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

Method: projects.locations.catalogs.models.list

Stay organized with collections Save and categorize content based on your preferences.

Lists all the models linked to this event store.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent for which to list models. Format: projects/{project_number}/locations/{locationId}/catalogs/{catalogId}

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

pageToken

string

Optional. A page token, received from a previous models.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 to a ListModelRequest.

JSON representation
{
  "models": [
    {
      object (Model)
    }
  ],
  "nextPageToken": string
}
Fields
models[]

object (Model)

List of Models.

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.models.list

For more information, see the IAM documentation.