This is the documentation for Recommendations AI, Retail Search, and the new Retail console.

Method: projects.locations.catalogs.servingConfigs.list

Lists all ServingConfigs linked to this catalog.

HTTP request

GET https://retail.googleapis.com/v2alpha/{parent=projects/*/locations/*/catalogs/*}/servingConfigs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The catalog resource name. Format: projects/{project_number}/locations/{locationId}/catalogs/{catalogId}

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.

pageToken

string

Optional. A page token, received from a previous servingConfigs.list call. Provide this to retrieve the subsequent page.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response for servingConfigs.list method.

JSON representation
{
  "servingConfigs": [
    {
      object (ServingConfig)
    }
  ],
  "nextPageToken": string
}
Fields
servingConfigs[]

object (ServingConfig)

All the ServingConfigs for a given catalog.

nextPageToken

string

Pagination token, if not returned indicates the last page.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • retail.servingConfigs.list

For more information, see the IAM documentation.