Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1348275334.9 KB
projects

Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned.

post/v2/{+parent}/controls

Path parameters

parentstring required

Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

Query parameters

controlIdstring

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-_/.

Request body

namestring

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

searchSolutionUseCasestring[]

Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.

displayNamestring

Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.

associatedServingConfigIdsstring[]

Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.

solutionTypesstring[]

Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.

Response

Successful response