2022-01-21
▼ ▲ retail.projects.locations.catalogs.controls.list
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location: path
Description: Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
Type: string
Required: Yes
pageToken
Type: string
Description: Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
Location: query
pageSize
Location: query
Type: integer
Description: Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
Format: int32
filter
Location: query
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"'
Type: string
Description: Lists all Controls linked to this catalog.
Parameter Order: parent
Path: v2alpha/{+parent}/controls
HTTP Method: GET
▼ ▲ retail.projects.locations.catalogs.controls.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls/{controlsId}
Description: Gets a Control.
Parameter Order: name
Path: v2alpha/{+name}
Parameters:
name
Required: Yes
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/[^/]+$
Type: string
Location: path
HTTP Method: GET
▼ ▲ retail.projects.locations.catalogs.controls.delete
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls/{controlsId}
Description: Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/controls/[^/]+$
Required: Yes
Description: Required. The resource name of the Control to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}
Path: v2alpha/{+name}
▼ ▲ retail.projects.locations.catalogs.controls.create
Description: Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned.
Path: v2alpha/{+parent}/controls
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Description: Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
Type: string
Required: Yes
Location: path
controlId
Location: query
Type: string
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
HTTP Method: POST
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls
▼ ▲ retail.projects.locations.catalogs.controls.patch
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls/{controlsId}
HTTP Method: PATCH
Description: Updates a Control. Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to delete does not exist, a NOT_FOUND error is returned.
Path: v2alpha/{+name}
Parameters:
updateMask
Type: string
Format: google-fieldmask
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.
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/controls/[^/]+$
Location: path
Required: Yes
Description: Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
Parameter Order: name
▼ ▲ retail.projects.locations.catalogs.servingConfigs.list
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Required: Yes
Location: path
Type: string
Description: Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
pageToken
Type: string
Description: Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
Location: query
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.
Format: int32
Type: integer
Location: query
HTTP Method: GET
Description: Lists all ServingConfigs linked to this catalog.
Path: v2alpha/{+parent}/servingConfigs
▼ ▲ retail.projects.locations.catalogs.servingConfigs.get
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}
Description: Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Required: Yes
Location: path
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
HTTP Method: GET
Path: v2alpha/{+name}
▼ ▲ retail.projects.locations.catalogs.servingConfigs.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2alpha/{+name}
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}
Description: Updates a ServingConfig.
Parameters:
updateMask
Format: google-fieldmask
Location: query
Type: string
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.
name
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Required: Yes
Description: Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*
Location: path
Type: string
HTTP Method: PATCH
Parameter Order: name
▼ ▲ retail.projects.locations.catalogs.servingConfigs.removeControl
HTTP Method: POST
Parameter Order: servingConfig
Path: v2alpha/{+servingConfig}:removeControl
Parameters:
servingConfig
Required: Yes
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
Location: path
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:removeControl
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.servingConfigs.addControl
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.
Parameters:
servingConfig
Location: path
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/[^/]+$
Required: Yes
Type: string
Path: v2alpha/{+servingConfig}:addControl
HTTP Method: POST
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:addControl
Parameter Order: servingConfig
▼ ▲ retail.projects.locations.catalogs.servingConfigs.create
HTTP Method: POST
Description: Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.
Path: v2alpha/{+parent}/servingConfigs
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs
Parameter Order: parent
Parameters:
parent
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Description: Required. Full resource name of parent. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
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
▼ ▲ retail.projects.locations.catalogs.servingConfigs.delete
Parameter Order: name
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}
Path: v2alpha/{+name}
HTTP Method: DELETE
Description: Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Description: Required. The resource name of the ServingConfig to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
Type: string
Required: Yes