Package Classes (1.21.2)

Summary of entries of Classes for retail.

Classes

AnalyticsServiceAsyncClient

Service for managing & accessing retail search business metric. Retail recommendation business metric is currently not available.

AnalyticsServiceClient

Service for managing & accessing retail search business metric. Retail recommendation business metric is currently not available.

CatalogServiceAsyncClient

Service for managing catalog configuration.

CatalogServiceClient

Service for managing catalog configuration.

ListCatalogsAsyncPager

A pager for iterating through list_catalogs requests.

This class thinly wraps an initial ListCatalogsResponse object, and provides an __aiter__ method to iterate through its catalogs field.

If there are more pages, the __aiter__ method will make additional ListCatalogs requests and continue to iterate through the catalogs field on the corresponding responses.

All the usual ListCatalogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCatalogsPager

A pager for iterating through list_catalogs requests.

This class thinly wraps an initial ListCatalogsResponse object, and provides an __iter__ method to iterate through its catalogs field.

If there are more pages, the __iter__ method will make additional ListCatalogs requests and continue to iterate through the catalogs field on the corresponding responses.

All the usual ListCatalogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

CompletionServiceAsyncClient

Autocomplete service for retail.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

CompletionServiceClient

Autocomplete service for retail.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

ListControlsAsyncPager

A pager for iterating through list_controls requests.

This class thinly wraps an initial ListControlsResponse object, and provides an __aiter__ method to iterate through its controls field.

If there are more pages, the __aiter__ method will make additional ListControls requests and continue to iterate through the controls field on the corresponding responses.

All the usual ListControlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListControlsPager

A pager for iterating through list_controls requests.

This class thinly wraps an initial ListControlsResponse object, and provides an __iter__ method to iterate through its controls field.

If there are more pages, the __iter__ method will make additional ListControls requests and continue to iterate through the controls field on the corresponding responses.

All the usual ListControlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Service for performing CRUD operations on models. Recommendation models contain all the metadata necessary to generate a set of models for the Predict() API. A model is queried indirectly via a ServingConfig, which associates a model with a given Placement (e.g. Frequently Bought Together on Home Page).

This service allows you to do the following:

Initiate training of a model.
Pause training of an existing model.
List all the available models along with their metadata.
Control their tuning schedule.

ModelServiceClient

This service allows you to do the following:

Initiate training of a model.
Pause training of an existing model.
List all the available models along with their metadata.
Control their tuning schedule.

ListModelsAsyncPager

A pager for iterating through list_models requests.

This class thinly wraps an initial ListModelsResponse object, and provides an __aiter__ method to iterate through its models field.

If there are more pages, the __aiter__ method will make additional ListModels requests and continue to iterate through the models field on the corresponding responses.

All the usual ListModelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListModelsPager

A pager for iterating through list_models requests.

This class thinly wraps an initial ListModelsResponse object, and provides an __iter__ method to iterate through its models field.

If there are more pages, the __iter__ method will make additional ListModels requests and continue to iterate through the models field on the corresponding responses.

All the usual ListModelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

PredictionServiceAsyncClient

Service for making recommendation prediction.

PredictionServiceClient

Service for making recommendation prediction.

ProductServiceAsyncClient

Service for ingesting Product information of the customer's website.

ProductServiceClient

Service for ingesting Product information of the customer's website.

ListProductsAsyncPager

A pager for iterating through list_products requests.

This class thinly wraps an initial ListProductsResponse object, and provides an __aiter__ method to iterate through its products field.

If there are more pages, the __aiter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListProductsPager

A pager for iterating through list_products requests.

This class thinly wraps an initial ListProductsResponse object, and provides an __iter__ method to iterate through its products field.

If there are more pages, the __iter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchServiceAsyncClient

Service for search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

SearchServiceClient

Service for search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

SearchAsyncPager

A pager for iterating through search requests.

This class thinly wraps an initial SearchResponse object, and provides an __aiter__ method to iterate through its results field.

If there are more pages, the __aiter__ method will make additional Search requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchPager

A pager for iterating through search requests.

This class thinly wraps an initial SearchResponse object, and provides an __iter__ method to iterate through its results field.

If there are more pages, the __iter__ method will make additional Search requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ServingConfigServiceAsyncClient

Service for modifying ServingConfig.

ServingConfigServiceClient

Service for modifying ServingConfig.

ListServingConfigsAsyncPager

A pager for iterating through list_serving_configs requests.

This class thinly wraps an initial ListServingConfigsResponse object, and provides an __aiter__ method to iterate through its serving_configs field.

If there are more pages, the __aiter__ method will make additional ListServingConfigs requests and continue to iterate through the serving_configs field on the corresponding responses.

All the usual ListServingConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListServingConfigsPager

A pager for iterating through list_serving_configs requests.

This class thinly wraps an initial ListServingConfigsResponse object, and provides an __iter__ method to iterate through its serving_configs field.

If there are more pages, the __iter__ method will make additional ListServingConfigs requests and continue to iterate through the serving_configs field on the corresponding responses.

All the usual ListServingConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

UserEventServiceAsyncClient

Service for ingesting end user actions on the customer website.

UserEventServiceClient

Service for ingesting end user actions on the customer website.

AddCatalogAttributeRequest

Request for CatalogService.AddCatalogAttribute method.

AddControlRequest

Request for AddControl method.

AddFulfillmentPlacesMetadata

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

AddFulfillmentPlacesRequest

Request message for ProductService.AddFulfillmentPlaces method.

AddFulfillmentPlacesResponse

Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces method.

AddLocalInventoriesMetadata

Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddLocalInventories method.

AddLocalInventoriesRequest

Request message for ProductService.AddLocalInventories method.

AddLocalInventoriesResponse

Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method.

AttributeConfigLevel

At which level we offer configuration for attributes.

AttributesConfig

Catalog level attribute config.

CatalogAttributesEntry

The abstract base class for a message.

Audience

An intended audience of the Product for whom it's sold.

BigQueryOutputResult

A BigQuery output result.

BigQuerySource

BigQuery source import data from.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Catalog

The catalog configuration.

CatalogAttribute

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

AttributeType

The type of an attribute.

    Used when type cannot be derived from attribute that is not
    <xref uid="google.cloud.retail.v2.CatalogAttribute.in_use">in_use</xref>.
TEXTUAL (1):
    Textual attribute.
NUMERICAL (2):
    Numerical attribute.

DynamicFacetableOption

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

ExactSearchableOption

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

FacetConfig

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

IgnoredFacetValues

Facet values to ignore on facets during the specified time range for the given SearchResponse.Facet.key attribute.

MergedFacet

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

MergedFacetValue

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

RerankConfig

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

IndexableOption

The status of the indexable option of a catalog attribute.

RetrievableOption

The status of the retrievable option of a catalog attribute.

SearchableOption

The status of the searchable option of a catalog attribute.

CollectUserEventRequest

Request message for CollectUserEvent method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ColorInfo

The color information of a Product.

CompleteQueryRequest

Autocomplete parameters.

CompleteQueryResponse

Response of the autocomplete query.

CompletionResult

Resource that represents completion results.

AttributesEntry

The abstract base class for a message.

RecentSearchResult

Deprecated: Recent search of this user.

CompletionConfig

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

CompletionDataInputConfig

The input config source for completion data.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CompletionDetail

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

Condition

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

QueryTerm

Query terms that we want to match on.

TimeRange

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

Control

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CreateControlRequest

Request for CreateControl method.

CreateModelMetadata

Metadata associated with a create operation.

CreateModelRequest

Request for creating a model.

CreateProductRequest

Request message for ProductService.CreateProduct method.

CreateServingConfigRequest

Request for CreateServingConfig method.

CustomAttribute

A custom attribute that is not explicitly modeled in Product.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeleteControlRequest

Request for DeleteControl method.

DeleteModelRequest

Request for deleting a model.

DeleteProductRequest

Request message for ProductService.DeleteProduct method.

DeleteServingConfigRequest

Request for DeleteServingConfig method.

ExperimentInfo

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ServingConfigExperiment

Metadata for active serving config A/B tests.

ExportAnalyticsMetricsRequest

Request message for the ExportAnalyticsMetrics method.

ExportAnalyticsMetricsResponse

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

ExportErrorsConfig

Configuration of destination for Export related errors.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExportMetadata

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

FulfillmentInfo

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

GcsOutputResult

A Gcs output result.

GcsSource

Google Cloud Storage location for input content.

GetAttributesConfigRequest

Request for CatalogService.GetAttributesConfig method.

GetCompletionConfigRequest

Request for CatalogService.GetCompletionConfig method.

GetControlRequest

Request for GetControl method.

GetDefaultBranchRequest

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

GetDefaultBranchResponse

Response message of CatalogService.GetDefaultBranch.

GetModelRequest

Request for getting a model.

GetProductRequest

Request message for ProductService.GetProduct method.

GetServingConfigRequest

Request for GetServingConfig method.

Image

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

ImportCompletionDataRequest

Request message for ImportCompletionData methods.

ImportCompletionDataResponse

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

ImportErrorsConfig

Configuration of destination for Import related errors.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportMetadata

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

ImportProductsRequest

Request message for Import methods.

ReconciliationMode

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

ImportProductsResponse

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

ImportUserEventsRequest

Request message for the ImportUserEvents request.

ImportUserEventsResponse

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

Interval

A floating point interval.

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ListCatalogsRequest

Request for CatalogService.ListCatalogs method.

ListCatalogsResponse

Response for CatalogService.ListCatalogs method.

ListControlsRequest

Request for ListControls method.

ListControlsResponse

Response for ListControls method.

ListModelsRequest

Request for listing models associated with a resource.

ListModelsResponse

Response to a ListModelRequest.

ListProductsRequest

Request message for ProductService.ListProducts method.

ListProductsResponse

Response message for ProductService.ListProducts method.

ListServingConfigsRequest

Request for ListServingConfigs method.

ListServingConfigsResponse

Response for ListServingConfigs method.

LocalInventory

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

AttributesEntry

The abstract base class for a message.

Model

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

ContextProductsType

Use single or multiple context products for recommendations.

DataState

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

FrequentlyBoughtTogetherFeaturesConfig

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

ModelFeaturesConfig

Additional model features config.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PeriodicTuningState

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

ServingConfigList

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

ServingState

The serving state of the model.

TrainingState

The training state of the model.

OutputConfig

The output configuration setting.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BigQueryDestination

The BigQuery output destination configuration.

GcsDestination

The Google Cloud Storage output destination configuration.

OutputResult

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

PauseModelRequest

Request for pausing training of a model.

PredictRequest

Request message for Predict method.

LabelsEntry

The abstract base class for a message.

ParamsEntry

The abstract base class for a message.

PredictResponse

Response message for predict method.

PredictionResult

PredictionResult represents the recommendation prediction results.

MetadataEntry

The abstract base class for a message.

PriceInfo

The price information of a Product.

PriceRange

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

Product

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AttributesEntry

The abstract base class for a message.

Availability

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

Type

The type of this product.

    As the primary unit for predicting, indexing and search
    serving, a
    <xref uid="google.cloud.retail.v2.Product.Type.PRIMARY">Type.PRIMARY</xref>
    <xref uid="google.cloud.retail.v2.Product">Product</xref> is grouped with
    multiple
    <xref uid="google.cloud.retail.v2.Product.Type.VARIANT">Type.VARIANT</xref>
    <xref uid="google.cloud.retail.v2.Product">Product</xref>s.
VARIANT (2):
    The variant type.

    <xref uid="google.cloud.retail.v2.Product.Type.VARIANT">Type.VARIANT</xref>
    <xref uid="google.cloud.retail.v2.Product">Product</xref>s usually share
    some common attributes on the same
    <xref uid="google.cloud.retail.v2.Product.Type.PRIMARY">Type.PRIMARY</xref>
    <xref uid="google.cloud.retail.v2.Product">Product</xref>s, but they have
    variant attributes like different colors, sizes and prices,
    etc.
COLLECTION (3):
    The collection type. Collection products are bundled
    <xref uid="google.cloud.retail.v2.Product.Type.PRIMARY">Type.PRIMARY</xref>
    <xref uid="google.cloud.retail.v2.Product">Product</xref>s or
    <xref uid="google.cloud.retail.v2.Product.Type.VARIANT">Type.VARIANT</xref>
    <xref uid="google.cloud.retail.v2.Product">Product</xref>s that are sold
    together, such as a jewelry set with necklaces, earrings and
    rings, etc.

ProductDetail

Detailed product information associated with a user event.

ProductInlineSource

The inline source for the input config for ImportProducts method.

ProductInputConfig

The input config source for products.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ProductLevelConfig

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

Promotion

Promotion information.

PurchaseTransaction

A transaction represents the entire purchase transaction.

PurgeMetadata

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

PurgeProductsMetadata

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

PurgeProductsRequest

Request message for PurgeProducts method.

PurgeProductsResponse

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

PurgeUserEventsRequest

Request message for PurgeUserEvents method.

PurgeUserEventsResponse

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

Rating

The rating of a Product.

RecommendationsFilteringOption

If filtering for recommendations is enabled.

RejoinUserEventsMetadata

Metadata for RejoinUserEvents method.

RejoinUserEventsRequest

Request message for RejoinUserEvents method.

UserEventRejoinScope

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.

RejoinUserEventsResponse

Response message for RejoinUserEvents method.

RemoveCatalogAttributeRequest

Request for CatalogService.RemoveCatalogAttribute method.

RemoveControlRequest

Request for RemoveControl method.

RemoveFulfillmentPlacesMetadata

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

RemoveFulfillmentPlacesRequest

Request message for ProductService.RemoveFulfillmentPlaces method.

RemoveFulfillmentPlacesResponse

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

RemoveLocalInventoriesMetadata

Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveLocalInventories method.

RemoveLocalInventoriesRequest

Request message for ProductService.RemoveLocalInventories method.

RemoveLocalInventoriesResponse

Response of the ProductService.RemoveLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.RemoveLocalInventories method.

ReplaceCatalogAttributeRequest

Request for CatalogService.ReplaceCatalogAttribute method.

ResumeModelRequest

Request for resuming training of a model.

Rule

A rule is a condition-action pair

A condition defines when a rule is to be triggered.
An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BoostAction

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

DoNotAssociateAction

Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".

FilterAction

Rule Condition:
- No Condition.query_terms provided is a global match.
- 1 or more Condition.query_terms provided are combined with OR operator.
Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict.
Action Result: Filters the returned objects to be ONLY those that passed the filter.

ForceReturnFacetAction

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

Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both.
Action Inputs: attribute name, position
Action Result: Will force return a facet key around a certain position or above if the condition is satisfied.

Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8.

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

FacetPositionAdjustment

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

IgnoreAction

Prevents a term in the query from being used in search. Example: Don't search for "shoddy".

OnewaySynonymsAction

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

RedirectAction

Redirects a shopper to a specific page.

Rule Condition: Must specify Condition.query_terms.
Action Input: Request Query
Action Result: Redirects shopper to provided uri.

RemoveFacetAction

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

Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both.
Action Input: attribute name
Action Result: Will remove the attribute (as a facet) from the request if it is present.

Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present).

ReplacementAction

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

TwowaySynonymsAction

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

"sneakers" will use a synonym of "shoes".
"shoes" will use a synonym of "sneakers".

SearchRequest

Request message for SearchService.Search method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BoostSpec

Boost specification to boost certain items.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ConditionBoostSpec

Boost applies to products which match a condition.

DynamicFacetSpec

The specifications of dynamically generated facets.

Mode

Enum to control DynamicFacet mode

FacetSpec

A facet specification to perform faceted search.

FacetKey

Specifies how a facet is computed.

LabelsEntry

The abstract base class for a message.

PersonalizationSpec

The specification for personalization.

Mode

The personalization mode of each search request.

QueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

Condition

Enum describing under which condition query expansion should occur.

SearchMode

The search mode of each search request.

    Only
    <xref uid="google.cloud.retail.v2.SearchResponse.SearchResult">SearchResponse.SearchResult</xref>
    will be returned.
    <xref uid="google.cloud.retail.v2.SearchResponse.Facet">SearchResponse.Facet</xref>
    will not be returned, even if
    <xref uid="google.cloud.retail.v2.SearchRequest.facet_specs">SearchRequest.facet_specs</xref>
    or
    <xref uid="google.cloud.retail.v2.SearchRequest.dynamic_facet_spec">SearchRequest.dynamic_facet_spec</xref>
    is set.
FACETED_SEARCH_ONLY (2):
    Only faceted search will be performed. The product search
    will be disabled.

    When in this mode, one or both of
    <xref uid="google.cloud.retail.v2.SearchRequest.facet_specs">SearchRequest.facet_specs</xref>
    and
    <xref uid="google.cloud.retail.v2.SearchRequest.dynamic_facet_spec">SearchRequest.dynamic_facet_spec</xref>
    should be set. Otherwise, an INVALID_ARGUMENT error is
    returned. Only
    <xref uid="google.cloud.retail.v2.SearchResponse.Facet">SearchResponse.Facet</xref>
    will be returned.
    <xref uid="google.cloud.retail.v2.SearchResponse.SearchResult">SearchResponse.SearchResult</xref>
    will not be returned.

SpellCorrectionSpec

The specification for query spell correction.

Mode

Enum describing under which mode spell correction should occur.

SearchResponse

Response message for SearchService.Search method.

A facet result.

FacetValue

A facet value which contains value names and their count.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

QueryExpansionInfo

Information describing query expansion including whether expansion has occurred.

SearchResult

Represents the search results.

MatchingVariantFieldsEntry

The abstract base class for a message.

VariantRollupValuesEntry

The abstract base class for a message.

SearchSolutionUseCase

The use case of Cloud Retail Search.

ServingConfig

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).

DiversityType

What type of diversity - data or rule based.

SetDefaultBranchRequest

Request message to set a specified branch as new default_branch.

SetInventoryMetadata

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

SetInventoryRequest

Request message for ProductService.SetInventory method.

SetInventoryResponse

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

SolutionType

The type of solution.

TuneModelMetadata

Metadata associated with a tune operation.

TuneModelRequest

Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).

TuneModelResponse

Response associated with a tune operation.

UpdateAttributesConfigRequest

Request for CatalogService.UpdateAttributesConfig method.

UpdateCatalogRequest

Request for CatalogService.UpdateCatalog method.

UpdateCompletionConfigRequest

Request for CatalogService.UpdateCompletionConfig method.

UpdateControlRequest

Request for UpdateControl method.

UpdateModelRequest

Request for updating an existing model.

UpdateProductRequest

Request message for ProductService.UpdateProduct method.

UpdateServingConfigRequest

Request for UpdateServingConfig method.

UserEvent

UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.

AttributesEntry

The abstract base class for a message.

UserEventImportSummary

A summary of import result. The UserEventImportSummary summarizes the import status for user events.

UserEventInlineSource

The inline source for the input config for ImportUserEvents method.

UserEventInputConfig

The input config source for user events.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

UserInfo

Information of an end user.

WriteUserEventRequest

Request message for WriteUserEvent method.

AnalyticsServiceAsyncClient

Service for managing & accessing retail search business metric. Retail recommendation business metric is currently not available.

AnalyticsServiceClient

Service for managing & accessing retail search business metric. Retail recommendation business metric is currently not available.

BranchServiceAsyncClient

Service for Branch Management

Branches are automatically created when a Catalog is created. There are fixed three branches in each catalog, and may use ListBranches method to get the details of all branches.

BranchServiceClient

Service for Branch Management

Branches are automatically created when a Catalog is created. There are fixed three branches in each catalog, and may use ListBranches method to get the details of all branches.

CatalogServiceAsyncClient

Service for managing catalog configuration.

CatalogServiceClient

Service for managing catalog configuration.

ListCatalogsAsyncPager

A pager for iterating through list_catalogs requests.

This class thinly wraps an initial ListCatalogsResponse object, and provides an __aiter__ method to iterate through its catalogs field.

If there are more pages, the __aiter__ method will make additional ListCatalogs requests and continue to iterate through the catalogs field on the corresponding responses.

All the usual ListCatalogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCatalogsPager

A pager for iterating through list_catalogs requests.

This class thinly wraps an initial ListCatalogsResponse object, and provides an __iter__ method to iterate through its catalogs field.

If there are more pages, the __iter__ method will make additional ListCatalogs requests and continue to iterate through the catalogs field on the corresponding responses.

All the usual ListCatalogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

CompletionServiceAsyncClient

Autocomplete service for retail.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

CompletionServiceClient

Autocomplete service for retail.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

ControlServiceAsyncClient

Service for modifying Control.

ControlServiceClient

Service for modifying Control.

ListControlsAsyncPager

A pager for iterating through list_controls requests.

This class thinly wraps an initial ListControlsResponse object, and provides an __aiter__ method to iterate through its controls field.

If there are more pages, the __aiter__ method will make additional ListControls requests and continue to iterate through the controls field on the corresponding responses.

All the usual ListControlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListControlsPager

A pager for iterating through list_controls requests.

This class thinly wraps an initial ListControlsResponse object, and provides an __iter__ method to iterate through its controls field.

If there are more pages, the __iter__ method will make additional ListControls requests and continue to iterate through the controls field on the corresponding responses.

All the usual ListControlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

MerchantCenterAccountLinkServiceAsyncClient

Merchant Center Link service to link a Branch to a Merchant Center Account.

MerchantCenterAccountLinkServiceClient

Merchant Center Link service to link a Branch to a Merchant Center Account.

ModelServiceAsyncClient

This service allows you to do the following:

Initiate training of a model.
Pause training of an existing model.
List all the available models along with their metadata.
Control their tuning schedule.

ModelServiceClient

This service allows you to do the following:

Initiate training of a model.
Pause training of an existing model.
List all the available models along with their metadata.
Control their tuning schedule.

ListModelsAsyncPager

A pager for iterating through list_models requests.

This class thinly wraps an initial ListModelsResponse object, and provides an __aiter__ method to iterate through its models field.

If there are more pages, the __aiter__ method will make additional ListModels requests and continue to iterate through the models field on the corresponding responses.

All the usual ListModelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListModelsPager

A pager for iterating through list_models requests.

This class thinly wraps an initial ListModelsResponse object, and provides an __iter__ method to iterate through its models field.

If there are more pages, the __iter__ method will make additional ListModels requests and continue to iterate through the models field on the corresponding responses.

All the usual ListModelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

PredictionServiceAsyncClient

Service for making recommendation prediction.

PredictionServiceClient

Service for making recommendation prediction.

ProductServiceAsyncClient

Service for ingesting Product information of the customer's website.

ProductServiceClient

Service for ingesting Product information of the customer's website.

ListProductsAsyncPager

A pager for iterating through list_products requests.

This class thinly wraps an initial ListProductsResponse object, and provides an __aiter__ method to iterate through its products field.

If there are more pages, the __aiter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListProductsPager

A pager for iterating through list_products requests.

This class thinly wraps an initial ListProductsResponse object, and provides an __iter__ method to iterate through its products field.

If there are more pages, the __iter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ProjectServiceAsyncClient

Service for settings at Project level.

ProjectServiceClient

Service for settings at Project level.

SearchServiceAsyncClient

Service for search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

SearchServiceClient

Service for search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

SearchAsyncPager

A pager for iterating through search requests.

This class thinly wraps an initial SearchResponse object, and provides an __aiter__ method to iterate through its results field.

If there are more pages, the __aiter__ method will make additional Search requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchPager

A pager for iterating through search requests.

This class thinly wraps an initial SearchResponse object, and provides an __iter__ method to iterate through its results field.

If there are more pages, the __iter__ method will make additional Search requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ServingConfigServiceAsyncClient

Service for modifying ServingConfig.

ServingConfigServiceClient

Service for modifying ServingConfig.

ListServingConfigsAsyncPager

A pager for iterating through list_serving_configs requests.

This class thinly wraps an initial ListServingConfigsResponse object, and provides an __aiter__ method to iterate through its serving_configs field.

If there are more pages, the __aiter__ method will make additional ListServingConfigs requests and continue to iterate through the serving_configs field on the corresponding responses.

All the usual ListServingConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListServingConfigsPager

A pager for iterating through list_serving_configs requests.

This class thinly wraps an initial ListServingConfigsResponse object, and provides an __iter__ method to iterate through its serving_configs field.

If there are more pages, the __iter__ method will make additional ListServingConfigs requests and continue to iterate through the serving_configs field on the corresponding responses.

All the usual ListServingConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

UserEventServiceAsyncClient

Service for ingesting end user actions on the customer website.

UserEventServiceClient

Service for ingesting end user actions on the customer website.

AcceptTermsRequest

Request for AcceptTerms method.

AddCatalogAttributeRequest

Request for CatalogService.AddCatalogAttribute method.

AddControlRequest

Request for AddControl method.

AddFulfillmentPlacesMetadata

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

AddFulfillmentPlacesRequest

Request message for ProductService.AddFulfillmentPlaces method.

AddFulfillmentPlacesResponse

Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces method.

AddLocalInventoriesMetadata

Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddLocalInventories method.

AddLocalInventoriesRequest

Request message for ProductService.AddLocalInventories method.

AddLocalInventoriesResponse

Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method.

AlertConfig

Project level alert config.

AlertPolicy

Alert policy for a customer.

EnrollStatus

The enrollment status enum for alert policy.

Recipient

Recipient contact information.

AttributeConfigLevel

At which level we offer configuration for attributes.

AttributesConfig

Catalog level attribute config.

CatalogAttributesEntry

The abstract base class for a message.

Audience

An intended audience of the Product for whom it's sold.

BatchRemoveCatalogAttributesRequest

Request for CatalogService.BatchRemoveCatalogAttributes method.

BatchRemoveCatalogAttributesResponse

Response of the CatalogService.BatchRemoveCatalogAttributes.

BigQueryOutputResult

A BigQuery output result.

BigQuerySource

BigQuery source import data from.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Branch

A data branch that stores Products.

ProductCountStatistic

A statistic about the number of products in a branch.

CountsEntry

The abstract base class for a message.

ProductCountScope

Scope of what products are included for this count.

QualityMetric

Metric measured on a group of Products against a certain quality requirement. Contains the number of products that pass the check and the number of products that don't.

BranchView

A view that specifies different level of fields of a Branch to show in responses.

Catalog

The catalog configuration.

CatalogAttribute

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

AttributeType

The type of an attribute.

    Used when type cannot be derived from attribute that is not
    <xref uid="google.cloud.retail.v2alpha.CatalogAttribute.in_use">in_use</xref>.
TEXTUAL (1):
    Textual attribute.
NUMERICAL (2):
    Numerical attribute.

DynamicFacetableOption

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

ExactSearchableOption

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

FacetConfig

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

IgnoredFacetValues

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

MergedFacet

MergedFacetValue

RerankConfig

IndexableOption

The status of the indexable option of a catalog attribute.

RetrievableOption

The status of the retrievable option of a catalog attribute.

SearchableOption

The status of the searchable option of a catalog attribute.

CollectUserEventRequest

Request message for CollectUserEvent method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ColorInfo

The color information of a Product.

CompleteQueryRequest

Autocomplete parameters.

CompleteQueryResponse

Response of the autocomplete query.

AttributeResult

Resource that represents attribute results.

AttributeResultsEntry

The abstract base class for a message.

CompletionResult

Resource that represents completion results.

AttributesEntry

The abstract base class for a message.

RecentSearchResult

Deprecated: Recent search of this user.

CompletionConfig

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

CompletionDataInputConfig

The input config source for completion data.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CompletionDetail

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

Condition

QueryTerm

Query terms that we want to match on.

TimeRange

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

Control

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CreateControlRequest

Request for CreateControl method.

CreateMerchantCenterAccountLinkMetadata

Common metadata related to the progress of the operations.

CreateMerchantCenterAccountLinkRequest

Request for MerchantCenterAccountLinkService.CreateMerchantCenterAccountLink method.

CreateModelMetadata

Metadata associated with a create operation.

CreateModelRequest

Request for creating a model.

CreateProductRequest

Request message for ProductService.CreateProduct method.

CreateServingConfigRequest

Request for CreateServingConfig method.

CustomAttribute

A custom attribute that is not explicitly modeled in Product.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeleteControlRequest

Request for DeleteControl method.

DeleteMerchantCenterAccountLinkRequest

Request for MerchantCenterAccountLinkService.DeleteMerchantCenterAccountLink method.

DeleteModelRequest

Request for deleting a model.

DeleteProductRequest

Request message for ProductService.DeleteProduct method.

DeleteServingConfigRequest

Request for DeleteServingConfig method.

EnrollSolutionMetadata

Metadata related to the EnrollSolution method. This will be returned by the google.longrunning.Operation.metadata field.

EnrollSolutionRequest

Request for EnrollSolution method.

EnrollSolutionResponse

Response for EnrollSolution method.

ExperimentInfo

Metadata for active A/B testing Experiment.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ServingConfigExperiment

Metadata for active serving config A/B tests.

ExportAnalyticsMetricsRequest

Request message for the ExportAnalyticsMetrics method.

ExportAnalyticsMetricsResponse

ExportErrorsConfig

Configuration of destination for Export related errors.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExportMetadata

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

ExportProductsResponse

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

ExportUserEventsResponse

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

FulfillmentInfo

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

GcsOutputResult

A Gcs output result.

GcsSource

Google Cloud Storage location for input content.

GetAlertConfigRequest

Request for ProjectService.GetAlertConfig method.

GetAttributesConfigRequest

Request for CatalogService.GetAttributesConfig method.

GetBranchRequest

Request for BranchService.GetBranch method.

GetCompletionConfigRequest

Request for CatalogService.GetCompletionConfig method.

GetControlRequest

Request for GetControl method.

GetDefaultBranchRequest

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

GetDefaultBranchResponse

Response message of CatalogService.GetDefaultBranch.

GetLoggingConfigRequest

Request for ProjectService.GetLoggingConfig method.

GetModelRequest

Request for getting a model.

GetProductRequest

Request message for ProductService.GetProduct method.

GetProjectRequest

Request for GetProject method.

GetServingConfigRequest

Request for GetServingConfig method.

Image

ImportCompletionDataRequest

Request message for ImportCompletionData methods.

ImportCompletionDataResponse

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

ImportErrorsConfig

Configuration of destination for Import related errors.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportMetadata

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

ImportProductsRequest

Request message for Import methods.

ReconciliationMode

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

ImportProductsResponse

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

ImportUserEventsRequest

Request message for the ImportUserEvents request.

ImportUserEventsResponse

Interval

A floating point interval.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ListBranchesRequest

Request for BranchService.ListBranches method.

ListBranchesResponse

Response for BranchService.ListBranches method.

ListCatalogsRequest

Request for CatalogService.ListCatalogs method.

ListCatalogsResponse

Response for CatalogService.ListCatalogs method.

ListControlsRequest

Request for ListControls method.

ListControlsResponse

Response for ListControls method.

ListEnrolledSolutionsRequest

Request for ListEnrolledSolutions method.

ListEnrolledSolutionsResponse

Response for ListEnrolledSolutions method.

ListMerchantCenterAccountLinksRequest

Request for MerchantCenterAccountLinkService.ListMerchantCenterAccountLinks method.

ListMerchantCenterAccountLinksResponse

Response for MerchantCenterAccountLinkService.ListMerchantCenterAccountLinks method.

ListModelsRequest

Request for listing models associated with a resource.

ListModelsResponse

Response to a ListModelRequest.

ListProductsRequest

Request message for ProductService.ListProducts method.

ListProductsResponse

Response message for ProductService.ListProducts method.

ListServingConfigsRequest

Request for ListServingConfigs method.

ListServingConfigsResponse

Response for ListServingConfigs method.

LocalInventory

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

AttributesEntry

The abstract base class for a message.

LoggingConfig

Project level logging config to control what level of log will be generated and written to Cloud Logging.

LogGenerationRule

The logging configurations for services supporting log generation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LoggingLevel

The setting to control log generation.

ServiceLogGenerationRule

The granular logging configurations for supported services.

MerchantCenterAccountLink

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

MerchantCenterFeedFilter

Merchant Center Feed filter criterion.

State

The state of the link.

MerchantCenterFeedFilter

Merchant Center Feed filter criterion.

MerchantCenterLink

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

MerchantCenterLinkingConfig

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

Model

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ContextProductsType

Use single or multiple context products for recommendations.

DataState

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

FrequentlyBoughtTogetherFeaturesConfig

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

ModelFeaturesConfig

Additional model features config.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PageOptimizationConfig

The PageOptimizationConfig for model training.

This determines how many panels to optimize for, and which serving configs to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey.

Candidate

A candidate to consider for a given panel. Currently only ServingConfig are valid candidates.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Panel

An individual panel with a list of ServingConfigs to consider for it.

Restriction

Restrictions of expected returned results.

    Example:

    `Panel1 candidates`: pdp_ctr, pdp_cvr,
    home_page_ctr_no_diversity

    `Panel2 candidates`: home_page_ctr_no_diversity,
    home_page_ctr_diversity, pdp_cvr_no_diversity

    `Restriction` = NO_RESTRICTION

    `Valid combinations`:

    -   (pdp_ctr, home_page_ctr_no_diversity)
    -  (pdp_ctr, home_page_ctr_diversity)
    -  (pdp_ctr, pdp_cvr_no_diversity)
    -  (pdp_cvr, home_page_ctr_no_diversity)
    -  (pdp_cvr, home_page_ctr_diversity)
    -  (pdp_cvr, pdp_cvr_no_diversity)
    -  (home_page_ctr_no_diversity, home_page_ctr_no_diversity)
    -  (home_page_ctr_no_diversity, home_page_ctr_diversity)
    -  (home_page_ctr_no_diversity, pdp_cvr_no_diversity)

    `Invalid combinations`: []
UNIQUE_SERVING_CONFIG_RESTRICTION (2):
    Do not allow the same
    <xref uid="google.cloud.retail.v2alpha.ServingConfig.name">ServingConfig.name</xref>
    to be shown on multiple panels.

    Example:

    `Panel1 candidates`: pdp_ctr, pdp_cvr,
    home_page_ctr_no_diversity

    `Panel2 candidates`: home_page_ctr_no_diversity,
    home_page_ctr_diversity_low, pdp_cvr_no_diversity

    `Restriction` = `UNIQUE_SERVING_CONFIG_RESTRICTION`

    `Valid combinations`:

    -   (pdp_ctr, home_page_ctr_no_diversity)
    -  (pdp_ctr, home_page_ctr_diversity_low)
    -  (pdp_ctr, pdp_cvr_no_diversity)
    -  (pdp_ctr, pdp_cvr_no_diversity)
    -  (pdp_cvr, home_page_ctr_no_diversity)
    -  (pdp_cvr, home_page_ctr_diversity_low)
    -  (pdp_cvr, pdp_cvr_no_diversity)
    -  (home_page_ctr_no_diversity, home_page_ctr_diversity_low)
    -  (home_page_ctr_no_diversity, pdp_cvr_no_diversity)

    `Invalid combinations`:

    -   (home_page_ctr_no_diversity, home_page_ctr_no_diversity)
UNIQUE_MODEL_RESTRICTION (3):
    Do not allow multiple
    <xref uid="google.cloud.retail.v2alpha.ServingConfig">ServingConfigs</xref>
    with same
    <xref uid="google.cloud.retail.v2alpha.Model.name">Model.name</xref> to be
    show on on different panels.

    Example:

    `Panel1 candidates`: pdp_ctr, pdp_cvr,
    home_page_ctr_no_diversity

    `Panel2 candidates`: home_page_ctr_no_diversity,
    home_page_ctr_diversity_low, pdp_cvr_no_diversity

    `Restriction` = `UNIQUE_MODEL_RESTRICTION`

    `Valid combinations`:

    -   (pdp_ctr, home_page_ctr_no_diversity)
    -  (pdp_ctr, home_page_ctr_diversity)
    -  (pdp_ctr, pdp_cvr_no_diversity)
    -  (pdp_ctr, pdp_cvr_no_diversity)
    -  (pdp_cvr, home_page_ctr_no_diversity)
    -  (pdp_cvr, home_page_ctr_diversity_low)
    -  (home_page_ctr_no_diversity, pdp_cvr_no_diversity)

    `Invalid combinations`:

    -   (home_page_ctr_no_diversity, home_page_ctr_no_diversity)
    -  (pdp_cvr, pdp_cvr_no_diversity)
UNIQUE_MODEL_TYPE_RESTRICTION (4):
    Do not allow multiple
    <xref uid="google.cloud.retail.v2alpha.ServingConfig">ServingConfigs</xref>
    with same
    <xref uid="google.cloud.retail.v2alpha.Model.type">Model.type</xref> to be
    shown on different panels.

    Example:

    `Panel1 candidates`: pdp_ctr, pdp_cvr,
    home_page_ctr_no_diversity

    `Panel2 candidates`: home_page_ctr_no_diversity,
    home_page_ctr_diversity_low, pdp_cvr_no_diversity

    `Restriction` = `UNIQUE_MODEL_RESTRICTION`

    `Valid combinations`:

    -   (pdp_ctr, home_page_ctr_no_diversity)
    -  (pdp_ctr, home_page_ctr_diversity)
    -  (pdp_cvr, home_page_ctr_no_diversity)
    -  (pdp_cvr, home_page_ctr_diversity_low)
    -  (home_page_ctr_no_diversity, pdp_cvr_no_diversity)

    `Invalid combinations`:

    -   (pdp_ctr, pdp_cvr_no_diversity)
    -  (pdp_ctr, pdp_cvr_no_diversity)
    -  (pdp_cvr, pdp_cvr_no_diversity)
    -  (home_page_ctr_no_diversity, home_page_ctr_no_diversity)
    -  (home_page_ctr_no_diversity, home_page_ctr_diversity)

PeriodicTuningState

ServingConfigList

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

ServingState

The serving state of the model.

TrainingState

The training state of the model.

OutputConfig

The output configuration setting.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BigQueryDestination

The BigQuery output destination configuration.

GcsDestination

The Google Cloud Storage output destination configuration.

OutputResult

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

PauseModelRequest

Request for pausing training of a model.

PredictRequest

Request message for Predict method.

LabelsEntry

The abstract base class for a message.

ParamsEntry

The abstract base class for a message.

PredictResponse

Response message for predict method.

PredictionResult

PredictionResult represents the recommendation prediction results.

MetadataEntry

The abstract base class for a message.

PriceInfo

The price information of a Product.

PriceRange

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

Product

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AttributesEntry

The abstract base class for a message.

Availability

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

Type

The type of this product.

    As the primary unit for predicting, indexing and search
    serving, a
    <xref uid="google.cloud.retail.v2alpha.Product.Type.PRIMARY">Type.PRIMARY</xref>
    <xref uid="google.cloud.retail.v2alpha.Product">Product</xref> is grouped
    with multiple
    <xref uid="google.cloud.retail.v2alpha.Product.Type.VARIANT">Type.VARIANT</xref>
    <xref uid="google.cloud.retail.v2alpha.Product">Product</xref>s.
VARIANT (2):
    The variant type.

    <xref uid="google.cloud.retail.v2alpha.Product.Type.VARIANT">Type.VARIANT</xref>
    <xref uid="google.cloud.retail.v2alpha.Product">Product</xref>s usually
    share some common attributes on the same
    <xref uid="google.cloud.retail.v2alpha.Product.Type.PRIMARY">Type.PRIMARY</xref>
    <xref uid="google.cloud.retail.v2alpha.Product">Product</xref>s, but they
    have variant attributes like different colors, sizes and
    prices, etc.
COLLECTION (3):
    The collection type. Collection products are bundled
    <xref uid="google.cloud.retail.v2alpha.Product.Type.PRIMARY">Type.PRIMARY</xref>
    <xref uid="google.cloud.retail.v2alpha.Product">Product</xref>s or
    <xref uid="google.cloud.retail.v2alpha.Product.Type.VARIANT">Type.VARIANT</xref>
    <xref uid="google.cloud.retail.v2alpha.Product">Product</xref>s that are
    sold together, such as a jewelry set with necklaces,
    earrings and rings, etc.

ProductDetail

Detailed product information associated with a user event.

ProductInlineSource

The inline source for the input config for ImportProducts method.

ProductInputConfig

The input config source for products.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ProductLevelConfig

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

Project

Metadata that describes a Cloud Retail Project.

Promotion

Promotion information.

PurchaseTransaction

A transaction represents the entire purchase transaction.

PurgeMetadata

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

PurgeProductsMetadata

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

PurgeProductsRequest

Request message for PurgeProducts method.

PurgeProductsResponse

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

PurgeUserEventsRequest

Request message for PurgeUserEvents method.

PurgeUserEventsResponse

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

Rating

The rating of a Product.

RecommendationsFilteringOption

If filtering for recommendations is enabled.

RejoinUserEventsMetadata

Metadata for RejoinUserEvents method.

RejoinUserEventsRequest

Request message for RejoinUserEvents method.

UserEventRejoinScope

RejoinUserEventsResponse

Response message for RejoinUserEvents method.

RemoveCatalogAttributeRequest

Request for CatalogService.RemoveCatalogAttribute method.

RemoveControlRequest

Request for RemoveControl method.

RemoveFulfillmentPlacesMetadata

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

RemoveFulfillmentPlacesRequest

Request message for ProductService.RemoveFulfillmentPlaces method.

RemoveFulfillmentPlacesResponse

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

RemoveLocalInventoriesMetadata

Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveLocalInventories method.

RemoveLocalInventoriesRequest

Request message for ProductService.RemoveLocalInventories method.

RemoveLocalInventoriesResponse

Response of the ProductService.RemoveLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.RemoveLocalInventories method.

ReplaceCatalogAttributeRequest

Request for CatalogService.ReplaceCatalogAttribute method.

ResumeModelRequest

Request for resuming training of a model.

Rule

A rule is a condition-action pair

A condition defines when a rule is to be triggered.
An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BoostAction

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

DoNotAssociateAction

Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".

FilterAction

Rule Condition:
- No Condition.query_terms provided is a global match.
- 1 or more Condition.query_terms provided are combined with OR operator.
Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict.
Action Result: Filters the returned objects to be ONLY those that passed the filter.

ForceReturnFacetAction

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

Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both.
Action Inputs: attribute name, position
Action Result: Will force return a facet key around a certain position or above if the condition is satisfied.

FacetPositionAdjustment

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

IgnoreAction

Prevents a term in the query from being used in search. Example: Don't search for "shoddy".

OnewaySynonymsAction

RedirectAction

Redirects a shopper to a specific page.

Rule Condition: Must specify Condition.query_terms.
Action Input: Request Query
Action Result: Redirects shopper to provided uri.

RemoveFacetAction

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

Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both.
Action Input: attribute name
Action Result: Will remove the attribute (as a facet) from the request if it is present.

Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present).

ReplacementAction

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

TwowaySynonymsAction

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

"sneakers" will use a synonym of "shoes".
"shoes" will use a synonym of "sneakers".

SearchRequest

Request message for SearchService.Search method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BoostSpec

Boost specification to boost certain items.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ConditionBoostSpec

Boost applies to products which match a condition.

DynamicFacetSpec

The specifications of dynamically generated facets.

Mode

Enum to control DynamicFacet mode

FacetSpec

A facet specification to perform faceted search.

FacetKey

Specifies how a facet is computed.

LabelsEntry

The abstract base class for a message.

PersonalizationSpec

The specification for personalization.

Mode

The personalization mode of each search request.

QueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

Condition

Enum describing under which condition query expansion should occur.

RelevanceThreshold

The relevance threshold of the search results. The higher relevance threshold is, the higher relevant results are shown and the less number of results are returned.

SearchMode

The search mode of each search request.

    Only
    <xref uid="google.cloud.retail.v2alpha.SearchResponse.SearchResult">SearchResponse.SearchResult</xref>
    will be returned.
    <xref uid="google.cloud.retail.v2alpha.SearchResponse.Facet">SearchResponse.Facet</xref>
    will not be returned, even if
    <xref uid="google.cloud.retail.v2alpha.SearchRequest.facet_specs">SearchRequest.facet_specs</xref>
    or
    <xref uid="google.cloud.retail.v2alpha.SearchRequest.dynamic_facet_spec">SearchRequest.dynamic_facet_spec</xref>
    is set.
FACETED_SEARCH_ONLY (2):
    Only faceted search will be performed. The product search
    will be disabled.

    When in this mode, one or both of
    <xref uid="google.cloud.retail.v2alpha.SearchRequest.facet_specs">SearchRequest.facet_specs</xref>
    and
    <xref uid="google.cloud.retail.v2alpha.SearchRequest.dynamic_facet_spec">SearchRequest.dynamic_facet_spec</xref>
    should be set. Otherwise, an INVALID_ARGUMENT error is
    returned. Only
    <xref uid="google.cloud.retail.v2alpha.SearchResponse.Facet">SearchResponse.Facet</xref>
    will be returned.
    <xref uid="google.cloud.retail.v2alpha.SearchResponse.SearchResult">SearchResponse.SearchResult</xref>
    will not be returned.

SpellCorrectionSpec

The specification for query spell correction.

Mode

Enum describing under which mode spell correction should occur.

SearchResponse

Response message for SearchService.Search method.

A facet result.

FacetValue

A facet value which contains value names and their count.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

QueryExpansionInfo

Information describing query expansion including whether expansion has occurred.

SearchResult

Represents the search results.

MatchingVariantFieldsEntry

The abstract base class for a message.

VariantRollupValuesEntry

The abstract base class for a message.

SearchSolutionUseCase

The use case of Cloud Retail Search.

ServingConfig

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).

DiversityType

What type of diversity - data or rule based.

SetDefaultBranchRequest

Request message to set a specified branch as new default_branch.

SetInventoryMetadata

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

SetInventoryRequest

Request message for ProductService.SetInventory method.

SetInventoryResponse

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

SolutionType

The type of solution.

TransformedUserEventsMetadata

Metadata related to transform user events operation.

TuneModelMetadata

Metadata associated with a tune operation.

TuneModelRequest

Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).

TuneModelResponse

Response associated with a tune operation.

UpdateAlertConfigRequest

Request for ProjectService.UpdateAlertConfig method.

UpdateAttributesConfigRequest

Request for CatalogService.UpdateAttributesConfig method.

UpdateCatalogRequest

Request for CatalogService.UpdateCatalog method.

UpdateCompletionConfigRequest

Request for CatalogService.UpdateCompletionConfig method.

UpdateControlRequest

Request for UpdateControl method.

UpdateLoggingConfigRequest

Request for ProjectService.UpdateLoggingConfig method.

UpdateModelRequest

Request for updating an existing model.

UpdateProductRequest

Request message for ProductService.UpdateProduct method.

UpdateServingConfigRequest

Request for UpdateServingConfig method.

UserEvent

UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.

AttributesEntry

The abstract base class for a message.

UserEventImportSummary

A summary of import result. The UserEventImportSummary summarizes the import status for user events.

UserEventInlineSource

The inline source for the input config for ImportUserEvents method.

UserEventInputConfig

The input config source for user events.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

UserInfo

Information of an end user.

WriteUserEventRequest

Request message for WriteUserEvent method.

AnalyticsServiceAsyncClient

Service for managing & accessing retail search business metric. Retail recommendation business metric is currently not available.

AnalyticsServiceClient

Service for managing & accessing retail search business metric. Retail recommendation business metric is currently not available.

CatalogServiceAsyncClient

Service for managing catalog configuration.

CatalogServiceClient

Service for managing catalog configuration.

ListCatalogsAsyncPager

A pager for iterating through list_catalogs requests.

This class thinly wraps an initial ListCatalogsResponse object, and provides an __aiter__ method to iterate through its catalogs field.

If there are more pages, the __aiter__ method will make additional ListCatalogs requests and continue to iterate through the catalogs field on the corresponding responses.

All the usual ListCatalogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCatalogsPager

A pager for iterating through list_catalogs requests.

This class thinly wraps an initial ListCatalogsResponse object, and provides an __iter__ method to iterate through its catalogs field.

If there are more pages, the __iter__ method will make additional ListCatalogs requests and continue to iterate through the catalogs field on the corresponding responses.

All the usual ListCatalogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

CompletionServiceAsyncClient

Autocomplete service for retail.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

CompletionServiceClient

Autocomplete service for retail.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

ControlServiceAsyncClient

Service for modifying Control.

ControlServiceClient

Service for modifying Control.

ListControlsAsyncPager

A pager for iterating through list_controls requests.

This class thinly wraps an initial ListControlsResponse object, and provides an __aiter__ method to iterate through its controls field.

If there are more pages, the __aiter__ method will make additional ListControls requests and continue to iterate through the controls field on the corresponding responses.

All the usual ListControlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListControlsPager

A pager for iterating through list_controls requests.

This class thinly wraps an initial ListControlsResponse object, and provides an __iter__ method to iterate through its controls field.

If there are more pages, the __iter__ method will make additional ListControls requests and continue to iterate through the controls field on the corresponding responses.

All the usual ListControlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ModelServiceAsyncClient

This service allows you to do the following:

Initiate training of a model.
Pause training of an existing model.
List all the available models along with their metadata.
Control their tuning schedule.

ModelServiceClient

This service allows you to do the following:

Initiate training of a model.
Pause training of an existing model.
List all the available models along with their metadata.
Control their tuning schedule.

ListModelsAsyncPager

A pager for iterating through list_models requests.

This class thinly wraps an initial ListModelsResponse object, and provides an __aiter__ method to iterate through its models field.

If there are more pages, the __aiter__ method will make additional ListModels requests and continue to iterate through the models field on the corresponding responses.

All the usual ListModelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListModelsPager

A pager for iterating through list_models requests.

This class thinly wraps an initial ListModelsResponse object, and provides an __iter__ method to iterate through its models field.

If there are more pages, the __iter__ method will make additional ListModels requests and continue to iterate through the models field on the corresponding responses.

All the usual ListModelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

PredictionServiceAsyncClient

Service for making recommendation prediction.

PredictionServiceClient

Service for making recommendation prediction.

ProductServiceAsyncClient

Service for ingesting Product information of the customer's website.

ProductServiceClient

Service for ingesting Product information of the customer's website.

ListProductsAsyncPager

A pager for iterating through list_products requests.

This class thinly wraps an initial ListProductsResponse object, and provides an __aiter__ method to iterate through its products field.

If there are more pages, the __aiter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListProductsPager

A pager for iterating through list_products requests.

This class thinly wraps an initial ListProductsResponse object, and provides an __iter__ method to iterate through its products field.

If there are more pages, the __iter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchServiceAsyncClient

Service for search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

SearchServiceClient

Service for search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

SearchAsyncPager

A pager for iterating through search requests.

This class thinly wraps an initial SearchResponse object, and provides an __aiter__ method to iterate through its results field.

If there are more pages, the __aiter__ method will make additional Search requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchPager

A pager for iterating through search requests.

This class thinly wraps an initial SearchResponse object, and provides an __iter__ method to iterate through its results field.

If there are more pages, the __iter__ method will make additional Search requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ServingConfigServiceAsyncClient

Service for modifying ServingConfig.

ServingConfigServiceClient

Service for modifying ServingConfig.

ListServingConfigsAsyncPager

A pager for iterating through list_serving_configs requests.

This class thinly wraps an initial ListServingConfigsResponse object, and provides an __aiter__ method to iterate through its serving_configs field.

If there are more pages, the __aiter__ method will make additional ListServingConfigs requests and continue to iterate through the serving_configs field on the corresponding responses.

All the usual ListServingConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListServingConfigsPager

A pager for iterating through list_serving_configs requests.

This class thinly wraps an initial ListServingConfigsResponse object, and provides an __iter__ method to iterate through its serving_configs field.

If there are more pages, the __iter__ method will make additional ListServingConfigs requests and continue to iterate through the serving_configs field on the corresponding responses.

All the usual ListServingConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

UserEventServiceAsyncClient

Service for ingesting end user actions on the customer website.

UserEventServiceClient

Service for ingesting end user actions on the customer website.

AddCatalogAttributeRequest

Request for CatalogService.AddCatalogAttribute method.

AddControlRequest

Request for AddControl method.

AddFulfillmentPlacesMetadata

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

AddFulfillmentPlacesRequest

Request message for ProductService.AddFulfillmentPlaces method.

AddFulfillmentPlacesResponse

Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces method.

AddLocalInventoriesMetadata

Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddLocalInventories method.

AddLocalInventoriesRequest

Request message for ProductService.AddLocalInventories method.

AddLocalInventoriesResponse

Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method.

AttributeConfigLevel

At which level we offer configuration for attributes.

AttributesConfig

Catalog level attribute config.

CatalogAttributesEntry

The abstract base class for a message.

Audience

An intended audience of the Product for whom it's sold.

BatchRemoveCatalogAttributesRequest

Request for CatalogService.BatchRemoveCatalogAttributes method.

BatchRemoveCatalogAttributesResponse

Response of the CatalogService.BatchRemoveCatalogAttributes.

BigQueryOutputResult

A BigQuery output result.

BigQuerySource

BigQuery source import data from.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Catalog

The catalog configuration.

CatalogAttribute

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

AttributeType

The type of an attribute.

    Used when type cannot be derived from attribute that is not
    <xref uid="google.cloud.retail.v2beta.CatalogAttribute.in_use">in_use</xref>.
TEXTUAL (1):
    Textual attribute.
NUMERICAL (2):
    Numerical attribute.

DynamicFacetableOption

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

ExactSearchableOption

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

FacetConfig

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

IgnoredFacetValues

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

MergedFacet

MergedFacetValue

RerankConfig

IndexableOption

The status of the indexable option of a catalog attribute.

RetrievableOption

The status of the retrievable option of a catalog attribute.

SearchableOption

The status of the searchable option of a catalog attribute.

CollectUserEventRequest

Request message for CollectUserEvent method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ColorInfo

The color information of a Product.

CompleteQueryRequest

Autocomplete parameters.

CompleteQueryResponse

Response of the autocomplete query.

CompletionResult

Resource that represents completion results.

AttributesEntry

The abstract base class for a message.

RecentSearchResult

Deprecated: Recent search of this user.

CompletionConfig

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

CompletionDataInputConfig

The input config source for completion data.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CompletionDetail

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

Condition

QueryTerm

Query terms that we want to match on.

TimeRange

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

Control

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CreateControlRequest

Request for CreateControl method.

CreateModelMetadata

Metadata associated with a create operation.

CreateModelRequest

Request for creating a model.

CreateProductRequest

Request message for ProductService.CreateProduct method.

CreateServingConfigRequest

Request for CreateServingConfig method.

CustomAttribute

A custom attribute that is not explicitly modeled in Product.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeleteControlRequest

Request for DeleteControl method.

DeleteModelRequest

Request for deleting a model.

DeleteProductRequest

Request message for ProductService.DeleteProduct method.

DeleteServingConfigRequest

Request for DeleteServingConfig method.

ExperimentInfo

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ServingConfigExperiment

Metadata for active serving config A/B tests.

ExportAnalyticsMetricsRequest

Request message for the ExportAnalyticsMetrics method.

ExportAnalyticsMetricsResponse

ExportErrorsConfig

Configuration of destination for Export related errors.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExportMetadata

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

ExportProductsResponse

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

ExportUserEventsResponse

FulfillmentInfo

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

GcsOutputResult

A Gcs output result.

GcsSource

Google Cloud Storage location for input content.

GetAttributesConfigRequest

Request for CatalogService.GetAttributesConfig method.

GetCompletionConfigRequest

Request for CatalogService.GetCompletionConfig method.

GetControlRequest

Request for GetControl method.

GetDefaultBranchRequest

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

GetDefaultBranchResponse

Response message of CatalogService.GetDefaultBranch.

GetModelRequest

Request for getting a model.

GetProductRequest

Request message for ProductService.GetProduct method.

GetServingConfigRequest

Request for GetServingConfig method.

Image

ImportCompletionDataRequest

Request message for ImportCompletionData methods.

ImportCompletionDataResponse

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

ImportErrorsConfig

Configuration of destination for Import related errors.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportMetadata

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

ImportProductsRequest

Request message for Import methods.

ReconciliationMode

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

ImportProductsResponse

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

ImportUserEventsRequest

Request message for the ImportUserEvents request.

ImportUserEventsResponse

Interval

A floating point interval.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ListCatalogsRequest

Request for CatalogService.ListCatalogs method.

ListCatalogsResponse

Response for CatalogService.ListCatalogs method.

ListControlsRequest

Request for ListControls method.

ListControlsResponse

Response for ListControls method.

ListModelsRequest

Request for listing models associated with a resource.

ListModelsResponse

Response to a ListModelRequest.

ListProductsRequest

Request message for ProductService.ListProducts method.

ListProductsResponse

Response message for ProductService.ListProducts method.

ListServingConfigsRequest

Request for ListServingConfigs method.

ListServingConfigsResponse

Response for ListServingConfigs method.

LocalInventory

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

AttributesEntry

The abstract base class for a message.

MerchantCenterFeedFilter

Merchant Center Feed filter criterion.

MerchantCenterLink

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

MerchantCenterLinkingConfig

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

Model

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

ContextProductsType

Use single or multiple context products for recommendations.

DataState

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

FrequentlyBoughtTogetherFeaturesConfig

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

ModelFeaturesConfig

Additional model features config.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PeriodicTuningState

ServingConfigList

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

ServingState

The serving state of the model.

TrainingState

The training state of the model.

OutputConfig

The output configuration setting.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BigQueryDestination

The BigQuery output destination configuration.

GcsDestination

The Google Cloud Storage output destination configuration.

OutputResult

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

PauseModelRequest

Request for pausing training of a model.

PredictRequest

Request message for Predict method.

LabelsEntry

The abstract base class for a message.

ParamsEntry

The abstract base class for a message.

PredictResponse

Response message for predict method.

PredictionResult

PredictionResult represents the recommendation prediction results.

MetadataEntry

The abstract base class for a message.

PriceInfo

The price information of a Product.

PriceRange

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

Product

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AttributesEntry

The abstract base class for a message.

Availability

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

Type

The type of this product.

    As the primary unit for predicting, indexing and search
    serving, a
    <xref uid="google.cloud.retail.v2beta.Product.Type.PRIMARY">Type.PRIMARY</xref>
    <xref uid="google.cloud.retail.v2beta.Product">Product</xref> is grouped
    with multiple
    <xref uid="google.cloud.retail.v2beta.Product.Type.VARIANT">Type.VARIANT</xref>
    <xref uid="google.cloud.retail.v2beta.Product">Product</xref>s.
VARIANT (2):
    The variant type.

    <xref uid="google.cloud.retail.v2beta.Product.Type.VARIANT">Type.VARIANT</xref>
    <xref uid="google.cloud.retail.v2beta.Product">Product</xref>s usually share
    some common attributes on the same
    <xref uid="google.cloud.retail.v2beta.Product.Type.PRIMARY">Type.PRIMARY</xref>
    <xref uid="google.cloud.retail.v2beta.Product">Product</xref>s, but they
    have variant attributes like different colors, sizes and
    prices, etc.
COLLECTION (3):
    The collection type. Collection products are bundled
    <xref uid="google.cloud.retail.v2beta.Product.Type.PRIMARY">Type.PRIMARY</xref>
    <xref uid="google.cloud.retail.v2beta.Product">Product</xref>s or
    <xref uid="google.cloud.retail.v2beta.Product.Type.VARIANT">Type.VARIANT</xref>
    <xref uid="google.cloud.retail.v2beta.Product">Product</xref>s that are sold
    together, such as a jewelry set with necklaces, earrings and
    rings, etc.

ProductDetail

Detailed product information associated with a user event.

ProductInlineSource

The inline source for the input config for ImportProducts method.

ProductInputConfig

The input config source for products.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ProductLevelConfig

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

Promotion

Promotion information.

PurchaseTransaction

A transaction represents the entire purchase transaction.

PurgeMetadata

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

PurgeProductsMetadata

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

PurgeProductsRequest

Request message for PurgeProducts method.

PurgeProductsResponse

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

PurgeUserEventsRequest

Request message for PurgeUserEvents method.

PurgeUserEventsResponse

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

Rating

The rating of a Product.

RecommendationsFilteringOption

If filtering for recommendations is enabled.

RejoinUserEventsMetadata

Metadata for RejoinUserEvents method.

RejoinUserEventsRequest

Request message for RejoinUserEvents method.

UserEventRejoinScope

RejoinUserEventsResponse

Response message for RejoinUserEvents method.

RemoveCatalogAttributeRequest

Request for CatalogService.RemoveCatalogAttribute method.

RemoveControlRequest

Request for RemoveControl method.

RemoveFulfillmentPlacesMetadata

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

RemoveFulfillmentPlacesRequest

Request message for ProductService.RemoveFulfillmentPlaces method.

RemoveFulfillmentPlacesResponse

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

RemoveLocalInventoriesMetadata

Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveLocalInventories method.

RemoveLocalInventoriesRequest

Request message for ProductService.RemoveLocalInventories method.

RemoveLocalInventoriesResponse

Response of the ProductService.RemoveLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.RemoveLocalInventories method.

ReplaceCatalogAttributeRequest

Request for CatalogService.ReplaceCatalogAttribute method.

ResumeModelRequest

Request for resuming training of a model.

Rule

A rule is a condition-action pair

A condition defines when a rule is to be triggered.
An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BoostAction

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

DoNotAssociateAction

Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".

FilterAction

Rule Condition:
- No Condition.query_terms provided is a global match.
- 1 or more Condition.query_terms provided are combined with OR operator.
Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict.
Action Result: Filters the returned objects to be ONLY those that passed the filter.

ForceReturnFacetAction

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

Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both.
Action Inputs: attribute name, position
Action Result: Will force return a facet key around a certain position or above if the condition is satisfied.

FacetPositionAdjustment

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

IgnoreAction

Prevents a term in the query from being used in search. Example: Don't search for "shoddy".

OnewaySynonymsAction

RedirectAction

Redirects a shopper to a specific page.

Rule Condition: Must specify Condition.query_terms.
Action Input: Request Query
Action Result: Redirects shopper to provided uri.

RemoveFacetAction

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

Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both.
Action Input: attribute name
Action Result: Will remove the attribute (as a facet) from the request if it is present.

Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present).

ReplacementAction

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

TwowaySynonymsAction

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

"sneakers" will use a synonym of "shoes".
"shoes" will use a synonym of "sneakers".

SearchRequest

Request message for SearchService.Search method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BoostSpec

Boost specification to boost certain items.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ConditionBoostSpec

Boost applies to products which match a condition.

DynamicFacetSpec

The specifications of dynamically generated facets.

Mode

Enum to control DynamicFacet mode

FacetSpec

A facet specification to perform faceted search.

FacetKey

Specifies how a facet is computed.

LabelsEntry

The abstract base class for a message.

PersonalizationSpec

The specification for personalization.

Mode

The personalization mode of each search request.

QueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

Condition

Enum describing under which condition query expansion should occur.

SearchMode

The search mode of each search request.

    Only
    <xref uid="google.cloud.retail.v2beta.SearchResponse.SearchResult">SearchResponse.SearchResult</xref>
    will be returned.
    <xref uid="google.cloud.retail.v2beta.SearchResponse.Facet">SearchResponse.Facet</xref>
    will not be returned, even if
    <xref uid="google.cloud.retail.v2beta.SearchRequest.facet_specs">SearchRequest.facet_specs</xref>
    or
    <xref uid="google.cloud.retail.v2beta.SearchRequest.dynamic_facet_spec">SearchRequest.dynamic_facet_spec</xref>
    is set.
FACETED_SEARCH_ONLY (2):
    Only faceted search will be performed. The product search
    will be disabled.

    When in this mode, one or both of
    <xref uid="google.cloud.retail.v2beta.SearchRequest.facet_specs">SearchRequest.facet_specs</xref>
    and
    <xref uid="google.cloud.retail.v2beta.SearchRequest.dynamic_facet_spec">SearchRequest.dynamic_facet_spec</xref>
    should be set. Otherwise, an INVALID_ARGUMENT error is
    returned. Only
    <xref uid="google.cloud.retail.v2beta.SearchResponse.Facet">SearchResponse.Facet</xref>
    will be returned.
    <xref uid="google.cloud.retail.v2beta.SearchResponse.SearchResult">SearchResponse.SearchResult</xref>
    will not be returned.