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.RetrievableOption(enum)CatalogAttribute.SearchableOption(enum)CollectUserEventRequest(message)ColorInfo(message)CompleteQueryRequest(message)CompleteQueryResponse(message)CompleteQueryResponse.AttributeResult(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)ExperimentInfo(message)ExperimentInfo.ServingConfigExperiment(message)ExportErrorsConfig(message)ExportMetadata(message)ExportProductsResponse(message)ExportUserEventsResponse(message)FulfillmentInfo(message)GcsOutputResult(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
|
| 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 |
|---|
|
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
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. |