Index
CatalogService(interface)CompletionService(interface)ControlService(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)BatchRemoveCatalogAttributesRequest(message)BatchRemoveCatalogAttributesResponse(message)BigQueryOutputResult(message)BigQuerySource(message)Catalog(message)CatalogAttribute(message)CatalogAttribute.AttributeType(enum)CatalogAttribute.DynamicFacetableOption(enum)CatalogAttribute.ExactSearchableOption(enum)CatalogAttribute.IndexableOption(enum)CatalogAttribute.SearchableOption(enum)CollectUserEventRequest(message)ColorInfo(message)CompleteQueryRequest(message)CompleteQueryResponse(message)CompleteQueryResponse.CompletionResult(message)CompleteQueryResponse.RecentSearchResult(message)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)ExportErrorsConfig(message)ExportMetadata(message)ExportProductsResponse(message)ExportUserEventsResponse(message)FulfillmentInfo(message)GcsSource(message)GetAttributesConfigRequest(message)GetCompletionConfigRequest(message)GetControlRequest(message)GetDefaultBranchRequest(message)GetDefaultBranchResponse(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)MerchantCenterFeedFilter(message)MerchantCenterLink(message)MerchantCenterLinkingConfig(message)Model(message)Model.DataState(enum)Model.PageOptimizationConfig(message)Model.PageOptimizationConfig.Candidate(message)Model.PageOptimizationConfig.Panel(message)Model.PageOptimizationConfig.Restriction(enum)Model.PeriodicTuningState(enum)Model.ServingConfigList(message)Model.ServingState(enum)Model.TrainingState(enum)OutputResult(message)PauseModelRequest(message)PredictRequest(message)PredictResponse(message)PredictResponse.PredictionResult(message)PriceInfo(message)PriceInfo.PriceRange(message)Product(message)Product.Availability(enum)Product.Type(enum)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.IgnoreAction(message)Rule.OnewaySynonymsAction(message)Rule.RedirectAction(message)Rule.ReplacementAction(message)Rule.TwowaySynonymsAction(message)SearchRequest(message)SearchRequest.BoostSpec(message)SearchRequest.BoostSpec.ConditionBoostSpec(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.RelevanceThreshold(enum)SearchRequest.SearchMode(enum)SearchRequest.SpellCorrectionSpec(message)SearchRequest.SpellCorrectionSpec.Mode(enum)SearchResponse(message)SearchResponse.Facet(message)SearchResponse.Facet.FacetValue(message)SearchResponse.QueryExpansionInfo(message)SearchResponse.SearchResult(message)SearchSolutionUseCase(enum)ServingConfig(message)ServingConfig.DiversityType(enum)SetDefaultBranchRequest(message)SetInventoryMetadata(message)SetInventoryRequest(message)SetInventoryResponse(message)SolutionType(enum)TransformedUserEventsMetadata(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)
CatalogService
Service for managing catalog configuration.
| AddCatalogAttribute |
|---|
|
Adds the specified If the
|
| BatchRemoveCatalogAttributes |
|---|
|
Removes all specified
|
| 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
Auto-completion 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.
|
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.
|
| 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 |
|---|
|
Incrementally adds place IDs to This process is asynchronous and does not require the The returned If conflicting updates are issued, the This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
|
| 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 This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
|
| 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 |
|---|
|
Incrementally removes place IDs from a This process is asynchronous and does not require the The returned If conflicting updates are issued, the This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
|
| 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 This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
|
| 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 This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
|
| 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
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
Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces method.
AddLocalInventoriesMetadata
Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddLocalInventories method.
AddLocalInventoriesRequest
Request message for ProductService.AddLocalInventories method.
| 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
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. |
BatchRemoveCatalogAttributesRequest
Request for CatalogService.BatchRemoveCatalogAttributes method.
| Fields | |
|---|---|
attributes_config |
Required. The attributes config resource shared by all catalog attributes being deleted. Format: |
attribute_keys[] |
Required. The attribute name keys of the |
BatchRemoveCatalogAttributesResponse
Response of the CatalogService.BatchRemoveCatalogAttributes.
| Fields | |
|---|---|
deleted_catalog_attributes[] |
Catalog attributes that were deleted. Only pre-loaded |
reset_catalog_attributes[] |
Catalog attributes that were reset. |
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 auto-completion imports:
|
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. |
merchant_center_linking_config |
The Merchant Center linking configuration. Once a link is added, the data stream from Merchant Center to Cloud Retail will be enabled automatically. The requester must have access to the merchant center account in order to make changes to this field. |
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: |
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, otherwise throws INVALID_FORMAT error. |
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, otherwise throws INVALID_FORMAT error. |
recommendations_filtering_option |
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. |
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. Defaults to EXACT_SEARCHABLE_DISABLED. |
EXACT_SEARCHABLE_ENABLED |
Exact searchable option enabled for an attribute. |
EXACT_SEARCHABLE_DISABLED |
Exact searchable option disabled for an attribute. |
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. |
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. |
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 25 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
Auto-complete 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. |
CompleteQueryResponse
Response of the auto-complete 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[] |
Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. Contact Retail Search support team if you are interested in enabling it. This feature is only available when
Recent searches are deduplicated. More recent searches will be reserved when duplication happens. |
CompletionResult
Resource that represents completion results.
| Fields | |
|---|---|
suggestion |
The suggestion for the query. |
attributes |
Custom attributes for the suggestion term.
|
RecentSearchResult
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 | |
|---|---|
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. |
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. |
|
facet_spec |
A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control. |
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: |
ExportErrorsConfig
Configuration of destination for Export related errors.
| Fields | |
|---|---|
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. |
ExportProductsResponse
Response of the ExportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
| 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. |
ExportUserEventsResponse
Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
| 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. |
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 |
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 |
|---|