As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Retail v2beta API

class google.cloud.retail_v2beta.types.AddCatalogAttributeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for [CatalogService.AddCatalogAttribute][google.cloud.retail.v2beta.CatalogService.AddCatalogAttribute] method.

attributes_config

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

Type

str

catalog_attribute

Required. The [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to add.

Type

google.cloud.retail_v2beta.types.CatalogAttribute

class google.cloud.retail_v2beta.types.AddControlRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for AddControl method.

serving_config

Required. The source ServingConfig resource name . Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}

Type

str

control_id

Required. The id of the control to apply. Assumed to be in the same catalog as the serving config - if id is not found a NOT_FOUND error is returned.

Type

str

class google.cloud.retail_v2beta.types.AddFulfillmentPlacesMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.AddFulfillmentPlaces] method.

class google.cloud.retail_v2beta.types.AddFulfillmentPlacesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.AddFulfillmentPlaces] method.

product

Required. Full resource name of [Product][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Type

str

type_

Required. The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types.

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.

This field directly corresponds to [Product.fulfillment_info.type][google.cloud.retail.v2beta.FulfillmentInfo.type].

Type

str

place_ids

Required. The IDs for this [type][google.cloud.retail.v2beta.AddFulfillmentPlacesRequest.type], such as the store IDs for “pickup-in-store” or the region IDs for “same-day-delivery” to be added for this [type][google.cloud.retail.v2beta.AddFulfillmentPlacesRequest.type]. Duplicate IDs will be automatically ignored.

At least 1 value is required, and a maximum of 2000 values are allowed. Each value must be a string with a length limit of 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as “store1” or “REGION-2”. Otherwise, an INVALID_ARGUMENT error is returned.

If the total number of place IDs exceeds 2000 for this [type][google.cloud.retail.v2beta.AddFulfillmentPlacesRequest.type] after adding, then the update will be rejected.

Type

MutableSequence[str]

add_time

The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information. If not provided, the internal system time will be used.

Type

google.protobuf.timestamp_pb2.Timestamp

allow_missing

If set to true, and the [Product][google.cloud.retail.v2beta.Product] is not found, the fulfillment information will still be processed and retained for at most 1 day and processed once the [Product][google.cloud.retail.v2beta.Product] is created. If set to false, a NOT_FOUND error is returned if the [Product][google.cloud.retail.v2beta.Product] is not found.

Type

bool

class google.cloud.retail_v2beta.types.AddFulfillmentPlacesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.AddFulfillmentPlaces] method.

class google.cloud.retail_v2beta.types.AddLocalInventoriesMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories] method.

class google.cloud.retail_v2beta.types.AddLocalInventoriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories] method.

product

Required. Full resource name of [Product][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Type

str

local_inventories

Required. A list of inventory information at difference places. Each place is identified by its place ID. At most 3000 inventories are allowed per request.

Type

MutableSequence[google.cloud.retail_v2beta.types.LocalInventory]

add_mask

Indicates which inventory fields in the provided list of [LocalInventory][google.cloud.retail.v2beta.LocalInventory] to update. The field is updated to the provided value.

If a field is set while the place does not have a previous local inventory, the local inventory at that store is created.

If a field is set while the value of that field is not provided, the original field value, if it exists, is deleted.

If the mask is not set or set with empty paths, all inventory fields will be updated.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.

Type

google.protobuf.field_mask_pb2.FieldMask

add_time

The time when the inventory updates are issued. Used to prevent out-of-order updates on local inventory fields. If not provided, the internal system time will be used.

Type

google.protobuf.timestamp_pb2.Timestamp

allow_missing

If set to true, and the [Product][google.cloud.retail.v2beta.Product] is not found, the local inventory will still be processed and retained for at most 1 day and processed once the [Product][google.cloud.retail.v2beta.Product] is created. If set to false, a NOT_FOUND error is returned if the [Product][google.cloud.retail.v2beta.Product] is not found.

Type

bool

class google.cloud.retail_v2beta.types.AddLocalInventoriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response of the [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories] API. Currently empty because there is no meaningful response populated from the [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories] method.

class google.cloud.retail_v2beta.types.AlertConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Project level alert config.

name

Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig

Type

str

alert_policies

Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]

Type

MutableSequence[google.cloud.retail_v2beta.types.AlertConfig.AlertPolicy]

class AlertPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Alert policy for a customer.

alert_group

The feature that provides alerting capability. Supported value:

• search-data-quality for retail search customers.

• conv-data-quality for retail conversation customers.

Type

str

enroll_status

The enrollment status of a customer.

Type

google.cloud.retail_v2beta.types.AlertConfig.AlertPolicy.EnrollStatus

recipients

Recipients for the alert policy. One alert policy should not exceed 20 recipients.

Type

MutableSequence[google.cloud.retail_v2beta.types.AlertConfig.AlertPolicy.Recipient]

class EnrollStatus(value)

Bases: proto.enums.Enum

The enrollment status enum for alert policy.

Values:

ENROLL_STATUS_UNSPECIFIED (0):

Default value. Used for customers who have not responded to the alert policy.

ENROLLED (1):

Customer is enrolled in this policy.

DECLINED (2):

Customer declined this policy.

class Recipient(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Recipient contact information.

email_address

Email address of the recipient.

Type

str

class google.cloud.retail_v2beta.types.AttributeConfigLevel(value)

Bases: proto.enums.Enum

At which level we offer configuration for attributes.

Values:

ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED (0):

Value used when unset. In this case, server behavior defaults to [CATALOG_LEVEL_ATTRIBUTE_CONFIG][google.cloud.retail.v2beta.AttributeConfigLevel.CATALOG_LEVEL_ATTRIBUTE_CONFIG].

PRODUCT_LEVEL_ATTRIBUTE_CONFIG (1):

At this level, we honor the attribute configurations set in [Product.attributes][google.cloud.retail.v2beta.Product.attributes].

CATALOG_LEVEL_ATTRIBUTE_CONFIG (2):

At this level, we honor the attribute configurations set in [CatalogConfig.attribute_configs][].

class google.cloud.retail_v2beta.types.AttributesConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Catalog level attribute config.

name

Required. Immutable. The fully qualified resource name of the attribute config. Format: projects/*/locations/*/catalogs/*/attributesConfig

Type

str

catalog_attributes

Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute.

The key is catalog attribute’s name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz.

The maximum number of catalog attributes allowed in a request is 1000.

Type

MutableMapping[str, google.cloud.retail_v2beta.types.CatalogAttribute]

attribute_config_level

Output only. The [AttributeConfigLevel][google.cloud.retail.v2beta.AttributeConfigLevel] used for this catalog.

Type

google.cloud.retail_v2beta.types.AttributeConfigLevel

class CatalogAttributesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.retail_v2beta.types.Audience(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An intended audience of the [Product][google.cloud.retail.v2beta.Product] for whom it’s sold.

genders

The genders of the audience. Strongly encouraged to use the standard values: “male”, “female”, “unisex”.

At most 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 gender. Schema.org property Product.audience.suggestedGender.

Type

MutableSequence[str]

age_groups

The age groups of the audience. Strongly encouraged to use the standard values: “newborn” (up to 3 months old), “infant” (3–12 months old), “toddler” (1–5 years old), “kids” (5–13 years old), “adult” (typically teens or older).

At most 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 age_group. Schema.org property Product.audience.suggestedMinAge and Product.audience.suggestedMaxAge.

Type

MutableSequence[str]

class google.cloud.retail_v2beta.types.BatchRemoveCatalogAttributesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for [CatalogService.BatchRemoveCatalogAttributes][google.cloud.retail.v2beta.CatalogService.BatchRemoveCatalogAttributes] method.

attributes_config

Required. The attributes config resource shared by all catalog attributes being deleted. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

Type

str

attribute_keys

Required. The attribute name keys of the [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute]s to delete. A maximum of 1000 catalog attributes can be deleted in a batch.

Type

MutableSequence[str]

class google.cloud.retail_v2beta.types.BatchRemoveCatalogAttributesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response of the [CatalogService.BatchRemoveCatalogAttributes][google.cloud.retail.v2beta.CatalogService.BatchRemoveCatalogAttributes].

deleted_catalog_attributes

Catalog attributes that were deleted. Only pre-loaded [catalog attributes][google.cloud.retail.v2beta.CatalogAttribute] that are neither [in use][google.cloud.retail.v2beta.CatalogAttribute.in_use] by products nor predefined can be deleted.

Type

MutableSequence[str]

reset_catalog_attributes

Catalog attributes that were reset. [Catalog attributes][google.cloud.retail.v2beta.CatalogAttribute] that are either [in use][google.cloud.retail.v2beta.CatalogAttribute.in_use] by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request.

Type

MutableSequence[str]

class google.cloud.retail_v2beta.types.BatchUpdateGenerativeQuestionConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for BatchUpdateGenerativeQuestionConfig method.

parent

Optional. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}

Type

str

requests

Required. The updates question configs.

Type

MutableSequence[google.cloud.retail_v2beta.types.UpdateGenerativeQuestionConfigRequest]

class google.cloud.retail_v2beta.types.BatchUpdateGenerativeQuestionConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Aggregated response for UpdateGenerativeQuestionConfig method.

generative_question_configs

Optional. The updates question configs.

Type

MutableSequence[google.cloud.retail_v2beta.types.GenerativeQuestionConfig]

class google.cloud.retail_v2beta.types.BigQueryOutputResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A BigQuery output result.

dataset_id

The ID of a BigQuery Dataset.

Type

str

table_id

The ID of a BigQuery Table.

Type

str

class google.cloud.retail_v2beta.types.BigQuerySource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

BigQuery source import data from.

partition_date

BigQuery time partitioned table’s _PARTITIONDATE in YYYY-MM-DD format.

Only supported in [ImportProductsRequest][google.cloud.retail.v2beta.ImportProductsRequest].

This field is a member of oneof partition.

Type

google.type.date_pb2.Date

project_id

The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

Type

str

dataset_id

Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.

Type

str

table_id

Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.

Type

str

gcs_staging_dir

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.

Type

str

data_schema

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

Supported values for product imports:

• product (default): One JSON [Product][google.cloud.retail.v2beta.Product] per line. Each product must have a valid [Product.id][google.cloud.retail.v2beta.Product.id].

• product_merchant_center: See Importing catalog data from Merchant Center.

Supported values for user events imports:

• user_event (default): One JSON [UserEvent][google.cloud.retail.v2beta.UserEvent] per line.

• user_event_ga360: The schema is available here: https://support.google.com/analytics/answer/3437719.

• user_event_ga4: The schema is available here: https://support.google.com/analytics/answer/7029846.

Supported values for autocomplete imports:

• suggestions (default): One JSON completion suggestion per line.

• denylist: One JSON deny suggestion per line.

• allowlist: One JSON allow suggestion per line.

Type

str

class google.cloud.retail_v2beta.types.Catalog(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The catalog configuration.

name

Required. Immutable. The fully qualified resource name of the catalog.

Type

str

display_name

Required. Immutable. The catalog display name.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Type

str

product_level_config

Required. The product level configuration.

Type

google.cloud.retail_v2beta.types.ProductLevelConfig

merchant_center_linking_config

The Merchant Center linking configuration. After a link is added, the data stream from Merchant Center to Cloud Retail will be enabled automatically. The requester must have access to the Merchant Center account in order to make changes to this field.

Type

google.cloud.retail_v2beta.types.MerchantCenterLinkingConfig

class google.cloud.retail_v2beta.types.CatalogAttribute(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.

key

Required. Attribute name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute named attributes.abc_xyz can be indexed, but an attribute named attributes.abc-xyz cannot be indexed.

If the attribute key starts with attributes., then the attribute is a custom attribute. Attributes such as brands, patterns, and title are built-in and called system attributes.

Type

str

in_use

Output only. Indicates whether this attribute has been used by any products. True if at least one [Product][google.cloud.retail.v2beta.Product] is using this attribute in [Product.attributes][google.cloud.retail.v2beta.Product.attributes]. Otherwise, this field is False.

[CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] can be pre-loaded by using [CatalogService.AddCatalogAttribute][google.cloud.retail.v2beta.CatalogService.AddCatalogAttribute], [CatalogService.ImportCatalogAttributes][], or [CatalogService.UpdateAttributesConfig][google.cloud.retail.v2beta.CatalogService.UpdateAttributesConfig] APIs. This field is False for pre-loaded [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute]s.

Only pre-loaded [catalog attributes][google.cloud.retail.v2beta.CatalogAttribute] that are neither in use by products nor predefined can be deleted. [Catalog attributes][google.cloud.retail.v2beta.CatalogAttribute] that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request.

After catalog changes, it takes about 10 minutes for this field to update.

Type

bool

type_

Output only. The type of this attribute. This is derived from the attribute in [Product.attributes][google.cloud.retail.v2beta.Product.attributes].

Type

google.cloud.retail_v2beta.types.CatalogAttribute.AttributeType

indexable_option

When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].

Must be specified when [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.

Type

google.cloud.retail_v2beta.types.CatalogAttribute.IndexableOption

dynamic_facetable_option

If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if [CatalogAttribute.indexable_option][google.cloud.retail.v2beta.CatalogAttribute.indexable_option] is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.

Must be specified, otherwise throws INVALID_FORMAT error.

Type

google.cloud.retail_v2beta.types.CatalogAttribute.DynamicFacetableOption

searchable_option

When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].

If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search], as there are no text values associated to numerical attributes.

Must be specified, when [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.

Type

google.cloud.retail_v2beta.types.CatalogAttribute.SearchableOption

recommendations_filtering_option

When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations. This option works for categorical features only, does not work for numerical features, inventory filtering.

Type

google.cloud.retail_v2beta.types.RecommendationsFilteringOption

exact_searchable_option

If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to [EXACT_SEARCHABLE_DISABLED][google.cloud.retail.v2beta.CatalogAttribute.ExactSearchableOption.EXACT_SEARCHABLE_DISABLED].

Type

google.cloud.retail_v2beta.types.CatalogAttribute.ExactSearchableOption

retrievable_option

If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to [RETRIEVABLE_DISABLED][google.cloud.retail.v2beta.CatalogAttribute.RetrievableOption.RETRIEVABLE_DISABLED].

Type

google.cloud.retail_v2beta.types.CatalogAttribute.RetrievableOption

facet_config

Contains facet options.

Type

google.cloud.retail_v2beta.types.CatalogAttribute.FacetConfig

class AttributeType(value)

Bases: proto.enums.Enum

The type of an attribute.

Values:

UNKNOWN (0):

The type of the attribute is unknown.

Used when type cannot be derived from attribute that is not [in_use][google.cloud.retail.v2beta.CatalogAttribute.in_use].

TEXTUAL (1):

Textual attribute.

NUMERICAL (2):

Numerical attribute.

class DynamicFacetableOption(value)

Bases: proto.enums.Enum

The status of the dynamic facetable option of a catalog attribute.

Values:

DYNAMIC_FACETABLE_OPTION_UNSPECIFIED (0):

Value used when unset.

DYNAMIC_FACETABLE_ENABLED (1):

Dynamic facetable option enabled for an attribute.

DYNAMIC_FACETABLE_DISABLED (2):

Dynamic facetable option disabled for an attribute.

class ExactSearchableOption(value)

Bases: proto.enums.Enum

The status of the exact-searchable option of a catalog attribute.

Values:

EXACT_SEARCHABLE_OPTION_UNSPECIFIED (0):

Value used when unset.

EXACT_SEARCHABLE_ENABLED (1):

Exact searchable option enabled for an attribute.

EXACT_SEARCHABLE_DISABLED (2):

Exact searchable option disabled for an attribute.

class FacetConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Possible options for the facet that corresponds to the current attribute config.

facet_intervals

If you don’t set the facet [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.intervals] in the request to a numerical attribute, then we use the computed intervals with rounded bounds obtained from all its product numerical attribute values. The computed intervals might not be ideal for some attributes. Therefore, we give you the option to overwrite them with the facet_intervals field. The maximum of facet intervals per [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] is 40. Each interval must have a lower bound or an upper bound. If both bounds are provided, then the lower bound must be smaller or equal than the upper bound.

Type

MutableSequence[google.cloud.retail_v2beta.types.Interval]

ignored_facet_values

Each instance represents a list of attribute values to ignore as facet values for a specific time range. The maximum number of instances per [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] is 25.

Type

MutableSequence[google.cloud.retail_v2beta.types.CatalogAttribute.FacetConfig.IgnoredFacetValues]

merged_facet_values

Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if “dark_blue” merged into “BLUE”, then the latter can’t merge into “blues” because this would create a path of length 2. The maximum number of instances of MergedFacetValue per [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] is 100. This feature is available only for textual custom attributes.

Type

MutableSequence[google.cloud.retail_v2beta.types.CatalogAttribute.FacetConfig.MergedFacetValue]

merged_facet

Use this field only if you want to merge a facet key into another facet key.

Type

google.cloud.retail_v2beta.types.CatalogAttribute.FacetConfig.MergedFacet

rerank_config

Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.

Type

google.cloud.retail_v2beta.types.CatalogAttribute.FacetConfig.RerankConfig

class IgnoredFacetValues(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

[Facet values][google.cloud.retail.v2beta.SearchResponse.Facet.values] to ignore on [facets][google.cloud.retail.v2beta.SearchResponse.Facet] during the specified time range for the given [SearchResponse.Facet.key][google.cloud.retail.v2beta.SearchResponse.Facet.key] attribute.

values

List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.

Type

MutableSequence[str]

start_time

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.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

class MergedFacet(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The current facet key (i.e. attribute config) maps into the [merged_facet_key][google.cloud.retail.v2beta.CatalogAttribute.FacetConfig.MergedFacet.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).

merged_facet_key

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.

Type

str

class MergedFacetValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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][google.cloud.retail.v2beta.CatalogAttribute]. This feature is available only for textual custom attributes.

values

All the facet values that are replaces by the same [merged_value][google.cloud.retail.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue.merged_value] that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters.

Type

MutableSequence[str]

merged_value

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.

Type

str

class RerankConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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).

rerank_facet

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.

Type

bool

facet_values

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

Type

MutableSequence[str]

class IndexableOption(value)

Bases: proto.enums.Enum

The status of the indexable option of a catalog attribute.

Values:

INDEXABLE_OPTION_UNSPECIFIED (0):

Value used when unset.

INDEXABLE_ENABLED (1):

Indexable option enabled for an attribute.

INDEXABLE_DISABLED (2):

Indexable option disabled for an attribute.

class RetrievableOption(value)

Bases: proto.enums.Enum

The status of the retrievable option of a catalog attribute.

Values:

RETRIEVABLE_OPTION_UNSPECIFIED (0):

Value used when unset.

RETRIEVABLE_ENABLED (1):

Retrievable option enabled for an attribute.

RETRIEVABLE_DISABLED (2):

Retrievable option disabled for an attribute.

class SearchableOption(value)

Bases: proto.enums.Enum

The status of the searchable option of a catalog attribute.

Values:

SEARCHABLE_OPTION_UNSPECIFIED (0):

Value used when unset.

SEARCHABLE_ENABLED (1):

Searchable option enabled for an attribute.

SEARCHABLE_DISABLED (2):

Searchable option disabled for an attribute.

class google.cloud.retail_v2beta.types.CollectUserEventRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for CollectUserEvent method.

prebuilt_rule

The prebuilt rule name that can convert a specific type of raw_json. For example: “ga4_bq” rule for the GA4 user event schema.

This field is a member of oneof conversion_rule.

Type

str

parent

Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog.

Type

str

user_event

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

Type

str

uri

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.

Type

str

ets

The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

Type

int

raw_json

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.

Type

str

class google.cloud.retail_v2beta.types.ColorInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The color information of a [Product][google.cloud.retail.v2beta.Product].

color_families

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.

Type

MutableSequence[str]

colors

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.

Type

MutableSequence[str]

class google.cloud.retail_v2beta.types.CompleteQueryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Autocomplete parameters.

catalog

Required. Catalog for which the completion is performed.

Full resource name of catalog, such as projects/*/locations/global/catalogs/default_catalog.

Type

str

query

Required. The query used to generate suggestions. The maximum number of allowed characters is 255.

Type

str

visitor_id

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.

Type

str

language_codes

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.

Type

MutableSequence[str]

device_type

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.

Type

str

dataset

Determines which dataset to use for fetching completion. “user-data” will use the imported dataset through [CompletionService.ImportCompletionData][google.cloud.retail.v2beta.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.

Type

str

max_suggestions

Completion max suggestions. If left unset or set to 0, then will fallback to the configured value [CompletionConfig.max_suggestions][google.cloud.retail.v2beta.CompletionConfig.max_suggestions].

The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.

Type

int

enable_attribute_suggestions

If true, attribute suggestions are enabled and provided in the response. This field is only available for the “cloud-retail” dataset.

Type

bool

entity

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][google.cloud.retail.v2beta.UserEvent.entity] to get per-entity autocomplete results.

Type

str

class google.cloud.retail_v2beta.types.CompleteQueryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response of the autocomplete query.

completion_results

Results of the matching suggestions. The result list is ordered and the first result is top suggestion.

Type

MutableSequence[google.cloud.retail_v2beta.types.CompleteQueryResponse.CompletionResult]

attribution_token

A unique complete token. This should be included in the [UserEvent.completion_detail][google.cloud.retail.v2beta.UserEvent.completion_detail] for search events resulting from this completion, which enables accurate attribution of complete model performance.

Type

str

recent_search_results

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][google.cloud.retail.v2beta.CompleteQueryRequest.visitor_id] field is set and [UserEvent][google.cloud.retail.v2beta.UserEvent] is imported. The recent searches satisfy the follow rules:

• They are ordered from latest to oldest.

• They are matched with [CompleteQueryRequest.query][google.cloud.retail.v2beta.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.

Type

MutableSequence[google.cloud.retail_v2beta.types.CompleteQueryResponse.RecentSearchResult]

attribute_results

A map of matched attribute suggestions. This field is only available for “cloud-retail” dataset.

Current supported keys:

• brands

• categories

Type

MutableMapping[str, google.cloud.retail_v2beta.types.CompleteQueryResponse.AttributeResult]

class AttributeResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

suggestions

Type

MutableSequence[str]

class AttributeResultsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class CompletionResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Resource that represents completion results.

suggestion

The suggestion for the query.

Type

str

attributes

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][google.cloud.retail.v2beta.UserEvent.product_details] is imported properly.

Type

MutableMapping[str, google.cloud.retail_v2beta.types.CustomAttribute]

class AttributesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class RecentSearchResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Deprecated: Recent search of this user.

recent_search

The recent search query.

Type

str

class google.cloud.retail_v2beta.types.CompletionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig

Type

str

matching_order

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’.

Type

str

max_suggestions

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.

Type

int

min_prefix_length

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.

Type

int

auto_learning

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][google.cloud.retail.v2beta.CompleteQueryRequest].

Type

bool

suggestions_input_config

Output only. The source data for the latest import of the autocomplete suggestion phrases.

Type

google.cloud.retail_v2beta.types.CompletionDataInputConfig

last_suggestions_import_operation

Output only. Name of the LRO corresponding to the latest suggestion terms list import.

Can use [GetOperation][google.longrunning.Operations.GetOperation] API method to retrieve the latest state of the Long Running Operation.

Type

str

denylist_input_config

Output only. The source data for the latest import of the autocomplete denylist phrases.

Type

google.cloud.retail_v2beta.types.CompletionDataInputConfig

last_denylist_import_operation

Output only. Name of the LRO corresponding to the latest denylist import.

Can use [GetOperation][google.longrunning.Operations.GetOperation] API to retrieve the latest state of the Long Running Operation.

Type

str

allowlist_input_config

Output only. The source data for the latest import of the autocomplete allowlist phrases.

Type

google.cloud.retail_v2beta.types.CompletionDataInputConfig

last_allowlist_import_operation

Output only. Name of the LRO corresponding to the latest allowlist import.

Can use [GetOperation][google.longrunning.Operations.GetOperation] API to retrieve the latest state of the Long Running Operation.

Type

str

class google.cloud.retail_v2beta.types.CompletionDataInputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The input config source for completion data.

big_query_source

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.

This field is a member of oneof source.

Type

google.cloud.retail_v2beta.types.BigQuerySource

class google.cloud.retail_v2beta.types.CompletionDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

completion_attribution_token

Completion attribution token in [CompleteQueryResponse.attribution_token][google.cloud.retail.v2beta.CompleteQueryResponse.attribution_token].

Type

str

selected_suggestion

End user selected [CompleteQueryResponse.CompletionResult.suggestion][google.cloud.retail.v2beta.CompleteQueryResponse.CompletionResult.suggestion].

Type

str

selected_position

End user selected [CompleteQueryResponse.CompletionResult.suggestion][google.cloud.retail.v2beta.CompleteQueryResponse.CompletionResult.suggestion] position, starting from 0.

Type

int

class google.cloud.retail_v2beta.types.Condition(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

query_terms

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).

Type

MutableSequence[google.cloud.retail_v2beta.types.Condition.QueryTerm]

active_time_range

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

Type

MutableSequence[google.cloud.retail_v2beta.types.Condition.TimeRange]

page_categories

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][google.cloud.retail.v2beta.UserEvent.page_categories];

Type

MutableSequence[str]

class QueryTerm(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Query terms that we want to match on.

value

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.

Type

str

full_match

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

Type

bool

class TimeRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

start_time

Start of time range. Range is inclusive.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

End of time range. Range is inclusive.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.retail_v2beta.types.Control(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configures dynamic metadata that can be linked to a [ServingConfig][google.cloud.retail.v2beta.ServingConfig] and affect search or recommendation results at serving time.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

facet_spec

A facet specification to perform faceted search.

Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control.

This field is a member of oneof control.

Type

google.cloud.retail_v2beta.types.SearchRequest.FacetSpec

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”.

This field is a member of oneof control.

Type

google.cloud.retail_v2beta.types.Rule

name

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

Type

str

display_name

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.

Type

str

associated_serving_config_ids

Output only. List of [serving config][google.cloud.retail.v2beta.ServingConfig] ids that are associated with this control in the same [Catalog][google.cloud.retail.v2beta.Catalog].

Note the association is managed via the [ServingConfig][google.cloud.retail.v2beta.ServingConfig], this is an output only denormalized view.

Type

MutableSequence[str]

solution_types

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][google.cloud.retail.v2beta.SolutionType.SOLUTION_TYPE_SEARCH].

Type

MutableSequence[google.cloud.retail_v2beta.types.SolutionType]

search_solution_use_case

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][google.cloud.retail.v2beta.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH] if not specified. Currently only allow one search_solution_use_case per control.

Type

MutableSequence[google.cloud.retail_v2beta.types.SearchSolutionUseCase]

class google.cloud.retail_v2beta.types.CreateControlRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for CreateControl method.

parent

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

Type

str

control

Required. The Control to create.

Type

google.cloud.retail_v2beta.types.Control

control_id

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

Type

str

class google.cloud.retail_v2beta.types.CreateModelMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata associated with a create operation.

model

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

Type

str

class google.cloud.retail_v2beta.types.CreateModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for creating a model.

parent

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

Type

str

model

Required. The payload of the [Model][google.cloud.retail.v2beta.Model] to create.

Type

google.cloud.retail_v2beta.types.Model

dry_run

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

Type

bool

class google.cloud.retail_v2beta.types.CreateProductRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct] method.

parent

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

Type

str

product

Required. The [Product][google.cloud.retail.v2beta.Product] to create.

Type

google.cloud.retail_v2beta.types.Product

product_id

Required. The ID to use for the [Product][google.cloud.retail.v2beta.Product], which will become the final component of the [Product.name][google.cloud.retail.v2beta.Product.name].

If the caller does not have permission to create the [Product][google.cloud.retail.v2beta.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all [Product][google.cloud.retail.v2beta.Product]s with the same [parent][google.cloud.retail.v2beta.CreateProductRequest.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.

Type

str

class google.cloud.retail_v2beta.types.CreateServingConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for CreateServingConfig method.

parent

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

Type

str

serving_config

Required. The ServingConfig to create.

Type

google.cloud.retail_v2beta.types.ServingConfig

serving_config_id

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

Type

str

class google.cloud.retail_v2beta.types.CustomAttribute(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A custom attribute that is not explicitly modeled in [Product][google.cloud.retail.v2beta.Product].

text

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][google.cloud.retail.v2beta.CustomAttribute.text] or [numbers][google.cloud.retail.v2beta.CustomAttribute.numbers] should be set. Otherwise, an INVALID_ARGUMENT error is returned.

Type

MutableSequence[str]

numbers

The numerical values of this custom attribute. For example, [2.3, 15.4] when the key is “lengths_cm”.

Exactly one of [text][google.cloud.retail.v2beta.CustomAttribute.text] or [numbers][google.cloud.retail.v2beta.CustomAttribute.numbers] should be set. Otherwise, an INVALID_ARGUMENT error is returned.

Type

MutableSequence[float]

searchable

This field is normally ignored unless [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level] of the [Catalog][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchService.Search].

This field is ignored in a [UserEvent][google.cloud.retail.v2beta.UserEvent].

Only set if type [text][google.cloud.retail.v2beta.CustomAttribute.text] is set. Otherwise, a INVALID_ARGUMENT error is returned.

This field is a member of oneof _searchable.

Type

bool

indexable

This field is normally ignored unless [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level] of the [Catalog][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchService.Search].

This field is ignored in a [UserEvent][google.cloud.retail.v2beta.UserEvent].

See [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter], [SearchRequest.facet_specs][google.cloud.retail.v2beta.SearchRequest.facet_specs] and [SearchRequest.boost_spec][google.cloud.retail.v2beta.SearchRequest.boost_spec] for more details.

This field is a member of oneof _indexable.

Type

bool

class google.cloud.retail_v2beta.types.DeleteControlRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for DeleteControl method.

name

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

Type

str

class google.cloud.retail_v2beta.types.DeleteModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for deleting a model.

name

Required. The resource name of the [Model][google.cloud.retail.v2beta.Model] to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

Type

str

class google.cloud.retail_v2beta.types.DeleteProductRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ProductService.DeleteProduct][google.cloud.retail.v2beta.ProductService.DeleteProduct] method.

name

Required. Full resource name of [Product][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [Product][google.cloud.retail.v2beta.Product] to delete does not exist, a NOT_FOUND error is returned.

The [Product][google.cloud.retail.v2beta.Product] to delete can neither be a [Product.Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION] [Product][google.cloud.retail.v2beta.Product] member nor a [Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product] with more than one [variants][google.cloud.retail.v2beta.Product.Type.VARIANT]. Otherwise, an INVALID_ARGUMENT error is returned.

All inventory information for the named [Product][google.cloud.retail.v2beta.Product] will be deleted.

Type

str

class google.cloud.retail_v2beta.types.DeleteServingConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for DeleteServingConfig method.

name

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

Type

str

class google.cloud.retail_v2beta.types.ExperimentInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

serving_config_experiment

A/B test between existing Cloud Retail Search [ServingConfig][google.cloud.retail.v2beta.ServingConfig]s.

This field is a member of oneof experiment_metadata.

Type

google.cloud.retail_v2beta.types.ExperimentInfo.ServingConfigExperiment

experiment

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

Type

str

class ServingConfigExperiment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata for active serving config A/B tests.

original_serving_config

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

Type

str

experiment_serving_config

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

Type

str

class google.cloud.retail_v2beta.types.ExportAnalyticsMetricsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the ExportAnalyticsMetrics method.

catalog

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

Type

str

output_config

Required. The output location of the data.

Type

google.cloud.retail_v2beta.types.OutputConfig

filter

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"

Type

str

class google.cloud.retail_v2beta.types.ExportAnalyticsMetricsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

error_samples

A sample of errors encountered while processing the request.

Type

MutableSequence[google.rpc.status_pb2.Status]

errors_config

This field is never set.

Type

google.cloud.retail_v2beta.types.ExportErrorsConfig

output_result

Output result indicating where the data were exported to.

Type

google.cloud.retail_v2beta.types.OutputResult

class google.cloud.retail_v2beta.types.ExportErrorsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration of destination for Export related errors.

gcs_prefix

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.

This field is a member of oneof destination.

Type

str

class google.cloud.retail_v2beta.types.ExportMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

create_time

Operation create time.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.retail_v2beta.types.ExportProductsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for ExportProducts method.

parent

Required. Resource name of a [Branch][google.cloud.retail.v2beta.Branch], and default_branch for branch_id component is supported. For example projects/1234/locations/global/catalogs/default_catalog/branches/default_branch

Type

str

output_config

Required. The output location of the data.

Type

google.cloud.retail_v2beta.types.OutputConfig

filter

A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, lastModifiedTime > "2012-04-23T18:25:43.511Z" lastModifiedTime<"2012-04-23T18:25:43.511Z" productType=primary

We expect only four types of fields:

* `lastModifiedTime`: This can be specified twice, once with a
  less than operator and once with a greater than operator. The
  `lastModifiedTime` restriction should result in one, contiguous,
  valid, last-modified, time range.

* `productType`: Supported values are `primary` and `variant`. The
Boolean operators `OR` and `NOT` are supported if the expression is
enclosed in parentheses and must be separated from the
  `productType` values by a space.

* `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`,
`PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are
supported if the expression is enclosed in parentheses and must be
separated from the `availability` values by a space.

* `Tag expressions`: Restricts output to products that match all of the
  specified tags. Boolean operators `OR` and `NOT` are supported if the
  expression is enclosed in parentheses and the operators are separated
  from the tag values by a space. Also supported is '`-"tagA"`', which
  is equivalent to '`NOT "tagA"`'. Tag values must be double-quoted,
  UTF-8 encoded strings and have a size limit of 1,000 characters.

Some examples of valid filters expressions:

• Example 1: lastModifiedTime > "2012-04-23T18:25:43.511Z" lastModifiedTime < "2012-04-23T18:30:43.511Z"

• Example 2: lastModifiedTime > "2012-04-23T18:25:43.511Z" productType = "variant"

• Example 3: tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") productType = "primary" lastModifiedTime < "2018-04-23T18:30:43.511Z"

• Example 4: lastModifiedTime > "2012-04-23T18:25:43.511Z"

• Example 5: availability = (IN_STOCK OR BACKORDER)

Type

str

class google.cloud.retail_v2beta.types.ExportProductsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

error_samples

A sample of errors encountered while processing the request.

Type

MutableSequence[google.rpc.status_pb2.Status]

errors_config

This field is never set.

Type

google.cloud.retail_v2beta.types.ExportErrorsConfig

output_result

Output result indicating where the data were exported to.

Type

google.cloud.retail_v2beta.types.OutputResult

class google.cloud.retail_v2beta.types.ExportUserEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the ExportUserEvents method.

parent

Required. Resource name of a [Catalog][google.cloud.retail.v2beta.Catalog]. For example projects/1234/locations/global/catalogs/default_catalog

Type

str

output_config

Required. The output location of the data.

Type

google.cloud.retail_v2beta.types.OutputConfig

filter

A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search

We expect only three types of fields:

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

* `eventType`: Boolean operators `OR` and `NOT` are supported if the
  expression is enclosed in parentheses and the operators are separated
  from the tag values by a space.

* `eventsMissingCatalogItems`: This restricts results
  to events for which catalog items were not found in the catalog. The
  default behavior is to return only those events for which catalog
  items were found.

Some examples of valid filters expressions:

• Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"

• Example 2: eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view

• Example 3: eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"

• Example 4: eventTime > "2012-04-23T18:25:43.511Z"

• Example 5: eventType = (detail-page-view OR search)

• Example 6: eventsMissingCatalogItems

Type

str

class google.cloud.retail_v2beta.types.ExportUserEventsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

error_samples

A sample of errors encountered while processing the request.

Type

MutableSequence[google.rpc.status_pb2.Status]

errors_config

This field is never set.

Type

google.cloud.retail_v2beta.types.ExportErrorsConfig

output_result

Output result indicating where the data were exported to.

Type

google.cloud.retail_v2beta.types.OutputResult

class google.cloud.retail_v2beta.types.FulfillmentInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

type_

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.

Type

str

place_ids

The IDs for this [type][google.cloud.retail.v2beta.FulfillmentInfo.type], such as the store IDs for [FulfillmentInfo.type.pickup-in-store][google.cloud.retail.v2beta.FulfillmentInfo.type] or the region IDs for [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2beta.FulfillmentInfo.type].

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.

Type

MutableSequence[str]

class google.cloud.retail_v2beta.types.GcsOutputResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A Gcs output result.

output_uri

The uri of Gcs output

Type

str

class google.cloud.retail_v2beta.types.GcsSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Google Cloud Storage location for input content.

input_uris

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.

Type

MutableSequence[str]

data_schema

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

Supported values for product imports:

• product (default): One JSON [Product][google.cloud.retail.v2beta.Product] per line. Each product must have a valid [Product.id][google.cloud.retail.v2beta.Product.id].

• product_merchant_center: See Importing catalog data from Merchant Center.

Supported values for user events imports:

• user_event (default): One JSON [UserEvent][google.cloud.retail.v2beta.UserEvent] per line.

• user_event_ga360: Using https://support.google.com/analytics/answer/3437719.

Supported values for control imports:

• control (default): One JSON [Control][google.cloud.retail.v2beta.Control] per line.

Supported values for catalog attribute imports:

• catalog_attribute (default): One CSV [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] per line.

Type

str

class google.cloud.retail_v2beta.types.GenerativeQuestionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for a single generated question.

catalog

Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}

Type

str

facet

Required. The facet to which the question is associated.

Type

str

generated_question

Output only. The LLM generated question.

Type

str

final_question

Optional. The question that will be used at serving time. Question can have a max length of 300 bytes. When not populated, generated_question should be used.

Type

str

example_values

Output only. Values that can be used to answer the question.

Type

MutableSequence[str]

frequency

Output only. The ratio of how often a question was asked.

Type

float

allowed_in_conversation

Optional. Whether the question is asked at serving time.

Type

bool

class google.cloud.retail_v2beta.types.GenerativeQuestionsFeatureConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for overall generative question feature state.

catalog

Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}

Type

str

feature_enabled

Optional. Determines whether questions will be used at serving time. Note: This feature cannot be enabled until initial data requirements are satisfied.

Type

bool

minimum_products

Optional. Minimum number of products in the response to trigger follow-up questions. Value must be 0 or positive.

Type

int

class google.cloud.retail_v2beta.types.GetAlertConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for [ProjectService.GetAlertConfig][google.cloud.retail.v2beta.ProjectService.GetAlertConfig] method.

name

Required. Full AlertConfig resource name. Format: projects/{project_number}/alertConfig

Type

str

class google.cloud.retail_v2beta.types.GetAttributesConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for [CatalogService.GetAttributesConfig][google.cloud.retail.v2beta.CatalogService.GetAttributesConfig] method.

name

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

Type

str

class google.cloud.retail_v2beta.types.GetCompletionConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for [CatalogService.GetCompletionConfig][google.cloud.retail.v2beta.CatalogService.GetCompletionConfig] method.

name

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

Type

str

class google.cloud.retail_v2beta.types.GetControlRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for GetControl method.

name

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

Type

str

class google.cloud.retail_v2beta.types.GetDefaultBranchRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

catalog

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

Type

str

class google.cloud.retail_v2beta.types.GetDefaultBranchResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message of [CatalogService.GetDefaultBranch][google.cloud.retail.v2beta.CatalogService.GetDefaultBranch].

branch

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

Type

str

set_time

The time when this branch is set to default.

Type

google.protobuf.timestamp_pb2.Timestamp

note

This corresponds to [SetDefaultBranchRequest.note][google.cloud.retail.v2beta.SetDefaultBranchRequest.note] field, when this branch was set as default.

Type

str

class google.cloud.retail_v2beta.types.GetGenerativeQuestionsFeatureConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for GetGenerativeQuestionsFeatureConfig method.

catalog

Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}

Type

str

class google.cloud.retail_v2beta.types.GetModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for getting a model.

name

Required. The resource name of the [Model][google.cloud.retail.v2beta.Model] to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog}/models/{model_id}

Type

str

class google.cloud.retail_v2beta.types.GetProductRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct] method.

name

Required. Full resource name of [Product][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [Product][google.cloud.retail.v2beta.Product] does not exist, a NOT_FOUND error is returned.

Type

str

class google.cloud.retail_v2beta.types.GetServingConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for GetServingConfig method.

name

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

Type

str

class google.cloud.retail_v2beta.types.Image(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

[Product][google.cloud.retail.v2beta.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.

uri

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.

Type

str

height

Height of the image in number of pixels.

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

Type

int

width

Width of the image in number of pixels.

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

Type

int

class google.cloud.retail_v2beta.types.ImportCompletionDataRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for ImportCompletionData methods.

parent

Required. The catalog which the suggestions dataset belongs to.

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

Type

str

input_config

Required. The desired input location of the data.

Type

google.cloud.retail_v2beta.types.CompletionDataInputConfig

notification_pubsub_topic

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][google.longrunning.Operation]. Format of the Pub/Sub topic is projects/{project}/topics/{topic}.

Type

str

class google.cloud.retail_v2beta.types.ImportCompletionDataResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

error_samples

A sample of errors encountered while processing the request.

Type

MutableSequence[google.rpc.status_pb2.Status]

class google.cloud.retail_v2beta.types.ImportErrorsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration of destination for Import related errors.

gcs_prefix

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.

This field is a member of oneof destination.

Type

str

class google.cloud.retail_v2beta.types.ImportMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

create_time

Operation create time.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

success_count

Count of entries that were processed successfully.

Type

int

failure_count

Count of entries that encountered errors while processing.

Type

int

request_id

Deprecated. This field is never set.

Type

str

notification_pubsub_topic

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][google.longrunning.Operation]. Format of the Pub/Sub topic is projects/{project}/topics/{topic}.

Type

str

class google.cloud.retail_v2beta.types.ImportProductsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for Import methods.

parent

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.

Type

str

request_id

Deprecated. This field has no effect.

Type

str

input_config

Required. The desired input location of the data.

Type

google.cloud.retail_v2beta.types.ProductInputConfig

errors_config

The desired location of errors incurred during the Import.

Type

google.cloud.retail_v2beta.types.ImportErrorsConfig

update_mask

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.

Type

google.protobuf.field_mask_pb2.FieldMask

reconciliation_mode

The mode of reconciliation between existing products and the products to be imported. Defaults to [ReconciliationMode.INCREMENTAL][google.cloud.retail.v2beta.ImportProductsRequest.ReconciliationMode.INCREMENTAL].

Type

google.cloud.retail_v2beta.types.ImportProductsRequest.ReconciliationMode

notification_pubsub_topic

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][google.longrunning.Operation].

Format of the Pub/Sub topic is projects/{project}/topics/{topic}. It has to be within the same project as [ImportProductsRequest.parent][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.ImportProductsRequest.reconciliation_mode] is set to FULL.

Type

str

class ReconciliationMode(value)

Bases: proto.enums.Enum

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

Values:

RECONCILIATION_MODE_UNSPECIFIED (0):

Defaults to INCREMENTAL.

INCREMENTAL (1):

Inserts new products or updates existing products.

FULL (2):

Calculates diff and replaces the entire product dataset. Existing products may be deleted if they are not present in the source location.

class google.cloud.retail_v2beta.types.ImportProductsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response of the [ImportProductsRequest][google.cloud.retail.v2beta.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.

error_samples

A sample of errors encountered while processing the request.

Type

MutableSequence[google.rpc.status_pb2.Status]

errors_config

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

Type

google.cloud.retail_v2beta.types.ImportErrorsConfig

class google.cloud.retail_v2beta.types.ImportUserEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the ImportUserEvents request.

parent

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

Type

str

input_config

Required. The desired input location of the data.

Type

google.cloud.retail_v2beta.types.UserEventInputConfig

errors_config

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

Type

google.cloud.retail_v2beta.types.ImportErrorsConfig

class google.cloud.retail_v2beta.types.ImportUserEventsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

error_samples

A sample of errors encountered while processing the request.

Type

MutableSequence[google.rpc.status_pb2.Status]

errors_config

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

Type

google.cloud.retail_v2beta.types.ImportErrorsConfig

import_summary

Aggregated statistics of user event import status.

Type

google.cloud.retail_v2beta.types.UserEventImportSummary

class google.cloud.retail_v2beta.types.Interval(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A floating point interval.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

minimum

Inclusive lower bound.

This field is a member of oneof min.

Type

float

exclusive_minimum

Exclusive lower bound.

This field is a member of oneof min.

Type

float

maximum

Inclusive upper bound.

This field is a member of oneof max.

Type

float

exclusive_maximum

Exclusive upper bound.

This field is a member of oneof max.

Type

float

class google.cloud.retail_v2beta.types.ListCatalogsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for [CatalogService.ListCatalogs][google.cloud.retail.v2beta.CatalogService.ListCatalogs] method.

parent

Required. The account resource name with an associated location.

If the caller does not have permission to list [Catalog][google.cloud.retail.v2beta.Catalog]s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

Type

str

page_size

Maximum number of [Catalog][google.cloud.retail.v2beta.Catalog]s 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.

Type

int

page_token

A page token [ListCatalogsResponse.next_page_token][google.cloud.retail.v2beta.ListCatalogsResponse.next_page_token], received from a previous [CatalogService.ListCatalogs][google.cloud.retail.v2beta.CatalogService.ListCatalogs] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [CatalogService.ListCatalogs][google.cloud.retail.v2beta.CatalogService.ListCatalogs] must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Type

str

class google.cloud.retail_v2beta.types.ListCatalogsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for [CatalogService.ListCatalogs][google.cloud.retail.v2beta.CatalogService.ListCatalogs] method.

catalogs

All the customer’s [Catalog][google.cloud.retail.v2beta.Catalog]s.

Type

MutableSequence[google.cloud.retail_v2beta.types.Catalog]

next_page_token

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

Type

str

class google.cloud.retail_v2beta.types.ListControlsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for ListControls method.

parent

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

Type

str

page_size

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

Type

int

page_token

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

Type

str

filter

Optional. A filter to apply on the list results. Supported features:

• List all the products under the parent branch if [filter][google.cloud.retail.v2beta.ListControlsRequest.filter] is unset.

• List controls that are used in a single ServingConfig: ‘serving_config = “boosted_home_page_cvr”’

Type

str

class google.cloud.retail_v2beta.types.ListControlsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for ListControls method.

controls

All the Controls for a given catalog.

Type

MutableSequence[google.cloud.retail_v2beta.types.Control]

next_page_token

Pagination token, if not returned indicates the last page.

Type

str

class google.cloud.retail_v2beta.types.ListGenerativeQuestionConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for ListQuestions method.

parent

Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}

Type

str

class google.cloud.retail_v2beta.types.ListGenerativeQuestionConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for ListQuestions method.

generative_question_configs

All the questions for a given catalog.

Type

MutableSequence[google.cloud.retail_v2beta.types.GenerativeQuestionConfig]

class google.cloud.retail_v2beta.types.ListModelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for listing models associated with a resource.

parent

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

Type

str

page_size

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

Type

int

page_token

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

Type

str

class google.cloud.retail_v2beta.types.ListModelsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response to a ListModelRequest.

models

List of Models.

Type

MutableSequence[google.cloud.retail_v2beta.types.Model]

next_page_token

Pagination token, if not returned indicates the last page.

Type

str

class google.cloud.retail_v2beta.types.ListProductsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts] method.

parent

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][google.cloud.retail.v2beta.Product]s under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

Type

str

page_size

Maximum number of [Product][google.cloud.retail.v2beta.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.

Type

int

page_token

A page token [ListProductsResponse.next_page_token][google.cloud.retail.v2beta.ListProductsResponse.next_page_token], received from a previous [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts] must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Type

str

filter

A filter to apply on the list results. Supported features:

• List all the products under the parent branch if [filter][google.cloud.retail.v2beta.ListProductsRequest.filter] is unset.

• List [Product.Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s sharing the same [Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]. For example: primary_product_id = "some_product_id"

• List [Product][google.cloud.retail.v2beta.Product]s bundled in a [Product.Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION] [Product][google.cloud.retail.v2beta.Product]. For example: collection_product_id = "some_product_id"

• List [Product][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product] or [Product.Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION] [Product][google.cloud.retail.v2beta.Product] does not exist, a NOT_FOUND error is returned.

Type

str

read_mask

The fields of [Product][google.cloud.retail.v2beta.Product] to return in the responses. If not set or empty, the following fields are returned:

• [Product.name][google.cloud.retail.v2beta.Product.name]

• [Product.id][google.cloud.retail.v2beta.Product.id]

• [Product.title][google.cloud.retail.v2beta.Product.title]

• [Product.uri][google.cloud.retail.v2beta.Product.uri]

• [Product.images][google.cloud.retail.v2beta.Product.images]

• [Product.price_info][google.cloud.retail.v2beta.Product.price_info]

• [Product.brands][google.cloud.retail.v2beta.Product.brands]

If “*” is provided, all fields are returned. [Product.name][google.cloud.retail.v2beta.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.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.retail_v2beta.types.ListProductsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts] method.

products

The [Product][google.cloud.retail.v2beta.Product]s.

Type

MutableSequence[google.cloud.retail_v2beta.types.Product]

next_page_token

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

Type

str

class google.cloud.retail_v2beta.types.ListServingConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for ListServingConfigs method.

parent

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

Type

str

page_size

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.

Type

int

page_token

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

Type

str

class google.cloud.retail_v2beta.types.ListServingConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for ListServingConfigs method.

serving_configs

All the ServingConfigs for a given catalog.

Type

MutableSequence[google.cloud.retail_v2beta.types.ServingConfig]

next_page_token

Pagination token, if not returned indicates the last page.

Type

str

class google.cloud.retail_v2beta.types.LocalInventory(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

place_id

The place ID for the current set of inventory information.

Type

str

price_info

Product price and cost information.

Google Merchant Center property price.

Type

google.cloud.retail_v2beta.types.PriceInfo

attributes

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.

Type

MutableMapping[str, google.cloud.retail_v2beta.types.CustomAttribute]

fulfillment_types

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.

Type

MutableSequence[str]

class AttributesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.retail_v2beta.types.MerchantCenterFeedFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Merchant Center Feed filter criterion.

primary_feed_id

Merchant Center primary feed ID.

Type

int

primary_feed_name

Merchant Center primary feed name. The name is used for the display purposes only.

Type

str

class google.cloud.retail_v2beta.types.MerchantCenterLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a link between a Merchant Center account and a branch. After a link is established, products from the linked Merchant Center account are streamed to the linked branch.

merchant_center_account_id

Required. The linked Merchant Center account ID. The account must be a standalone account or a sub-account of a MCA.

Type

int

branch_id

The branch ID (e.g. 0/1/2) within this catalog that products from merchant_center_account_id are streamed to. When updating this field, an empty value will use the currently configured default branch. However, changing the default branch later on won’t change the linked branch here.

A single branch ID can only have one linked Merchant Center account ID.

Type

str

destinations

String representing the destination to import for, all if left empty. List of possible values is given in Included destination. List of allowed string values: “Shopping_ads”, “Buy_on_google_listings”, “Display_ads”, “Local_inventory _ads”, “Free_listings”, “Free_local_listings” NOTE: The string values are case sensitive.

Type

MutableSequence[str]

region_code

Region code of offers to accept. 2-letter Uppercase ISO 3166-1 alpha-2 code. List of values can be found here under the region tag. If left blank no region filtering will be performed.

Example value: US.

Type

str

language_code

Language of the title/description and other string attributes. Use language tags defined by BCP 47. ISO 639-1.

This specifies the language of offers in Merchant Center that will be accepted. If empty no language filtering will be performed.

Example value: en.

Type

str

feeds

Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.

Type

MutableSequence[google.cloud.retail_v2beta.types.MerchantCenterFeedFilter]

class google.cloud.retail_v2beta.types.MerchantCenterLinkingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configures Merchant Center linking. Links contained in the config will be used to sync data from a Merchant Center account to a Cloud Retail branch.

links

Links between Merchant Center accounts and branches.

Type

MutableSequence[google.cloud.retail_v2beta.types.MerchantCenterLink]

class google.cloud.retail_v2beta.types.Model(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata that describes the training and serving parameters of a [Model][google.cloud.retail.v2beta.Model]. A [Model][google.cloud.retail.v2beta.Model] can be associated with a [ServingConfig][google.cloud.retail.v2beta.ServingConfig] and then queried through the Predict API.

name

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.

Type

str

display_name

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.

Type

str

training_state

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.

Type

google.cloud.retail_v2beta.types.Model.TrainingState

serving_state

Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.

Type

google.cloud.retail_v2beta.types.Model.ServingState

create_time

Output only. Timestamp the Recommendation Model was created at.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

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

google.protobuf.timestamp_pb2.Timestamp

type_

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][google.cloud.retail.v2beta.Model.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.

Type

str

optimization_objective

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][google.cloud.retail.v2beta.Model.type] 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.

Type

str

periodic_tuning_state

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.

Type

google.cloud.retail_v2beta.types.Model.PeriodicTuningState

last_tune_time

Output only. The timestamp when the latest successful tune finished.

Type

google.protobuf.timestamp_pb2.Timestamp

tuning_operation

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.

Type

str

data_state

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.

Type

google.cloud.retail_v2beta.types.Model.DataState

filtering_option

Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by attributes is enabled for the model.

Type

google.cloud.retail_v2beta.types.RecommendationsFilteringOption

serving_config_lists

Output only. The list of valid serving configs associated with the PageOptimizationConfig.

Type

MutableSequence[google.cloud.retail_v2beta.types.Model.ServingConfigList]

model_features_config

Optional. Additional model features config.

Type

google.cloud.retail_v2beta.types.Model.ModelFeaturesConfig

class ContextProductsType(value)

Bases: proto.enums.Enum

Use single or multiple context products for recommendations.

Values:

CONTEXT_PRODUCTS_TYPE_UNSPECIFIED (0):

Unspecified default value, should never be explicitly set. Defaults to [MULTIPLE_CONTEXT_PRODUCTS][google.cloud.retail.v2beta.Model.ContextProductsType.MULTIPLE_CONTEXT_PRODUCTS].

SINGLE_CONTEXT_PRODUCT (1):

Use only a single product as context for the recommendation. Typically used on pages like add-to-cart or product details.

MULTIPLE_CONTEXT_PRODUCTS (2):

Use one or multiple products as context for the recommendation. Typically used on shopping cart pages.

class DataState(value)

Bases: proto.enums.Enum

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

Values:

DATA_STATE_UNSPECIFIED (0):

Unspecified default value, should never be explicitly set.

DATA_OK (1):

The model has sufficient training data.

DATA_ERROR (2):

The model does not have sufficient training data. Error messages can be queried via Stackdriver.

class FrequentlyBoughtTogetherFeaturesConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

context_products_type

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][google.cloud.retail.v2beta.Model.ContextProductsType.MULTIPLE_CONTEXT_PRODUCTS].

Type

google.cloud.retail_v2beta.types.Model.ContextProductsType

class ModelFeaturesConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Additional model features config.

frequently_bought_together_config

Additional configs for frequently-bought-together models.

This field is a member of oneof type_dedicated_config.

Type

google.cloud.retail_v2beta.types.Model.FrequentlyBoughtTogetherFeaturesConfig

class PeriodicTuningState(value)

Bases: proto.enums.Enum

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.

Values:

PERIODIC_TUNING_STATE_UNSPECIFIED (0):

Unspecified default value, should never be explicitly set.

PERIODIC_TUNING_DISABLED (1):

The model has periodic tuning disabled. Tuning can be reenabled by calling the EnableModelPeriodicTuning method or by calling the TuneModel method.

ALL_TUNING_DISABLED (3):

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 (2):

The model has periodic tuning enabled. Tuning can be disabled by calling the DisableModelPeriodicTuning method.

class ServingConfigList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

serving_config_ids

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

Type

MutableSequence[str]

class ServingState(value)

Bases: proto.enums.Enum

The serving state of the model.

Values:

SERVING_STATE_UNSPECIFIED (0):

Unspecified serving state.

INACTIVE (1):

The model is not serving.

ACTIVE (2):

The model is serving and can be queried.

TUNED (3):

The model is trained on tuned hyperparameters and can be queried.

class TrainingState(value)

Bases: proto.enums.Enum

The training state of the model.

Values:

TRAINING_STATE_UNSPECIFIED (0):

Unspecified training state.

PAUSED (1):

The model training is paused.

TRAINING (2):

The model is training.

class google.cloud.retail_v2beta.types.OutputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The output configuration setting.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

gcs_destination

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

This field is a member of oneof destination.

Type

google.cloud.retail_v2beta.types.OutputConfig.GcsDestination

bigquery_destination

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

This field is a member of oneof destination.

Type

google.cloud.retail_v2beta.types.OutputConfig.BigQueryDestination

class BigQueryDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The BigQuery output destination configuration.

dataset_id

Required. The ID of a BigQuery Dataset.

Type

str

table_id_prefix

Required. The prefix of exported BigQuery tables.

Type

str

table_type

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

• table: A BigQuery native table.

• view: A virtual table defined by a SQL query.

Type

str

class GcsDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The Google Cloud Storage output destination configuration.

output_uri_prefix

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

Type

str

class google.cloud.retail_v2beta.types.OutputResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

bigquery_result

The BigQuery location where the result is stored.

Type

MutableSequence[google.cloud.retail_v2beta.types.BigQueryOutputResult]

gcs_result

The Google Cloud Storage location where the result is stored.

Type

MutableSequence[google.cloud.retail_v2beta.types.GcsOutputResult]

class google.cloud.retail_v2beta.types.PauseModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for pausing training of a model.

name

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

Type

str

class google.cloud.retail_v2beta.types.PredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for Predict method.

placement

Required. Full resource name of the format: {placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*} or {placement=projects/*/locations/global/catalogs/default_catalog/placements/*}. We recommend using the servingConfigs resource. placements is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Manage serving configs] (https://cloud.google.com/retail/docs/manage-configs).

The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs

Type

str

user_event

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][google.cloud.retail.v2beta.UserEvent.visitor_id] or [UserInfo.user_id][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.UserEvent.visitor_id] to a random unique ID and leave [UserInfo.user_id][google.cloud.retail.v2beta.UserInfo.user_id] unset.

Type

google.cloud.retail_v2beta.types.UserEvent

page_size

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.

Type

int

page_token

This field is not used; leave it unset.

Type

str

filter

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.

Type

str

validate_only

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.

Type

bool

params

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.

Type

MutableMapping[str, google.protobuf.struct_pb2.Value]

labels

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.

Type

MutableMapping[str, str]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class ParamsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.retail_v2beta.types.PredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for predict method.

results

A list of recommended products. The order represents the ranking (from the most relevant product to the least).

Type

MutableSequence[google.cloud.retail_v2beta.types.PredictResponse.PredictionResult]

attribution_token

A unique attribution token. This should be included in the [UserEvent][google.cloud.retail.v2beta.UserEvent] logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

Type

str

missing_ids

IDs of products in the request that were missing from the inventory.

Type

MutableSequence[str]

validate_only

True if the validateOnly property was set in the request.

Type

bool

class PredictionResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

PredictionResult represents the recommendation prediction results.

id

ID of the recommended product

Type

str

metadata

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.

Type

MutableMapping[str, google.protobuf.struct_pb2.Value]

class MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.retail_v2beta.types.PriceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The price information of a [Product][google.cloud.retail.v2beta.Product].

currency_code

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][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s with the same [Product.primary_product_id][google.cloud.retail.v2beta.Product.primary_product_id] must share the same [currency_code][google.cloud.retail.v2beta.PriceInfo.currency_code]. Otherwise, a FAILED_PRECONDITION error is returned.

Type

str

price

Price of the product.

Google Merchant Center property price. Schema.org property Offer.price.

Type

float

original_price

Price of the product without any discount. If zero, by default set to be the [price][google.cloud.retail.v2beta.PriceInfo.price]. If set, [original_price][google.cloud.retail.v2beta.PriceInfo.original_price] should be greater than or equal to [price][google.cloud.retail.v2beta.PriceInfo.price], otherwise an INVALID_ARGUMENT error is thrown.

Type

float

cost

The costs associated with the sale of a particular product. Used for gross profit reporting.

• Profit = [price][google.cloud.retail.v2beta.PriceInfo.price] - [cost][google.cloud.retail.v2beta.PriceInfo.cost]

Google Merchant Center property cost_of_goods_sold.

Type

float

price_effective_time

The timestamp when the [price][google.cloud.retail.v2beta.PriceInfo.price] starts to be effective. This can be set as a future timestamp, and the [price][google.cloud.retail.v2beta.PriceInfo.price] is only used for search after [price_effective_time][google.cloud.retail.v2beta.PriceInfo.price_effective_time]. If so, the [original_price][google.cloud.retail.v2beta.PriceInfo.original_price] must be set and [original_price][google.cloud.retail.v2beta.PriceInfo.original_price] is used before [price_effective_time][google.cloud.retail.v2beta.PriceInfo.price_effective_time].

Do not set if [price][google.cloud.retail.v2beta.PriceInfo.price] is always effective because it will cause additional latency during search.

Type

google.protobuf.timestamp_pb2.Timestamp

price_expire_time

The timestamp when the [price][google.cloud.retail.v2beta.PriceInfo.price] stops to be effective. The [price][google.cloud.retail.v2beta.PriceInfo.price] is used for search before [price_expire_time][google.cloud.retail.v2beta.PriceInfo.price_expire_time]. If this field is set, the [original_price][google.cloud.retail.v2beta.PriceInfo.original_price] must be set and [original_price][google.cloud.retail.v2beta.PriceInfo.original_price] is used after [price_expire_time][google.cloud.retail.v2beta.PriceInfo.price_expire_time].

Do not set if [price][google.cloud.retail.v2beta.PriceInfo.price] is always effective because it will cause additional latency during search.

Type

google.protobuf.timestamp_pb2.Timestamp

price_range

Output only. The price range of all the child [Product.Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s grouped together on the [Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]. Only populated for [Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]s.

Note: This field is OUTPUT_ONLY for [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]. Do not set this field in API requests.

Type

google.cloud.retail_v2beta.types.PriceInfo.PriceRange

class PriceRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The price range of all [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] having the same [Product.primary_product_id][google.cloud.retail.v2beta.Product.primary_product_id].

price

The inclusive [Product.pricing_info.price][google.cloud.retail.v2beta.PriceInfo.price] interval of all [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] having the same [Product.primary_product_id][google.cloud.retail.v2beta.Product.primary_product_id].

Type

google.cloud.retail_v2beta.types.Interval

original_price

The inclusive [Product.pricing_info.original_price][google.cloud.retail.v2beta.PriceInfo.original_price] internal of all [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] having the same [Product.primary_product_id][google.cloud.retail.v2beta.Product.primary_product_id].

Type

google.cloud.retail_v2beta.types.Interval

class google.cloud.retail_v2beta.types.Product(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

expire_time

Note that this field is applied in the following ways:

• If the [Product][google.cloud.retail.v2beta.Product] is already expired when it is uploaded, this product is not indexed for search.

• If the [Product][google.cloud.retail.v2beta.Product] is not expired when it is uploaded, only the [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY]’s and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION]’s expireTime is respected, and [Type.VARIANT][google.cloud.retail.v2beta.Product.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][google.cloud.retail.v2beta.Product.expire_time] must be later than [available_time][google.cloud.retail.v2beta.Product.available_time] and [publish_time][google.cloud.retail.v2beta.Product.publish_time], otherwise an INVALID_ARGUMENT error is thrown.

Corresponding properties: Google Merchant Center property expiration_date.

This field is a member of oneof expiration.

Type

google.protobuf.timestamp_pb2.Timestamp

ttl

Input only. The TTL (time to live) of the product. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2beta.Product.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][google.cloud.retail.v2beta.Product.expire_time] is set as current timestamp plus [ttl][google.cloud.retail.v2beta.Product.ttl]. The derived [expire_time][google.cloud.retail.v2beta.Product.expire_time] is returned in the output and [ttl][google.cloud.retail.v2beta.Product.ttl] is left blank when retrieving the [Product][google.cloud.retail.v2beta.Product].

If it is set, the product is not available for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] after current timestamp plus [ttl][google.cloud.retail.v2beta.Product.ttl]. However, the product can still be retrieved by [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct] and [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].

This field is a member of oneof expiration.

Type

google.protobuf.duration_pb2.Duration

name

Immutable. Full resource name of the product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id.

Type

str

id

Immutable. [Product][google.cloud.retail.v2beta.Product] identifier, which is the final component of [name][google.cloud.retail.v2beta.Product.name]. For example, this field is “id_1”, if [name][google.cloud.retail.v2beta.Product.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

str

type_

Immutable. The type of the product. Default to [Catalog.product_level_config.ingestion_product_type][google.cloud.retail.v2beta.ProductLevelConfig.ingestion_product_type] if unset.

Type

google.cloud.retail_v2beta.types.Product.Type

primary_product_id

Variant group identifier. Must be an [id][google.cloud.retail.v2beta.Product.id], with the same parent branch with this product. Otherwise, an error is thrown.

For [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]s, this field can only be empty or set to the same value as [id][google.cloud.retail.v2beta.Product.id].

For VARIANT [Product][google.cloud.retail.v2beta.Product]s, this field cannot be empty. A maximum of 2,000 products are allowed to share the same [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property item_group_id. Schema.org property Product.inProductGroupWithID.

Type

str

collection_member_ids

The [id][google.cloud.retail.v2beta.Product.id] of the collection members when [type][google.cloud.retail.v2beta.Product.type] is [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION].

Non-existent product ids are allowed. The [type][google.cloud.retail.v2beta.Product.type] of the members must be either [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] or [Type.VARIANT][google.cloud.retail.v2beta.Product.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.

Type

MutableSequence[str]

gtin

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.

Type

str

categories

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][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product] otherwise an INVALID_ARGUMENT error is returned.

At most 250 values are allowed per [Product][google.cloud.retail.v2beta.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] (https://schema.org/category).

Type

MutableSequence[str]

title

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.

Type

str

brands

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.

Type

MutableSequence[str]

description

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.

Type

str

language_code

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][google.cloud.retail.v2beta.Product] can include text in different languages, but duplicating [Product][google.cloud.retail.v2beta.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.

Type

str

attributes

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.

Type

MutableMapping[str, google.cloud.retail_v2beta.types.CustomAttribute]

tags

Custom tags associated with the product.

At most 250 values are allowed per [Product][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.PredictRequest.filter].

Corresponding properties: Google Merchant Center property custom_label_0–4.

Type

MutableSequence[str]

price_info

Product price and cost information.

Corresponding properties: Google Merchant Center property price.

Type

google.cloud.retail_v2beta.types.PriceInfo

rating

The rating of this product.

Type

google.cloud.retail_v2beta.types.Rating

available_time

The timestamp when this [Product][google.cloud.retail.v2beta.Product] becomes available for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT].

Type

google.protobuf.timestamp_pb2.Timestamp

availability

The online availability of the [Product][google.cloud.retail.v2beta.Product]. Default to [Availability.IN_STOCK][google.cloud.retail.v2beta.Product.Availability.IN_STOCK].

For primary products with variants set the availability of the primary as [Availability.OUT_OF_STOCK][google.cloud.retail.v2beta.Product.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.

Type

google.cloud.retail_v2beta.types.Product.Availability

available_quantity

The available quantity of the item.

Type

google.protobuf.wrappers_pb2.Int32Value

fulfillment_info

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][google.cloud.retail.v2beta.FulfillmentInfo.type]. Otherwise, an INVALID_ARGUMENT error is returned.

Type

MutableSequence[google.cloud.retail_v2beta.types.FulfillmentInfo]

uri

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.

Type

str

images

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.

Type

MutableSequence[google.cloud.retail_v2beta.types.Image]

audience

The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product.

Type

google.cloud.retail_v2beta.types.Audience

color_info

The color of the product.

Corresponding properties: Google Merchant Center property color. Schema.org property Product.color.

Type

google.cloud.retail_v2beta.types.ColorInfo

sizes

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][google.cloud.retail.v2beta.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.

Type

MutableSequence[str]

materials

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.

Type

MutableSequence[str]

patterns

The pattern or graphic print of the product. For example, “striped”, “polka dot”, “paisley”.

A maximum of 20 values are allowed per [Product][google.cloud.retail.v2beta.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.

Type

MutableSequence[str]

conditions

The condition of the product. Strongly encouraged to use the standard values: “new”, “refurbished”, “used”.

A maximum of 1 value is allowed per [Product][google.cloud.retail.v2beta.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.

Type

MutableSequence[str]

promotions

The promotions applied to the product. A maximum of 10 values are allowed per [Product][google.cloud.retail.v2beta.Product]. Only [Promotion.promotion_id][google.cloud.retail.v2beta.Promotion.promotion_id] will be used, other fields will be ignored if set.

Type

MutableSequence[google.cloud.retail_v2beta.types.Promotion]

publish_time

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][google.cloud.retail.v2beta.Product.available_time], given it purely describes product freshness regardless of when it is available on search and recommendation.

Type

google.protobuf.timestamp_pb2.Timestamp

retrievable_fields

Indicates which fields in the [Product][google.cloud.retail.v2beta.Product]s are returned in [SearchResponse][google.cloud.retail.v2beta.SearchResponse].

Supported fields for all [type][google.cloud.retail.v2beta.Product.type]s:

• [audience][google.cloud.retail.v2beta.Product.audience]

• [availability][google.cloud.retail.v2beta.Product.availability]

• [brands][google.cloud.retail.v2beta.Product.brands]

• [color_info][google.cloud.retail.v2beta.Product.color_info]

• [conditions][google.cloud.retail.v2beta.Product.conditions]

• [gtin][google.cloud.retail.v2beta.Product.gtin]

• [materials][google.cloud.retail.v2beta.Product.materials]

• [name][google.cloud.retail.v2beta.Product.name]

• [patterns][google.cloud.retail.v2beta.Product.patterns]

• [price_info][google.cloud.retail.v2beta.Product.price_info]

• [rating][google.cloud.retail.v2beta.Product.rating]

• [sizes][google.cloud.retail.v2beta.Product.sizes]

• [title][google.cloud.retail.v2beta.Product.title]

• [uri][google.cloud.retail.v2beta.Product.uri]

Supported fields only for [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION]:

• [categories][google.cloud.retail.v2beta.Product.categories]

• [description][google.cloud.retail.v2beta.Product.description]

• [images][google.cloud.retail.v2beta.Product.images]

Supported fields only for [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]:

• Only the first image in [images][google.cloud.retail.v2beta.Product.images]

To mark [attributes][google.cloud.retail.v2beta.Product.attributes] as retrievable, include paths of the form “attributes.key” where “key” is the key of a custom attribute, as specified in [attributes][google.cloud.retail.v2beta.Product.attributes].

For [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], the following fields are always returned in [SearchResponse][google.cloud.retail.v2beta.SearchResponse] by default:

• [name][google.cloud.retail.v2beta.Product.name]

For [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT], the following fields are always returned in by default:

• [name][google.cloud.retail.v2beta.Product.name]

• [color_info][google.cloud.retail.v2beta.Product.color_info]

Note: Returning more fields in [SearchResponse][google.cloud.retail.v2beta.SearchResponse] can increase response payload size and serving latency.

This field is deprecated. Use the retrievable site-wide control instead.

Type

google.protobuf.field_mask_pb2.FieldMask

variants

Output only. Product variants grouped together on primary product which share similar product attributes. It’s automatically grouped by [primary_product_id][google.cloud.retail.v2beta.Product.primary_product_id] for all the product variants. Only populated for [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]s.

Note: This field is OUTPUT_ONLY for [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]. Do not set this field in API requests.

Type

MutableSequence[google.cloud.retail_v2beta.types.Product]

local_inventories

Output only. A list of local inventories specific to different places.

This field can be managed by [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories] and [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] APIs if fine-grained, high-volume updates are necessary.

Type

MutableSequence[google.cloud.retail_v2beta.types.LocalInventory]

class AttributesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Availability(value)

Bases: proto.enums.Enum

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

Values:

AVAILABILITY_UNSPECIFIED (0):

Default product availability. Default to [Availability.IN_STOCK][google.cloud.retail.v2beta.Product.Availability.IN_STOCK] if unset.

IN_STOCK (1):

Product in stock.

OUT_OF_STOCK (2):

Product out of stock.

PREORDER (3):

Product that is in pre-order state.

BACKORDER (4):

Product that is back-ordered (i.e. temporarily out of stock).

class Type(value)

Bases: proto.enums.Enum

The type of this product.

Values:

TYPE_UNSPECIFIED (0):

Default value. Default to [Catalog.product_level_config.ingestion_product_type][google.cloud.retail.v2beta.ProductLevelConfig.ingestion_product_type] if unset.

PRIMARY (1):

The primary type.

As the primary unit for predicting, indexing and search serving, a [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product] is grouped with multiple [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s.

VARIANT (2):

The variant type.

[Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s usually share some common attributes on the same [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]s, but they have variant attributes like different colors, sizes and prices, etc.

COLLECTION (3):

The collection type. Collection products are bundled [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]s or [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s that are sold together, such as a jewelry set with necklaces, earrings and rings, etc.

class google.cloud.retail_v2beta.types.ProductAttributeInterval(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Product attribute name and numeric interval.

name

The attribute name (e.g. “length”)

Type

str

interval

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

Type

google.cloud.retail_v2beta.types.Interval

class google.cloud.retail_v2beta.types.ProductAttributeValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

The attribute name.

Type

str

value

The attribute value.

Type

str

class google.cloud.retail_v2beta.types.ProductDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Detailed product information associated with a user event.

product

Required. [Product][google.cloud.retail.v2beta.Product] information.

Required field(s):

• [Product.id][google.cloud.retail.v2beta.Product.id]

Optional override field(s):

• [Product.price_info][google.cloud.retail.v2beta.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.

Type

google.cloud.retail_v2beta.types.Product

quantity

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.

Type

google.protobuf.wrappers_pb2.Int32Value

class google.cloud.retail_v2beta.types.ProductInlineSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The inline source for the input config for ImportProducts method.

products

Required. A list of products to update/create. Each product must have a valid [Product.id][google.cloud.retail.v2beta.Product.id]. Recommended max of 100 items.

Type

MutableSequence[google.cloud.retail_v2beta.types.Product]

class google.cloud.retail_v2beta.types.ProductInputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The input config source for products.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

product_inline_source

The Inline source for the input content for products.

This field is a member of oneof source.

Type

google.cloud.retail_v2beta.types.ProductInlineSource

gcs_source

Google Cloud Storage location for the input content.

This field is a member of oneof source.

Type

google.cloud.retail_v2beta.types.GcsSource

big_query_source

BigQuery input source.

This field is a member of oneof source.

Type

google.cloud.retail_v2beta.types.BigQuerySource

class google.cloud.retail_v2beta.types.ProductLevelConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.

ingestion_product_type

The type of [Product][google.cloud.retail.v2beta.Product]s allowed to be ingested into the catalog. Acceptable values are:

• primary (default): You can ingest [Product][google.cloud.retail.v2beta.Product]s of all types. When ingesting a [Product][google.cloud.retail.v2beta.Product], its type will default to [Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] if unset.

• variant (incompatible with Retail Search): You can only ingest [Product.Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s. This means [Product.primary_product_id][google.cloud.retail.v2beta.Product.primary_product_id] cannot be empty.

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

If this field is variant and [merchant_center_product_id_field][google.cloud.retail.v2beta.ProductLevelConfig.merchant_center_product_id_field] is itemGroupId, an INVALID_ARGUMENT error is returned.

See Product levels for more details.

Type

str

merchant_center_product_id_field

Which field of Merchant Center Product should be imported as [Product.id][google.cloud.retail.v2beta.Product.id]. Acceptable values are:

• offerId (default): Import offerId as the product ID.

• itemGroupId: Import itemGroupId as the product ID. Notice that Retail API will choose one item from the ones with the same itemGroupId, and use it to represent the item group.

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

If this field is itemGroupId and [ingestion_product_type][google.cloud.retail.v2beta.ProductLevelConfig.ingestion_product_type] is variant, an INVALID_ARGUMENT error is returned.

See Product levels for more details.

Type

str

class google.cloud.retail_v2beta.types.Promotion(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Promotion information.

promotion_id

ID of the promotion. For example, “free gift”.

The value must be a UTF-8 encoded string with a length limit of 128 characters, and match the pattern: [a-zA-Z][a-zA-Z0-9_]*. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponds to Google Merchant Center property promotion_id.

Type

str

class google.cloud.retail_v2beta.types.PurchaseTransaction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A transaction represents the entire purchase transaction.

id

The transaction ID with a length limit of 128 characters.

Type

str

revenue

Required. Total non-zero revenue or grand total associated with the transaction. This value include shipping, tax, or other adjustments to total revenue that you want to include as part of your revenue calculations.

Type

float

tax

All the taxes associated with the transaction.

Type

float

cost

All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that:

• Profit = [revenue][google.cloud.retail.v2beta.PurchaseTransaction.revenue] - [tax][google.cloud.retail.v2beta.PurchaseTransaction.tax] - [cost][google.cloud.retail.v2beta.PurchaseTransaction.cost]

Type

float

currency_code

Required. Currency code. Use three-character ISO-4217 code.

Type

str

class google.cloud.retail_v2beta.types.PurgeMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.

class google.cloud.retail_v2beta.types.PurgeProductsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata related to the progress of the PurgeProducts operation. This will be returned by the google.longrunning.Operation.metadata field.

create_time

Operation create time.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

success_count

Count of entries that were deleted successfully.

Type

int

failure_count

Count of entries that encountered errors while processing.

Type

int

class google.cloud.retail_v2beta.types.PurgeProductsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for PurgeProducts method.

parent

Required. The resource name of the branch under which the products are created. The format is projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}

Type

str

filter

Required. The filter string to specify the products to be deleted with a length limit of 5,000 characters.

Empty string filter is not allowed. “*” implies delete all items in a branch.

The eligible fields for filtering are:

• availability: Double quoted [Product.availability][google.cloud.retail.v2beta.Product.availability] string.

• create_time : in ISO 8601 “zulu” format.

Supported syntax:

• Comparators (“>”, “<”, “>=”, “<=”, “=”). Examples:

  • create_time <= “2015-02-13T17:05:46Z”

  • availability = “IN_STOCK”

• Conjunctions (“AND”) Examples:

  • create_time <= “2015-02-13T17:05:46Z” AND availability = “PREORDER”

• Disjunctions (“OR”) Examples:

  • create_time <= “2015-02-13T17:05:46Z” OR availability = “IN_STOCK”

• Can support nested queries. Examples:

  • (create_time <= “2015-02-13T17:05:46Z” AND availability = “PREORDER”) OR (create_time >= “2015-02-14T13:03:32Z” AND availability = “IN_STOCK”)

• Filter Limits:

  • Filter should not contain more than 6 conditions.

  • Max nesting depth should not exceed 2 levels.

Examples queries:

• Delete back order products created before a timestamp. create_time <= “2015-02-13T17:05:46Z” OR availability = “BACKORDER”.

Type

str

force

Actually perform the purge. If force is set to false, the method will return the expected purge count without deleting any products.

Type

bool

class google.cloud.retail_v2beta.types.PurgeProductsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response of the PurgeProductsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

purge_count

The total count of products purged as a result of the operation.

Type

int

purge_sample

A sample of the product names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

Type

MutableSequence[str]

class google.cloud.retail_v2beta.types.PurgeUserEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for PurgeUserEvents method.

parent

Required. The resource name of the catalog under which the events are created. The format is projects/${projectId}/locations/global/catalogs/${catalogId}

Type

str

filter

Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. Empty string filter is not allowed. The eligible fields for filtering are:

• eventType: Double quoted [UserEvent.event_type][google.cloud.retail.v2beta.UserEvent.event_type] string.

• eventTime: in ISO 8601 “zulu” format.

• visitorId: Double quoted string. Specifying this will delete all events associated with a visitor.

• userId: Double quoted string. Specifying this will delete all events associated with a user.

Examples:

• Deleting all events in a time range: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"

• Deleting specific eventType in time range: eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"

• Deleting all events for a specific visitor: visitorId = "visitor1024"

The filtering fields are assumed to have an implicit AND.

Type

str

force

Actually perform the purge. If force is set to false, the method will return the expected purge count without deleting any user events.

Type

bool

class google.cloud.retail_v2beta.types.PurgeUserEventsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

purged_events_count

The total count of events purged as a result of the operation.

Type

int

class google.cloud.retail_v2beta.types.Rating(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The rating of a [Product][google.cloud.retail.v2beta.Product].

rating_count

The total number of ratings. This value is independent of the value of [rating_histogram][google.cloud.retail.v2beta.Rating.rating_histogram].

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

Type

int

average_rating

The average rating of the [Product][google.cloud.retail.v2beta.Product].

The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned.

Type

float

rating_histogram

List of rating counts per rating value (index = rating - 1). The list is empty if there is no rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is returned.

For example, [41, 14, 13, 47, 303]. It means that the [Product][google.cloud.retail.v2beta.Product] got 41 ratings with 1 star, 14 ratings with 2 star, and so on.

Type

MutableSequence[int]

class google.cloud.retail_v2beta.types.RecommendationsFilteringOption(value)

Bases: proto.enums.Enum

If filtering for recommendations is enabled.

Values:

RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED (0):

Value used when unset. In this case, server behavior defaults to [RECOMMENDATIONS_FILTERING_DISABLED][google.cloud.retail.v2beta.RecommendationsFilteringOption.RECOMMENDATIONS_FILTERING_DISABLED].

RECOMMENDATIONS_FILTERING_DISABLED (1):

Recommendation filtering is disabled.

RECOMMENDATIONS_FILTERING_ENABLED (3):

Recommendation filtering is enabled.

class google.cloud.retail_v2beta.types.RejoinUserEventsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata for RejoinUserEvents method.

class google.cloud.retail_v2beta.types.RejoinUserEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for RejoinUserEvents method.

parent

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

Type

str

user_event_rejoin_scope

The type of the user event rejoin to define the scope and range of the user events to be rejoined with the latest product catalog. Defaults to USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an invalid integer value.

Type

google.cloud.retail_v2beta.types.RejoinUserEventsRequest.UserEventRejoinScope

class UserEventRejoinScope(value)

Bases: proto.enums.Enum

The scope of user events to be rejoined with the latest product catalog. If the rejoining aims at reducing number of unjoined events, set UserEventRejoinScope to UNJOINED_EVENTS. If the rejoining aims at correcting product catalog information in joined events, set UserEventRejoinScope to JOINED_EVENTS. If all events needs to be rejoined, set UserEventRejoinScope to USER_EVENT_REJOIN_SCOPE_UNSPECIFIED.

Values:

USER_EVENT_REJOIN_SCOPE_UNSPECIFIED (0):

Rejoin all events with the latest product catalog, including both joined events and unjoined events.

JOINED_EVENTS (1):

Only rejoin joined events with the latest product catalog.

UNJOINED_EVENTS (2):

Only rejoin unjoined events with the latest product catalog.

class google.cloud.retail_v2beta.types.RejoinUserEventsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for RejoinUserEvents method.

rejoined_user_events_count

Number of user events that were joined with latest product catalog.

Type

int

class google.cloud.retail_v2beta.types.RemoveCatalogAttributeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for [CatalogService.RemoveCatalogAttribute][google.cloud.retail.v2beta.CatalogService.RemoveCatalogAttribute] method.

attributes_config

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

Type

str

key

Required. The attribute name key of the [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to remove.

Type

str

class google.cloud.retail_v2beta.types.RemoveControlRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for RemoveControl method.

serving_config

Required. The source ServingConfig resource name . Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}

Type

str

control_id

Required. The id of the control to apply. Assumed to be in the same catalog as the serving config.

Type

str

class google.cloud.retail_v2beta.types.RemoveFulfillmentPlacesMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.RemoveFulfillmentPlaces] method.

class google.cloud.retail_v2beta.types.RemoveFulfillmentPlacesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.RemoveFulfillmentPlaces] method.

product

Required. Full resource name of [Product][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Type

str

type_

Required. The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types.

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.

This field directly corresponds to [Product.fulfillment_info.type][google.cloud.retail.v2beta.FulfillmentInfo.type].

Type

str

place_ids

Required. The IDs for this [type][google.cloud.retail.v2beta.RemoveFulfillmentPlacesRequest.type], such as the store IDs for “pickup-in-store” or the region IDs for “same-day-delivery”, to be removed for this [type][google.cloud.retail.v2beta.RemoveFulfillmentPlacesRequest.type].

At least 1 value is required, and a maximum of 2000 values are allowed. Each value must be a string with a length limit of 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as “store1” or “REGION-2”. Otherwise, an INVALID_ARGUMENT error is returned.

Type

MutableSequence[str]

remove_time

The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information. If not provided, the internal system time will be used.

Type

google.protobuf.timestamp_pb2.Timestamp

allow_missing

If set to true, and the [Product][google.cloud.retail.v2beta.Product] is not found, the fulfillment information will still be processed and retained for at most 1 day and processed once the [Product][google.cloud.retail.v2beta.Product] is created. If set to false, a NOT_FOUND error is returned if the [Product][google.cloud.retail.v2beta.Product] is not found.

Type

bool

class google.cloud.retail_v2beta.types.RemoveFulfillmentPlacesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.RemoveFulfillmentPlaces] method.

class google.cloud.retail_v2beta.types.RemoveLocalInventoriesMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] method.

class google.cloud.retail_v2beta.types.RemoveLocalInventoriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] method.

product

Required. Full resource name of [Product][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Type

str

place_ids

Required. A list of place IDs to have their inventory deleted. At most 3000 place IDs are allowed per request.

Type

MutableSequence[str]

remove_time

The time when the inventory deletions are issued. Used to prevent out-of-order updates and deletions on local inventory fields. If not provided, the internal system time will be used.

Type

google.protobuf.timestamp_pb2.Timestamp

allow_missing

If set to true, and the [Product][google.cloud.retail.v2beta.Product] is not found, the local inventory removal request will still be processed and retained for at most 1 day and processed once the [Product][google.cloud.retail.v2beta.Product] is created. If set to false, a NOT_FOUND error is returned if the [Product][google.cloud.retail.v2beta.Product] is not found.

Type

bool

class google.cloud.retail_v2beta.types.RemoveLocalInventoriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response of the [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] API. Currently empty because there is no meaningful response populated from the [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] method.

class google.cloud.retail_v2beta.types.ReplaceCatalogAttributeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for [CatalogService.ReplaceCatalogAttribute][google.cloud.retail.v2beta.CatalogService.ReplaceCatalogAttribute] method.

attributes_config

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

Type

str

catalog_attribute

Required. The updated [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute].

Type

google.cloud.retail_v2beta.types.CatalogAttribute

update_mask

Indicates which fields in the provided [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to update. The following are NOT supported:

• [CatalogAttribute.key][google.cloud.retail.v2beta.CatalogAttribute.key]

If not set, all supported fields are updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.retail_v2beta.types.ResumeModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for resuming training of a model.

name

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

Type

str

class google.cloud.retail_v2beta.types.Rule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A rule is a condition-action pair

• A condition defines when a rule is to be triggered.

• An action specifies what occurs on that trigger. Currently rules only work for [controls][google.cloud.retail.v2beta.Control] with [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2beta.SolutionType.SOLUTION_TYPE_SEARCH].

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

boost_action

A boost action.

This field is a member of oneof action.

Type

google.cloud.retail_v2beta.types.Rule.BoostAction

redirect_action

Redirects a shopper to a specific page.

This field is a member of oneof action.

Type

google.cloud.retail_v2beta.types.Rule.RedirectAction

oneway_synonyms_action

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

This field is a member of oneof action.

Type

google.cloud.retail_v2beta.types.Rule.OnewaySynonymsAction

do_not_associate_action

Prevents term from being associated with other terms.

This field is a member of oneof action.

Type

google.cloud.retail_v2beta.types.Rule.DoNotAssociateAction

replacement_action

Replaces specific terms in the query.

This field is a member of oneof action.

Type

google.cloud.retail_v2beta.types.Rule.ReplacementAction

ignore_action

Ignores specific terms from query during search.

This field is a member of oneof action.

Type

google.cloud.retail_v2beta.types.Rule.IgnoreAction

filter_action

Filters results.

This field is a member of oneof action.

Type

google.cloud.retail_v2beta.types.Rule.FilterAction

twoway_synonyms_action

Treats a set of terms as synonyms of one another.

This field is a member of oneof action.

Type

google.cloud.retail_v2beta.types.Rule.TwowaySynonymsAction

force_return_facet_action

Force returns an attribute as a facet in the request.

This field is a member of oneof action.

Type

google.cloud.retail_v2beta.types.Rule.ForceReturnFacetAction

remove_facet_action

Remove an attribute as a facet in the request (if present).

This field is a member of oneof action.

Type

google.cloud.retail_v2beta.types.Rule.RemoveFacetAction

condition

Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.

Type

google.cloud.retail_v2beta.types.Condition

class BoostAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A boost action to apply to results matching condition specified above.

boost

Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0.

Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items.

Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely.

Setting to 0.0 means no boost applied. The boosting condition is ignored.

Type

float

products_filter

The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter] for detail syntax and limitations.

Examples:

• To boost products with product ID “product_1” or “product_2”, and color “Red” or “Blue”: (id: ANY(“product_1”, “product_2”)) AND (colorFamilies: ANY(“Red”, “Blue”))

Type

str

class DoNotAssociateAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Prevents query_term from being associated with specified terms during search. Example: Don’t associate “gShoe” and “cheap”.

query_terms

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

Type

MutableSequence[str]

do_not_associate_terms

Cannot contain duplicates or the query term. Can specify up to 100 terms.

Type

MutableSequence[str]

terms

Will be [deprecated = true] post migration;

Type

MutableSequence[str]

class FilterAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

• Rule Condition:

  • No [Condition.query_terms][google.cloud.retail.v2beta.Condition.query_terms] provided is a global match.

  • 1 or more [Condition.query_terms][google.cloud.retail.v2beta.Condition.query_terms] provided are combined with OR operator.

• Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query’s existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict.

• Action Result: Filters the returned objects to be ONLY those that passed the filter.

filter

A filter to apply on the matching condition results. Supported features:

• [filter][google.cloud.retail.v2beta.Rule.FilterAction.filter] must be set.

• Filter syntax is identical to [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter]. For more information, see Filter.

• To filter products with product ID “product_1” or “product_2”, and color “Red” or “Blue”: (id: ANY(“product_1”, “product_2”)) AND (colorFamilies: ANY(“Red”, “Blue”))

Type

str

class ForceReturnFacetAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Force returns an attribute/facet in the request around a certain position or above.

• Rule Condition: Must specify non-empty [Condition.query_terms][google.cloud.retail.v2beta.Condition.query_terms] (for search only) or [Condition.page_categories][google.cloud.retail.v2beta.Condition.page_categories] (for browse only), but can’t specify both.

• Action Inputs: attribute name, position

• Action Result: Will force return a facet key around a certain position or above if the condition is satisfied.

Example: Suppose the query is “shoes”, the [Condition.query_terms][google.cloud.retail.v2beta.Condition.query_terms] is “shoes”, the [ForceReturnFacetAction.FacetPositionAdjustment.attribute_name][google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment.attribute_name] is “size” and the [ForceReturnFacetAction.FacetPositionAdjustment.position][google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment.position] is 8.

Two cases: a) The facet key “size” is not already in the top 8 slots, then the facet “size” will appear at a position close to 8. b) The facet key “size” in among the top 8 positions in the request, then it will stay at its current rank.

facet_position_adjustments

Each instance corresponds to a force return attribute for the given condition. There can’t be more 15 instances here.

Type

MutableSequence[google.cloud.retail_v2beta.types.Rule.ForceReturnFacetAction.FacetPositionAdjustment]

class FacetPositionAdjustment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.

attribute_name

The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.

Type

str

position

This is the position in the request as explained above. It should be strictly positive be at most 100.

Type

int

class IgnoreAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Prevents a term in the query from being used in search. Example: Don’t search for “shoddy”.

ignore_terms

Terms to ignore in the search query.

Type

MutableSequence[str]

class OnewaySynonymsAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each query term only. query_terms will not be treated as synonyms of each other. Example: “sneakers” will use a synonym of “shoes”. “shoes” will not use a synonym of “sneakers”.

query_terms

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

Type

MutableSequence[str]

synonyms

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

Type

MutableSequence[str]

oneway_terms

Will be [deprecated = true] post migration;

Type

MutableSequence[str]

class RedirectAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Redirects a shopper to a specific page.

• Rule Condition: Must specify [Condition.query_terms][google.cloud.retail.v2beta.Condition.query_terms].

• Action Input: Request Query

• Action Result: Redirects shopper to provided uri.

redirect_uri

URL must have length equal or less than 2000 characters.

Type

str

class RemoveFacetAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Removes an attribute/facet in the request if is present.

• Rule Condition: Must specify non-empty [Condition.query_terms][google.cloud.retail.v2beta.Condition.query_terms] (for search only) or [Condition.page_categories][google.cloud.retail.v2beta.Condition.page_categories] (for browse only), but can’t specify both.

• Action Input: attribute name

• Action Result: Will remove the attribute (as a facet) from the request if it is present.

Example: Suppose the query is “shoes”, the [Condition.query_terms][google.cloud.retail.v2beta.Condition.query_terms] is “shoes” and the attribute name “size”, then facet key “size” will be removed from the request (if it is present).

attribute_names

The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can’t be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.

Type

MutableSequence[str]

class ReplacementAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Replaces a term in the query. Multiple replacement candidates can be specified. All query_terms will be replaced with the replacement term. Example: Replace “gShoe” with “google shoe”.

query_terms

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

Type

MutableSequence[str]

replacement_term

Term that will be used for replacement.

Type

str

term

Will be [deprecated = true] post migration;

Type

str

class TwowaySynonymsAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Creates a set of terms that will be treated as synonyms of each other. Example: synonyms of “sneakers” and “shoes”:

• “sneakers” will use a synonym of “shoes”.

• “shoes” will use a synonym of “sneakers”.

synonyms

Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.

Type

MutableSequence[str]

class google.cloud.retail_v2beta.types.SearchRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] method.

placement

Required. The resource name of the Retail Search serving config, such as projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config or the name of the legacy placement resource, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search. This field is used to identify the serving config name and the set of models that are used to make the search.

Type

str

branch

The branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0.

Use “default_branch” as the branch ID or leave this field empty, to search products under the default branch.

Type

str

query

Raw search query.

If this field is empty, the request is considered a category browsing request and returned results are based on [filter][google.cloud.retail.v2beta.SearchRequest.filter] and [page_categories][google.cloud.retail.v2beta.SearchRequest.page_categories].

Type

str

visitor_id

Required. 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.

This should be the same identifier as [UserEvent.visitor_id][google.cloud.retail.v2beta.UserEvent.visitor_id].

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Type

str

user_info

User information.

Type

google.cloud.retail_v2beta.types.UserInfo

page_size

Maximum number of [Product][google.cloud.retail.v2beta.Product]s to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 120. Values above 120 will be coerced to 120.

If this field is negative, an INVALID_ARGUMENT is returned.

Type

int

page_token

A page token [SearchResponse.next_page_token][google.cloud.retail.v2beta.SearchResponse.next_page_token], received from a previous [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Type

str

offset

A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the [Product][google.cloud.retail.v2beta.Product]s deemed by the API as relevant) in search results. This field is only considered if [page_token][google.cloud.retail.v2beta.SearchRequest.page_token] is unset.

If this field is negative, an INVALID_ARGUMENT is returned.

Type

int

filter

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. For more information, see Filter.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Type

str

canonical_filter

The default filter that is applied when a user performs a search without checking any filters on the search page.

The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality.

For more information about filter syntax, see [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter].

Type

str

order_by

The order in which products are returned. Products can be ordered by a field in an [Product][google.cloud.retail.v2beta.Product] object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. For more information, see Order.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Type

str

facet_specs

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

Type

MutableSequence[google.cloud.retail_v2beta.types.SearchRequest.FacetSpec]

dynamic_facet_spec

Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field.

The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.

Type

google.cloud.retail_v2beta.types.SearchRequest.DynamicFacetSpec

boost_spec

Boost specification to boost certain products. For more information, see Boost results.

Notice that if both [ServingConfig.boost_control_ids][google.cloud.retail.v2beta.ServingConfig.boost_control_ids] and [SearchRequest.boost_spec][google.cloud.retail.v2beta.SearchRequest.boost_spec] are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.

Type

google.cloud.retail_v2beta.types.SearchRequest.BoostSpec

query_expansion_spec

The query expansion specification that specifies the conditions under which query expansion occurs. For more information, see Query expansion.

Type

google.cloud.retail_v2beta.types.SearchRequest.QueryExpansionSpec

variant_rollup_keys

The keys to fetch and rollup the matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s attributes, [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo] or [LocalInventory][google.cloud.retail.v2beta.LocalInventory]s attributes. The attributes from all the matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s or [LocalInventory][google.cloud.retail.v2beta.LocalInventory]s are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30.

For [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo], a fulfillment type and a fulfillment ID must be provided in the format of “fulfillmentType.fulfillmentId”. E.g., in “pickupInStore.store123”, “pickupInStore” is fulfillment type and “store123” is the store ID.

Supported keys are:

• colorFamilies

• price

• originalPrice

• discount

• variantId

• inventory(place_id,price)

• inventory(place_id,original_price)

• inventory(place_id,attributes.key), where key is any key in the [Product.local_inventories.attributes][google.cloud.retail.v2beta.LocalInventory.attributes] map.

• attributes.key, where key is any key in the [Product.attributes][google.cloud.retail.v2beta.Product.attributes] map.

• pickupInStore.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] “pickup-in-store”.

• shipToStore.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] “ship-to-store”.

• sameDayDelivery.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] “same-day-delivery”.

• nextDayDelivery.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] “next-day-delivery”.

• customFulfillment1.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] “custom-type-1”.

• customFulfillment2.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] “custom-type-2”.

• customFulfillment3.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] “custom-type-3”.

• customFulfillment4.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] “custom-type-4”.

• customFulfillment5.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] “custom-type-5”.

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

Type

MutableSequence[str]

page_categories

The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as [UserEvent.page_categories][google.cloud.retail.v2beta.UserEvent.page_categories];

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).

Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: “pageCategories” : [“Sales > 2017 Black Friday Deals”].

Type

MutableSequence[str]

search_mode

The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.

Type

google.cloud.retail_v2beta.types.SearchRequest.SearchMode

personalization_spec

The specification for personalization.

Notice that if both [ServingConfig.personalization_spec][google.cloud.retail.v2beta.ServingConfig.personalization_spec] and [SearchRequest.personalization_spec][google.cloud.retail.v2beta.SearchRequest.personalization_spec] are set. [SearchRequest.personalization_spec][google.cloud.retail.v2beta.SearchRequest.personalization_spec] will override [ServingConfig.personalization_spec][google.cloud.retail.v2beta.ServingConfig.personalization_spec].

Type

google.cloud.retail_v2beta.types.SearchRequest.PersonalizationSpec

labels

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.

For more information, see Requirements for labels in the Resource Manager documentation.

Type

MutableMapping[str, str]

spell_correction_spec

The spell correction specification that specifies the mode under which spell correction will take effect.

This field is a member of oneof _spell_correction_spec.

Type

google.cloud.retail_v2beta.types.SearchRequest.SpellCorrectionSpec

entity

The entity for customers that may run multiple different entities, domains, sites or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc. If this is set, it should be exactly matched with [UserEvent.entity][google.cloud.retail.v2beta.UserEvent.entity] to get search results boosted by entity.

Type

str

conversational_search_spec

Optional. This field specifies all conversational related parameters addition to traditional retail search.

Type

google.cloud.retail_v2beta.types.SearchRequest.ConversationalSearchSpec

tile_navigation_spec

Optional. This field specifies tile navigation related parameters.

Type

google.cloud.retail_v2beta.types.SearchRequest.TileNavigationSpec

class BoostSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Boost specification to boost certain items.

condition_boost_specs

Condition boost specifications. If a product matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.

Type

MutableSequence[google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec]

skip_boost_spec_validation

Whether to skip boostspec validation. If this field is set to true, invalid [BoostSpec.condition_boost_specs][google.cloud.retail.v2beta.SearchRequest.BoostSpec.condition_boost_specs] will be ignored and valid [BoostSpec.condition_boost_specs][google.cloud.retail.v2beta.SearchRequest.BoostSpec.condition_boost_specs] will still be applied.

This field is a member of oneof _skip_boost_spec_validation.

Type

bool

class ConditionBoostSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Boost applies to products which match a condition.

condition

An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter] for detail syntax and limitations.

Examples:

• To boost products with product ID “product_1” or “product_2”, and color “Red” or “Blue”:

  • (id: ANY(“product_1”, “product_2”)) AND (colorFamilies: ANY(“Red”,”Blue”))

Type

str

boost

Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0.

Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items.

Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely.

Setting to 0.0 means no boost applied. The boosting condition is ignored.

Type

float

class ConversationalSearchSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

This field specifies all conversational related parameters addition to traditional retail search.

followup_conversation_requested

This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc.

Type

bool

conversation_id

This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous [ConversationalSearchResult.conversation_id][]. For the initial request, this should be empty.

Type

str

user_answer

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.

Type

google.cloud.retail_v2beta.types.SearchRequest.ConversationalSearchSpec.UserAnswer

class UserAnswer(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

text_answer

This field specifies the incremental input text from the user during the conversational search.

This field is a member of oneof type.

Type

str

selected_answer

This field specifies the selected attributes during the conversational search. This should be a subset of [ConversationalSearchResult.suggested_answers][].

This field is a member of oneof type.

Type

google.cloud.retail_v2beta.types.SearchRequest.ConversationalSearchSpec.UserAnswer.SelectedAnswer

class SelectedAnswer(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

This field specifies the selected answers during the conversational search.

product_attribute_values

This field is deprecated and should not be set.

Type

MutableSequence[google.cloud.retail_v2beta.types.ProductAttributeValue]

product_attribute_value

This field specifies the selected answer which is a attribute key-value.

Type

google.cloud.retail_v2beta.types.ProductAttributeValue

class DynamicFacetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The specifications of dynamically generated facets.

mode

Mode of the DynamicFacet feature. Defaults to [Mode.DISABLED][google.cloud.retail.v2beta.SearchRequest.DynamicFacetSpec.Mode.DISABLED] if it’s unset.

Type

google.cloud.retail_v2beta.types.SearchRequest.DynamicFacetSpec.Mode

class Mode(value)

Bases: proto.enums.Enum

Enum to control DynamicFacet mode

Values:

MODE_UNSPECIFIED (0):

Default value.

DISABLED (1):

Disable Dynamic Facet.

ENABLED (2):

Automatic mode built by Google Retail Search.

class FacetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A facet specification to perform faceted search.

facet_key

Required. The facet key specification.

Type

google.cloud.retail_v2beta.types.SearchRequest.FacetSpec.FacetKey

limit

Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300.

If this field is negative, an INVALID_ARGUMENT is returned.

Type

int

excluded_filter_keys

List of keys to exclude when faceting.

By default, [FacetKey.key][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.key] is not excluded from the filter unless it is listed in this field.

Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned.

For example, suppose there are 100 products with the color facet “Red” and 200 products with the color facet “Blue”. A query containing the filter “colorFamilies:ANY(“Red”)” and having “colorFamilies” as [FacetKey.key][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.key] would by default return only “Red” products in the search results, and also return “Red” with count 100 as the only color facet. Although there are also blue products available, “Blue” would not be shown as an available facet value.

If “colorFamilies” is listed in “excludedFilterKeys”, then the query returns the facet values “Red” with count 100 and “Blue” with count 200, because the “colorFamilies” key is now excluded from the filter. Because this field doesn’t affect search results, the search results are still correctly filtered to return only “Red” products.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

Type

MutableSequence[str]

enable_dynamic_position

Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets.

For example, you may always want to have rating facet returned in the response, but it’s not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search.

Another example, assuming you have the following facets in the request:

• “rating”, enable_dynamic_position = true

• “price”, enable_dynamic_position = false

• “brands”, enable_dynamic_position = false

And also you have a dynamic facets enable, which generates a facet “gender”. Then, the final order of the facets in the response can be (“price”, “brands”, “rating”, “gender”) or (“price”, “brands”, “gender”, “rating”) depends on how Google Retail Search orders “gender” and “rating” facets. However, notice that “price” and “brands” are always ranked at first and second position because their enable_dynamic_position values are false.

Type

bool

class FacetKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Specifies how a facet is computed.

key

Required. Supported textual and numerical facet keys in [Product][google.cloud.retail.v2beta.Product] object, over which the facet values are computed. Facet key is case-sensitive.

Allowed facet keys when [FacetKey.query][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.query] is not specified:

• textual_field =

  • “brands”

  • “categories”

  • “genders”

  • “ageGroups”

  • “availability”

  • “colorFamilies”

  • “colors”

  • “sizes”

  • “materials”

  • “patterns”

  • “conditions”

  • “attributes.key”

  • “pickupInStore”

  • “shipToStore”

  • “sameDayDelivery”

  • “nextDayDelivery”

  • “customFulfillment1”

  • “customFulfillment2”

  • “customFulfillment3”

  • “customFulfillment4”

  • “customFulfillment5”

  • “inventory(place_id,attributes.key)”

• numerical_field =

  • “price”

  • “discount”

  • “rating”

  • “ratingCount”

  • “attributes.key”

  • “inventory(place_id,price)”

  • “inventory(place_id,original_price)”

  • “inventory(place_id,attributes.key)”.

Type

str

intervals

Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40.

For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles become the bounds for its intervals and are returned in the response. If the facet key intervals are specified in the request, then the specified intervals are returned instead.

Type

MutableSequence[google.cloud.retail_v2beta.types.Interval]

restricted_values

Only get facet for the given restricted values. For example, when using “pickupInStore” as key and set restricted values to [“store123”, “store456”], only facets for “store123” and “store456” are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20.

Must be set for the fulfillment facet keys:

• pickupInStore

• shipToStore

• sameDayDelivery

• nextDayDelivery

• customFulfillment1

• customFulfillment2

• customFulfillment3

• customFulfillment4

• customFulfillment5

Type

MutableSequence[str]

prefixes

Only get facet values that start with the given string prefix. For example, suppose “categories” has three values “Women > Shoe”, “Women > Dress” and “Men > Shoe”. If set “prefixes” to “Women”, the “categories” facet gives only “Women > Shoe” and “Women > Dress”. Only supported on textual fields. Maximum is 10.

Type

MutableSequence[str]

contains

Only get facet values that contains the given strings. For example, suppose “categories” has three values “Women > Shoe”, “Women > Dress” and “Men > Shoe”. If set “contains” to “Shoe”, the “categories” facet gives only “Women > Shoe” and “Men > Shoe”. Only supported on textual fields. Maximum is 10.

Type

MutableSequence[str]

case_insensitive

True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

Type

bool

order_by

The order in which [SearchResponse.Facet.values][google.cloud.retail.v2beta.SearchResponse.Facet.values] are returned.

Allowed values are:

• “count desc”, which means order by [SearchResponse.Facet.values.count][google.cloud.retail.v2beta.SearchResponse.Facet.FacetValue.count] descending.

• “value desc”, which means order by [SearchResponse.Facet.values.value][google.cloud.retail.v2beta.SearchResponse.Facet.FacetValue.value] descending. Only applies to textual facets.

If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by [FacetSpec.FacetKey.intervals][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.intervals]; [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] are sorted in the order given by [FacetSpec.FacetKey.restricted_values][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.restricted_values].

Type

str

query

The query that is used to compute facet for the given facet key. When provided, it overrides the default behavior of facet computation. The query syntax is the same as a filter expression. See [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter] for detail syntax and limitations. Notice that there is no limitation on [FacetKey.key][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.key] when query is specified.

In the response, [SearchResponse.Facet.values.value][google.cloud.retail.v2beta.SearchResponse.Facet.FacetValue.value] is always “1” and [SearchResponse.Facet.values.count][google.cloud.retail.v2beta.SearchResponse.Facet.FacetValue.count] is the number of results that match the query.

For example, you can set a customized facet for “shipToStore”, where [FacetKey.key][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.key] is “customizedShipToStore”, and [FacetKey.query][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.query] is “availability: ANY(“IN_STOCK”) AND shipToStore: ANY(“123”)”. Then the facet counts the products that are both in stock and ship to store “123”.

Type

str

return_min_max

Returns the min and max value for each numerical facet intervals. Ignored for textual facets.

Type

bool

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class PersonalizationSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The specification for personalization.

mode

Defaults to [Mode.AUTO][google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec.Mode.AUTO].

Type

google.cloud.retail_v2beta.types.SearchRequest.PersonalizationSpec.Mode

class Mode(value)

Bases: proto.enums.Enum

The personalization mode of each search request.

Values:

MODE_UNSPECIFIED (0):

Default value. In this case, server behavior defaults to [Mode.AUTO][google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec.Mode.AUTO].

AUTO (1):

Let CRS decide whether to use personalization based on quality of user event data.

DISABLED (2):

Disable personalization.

class QueryExpansionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Specification to determine under which conditions query expansion should occur.

condition

The condition under which query expansion should occur. Default to [Condition.DISABLED][google.cloud.retail.v2beta.SearchRequest.QueryExpansionSpec.Condition.DISABLED].

Type

google.cloud.retail_v2beta.types.SearchRequest.QueryExpansionSpec.Condition

pin_unexpanded_results

Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.

Type

bool

class Condition(value)

Bases: proto.enums.Enum

Enum describing under which condition query expansion should occur.

Values:

CONDITION_UNSPECIFIED (0):

Unspecified query expansion condition. In this case, server behavior defaults to [Condition.DISABLED][google.cloud.retail.v2beta.SearchRequest.QueryExpansionSpec.Condition.DISABLED].

DISABLED (1):

Disabled query expansion. Only the exact search query is used, even if [SearchResponse.total_size][google.cloud.retail.v2beta.SearchResponse.total_size] is zero.

AUTO (3):

Automatic query expansion built by Google Retail Search.

class SearchMode(value)

Bases: proto.enums.Enum

The search mode of each search request.

Values:

SEARCH_MODE_UNSPECIFIED (0):

Default value. In this case both product search and faceted search will be performed. Both [SearchResponse.SearchResult][google.cloud.retail.v2beta.SearchResponse.SearchResult] and [SearchResponse.Facet][google.cloud.retail.v2beta.SearchResponse.Facet] will be returned.

PRODUCT_SEARCH_ONLY (1):

Only product search will be performed. The faceted search will be disabled.

Only [SearchResponse.SearchResult][google.cloud.retail.v2beta.SearchResponse.SearchResult] will be returned. [SearchResponse.Facet][google.cloud.retail.v2beta.SearchResponse.Facet] will not be returned, even if [SearchRequest.facet_specs][google.cloud.retail.v2beta.SearchRequest.facet_specs] or [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2beta.SearchRequest.dynamic_facet_spec] is set.

FACETED_SEARCH_ONLY (2):

Only faceted search will be performed. The product search will be disabled.

When in this mode, one or both of [SearchRequest.facet_specs][google.cloud.retail.v2beta.SearchRequest.facet_specs] and [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2beta.SearchRequest.dynamic_facet_spec] should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only [SearchResponse.Facet][google.cloud.retail.v2beta.SearchResponse.Facet] will be returned. [SearchResponse.SearchResult][google.cloud.retail.v2beta.SearchResponse.SearchResult] will not be returned.

class SpellCorrectionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The specification for query spell correction.

mode

The mode under which spell correction should take effect to replace the original search query. Default to [Mode.AUTO][google.cloud.retail.v2beta.SearchRequest.SpellCorrectionSpec.Mode.AUTO].

Type

google.cloud.retail_v2beta.types.SearchRequest.SpellCorrectionSpec.Mode

class Mode(value)

Bases: proto.enums.Enum

Enum describing under which mode spell correction should occur.

Values:

MODE_UNSPECIFIED (0):

Unspecified spell correction mode. In this case, server behavior defaults to [Mode.AUTO][google.cloud.retail.v2beta.SearchRequest.SpellCorrectionSpec.Mode.AUTO].

SUGGESTION_ONLY (1):

Google Retail Search will try to find a spell suggestion if there is any and put in the [SearchResponse.corrected_query][google.cloud.retail.v2beta.SearchResponse.corrected_query]. The spell suggestion will not be used as the search query.

AUTO (2):

Automatic spell correction built by Google Retail Search. Search will be based on the corrected query if found.

class TileNavigationSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

This field specifies tile navigation related parameters.

tile_navigation_requested

This field specifies whether the customer would like to request tile navigation.

Type

bool

applied_tiles

This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter].

Type

MutableSequence[google.cloud.retail_v2beta.types.Tile]

class google.cloud.retail_v2beta.types.SearchResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] method.

results

A list of matched items. The order represents the ranking.

Type

MutableSequence[google.cloud.retail_v2beta.types.SearchResponse.SearchResult]

facets

Results of facets requested by user.

Type

MutableSequence[google.cloud.retail_v2beta.types.SearchResponse.Facet]

total_size

The estimated total count of matched items irrespective of pagination. The count of [results][google.cloud.retail.v2beta.SearchResponse.results] returned by pagination may be less than the [total_size][google.cloud.retail.v2beta.SearchResponse.total_size] that matches.

Type

int

corrected_query

Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.

Type

str

attribution_token

A unique search token. This should be included in the [UserEvent][google.cloud.retail.v2beta.UserEvent] logs resulting from this search, which enables accurate attribution of search model performance.

Type

str

next_page_token

A token that can be sent as [SearchRequest.page_token][google.cloud.retail.v2beta.SearchRequest.page_token] to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

query_expansion_info

Query expansion information for the returned results.

Type

google.cloud.retail_v2beta.types.SearchResponse.QueryExpansionInfo

redirect_uri

The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only [redirect_uri][google.cloud.retail.v2beta.SearchResponse.redirect_uri] and [attribution_token][google.cloud.retail.v2beta.SearchResponse.attribution_token] are set in the response.

Type

str

applied_controls

The fully qualified resource name of applied controls.

Type

MutableSequence[str]

invalid_condition_boost_specs

The invalid [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2beta.SearchRequest.BoostSpec.condition_boost_specs] that are not applied during serving.

Type

MutableSequence[google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec]

experiment_info

Metadata related to A/B testing [Experiment][] associated with this response. Only exists when an experiment is triggered.

Type

MutableSequence[google.cloud.retail_v2beta.types.ExperimentInfo]

conversational_search_result

This field specifies all related information that is needed on client side for UI rendering of conversational retail search.

Type

google.cloud.retail_v2beta.types.SearchResponse.ConversationalSearchResult

tile_navigation_result

This field specifies all related information for tile navigation that will be used in client side.

Type

google.cloud.retail_v2beta.types.SearchResponse.TileNavigationResult

class ConversationalSearchResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

This field specifies all related information that is needed on client side for UI rendering of conversational retail search.

conversation_id

Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request’s [SearchRequest.ConversationalSearchSpec.conversation_id][google.cloud.retail.v2beta.SearchRequest.ConversationalSearchSpec.conversation_id] to restore conversation state in server.

Type

str

refined_query

The current refined query for the conversational search. This field will be used in customer UI that the query in the search bar should be replaced with the refined query. For example, if [SearchRequest.query][google.cloud.retail.v2beta.SearchRequest.query] is dress and next [SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer][google.cloud.retail.v2beta.SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer] is red color, which does not match any product attribute value filters, the refined query will be dress, red color.

Type

str

additional_filters

This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field additional_filter.

Type

MutableSequence[google.cloud.retail_v2beta.types.SearchResponse.ConversationalSearchResult.AdditionalFilter]

followup_question

The follow-up question. e.g., What is the color?

Type

str

suggested_answers

The answer options provided to client for the follow-up question.

Type

MutableSequence[google.cloud.retail_v2beta.types.SearchResponse.ConversationalSearchResult.SuggestedAnswer]

additional_filter

This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter], and use the merged filter in the follow up search request.

Type

google.cloud.retail_v2beta.types.SearchResponse.ConversationalSearchResult.AdditionalFilter

class AdditionalFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Additional filter that client side need to apply.

product_attribute_value

Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future.

Type

google.cloud.retail_v2beta.types.ProductAttributeValue

class SuggestedAnswer(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Suggested answers to the follow-up question.

product_attribute_value

Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future.

Type

google.cloud.retail_v2beta.types.ProductAttributeValue

class Facet(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A facet result.

key

The key for this facet. E.g., “colorFamilies” or “price” or “attributes.attr1”.

Type

str

values

The facet values for this field.

Type

MutableSequence[google.cloud.retail_v2beta.types.SearchResponse.Facet.FacetValue]

dynamic_facet

Whether the facet is dynamically generated.

Type

bool

class FacetValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A facet value which contains value names and their count.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

value

Text value of a facet, such as “Black” for facet “colorFamilies”.

This field is a member of oneof facet_value.

Type

str

interval

Interval value for a facet, such as [10, 20) for facet “price”.

This field is a member of oneof facet_value.

Type

google.cloud.retail_v2beta.types.Interval

count

Number of items that have this facet value.

Type

int

min_value

The minimum value in the [FacetValue.interval][google.cloud.retail.v2beta.SearchResponse.Facet.FacetValue.interval]. Only supported on numerical facets and returned if [SearchRequest.FacetSpec.FacetKey.return_min_max][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.return_min_max] is true.

Type

float

max_value

The maximum value in the [FacetValue.interval][google.cloud.retail.v2beta.SearchResponse.Facet.FacetValue.interval]. Only supported on numerical facets and returned if [SearchRequest.FacetSpec.FacetKey.return_min_max][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.return_min_max] is true.

Type

float

class QueryExpansionInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Information describing query expansion including whether expansion has occurred.

expanded_query

Bool describing whether query expansion has occurred.

Type

bool

pinned_result_count

Number of pinned results. This field will only be set when expansion happens and [SearchRequest.QueryExpansionSpec.pin_unexpanded_results][google.cloud.retail.v2beta.SearchRequest.QueryExpansionSpec.pin_unexpanded_results] is set to true.

Type

int

class SearchResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the search results.

id

[Product.id][google.cloud.retail.v2beta.Product.id] of the searched [Product][google.cloud.retail.v2beta.Product].

Type

str

product

The product data snippet in the search response. Only [Product.name][google.cloud.retail.v2beta.Product.name] is guaranteed to be populated.

[Product.variants][google.cloud.retail.v2beta.Product.variants] contains the product variants that match the search query. If there are multiple product variants matching the query, top 5 most relevant product variants are returned and ordered by relevancy.

If relevancy can be deternmined, use [matching_variant_fields][google.cloud.retail.v2beta.SearchResponse.SearchResult.matching_variant_fields] to look up matched product variants fields. If relevancy cannot be determined, e.g. when searching “shoe” all products in a shoe product can be a match, 5 product variants are returned but order is meaningless.

Type

google.cloud.retail_v2beta.types.Product

matching_variant_count

The count of matched [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s.

Type

int

matching_variant_fields

If a [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2beta.Product] fields are matched. The key is the [Product.name][google.cloud.retail.v2beta.Product.name], the value is a field mask of the matched [Product][google.cloud.retail.v2beta.Product] fields. If matched attributes cannot be determined, this map will be empty.

For example, a key “sku1” with field mask “products.color_info” indicates there is a match between “sku1” [ColorInfo][google.cloud.retail.v2beta.ColorInfo] and the query.

Type

MutableMapping[str, google.protobuf.field_mask_pb2.FieldMask]

variant_rollup_values

The rollup matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] attributes. The key is one of the [SearchRequest.variant_rollup_keys][google.cloud.retail.v2beta.SearchRequest.variant_rollup_keys]. The values are the merged and de-duplicated [Product][google.cloud.retail.v2beta.Product] attributes. Notice that the rollup values are respect filter. For example, when filtering by “colorFamilies:ANY(“red”)” and rollup “colorFamilies”, only “red” is returned.

For textual and numerical attributes, the rollup values is a list of string or double values with type [google.protobuf.ListValue][google.protobuf.ListValue]. For example, if there are two variants with colors “red” and “blue”, the rollup values are

{ key: "colorFamilies"
  value {
    list_value {
      values { string_value: "red" }
      values { string_value: "blue" }
     }
  }
}

For [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo], the rollup values is a double value with type [google.protobuf.Value][google.protobuf.Value]. For example, {key: "pickupInStore.store1" value { number_value: 10 }} means a there are 10 variants in this product are available in the store “store1”.

Type

MutableMapping[str, google.protobuf.struct_pb2.Value]

personal_labels

Specifies previous events related to this product for this user based on [UserEvent][google.cloud.retail.v2beta.UserEvent] with same [SearchRequest.visitor_id][google.cloud.retail.v2beta.SearchRequest.visitor_id] or [UserInfo.user_id][google.cloud.retail.v2beta.UserInfo.user_id].

This is set only when [SearchRequest.PersonalizationSpec.mode][google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec.mode] is [SearchRequest.PersonalizationSpec.Mode.AUTO][google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec.Mode.AUTO].

Possible values:

• purchased: Indicates that this product has been purchased before.

Type

MutableSequence[str]

class MatchingVariantFieldsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class VariantRollupValuesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class TileNavigationResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

This field specifies all related information for tile navigation that will be used in client side.

tiles

The current tiles that are used for tile navigation, sorted by engagement.

Type

MutableSequence[google.cloud.retail_v2beta.types.Tile]

class google.cloud.retail_v2beta.types.SearchSolutionUseCase(value)

Bases: proto.enums.Enum

The use case of Cloud Retail Search.

Values:

SEARCH_SOLUTION_USE_CASE_UNSPECIFIED (0):

The value when it’s unspecified. In this case, server behavior defaults to [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2beta.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH].

SEARCH_SOLUTION_USE_CASE_SEARCH (1):

Search use case. Expects the traffic has a non-empty [query][google.cloud.retail.v2beta.SearchRequest.query].

SEARCH_SOLUTION_USE_CASE_BROWSE (2):

Browse use case. Expects the traffic has an empty [query][google.cloud.retail.v2beta.SearchRequest.query].

class google.cloud.retail_v2beta.types.ServingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).

name

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

Type

str

display_name

Required. The human readable serving config 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 returned.

Type

str

model_id

The id of the model in the same [Catalog][google.cloud.retail.v2beta.Catalog] to use at serving time. Currently only RecommendationModels are supported: https://cloud.google.com/retail/recommendations-ai/docs/create-models Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR).

Required when [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

Type

str

price_reranking_level

How much price ranking we want in serving results. Price reranking causes product items with a similar recommendation probability to be ordered by price, with the highest-priced items first. This setting could result in a decrease in click-through and conversion rates. Allowed values are:

• no-price-reranking

• low-price-reranking

• medium-price-reranking

• high-price-reranking

If not specified, we choose default based on model type. Default value: no-price-reranking.

Can only be set if [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

Type

str

facet_control_ids

Facet specifications for faceted search. If empty, no facets are returned. The ids refer to the ids of [Control][google.cloud.retail.v2beta.Control] resources with only the Facet control set. These controls are assumed to be in the same [Catalog][google.cloud.retail.v2beta.Catalog] as the [ServingConfig][google.cloud.retail.v2beta.ServingConfig]. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

Can only be set if [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

Type

MutableSequence[str]

dynamic_facet_spec

The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.

Can only be set if [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

Type

google.cloud.retail_v2beta.types.SearchRequest.DynamicFacetSpec

boost_control_ids

Condition boost specifications. If a product matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 100.

Notice that if both [ServingConfig.boost_control_ids][google.cloud.retail.v2beta.ServingConfig.boost_control_ids] and [SearchRequest.boost_spec][google.cloud.retail.v2beta.SearchRequest.boost_spec] are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.

Can only be set if [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

Type

MutableSequence[str]

filter_control_ids

Condition filter specifications. If a product matches multiple conditions in the specifications, filters from these specifications are all applied and combined via the AND operator. Maximum number of specifications is 100.

Can only be set if [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

Type

MutableSequence[str]

redirect_control_ids

Condition redirect specifications. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 1000.

Can only be set if [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

Type

MutableSequence[str]

twoway_synonyms_control_ids

Condition synonyms specifications. If multiple syonyms conditions match, all matching synonyms control in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100.

Can only be set if [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

Type

MutableSequence[str]

oneway_synonyms_control_ids

Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100.

Can only be set if [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

Type

MutableSequence[str]

do_not_associate_control_ids

Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute.

• Order does not matter.

• Maximum number of specifications is 100.

Can only be set if [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

Type

MutableSequence[str]

replacement_control_ids

Condition replacement specifications.

• Applied according to the order in the list.

• A previously replaced term can not be re-replaced.

• Maximum number of specifications is 100.

Can only be set if [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

Type

MutableSequence[str]

ignore_control_ids

Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute.

• Order does not matter.

• Maximum number of specifications is 100.

Can only be set if [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

Type

MutableSequence[str]

diversity_level

How much diversity to use in recommendation model results e.g. medium-diversity or high-diversity. Currently supported values:

• no-diversity

• low-diversity

• medium-diversity

• high-diversity

• auto-diversity

If not specified, we choose default based on recommendation model type. Default value: no-diversity.

Can only be set if [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

Type

str

diversity_type

What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to [RULE_BASED_DIVERSITY][google.cloud.retail.v2beta.ServingConfig.DiversityType.RULE_BASED_DIVERSITY].

Type

google.cloud.retail_v2beta.types.ServingConfig.DiversityType

enable_category_filter_level

Whether to add additional category filters on the similar-items model. If not specified, we enable it by default. Allowed values are:

• no-category-match: No additional filtering of original results from the model and the customer’s filters.

• relaxed-category-match: Only keep results with categories that match at least one item categories in the PredictRequests’s context item.

  • If customer also sends filters in the PredictRequest, then the results will satisfy both conditions (user given and category match).

Can only be set if [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

Type

str

ignore_recs_denylist

When the flag is enabled, the products in the denylist will not be filtered out in the recommendation filtering results.

Type

bool

personalization_spec

The specification for personalization spec.

Can only be set if [solution_types][google.cloud.retail.v2beta.ServingConfig.solution_types] is [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

Notice that if both [ServingConfig.personalization_spec][google.cloud.retail.v2beta.ServingConfig.personalization_spec] and [SearchRequest.personalization_spec][google.cloud.retail.v2beta.SearchRequest.personalization_spec] are set. [SearchRequest.personalization_spec][google.cloud.retail.v2beta.SearchRequest.personalization_spec] will override [ServingConfig.personalization_spec][google.cloud.retail.v2beta.ServingConfig.personalization_spec].

Type

google.cloud.retail_v2beta.types.SearchRequest.PersonalizationSpec

solution_types

Required. Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution.

Type

MutableSequence[google.cloud.retail_v2beta.types.SolutionType]

class DiversityType(value)

Bases: proto.enums.Enum

What type of diversity - data or rule based.

Values:

DIVERSITY_TYPE_UNSPECIFIED (0):

Default value.

RULE_BASED_DIVERSITY (2):

Rule based diversity.

DATA_DRIVEN_DIVERSITY (3):

Data driven diversity.

class google.cloud.retail_v2beta.types.SetDefaultBranchRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message to set a specified branch as new default_branch.

catalog

Full resource name of the catalog, such as projects/*/locations/global/catalogs/default_catalog.

Type

str

branch_id

The final component of the resource name of a branch.

This field must be one of “0”, “1” or “2”. Otherwise, an INVALID_ARGUMENT error is returned.

If there are no sufficient active products in the targeted branch and [force][google.cloud.retail.v2beta.SetDefaultBranchRequest.force] is not set, a FAILED_PRECONDITION error is returned.

Type

str

note

Some note on this request, this can be retrieved by [CatalogService.GetDefaultBranch][google.cloud.retail.v2beta.CatalogService.GetDefaultBranch] before next valid default branch set occurs.

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

Type

str

force

If set to true, it permits switching to a branch with [branch_id][google.cloud.retail.v2beta.SetDefaultBranchRequest.branch_id] even if it has no sufficient active products.

Type

bool

class google.cloud.retail_v2beta.types.SetInventoryMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the [ProductService.SetInventory][google.cloud.retail.v2beta.ProductService.SetInventory] method.

class google.cloud.retail_v2beta.types.SetInventoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ProductService.SetInventory][google.cloud.retail.v2beta.ProductService.SetInventory] method.

inventory

Required. The inventory information to update. The allowable fields to update are:

• [Product.price_info][google.cloud.retail.v2beta.Product.price_info]

• [Product.availability][google.cloud.retail.v2beta.Product.availability]

• [Product.available_quantity][google.cloud.retail.v2beta.Product.available_quantity]

• [Product.fulfillment_info][google.cloud.retail.v2beta.Product.fulfillment_info] The updated inventory fields must be specified in [SetInventoryRequest.set_mask][google.cloud.retail.v2beta.SetInventoryRequest.set_mask].

If [SetInventoryRequest.inventory.name][google.cloud.retail.v2beta.Product.name] is empty or invalid, an INVALID_ARGUMENT error is returned.

If the caller does not have permission to update the [Product][google.cloud.retail.v2beta.Product] named in [Product.name][google.cloud.retail.v2beta.Product.name], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [Product][google.cloud.retail.v2beta.Product] to update does not have existing inventory information, the provided inventory information will be inserted.

If the [Product][google.cloud.retail.v2beta.Product] to update has existing inventory information, the provided inventory information will be merged while respecting the last update time for each inventory field, using the provided or default value for [SetInventoryRequest.set_time][google.cloud.retail.v2beta.SetInventoryRequest.set_time].

The caller can replace place IDs for a subset of fulfillment types in the following ways:

• Adds “fulfillment_info” in [SetInventoryRequest.set_mask][google.cloud.retail.v2beta.SetInventoryRequest.set_mask]

• Specifies only the desired fulfillment types and corresponding place IDs to update in [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2beta.Product.fulfillment_info]

The caller can clear all place IDs from a subset of fulfillment types in the following ways:

• Adds “fulfillment_info” in [SetInventoryRequest.set_mask][google.cloud.retail.v2beta.SetInventoryRequest.set_mask]

• Specifies only the desired fulfillment types to clear in [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2beta.Product.fulfillment_info]

• Checks that only the desired fulfillment info types have empty [SetInventoryRequest.inventory.fulfillment_info.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids]

The last update time is recorded for the following inventory fields:

• [Product.price_info][google.cloud.retail.v2beta.Product.price_info]

• [Product.availability][google.cloud.retail.v2beta.Product.availability]

• [Product.available_quantity][google.cloud.retail.v2beta.Product.available_quantity]

• [Product.fulfillment_info][google.cloud.retail.v2beta.Product.fulfillment_info]

If a full overwrite of inventory information while ignoring timestamps is needed, [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct] should be invoked instead.

Type

google.cloud.retail_v2beta.types.Product

set_mask

Indicates which inventory fields in the provided [Product][google.cloud.retail.v2beta.Product] to update.

At least one field must be provided.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.

Type

google.protobuf.field_mask_pb2.FieldMask

set_time

The time when the request is issued, used to prevent out-of-order updates on inventory fields with the last update time recorded. If not provided, the internal system time will be used.

Type

google.protobuf.timestamp_pb2.Timestamp

allow_missing

If set to true, and the [Product][google.cloud.retail.v2beta.Product] with name [Product.name][google.cloud.retail.v2beta.Product.name] is not found, the inventory update will still be processed and retained for at most 1 day until the [Product][google.cloud.retail.v2beta.Product] is created. If set to false, a NOT_FOUND error is returned if the [Product][google.cloud.retail.v2beta.Product] is not found.

Type

bool

class google.cloud.retail_v2beta.types.SetInventoryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the [ProductService.SetInventory][google.cloud.retail.v2beta.ProductService.SetInventory] method.

class google.cloud.retail_v2beta.types.SolutionType(value)

Bases: proto.enums.Enum

The type of solution.

Values:

SOLUTION_TYPE_UNSPECIFIED (0):

Default value.

SOLUTION_TYPE_RECOMMENDATION (1):

Used for Recommendations AI.

SOLUTION_TYPE_SEARCH (2):

Used for Retail Search.

class google.cloud.retail_v2beta.types.Tile(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

product_attribute_value

The product attribute key-value.

This field is a member of oneof product_attribute.

Type

google.cloud.retail_v2beta.types.ProductAttributeValue

product_attribute_interval

The product attribute key-numeric interval.

This field is a member of oneof product_attribute.

Type

google.cloud.retail_v2beta.types.ProductAttributeInterval

representative_product_id

The representative product id for this tile.

Type

str

class google.cloud.retail_v2beta.types.TuneModelMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata associated with a tune operation.

model

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

Type

str

class google.cloud.retail_v2beta.types.TuneModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).

name

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

Type

str

class google.cloud.retail_v2beta.types.TuneModelResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response associated with a tune operation.

class google.cloud.retail_v2beta.types.UpdateAlertConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for [ProjectService.UpdateAlertConfig][google.cloud.retail.v2beta.ProjectService.UpdateAlertConfig] method.

alert_config

Required. The [AlertConfig][google.cloud.retail.v2beta.AlertConfig] to update.

If the caller does not have permission to update the [AlertConfig][google.cloud.retail.v2beta.AlertConfig], then a PERMISSION_DENIED error is returned.

If the [AlertConfig][google.cloud.retail.v2beta.AlertConfig] to update does not exist, a NOT_FOUND error is returned.

Type

google.cloud.retail_v2beta.types.AlertConfig

update_mask

Indicates which fields in the provided [AlertConfig][google.cloud.retail.v2beta.AlertConfig] to update. If not set, all supported fields are updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.retail_v2beta.types.UpdateAttributesConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for [CatalogService.UpdateAttributesConfig][google.cloud.retail.v2beta.CatalogService.UpdateAttributesConfig] method.

attributes_config

Required. The [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig] to update.

Type

google.cloud.retail_v2beta.types.AttributesConfig

update_mask

Indicates which fields in the provided [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig] to update. The following is the only supported field:

• [AttributesConfig.catalog_attributes][google.cloud.retail.v2beta.AttributesConfig.catalog_attributes]

If not set, all supported fields are updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.retail_v2beta.types.UpdateCatalogRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for [CatalogService.UpdateCatalog][google.cloud.retail.v2beta.CatalogService.UpdateCatalog] method.

catalog

Required. The [Catalog][google.cloud.retail.v2beta.Catalog] to update.

If the caller does not have permission to update the [Catalog][google.cloud.retail.v2beta.Catalog], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [Catalog][google.cloud.retail.v2beta.Catalog] to update does not exist, a NOT_FOUND error is returned.

Type

google.cloud.retail_v2beta.types.Catalog

update_mask

Indicates which fields in the provided [Catalog][google.cloud.retail.v2beta.Catalog] to update.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.retail_v2beta.types.UpdateCompletionConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for [CatalogService.UpdateCompletionConfig][google.cloud.retail.v2beta.CatalogService.UpdateCompletionConfig] method.

completion_config

Required. The [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig] to update.

If the caller does not have permission to update the [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig], then a PERMISSION_DENIED error is returned.

If the [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig] to update does not exist, a NOT_FOUND error is returned.

Type

google.cloud.retail_v2beta.types.CompletionConfig

update_mask

Indicates which fields in the provided [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig] to update. The following are the only supported fields:

• [CompletionConfig.matching_order][google.cloud.retail.v2beta.CompletionConfig.matching_order]

• [CompletionConfig.max_suggestions][google.cloud.retail.v2beta.CompletionConfig.max_suggestions]

• [CompletionConfig.min_prefix_length][google.cloud.retail.v2beta.CompletionConfig.min_prefix_length]

• [CompletionConfig.auto_learning][google.cloud.retail.v2beta.CompletionConfig.auto_learning]

If not set, all supported fields are updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.retail_v2beta.types.UpdateControlRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for UpdateControl method.

control

Required. The Control to update.

Type

google.cloud.retail_v2beta.types.Control

update_mask

Indicates which fields in the provided [Control][google.cloud.retail.v2beta.Control] to update. The following are NOT supported:

• [Control.name][google.cloud.retail.v2beta.Control.name]

If not set or empty, all supported fields are updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.retail_v2beta.types.UpdateGenerativeQuestionConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for UpdateGenerativeQuestionConfig method.

generative_question_config

Required. The question to update.

Type

google.cloud.retail_v2beta.types.GenerativeQuestionConfig

update_mask

Optional. Indicates which fields in the provided [GenerativeQuestionConfig][google.cloud.retail.v2beta.GenerativeQuestionConfig] to update. The following are NOT supported:

• [GenerativeQuestionConfig.frequency][google.cloud.retail.v2beta.GenerativeQuestionConfig.frequency]

If not set or empty, all supported fields are updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.retail_v2beta.types.UpdateGenerativeQuestionsFeatureConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for UpdateGenerativeQuestionsFeatureConfig method.

generative_questions_feature_config

Required. The configuration managing the feature state.

Type

google.cloud.retail_v2beta.types.GenerativeQuestionsFeatureConfig

update_mask

Optional. Indicates which fields in the provided [GenerativeQuestionsFeatureConfig][google.cloud.retail.v2beta.GenerativeQuestionsFeatureConfig] to update. If not set or empty, all supported fields are updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.retail_v2beta.types.UpdateModelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for updating an existing model.

model

Required. The body of the updated [Model][google.cloud.retail.v2beta.Model].

Type

google.cloud.retail_v2beta.types.Model

update_mask

Optional. Indicates which fields in the provided ‘model’ to update. If not set, by default updates all fields.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.retail_v2beta.types.UpdateProductRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct] method.

product

Required. The product to update/create.

If the caller does not have permission to update the [Product][google.cloud.retail.v2beta.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [Product][google.cloud.retail.v2beta.Product] to update does not exist and [allow_missing][google.cloud.retail.v2beta.UpdateProductRequest.allow_missing] is not set, a NOT_FOUND error is returned.

Type

google.cloud.retail_v2beta.types.Product

update_mask

Indicates which fields in the provided [Product][google.cloud.retail.v2beta.Product] to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

The attribute key can be updated by setting the mask path as “attributes.${key_name}”. If a key name is present in the mask but not in the patching product from the request, this key will be deleted after the update.

Type

google.protobuf.field_mask_pb2.FieldMask

allow_missing

If set to true, and the [Product][google.cloud.retail.v2beta.Product] is not found, a new [Product][google.cloud.retail.v2beta.Product] will be created. In this situation, update_mask is ignored.

Type

bool

class google.cloud.retail_v2beta.types.UpdateServingConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for UpdateServingConfig method.

serving_config

Required. The ServingConfig to update.

Type

google.cloud.retail_v2beta.types.ServingConfig

update_mask

Indicates which fields in the provided [ServingConfig][google.cloud.retail.v2beta.ServingConfig] to update. The following are NOT supported:

• [ServingConfig.name][google.cloud.retail.v2beta.ServingConfig.name]

If not set, all supported fields are updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.retail_v2beta.types.UserEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

UserEvent captures all metadata information Retail API needs to know about how end users interact with customers’ website.

event_type

Required. User event type. Allowed values are:

• add-to-cart: Products being added to cart.

• remove-from-cart: Products being removed from cart.

• category-page-view: Special pages such as sale or promotion pages viewed.

• detail-page-view: Products detail page viewed.

• home-page-view: Homepage viewed.

• promotion-offered: Promotion is offered to a user.

• promotion-not-offered: Promotion is not offered to a user.

• purchase-complete: User finishing a purchase.

• search: Product search.

• shopping-cart-page-view: User viewing a shopping cart.

Type

str

visitor_id

Required. 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 log in/out of the website.

Don’t set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality.

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

The field should not contain PII or user-data. We recommend to use Google Analytics Client ID for this field.

Type

str

session_id

A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span.

A general guideline to populate the sesion_id:

1. If user has no activity for 30 min, a new session_id should be assigned.

2. The session_id should be unique across users, suggest use uuid or add visitor_id as prefix.

Type

str

event_time

Only required for [UserEventService.ImportUserEvents][google.cloud.retail.v2beta.UserEventService.ImportUserEvents] method. Timestamp of when the user event happened.

Type

google.protobuf.timestamp_pb2.Timestamp

experiment_ids

A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models).

Type

MutableSequence[str]

attribution_token

Highly recommended for user events that are the result of [PredictionService.Predict][google.cloud.retail.v2beta.PredictionService.Predict]. This field enables accurate attribution of recommendation model performance.

The value must be a valid [PredictResponse.attribution_token][google.cloud.retail.v2beta.PredictResponse.attribution_token] for user events that are the result of [PredictionService.Predict][google.cloud.retail.v2beta.PredictionService.Predict]. The value must be a valid [SearchResponse.attribution_token][google.cloud.retail.v2beta.SearchResponse.attribution_token] for user events that are the result of [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].

This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass [PredictResponse.attribution_token][google.cloud.retail.v2beta.PredictResponse.attribution_token] as a URL parameter to product K’s page. When recording events on product K’s page, log the [PredictResponse.attribution_token][google.cloud.retail.v2beta.PredictResponse.attribution_token] to this field.

Type

str

product_details

The main product details related to the event.

This field is optional except for the following event types:

• add-to-cart

• detail-page-view

• purchase-complete

In a search event, this field represents the products returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new search event with different [product_details][google.cloud.retail.v2beta.UserEvent.product_details] is desired. The end user may have not finished browsing the whole page yet.

Type

MutableSequence[google.cloud.retail_v2beta.types.ProductDetail]

completion_detail

The main auto-completion details related to the event.

This field should be set for search event when autocomplete function is enabled and the user clicks a suggestion for search.

Type

google.cloud.retail_v2beta.types.CompletionDetail

attributes

Extra user event features to include in the recommendation model.

If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality.

This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

• The key must be a UTF-8 encoded string with a length limit of 5,000 characters.

• For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters.

• For number attributes, at most 400 values are allowed.

For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.

Type

MutableMapping[str, google.cloud.retail_v2beta.types.CustomAttribute]

cart_id

The ID or name of the associated shopping cart. This ID is used to associate multiple items added or present in the cart before purchase.

This can only be set for add-to-cart, purchase-complete, or shopping-cart-page-view events.

Type

str

purchase_transaction

A transaction represents the entire purchase transaction.

Required for purchase-complete events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

Type

google.cloud.retail_v2beta.types.PurchaseTransaction

search_query

The user’s search query.

See [SearchRequest.query][google.cloud.retail.v2beta.SearchRequest.query] for definition.

The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

At least one of [search_query][google.cloud.retail.v2beta.UserEvent.search_query] or [page_categories][google.cloud.retail.v2beta.UserEvent.page_categories] is required for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

Type

str

filter

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered.

See [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter] for definition and syntax.

The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Type

str

order_by

The order in which products are returned.

See [SearchRequest.order_by][google.cloud.retail.v2beta.SearchRequest.order_by] for definition and syntax.

The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

This can only be set for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

Type

str

offset

An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).

See [SearchRequest.offset][google.cloud.retail.v2beta.SearchRequest.offset] for definition.

If this field is negative, an INVALID_ARGUMENT is returned.

This can only be set for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

Type

int

page_categories

The categories associated with a category page.

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).

Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: “pageCategories” : [“Sales > 2017 Black Friday Deals”].

Required for category-page-view events. At least one of [search_query][google.cloud.retail.v2beta.UserEvent.search_query] or [page_categories][google.cloud.retail.v2beta.UserEvent.page_categories] is required for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

Type

MutableSequence[str]

user_info

User information.

Type

google.cloud.retail_v2beta.types.UserInfo

uri

Complete URL (window.location.href) of the user’s current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.

Type

str

referrer_uri

The referrer URL of the current page.

When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.

Type

str

page_view_id

A unique ID of a web page view.

This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The pageViewId property should be kept the same for all these events so that they can be grouped together properly.

When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.

Type

str

entity

The entity for customers that may run multiple different entities, domains, sites or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results.

Type

str

class AttributesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.retail_v2beta.types.UserEventImportSummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A summary of import result. The UserEventImportSummary summarizes the import status for user events.

joined_events_count

Count of user events imported with complete existing catalog information.

Type

int

unjoined_events_count

Count of user events imported, but with catalog information not found in the imported catalog.

Type

int

class google.cloud.retail_v2beta.types.UserEventInlineSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The inline source for the input config for ImportUserEvents method.

user_events

Required. A list of user events to import. Recommended max of 10k items.

Type

MutableSequence[google.cloud.retail_v2beta.types.UserEvent]

class google.cloud.retail_v2beta.types.UserEventInputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The input config source for user events.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

user_event_inline_source

Required. The Inline source for the input content for UserEvents.

This field is a member of oneof source.

Type

google.cloud.retail_v2beta.types.UserEventInlineSource

gcs_source

Required. Google Cloud Storage location for the input content.

This field is a member of oneof source.

Type

google.cloud.retail_v2beta.types.GcsSource

big_query_source

Required. BigQuery input source.

This field is a member of oneof source.

Type

google.cloud.retail_v2beta.types.BigQuerySource

class google.cloud.retail_v2beta.types.UserInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Information of an end user.

user_id

Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don’t set for anonymous users.

Always use a hashed value for this ID.

Don’t set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality.

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Type

str

ip_address

The end user’s IP address. This field is used to extract location information for personalization.

This field must be either an IPv4 address (e.g. “104.133.9.80”) or an IPv6 address (e.g. “2001:0db8:85a3:0000:0000:8a2e:0370:7334”). Otherwise, an INVALID_ARGUMENT error is returned.

This should not be set when:

• setting [SearchRequest.user_info][google.cloud.retail.v2beta.SearchRequest.user_info].

• using the JavaScript tag in [UserEventService.CollectUserEvent][google.cloud.retail.v2beta.UserEventService.CollectUserEvent] or if [direct_user_request][google.cloud.retail.v2beta.UserInfo.direct_user_request] is set.

Type

str

user_agent

User agent as included in the HTTP header. Required for getting [SearchResponse.sponsored_results][google.cloud.retail.v2beta.SearchResponse.sponsored_results].

The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

This should not be set when using the client side event reporting with GTM or JavaScript tag in [UserEventService.CollectUserEvent][google.cloud.retail.v2beta.UserEventService.CollectUserEvent] or if [direct_user_request][google.cloud.retail.v2beta.UserInfo.direct_user_request] is set.

Type

str

direct_user_request

True if the request is made directly from the end user, in which case the [ip_address][google.cloud.retail.v2beta.UserInfo.ip_address] and [user_agent][google.cloud.retail.v2beta.UserInfo.user_agent] can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events).

This should not be set when using the JavaScript tag in [UserEventService.CollectUserEvent][google.cloud.retail.v2beta.UserEventService.CollectUserEvent].

Type

bool

class google.cloud.retail_v2beta.types.WriteUserEventRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for WriteUserEvent method.

parent

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

Type

str

user_event

Required. User event to write.

Type

google.cloud.retail_v2beta.types.UserEvent

write_async

If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write. Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs.

Type

bool