API Reference google_api_retail v0.3.0
Modules
API client metadata for GoogleApi.Retail.V2.
API calls for all endpoints tagged Projects.
Handle Tesla connections for GoogleApi.Retail.V2.
Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
A description of the context in which an error occurred.
An error log which is reported to the Error Reporting system. This proto a superset of google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent.
HTTP request data that is related to a reported error.
The error payload that is populated on LRO import APIs. Including: "google.cloud.retail.v2.ProductService.ImportProducts" "google.cloud.retail.v2.EventService.ImportUserEvents"
Describes a running service that sends errors.
Indicates a location in the source code of the service for which errors are reported.
Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the AddFulfillmentPlaces method.
Request message for AddFulfillmentPlaces method.
Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the AddFulfillmentPlaces method.
An intended audience of the Product for whom it's sold.
BigQuery source import data from.
The catalog configuration.
The color information of a Product.
Response of the auto-complete query.
Resource that represents completion results.
Recent search of this user.
The input config source for completion data.
Detailed completion information including completion attribution token and clicked completion info.
A custom attribute that is not explicitly modeled in Product.
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
Google Cloud Storage location for input content. format.
Response message of CatalogService.GetDefaultBranch.
Product thumbnail/detail image.
Request message for ImportCompletionData methods.
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.
Configuration of destination for Import related errors.
Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.
Request message for Import methods.
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.
Request message for the ImportUserEvents request.
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.
A floating point interval.
Response for CatalogService.ListCatalogs method.
Response message for ProductService.ListProducts method.
Request message for Predict method.
Response message for predict method.
PredictionResult represents the recommendation prediction results.
The price information of a Product.
The price range of all variant Product having the same Product.primary_product_id.
Product captures all metadata information of items to be recommended or searched.
Detailed product information associated with a user event.
The inline source for the input config for ImportProducts method.
The input config source for products.
Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.
Promotion information.
A transaction represents the entire purchase transaction.
Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.
Request message for PurgeUserEvents method.
Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
The rating of a Product.
Metadata for RejoinUserEvents method.
Request message for RejoinUserEvents method.
Response message for RejoinUserEvents method.
Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the RemoveFulfillmentPlaces method.
Request message for RemoveFulfillmentPlaces method.
Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the RemoveFulfillmentPlaces method.
Request message for SearchService.Search method.
Boost specification to boost certain items.
Boost applies to products which match a condition.
The specifications of dynamically generated facets.
A facet specification to perform faceted search.
Specifies how a facet is computed.
Specification to determine under which conditions query expansion should occur.
Response message for SearchService.Search method.
A facet result.
A facet value which contains value names and their count.
Information describing query expansion including whether expansion has occurred.
Represents the search results.
Request message to set a specified branch as new default_branch.
Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the SetInventory method.
Request message for SetInventory method.
Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the SetInventory method.
UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
A summary of import result. The UserEventImportSummary summarizes the import status for user events.
The inline source for the input config for ImportUserEvents method.
The input config source for user events.
Information of an end user.
Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the AddFulfillmentPlaces method.
Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the AddFulfillmentPlaces method.
Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the AddLocalInventories method.
Response of the AddLocalInventories API. Currently empty because there is no meaningful response populated from the AddLocalInventories method.
Configuration of destination for Export related errors.
Metadata related to the progress of the Export operation. This will be returned by the google.longrunning.Operation.metadata field.
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.
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.
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.
Configuration of destination for Import related errors.
Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.
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.
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.
Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.
Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
Metadata for RejoinUserEvents method.
Response message for RejoinUserEvents method.
Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the RemoveFulfillmentPlaces method.
Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the RemoveFulfillmentPlaces method.
Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the RemoveLocalInventories method.
Response of the RemoveLocalInventories API. Currently empty because there is no meaningful response populated from the RemoveLocalInventories method.
Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the SetInventory method.
Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the SetInventory method.
A summary of import result. The UserEventImportSummary summarizes the import status for user events.
Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the AddFulfillmentPlaces method.
Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the AddFulfillmentPlaces method.
Configuration of destination for Export related errors.
Metadata related to the progress of the Export operation. This will be returned by the google.longrunning.Operation.metadata field.
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.
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.
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.
Configuration of destination for Import related errors.
Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.
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.
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.
Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.
Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
Metadata for RejoinUserEvents method.
Response message for RejoinUserEvents method.
Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the RemoveFulfillmentPlaces method.
Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the RemoveFulfillmentPlaces method.
Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the SetInventory method.
Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the SetInventory method.
A summary of import result. The UserEventImportSummary summarizes the import status for user events.
The response message for Operations.ListOperations.
This resource represents a long-running operation that is the result of a network API call.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values A month and day value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp.