Index
AnalyticsService
(interface)CatalogService
(interface)CompletionService
(interface)ControlService
(interface)GenerativeQuestionService
(interface)ModelService
(interface)PredictionService
(interface)ProductService
(interface)SearchService
(interface)ServingConfigService
(interface)UserEventService
(interface)AddCatalogAttributeRequest
(message)AddControlRequest
(message)AddFulfillmentPlacesMetadata
(message)AddFulfillmentPlacesRequest
(message)AddFulfillmentPlacesResponse
(message)AddLocalInventoriesMetadata
(message)AddLocalInventoriesRequest
(message)AddLocalInventoriesResponse
(message)AttributeConfigLevel
(enum)AttributesConfig
(message)Audience
(message)BigQueryOutputResult
(message)BigQuerySource
(message)Catalog
(message)CatalogAttribute
(message)CatalogAttribute.AttributeType
(enum)CatalogAttribute.DynamicFacetableOption
(enum)CatalogAttribute.ExactSearchableOption
(enum)CatalogAttribute.FacetConfig
(message)CatalogAttribute.FacetConfig.IgnoredFacetValues
(message)CatalogAttribute.FacetConfig.MergedFacet
(message)CatalogAttribute.FacetConfig.MergedFacetValue
(message)CatalogAttribute.FacetConfig.RerankConfig
(message)CatalogAttribute.IndexableOption
(enum)CatalogAttribute.RetrievableOption
(enum)CatalogAttribute.SearchableOption
(enum)CollectUserEventRequest
(message)ColorInfo
(message)CompleteQueryRequest
(message)CompleteQueryResponse
(message)CompleteQueryResponse.AttributeResult
(message)CompleteQueryResponse.CompletionResult
(message)CompleteQueryResponse.RecentSearchResult
(message) (deprecated)CompletionConfig
(message)CompletionDataInputConfig
(message)CompletionDetail
(message)Condition
(message)Condition.QueryTerm
(message)Condition.TimeRange
(message)Control
(message)CreateControlRequest
(message)CreateModelMetadata
(message)CreateModelRequest
(message)CreateProductRequest
(message)CreateServingConfigRequest
(message)CustomAttribute
(message)DeleteControlRequest
(message)DeleteModelRequest
(message)DeleteProductRequest
(message)DeleteServingConfigRequest
(message)ExperimentInfo
(message)ExperimentInfo.ServingConfigExperiment
(message)ExportAnalyticsMetricsRequest
(message)ExportAnalyticsMetricsResponse
(message)ExportErrorsConfig
(message)ExportMetadata
(message)FulfillmentInfo
(message)GcsOutputResult
(message)GcsSource
(message)GetAttributesConfigRequest
(message)GetCompletionConfigRequest
(message)GetControlRequest
(message)GetDefaultBranchRequest
(message)GetDefaultBranchResponse
(message)GetModelRequest
(message)GetProductRequest
(message)GetServingConfigRequest
(message)Image
(message)ImportCompletionDataRequest
(message)ImportCompletionDataResponse
(message)ImportErrorsConfig
(message)ImportMetadata
(message)ImportProductsRequest
(message)ImportProductsRequest.ReconciliationMode
(enum)ImportProductsResponse
(message)ImportUserEventsRequest
(message)ImportUserEventsResponse
(message)Interval
(message)ListCatalogsRequest
(message)ListCatalogsResponse
(message)ListControlsRequest
(message)ListControlsResponse
(message)ListModelsRequest
(message)ListModelsResponse
(message)ListProductsRequest
(message)ListProductsResponse
(message)ListServingConfigsRequest
(message)ListServingConfigsResponse
(message)LocalInventory
(message)Model
(message)Model.ContextProductsType
(enum)Model.DataState
(enum)Model.FrequentlyBoughtTogetherFeaturesConfig
(message)Model.ModelFeaturesConfig
(message)Model.PeriodicTuningState
(enum)Model.ServingConfigList
(message)Model.ServingState
(enum)Model.TrainingState
(enum)OutputConfig
(message)OutputConfig.BigQueryDestination
(message)OutputConfig.GcsDestination
(message)OutputResult
(message)PauseModelRequest
(message)PredictRequest
(message)PredictResponse
(message)PredictResponse.PredictionResult
(message)PriceInfo
(message)PriceInfo.PriceRange
(message)Product
(message)Product.Availability
(enum)Product.Type
(enum)ProductAttributeInterval
(message)ProductAttributeValue
(message)ProductDetail
(message)ProductInlineSource
(message)ProductInputConfig
(message)ProductLevelConfig
(message)Promotion
(message)PurchaseTransaction
(message)PurgeMetadata
(message)PurgeProductsMetadata
(message)PurgeProductsRequest
(message)PurgeProductsResponse
(message)PurgeUserEventsRequest
(message)PurgeUserEventsResponse
(message)Rating
(message)RecommendationsFilteringOption
(enum)RejoinUserEventsMetadata
(message)RejoinUserEventsRequest
(message)RejoinUserEventsRequest.UserEventRejoinScope
(enum)RejoinUserEventsResponse
(message)RemoveCatalogAttributeRequest
(message)RemoveControlRequest
(message)RemoveFulfillmentPlacesMetadata
(message)RemoveFulfillmentPlacesRequest
(message)RemoveFulfillmentPlacesResponse
(message)RemoveLocalInventoriesMetadata
(message)RemoveLocalInventoriesRequest
(message)RemoveLocalInventoriesResponse
(message)ReplaceCatalogAttributeRequest
(message)ResumeModelRequest
(message)Rule
(message)Rule.BoostAction
(message)Rule.DoNotAssociateAction
(message)Rule.FilterAction
(message)Rule.ForceReturnFacetAction
(message)Rule.ForceReturnFacetAction.FacetPositionAdjustment
(message)Rule.IgnoreAction
(message)Rule.OnewaySynonymsAction
(message)Rule.RedirectAction
(message)Rule.RemoveFacetAction
(message)Rule.ReplacementAction
(message)Rule.TwowaySynonymsAction
(message)SearchRequest
(message)SearchRequest.BoostSpec
(message)SearchRequest.BoostSpec.ConditionBoostSpec
(message)SearchRequest.ConversationalSearchSpec
(message)SearchRequest.ConversationalSearchSpec.UserAnswer
(message)SearchRequest.ConversationalSearchSpec.UserAnswer.SelectedAnswer
(message)SearchRequest.DynamicFacetSpec
(message)SearchRequest.DynamicFacetSpec.Mode
(enum)SearchRequest.FacetSpec
(message)SearchRequest.FacetSpec.FacetKey
(message)SearchRequest.PersonalizationSpec
(message)SearchRequest.PersonalizationSpec.Mode
(enum)SearchRequest.QueryExpansionSpec
(message)SearchRequest.QueryExpansionSpec.Condition
(enum)SearchRequest.SearchMode
(enum)SearchRequest.SpellCorrectionSpec
(message)SearchRequest.SpellCorrectionSpec.Mode
(enum)SearchRequest.TileNavigationSpec
(message)SearchResponse
(message)SearchResponse.ConversationalSearchResult
(message)SearchResponse.ConversationalSearchResult.AdditionalFilter
(message)SearchResponse.ConversationalSearchResult.SuggestedAnswer
(message)SearchResponse.Facet
(message)SearchResponse.Facet.FacetValue
(message)SearchResponse.QueryExpansionInfo
(message)SearchResponse.SearchResult
(message)SearchResponse.TileNavigationResult
(message)SearchSolutionUseCase
(enum)ServingConfig
(message)ServingConfig.DiversityType
(enum)SetDefaultBranchRequest
(message)SetInventoryMetadata
(message)SetInventoryRequest
(message)SetInventoryResponse
(message)SolutionType
(enum)Tile
(message)TuneModelMetadata
(message)TuneModelRequest
(message)TuneModelResponse
(message)UpdateAttributesConfigRequest
(message)UpdateCatalogRequest
(message)UpdateCompletionConfigRequest
(message)UpdateControlRequest
(message)UpdateModelRequest
(message)UpdateProductRequest
(message)UpdateServingConfigRequest
(message)UserEvent
(message)UserEventImportSummary
(message)UserEventInlineSource
(message)UserEventInputConfig
(message)UserInfo
(message)WriteUserEventRequest
(message)
AnalyticsService
Service for managing & accessing retail search business metric. Retail recommendation business metric is currently not available.
ExportAnalyticsMetrics |
---|
Exports analytics metrics.
|
CatalogService
Service for managing catalog configuration.
AddCatalogAttribute |
---|
Adds the specified If the
|
GetAttributesConfig |
---|
Gets an
|
GetCompletionConfig |
---|
Gets a
|
GetDefaultBranch |
---|
Get which branch is currently default branch set by
|
ListCatalogs |
---|
Lists all the
|
RemoveCatalogAttribute |
---|
Removes the specified If the
|
ReplaceCatalogAttribute |
---|
Replaces the specified If the
|
SetDefaultBranch |
---|
Set a specified branch id as default branch. API methods such as For example, if Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one. More specifically:
|
UpdateAttributesConfig |
---|
Updates the The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.
|
UpdateCatalog |
---|
Updates the
|
UpdateCompletionConfig |
---|
Updates the
|
CompletionService
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.
CompleteQuery |
---|
Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
|
ImportCompletionData |
---|
Bulk import of processed completion dataset. Request processing is asynchronous. Partial updating is not supported. The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
|
ControlService
Service for modifying Control.
CreateControl |
---|
Creates a Control. If the
|
DeleteControl |
---|
Deletes a Control. If the
|
GetControl |
---|
Gets a Control.
|
ListControls |
---|
Lists all Controls by their parent
|
UpdateControl |
---|
Updates a Control.
|
GenerativeQuestionService
Service for managing LLM generated questions in search serving.
ModelService
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.
CreateModel |
---|
Creates a new model.
|
DeleteModel |
---|
Deletes an existing model.
|
GetModel |
---|
Gets a model.
|
ListModels |
---|
Lists all the models linked to this event store.
|
PauseModel |
---|
Pauses the training of an existing model.
|
ResumeModel |
---|
Resumes the training of an existing model.
|
TuneModel |
---|
Tunes an existing model.
|
UpdateModel |
---|
Update of model metadata. Only fields that currently can be updated are:
|
PredictionService
Service for making recommendation prediction.
Predict |
---|
Makes a recommendation prediction.
|
ProductService
Service for ingesting Product
information of the customer's website.
AddFulfillmentPlaces |
---|
We recommend that you use the Incrementally adds place IDs to This process is asynchronous and does not require the The returned If conflicting updates are issued, the
|
AddLocalInventories |
---|
Updates local inventory information for a This process is asynchronous and does not require the Local inventory information can only be modified using this method. The returned If conflicting updates are issued, the
|
CreateProduct |
---|
Creates a
|
DeleteProduct |
---|
Deletes a
|
GetProduct |
---|
Gets a
|
ImportProducts |
---|
Bulk import of multiple Request processing may be synchronous. Non-existing items are created. Note that it is possible for a subset of the
|
ListProducts |
---|
Gets a list of
|
PurgeProducts |
---|
Permanently deletes all selected This process is asynchronous. If the request is valid, the removal will be enqueued and processed offline. Depending on the number of Depending on the number of
|
RemoveFulfillmentPlaces |
---|
We recommend that you use the Incrementally removes place IDs from a This process is asynchronous and does not require the The returned If conflicting updates are issued, the
|
RemoveLocalInventories |
---|
Remove local inventory information for a This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Local inventory information can only be removed using this method. The returned If conflicting updates are issued, the
|
SetInventory |
---|
Updates inventory information for a This process is asynchronous and does not require the When inventory is updated with If no inventory fields are set in If no inventory fields are set in Pre-existing inventory information can only be updated with The returned If conflicting updates are issued, the
|
UpdateProduct |
---|
Updates a
|
SearchService
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.
Search |
---|
Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
|
ServingConfigService
Service for modifying ServingConfig.
AddControl |
---|
Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control.
|
CreateServingConfig |
---|
Creates a ServingConfig. A maximum of 100
|
DeleteServingConfig |
---|
Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
GetServingConfig |
---|
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
ListServingConfigs |
---|
Lists all ServingConfigs linked to this catalog.
|
RemoveControl |
---|
Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig.
|
UpdateServingConfig |
---|
Updates a ServingConfig.
|
UserEventService
Service for ingesting end user actions on the customer website.
CollectUserEvent |
---|
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
|
ImportUserEvents |
---|
Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
|
PurgeUserEvents |
---|
Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.
|
RejoinUserEvents |
---|
Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.
|
WriteUserEvent |
---|
Writes a single user event.
|
AddCatalogAttributeRequest
Request for CatalogService.AddCatalogAttribute
method.
Fields | |
---|---|
attributes_config |
Required. Full AttributesConfig resource name. Format: |
catalog_attribute |
Required. The |
AddControlRequest
Request for AddControl method.
Fields | |
---|---|
serving_config |
Required. The source ServingConfig resource name . Format: |
control_id |
Required. The id of the control to apply. Assumed to be in the same catalog as the serving config - if id is not found a NOT_FOUND error is returned. |
AddFulfillmentPlacesMetadata
This type has no fields.
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.
Fields | |
---|---|
product |
Required. Full resource name of If the caller does not have permission to access the |
type |
Required. The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Supported values:
If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. This field directly corresponds to |
place_ids[] |
Required. The IDs for this At least 1 value is required, and a maximum of 2000 values are allowed. Each value must be a string with a length limit of 10 characters, matching the pattern If the total number of place IDs exceeds 2000 for this |
add_time |
The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information. If not provided, the internal system time will be used. |
allow_missing |
If set to true, and the |
AddFulfillmentPlacesResponse
This type has no fields.
Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces
method.
AddLocalInventoriesMetadata
This type has no fields.
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.
Fields | |
---|---|
product |
Required. Full resource name of If the caller does not have permission to access the |
local_inventories[] |
Required. A list of inventory information at difference places. Each place is identified by its place ID. At most 3000 inventories are allowed per request. |
add_mask |
Indicates which inventory fields in the provided list of If a field is set while the place does not have a previous local inventory, the local inventory at that store is created. If a field is set while the value of that field is not provided, the original field value, if it exists, is deleted. If the mask is not set or set with empty paths, all inventory fields will be updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored. |
add_time |
The time when the inventory updates are issued. Used to prevent out-of-order updates on local inventory fields. If not provided, the internal system time will be used. |
allow_missing |
If set to true, and the |
AddLocalInventoriesResponse
This type has no fields.
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.
Enums | |
---|---|
ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED |
Value used when unset. In this case, server behavior defaults to CATALOG_LEVEL_ATTRIBUTE_CONFIG . |
PRODUCT_LEVEL_ATTRIBUTE_CONFIG |
At this level, we honor the attribute configurations set in Product.attributes . |
CATALOG_LEVEL_ATTRIBUTE_CONFIG |
At this level, we honor the attribute configurations set in [CatalogConfig.attribute_configs][]. |
AttributesConfig
Catalog level attribute config.
Fields | |
---|---|
name |
Required. Immutable. The fully qualified resource name of the attribute config. Format: |
catalog_attributes |
Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute. The key is catalog attribute's name. For example: The maximum number of catalog attributes allowed in a request is 1000. |
attribute_config_level |
Output only. The |
Audience
An intended audience of the Product
for whom it's sold.
Fields | |
---|---|
genders[] |
The genders of the audience. Strongly encouraged to use the standard values: "male", "female", "unisex". At most 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property gender. Schema.org property Product.audience.suggestedGender. |
age_groups[] |
The age groups of the audience. Strongly encouraged to use the standard values: "newborn" (up to 3 months old), "infant" (3–12 months old), "toddler" (1–5 years old), "kids" (5–13 years old), "adult" (typically teens or older). At most 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property age_group. Schema.org property Product.audience.suggestedMinAge and Product.audience.suggestedMaxAge. |
BigQueryOutputResult
A BigQuery output result.
Fields | |
---|---|
dataset_id |
The ID of a BigQuery Dataset. |
table_id |
The ID of a BigQuery Table. |
BigQuerySource
BigQuery source import data from.
Fields | |
---|---|
project_id |
The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. |
dataset_id |
Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. |
table_id |
Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. |
gcs_staging_dir |
Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. |
data_schema |
The schema to use when parsing the data from the source. Supported values for product imports:
Supported values for user events imports:
Supported values for autocomplete imports:
|
Union field partition . BigQuery table partition info. Leave this empty if the BigQuery table is not partitioned. partition can be only one of the following: |
|
partition_date |
BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported in |
Catalog
The catalog configuration.
Fields | |
---|---|
name |
Required. Immutable. The fully qualified resource name of the catalog. |
display_name |
Required. Immutable. The catalog display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
product_level_config |
Required. The product level configuration. |
CatalogAttribute
Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
Fields | |
---|---|
key |
Required. Attribute name. For example: If the attribute key starts with |
in_use |
Output only. Indicates whether this attribute has been used by any products.
Only pre-loaded After catalog changes, it takes about 10 minutes for this field to update. |
type |
Output only. The type of this attribute. This is derived from the attribute in |
indexable_option |
When Must be specified when |
dynamic_facetable_option |
If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if Must be specified, otherwise throws INVALID_FORMAT error. |
searchable_option |
When If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in Must be specified, when |
exact_searchable_option |
If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to |
retrievable_option |
If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to |
facet_config |
Contains facet options. |
AttributeType
The type of an attribute.
Enums | |
---|---|
UNKNOWN |
The type of the attribute is unknown. Used when type cannot be derived from attribute that is not |
TEXTUAL |
Textual attribute. |
NUMERICAL |
Numerical attribute. |
DynamicFacetableOption
The status of the dynamic facetable option of a catalog attribute.
Enums | |
---|---|
DYNAMIC_FACETABLE_OPTION_UNSPECIFIED |
Value used when unset. |
DYNAMIC_FACETABLE_ENABLED |
Dynamic facetable option enabled for an attribute. |
DYNAMIC_FACETABLE_DISABLED |
Dynamic facetable option disabled for an attribute. |
ExactSearchableOption
The status of the exact-searchable option of a catalog attribute.
Enums | |
---|---|
EXACT_SEARCHABLE_OPTION_UNSPECIFIED |
Value used when unset. |
EXACT_SEARCHABLE_ENABLED |
Exact searchable option enabled for an attribute. |
EXACT_SEARCHABLE_DISABLED |
Exact searchable option disabled for an attribute. |
FacetConfig
Possible options for the facet that corresponds to the current attribute config.
Fields | |
---|---|
facet_intervals[] |
If you don't set the facet |
ignored_facet_values[] |
Each instance represents a list of attribute values to ignore as facet values for a specific time range. The maximum number of instances per |
merged_facet_values[] |
Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per |
merged_facet |
Use this field only if you want to merge a facet key into another facet key. |
rerank_config |
Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys. |
IgnoredFacetValues
Facet values
to ignore on facets
during the specified time range for the given SearchResponse.Facet.key
attribute.
Fields | |
---|---|
values[] |
List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters. |
start_time |
Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time. |
end_time |
If start time is empty and end time is not empty, then ignore these facet values before end time. |
MergedFacet
The current facet key (i.e. attribute config) maps into the merged_facet_key
. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type).
Fields | |
---|---|
merged_facet_key |
The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. |
MergedFacetValue
Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute
. This feature is available only for textual custom attributes.
Fields | |
---|---|
values[] |
All the facet values that are replaces by the same |
merged_value |
All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. |
RerankConfig
Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don't pass the facet keys engaged that you want to rerank on, this control won't be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces).
Fields | |
---|---|
rerank_facet |
If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving. |
facet_values[] |
If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only. |
IndexableOption
The status of the indexable option of a catalog attribute.
Enums | |
---|---|
INDEXABLE_OPTION_UNSPECIFIED |
Value used when unset. |
INDEXABLE_ENABLED |
Indexable option enabled for an attribute. |
INDEXABLE_DISABLED |
Indexable option disabled for an attribute. |
RetrievableOption
The status of the retrievable option of a catalog attribute.
Enums | |
---|---|
RETRIEVABLE_OPTION_UNSPECIFIED |
Value used when unset. |
RETRIEVABLE_ENABLED |
Retrievable option enabled for an attribute. |
RETRIEVABLE_DISABLED |
Retrievable option disabled for an attribute. |
SearchableOption
The status of the searchable option of a catalog attribute.
Enums | |
---|---|
SEARCHABLE_OPTION_UNSPECIFIED |
Value used when unset. |
SEARCHABLE_ENABLED |
Searchable option enabled for an attribute. |
SEARCHABLE_DISABLED |
Searchable option disabled for an attribute. |
CollectUserEventRequest
Request message for CollectUserEvent method.
Fields | |
---|---|
parent |
Required. The parent catalog name, such as |
user_event |
Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. |
uri |
The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests. |
ets |
The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. |
raw_json |
An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only. |
Union field conversion_rule . The rule that can convert the raw_json to a user event. It is needed only when the raw_json is set. conversion_rule can be only one of the following: |
|
prebuilt_rule |
The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema. |
ColorInfo
The color information of a Product
.
Fields | |
---|---|
color_families[] |
The standard color families. Strongly recommended to use the following standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and "Mixed". Normally it is expected to have only 1 color family. May consider using single "Mixed" instead of multiple values. A maximum of 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property color. Schema.org property Product.color. |
colors[] |
The color display names, which may be different from standard color family names, such as the color aliases used in the website frontend. Normally it is expected to have only 1 color. May consider using single "Mixed" instead of multiple values. A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property color. Schema.org property Product.color. |
CompleteQueryRequest
Autocomplete parameters.
Fields | |
---|---|
catalog |
Required. Catalog for which the completion is performed. Full resource name of catalog, such as |
query |
Required. The query used to generate suggestions. The maximum number of allowed characters is 255. |
visitor_id |
Required field. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
language_codes[] |
Note that this field applies for The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. The maximum number of language codes is 3. |
device_type |
The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. Supported formats:
|
dataset |
Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through Current supported values:
|
max_suggestions |
Completion max suggestions. If left unset or set to 0, then will fallback to the configured value The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20. |
enable_attribute_suggestions |
If true, attribute suggestions are enabled and provided in the response. This field is only available for the "cloud-retail" dataset. |
entity |
The entity for customers who run multiple entities, domains, sites, or regions, for example, |
CompleteQueryResponse
Response of the autocomplete query.
Fields | |
---|---|
completion_results[] |
Results of the matching suggestions. The result list is ordered and the first result is top suggestion. |
attribution_token |
A unique complete token. This should be included in the |
recent_search_results[] |
Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This feature is only available when
Recent searches are deduplicated. More recent searches will be reserved when duplication happens. |
attribute_results |
A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset. Current supported keys:
|
AttributeResult
Resource that represents attribute results. The list of suggestions for the attribute.
Fields | |
---|---|
suggestions[] |
|
CompletionResult
Resource that represents completion results.
Fields | |
---|---|
suggestion |
The suggestion for the query. |
attributes |
Custom attributes for the suggestion term.
|
RecentSearchResult
Deprecated: Recent search of this user.
Fields | |
---|---|
recent_search |
The recent search query. |
CompletionConfig
Catalog level autocomplete config for customers to customize autocomplete feature's settings.
Fields | |
---|---|
name |
Required. Immutable. Fully qualified name |
matching_order |
Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified would suggest "red shoes". Currently supported values:
Default value: 'exact-prefix'. |
max_suggestions |
The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20. |
min_prefix_length |
The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20. |
auto_learning |
If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use |
suggestions_input_config |
Output only. The source data for the latest import of the autocomplete suggestion phrases. |
last_suggestions_import_operation |
Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use |
denylist_input_config |
Output only. The source data for the latest import of the autocomplete denylist phrases. |
last_denylist_import_operation |
Output only. Name of the LRO corresponding to the latest denylist import. Can use |
allowlist_input_config |
Output only. The source data for the latest import of the autocomplete allowlist phrases. |
last_allowlist_import_operation |
Output only. Name of the LRO corresponding to the latest allowlist import. Can use |
CompletionDataInputConfig
The input config source for completion data.
Fields | |
---|---|
Union field Supported
|
|
big_query_source |
Required. BigQuery input source. Add the IAM permission "BigQuery Data Viewer" for cloud-retail-customer-data-access@system.gserviceaccount.com before using this feature otherwise an error is thrown. |
CompletionDetail
Detailed completion information including completion attribution token and clicked completion info.
Fields | |
---|---|
completion_attribution_token |
Completion attribution token in |
selected_suggestion |
End user selected |
selected_position |
End user selected |
Condition
Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.
Fields | |
---|---|
query_terms[] |
A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator). |
active_time_range[] |
Range of time(s) specifying when Condition is active. Condition true if any time range matches. |
page_categories[] |
Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as |
QueryTerm
Query terms that we want to match on.
Fields | |
---|---|
value |
The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match. |
full_match |
Whether this is supposed to be a full or partial match. |
TimeRange
Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
Fields | |
---|---|
start_time |
Start of time range. Range is inclusive. |
end_time |
End of time range. Range is inclusive. |
Control
Configures dynamic metadata that can be linked to a ServingConfig
and affect search or recommendation results at serving time.
Fields | |
---|---|
name |
Immutable. Fully qualified name |
display_name |
Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown. |
associated_serving_config_ids[] |
Output only. List of Note the association is managed via the |
solution_types[] |
Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only |
search_solution_use_case[] |
Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to |
Union field A behavior/type must be specified on creation. Type cannot be changed once specified (e.g. A Rule control will always be a Rule control.). An INVALID_ARGUMENT will be returned if either condition is violated. |
|
rule |
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes". |
CreateControlRequest
Request for CreateControl method.
Fields | |
---|---|
parent |
Required. Full resource name of parent catalog. Format: |
control |
Required. The Control to create. |
control_id |
Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-_/. |
CreateModelMetadata
Metadata associated with a create operation.
Fields | |
---|---|
model |
The resource name of the model that this create applies to. Format: |
CreateModelRequest
Request for creating a model.
Fields | |
---|---|
parent |
Required. The parent resource under which to create the model. Format: |
model |
Required. The payload of the |
dry_run |
Optional. Whether to run a dry run to validate the request (without actually creating the model). |
CreateProductRequest
Request message for ProductService.CreateProduct
method.
Fields | |
---|---|
parent |
Required. The parent catalog resource name, such as |
product |
Required. The |
product_id |
Required. The ID to use for the If the caller does not have permission to create the This field must be unique among all This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
CreateServingConfigRequest
Request for CreateServingConfig method.
Fields | |
---|---|
parent |
Required. Full resource name of parent. Format: |
serving_config |
Required. The ServingConfig to create. |
serving_config_id |
Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-_/. |
CustomAttribute
A custom attribute that is not explicitly modeled in Product
.
Fields | |
---|---|
text[] |
The textual values of this custom attribute. For example, Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of |
numbers[] |
The numerical values of this custom attribute. For example, Exactly one of |
searchable |
This field is normally ignored unless This field is ignored in a Only set if type |
indexable |
This field is normally ignored unless This field is ignored in a See |
DeleteControlRequest
Request for DeleteControl method.
Fields | |
---|---|
name |
Required. The resource name of the Control to delete. Format: |
DeleteModelRequest
Request for deleting a model.
Fields | |
---|---|
name |
Required. The resource name of the |
DeleteProductRequest
Request message for ProductService.DeleteProduct
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to delete the If the The All inventory information for the named |
DeleteServingConfigRequest
Request for DeleteServingConfig method.
Fields | |
---|---|
name |
Required. The resource name of the ServingConfig to delete. Format: |
ExperimentInfo
Metadata for active A/B testing [Experiment][].
Fields | |
---|---|
experiment |
The fully qualified resource name of the experiment that provides the serving config under test, should an active experiment exist. For example: |
Union field experiment_metadata . Information associated with the specific experiment entity being recorded. experiment_metadata can be only one of the following: |
|
serving_config_experiment |
A/B test between existing Cloud Retail Search |
ServingConfigExperiment
Metadata for active serving config A/B tests.
Fields | |
---|---|
original_serving_config |
The fully qualified resource name of the original |
experiment_serving_config |
The fully qualified resource name of the serving config [Experiment.VariantArm.serving_config_id][] responsible for generating the search response. For example: |
ExportAnalyticsMetricsRequest
Request message for the ExportAnalyticsMetrics
method.
Fields | |
---|---|
catalog |
Required. Full resource name of the parent catalog. Expected format: |
output_config |
Required. The output location of the data. |
filter |
A filtering expression to specify restrictions on returned metrics. The expression is a sequence of terms. Each term applies a restriction to the returned metrics. Use this expression to restrict results to a specific time range. Currently we expect only one types of fields:
Some examples of valid filters expressions:
|
ExportAnalyticsMetricsResponse
Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Fields | |
---|---|
error_samples[] |
A sample of errors encountered while processing the request. |
errors_config |
This field is never set. |
output_result |
Output result indicating where the data were exported to. |
ExportErrorsConfig
Configuration of destination for Export related errors.
Fields | |
---|---|
Union field destination . Required. Errors destination. destination can be only one of the following: |
|
gcs_prefix |
Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded |
ExportMetadata
Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_time |
Operation create time. |
update_time |
Operation last update time. If the operation is done, this is also the finish time. |
FulfillmentInfo
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
Fields | |
---|---|
type |
The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values:
If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. |
place_ids[] |
The IDs for this A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 characters, matching the pattern |
GcsOutputResult
A Gcs output result.
Fields | |
---|---|
output_uri |
The uri of Gcs output |
GcsSource
Google Cloud Storage location for input content.
Fields | |
---|---|
input_uris[] |
Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, |
data_schema |
The schema to use when parsing the data from the source. Supported values for product imports:
Supported values for user events imports:
Supported values for control imports:
Supported values for catalog attribute imports:
|
GetAttributesConfigRequest
Request for CatalogService.GetAttributesConfig
method.
Fields | |
---|---|
name |
Required. Full AttributesConfig resource name. Format: |
GetCompletionConfigRequest
Request for CatalogService.GetCompletionConfig
method.
Fields | |
---|---|
name |
Required. Full CompletionConfig resource name. Format: |
GetControlRequest
Request for GetControl method.
Fields | |
---|---|
name |
Required. The resource name of the Control to get. Format: |
GetDefaultBranchRequest
Request message to show which branch is currently the default branch.
Fields | |
---|---|
catalog |
The parent catalog resource name, such as |
GetDefaultBranchResponse
Response message of CatalogService.GetDefaultBranch
.
Fields | |
---|---|
branch |
Full resource name of the branch id currently set as default branch. |
set_time |
The time when this branch is set to default. |
note |
This corresponds to |
GetModelRequest
Request for getting a model.
Fields | |
---|---|
name |
Required. The resource name of the |
GetProductRequest
Request message for ProductService.GetProduct
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to access the If the requested |
GetServingConfigRequest
Request for GetServingConfig method.
Fields | |
---|---|
name |
Required. The resource name of the ServingConfig to get. Format: |
Image
Product
image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.
Fields | |
---|---|
uri |
Required. URI of the image. This field must be a valid UTF-8 encoded URI with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property image_link. Schema.org property Product.image. |
height |
Height of the image in number of pixels. This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned. |
width |
Width of the image in number of pixels. This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned. |
ImportCompletionDataRequest
Request message for ImportCompletionData methods.
Fields | |
---|---|
parent |
Required. The catalog which the suggestions dataset belongs to. Format: |
input_config |
Required. The desired input location of the data. |
notification_pubsub_topic |
Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a |
ImportCompletionDataResponse
Response of the ImportCompletionDataRequest
. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.
Fields | |
---|---|
error_samples[] |
A sample of errors encountered while processing the request. |
ImportErrorsConfig
Configuration of destination for Import related errors.
Fields | |
---|---|
Union field destination . Required. Errors destination. destination can be only one of the following: |
|
gcs_prefix |
Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded |
ImportMetadata
Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_time |
Operation create time. |
update_time |
Operation last update time. If the operation is done, this is also the finish time. |
success_count |
Count of entries that were processed successfully. |
failure_count |
Count of entries that encountered errors while processing. |
request_id |
Deprecated. This field is never set. |
notification_pubsub_topic |
Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a |
ImportProductsRequest
Request message for Import methods.
Fields | |
---|---|
parent |
Required. If no updateMask is specified, requires products.create permission. If updateMask is specified, requires products.update permission. |
request_id |
Deprecated. This field has no effect. |
input_config |
Required. The desired input location of the data. |
errors_config |
The desired location of errors incurred during the Import. |
update_mask |
Indicates which fields in the provided imported |
reconciliation_mode |
The mode of reconciliation between existing products and the products to be imported. Defaults to |
notification_pubsub_topic |
Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Format of the Pub/Sub topic is Only supported when |
ReconciliationMode
Indicates how imported products are reconciled with the existing products created or imported before.
Enums | |
---|---|
RECONCILIATION_MODE_UNSPECIFIED |
Defaults to INCREMENTAL. |
INCREMENTAL |
Inserts new products or updates existing products. |
FULL |
Calculates diff and replaces the entire product dataset. Existing products may be deleted if they are not present in the source location. |
ImportProductsResponse
Response of the ImportProductsRequest
. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Fields | |
---|---|
error_samples[] |
A sample of errors encountered while processing the request. |
errors_config |
Echoes the destination for the complete errors in the request if set. |
ImportUserEventsRequest
Request message for the ImportUserEvents request.
Fields | |
---|---|
parent |
Required. |
input_config |
Required. The desired input location of the data. |
errors_config |
The desired location of errors incurred during the Import. Cannot be set for inline user event imports. |
ImportUserEventsResponse
Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Fields | |
---|---|
error_samples[] |
A sample of errors encountered while processing the request. |
errors_config |
Echoes the destination for the complete errors if this field was set in the request. |
import_summary |
Aggregated statistics of user event import status. |
Interval
A floating point interval.
Fields | |
---|---|
Union field This field must not be larger than max. Otherwise, an INVALID_ARGUMENT error is returned. |
|
minimum |
Inclusive lower bound. |
exclusive_minimum |
Exclusive lower bound. |
Union field This field must be not smaller than min. Otherwise, an INVALID_ARGUMENT error is returned. |
|
maximum |
Inclusive upper bound. |
exclusive_maximum |
Exclusive upper bound. |
ListCatalogsRequest
Request for CatalogService.ListCatalogs
method.
Fields | |
---|---|
parent |
Required. The account resource name with an associated location. If the caller does not have permission to list |
page_size |
Maximum number of If this field is negative, an INVALID_ARGUMENT is returned. |
page_token |
A page token When paginating, all other parameters provided to |
ListCatalogsResponse
Response for CatalogService.ListCatalogs
method.
Fields | |
---|---|
catalogs[] |
All the customer's |
next_page_token |
A token that can be sent as |
ListControlsRequest
Request for ListControls method.
Fields | |
---|---|
parent |
Required. The catalog resource name. Format: |
page_size |
Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
page_token |
Optional. A page token, received from a previous |
filter |
Optional. A filter to apply on the list results. Supported features:
|
ListControlsResponse
Response for ListControls method.
Fields | |
---|---|
controls[] |
All the Controls for a given catalog. |
next_page_token |
Pagination token, if not returned indicates the last page. |
ListModelsRequest
Request for listing models associated with a resource.
Fields | |
---|---|
parent |
Required. The parent for which to list models. Format: |
page_size |
Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
page_token |
Optional. A page token, received from a previous |
ListModelsResponse
Response to a ListModelRequest.
Fields | |
---|---|
models[] |
List of Models. |
next_page_token |
Pagination token, if not returned indicates the last page. |
ListProductsRequest
Request message for ProductService.ListProducts
method.
Fields | |
---|---|
parent |
Required. The parent branch resource name, such as If the caller does not have permission to list |
page_size |
Maximum number of If this field is negative, an INVALID_ARGUMENT error is returned. |
page_token |
A page token When paginating, all other parameters provided to |
filter |
A filter to apply on the list results. Supported features:
If the field is unrecognizable, an INVALID_ARGUMENT error is returned. If the specified |
read_mask |
The fields of If "*" is provided, all fields are returned. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. |
ListProductsResponse
Response message for ProductService.ListProducts
method.
Fields | |
---|---|
products[] |
The |
next_page_token |
A token that can be sent as |
ListServingConfigsRequest
Request for ListServingConfigs method.
Fields | |
---|---|
parent |
Required. The catalog resource name. Format: |
page_size |
Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. |
page_token |
Optional. A page token, received from a previous |
ListServingConfigsResponse
Response for ListServingConfigs method.
Fields | |
---|---|
serving_configs[] |
All the ServingConfigs for a given catalog. |
next_page_token |
Pagination token, if not returned indicates the last page. |
LocalInventory
The inventory information at a place (e.g. a store) identified by a place ID.
Fields | |
---|---|
place_id |
The place ID for the current set of inventory information. |
price_info |
Product price and cost information. Google Merchant Center property price. |
attributes |
Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:
|
fulfillment_types[] |
Input only. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values:
If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned. |
Model
Metadata that describes the training and serving parameters of a Model
. A Model
can be associated with a ServingConfig
and then queried through the Predict API.
Fields | |
---|---|
name |
Required. The fully qualified resource name of the model. Format: |
display_name |
Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters. |
training_state |
Optional. The training state that the model is in (e.g. Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for |
serving_state |
Output only. The serving state of the model: |
create_time |
Output only. Timestamp the Recommendation Model was created at. |
update_time |
Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated. |
type |
Required. The type of model e.g. Currently supported values: This field together with |
optimization_objective |
Optional. The optimization objective e.g. Currently supported values: If not specified, we choose default based on model type. Default depends on type of recommendation:
This field together with |
periodic_tuning_state |
Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the |
last_tune_time |
Output only. The timestamp when the latest successful tune finished. |
tuning_operation |
Output only. The tune operation associated with the model. Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on. |
data_state |
Output only. The state of data requirements for this model: Recommendation model cannot be trained if the data is in |
filtering_option |
Optional. If |
serving_config_lists[] |
Output only. The list of valid serving configs associated with the PageOptimizationConfig. |
model_features_config |
Optional. Additional model features config. |
ContextProductsType
Use single or multiple context products for recommendations.
Enums | |
---|---|
CONTEXT_PRODUCTS_TYPE_UNSPECIFIED |
Unspecified default value, should never be explicitly set. Defaults to MULTIPLE_CONTEXT_PRODUCTS . |
SINGLE_CONTEXT_PRODUCT |
Use only a single product as context for the recommendation. Typically used on pages like add-to-cart or product details. |
MULTIPLE_CONTEXT_PRODUCTS |
Use one or multiple products as context for the recommendation. Typically used on shopping cart pages. |
DataState
Describes whether this model have sufficient training data to be continuously trained.
Enums | |
---|---|
DATA_STATE_UNSPECIFIED |
Unspecified default value, should never be explicitly set. |
DATA_OK |
The model has sufficient training data. |
DATA_ERROR |
The model does not have sufficient training data. Error messages can be queried via Stackdriver. |
FrequentlyBoughtTogetherFeaturesConfig
Additional configs for the frequently-bought-together model type.
Fields | |
---|---|
context_products_type |
Optional. Specifies the context of the model when it is used in predict requests. Can only be set for the |
ModelFeaturesConfig
Additional model features config.
Fields | |
---|---|
Union field
|
|
frequently_bought_together_config |
Additional configs for frequently-bought-together models. |
PeriodicTuningState
Describes whether periodic tuning is enabled for this model or not. Periodic tuning is scheduled at most every three months. You can start a tuning process manually by using the TuneModel
method, which starts a tuning process immediately and resets the quarterly schedule. Enabling or disabling periodic tuning does not affect any current tuning processes.
Enums | |
---|---|
PERIODIC_TUNING_STATE_UNSPECIFIED |
Unspecified default value, should never be explicitly set. |
PERIODIC_TUNING_DISABLED |
The model has periodic tuning disabled. Tuning can be reenabled by calling the EnableModelPeriodicTuning method or by calling the TuneModel method. |
ALL_TUNING_DISABLED |
The model cannot be tuned with periodic tuning OR the TuneModel method. Hide the options in customer UI and reject any requests through the backend self serve API. |
PERIODIC_TUNING_ENABLED |
The model has periodic tuning enabled. Tuning can be disabled by calling the DisableModelPeriodicTuning method. |
ServingConfigList
Represents an ordered combination of valid serving configs, which can be used for PAGE_OPTIMIZATION
recommendations.
Fields | |
---|---|
serving_config_ids[] |
Optional. A set of valid serving configs that may be used for |
ServingState
The serving state of the model.
Enums | |
---|---|
SERVING_STATE_UNSPECIFIED |
Unspecified serving state. |
INACTIVE |
The model is not serving. |
ACTIVE |
The model is serving and can be queried. |
TUNED |
The model is trained on tuned hyperparameters and can be queried. |
TrainingState
The training state of the model.
Enums | |
---|---|
TRAINING_STATE_UNSPECIFIED |
Unspecified training state. |
PAUSED |
The model training is paused. |
TRAINING |
The model is training. |
OutputConfig
The output configuration setting.
Fields | |
---|---|
Union field destination . The configuration of destination for holding output data. destination can be only one of the following: |
|
gcs_destination |
The Google Cloud Storage location where the output is to be written to. |
bigquery_destination |
The BigQuery location where the output is to be written to. |
BigQueryDestination
The BigQuery output destination configuration.
Fields | |
---|---|
dataset_id |
Required. The ID of a BigQuery Dataset. |
table_id_prefix |
Required. The prefix of exported BigQuery tables. |
table_type |
Required. Describes the table type. The following values are supported:
|
GcsDestination
The Google Cloud Storage output destination configuration.
Fields | |
---|---|
output_uri_prefix |
Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: output_uri_prefix sample output(assuming the object is foo.json) ======================== ============================================= gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json |
OutputResult
Output result that stores the information about where the exported data is stored.
Fields | |
---|---|
bigquery_result[] |
The BigQuery location where the result is stored. |
gcs_result[] |
The Google Cloud Storage location where the result is stored. |
PauseModelRequest
Request for pausing training of a model.
Fields | |
---|---|
name |
Required. The name of the model to pause. Format: |
PredictRequest
Request message for Predict method.
Fields | |
---|---|
placement |
Required. Full resource name of the format: The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs |
user_event |
Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set |
page_size |
Maximum number of results to return. Set this property to the number of prediction results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100. |
page_token |
This field is not used; leave it unset. |
filter |
Filter for restricting prediction results with a length limit of 5,000 characters. Accepts values for tags and the
Note: "Recently viewed" models don't support tag filtering at the moment.
Examples:
If your filter blocks all prediction results, the API will return no results. If instead you want empty result sets to return generic (unfiltered) popular products, set If
For more information, see Filter recommendations. |
validate_only |
Use validate only mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary products. Note that the validate only mode should only be used for testing the API, or if the model is not ready. |
params |
Additional domain specific parameters for the predictions. Allowed values:
|
labels |
The labels applied to a resource must meet the following requirements:
See Google Cloud Document for more details. |
PredictResponse
Response message for predict method.
Fields | |
---|---|
results[] |
A list of recommended products. The order represents the ranking (from the most relevant product to the least). |
attribution_token |
A unique attribution token. This should be included in the |
missing_ids[] |
IDs of products in the request that were missing from the inventory. |
validate_only |
True if the validateOnly property was set in the request. |
PredictionResult
PredictionResult represents the recommendation prediction results.
Fields | |
---|---|
id |
ID of the recommended product |
metadata |
Additional product metadata / annotations. Possible values:
|
PriceInfo
The price information of a Product
.
Fields | |
---|---|
currency_code |
The 3-letter currency code defined in ISO 4217. If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The |
price |
Price of the product. Google Merchant Center property price. Schema.org property Offer.price. |
original_price |
Price of the product without any discount. If zero, by default set to be the |
cost |
The costs associated with the sale of a particular product. Used for gross profit reporting. Google Merchant Center property cost_of_goods_sold. |
price_effective_time |
The timestamp when the Do not set if |
price_expire_time |
The timestamp when the Do not set if |
price_range |
Output only. The price range of all the child Note: This field is OUTPUT_ONLY for |
PriceRange
The price range of all variant
Product
having the same Product.primary_product_id
.
Fields | |
---|---|
price |
The inclusive |
original_price |
The inclusive |
Product
Product captures all metadata information of items to be recommended or searched.
Fields | |
---|---|
name |
Immutable. Full resource name of the product, such as |
id |
Immutable. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property id. Schema.org property Product.sku. |
type |
Immutable. The type of the product. Default to |
primary_product_id |
Variant group identifier. Must be an For For VARIANT Corresponding properties: Google Merchant Center property item_group_id. Schema.org property Product.inProductGroupWithID. |
collection_member_ids[] |
The Non-existent product ids are allowed. The |
gtin |
The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property gtin. Schema.org property Product.isbn, Product.gtin8, Product.gtin12, Product.gtin13, or Product.gtin14. If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned. |
categories[] |
Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as:
Must be set for At most 250 values are allowed per Corresponding properties: Google Merchant Center property google_product_category. Schema.org property Product.category. |
title |
Required. Product title. This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property title. Schema.org property Product.name. |
brands[] |
The brands of the product. A maximum of 30 brands are allowed unless overridden through the Google Cloud console. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property brand. Schema.org property Product.brand. |
description |
Product description. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property description. Schema.org property Product.description. |
language_code |
Language of the title/description and other string attributes. Use language tags defined by BCP 47. For product prediction, this field is ignored and the model automatically detects the text language. The For product search this field is in use. It defaults to "en-US" if unset. |
attributes |
Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer. For example: This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:
|
tags[] |
Custom tags associated with the product. At most 250 values are allowed per This tag can be used for filtering recommendation results by passing the tag as part of the Corresponding properties: Google Merchant Center property custom_label_0–4. |
price_info |
Product price and cost information. Corresponding properties: Google Merchant Center property price. |
rating |
The rating of this product. |
available_time |
The timestamp when this |
availability |
The online availability of the For primary products with variants set the availability of the primary as For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property availability. Schema.org property Offer.availability. |
available_quantity |
The available quantity of the item. |
fulfillment_info[] |
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods. All the elements must have distinct |
uri |
Canonical URL directly linking to the product detail page. It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be significantly degraded. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property link. Schema.org property Offer.url. |
images[] |
Product images for the product. We highly recommend putting the main image first. A maximum of 300 images are allowed. Corresponding properties: Google Merchant Center property image_link. Schema.org property Product.image. |
audience |
The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product. |
color_info |
The color of the product. Corresponding properties: Google Merchant Center property color. Schema.org property Product.color. |
sizes[] |
The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Corresponding properties: Google Merchant Center property size, size_type, and size_system. Schema.org property Product.size. |
materials[] |
The material of the product. For example, "leather", "wooden". A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property material. Schema.org property Product.material. |
patterns[] |
The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley". A maximum of 20 values are allowed per Corresponding properties: Google Merchant Center property pattern. Schema.org property Product.pattern. |
conditions[] |
The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used". A maximum of 1 value is allowed per Corresponding properties: Google Merchant Center property condition. Schema.org property Offer.itemCondition. |
promotions[] |
The promotions applied to the product. A maximum of 10 values are allowed per |
publish_time |
The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from |
retrievable_fields |
Indicates which fields in the Supported fields for all
Supported fields only for Supported fields only for
To mark For For The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in This field is deprecated. Use the retrievable site-wide control instead. |
variants[] |
Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by Note: This field is OUTPUT_ONLY for |
local_inventories[] |
Output only. A list of local inventories specific to different places. This field can be managed by |
Union field
|
|
expire_time |
Note that this field is applied in the following ways:
In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness.
Corresponding properties: Google Merchant Center property expiration_date. |
ttl |
Input only. The TTL (time to live) of the product. Note that this is only applicable to If it is set, it must be a non-negative value, and If it is set, the product is not available for |
Availability
Product availability. If this field is unspecified, the product is assumed to be in stock.
Enums | |
---|---|
AVAILABILITY_UNSPECIFIED |
Default product availability. Default to Availability.IN_STOCK if unset. |
IN_STOCK |
Product in stock. |
OUT_OF_STOCK |
Product out of stock. |
PREORDER |
Product that is in pre-order state. |
BACKORDER |
Product that is back-ordered (i.e. temporarily out of stock). |
Type
The type of this product.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Default value. Default to Catalog.product_level_config.ingestion_product_type if unset. |
PRIMARY |
The primary type. As the primary unit for predicting, indexing and search serving, a |
VARIANT |
The variant type.
|
COLLECTION |
The collection type. Collection products are bundled Type.PRIMARY Product s or Type.VARIANT Product s that are sold together, such as a jewelry set with necklaces, earrings and rings, etc. |
ProductAttributeInterval
Product attribute name and numeric interval.
Fields | |
---|---|
name |
The attribute name (e.g. "length") |
interval |
The numeric interval (e.g. [10, 20)) |
ProductAttributeValue
Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have name=color
and value=red
, this means that the color is red
.
Fields | |
---|---|
name |
The attribute name. |
value |
The attribute value. |
ProductDetail
Detailed product information associated with a user event.
Fields | |
---|---|
product |
Required. Required field(s): Optional override field(s): If any supported optional fields are provided, we will treat them as a full override when looking up product information from the catalog. Thus, it is important to ensure that the overriding fields are accurate and complete. All other product fields are ignored and instead populated via catalog lookup after event ingestion. |
quantity |
Quantity of the product associated with the user event. For example, this field will be 2 if two products are added to the shopping cart for |
ProductInlineSource
The inline source for the input config for ImportProducts method.
Fields | |
---|---|
products[] |
Required. A list of products to update/create. Each product must have a valid |
ProductInputConfig
The input config source for products.
Fields | |
---|---|
Union field source . Required. The source of the input. source can be only one of the following: |
|
product_inline_source |
The Inline source for the input content for products. |
gcs_source |
Google Cloud Storage location for the input content. |
big_query_source |
BigQuery input source. |
ProductLevelConfig
Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.
Fields | |
---|---|
ingestion_product_type |
The type of
If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. If this field is See Product levels for more details. |
merchant_center_product_id_field |
Which field of Merchant Center Product should be imported as
If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. If this field is See Product levels for more details. |
Promotion
Promotion specification.
Fields | |
---|---|
promotion_id |
The value must be a UTF-8 encoded string with a length limit of 128 characters, and match the pattern: Corresponds to Google Merchant Center property promotion_id. |
PurchaseTransaction
A transaction represents the entire purchase transaction.
Fields | |
---|---|
id |
The transaction ID with a length limit of 128 characters. |
revenue |
Required. Total non-zero revenue or grand total associated with the transaction. This value include shipping, tax, or other adjustments to total revenue that you want to include as part of your revenue calculations. |
tax |
All the taxes associated with the transaction. |
cost |
All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: |
currency_code |
Required. Currency code. Use three-character ISO-4217 code. |
PurgeMetadata
This type has no fields.
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.
Fields | |
---|---|
create_time |
Operation create time. |
update_time |
Operation last update time. If the operation is done, this is also the finish time. |
success_count |
Count of entries that were deleted successfully. |
failure_count |
Count of entries that encountered errors while processing. |
PurgeProductsRequest
Request message for PurgeProducts method.
Fields | |
---|---|
parent |
Required. The resource name of the branch under which the products are created. The format is |
filter |
Required. The filter string to specify the products to be deleted with a length limit of 5,000 characters. Empty string filter is not allowed. "*" implies delete all items in a branch. The eligible fields for filtering are:
Supported syntax:
Examples queries: * Delete back order products created before a timestamp. create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER" |
force |
Actually perform the purge. If |
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.
Fields | |
---|---|
purge_count |
The total count of products purged as a result of the operation. |
purge_sample[] |
A sample of the product names that will be deleted. Only populated if |
PurgeUserEventsRequest
Request message for PurgeUserEvents method.
Fields | |
---|---|
parent |
Required. The resource name of the catalog under which the events are created. The format is |
filter |
Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. Empty string filter is not allowed. The eligible fields for filtering are:
Examples:
The filtering fields are assumed to have an implicit AND. |
force |
Actually perform the purge. If |
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.
Fields | |
---|---|
purged_events_count |
The total count of events purged as a result of the operation. |
Rating
The rating of a Product
.
Fields | |
---|---|
rating_count |
The total number of ratings. This value is independent of the value of This value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned. |
average_rating |
The average rating of the The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned. |
rating_histogram[] |
List of rating counts per rating value (index = rating - 1). The list is empty if there is no rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is returned. For example, [41, 14, 13, 47, 303]. It means that the |
RecommendationsFilteringOption
If filtering for recommendations is enabled.
Enums | |
---|---|
RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED |
Value used when unset. In this case, server behavior defaults to RECOMMENDATIONS_FILTERING_DISABLED . |
RECOMMENDATIONS_FILTERING_DISABLED |
Recommendation filtering is disabled. |
RECOMMENDATIONS_FILTERING_ENABLED |
Recommendation filtering is enabled. |
RejoinUserEventsMetadata
This type has no fields.
Metadata for RejoinUserEvents
method.
RejoinUserEventsRequest
Request message for RejoinUserEvents method.
Fields | |
---|---|
parent |
Required. The parent catalog resource name, such as |
user_event_rejoin_scope |
The type of the user event rejoin to define the scope and range of the user events to be rejoined with the latest product catalog. Defaults to |
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
.
Enums | |
---|---|
USER_EVENT_REJOIN_SCOPE_UNSPECIFIED |
Rejoin all events with the latest product catalog, including both joined events and unjoined events. |
JOINED_EVENTS |
Only rejoin joined events with the latest product catalog. |
UNJOINED_EVENTS |
Only rejoin unjoined events with the latest product catalog. |
RejoinUserEventsResponse
Response message for RejoinUserEvents
method.
Fields | |
---|---|
rejoined_user_events_count |
Number of user events that were joined with latest product catalog. |
RemoveCatalogAttributeRequest
Request for CatalogService.RemoveCatalogAttribute
method.
Fields | |
---|---|
attributes_config |
Required. Full AttributesConfig resource name. Format: |
key |
Required. The attribute name key of the |
RemoveControlRequest
Request for RemoveControl method.
Fields | |
---|---|
serving_config |
Required. The source ServingConfig resource name . Format: |
control_id |
Required. The id of the control to apply. Assumed to be in the same catalog as the serving config. |
RemoveFulfillmentPlacesMetadata
This type has no fields.
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.
Fields | |
---|---|
product |
Required. Full resource name of If the caller does not have permission to access the |
type |
Required. The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Supported values:
If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. This field directly corresponds to |
place_ids[] |
Required. The IDs for this At least 1 value is required, and a maximum of 2000 values are allowed. Each value must be a string with a length limit of 10 characters, matching the pattern |
remove_time |
The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information. If not provided, the internal system time will be used. |
allow_missing |
If set to true, and the |
RemoveFulfillmentPlacesResponse
This type has no fields.
Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.RemoveFulfillmentPlaces
method.
RemoveLocalInventoriesMetadata
This type has no fields.
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.
Fields | |
---|---|
product |
Required. Full resource name of If the caller does not have permission to access the |
place_ids[] |
Required. A list of place IDs to have their inventory deleted. At most 3000 place IDs are allowed per request. |
remove_time |
The time when the inventory deletions are issued. Used to prevent out-of-order updates and deletions on local inventory fields. If not provided, the internal system time will be used. |
allow_missing |
If set to true, and the |
RemoveLocalInventoriesResponse
This type has no fields.
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.
Fields | |
---|---|
attributes_config |
Required. Full AttributesConfig resource name. Format: |
catalog_attribute |
Required. The updated |
update_mask |
Indicates which fields in the provided If not set, all supported fields are updated. |
ResumeModelRequest
Request for resuming training of a model.
Fields | |
---|---|
name |
Required. The name of the model to resume. Format: |
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
withSOLUTION_TYPE_SEARCH
.
Fields | |
---|---|
condition |
Required. The condition that triggers the rule. If the condition is empty, the rule will always apply. |
Union field action . An action must be provided. action can be only one of the following: |
|
boost_action |
A boost action. |
redirect_action |
Redirects a shopper to a specific page. |
oneway_synonyms_action |
Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term. |
do_not_associate_action |
Prevents term from being associated with other terms. |
replacement_action |
Replaces specific terms in the query. |
ignore_action |
Ignores specific terms from query during search. |
filter_action |
Filters results. |
twoway_synonyms_action |
Treats a set of terms as synonyms of one another. |
force_return_facet_action |
Force returns an attribute as a facet in the request. |
remove_facet_action |
Remove an attribute as a facet in the request (if present). |
BoostAction
A boost action to apply to results matching condition specified above.
Fields | |
---|---|
boost |
Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. |
products_filter |
The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See Examples:
|
DoNotAssociateAction
Prevents query_term
from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".
Fields | |
---|---|
query_terms[] |
Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms. |
do_not_associate_terms[] |
Cannot contain duplicates or the query term. Can specify up to 100 terms. |
terms[] |
Will be [deprecated = true] post migration; |
FilterAction
Rule Condition:
- No
Condition.query_terms
provided is a global match. - 1 or more
Condition.query_terms
provided are combined with OR operator.
- No
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.
Fields | |
---|---|
filter |
A filter to apply on the matching condition results. Supported features:
|
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) orCondition.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.
Fields | |
---|---|
facet_position_adjustments[] |
Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. |
FacetPositionAdjustment
Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.
Fields | |
---|---|
attribute_name |
The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. |
position |
This is the position in the request as explained above. It should be strictly positive be at most 100. |
IgnoreAction
Prevents a term in the query from being used in search. Example: Don't search for "shoddy".
Fields | |
---|---|
ignore_terms[] |
Terms to ignore in the search query. |
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".
Fields | |
---|---|
query_terms[] |
Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms. |
synonyms[] |
Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms. |
oneway_terms[] |
Will be [deprecated = true] post migration; |
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.
Fields | |
---|---|
redirect_uri |
URL must have length equal or less than 2000 characters. |
RemoveFacetAction
Removes an attribute/facet in the request if is present.
Rule Condition: Must specify non-empty
Condition.query_terms
(for search only) orCondition.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).
Fields | |
---|---|
attribute_names[] |
The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters. |
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".
Fields | |
---|---|
query_terms[] |
Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms. |
replacement_term |
Term that will be used for replacement. |
term |
Will be [deprecated = true] post migration; |
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".
Fields | |
---|---|
synonyms[] |
Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. |
SearchRequest
Request message for SearchService.Search
method.
Fields | |
---|---|
placement |
Required. The resource name of the Retail Search serving config, such as |
branch |
The branch resource name, such as Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch. |
query |
Raw search query. If this field is empty, the request is considered a category browsing request and returned results are based on |
visitor_id |
Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
user_info |
User information. |
page_size |
Maximum number of If this field is negative, an INVALID_ARGUMENT is returned. |
page_token |
A page token When paginating, all other parameters provided to |
offset |
A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the If this field is negative, an INVALID_ARGUMENT is returned. |
filter |
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. For more information, see Filter. If this field is unrecognizable, an INVALID_ARGUMENT is returned. |
canonical_filter |
The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see |
order_by |
The order in which products are returned. Products can be ordered by a field in an If this field is unrecognizable, an INVALID_ARGUMENT is returned. |
facet_specs[] |
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. |
dynamic_facet_spec |
Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field. The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated. |
boost_spec |
Boost specification to boost certain products. For more information, see Boost results. Notice that if both |
query_expansion_spec |
The query expansion specification that specifies the conditions under which query expansion occurs. For more information, see Query expansion. |
variant_rollup_keys[] |
The keys to fetch and rollup the matching For Supported keys are:
If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. |
page_categories[] |
The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"]. |
search_mode |
The search mode of the search request. If not specified, a single search request triggers both product search and faceted search. |
personalization_spec |
The specification for personalization. Notice that if both |
labels |
The labels applied to a resource must meet the following requirements:
For more information, see Requirements for labels in the Resource Manager documentation. |
entity |
The entity for customers that may run multiple different entities, domains, sites or regions, for example, |
conversational_search_spec |
Optional. This field specifies all conversational related parameters addition to traditional retail search. |
tile_navigation_spec |
Optional. This field specifies tile navigation related parameters. |
spell_correction_spec |
The spell correction specification that specifies the mode under which spell correction will take effect. |
BoostSpec
Boost specification to boost certain items.
Fields | |
---|---|
condition_boost_specs[] |
Condition boost specifications. If a product matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. |
skip_boost_spec_validation |
Whether to skip boostspec validation. If this field is set to true, invalid |
ConditionBoostSpec
Boost applies to products which match a condition.
Fields | |
---|---|
condition |
An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See Examples:
|
boost |
Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. |
ConversationalSearchSpec
This field specifies all conversational related parameters addition to traditional retail search.
Fields | |
---|---|
followup_conversation_requested |
This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc. |
conversation_id |
This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous [ConversationalSearchResult.conversation_id][]. For the initial request, this should be empty. |
user_answer |
This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text. |
UserAnswer
This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.
Fields | |
---|---|
Union field type . This field specifies the type of user answer. type can be only one of the following: |
|
text_answer |
This field specifies the incremental input text from the user during the conversational search. |
selected_answer |
This field specifies the selected attributes during the conversational search. This should be a subset of [ConversationalSearchResult.suggested_answers][]. |
SelectedAnswer
This field specifies the selected answers during the conversational search.
Fields | |
---|---|
product_attribute_values[] |
This field is deprecated and should not be set. |
product_attribute_value |
This field specifies the selected answer which is a attribute key-value. |
DynamicFacetSpec
The specifications of dynamically generated facets.
Fields | |
---|---|
mode |
Mode of the DynamicFacet feature. Defaults to |
Mode
Enum to control DynamicFacet mode
Enums | |
---|---|
MODE_UNSPECIFIED |
Default value. |
DISABLED |
Disable Dynamic Facet. |
ENABLED |
Automatic mode built by Google Retail Search. |
FacetSpec
A facet specification to perform faceted search.
Fields | |
---|---|
facet_key |
Required. The facet key specification. |
limit |
Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned. |
excluded_filter_keys[] |
List of keys to exclude when faceting. By default, Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. |
enable_dynamic_position |
Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. < |