2025-03-12
▼ ▲ retail.projects.locations.operations.list
Path : v2/{+name}/operations
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ retail.projects.locations.operations.get
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ retail.projects.locations.catalogs.exportAnalyticsMetrics
Path : v2/{+catalog}:exportAnalyticsMetrics
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}:exportAnalyticsMetrics
HTTP Method : POST
Parameters :
catalog
Description : Required. Full resource name of the parent catalog. Expected format: `projects/*/locations/*/catalogs/*`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : catalog
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Exports analytics metrics. `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`.
▼ ▲ retail.projects.locations.catalogs.list
Path : v2/{+parent}/catalogs
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs
HTTP Method : GET
Parameters :
parent
Description : Required. The account resource name with an associated location. If the caller does not have permission to list Catalogs under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Maximum number of Catalogs to return. If unspecified, defaults to 50. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT is returned.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token ListCatalogsResponse.next_page_token, received from a previous CatalogService.ListCatalogs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CatalogService.ListCatalogs must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all the Catalogs associated with the project.
▼ ▲ retail.projects.locations.catalogs.patch
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}
HTTP Method : PATCH
Parameters :
name
Description : Required. Immutable. The fully qualified resource name of the catalog.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the Catalogs.
▼ ▲ retail.projects.locations.catalogs.setDefaultBranch
Path : v2/{+catalog}:setDefaultBranch
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}:setDefaultBranch
HTTP Method : POST
Parameters :
catalog
Description : Full resource name of the catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : catalog
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Set a specified branch id as default branch. API methods such as SearchService.Search, ProductService.GetProduct, ProductService.ListProducts will treat requests using "default_branch" to the actual branch id set as default. For example, if `projects/*/locations/*/catalogs/*/branches/1` is set as default, setting SearchRequest.branch to `projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent to setting SearchRequest.branch to `projects/*/locations/*/catalogs/*/branches/1`. Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using `projects/*/locations/*/catalogs/*/branches/default_branch` as SearchRequest.branch to route the traffic to this staging branch. CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one. More specifically: * PredictionService will only return product IDs from branch {newBranch}. * SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set). * UserEventService will only join events with products from branch {newBranch}.
▼ ▲ retail.projects.locations.catalogs.getDefaultBranch
Path : v2/{+catalog}:getDefaultBranch
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}:getDefaultBranch
HTTP Method : GET
Parameters :
catalog
Description : The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : catalog
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.
▼ ▲ retail.projects.locations.catalogs.getCompletionConfig
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/completionConfig
HTTP Method : GET
Parameters :
name
Description : Required. Full CompletionConfig resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/completionConfig$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a CompletionConfig.
▼ ▲ retail.projects.locations.catalogs.updateCompletionConfig
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/completionConfig
HTTP Method : PATCH
Parameters :
name
Description : Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/completionConfig`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/completionConfig$
Location : path
Required : Yes
Type : string
updateMask
Description : Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the CompletionConfigs.
▼ ▲ retail.projects.locations.catalogs.getAttributesConfig
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig
HTTP Method : GET
Parameters :
name
Description : Required. Full AttributesConfig resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/attributesConfig$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an AttributesConfig.
▼ ▲ retail.projects.locations.catalogs.updateAttributesConfig
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig
HTTP Method : PATCH
Parameters :
name
Description : Required. Immutable. The fully qualified resource name of the attribute config. Format: `projects/*/locations/*/catalogs/*/attributesConfig`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/attributesConfig$
Location : path
Required : Yes
Type : string
updateMask
Description : Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the AttributesConfig. The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.
▼ ▲ retail.projects.locations.catalogs.completeQuery
Path : v2/{+catalog}:completeQuery
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}:completeQuery
HTTP Method : GET
Parameters :
catalog
Description : Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
query
Description : Required. The query used to generate suggestions. The maximum number of allowed characters is 255.
Location : query
Type : string
visitorId
Description : Required field. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
Location : query
Type : string
languageCodes
Description : Note that this field applies for `user-data` dataset only. For requests with `cloud-retail` dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of language codes is 3.
Location : query
Repeated : Yes
Type : string
deviceType
Description : The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
Location : query
Type : string
dataset
Description : Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through CompletionService.ImportCompletionData. "cloud-retail" will use the dataset generated by cloud retail based on user events. If leave empty, it will use the "user-data". Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
Location : query
Type : string
maxSuggestions
Description : Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.
Location : query
Type : integer
Format : int32
enableAttributeSuggestions
Description : If true, attribute suggestions are enabled and provided in the response. This field is only available for the "cloud-retail" dataset.
Location : query
Type : boolean
entity
Description : The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results. Also, this entity should be limited to 256 characters, if too long, it will be truncated to 256 characters in both generation and serving time, and may lead to mis-match. To ensure it works, please set the entity with string within 256 characters.
Location : query
Type : string
Parameter Order : catalog
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
▼ ▲ retail.projects.locations.catalogs.updateGenerativeQuestionFeature
Path : v2/{+catalog}/generativeQuestionFeature
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestionFeature
HTTP Method : PATCH
Parameters :
catalog
Description : Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Indicates which fields in the provided GenerativeQuestionsFeatureConfig to update. If not set or empty, all supported fields are updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : catalog
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Manages overal generative question feature state -- enables toggling feature on and off.
▼ ▲ retail.projects.locations.catalogs.getGenerativeQuestionFeature
Path : v2/{+catalog}/generativeQuestionFeature
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestionFeature
HTTP Method : GET
Parameters :
catalog
Description : Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : catalog
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Manages overal generative question feature state -- enables toggling feature on and off.
▼ ▲ retail.projects.locations.catalogs.updateGenerativeQuestion
Path : v2/{+catalog}/generativeQuestion
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestion
HTTP Method : PATCH
Parameters :
catalog
Description : Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : catalog
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Allows management of individual questions.
▼ ▲ retail.projects.locations.catalogs.operations.list
Path : v2/{+name}/operations
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ retail.projects.locations.catalogs.operations.get
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ retail.projects.locations.catalogs.branches.operations.get
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ retail.projects.locations.catalogs.branches.products.create
Path : v2/{+parent}/products
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products
HTTP Method : POST
Parameters :
parent
Description : Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch`.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+$
Location : path
Required : Yes
Type : string
productId
Description : Required. The ID to use for the Product, which will become the final component of the Product.name. If the caller does not have permission to create the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a Product.
▼ ▲ retail.projects.locations.catalogs.branches.products.get
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}
HTTP Method : GET
Parameters :
name
Description : Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Product does not exist, a NOT_FOUND error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Product.
▼ ▲ retail.projects.locations.catalogs.branches.products.list
Path : v2/{+parent}/products
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products
HTTP Method : GET
Parameters :
parent
Description : Required. The parent branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use `default_branch` as the branch ID, to list products under the default branch. If the caller does not have permission to list Products under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
Location : query
Type : string
filter
Description : A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. * List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: `primary_product_id = "some_product_id"` * List Products bundled in a Product.Type.COLLECTION Product. For example: `collection_product_id = "some_product_id"` * List Products with a partibular type. For example: `type = "PRIMARY"` `type = "VARIANT"` `type = "COLLECTION"` If the field is unrecognizable, an INVALID_ARGUMENT error is returned. If the specified Product.Type.PRIMARY Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.
Location : query
Type : string
readMask
Description : The fields of Product to return in the responses. If not set or empty, the following fields are returned: * Product.name * Product.id * Product.title * Product.uri * Product.images * Product.price_info * Product.brands If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a list of Products.
▼ ▲ retail.projects.locations.catalogs.branches.products.patch
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$
Location : path
Required : Yes
Type : string
updateMask
Description : Indicates which fields in the provided Product to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. The attribute key can be updated by setting the mask path as "attributes.${key_name}". If a key name is present in the mask but not in the patching product from the request, this key will be deleted after the update.
Location : query
Type : string
Format : google-fieldmask
allowMissing
Description : If set to true, and the Product is not found, a new Product will be created. In this situation, `update_mask` is ignored.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a Product.
▼ ▲ retail.projects.locations.catalogs.branches.products.delete
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to delete the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to delete does not exist, a NOT_FOUND error is returned. The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants. Otherwise, an INVALID_ARGUMENT error is returned. All inventory information for the named Product will be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Product.
▼ ▲ retail.projects.locations.catalogs.branches.products.purge
Path : v2/{+parent}/products:purge
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products:purge
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the branch under which the products are created. The format is `projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Permanently deletes all selected Products under a branch. This process is asynchronous. If the request is valid, the removal will be enqueued and processed offline. Depending on the number of Products, this operation could take hours to complete. Before the operation completes, some Products may still be returned by ProductService.GetProduct or ProductService.ListProducts. Depending on the number of Products, this operation could take hours to complete. To get a sample of Products that would be deleted, set PurgeProductsRequest.force to false.
▼ ▲ retail.projects.locations.catalogs.branches.products.import
Path : v2/{+parent}/products:import
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products:import
HTTP Method : POST
Parameters :
parent
Description : Required. `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch` If no updateMask is specified, requires products.create permission. If updateMask is specified, requires products.update permission.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Bulk import of multiple Products. Request processing may be synchronous. Non-existing items are created. Note that it is possible for a subset of the Products to be successfully updated.
▼ ▲ retail.projects.locations.catalogs.branches.products.setInventory
Path : v2/{+name}:setInventory
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:setInventory
HTTP Method : POST
Parameters :
name
Description : Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update is enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update times for the specified inventory fields are overwritten by the times of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product is used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information is preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. The returned Operations is obsolete after one day, and the GetOperation API returns `NOT_FOUND` afterwards. If conflicting updates are issued, the Operations associated with the stale updates are not marked as done until they are obsolete.
▼ ▲ retail.projects.locations.catalogs.branches.products.addFulfillmentPlaces
Path : v2/{+product}:addFulfillmentPlaces
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addFulfillmentPlaces
HTTP Method : POST
Parameters :
product
Description : Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$
Location : path
Required : Yes
Type : string
Parameter Order : product
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : We recommend that you use the ProductService.AddLocalInventories method instead of the ProductService.AddFulfillmentPlaces method. ProductService.AddLocalInventories achieves the same results but provides more fine-grained control over ingesting local inventory data. Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.
▼ ▲ retail.projects.locations.catalogs.branches.products.removeFulfillmentPlaces
Path : v2/{+product}:removeFulfillmentPlaces
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeFulfillmentPlaces
HTTP Method : POST
Parameters :
product
Description : Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$
Location : path
Required : Yes
Type : string
Parameter Order : product
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : We recommend that you use the ProductService.RemoveLocalInventories method instead of the ProductService.RemoveFulfillmentPlaces method. ProductService.RemoveLocalInventories achieves the same results but provides more fine-grained control over ingesting local inventory data. Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.
▼ ▲ retail.projects.locations.catalogs.branches.products.addLocalInventories
Path : v2/{+product}:addLocalInventories
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addLocalInventories
HTTP Method : POST
Parameters :
product
Description : Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$
Location : path
Required : Yes
Type : string
Parameter Order : product
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.
▼ ▲ retail.projects.locations.catalogs.branches.products.removeLocalInventories
Path : v2/{+product}:removeLocalInventories
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeLocalInventories
HTTP Method : POST
Parameters :
product
Description : Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$
Location : path
Required : Yes
Type : string
Parameter Order : product
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.
▼ ▲ retail.projects.locations.catalogs.attributesConfig.addCatalogAttribute
Path : v2/{+attributesConfig}:addCatalogAttribute
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig:addCatalogAttribute
HTTP Method : POST
Parameters :
attributesConfig
Description : Required. Full AttributesConfig resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/attributesConfig$
Location : path
Required : Yes
Type : string
Parameter Order : attributesConfig
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Adds the specified CatalogAttribute to the AttributesConfig. If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
▼ ▲ retail.projects.locations.catalogs.attributesConfig.removeCatalogAttribute
Path : v2/{+attributesConfig}:removeCatalogAttribute
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig:removeCatalogAttribute
HTTP Method : POST
Parameters :
attributesConfig
Description : Required. Full AttributesConfig resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/attributesConfig$
Location : path
Required : Yes
Type : string
Parameter Order : attributesConfig
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Removes the specified CatalogAttribute from the AttributesConfig. If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.
▼ ▲ retail.projects.locations.catalogs.attributesConfig.replaceCatalogAttribute
Path : v2/{+attributesConfig}:replaceCatalogAttribute
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig:replaceCatalogAttribute
HTTP Method : POST
Parameters :
attributesConfig
Description : Required. Full AttributesConfig resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/attributesConfig$
Location : path
Required : Yes
Type : string
Parameter Order : attributesConfig
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Replaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key. If the CatalogAttribute to replace does not exist, a NOT_FOUND error is returned.
▼ ▲ retail.projects.locations.catalogs.placements.search
Path : v2/{+placement}:search
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/placements/{placementsId}:search
HTTP Method : POST
Parameters :
placement
Description : Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving config name and the set of models that are used to make the search.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/placements/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : placement
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
▼ ▲ retail.projects.locations.catalogs.placements.predict
Path : v2/{+placement}:predict
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/placements/{placementsId}:predict
HTTP Method : POST
Parameters :
placement
Description : Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Manage serving configs] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/placements/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : placement
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Makes a recommendation prediction.
▼ ▲ retail.projects.locations.catalogs.servingConfigs.search
Path : v2/{+placement}:search
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:search
HTTP Method : POST
Parameters :
placement
Description : Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving config name and the set of models that are used to make the search.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : placement
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
▼ ▲ retail.projects.locations.catalogs.servingConfigs.predict
Path : v2/{+placement}:predict
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:predict
HTTP Method : POST
Parameters :
placement
Description : Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Manage serving configs] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : placement
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Makes a recommendation prediction.
▼ ▲ retail.projects.locations.catalogs.servingConfigs.create
Path : v2/{+parent}/servingConfigs
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs
HTTP Method : POST
Parameters :
parent
Description : Required. Full resource name of parent. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
servingConfigId
Description : Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.
▼ ▲ retail.projects.locations.catalogs.servingConfigs.delete
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the ServingConfig to delete. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
▼ ▲ retail.projects.locations.catalogs.servingConfigs.patch
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/servingConfig/*`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a ServingConfig.
▼ ▲ retail.projects.locations.catalogs.servingConfigs.get
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
▼ ▲ retail.projects.locations.catalogs.servingConfigs.list
Path : v2/{+parent}/servingConfigs
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs
HTTP Method : GET
Parameters :
parent
Description : Required. The catalog resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : 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.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all ServingConfigs linked to this catalog.
▼ ▲ retail.projects.locations.catalogs.servingConfigs.addControl
Path : v2/{+servingConfig}:addControl
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:addControl
HTTP Method : POST
Parameters :
servingConfig
Description : Required. The source ServingConfig resource name . Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : servingConfig
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control.
▼ ▲ retail.projects.locations.catalogs.servingConfigs.removeControl
Path : v2/{+servingConfig}:removeControl
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:removeControl
HTTP Method : POST
Parameters :
servingConfig
Description : Required. The source ServingConfig resource name . Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : servingConfig
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig.
▼ ▲ retail.projects.locations.catalogs.completionData.import
Path : v2/{+parent}/completionData:import
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/completionData:import
HTTP Method : POST
Parameters :
parent
Description : Required. The catalog which the suggestions dataset belongs to. Format: `projects/1234/locations/global/catalogs/default_catalog`.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Bulk import of processed completion dataset. Request processing is asynchronous. Partial updating is not supported. The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
▼ ▲ retail.projects.locations.catalogs.controls.create
Path : v2/{+parent}/controls
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls
HTTP Method : POST
Parameters :
parent
Description : Required. Full resource name of parent catalog. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
controlId
Description : Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned.
▼ ▲ retail.projects.locations.catalogs.controls.delete
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls/{controlsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/controls/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
▼ ▲ retail.projects.locations.catalogs.controls.patch
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls/{controlsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/controls/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name If not set or empty, all supported fields are updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a Control. Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to update does not exist, a NOT_FOUND error is returned.
▼ ▲ retail.projects.locations.catalogs.controls.get
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls/{controlsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/controls/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Control.
▼ ▲ retail.projects.locations.catalogs.controls.list
Path : v2/{+parent}/controls
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls
HTTP Method : GET
Parameters :
parent
Description : Required. The catalog resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
Location : query
Type : string
filter
Description : Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. * List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all Controls by their parent Catalog.
▼ ▲ retail.projects.locations.catalogs.generativeQuestions.list
Path : v2/{+parent}/generativeQuestions
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestions
HTTP Method : GET
Parameters :
parent
Description : Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns all questions for a given catalog.
▼ ▲ retail.projects.locations.catalogs.generativeQuestion.batchUpdate
Path : v2/{+parent}/generativeQuestion:batchUpdate
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestion:batchUpdate
HTTP Method : POST
Parameters :
parent
Description : Optional. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Allows management of multiple questions.
▼ ▲ retail.projects.locations.catalogs.models.create
Path : v2/{+parent}/models
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource under which to create the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
dryRun
Description : Optional. Whether to run a dry run to validate the request (without actually creating the model).
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new model.
▼ ▲ retail.projects.locations.catalogs.models.get
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the Model to get. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog}/models/{model_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a model.
▼ ▲ retail.projects.locations.catalogs.models.pause
Path : v2/{+name}:pause
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}:pause
HTTP Method : POST
Parameters :
name
Description : Required. The name of the model to pause. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Pauses the training of an existing model.
▼ ▲ retail.projects.locations.catalogs.models.resume
Path : v2/{+name}:resume
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}:resume
HTTP Method : POST
Parameters :
name
Description : Required. The name of the model to resume. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Resumes the training of an existing model.
▼ ▲ retail.projects.locations.catalogs.models.delete
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the Model to delete. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an existing model.
▼ ▲ retail.projects.locations.catalogs.models.list
Path : v2/{+parent}/models
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models
HTTP Method : GET
Parameters :
parent
Description : Required. The parent for which to list models. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListModels` call. Provide this to retrieve the subsequent page.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all the models linked to this event store.
▼ ▲ retail.projects.locations.catalogs.models.patch
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}
HTTP Method : PATCH
Parameters :
name
Description : Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Indicates which fields in the provided 'model' to update. If not set, by default updates all fields.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update of model metadata. Only fields that currently can be updated are: `filtering_option` and `periodic_tuning_state`. If other values are provided, this API method ignores them.
▼ ▲ retail.projects.locations.catalogs.models.tune
Path : v2/{+name}:tune
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}:tune
HTTP Method : POST
Parameters :
name
Description : Required. The resource name of the model to tune. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Tunes an existing model.
▼ ▲ retail.projects.locations.catalogs.userEvents.write
Path : v2/{+parent}/userEvents:write
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:write
HTTP Method : POST
Parameters :
parent
Description : Required. The parent catalog resource name, such as `projects/1234/locations/global/catalogs/default_catalog`.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
writeAsync
Description : If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write. Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Writes a single user event.
▼ ▲ retail.projects.locations.catalogs.userEvents.collect
Path : v2/{+parent}/userEvents:collect
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:collect
HTTP Method : POST
Parameters :
parent
Description : Required. The parent catalog name, such as `projects/1234/locations/global/catalogs/default_catalog`.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
▼ ▲ retail.projects.locations.catalogs.userEvents.purge
Path : v2/{+parent}/userEvents:purge
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:purge
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/catalogs/${catalogId}`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.
▼ ▲ retail.projects.locations.catalogs.userEvents.import
Path : v2/{+parent}/userEvents:import
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import
HTTP Method : POST
Parameters :
parent
Description : Required. `projects/1234/locations/global/catalogs/default_catalog`
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.
▼ ▲ retail.projects.locations.catalogs.userEvents.rejoin
Path : v2/{+parent}/userEvents:rejoin
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:rejoin
HTTP Method : POST
Parameters :
parent
Description : Required. The parent catalog resource name, such as `projects/1234/locations/global/catalogs/default_catalog`.
Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.
▼ ▲ retail.projects.operations.list
Path : v2/{+name}/operations
Flat Path : v2/projects/{projectsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ retail.projects.operations.get
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.