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 v2 API

class google.cloud.retail_v2.types.AddFulfillmentPlacesMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

class google.cloud.retail_v2.types.AddFulfillmentPlacesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [AddFulfillmentPlaces][] method.

product

Required. Full resource name of [Product][google.cloud.retail.v2.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.v2.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][].

Type

str

place_ids

Required. The IDs for this [type][google.cloud.retail.v2.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.v2.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.v2.AddFulfillmentPlacesRequest.type] after adding, then the update will be rejected.

Type

Sequence[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.v2.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.v2.Product] is created. If set to false, an INVALID_ARGUMENT error is returned if the [Product][google.cloud.retail.v2.Product] is not found.

Type

bool

class google.cloud.retail_v2.types.AddFulfillmentPlacesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the [AddFulfillmentPlaces][] method.

class google.cloud.retail_v2.types.Audience(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An intended audience of the [Product][google.cloud.retail.v2.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

Sequence[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

Sequence[str]

class google.cloud.retail_v2.types.BigQuerySource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

BigQuery source import data from.

partition_date

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

Only supported when [ImportProductsRequest.reconciliation_mode][google.cloud.retail.v2.ImportProductsRequest.reconciliation_mode] is set to FULL.

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.v2.Product] per line. Each product must have a valid [Product.id][google.cloud.retail.v2.Product.id].

  • product_merchant_center: See Importing catalog data from Merchant Center.

Supported values for user events imports:

Type

str

class google.cloud.retail_v2.types.Catalog(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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_v2.types.ProductLevelConfig

class google.cloud.retail_v2.types.CollectUserEventRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for CollectUserEvent method.

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

class google.cloud.retail_v2.types.ColorInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The color information of a [Product][google.cloud.retail.v2.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

Sequence[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 5 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

Sequence[str]

class google.cloud.retail_v2.types.CompleteQueryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Auto-complete 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

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

The list of languages of the query. 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 allowed characters is 255. Only “en-US” is currently supported.

Type

Sequence[str]

device_type

The device type context for completion suggestions. It is useful to 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.v2.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 additional allowlisting. Before using cloud-retail, contact Cloud Retail support team first.

Type

str

max_suggestions

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

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

Type

int

class google.cloud.retail_v2.types.CompleteQueryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response of the auto-complete query.

completion_results

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

Type

Sequence[google.cloud.retail_v2.types.CompleteQueryResponse.CompletionResult]

attribution_token

A unique complete token. This should be included in the [SearchRequest][google.cloud.retail.v2.SearchRequest] resulting from this completion, which enables accurate attribution of complete model performance.

Type

str

recent_search_results

Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. Contact Retail Search support team if you are interested in enabling it.

This feature is only available when [CompleteQueryRequest.visitor_id][google.cloud.retail.v2.CompleteQueryRequest.visitor_id] field is set and [UserEvent][google.cloud.retail.v2.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.v2.CompleteQueryRequest.query] case insensitively.

  • They are transformed to lower cases.

  • They are UTF-8 safe.

Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

Type

Sequence[google.cloud.retail_v2.types.CompleteQueryResponse.RecentSearchResult]

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

Bases: proto.message.Message

Resource that represents completion results.

suggestion

The suggestion for the query.

Type

str

attributes

Additional custom attributes ingested through BigQuery.

Type

Sequence[google.cloud.retail_v2.types.CompleteQueryResponse.CompletionResult.AttributesEntry]

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

Bases: proto.message.Message

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

Bases: proto.message.Message

Recent search of this user.

The recent search query.

Type

str

class google.cloud.retail_v2.types.CompletionDataInputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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.

Type

google.cloud.retail_v2.types.BigQuerySource

class google.cloud.retail_v2.types.CompletionDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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.v2.CompleteQueryResponse.attribution_token].

Type

str

selected_suggestion

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

Type

str

selected_position

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

Type

int

class google.cloud.retail_v2.types.CreateProductRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [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.v2.Product] to create.

Type

google.cloud.retail_v2.types.Product

product_id

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

If the caller does not have permission to create the [Product][google.cloud.retail.v2.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.v2.Product]s with the same [parent][google.cloud.retail.v2.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_v2.types.CustomAttribute(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

text

The textual values of this custom attribute. For example, ["yellow", "green"] when the key is “color”.

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. Otherwise, an INVALID_ARGUMENT error is returned.

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

Type

Sequence[str]

numbers

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

At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned.

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

Type

Sequence[float]

searchable

If true, custom attribute values are searchable by text queries in [SearchService.Search][google.cloud.retail.v2.SearchService.Search].

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

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

Type

bool

indexable

If true, custom attribute values are indexed, so that it can be filtered, faceted or boosted in [SearchService.Search][google.cloud.retail.v2.SearchService.Search].

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

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

Type

bool

class google.cloud.retail_v2.types.DeleteProductRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DeleteProduct][] method.

name

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

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

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

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

Type

str

class google.cloud.retail_v2.types.FulfillmentInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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.v2.FulfillmentInfo.type], such as the store IDs for [FulfillmentInfo.type.pickup-in-store][google.cloud.retail.v2.FulfillmentInfo.type] or the region IDs for [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2.FulfillmentInfo.type].

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

Sequence[str]

class google.cloud.retail_v2.types.GcsSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Google Cloud Storage location for input content. format.

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

Sequence[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.v2.Product] per line. Each product must have a valid [Product.id][google.cloud.retail.v2.Product.id].

  • product_merchant_center: See Importing catalog data from Merchant Center.

Supported values for user events imports:

Type

str

class google.cloud.retail_v2.types.GetDefaultBranchRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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_v2.types.GetDefaultBranchResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message of [CatalogService.GetDefaultBranch][google.cloud.retail.v2.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.v2.SetDefaultBranchRequest.note] field, when this branch was set as default.

Type

str

class google.cloud.retail_v2.types.GetProductRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [GetProduct][] method.

name

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

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

Type

str

class google.cloud.retail_v2.types.Image(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

[Product][google.cloud.retail.v2.Product] thumbnail/detail image.

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_v2.types.ImportCompletionDataRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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_v2.types.CompletionDataInputConfig

notification_pubsub_topic

Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be 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_v2.types.ImportCompletionDataResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

Sequence[google.rpc.status_pb2.Status]

class google.cloud.retail_v2.types.ImportErrorsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Configuration of destination for Import related errors.

gcs_prefix

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

Type

str

class google.cloud.retail_v2.types.ImportMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metadata related to the progress of the Import 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 processed successfully.

Type

int

failure_count

Count of entries that encountered errors while processing.

Type

int

request_id

Id of the request / operation. This is parroting back the requestId that was passed in the request.

Type

str

notification_pubsub_topic

Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be 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_v2.types.ImportProductsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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

Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency and used for request deduplication. Server-generated if unspecified. Up to 128 characters long and must match the pattern: “[a-zA-Z0-9_]+”. This is returned as [Operation.name][] in [ImportMetadata][google.cloud.retail.v2.ImportMetadata].

Only supported when [ImportProductsRequest.reconciliation_mode][google.cloud.retail.v2.ImportProductsRequest.reconciliation_mode] is set to FULL.

Type

str

input_config

Required. The desired input location of the data.

Type

google.cloud.retail_v2.types.ProductInputConfig

errors_config

The desired location of errors incurred during the Import.

Type

google.cloud.retail_v2.types.ImportErrorsConfig

update_mask

Indicates which fields in the provided imported ‘products’ to update. If not set, will by default update all fields.

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.v2.ImportProductsRequest.ReconciliationMode.INCREMENTAL].

Type

google.cloud.retail_v2.types.ImportProductsRequest.ReconciliationMode

notification_pubsub_topic

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

Only supported when [ImportProductsRequest.reconciliation_mode][google.cloud.retail.v2.ImportProductsRequest.reconciliation_mode] is set to FULL.

Type

str

class ReconciliationMode(value)[source]

Bases: proto.enums.Enum

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

FULL = 2
INCREMENTAL = 1
RECONCILIATION_MODE_UNSPECIFIED = 0
class google.cloud.retail_v2.types.ImportProductsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

Sequence[google.rpc.status_pb2.Status]

errors_config

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

Type

google.cloud.retail_v2.types.ImportErrorsConfig

class google.cloud.retail_v2.types.ImportUserEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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_v2.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_v2.types.ImportErrorsConfig

class google.cloud.retail_v2.types.ImportUserEventsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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

Sequence[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_v2.types.ImportErrorsConfig

import_summary

Aggregated statistics of user event import status.

Type

google.cloud.retail_v2.types.UserEventImportSummary

class google.cloud.retail_v2.types.Interval(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A floating point interval.

minimum

Inclusive lower bound.

Type

float

exclusive_minimum

Exclusive lower bound.

Type

float

maximum

Inclusive upper bound.

Type

float

exclusive_maximum

Exclusive upper bound.

Type

float

class google.cloud.retail_v2.types.ListCatalogsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for [CatalogService.ListCatalogs][google.cloud.retail.v2.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.v2.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.v2.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.v2.ListCatalogsResponse.next_page_token], received from a previous [CatalogService.ListCatalogs][google.cloud.retail.v2.CatalogService.ListCatalogs] call. Provide this to retrieve the subsequent page.

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

Type

str

class google.cloud.retail_v2.types.ListCatalogsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

catalogs

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

Type

Sequence[google.cloud.retail_v2.types.Catalog]

next_page_token

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

Type

str

property raw_page
class google.cloud.retail_v2.types.ListProductsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [ProductService.ListProducts][google.cloud.retail.v2.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.v2.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.v2.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.v2.ListProductsResponse.next_page_token], received from a previous [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [ProductService.ListProducts][google.cloud.retail.v2.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.v2.ListProductsRequest.filter] is unset.

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

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

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

Type

str

read_mask

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

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

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

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

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

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

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

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

If “*” is provided, all fields are returned. [Product.name][google.cloud.retail.v2.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_v2.types.ListProductsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

products

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

Type

Sequence[google.cloud.retail_v2.types.Product]

next_page_token

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

Type

str

property raw_page
class google.cloud.retail_v2.types.PredictRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for Predict method.

placement

Required. Full resource name of the format: {name=projects//locations/global/catalogs/default_catalog/placements/} The ID of the Recommendations AI placement. Before you can request predictions from your model, you must create at least one placement for it. For more information, see Managing placements.

The full list of available placements can be seen at https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements

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.

Type

google.cloud.retail_v2.types.UserEvent

page_size

Maximum number of results to return per page. 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

The previous PredictResponse.next_page_token.

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, nothing will be returned. If you want generic (unfiltered) popular products to be returned instead, set strictFiltering to false in PredictRequest.params.

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

Type

Sequence[google.cloud.retail_v2.types.PredictRequest.ParamsEntry]

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

Sequence[google.cloud.retail_v2.types.PredictRequest.LabelsEntry]

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_v2.types.PredictResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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

Sequence[google.cloud.retail_v2.types.PredictResponse.PredictionResult]

attribution_token

A unique attribution token. This should be included in the [UserEvent][google.cloud.retail.v2.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

Sequence[str]

validate_only

True if the validateOnly property was set in the request.

Type

bool

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

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. Will be set if returnProduct is set to true in PredictRequest.params.

  • score: Prediction score in double value. Will be set if returnScore is set to true in PredictRequest.params.

Type

Sequence[google.cloud.retail_v2.types.PredictResponse.PredictionResult.MetadataEntry]

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

Bases: proto.message.Message

class google.cloud.retail_v2.types.PriceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The price information of a [Product][google.cloud.retail.v2.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.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s with the same [Product.primary_product_id][google.cloud.retail.v2.Product.primary_product_id] must share the same [currency_code][google.cloud.retail.v2.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.priceSpecification.

Type

float

original_price

Price of the product without any discount. If zero, by default set to be the [price][google.cloud.retail.v2.PriceInfo.price].

Type

float

cost

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

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

Google Merchant Center property cost_of_goods_sold.

Type

float

price_effective_time

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

Do not set if [price][google.cloud.retail.v2.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.v2.PriceInfo.price] stops to be effective. The [price][google.cloud.retail.v2.PriceInfo.price] is used for search before [price_expire_time][google.cloud.retail.v2.PriceInfo.price_expire_time]. If this field is set, the [original_price][google.cloud.retail.v2.PriceInfo.original_price] must be set and [original_price][google.cloud.retail.v2.PriceInfo.original_price] is used after [price_expire_time][google.cloud.retail.v2.PriceInfo.price_expire_time].

Do not set if [price][google.cloud.retail.v2.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.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s grouped together on the [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] [Product][google.cloud.retail.v2.Product]. Only populated for [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] [Product][google.cloud.retail.v2.Product]s.

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

Type

google.cloud.retail_v2.types.PriceInfo.PriceRange

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

Bases: proto.message.Message

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

price

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

Type

google.cloud.retail_v2.types.Interval

original_price

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

Type

google.cloud.retail_v2.types.Interval

class google.cloud.retail_v2.types.Product(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

expire_time

The timestamp when this product becomes unavailable for [SearchService.Search][google.cloud.retail.v2.SearchService.Search].

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

Google Merchant Center property expiration_date.

Type

google.protobuf.timestamp_pb2.Timestamp

ttl

Input only. The TTL (time to live) of the product.

If it is set, [expire_time][google.cloud.retail.v2.Product.expire_time] is set as current timestamp plus [ttl][google.cloud.retail.v2.Product.ttl]. The derived [expire_time][google.cloud.retail.v2.Product.expire_time] is returned in the output and [ttl][google.cloud.retail.v2.Product.ttl] is left blank when retrieving the [Product][google.cloud.retail.v2.Product].

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

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.

The branch ID must be “default_branch”.

Type

str

id

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

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.v2.ProductLevelConfig.ingestion_product_type] if unset.

Type

google.cloud.retail_v2.types.Product.Type

primary_product_id

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

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

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

Google Merchant Center Property item_group_id. Schema.org Property Product.inProductGroupWithID.

This field must be enabled before it can be used. Learn more.

Type

str

collection_member_ids

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

Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return.

Type

Sequence[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.

Google Merchant Center property gtin. Schema.org property Product.isbn or Product.gtin8 or Product.gtin12 or 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, please 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.v2.Product.Type.PRIMARY] [Product][google.cloud.retail.v2.Product] otherwise an INVALID_ARGUMENT error is returned.

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

Google Merchant Center property google_product_category. Schema.org property [Product.category] (https://schema.org/category).

Type

Sequence[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.

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. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

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

Type

Sequence[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.

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][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].

For product prediction, this field is ignored and the model automatically detects the text language. The [Product][google.cloud.retail.v2.Product] can include text in different languages, but duplicating [Product][google.cloud.retail.v2.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.

Type

Sequence[google.cloud.retail_v2.types.Product.AttributesEntry]

tags

Custom tags associated with the product.

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

Google Merchant Center property custom_label_0–4.

Type

Sequence[str]

price_info

Product price and cost information.

Google Merchant Center property price.

Type

google.cloud.retail_v2.types.PriceInfo

rating

The rating of this product.

Type

google.cloud.retail_v2.types.Rating

available_time

The timestamp when this [Product][google.cloud.retail.v2.Product] becomes available for [SearchService.Search][google.cloud.retail.v2.SearchService.Search].

Type

google.protobuf.timestamp_pb2.Timestamp

availability

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

Google Merchant Center Property availability. Schema.org Property Offer.availability.

Type

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

Type

Sequence[google.cloud.retail_v2.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.

Google Merchant Center property link. Schema.org property Offer.url.

Type

str

images

Product images for the product.Highly recommended to put the main image to the first.

A maximum of 300 images are allowed.

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

Type

Sequence[google.cloud.retail_v2.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_v2.types.Audience

color_info

The color of the product.

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

Type

google.cloud.retail_v2.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.v2.Product]. 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 size, size_type and size_system. Schema.org property Product.size.

Type

Sequence[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 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

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

Type

Sequence[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.v2.Product]. 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 pattern. Schema.org property Product.pattern.

Type

Sequence[str]

conditions

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

A maximum of 5 values are allowed per [Product][google.cloud.retail.v2.Product]. 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 condition. Schema.org property Offer.itemCondition.

Type

Sequence[str]

promotions

The promotions applied to the product. A maximum of 10 values are allowed per [Product][google.cloud.retail.v2.Product].

Type

Sequence[google.cloud.retail_v2.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.v2.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.v2.Product]s are returned in [SearchResponse][google.cloud.retail.v2.SearchResponse].

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

To mark [attributes][google.cloud.retail.v2.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.v2.Product.attributes].

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

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

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

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

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

Maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned.

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

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.v2.Product.primary_product_id] for all the product variants. Only populated for [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] [Product][google.cloud.retail.v2.Product]s.

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

Type

Sequence[google.cloud.retail_v2.types.Product]

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

Bases: proto.message.Message

class Availability(value)[source]

Bases: proto.enums.Enum

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

AVAILABILITY_UNSPECIFIED = 0
BACKORDER = 4
IN_STOCK = 1
OUT_OF_STOCK = 2
PREORDER = 3
class Type(value)[source]

Bases: proto.enums.Enum

The type of this product.

COLLECTION = 3
PRIMARY = 1
TYPE_UNSPECIFIED = 0
VARIANT = 2
class google.cloud.retail_v2.types.ProductDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Detailed product information associated with a user event.

product

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

Required field(s):

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

Optional override field(s):

  • [Product.price_info][google.cloud.retail.v2.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_v2.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_v2.types.ProductInlineSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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.v2.Product.id]. Recommended max of 100 items.

Type

Sequence[google.cloud.retail_v2.types.Product]

class google.cloud.retail_v2.types.ProductInputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The input config source for products.

product_inline_source

The Inline source for the input content for products.

Type

google.cloud.retail_v2.types.ProductInlineSource

gcs_source

Google Cloud Storage location for the input content.

Type

google.cloud.retail_v2.types.GcsSource

big_query_source

BigQuery input source.

Type

google.cloud.retail_v2.types.BigQuerySource

class google.cloud.retail_v2.types.ProductLevelConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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.v2.Product]s allowed to be ingested into the catalog. Acceptable values are:

  • primary (default): You can only ingest [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] [Product][google.cloud.retail.v2.Product]s. This means [Product.primary_product_id][google.cloud.retail.v2.Product.primary_product_id] can only be empty or set to the same value as [Product.id][google.cloud.retail.v2.Product.id].

  • variant: You can only ingest [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s. This means [Product.primary_product_id][google.cloud.retail.v2.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.v2.ProductLevelConfig.merchant_center_product_id_field] is itemGroupId, an INVALID_ARGUMENT error is returned.

See Using 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.v2.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.v2.ProductLevelConfig.ingestion_product_type] is variant, an INVALID_ARGUMENT error is returned.

See Using product levels for more details.

Type

str

class google.cloud.retail_v2.types.Promotion(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Promotion information.

promotion_id

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

The value 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.

Google Merchant Center property promotion.

Type

str

class google.cloud.retail_v2.types.PurchaseTransaction(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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.v2.PurchaseTransaction.revenue] - [tax][google.cloud.retail.v2.PurchaseTransaction.tax] - [cost][google.cloud.retail.v2.PurchaseTransaction.cost]

Type

float

currency_code

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

Type

str

class google.cloud.retail_v2.types.PurgeMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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_v2.types.PurgeUserEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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.v2.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_v2.types.PurgeUserEventsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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_v2.types.Rating(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

rating_count

The total number of ratings. This value is independent of the value of [rating_histogram][google.cloud.retail.v2.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.v2.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.v2.Product] got 41 ratings with 1 star, 14 ratings with 2 star, and so on.

Type

Sequence[int]

class google.cloud.retail_v2.types.RejoinUserEventsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metadata for RejoinUserEvents method.

class google.cloud.retail_v2.types.RejoinUserEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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_v2.types.RejoinUserEventsRequest.UserEventRejoinScope

class UserEventRejoinScope(value)[source]

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.

JOINED_EVENTS = 1
UNJOINED_EVENTS = 2
USER_EVENT_REJOIN_SCOPE_UNSPECIFIED = 0
class google.cloud.retail_v2.types.RejoinUserEventsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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_v2.types.RemoveFulfillmentPlacesMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

class google.cloud.retail_v2.types.RemoveFulfillmentPlacesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [RemoveFulfillmentPlaces][] method.

product

Required. Full resource name of [Product][google.cloud.retail.v2.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.v2.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][].

Type

str

place_ids

Required. The IDs for this [type][google.cloud.retail.v2.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.v2.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

Sequence[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.v2.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.v2.Product] is created. If set to false, an INVALID_ARGUMENT error is returned if the [Product][google.cloud.retail.v2.Product] is not found.

Type

bool

class google.cloud.retail_v2.types.RemoveFulfillmentPlacesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the [RemoveFulfillmentPlaces][] method.

class google.cloud.retail_v2.types.SearchRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

placement

Required. The resource name of the search engine placement, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search. This field is used to identify the set of models that will be used to make the search.

We currently support one placement with the following ID:

  • default_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.

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.

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_v2.types.UserInfo

page_size

Maximum number of [Product][google.cloud.retail.v2.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.v2.SearchResponse.next_page_token], received from a previous [SearchService.Search][google.cloud.retail.v2.SearchService.Search] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [SearchService.Search][google.cloud.retail.v2.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.v2.Product]s deemed by the API as relevant) in search results. This field is only considered if [page_token][google.cloud.retail.v2.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.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Type

str

canonical_filter

The filter applied to every search request when quality improvement such as query expansion is needed. For example, if a query does not have enough results, an expanded query with [SearchRequest.canonical_filter][google.cloud.retail.v2.SearchRequest.canonical_filter] will be returned as a supplement of the original query. This field is strongly recommended to achieve high search quality.

See [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter] for more details about filter syntax.

Type

str

order_by

The order in which products are returned. Products can be ordered by a field in an [Product][google.cloud.retail.v2.Product] object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive.

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 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

Type

Sequence[google.cloud.retail_v2.types.SearchRequest.FacetSpec]

dynamic_facet_spec

The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated. This feature requires additional allowlisting. Contact Retail Search support team if you are interested in using dynamic facet feature.

Type

google.cloud.retail_v2.types.SearchRequest.DynamicFacetSpec

boost_spec

Boost specification to boost certain products.

Type

google.cloud.retail_v2.types.SearchRequest.BoostSpec

query_expansion_spec

The query expansion specification that specifies the conditions under which query expansion will occur.

Type

google.cloud.retail_v2.types.SearchRequest.QueryExpansionSpec

variant_rollup_keys

The keys to fetch and rollup the matching [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s attributes. The attributes from all the matching [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s are merged and de-duplicated. Notice that rollup [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s attributes will lead to extra query latency. Maximum number of keys is 10.

For [FulfillmentInfo][google.cloud.retail.v2.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

  • attributes.key, where key is any key in the [Product.attributes][google.cloud.retail.v2.Product.attributes] map.

  • pickupInStore.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] “pickup-in-store”.

  • shipToStore.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] “ship-to-store”.

  • sameDayDelivery.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] “same-day-delivery”.

  • nextDayDelivery.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] “next-day-delivery”.

  • customFulfillment1.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] “custom-type-1”.

  • customFulfillment2.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] “custom-type-2”.

  • customFulfillment3.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] “custom-type-3”.

  • customFulfillment4.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] “custom-type-4”.

  • customFulfillment5.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type] “custom-type-5”.

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

Type

Sequence[str]

page_categories

The categories associated with a category page. Required for category navigation queries to achieve good search quality. The format should be the same as [UserEvent.page_categories][google.cloud.retail.v2.UserEvent.page_categories];

To represent full path of category, use ‘>’ sign to separate different hierarchies. If ‘>’ is part of the category name, please 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

Sequence[str]

class BoostSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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

Type

Sequence[google.cloud.retail_v2.types.SearchRequest.BoostSpec.ConditionBoostSpec]

class ConditionBoostSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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.v2.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 DynamicFacetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The specifications of dynamically generated facets.

mode

Mode of the DynamicFacet feature. Defaults to [Mode.DISABLED][google.cloud.retail.v2.SearchRequest.DynamicFacetSpec.Mode.DISABLED] if it’s unset.

Type

google.cloud.retail_v2.types.SearchRequest.DynamicFacetSpec.Mode

class Mode(value)[source]

Bases: proto.enums.Enum

Enum to control DynamicFacet mode

DISABLED = 1
ENABLED = 2
MODE_UNSPECIFIED = 0
class FacetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A facet specification to perform faceted search.

facet_key

Required. The facet key specification.

Type

google.cloud.retail_v2.types.SearchRequest.FacetSpec.FacetKey

limit

Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. 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.v2.SearchRequest.FacetSpec.FacetKey.key] is not excluded from the filter unless it is listed in this field.

For example, suppose there are 100 products with color facet “Red” and 200 products with color facet “Blue”. A query containing the filter “colorFamilies:ANY(“Red”)” and have “colorFamilies” as [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key] will by default return the “Red” with count 100.

If this field contains “colorFamilies”, then the query returns both the “Red” with count 100 and “Blue” with count 200, because the “colorFamilies” key is now excluded from the filter.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

Type

Sequence[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 will be ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be 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 will be 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 will generate 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” will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.

Type

bool

class FacetKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Specifies how a facet is computed.

key

Required. Supported textual and numerical facet keys in [Product][google.cloud.retail.v2.Product] object, over which the facet values are computed. Facet key is case-sensitive.

Allowed facet keys when [FacetKey.query][google.cloud.retail.v2.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”

  • numerical_field =

    • “price”

    • “discount”

    • “rating”

    • “ratingCount”

    • “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 30.

Type

Sequence[google.cloud.retail_v2.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 textual fields and fulfillments. Maximum is 20.

Must be set for the fulfillment facet keys:

  • pickupInStore

  • shipToStore

  • sameDayDelivery

  • nextDayDelivery

  • customFulfillment1

  • customFulfillment2

  • customFulfillment3

  • customFulfillment4

  • customFulfillment5

Type

Sequence[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 will give only “Women > Shoe” and “Women > Dress”. Only supported on textual fields. Maximum is 10.

Type

Sequence[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 will give only “Women > Shoe” and “Men > Shoe”. Only supported on textual fields. Maximum is 10.

Type

Sequence[str]

order_by

The order in which [Facet.values][] are returned.

Allowed values are:

  • “count desc”, which means order by [Facet.FacetValue.count][] descending.

  • “value desc”, which means order by [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.v2.SearchRequest.FacetSpec.FacetKey.intervals]; [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] are sorted in the order given by [FacetSpec.FacetKey.restricted_values][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.restricted_values].

Type

str

query

The query that is used to compute facet for the given facet key. When provided, it will override the default behavior of facet computation. The query syntax is the same as a filter expression. See [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter] for detail syntax and limitations. Notice that there is no limitation on [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key] when query is specified.

In the response, [FacetValue.value][] will be always “1” and [FacetValue.count][] will be the number of results that matches the query.

For example, you can set a customized facet for “shipToStore”, where [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key] is “customizedShipToStore”, and [FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query] is “availability: ANY(“IN_STOCK”) AND shipToStore: ANY(“123”)”. Then the facet will count the products that are both in stock and ship to store “123”.

Type

str

class QueryExpansionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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.v2.SearchRequest.QueryExpansionSpec.Condition.DISABLED].

Type

google.cloud.retail_v2.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)[source]

Bases: proto.enums.Enum

Enum describing under which condition query expansion should occur.

AUTO = 3
CONDITION_UNSPECIFIED = 0
DISABLED = 1
class google.cloud.retail_v2.types.SearchResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [SearchService.Search][google.cloud.retail.v2.SearchService.Search] method.

results

A list of matched items. The order represents the ranking.

Type

Sequence[google.cloud.retail_v2.types.SearchResponse.SearchResult]

facets

Results of facets requested by user.

Type

Sequence[google.cloud.retail_v2.types.SearchResponse.Facet]

total_size

The estimated total count of matched items irrespective of pagination. The count of [results][google.cloud.retail.v2.SearchResponse.results] returned by pagination may be less than the [total_size][google.cloud.retail.v2.SearchResponse.total_size] that matches.

Type

int

corrected_query

If spell correction applies, the corrected query. Otherwise, empty.

Type

str

attribution_token

A unique search token. This should be included in the [UserEvent][google.cloud.retail.v2.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.v2.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_v2.types.SearchResponse.QueryExpansionInfo

redirect_uri

The URI of a customer-defined redirect page. If redirect action is triggered, no search will be performed, and only [redirect_uri][google.cloud.retail.v2.SearchResponse.redirect_uri] and [attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token] will be set in the response.

Type

str

class Facet(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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

Sequence[google.cloud.retail_v2.types.SearchResponse.Facet.FacetValue]

dynamic_facet

Whether the facet is dynamically generated.

Type

bool

class FacetValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A facet value which contains value names and their count.

value

Text value of a facet, such as “Black” for facet “colorFamilies”.

Type

str

interval

Interval value for a facet, such as [10, 20) for facet “price”.

Type

google.cloud.retail_v2.types.Interval

count

Number of items that have this facet value.

Type

int

class QueryExpansionInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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.query_expansion_spec.pin_unexpanded_results][] is set to true.

Type

int

class SearchResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the search results.

id

[Product.id][google.cloud.retail.v2.Product.id] of the searched [Product][google.cloud.retail.v2.Product].

Type

str

product

The product data snippet in the search response. Only [Product.name][google.cloud.retail.v2.Product.name] is guaranteed to be populated.

[Product.variants][google.cloud.retail.v2.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.v2.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_v2.types.Product

matching_variant_count

The count of matched [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s.

Type

int

matching_variant_fields

If a [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2.Product] fields are matched. The key is the [Product.name][google.cloud.retail.v2.Product.name], the value is a field mask of the matched [Product][google.cloud.retail.v2.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.v2.ColorInfo] and the query.

Type

Sequence[google.cloud.retail_v2.types.SearchResponse.SearchResult.MatchingVariantFieldsEntry]

variant_rollup_values

The rollup matching [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product] attributes. The key is one of the [SearchRequest.variant_rollup_keys][google.cloud.retail.v2.SearchRequest.variant_rollup_keys]. The values are the merged and de-duplicated [Product][google.cloud.retail.v2.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.v2.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

Sequence[google.cloud.retail_v2.types.SearchResponse.SearchResult.VariantRollupValuesEntry]

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

property raw_page
class google.cloud.retail_v2.types.SetDefaultBranchRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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.

Type

str

note

Some note on this request, this can be retrieved by [CatalogService.GetDefaultBranch][google.cloud.retail.v2.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

class google.cloud.retail_v2.types.SetInventoryMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the [SetInventory][] method.

class google.cloud.retail_v2.types.SetInventoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [SetInventory][] method.

inventory

Required. The inventory information to update. The allowable fields to update are:

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

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

  • [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]

  • [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info] The updated inventory fields must be specified in [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask].

If [SetInventoryRequest.inventory.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.v2.Product] named in [Product.name][google.cloud.retail.v2.Product.name], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [Product][google.cloud.retail.v2.Product] to update does not have existing inventory information, the provided inventory information will be inserted.

If the [Product][google.cloud.retail.v2.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.v2.SetInventoryRequest.set_time].

The last update time is recorded for the following inventory fields:

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

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

  • [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]

  • [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]

If a full overwrite of inventory information while ignoring timestamps is needed, [UpdateProduct][] should be invoked instead.

Type

google.cloud.retail_v2.types.Product

set_mask

Indicates which inventory fields in the provided [Product][google.cloud.retail.v2.Product] to update. If 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

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.v2.Product] with name [Product.name][google.cloud.retail.v2.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.v2.Product] is created. If set to false, an INVALID_ARGUMENT error is returned if the [Product][google.cloud.retail.v2.Product] is not found.

Type

bool

class google.cloud.retail_v2.types.SetInventoryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the [SetInventory][] method.

class google.cloud.retail_v2.types.UpdateCatalogRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for [CatalogService.UpdateCatalog][google.cloud.retail.v2.CatalogService.UpdateCatalog] method.

catalog

Required. The [Catalog][google.cloud.retail.v2.Catalog] to update.

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

If the [Catalog][google.cloud.retail.v2.Catalog] to update does not exist, a NOT_FOUND error is returned.

Type

google.cloud.retail_v2.types.Catalog

update_mask

Indicates which fields in the provided [Catalog][google.cloud.retail.v2.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_v2.types.UpdateProductRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [UpdateProduct][] method.

product

Required. The product to update/create.

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

If the [Product][google.cloud.retail.v2.Product] to update does not exist and [allow_missing][google.cloud.retail.v2.UpdateProductRequest.allow_missing] is not set, a NOT_FOUND error is returned.

Type

google.cloud.retail_v2.types.Product

update_mask

Indicates which fields in the provided [Product][google.cloud.retail.v2.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.

Type

google.protobuf.field_mask_pb2.FieldMask

allow_missing

If set to true, and the [Product][google.cloud.retail.v2.Product] is not found, a new [Product][google.cloud.retail.v2.Product] will be created. In this situation, update_mask is ignored.

Type

bool

class google.cloud.retail_v2.types.UserEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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.

  • category-page-view: Special pages such as sale or promotion pages viewed.

  • completion: Completion query result showed/clicked.

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

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 Analystics 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.v2.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

Sequence[str]

attribution_token

Highly recommended for user events that are the result of [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict]. This field enables accurate attribution of recommendation model performance.

The value must be a valid [PredictResponse.attribution_token][google.cloud.retail.v2.PredictResponse.attribution_token] for user events that are the result of [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict]. The value must be a valid [SearchResponse.attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token] for user events that are the result of [SearchService.Search][google.cloud.retail.v2.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.v2.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.v2.PredictResponse.attribution_token] to this field.

Type

str

product_details

The main product details related to the event.

This field is required 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 broswing 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.v2.UserEvent.product_details] is desired. The end user may have not finished broswing the whole page yet.

Type

Sequence[google.cloud.retail_v2.types.ProductDetail]

completion_detail

The main completion details related to the event.

In a completion event, this field represents the completions returned to the end user and the clicked completion by the end user. In a search event, it represents the search event happens after clicking completion.

Type

google.cloud.retail_v2.types.CompletionDetail

attributes

Extra user event features to include in the recommendation model.

The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.

Type

Sequence[google.cloud.retail_v2.types.UserEvent.AttributesEntry]

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_v2.types.PurchaseTransaction

search_query

The user’s search query.

See [SearchRequest.query][google.cloud.retail.v2.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.v2.UserEvent.search_query] or [page_categories][google.cloud.retail.v2.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.v2.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.v2.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.v2.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, please 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.v2.UserEvent.search_query] or [page_categories][google.cloud.retail.v2.UserEvent.page_categories] is required for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

Type

Sequence[str]

user_info

User information.

Type

google.cloud.retail_v2.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

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

Bases: proto.message.Message

class google.cloud.retail_v2.types.UserEventImportSummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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_v2.types.UserEventInlineSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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

Sequence[google.cloud.retail_v2.types.UserEvent]

class google.cloud.retail_v2.types.UserEventInputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The input config source for user events.

user_event_inline_source

Required. The Inline source for the input content for UserEvents.

Type

google.cloud.retail_v2.types.UserEventInlineSource

gcs_source

Required. Google Cloud Storage location for the input content.

Type

google.cloud.retail_v2.types.GcsSource

big_query_source

Required. BigQuery input source.

Type

google.cloud.retail_v2.types.BigQuerySource

class google.cloud.retail_v2.types.UserInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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.

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. Required for getting [SearchResponse.sponsored_results][google.cloud.retail.v2.SearchResponse.sponsored_results]. 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 using the JavaScript tag in [UserEventService.CollectUserEvent][google.cloud.retail.v2.UserEventService.CollectUserEvent] or if [direct_user_request][google.cloud.retail.v2.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.v2.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.v2.UserEventService.CollectUserEvent] or if [direct_user_request][google.cloud.retail.v2.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.v2.UserInfo.ip_address] and [user_agent][google.cloud.retail.v2.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.v2.UserEventService.CollectUserEvent].

Type

bool

class google.cloud.retail_v2.types.WriteUserEventRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

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_v2.types.UserEvent