Package google.cloud.retail.v2

Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.

end_time

If start time is empty and end time is not empty, then ignore these facet values before end time.

MergedFacet

The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type).

Fields

merged_facet_key

string

The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.

MergedFacetValue

Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes.

Fields

values[]

string

All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters.

merged_value

string

All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters.

RerankConfig

Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don't pass the facet keys engaged that you want to rerank on, this control won't be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces).

Fields

rerank_facet

bool

If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.

facet_values[]

string

If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.

IndexableOption

The status of the indexable option of a catalog attribute.

Enums
`INDEXABLE_OPTION_UNSPECIFIED`	Value used when unset.
`INDEXABLE_ENABLED`	Indexable option enabled for an attribute.
`INDEXABLE_DISABLED`	Indexable option disabled for an attribute.

RetrievableOption

The status of the retrievable option of a catalog attribute.

Enums
`RETRIEVABLE_OPTION_UNSPECIFIED`	Value used when unset.
`RETRIEVABLE_ENABLED`	Retrievable option enabled for an attribute.
`RETRIEVABLE_DISABLED`	Retrievable option disabled for an attribute.

SearchableOption

The status of the searchable option of a catalog attribute.

Enums
`SEARCHABLE_OPTION_UNSPECIFIED`	Value used when unset.
`SEARCHABLE_ENABLED`	Searchable option enabled for an attribute.
`SEARCHABLE_DISABLED`	Searchable option disabled for an attribute.

CollectUserEventRequest

Request message for CollectUserEvent method.

Fields
`parent`	`string` Required. The parent catalog name, such as `projects/1234/locations/global/catalogs/default_catalog`.
`user_event`	`string` Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
`uri`	`string` The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.
`ets`	`int64` The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
`raw_json`	`string` An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only.
Union field `conversion_rule`. The rule that can convert the raw_json to a user event. It is needed only when the raw_json is set. `conversion_rule` can be only one of the following:
`prebuilt_rule`	`string` The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.

ColorInfo

The color information of a Product.

Fields

color_families[]

string

The standard color families. Strongly recommended to use the following standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and "Mixed". Normally it is expected to have only 1 color family. May consider using single "Mixed" instead of multiple values.

A maximum of 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

colors[]

string

The color display names, which may be different from standard color family names, such as the color aliases used in the website frontend. Normally it is expected to have only 1 color. May consider using single "Mixed" instead of multiple values.

A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

CompleteQueryRequest

Autocomplete parameters.

Fields
`catalog`	`string` Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
`query`	`string` Required. The query used to generate suggestions. The maximum number of allowed characters is 255.
`visitor_id`	`string` 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.
`language_codes[]`	`string` 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. The maximum number of language codes is 3.
`device_type`	`string` 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`.
`dataset`	`string` 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.
`max_suggestions`	`int32` 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.
`enable_attribute_suggestions`	`bool` If true, attribute suggestions are enabled and provided in the response. This field is only available for the "cloud-retail" dataset.
`entity`	`string` 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.

CompleteQueryResponse

Response of the autocomplete query.

Fields
`completion_results[]`	`CompletionResult` Results of the matching suggestions. The result list is ordered and the first result is top suggestion.
`attribution_token`	`string` A unique complete token. This should be included in the `UserEvent.completion_detail` for search events resulting from this completion, which enables accurate attribution of complete model performance.
`recent_search_results[] (deprecated)`	`RecentSearchResult` This item is deprecated! Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This feature is only available when `CompleteQueryRequest.visitor_id` field is set and `UserEvent` is imported. The recent searches satisfy the follow rules: They are ordered from latest to oldest. They are matched with `CompleteQueryRequest.query` case insensitively. They are transformed to lower case. They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.
`attribute_results`	`map<string, AttributeResult>` A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset. Current supported keys: `brands` `categories`

AttributeResult

Resource that represents attribute results. The list of suggestions for the attribute.

Fields
`suggestions[]`	`string`

CompletionResult

Resource that represents completion results.

Fields

suggestion

string

The suggestion for the query.

attributes

map<string, CustomAttribute>

Custom attributes for the suggestion term.

For "user-data", the attributes are additional custom attributes ingested through BigQuery.
For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.

RecentSearchResult

Deprecated: Recent search of this user.

Fields

recent_search

string

The recent search query.

CompletionConfig

Catalog level autocomplete config for customers to customize autocomplete feature's settings.

Fields
`name`	`string` Required. Immutable. Fully qualified name `projects//locations//catalogs/*/completionConfig`
`matching_order`	`string` Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified would suggest "red shoes". Currently supported values: 'out-of-order' 'exact-prefix' Default value: 'exact-prefix'.
`max_suggestions`	`int32` The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.
`min_prefix_length`	`int32` The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.
`auto_learning`	`bool` If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use `cloud-retail` data in `CompleteQueryRequest`.
`suggestions_input_config`	`CompletionDataInputConfig` Output only. The source data for the latest import of the autocomplete suggestion phrases.
`last_suggestions_import_operation`	`string` Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use `GetOperation` API method to retrieve the latest state of the Long Running Operation.
`denylist_input_config`	`CompletionDataInputConfig` Output only. The source data for the latest import of the autocomplete denylist phrases.
`last_denylist_import_operation`	`string` Output only. Name of the LRO corresponding to the latest denylist import. Can use `GetOperation` API to retrieve the latest state of the Long Running Operation.
`allowlist_input_config`	`CompletionDataInputConfig` Output only. The source data for the latest import of the autocomplete allowlist phrases.
`last_allowlist_import_operation`	`string` Output only. Name of the LRO corresponding to the latest allowlist import. Can use `GetOperation` API to retrieve the latest state of the Long Running Operation.

CompletionDataInputConfig

The input config source for completion data.

Fields

Union field source. The source of the input.

Supported BigQuerySource.data_schema values for suggestions imports:

suggestions (default): One JSON completion suggestion per line.
denylist: One JSON deny suggestion per line.
allowlist: One JSON allow suggestion per line. source can be only one of the following:

big_query_source

BigQuerySource

Required. BigQuery input source.

Add the IAM permission "BigQuery Data Viewer" for cloud-retail-customer-data-access@system.gserviceaccount.com before using this feature otherwise an error is thrown.

CompletionDetail

Detailed completion information including completion attribution token and clicked completion info.

Fields

completion_attribution_token

string

Completion attribution token in CompleteQueryResponse.attribution_token.

selected_suggestion

string

End user selected CompleteQueryResponse.CompletionResult.suggestion.

selected_position

int32

End user selected CompleteQueryResponse.CompletionResult.suggestion position, starting from 0.

Condition

Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.

Fields

query_terms[]

QueryTerm

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

active_time_range[]

TimeRange

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

page_categories[]

string

Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;

QueryTerm

Query terms that we want to match on.

Fields

value

string

The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.

full_match

bool

Whether this is supposed to be a full or partial match.

TimeRange

Used for time-dependent conditions. Example: Want to have rule applied for week long sale.

Fields

start_time

Start of time range. Range is inclusive.

end_time

End of time range. Range is inclusive.

Control

Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.

Fields
`name`	`string` Immutable. Fully qualified name `projects//locations/global/catalogs//controls/*`
`display_name`	`string` 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.
`associated_serving_config_ids[]`	`string` 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.
`solution_types[]`	`SolutionType` 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`.
`search_solution_use_case[]`	`SearchSolutionUseCase` 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.
Union field `control`. The behavior/type of the control A behavior/type must be specified on creation. Type cannot be changed once specified (e.g. A Rule control will always be a Rule control.). An INVALID_ARGUMENT will be returned if either condition is violated. `control` can be only one of the following:
`rule`	`Rule` A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

CreateControlRequest

Request for CreateControl method.

Fields

parent

string

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

control

Control

Required. The Control to create.

control_id

string

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][0-9]-_/.

CreateModelMetadata

Metadata associated with a create operation.

Fields

model

string

The resource name of the model that this create applies to. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

CreateModelRequest

Request for creating a model.

Fields

parent

string

Required. The parent resource under which to create the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

model

Model

Required. The payload of the Model to create.

dry_run

bool

Optional. Whether to run a dry run to validate the request (without actually creating the model).

CreateProductRequest

Request message for ProductService.CreateProduct method.

Fields

parent

string

Required. The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch.

product

ServingConfigExperiment

Required. The Product to create.

product_id

string

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.

CreateServingConfigRequest

Request for CreateServingConfig method.

Fields

parent

string

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

serving_config

ServingConfig

Required. The ServingConfig to create.

serving_config_id

string

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][0-9]-_/.

CustomAttribute

A custom attribute that is not explicitly modeled in Product.

Fields
`text[]`	`string` The textual values of this custom attribute. For example, `["yellow", "green"]` when the key is "color". Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of `text` or `numbers` should be set. Otherwise, an INVALID_ARGUMENT error is returned.
`numbers[]`	`double` The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of `text` or `numbers` should be set. Otherwise, an INVALID_ARGUMENT error is returned.
`searchable (deprecated)`	`bool` This item is deprecated! This field is normally ignored unless `AttributesConfig.attribute_config_level` of the `Catalog` is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see Configuration modes. If true, custom attribute values are searchable by text queries in `SearchService.Search`. This field is ignored in a `UserEvent`. Only set if type `text` is set. Otherwise, a INVALID_ARGUMENT error is returned.
`indexable (deprecated)`	`bool` This item is deprecated! This field is normally ignored unless `AttributesConfig.attribute_config_level` of the `Catalog` is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see Configuration modes. If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in `SearchService.Search`. This field is ignored in a `UserEvent`. See `SearchRequest.filter`, `SearchRequest.facet_specs` and `SearchRequest.boost_spec` for more details.

DeleteControlRequest

Request for DeleteControl method.

Fields

name

string

Required. The resource name of the Control to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}

DeleteModelRequest

Request for deleting a model.

Fields

name

string

Required. The resource name of the Model to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

DeleteProductRequest

Request message for ProductService.DeleteProduct method.

Fields

name

string

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.

DeleteServingConfigRequest

Request for DeleteServingConfig method.

Fields

name

string

Required. The resource name of the ServingConfig to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}

ExperimentInfo

Metadata for active A/B testing [Experiment][].

Fields

experiment

string

The fully qualified resource name of the experiment that provides the serving config under test, should an active experiment exist. For example: projects/*/locations/global/catalogs/default_catalog/experiments/experiment_id

Union field experiment_metadata. Information associated with the specific experiment entity being recorded. experiment_metadata can be only one of the following:

serving_config_experiment

A/B test between existing Cloud Retail Search ServingConfigs.

ServingConfigExperiment

Metadata for active serving config A/B tests.

Fields

original_serving_config

string

The fully qualified resource name of the original SearchRequest.placement in the search request prior to reassignment by experiment API. For example: projects/*/locations/*/catalogs/*/servingConfigs/*.

experiment_serving_config

string

The fully qualified resource name of the serving config [Experiment.VariantArm.serving_config_id][] responsible for generating the search response. For example: projects/*/locations/*/catalogs/*/servingConfigs/*.

ExportAnalyticsMetricsRequest

Request message for the ExportAnalyticsMetrics method.

Fields

catalog

string

Required. Full resource name of the parent catalog. Expected format: projects/*/locations/*/catalogs/*

output_config

OutputConfig

Required. The output location of the data.

filter

string

A filtering expression to specify restrictions on returned metrics. The expression is a sequence of terms. Each term applies a restriction to the returned metrics. Use this expression to restrict results to a specific time range.

Currently we expect only one types of fields:

timestamp: This can be specified twice, once with a less than operator and once with a greater than operator. The timestamp restriction should result in one, contiguous, valid, timestamp range.

Some examples of valid filters expressions:

Example 1: timestamp > "2012-04-23T18:25:43.511Z" timestamp < "2012-04-23T18:30:43.511Z"
Example 2: timestamp > "2012-04-23T18:25:43.511Z"

ExportAnalyticsMetricsResponse

Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

Fields

error_samples[]

A sample of errors encountered while processing the request.

errors_config

ExportErrorsConfig

This field is never set.

output_result

OutputResult

Output result indicating where the data were exported to.

ExportErrorsConfig

Configuration of destination for Export related errors.

Fields

Union field destination. Required. Errors destination. destination can be only one of the following:

gcs_prefix

string

Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded google.rpc.Status message.

ExportMetadata

Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

FulfillmentInfo

Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.

Fields

type

string

The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI.

Supported values:

"pickup-in-store"
"ship-to-store"
"same-day-delivery"
"next-day-delivery"
"custom-type-1"
"custom-type-2"
"custom-type-3"
"custom-type-4"
"custom-type-5"

If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

place_ids[]

string

The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery.

A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.

GcsOutputResult

A Gcs output result.

Fields

output_uri

string

The uri of Gcs output

GcsSource

Google Cloud Storage location for input content.

Fields

input_uris[]

string

Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json. A request can contain at most 100 files, and each file can be up to 2 GB. See Importing product information for the expected file format and setup instructions.

data_schema

string

The schema to use when parsing the data from the source.

Supported values for product imports:

product (default): One JSON Product per line. Each product must have a valid Product.id.
product_merchant_center: See Importing catalog data from Merchant Center.

Supported values for user events imports:

user_event (default): One JSON UserEvent per line.
user_event_ga360: Using https://support.google.com/analytics/answer/3437719.

Supported values for control imports:

control (default): One JSON Control per line.

Supported values for catalog attribute imports:

catalog_attribute (default): One CSV CatalogAttribute per line.

GetAttributesConfigRequest

Request for CatalogService.GetAttributesConfig method.

Fields

name

string

Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

GetCompletionConfigRequest

Request for CatalogService.GetCompletionConfig method.

Fields

name

string

Required. Full CompletionConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig

GetControlRequest

Request for GetControl method.

Fields

name

string

Required. The resource name of the Control to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}

GetDefaultBranchRequest

Request message to show which branch is currently the default branch.

Fields

catalog

string

The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog.

GetDefaultBranchResponse

Response message of CatalogService.GetDefaultBranch.

Fields

branch

string

Full resource name of the branch id currently set as default branch.

set_time

CompletionDataInputConfig

The time when this branch is set to default.

note

string

This corresponds to SetDefaultBranchRequest.note field, when this branch was set as default.

GetModelRequest

Request for getting a model.

Fields

name

string

Required. The resource name of the Model to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog}/models/{model_id}

GetProductRequest

Request message for ProductService.GetProduct method.

Fields

name

string

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.

GetServingConfigRequest

Request for GetServingConfig method.

Fields

name

string

Required. The resource name of the ServingConfig to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}

Image

Product image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.

Fields

uri

string

Required. URI of the image.

This field must be a valid UTF-8 encoded URI with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property image_link. Schema.org property Product.image.

height

int32

Height of the image in number of pixels.

This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

width

int32

Width of the image in number of pixels.

This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

ImportCompletionDataRequest

Request message for ImportCompletionData methods.

Fields

parent

string

Required. The catalog which the suggestions dataset belongs to.

Format: projects/1234/locations/global/catalogs/default_catalog.

input_config

Required. The desired input location of the data.

notification_pubsub_topic

string

Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}.

ImportCompletionDataResponse

Response of the ImportCompletionDataRequest. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

Fields

error_samples[]

A sample of errors encountered while processing the request.

ImportErrorsConfig

Configuration of destination for Import related errors.

Fields

Union field destination. Required. Errors destination. destination can be only one of the following:

gcs_prefix

string

Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded google.rpc.Status message.

ImportMetadata

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

Fields
`create_time`	`Timestamp` Operation create time.
`update_time`	`Timestamp` Operation last update time. If the operation is done, this is also the finish time.
`success_count`	`int64` Count of entries that were processed successfully.
`failure_count`	`int64` Count of entries that encountered errors while processing.
`request_id (deprecated)`	`string` This item is deprecated! Deprecated. This field is never set.
`notification_pubsub_topic`	`string` Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a `Operation`. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.

ImportProductsRequest

Request message for Import methods.

Fields
`parent`	`string` 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.
`request_id (deprecated)`	`string` This item is deprecated! Deprecated. This field has no effect.
`input_config`	`ProductInputConfig` Required. The desired input location of the data.
`errors_config`	`ImportErrorsConfig` The desired location of errors incurred during the Import.
`update_mask`	`FieldMask` Indicates which fields in the provided imported `products` to update. If not set, all fields are updated. If provided, only the existing product fields are updated. Missing products will not be created.
`reconciliation_mode`	`ReconciliationMode` The mode of reconciliation between existing products and the products to be imported. Defaults to `ReconciliationMode.INCREMENTAL`.
`notification_pubsub_topic`	`string` Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a `Operation`. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has to be within the same project as `ImportProductsRequest.parent`. Make sure that both `cloud-retail-customer-data-access@system.gserviceaccount.com` and `service-<project number>@gcp-sa-retail.iam.gserviceaccount.com` have the `pubsub.topics.publish` IAM permission on the topic. Only supported when `ImportProductsRequest.reconciliation_mode` is set to `FULL`.

ReconciliationMode

Indicates how imported products are reconciled with the existing products created or imported before.

Enums
`RECONCILIATION_MODE_UNSPECIFIED`	Defaults to INCREMENTAL.
`INCREMENTAL`	Inserts new products or updates existing products.
`FULL`	Calculates diff and replaces the entire product dataset. Existing products may be deleted if they are not present in the source location.

ImportProductsResponse

Response of the ImportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

Fields

error_samples[]

A sample of errors encountered while processing the request.

errors_config

ImportErrorsConfig

Echoes the destination for the complete errors in the request if set.

ImportUserEventsRequest

Request message for the ImportUserEvents request.

Fields

parent

string

Required. projects/1234/locations/global/catalogs/default_catalog

input_config

UserEventInputConfig

Required. The desired input location of the data.

errors_config

ImportErrorsConfig

The desired location of errors incurred during the Import. Cannot be set for inline user event imports.

ImportUserEventsResponse

Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

Fields

error_samples[]

A sample of errors encountered while processing the request.

errors_config

ImportErrorsConfig

Echoes the destination for the complete errors if this field was set in the request.

import_summary

UserEventImportSummary

Aggregated statistics of user event import status.

Interval

A floating point interval.

Fields

Union field min. The lower bound of the interval. If neither of the min fields are set, then the lower bound is negative infinity.

This field must not be larger than max. Otherwise, an INVALID_ARGUMENT error is returned. min can be only one of the following:

minimum

double

Inclusive lower bound.

exclusive_minimum

double

Exclusive lower bound.

Union field max. The upper bound of the interval. If neither of the max fields are set, then the upper bound is positive infinity.

This field must be not smaller than min. Otherwise, an INVALID_ARGUMENT error is returned. max can be only one of the following:

maximum

double

Inclusive upper bound.

exclusive_maximum

double

Exclusive upper bound.

ListCatalogsRequest

Request for CatalogService.ListCatalogs method.

Fields

parent

string

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.

page_size

int32

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.

page_token

string

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.

ListCatalogsResponse

Response for CatalogService.ListCatalogs method.

Fields

catalogs[]

Catalog

All the customer's Catalogs.

next_page_token

string

A token that can be sent as ListCatalogsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListControlsRequest

Request for ListControls method.

Fields
`parent`	`string` Required. The catalog resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
`page_size`	`int32` Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
`page_token`	`string` Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
`filter`	`string` 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"'

ListControlsResponse

Response for ListControls method.

Fields

controls[]

Control

All the Controls for a given catalog.

next_page_token

string

Pagination token, if not returned indicates the last page.

ListModelsRequest

Request for listing models associated with a resource.

Fields

parent

string

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

page_size

int32

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

page_token

string

Optional. A page token, received from a previous ListModels call. Provide this to retrieve the subsequent page.

ListModelsResponse

Response to a ListModelRequest.

Fields

models[]

Model

List of Models.

next_page_token

string

Pagination token, if not returned indicates the last page.

ListProductsRequest

Request message for ProductService.ListProducts method.

Fields
`parent`	`string` 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 `Product`s under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
`page_size`	`int32` Maximum number of `Product`s 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.
`page_token`	`string` 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.
`filter`	`string` 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` `Product`s sharing the same `Product.Type.PRIMARY` `Product`. For example: `primary_product_id = "some_product_id"` List `Product`s bundled in a `Product.Type.COLLECTION` `Product`. For example: `collection_product_id = "some_product_id"` List `Product`s 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.
`read_mask`	`FieldMask` 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.

ListProductsResponse

Response message for ProductService.ListProducts method.

Fields

products[]

FrequentlyBoughtTogetherFeaturesConfig

The Products.

next_page_token

string

A token that can be sent as ListProductsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListServingConfigsRequest

Request for ListServingConfigs method.

Fields

parent

string

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

page_size

int32

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.

page_token

string

Optional. A page token, received from a previous ListServingConfigs call. Provide this to retrieve the subsequent page.

ListServingConfigsResponse

Response for ListServingConfigs method.

Fields

serving_configs[]

ServingConfig

All the ServingConfigs for a given catalog.

next_page_token

string

Pagination token, if not returned indicates the last page.

LocalInventory

The inventory information at a place (e.g. a store) identified by a place ID.

Fields
`place_id`	`string` The place ID for the current set of inventory information.
`price_info`	`PriceInfo` Product price and cost information. Google Merchant Center property price.
`attributes`	`map<string, CustomAttribute>` Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: At most 30 attributes are allowed. The key must be a UTF-8 encoded string with a length limit of 32 characters. The key must match the pattern: `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, key0LikeThis or KEY_1_LIKE_THIS. The attribute values must be of the same type (text or number). Only 1 value is allowed for each attribute. For text values, the length limit is 256 UTF-8 characters. The attribute does not support search. The `searchable` field should be unset or set to false. The max summed total bytes of custom attribute keys and values per product is 5MiB.
`fulfillment_types[]`	`string` Input only. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: "pickup-in-store" "ship-to-store" "same-day-delivery" "next-day-delivery" "custom-type-1" "custom-type-2" "custom-type-3" "custom-type-4" "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.

Model

Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict API.

Fields
`name`	`string` 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.
`display_name`	`string` Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
`training_state`	`TrainingState` Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for `CreateModel` method is `TRAINING`. The default value for `UpdateModel` method is to keep the state the same as before.
`serving_state`	`ServingState` Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
`create_time`	`Timestamp` Output only. Timestamp the Recommendation Model was created at.
`update_time`	`Timestamp` Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.
`type`	`string` Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value). This field together with `optimization_objective` describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
`optimization_objective`	`string` Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with `optimization_objective` describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
`periodic_tuning_state`	`PeriodicTuningState` Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`.
`last_tune_time`	`Timestamp` Output only. The timestamp when the latest successful tune finished.
`tuning_operation`	`string` Output only. The tune operation associated with the model. Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on.
`data_state`	`DataState` Output only. The state of data requirements for this model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if serving state is `ACTIVE`: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.
`filtering_option`	`RecommendationsFilteringOption` Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by attributes is enabled for the model.
`serving_config_lists[]`	`ServingConfigList` Output only. The list of valid serving configs associated with the PageOptimizationConfig.
`model_features_config`	`ModelFeaturesConfig` Optional. Additional model features config.

ContextProductsType

Use single or multiple context products for recommendations.

Enums
`CONTEXT_PRODUCTS_TYPE_UNSPECIFIED`	Unspecified default value, should never be explicitly set. Defaults to `MULTIPLE_CONTEXT_PRODUCTS`.
`SINGLE_CONTEXT_PRODUCT`	Use only a single product as context for the recommendation. Typically used on pages like add-to-cart or product details.
`MULTIPLE_CONTEXT_PRODUCTS`	Use one or multiple products as context for the recommendation. Typically used on shopping cart pages.

DataState

Describes whether this model have sufficient training data to be continuously trained.

Enums
`DATA_STATE_UNSPECIFIED`	Unspecified default value, should never be explicitly set.
`DATA_OK`	The model has sufficient training data.
`DATA_ERROR`	The model does not have sufficient training data. Error messages can be queried via Stackdriver.

FrequentlyBoughtTogetherFeaturesConfig

Additional configs for the frequently-bought-together model type.

Fields

context_products_type

ContextProductsType

Optional. Specifies the context of the model when it is used in predict requests. Can only be set for the frequently-bought-together type. If it isn't specified, it defaults to MULTIPLE_CONTEXT_PRODUCTS.

ModelFeaturesConfig

Additional model features config.

Fields

Union field type_dedicated_config.

type_dedicated_config can be only one of the following:

frequently_bought_together_config

Additional configs for frequently-bought-together models.

PeriodicTuningState

Describes whether periodic tuning is enabled for this model or not. Periodic tuning is scheduled at most every three months. You can start a tuning process manually by using the TuneModel method, which starts a tuning process immediately and resets the quarterly schedule. Enabling or disabling periodic tuning does not affect any current tuning processes.

Enums
`PERIODIC_TUNING_STATE_UNSPECIFIED`	Unspecified default value, should never be explicitly set.
`PERIODIC_TUNING_DISABLED`	The model has periodic tuning disabled. Tuning can be reenabled by calling the `EnableModelPeriodicTuning` method or by calling the `TuneModel` method.
`ALL_TUNING_DISABLED`	The model cannot be tuned with periodic tuning OR the `TuneModel` method. Hide the options in customer UI and reject any requests through the backend self serve API.
`PERIODIC_TUNING_ENABLED`	The model has periodic tuning enabled. Tuning can be disabled by calling the `DisableModelPeriodicTuning` method.

ServingConfigList

Represents an ordered combination of valid serving configs, which can be used for PAGE_OPTIMIZATION recommendations.

Fields

serving_config_ids[]

string

Optional. A set of valid serving configs that may be used for PAGE_OPTIMIZATION.

ServingState

The serving state of the model.

Enums
`SERVING_STATE_UNSPECIFIED`	Unspecified serving state.
`INACTIVE`	The model is not serving.
`ACTIVE`	The model is serving and can be queried.
`TUNED`	The model is trained on tuned hyperparameters and can be queried.

TrainingState

The training state of the model.

Enums
`TRAINING_STATE_UNSPECIFIED`	Unspecified training state.
`PAUSED`	The model training is paused.
`TRAINING`	The model is training.

OutputConfig

The output configuration setting.

Fields

Union field destination. The configuration of destination for holding output data. destination can be only one of the following:

gcs_destination

GcsDestination

The Google Cloud Storage location where the output is to be written to.

bigquery_destination

BigQueryDestination

The BigQuery location where the output is to be written to.

BigQueryDestination

The BigQuery output destination configuration.

Fields

dataset_id

string

Required. The ID of a BigQuery Dataset.

table_id_prefix

string

Required. The prefix of exported BigQuery tables.

table_type

string

Required. Describes the table type. The following values are supported:

table: A BigQuery native table.
view: A virtual table defined by a SQL query.

GcsDestination

The Google Cloud Storage output destination configuration.

Fields

output_uri_prefix

string

Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: output_uri_prefix sample output(assuming the object is foo.json) ======================== ============================================= gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json

OutputResult

Output result that stores the information about where the exported data is stored.

Fields

bigquery_result[]

BigQueryOutputResult

The BigQuery location where the result is stored.

gcs_result[]

GcsOutputResult

The Google Cloud Storage location where the result is stored.

PauseModelRequest

Request for pausing training of a model.

Fields

name

string

Required. The name of the model to pause. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

PredictRequest

Request message for Predict method.

Fields
`placement`	`string` 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. The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
`user_event`	`UserEvent` Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set `UserEvent.visitor_id` or `UserInfo.user_id` to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set `UserEvent.visitor_id` to a random unique ID and leave `UserInfo.user_id` unset.
`page_size`	`int32` Maximum number of results to return. Set this property to the number of prediction results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100.
`page_token (deprecated)`	`string` This item is deprecated! This field is not used; leave it unset.
`filter`	`string` Filter for restricting prediction results with a length limit of 5,000 characters. Accepts values for tags and the `filterOutOfStockItems` flag. Tag expressions. Restricts predictions to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. `-"tagA"` is also supported and is equivalent to `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings with a size limit of 1,000 characters. Note: "Recently viewed" models don't support tag filtering at the moment. filterOutOfStockItems. Restricts predictions to products that do not have a stockState value of OUT_OF_STOCK. Examples: tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") filterOutOfStockItems tag=(-"promotional") filterOutOfStockItems If your filter blocks all prediction results, the API will return no results. If instead you want empty result sets to return generic (unfiltered) popular products, set `strictFiltering` to False in `PredictRequest.params`. Note that the API will never return items with storageStatus of "EXPIRED" or "DELETED" regardless of filter choices. If `filterSyntaxV2` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones")) (availability: ANY("IN_STOCK")) AND (colors: ANY("Red") OR categories: ANY("Phones")) For more information, see Filter recommendations.
`validate_only`	`bool` Use validate only mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary products. Note that the validate only mode should only be used for testing the API, or if the model is not ready.
`params`	`map<string, Value>` Additional domain specific parameters for the predictions. Allowed values: `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. `returnScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given 'score' indicates the probability of a product being clicked/purchased given the user's context and history. `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction results. `priceRerankLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-price-reranking', 'low-price-reranking', 'medium-price-reranking', 'high-price-reranking'}. This gives request-level control and adjusts prediction results based on product price. `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-diversity', 'low-diversity', 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives request-level control and adjusts prediction results based on product category. `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter` field is interpreteted according to the new, attribute-based syntax.
`labels`	`map<string, string>` The labels applied to a resource must meet the following requirements: Each resource can have multiple labels, up to a maximum of 64. Each label must be a key-value pair. Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. The key portion of a label must be unique. However, you can use the same key with multiple resources. Keys must start with a lowercase letter or international character. See Google Cloud Document for more details.

PredictResponse

Response message for predict method.

Fields
`results[]`	`PredictionResult` A list of recommended products. The order represents the ranking (from the most relevant product to the least).
`attribution_token`	`string` A unique attribution token. This should be included in the `UserEvent` logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.
`missing_ids[]`	`string` IDs of products in the request that were missing from the inventory.
`validate_only`	`bool` True if the validateOnly property was set in the request.

PredictionResult

PredictionResult represents the recommendation prediction results.

Fields

id

string

ID of the recommended product

metadata

map<string, Value>

Additional product metadata / annotations.

Possible values:

product: JSON representation of the product. Is set if returnProduct is set to true in PredictRequest.params.
score: Prediction score in double value. Is set if returnScore is set to true in PredictRequest.params.

PriceInfo

The price information of a Product.

Fields
`currency_code`	`string` The 3-letter currency code defined in ISO 4217. If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The `Product.Type.VARIANT` `Product`s with the same `Product.primary_product_id` must share the same `currency_code`. Otherwise, a FAILED_PRECONDITION error is returned.
`price`	`float` Price of the product. Google Merchant Center property price. Schema.org property Offer.price.
`original_price`	`float` Price of the product without any discount. If zero, by default set to be the `price`. If set, `original_price` should be greater than or equal to `price`, otherwise an INVALID_ARGUMENT error is thrown.
`cost`	`float` The costs associated with the sale of a particular product. Used for gross profit reporting. Profit = `price` - `cost` Google Merchant Center property cost_of_goods_sold.
`price_effective_time`	`Timestamp` The timestamp when the `price` starts to be effective. This can be set as a future timestamp, and the `price` is only used for search after `price_effective_time`. If so, the `original_price` must be set and `original_price` is used before `price_effective_time`. Do not set if `price` is always effective because it will cause additional latency during search.
`price_expire_time`	`Timestamp` The timestamp when the `price` stops to be effective. The `price` is used for search before `price_expire_time`. If this field is set, the `original_price` must be set and `original_price` is used after `price_expire_time`. Do not set if `price` is always effective because it will cause additional latency during search.
`price_range`	`PriceRange` Output only. The price range of all the child `Product.Type.VARIANT` `Product`s grouped together on the `Product.Type.PRIMARY` `Product`. Only populated for `Product.Type.PRIMARY` `Product`s. Note: This field is OUTPUT_ONLY for `ProductService.GetProduct`. Do not set this field in API requests.

PriceRange

The price range of all variant Product having the same Product.primary_product_id.

Fields

price

Interval

The inclusive Product.pricing_info.price interval of all variant Product having the same Product.primary_product_id.

original_price

Interval

The inclusive Product.pricing_info.original_price internal of all variant Product having the same Product.primary_product_id.

Product

Product captures all metadata information of items to be recommended or searched.

Fields
`name`	`string` Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.
`id`	`string` Immutable. `Product` identifier, which is the final component of `name`. For example, this field is "id_1", if `name` is `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property id. Schema.org property Product.sku.
`type`	`Type` Immutable. The type of the product. Default to `Catalog.product_level_config.ingestion_product_type` if unset.
`primary_product_id`	`string` Variant group identifier. Must be an `id`, with the same parent branch with this product. Otherwise, an error is thrown. For `Type.PRIMARY` `Product`s, this field can only be empty or set to the same value as `id`. For VARIANT `Product`s, this field cannot be empty. A maximum of 2,000 products are allowed to share the same `Type.PRIMARY` `Product`. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property item_group_id. Schema.org property Product.inProductGroupWithID.
`collection_member_ids[]`	`string` The `id` of the collection members when `type` is `Type.COLLECTION`. Non-existent product ids are allowed. The `type` of the members must be either `Type.PRIMARY` or `Type.VARIANT` otherwise an INVALID_ARGUMENT error is thrown. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return.
`gtin`	`string` The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property gtin. Schema.org property Product.isbn, Product.gtin8, Product.gtin12, Product.gtin13, or Product.gtin14. If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.
`categories[]`	`string` Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: `"categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic Clothing > Shoes" ]` Must be set for `Type.PRIMARY` `Product` otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per `Product` unless overridden through the Google Cloud console. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property google_product_category. Schema.org property Product.category.
`title`	`string` Required. Product title. This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property title. Schema.org property Product.name.
`brands[]`	`string` The brands of the product. A maximum of 30 brands are allowed unless overridden through the Google Cloud console. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property brand. Schema.org property Product.brand.
`description`	`string` Product description. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property description. Schema.org property Product.description.
`language_code`	`string` Language of the title/description and other string attributes. Use language tags defined by BCP 47. For product prediction, this field is ignored and the model automatically detects the text language. The `Product` can include text in different languages, but duplicating `Product`s to provide text in multiple languages can result in degraded model performance. For product search this field is in use. It defaults to "en-US" if unset.
`attributes`	`map<string, CustomAttribute>` Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer. For example: `{ "vendor": {"text": ["vendor123", "vendor456"]}, "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]} }`. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: Max entries count: 200. The key must be a UTF-8 encoded string with a length limit of 128 characters. For indexable attribute, the key must match the pattern: `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, `key0LikeThis` or `KEY_1_LIKE_THIS`. For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a non-empty UTF-8 encoded string with a length limit of 256 characters. For number attributes, at most 400 values are allowed.
`tags[]`	`string` Custom tags associated with the product. At most 250 values are allowed per `Product`. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the `PredictRequest.filter`. Corresponding properties: Google Merchant Center property custom_label_0–4.
`price_info`	`PriceInfo` Product price and cost information. Corresponding properties: Google Merchant Center property price.
`rating`	`Rating` The rating of this product.
`available_time`	`Timestamp` The timestamp when this `Product` becomes available for `SearchService.Search`. Note that this is only applicable to `Type.PRIMARY` and `Type.COLLECTION`, and ignored for `Type.VARIANT`.
`availability`	`Availability` The online availability of the `Product`. Default to `Availability.IN_STOCK`. For primary products with variants set the availability of the primary as `Availability.OUT_OF_STOCK` and set the true availability at the variant level. This way the primary product will be considered "in stock" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property availability. Schema.org property Offer.availability.
`available_quantity`	`Int32Value` The available quantity of the item.
`fulfillment_info[]`	`FulfillmentInfo` Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods. All the elements must have distinct `FulfillmentInfo.type`. Otherwise, an INVALID_ARGUMENT error is returned.
`uri`	`string` Canonical URL directly linking to the product detail page. It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be significantly degraded. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property link. Schema.org property Offer.url.
`images[]`	`Image` Product images for the product. We highly recommend putting the main image first. A maximum of 300 images are allowed. Corresponding properties: Google Merchant Center property image_link. Schema.org property Product.image.
`audience`	`Audience` The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product.
`color_info`	`ColorInfo` The color of the product. Corresponding properties: Google Merchant Center property color. Schema.org property Product.color.
`sizes[]`	`string` The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per `Product`. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property size, size_type, and size_system. Schema.org property Product.size.
`materials[]`	`string` The material of the product. For example, "leather", "wooden". A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property material. Schema.org property Product.material.
`patterns[]`	`string` The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley". A maximum of 20 values are allowed per `Product`. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property pattern. Schema.org property Product.pattern.
`conditions[]`	`string` The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used". A maximum of 1 value is allowed per `Product`. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property condition. Schema.org property Offer.itemCondition.
`promotions[]`	`Promotion` The promotions applied to the product. A maximum of 10 values are allowed per `Product`. Only `Promotion.promotion_id` will be used, other fields will be ignored if set.
`publish_time`	`Timestamp` The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from `available_time`, given it purely describes product freshness regardless of when it is available on search and recommendation.
`retrievable_fields (deprecated)`	`FieldMask` This item is deprecated! Indicates which fields in the `Product`s are returned in `SearchResponse`. Supported fields for all `type`s: `audience` `availability` `brands` `color_info` `conditions` `gtin` `materials` `name` `patterns` `price_info` `rating` `sizes` `title` `uri` Supported fields only for `Type.PRIMARY` and `Type.COLLECTION`: `categories` `description` `images` Supported fields only for `Type.VARIANT`: Only the first image in `images` To mark `attributes` as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in `attributes`. For `Type.PRIMARY` and `Type.COLLECTION`, the following fields are always returned in `SearchResponse` by default: `name` For `Type.VARIANT`, the following fields are always returned in by default: `name` `color_info` The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in `SearchResponse` can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.
`variants[]`	`Product` Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by `primary_product_id` for all the product variants. Only populated for `Type.PRIMARY` `Product`s. Note: This field is OUTPUT_ONLY for `ProductService.GetProduct`. Do not set this field in API requests.
`local_inventories[]`	`LocalInventory` Output only. A list of local inventories specific to different places. This field can be managed by `ProductService.AddLocalInventories` and `ProductService.RemoveLocalInventories` APIs if fine-grained, high-volume updates are necessary.
Union field `expiration`. `expiration` can be only one of the following:
`expire_time`	`Timestamp` Note that this field is applied in the following ways: If the `Product` is already expired when it is uploaded, this product is not indexed for search. If the `Product` is not expired when it is uploaded, only the `Type.PRIMARY`'s and `Type.COLLECTION`'s expireTime is respected, and `Type.VARIANT`'s expireTime is not used. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. `expire_time` must be later than `available_time` and `publish_time`, otherwise an INVALID_ARGUMENT error is thrown. Corresponding properties: Google Merchant Center property expiration_date.
`ttl`	`Duration` Input only. The TTL (time to live) of the product. Note that this is only applicable to `Type.PRIMARY` and `Type.COLLECTION`, and ignored for `Type.VARIANT`. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, it must be a non-negative value, and `expire_time` is set as current timestamp plus `ttl`. The derived `expire_time` is returned in the output and `ttl` is left blank when retrieving the `Product`. If it is set, the product is not available for `SearchService.Search` after current timestamp plus `ttl`. However, the product can still be retrieved by `ProductService.GetProduct` and `ProductService.ListProducts`.

Availability

Product availability. If this field is unspecified, the product is assumed to be in stock.

Enums
`AVAILABILITY_UNSPECIFIED`	Default product availability. Default to `Availability.IN_STOCK` if unset.
`IN_STOCK`	Product in stock.
`OUT_OF_STOCK`	Product out of stock.
`PREORDER`	Product that is in pre-order state.
`BACKORDER`	Product that is back-ordered (i.e. temporarily out of stock).

Type

The type of this product.

Enums
`TYPE_UNSPECIFIED`	Default value. Default to `Catalog.product_level_config.ingestion_product_type` if unset.
`PRIMARY`	The primary type. As the primary unit for predicting, indexing and search serving, a `Type.PRIMARY` `Product` is grouped with multiple `Type.VARIANT` `Product`s.
`VARIANT`	The variant type. `Type.VARIANT` `Product`s usually share some common attributes on the same `Type.PRIMARY` `Product`s, but they have variant attributes like different colors, sizes and prices, etc.
`COLLECTION`	The collection type. Collection products are bundled `Type.PRIMARY` `Product`s or `Type.VARIANT` `Product`s that are sold together, such as a jewelry set with necklaces, earrings and rings, etc.

ProductAttributeInterval

Product attribute name and numeric interval.

Fields

name

string

The attribute name (e.g. "length")

interval

Interval

The numeric interval (e.g. [10, 20))

ProductAttributeValue

Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have name=color and value=red, this means that the color is red.

Fields

name

string

The attribute name.

value

string

The attribute value.

ProductDetail

Detailed product information associated with a user event.

Fields

product

Required. Product information.

Required field(s):

Product.id

Optional override field(s):

Product.price_info

If any supported optional fields are provided, we will treat them as a full override when looking up product information from the catalog. Thus, it is important to ensure that the overriding fields are accurate and complete.

All other product fields are ignored and instead populated via catalog lookup after event ingestion.

quantity

Int32Value

Quantity of the product associated with the user event.

For example, this field will be 2 if two products are added to the shopping cart for purchase-complete event. Required for add-to-cart and purchase-complete event types.

ProductInlineSource

The inline source for the input config for ImportProducts method.

Fields

products[]