2022-08-23
▼ ▲ retail.projects.locations.catalogs.attributesConfig.replaceCatalogAttribute
Parameter Order: attributesConfig
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig:replaceCatalogAttribute
Parameters:
attributesConfig
Description: Required. Full AttributesConfig resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/attributesConfig$
Path: v2/{+attributesConfig}:replaceCatalogAttribute
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
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.servingConfigs.patch
Parameter Order: name
HTTP Method: PATCH
Path: v2/{+name}
Parameters:
updateMask
Location: query
Format: google-fieldmask
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.
Type: string
name
Location: path
Description: Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/servingConfig/*`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}
Description: Updates a ServingConfig.
▼ ▲ retail.projects.locations.catalogs.servingConfigs.list
Parameter Order: parent
Path: v2/{+parent}/servingConfigs
Description: Lists all ServingConfigs linked to this catalog.
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Type: string
Required: Yes
Location: path
Description: Required. The catalog resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
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
Format: int32
Type: integer
pageToken
Type: string
Description: Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
Location: query
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs
▼ ▲ retail.projects.locations.catalogs.servingConfigs.create
HTTP Method: POST
Parameters:
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Description: Required. Full resource name of parent. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
Location: path
Type: string
servingConfigId
Location: query
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-_/.
Type: string
Path: v2/{+parent}/servingConfigs
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.
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs
▼ ▲ retail.projects.locations.catalogs.servingConfigs.addControl
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:addControl
Parameter Order: servingConfig
Path: v2/{+servingConfig}:addControl
Parameters:
servingConfig
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Description: Required. The source ServingConfig resource name . Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
Required: Yes
HTTP Method: POST
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.delete
Description: Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Location: path
Type: string
Description: Required. The resource name of the ServingConfig to delete. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
Path: v2/{+name}
Parameter Order: name
▼ ▲ retail.projects.locations.catalogs.servingConfigs.get
Path: v2/{+name}
Description: Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
HTTP Method: GET
Parameters:
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Type: string
Description: Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}
▼ ▲ retail.projects.locations.catalogs.servingConfigs.removeControl
HTTP Method: POST
Parameter Order: servingConfig
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2/{+servingConfig}:removeControl
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:removeControl
Parameters:
servingConfig
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Description: Required. The source ServingConfig resource name . Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
Type: string
▼ ▲ retail.projects.locations.catalogs.controls.patch
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls/{controlsId}
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.
Parameter Order: name
Path: v2/{+name}
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/controls/[^/]+$
Description: Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
Location: path
updateMask
Format: google-fieldmask
Type: string
Location: query
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.
▼ ▲ retail.projects.locations.catalogs.controls.delete
Parameter Order: name
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls/{controlsId}
Parameters:
name
Type: string
Location: path
Description: Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/controls/[^/]+$
HTTP Method: DELETE
Path: v2/{+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.get
Description: Gets a Control.
HTTP Method: GET
Parameters:
name
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/controls/[^/]+$
Description: Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`
Path: v2/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls/{controlsId}
Parameter Order: name
▼ ▲ retail.projects.locations.catalogs.controls.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls
HTTP Method: POST
Description: Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned.
Parameters:
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Required: Yes
Description: Required. Full resource name of parent catalog. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
Type: string
controlId
Type: string
Location: query
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-_/.
Parameter Order: parent
Path: v2/{+parent}/controls
▼ ▲ retail.projects.locations.catalogs.controls.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls
Parameters:
parent
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Description: Required. The catalog resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
filter
Location: query
Type: string
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"'
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
Type: string
Location: query
Description: Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
Path: v2/{+parent}/controls
HTTP Method: GET
Parameter Order: parent
Description: Lists all Controls by their parent Catalog.