google-cloud-retail-v2 0.3.2 → 0.5.0

data/proto_docs/google/cloud/retail/v2/product.rb

@@ -23,6 +23,40 @@ module Google
       module V2
         # Product captures all metadata information of items to be recommended or
         # searched.
+        # @!attribute [rw] expire_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The timestamp when this product becomes unavailable for
+        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
+        #
+        #     If it is set, the {::Google::Cloud::Retail::V2::Product Product} is not
+        #     available for
+        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search} after
+        #     {::Google::Cloud::Retail::V2::Product#expire_time expire_time}. However, the
+        #     product can still be retrieved by
+        #     {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
+        #     and
+        #     {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
+        #
+        #     Google Merchant Center property
+        #     [expiration_date](https://support.google.com/merchants/answer/6324499).
+        # @!attribute [rw] ttl
+        #   @return [::Google::Protobuf::Duration]
+        #     Input only. The TTL (time to live) of the product.
+        #
+        #     If it is set, {::Google::Cloud::Retail::V2::Product#expire_time expire_time}
+        #     is set as current timestamp plus
+        #     {::Google::Cloud::Retail::V2::Product#ttl ttl}. The derived
+        #     {::Google::Cloud::Retail::V2::Product#expire_time expire_time} is returned in
+        #     the output and {::Google::Cloud::Retail::V2::Product#ttl ttl} is left blank
+        #     when retrieving the {::Google::Cloud::Retail::V2::Product Product}.
+        #
+        #     If it is set, the product is not available for
+        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search} after
+        #     current timestamp plus {::Google::Cloud::Retail::V2::Product#ttl ttl}.
+        #     However, the product can still be retrieved by
+        #     {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
+        #     and
+        #     {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
         # @!attribute [rw] name
         #   @return [::String]
         #     Immutable. Full resource name of the product, such as
@@ -45,7 +79,9 @@ module Google
         #     Property [Product.sku](https://schema.org/sku).
         # @!attribute [rw] type
         #   @return [::Google::Cloud::Retail::V2::Product::Type]
-        #     Immutable. The type of the product. This field is output-only.
+        #     Immutable. The type of the product. Default to
+        #     {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
+        #     if unset.
         # @!attribute [rw] primary_product_id
         #   @return [::String]
         #     Variant group identifier. Must be an
@@ -69,6 +105,31 @@ module Google
         #
         #     This field must be enabled before it can be used. [Learn
         #     more](/recommendations-ai/docs/catalog#item-group-id).
+        # @!attribute [rw] collection_member_ids
+        #   @return [::Array<::String>]
+        #     The {::Google::Cloud::Retail::V2::Product#id id} of the collection members when
+        #     {::Google::Cloud::Retail::V2::Product#type type} is
+        #     {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Type.COLLECTION}.
+        #
+        #     Should not set it for other types. A maximum of 1000 values are allowed.
+        #     Otherwise, an INVALID_ARGUMENT error is return.
+        # @!attribute [rw] gtin
+        #   @return [::String]
+        #     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.
+        #
+        #     Google Merchant Center property
+        #     [gtin](https://support.google.com/merchants/answer/6324461).
+        #     Schema.org property
+        #     [Product.isbn](https://schema.org/isbn) or
+        #     [Product.gtin8](https://schema.org/gtin8) or
+        #     [Product.gtin12](https://schema.org/gtin12) or
+        #     [Product.gtin13](https://schema.org/gtin13) or
+        #     [Product.gtin14](https://schema.org/gtin14).
+        #
+        #     If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.
         # @!attribute [rw] categories
         #   @return [::Array<::String>]
         #     Product categories. This field is repeated for supporting one product
@@ -109,12 +170,23 @@ module Google
         #   @return [::String]
         #     Required. Product title.
         #
-        #     This field must be a UTF-8 encoded string with a length limit of 128
+        #     This field must be a UTF-8 encoded string with a length limit of 1,000
         #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
         #
         #     Google Merchant Center property
         #     [title](https://support.google.com/merchants/answer/6324415). Schema.org
         #     property [Product.name](https://schema.org/name).
+        # @!attribute [rw] brands
+        #   @return [::Array<::String>]
+        #     The brands of the product.
+        #
+        #     A maximum of 30 brands are allowed. Each brand must be a UTF-8 encoded
+        #     string with a length limit of 1,000 characters. Otherwise, an
+        #     INVALID_ARGUMENT error is returned.
+        #
+        #     Google Merchant Center property
+        #     [brand](https://support.google.com/merchants/answer/6324351). Schema.org
+        #     property [Product.brand](https://schema.org/brand).
         # @!attribute [rw] description
         #   @return [::String]
         #     Product description.
@@ -125,6 +197,18 @@ module Google
         #     Google Merchant Center property
         #     [description](https://support.google.com/merchants/answer/6324468).
         #     schema.org property [Product.description](https://schema.org/description).
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     Language of the title/description and other string attributes. Use language
+        #     tags defined by [BCP 47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
+        #
+        #     For product prediction, this field is ignored and the model automatically
+        #     detects the text language. The {::Google::Cloud::Retail::V2::Product Product}
+        #     can include text in different languages, but duplicating
+        #     {::Google::Cloud::Retail::V2::Product Product}s to provide text in multiple
+        #     languages can result in degraded model performance.
+        #
+        #     For product search this field is in use. It defaults to "en-US" if unset.
         # @!attribute [rw] attributes
         #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}]
         #     Highly encouraged. Extra product attributes to be included. For example,
@@ -143,11 +227,14 @@ module Google
         #     "lengths_cm": \\{"numbers":[2.3, 15.4]}, "heights_cm": \\{"numbers":[8.1, 6.4]}
         #     }`.
         #
-        #     A maximum of 150 attributes are allowed. Otherwise, an INVALID_ARGUMENT
-        #     error is returned.
+        #     This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
+        #     error is returned:
         #
-        #     The key must be a UTF-8 encoded string with a length limit of 5,000
-        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        #     * Max entries count: 200.
+        #     * The key must be a UTF-8 encoded string with a length limit of 128
+        #       characters.
+        #     * For indexable attribute, the key must match the pattern:
+        #       [a-zA-Z0-9][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.
         # @!attribute [rw] tags
         #   @return [::Array<::String>]
         #     Custom tags associated with the product.
@@ -169,10 +256,14 @@ module Google
         #
         #     Google Merchant Center property
         #     [price](https://support.google.com/merchants/answer/6324371).
+        # @!attribute [rw] rating
+        #   @return [::Google::Cloud::Retail::V2::Rating]
+        #     The rating of this product.
         # @!attribute [rw] available_time
         #   @return [::Google::Protobuf::Timestamp]
         #     The timestamp when this {::Google::Cloud::Retail::V2::Product Product} becomes
-        #     available recommendation and search.
+        #     available for
+        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
         # @!attribute [rw] availability
         #   @return [::Google::Cloud::Retail::V2::Product::Availability]
         #     The online availability of the {::Google::Cloud::Retail::V2::Product Product}.
@@ -185,10 +276,21 @@ module Google
         # @!attribute [rw] available_quantity
         #   @return [::Google::Protobuf::Int32Value]
         #     The available quantity of the item.
+        # @!attribute [rw] fulfillment_info
+        #   @return [::Array<::Google::Cloud::Retail::V2::FulfillmentInfo>]
+        #     Fulfillment information, such as the store IDs for in-store pickup or
+        #     region IDs for different shipping methods.
+        #
+        #     All the elements must have distinct
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}.
+        #     Otherwise, an INVALID_ARGUMENT error is returned.
         # @!attribute [rw] uri
         #   @return [::String]
         #     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.
         #
@@ -197,13 +299,166 @@ module Google
         #     property [Offer.url](https://schema.org/url).
         # @!attribute [rw] images
         #   @return [::Array<::Google::Cloud::Retail::V2::Image>]
-        #     Product images for the product.
+        #     Product images for the product.Highly recommended to put the main image
+        #     to the first.
         #
         #     A maximum of 300 images are allowed.
         #
         #     Google Merchant Center property
         #     [image_link](https://support.google.com/merchants/answer/6324350).
         #     Schema.org property [Product.image](https://schema.org/image).
+        # @!attribute [rw] audience
+        #   @return [::Google::Cloud::Retail::V2::Audience]
+        #     The target group associated with a given audience (e.g. male, veterans,
+        #     car owners, musicians, etc.) of the product.
+        # @!attribute [rw] color_info
+        #   @return [::Google::Cloud::Retail::V2::ColorInfo]
+        #     The color of the product.
+        #
+        #     Google Merchant Center property
+        #     [color](https://support.google.com/merchants/answer/6324487). Schema.org
+        #     property [Product.color](https://schema.org/color).
+        # @!attribute [rw] sizes
+        #   @return [::Array<::String>]
+        #     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
+        #     {::Google::Cloud::Retail::V2::Product Product}. 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
+        #     [size](https://support.google.com/merchants/answer/6324492),
+        #     [size_type](https://support.google.com/merchants/answer/6324497) and
+        #     [size_system](https://support.google.com/merchants/answer/6324502).
+        #     Schema.org property [Product.size](https://schema.org/size).
+        # @!attribute [rw] materials
+        #   @return [::Array<::String>]
+        #     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 128 characters. Otherwise, an
+        #     INVALID_ARGUMENT error is returned.
+        #
+        #     Google Merchant Center property
+        #     [material](https://support.google.com/merchants/answer/6324410). Schema.org
+        #     property [Product.material](https://schema.org/material).
+        # @!attribute [rw] patterns
+        #   @return [::Array<::String>]
+        #     The pattern or graphic print of the product. For example, "striped", "polka
+        #     dot", "paisley".
+        #
+        #     A maximum of 5 values are allowed per
+        #     {::Google::Cloud::Retail::V2::Product Product}. 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
+        #     [pattern](https://support.google.com/merchants/answer/6324483). Schema.org
+        #     property [Product.pattern](https://schema.org/pattern).
+        # @!attribute [rw] conditions
+        #   @return [::Array<::String>]
+        #     The condition of the product. Strongly encouraged to use the standard
+        #     values: "new", "refurbished", "used".
+        #
+        #     A maximum of 5 values are allowed per
+        #     {::Google::Cloud::Retail::V2::Product Product}. 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
+        #     [condition](https://support.google.com/merchants/answer/6324469).
+        #     Schema.org property
+        #     [Offer.itemCondition](https://schema.org/itemCondition).
+        # @!attribute [rw] promotions
+        #   @return [::Array<::Google::Cloud::Retail::V2::Promotion>]
+        #     The promotions applied to the product. A maximum of 10 values are allowed
+        #     per {::Google::Cloud::Retail::V2::Product Product}.
+        # @!attribute [rw] publish_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     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
+        #     {::Google::Cloud::Retail::V2::Product#available_time available_time}, given it
+        #     purely describes product freshness regardless of when it is available on
+        #     search and recommendation.
+        # @!attribute [rw] retrievable_fields
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which fields in the {::Google::Cloud::Retail::V2::Product Product}s
+        #     are returned in {::Google::Cloud::Retail::V2::SearchResponse SearchResponse}.
+        #
+        #     Supported fields for all {::Google::Cloud::Retail::V2::Product#type type}s:
+        #
+        #     * {::Google::Cloud::Retail::V2::Product#audience audience}
+        #     * {::Google::Cloud::Retail::V2::Product#availability availability}
+        #     * {::Google::Cloud::Retail::V2::Product#brands brands}
+        #     * {::Google::Cloud::Retail::V2::Product#color_info color_info}
+        #     * {::Google::Cloud::Retail::V2::Product#conditions conditions}
+        #     * {::Google::Cloud::Retail::V2::Product#gtin gtin}
+        #     * {::Google::Cloud::Retail::V2::Product#materials materials}
+        #     * {::Google::Cloud::Retail::V2::Product#name name}
+        #     * {::Google::Cloud::Retail::V2::Product#patterns patterns}
+        #     * {::Google::Cloud::Retail::V2::Product#price_info price_info}
+        #     * {::Google::Cloud::Retail::V2::Product#rating rating}
+        #     * {::Google::Cloud::Retail::V2::Product#sizes sizes}
+        #     * {::Google::Cloud::Retail::V2::Product#title title}
+        #     * {::Google::Cloud::Retail::V2::Product#uri uri}
+        #
+        #     Supported fields only for
+        #     {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY} and
+        #     {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Type.COLLECTION}:
+        #
+        #     * {::Google::Cloud::Retail::V2::Product#categories categories}
+        #     * {::Google::Cloud::Retail::V2::Product#description description}
+        #     * {::Google::Cloud::Retail::V2::Product#images images}
+        #
+        #     Supported fields only for
+        #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}:
+        #
+        #     * Only the first image in {::Google::Cloud::Retail::V2::Product#images images}
+        #
+        #     To mark {::Google::Cloud::Retail::V2::Product#attributes attributes} as
+        #     retrievable, include paths of the form "attributes.key" where "key" is the
+        #     key of a custom attribute, as specified in
+        #     {::Google::Cloud::Retail::V2::Product#attributes attributes}.
+        #
+        #     For {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY} and
+        #     {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Type.COLLECTION}, the
+        #     following fields are always returned in
+        #     {::Google::Cloud::Retail::V2::SearchResponse SearchResponse} by default:
+        #
+        #     * {::Google::Cloud::Retail::V2::Product#name name}
+        #
+        #     For {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}, the
+        #     following fields are always returned in by default:
+        #
+        #     * {::Google::Cloud::Retail::V2::Product#name name}
+        #     * {::Google::Cloud::Retail::V2::Product#color_info color_info}
+        #
+        #     Maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is
+        #     returned.
+        #
+        #     Note: Returning more fields in
+        #     {::Google::Cloud::Retail::V2::SearchResponse SearchResponse} may increase
+        #     response payload size and serving latency.
+        # @!attribute [r] variants
+        #   @return [::Array<::Google::Cloud::Retail::V2::Product>]
+        #     Output only. Product variants grouped together on primary product which
+        #     share similar product attributes. It's automatically grouped by
+        #     {::Google::Cloud::Retail::V2::Product#primary_product_id primary_product_id} for
+        #     all the product variants. Only populated for
+        #     {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
+        #     {::Google::Cloud::Retail::V2::Product Product}s.
+        #
+        #     Note: This field is OUTPUT_ONLY for
+        #     {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}.
+        #     Do not set this field in API requests.
         class Product
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -220,7 +475,8 @@ module Google
           # The type of this product.
           module Type
             # Default value. Default to
-            # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY} if unset.
+            # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
+            # if unset.
             TYPE_UNSPECIFIED = 0
 
             # The primary type.

data/proto_docs/google/cloud/retail/v2/product_service.rb

@@ -78,8 +78,10 @@ module Google
         #     {::Google::Cloud::Retail::V2::Product Product}, regardless of whether or not it
         #     exists, a PERMISSION_DENIED error is returned.
         #
-        #     If the {::Google::Cloud::Retail::V2::Product Product} to update does not exist,
-        #     a NOT_FOUND error is returned.
+        #     If the {::Google::Cloud::Retail::V2::Product Product} to update does not exist
+        #     and
+        #     {::Google::Cloud::Retail::V2::UpdateProductRequest#allow_missing allow_missing}
+        #     is not set, a NOT_FOUND error is returned.
         # @!attribute [rw] update_mask
         #   @return [::Google::Protobuf::FieldMask]
         #     Indicates which fields in the provided
@@ -89,6 +91,11 @@ module Google
         #
         #     If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
         #     is returned.
+        # @!attribute [rw] allow_missing
+        #   @return [::Boolean]
+        #     If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
+        #     found, a new {::Google::Cloud::Retail::V2::Product Product} will be created. In
+        #     this situation, `update_mask` is ignored.
         class UpdateProductRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -107,10 +114,363 @@ module Google
         #
         #     If the {::Google::Cloud::Retail::V2::Product Product} to delete does not exist,
         #     a NOT_FOUND error is returned.
+        #
+        #     The {::Google::Cloud::Retail::V2::Product Product} to delete can neither be a
+        #     {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Product.Type.COLLECTION}
+        #     {::Google::Cloud::Retail::V2::Product Product} member nor a
+        #     {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Product.Type.PRIMARY}
+        #     {::Google::Cloud::Retail::V2::Product Product} with more than one
+        #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT variants}. Otherwise, an
+        #     INVALID_ARGUMENT error is returned.
+        #
+        #     All inventory information for the named
+        #     {::Google::Cloud::Retail::V2::Product Product} will be deleted.
         class DeleteProductRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent branch resource name, such as
+        #     `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use
+        #     `default_branch` as the branch ID, to list products under the default
+        #     branch.
+        #
+        #     If the caller does not have permission to list
+        #     {::Google::Cloud::Retail::V2::Product Product}s under this branch, regardless of
+        #     whether or not this branch exists, a PERMISSION_DENIED error is returned.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Maximum number of {::Google::Cloud::Retail::V2::Product Product}s to return. If
+        #     unspecified, defaults to 100. The maximum allowed value is 1000. Values
+        #     above 1000 will be coerced to 1000.
+        #
+        #     If this field is negative, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token
+        #     {::Google::Cloud::Retail::V2::ListProductsResponse#next_page_token ListProductsResponse.next_page_token},
+        #     received from a previous
+        #     {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}
+        #     call. Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to
+        #     {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}
+        #     must match the call that provided the page token. Otherwise, an
+        #     INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     A filter to apply on the list results. Supported features:
+        #
+        #     * List all the products under the parent branch if
+        #     {::Google::Cloud::Retail::V2::ListProductsRequest#filter filter} is unset.
+        #     * List {::Google::Cloud::Retail::V2::Product::Type::VARIANT Product.Type.VARIANT}
+        #     {::Google::Cloud::Retail::V2::Product Product}s sharing the same
+        #       {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Product.Type.PRIMARY}
+        #       {::Google::Cloud::Retail::V2::Product Product}. For example:
+        #         `primary_product_id = "some_product_id"`
+        #     * List {::Google::Cloud::Retail::V2::Product Product}s bundled in a
+        #     {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Product.Type.COLLECTION}
+        #     {::Google::Cloud::Retail::V2::Product Product}.
+        #       For example:
+        #         `collection_product_id = "some_product_id"`
+        #     * List {::Google::Cloud::Retail::V2::Product Product}s with a partibular type.
+        #     For example:
+        #         `type = "PRIMARY"`
+        #         `type = "VARIANT"`
+        #         `type = "COLLECTION"`
+        #
+        #     If the field is unrecognizable, an INVALID_ARGUMENT error is returned.
+        #
+        #     If the specified
+        #     {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Product.Type.PRIMARY}
+        #     {::Google::Cloud::Retail::V2::Product Product} or
+        #     {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Product.Type.COLLECTION}
+        #     {::Google::Cloud::Retail::V2::Product Product} does not exist, a NOT_FOUND error
+        #     is returned.
+        # @!attribute [rw] read_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     The fields of {::Google::Cloud::Retail::V2::Product Product} to return in the
+        #     responses. If not set or empty, the following fields are returned:
+        #
+        #     * {::Google::Cloud::Retail::V2::Product#name Product.name}
+        #     * {::Google::Cloud::Retail::V2::Product#id Product.id}
+        #     * {::Google::Cloud::Retail::V2::Product#title Product.title}
+        #     * {::Google::Cloud::Retail::V2::Product#uri Product.uri}
+        #     * {::Google::Cloud::Retail::V2::Product#images Product.images}
+        #     * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
+        #     * {::Google::Cloud::Retail::V2::Product#brands Product.brands}
+        #
+        #     If "*" is provided, all fields are returned.
+        #     {::Google::Cloud::Retail::V2::Product#name Product.name} is always returned no
+        #     matter what mask is set.
+        #
+        #     If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
+        #     is returned.
+        class ListProductsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}
+        # method.
+        # @!attribute [rw] products
+        #   @return [::Array<::Google::Cloud::Retail::V2::Product>]
+        #     The {::Google::Cloud::Retail::V2::Product Product}s.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as
+        #     {::Google::Cloud::Retail::V2::ListProductsRequest#page_token ListProductsRequest.page_token}
+        #     to retrieve the next page. If this field is omitted, there are no
+        #     subsequent pages.
+        class ListProductsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for [SetInventory][] method.
+        # @!attribute [rw] inventory
+        #   @return [::Google::Cloud::Retail::V2::Product]
+        #     Required. The inventory information to update. The allowable fields to
+        #     update are:
+        #     * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
+        #     * {::Google::Cloud::Retail::V2::Product#availability Product.availability}
+        #     * {::Google::Cloud::Retail::V2::Product#available_quantity Product.available_quantity}
+        #     * {::Google::Cloud::Retail::V2::Product#fulfillment_info Product.fulfillment_info}
+        #     The updated inventory fields must be specified in
+        #     {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}.
+        #
+        #     If [SetInventoryRequest.inventory.name][] is empty or invalid, an
+        #     INVALID_ARGUMENT error is returned.
+        #
+        #     If the caller does not have permission to update the
+        #     {::Google::Cloud::Retail::V2::Product Product} named in
+        #     {::Google::Cloud::Retail::V2::Product#name Product.name}, regardless of whether
+        #     or not it exists, a PERMISSION_DENIED error is returned.
+        #
+        #     If the {::Google::Cloud::Retail::V2::Product Product} to update does not have
+        #     existing inventory information, the provided inventory information will be
+        #     inserted.
+        #
+        #     If the {::Google::Cloud::Retail::V2::Product Product} to update has existing
+        #     inventory information, the provided inventory information will be merged
+        #     while respecting the last update time for each inventory field, using the
+        #     provided or default value for
+        #     {::Google::Cloud::Retail::V2::SetInventoryRequest#set_time SetInventoryRequest.set_time}.
+        #
+        #     The last update time is recorded for the following inventory fields:
+        #     * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
+        #     * {::Google::Cloud::Retail::V2::Product#availability Product.availability}
+        #     * {::Google::Cloud::Retail::V2::Product#available_quantity Product.available_quantity}
+        #     * {::Google::Cloud::Retail::V2::Product#fulfillment_info Product.fulfillment_info}
+        #
+        #     If a full overwrite of inventory information while ignoring timestamps is
+        #     needed, [UpdateProduct][] should be invoked instead.
+        # @!attribute [rw] set_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which inventory fields in the provided
+        #     {::Google::Cloud::Retail::V2::Product Product} to update. If 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.
+        # @!attribute [rw] set_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time when the request is issued, used to prevent
+        #     out-of-order updates on inventory fields with the last update time
+        #     recorded. If not provided, the internal system time will be used.
+        # @!attribute [rw] allow_missing
+        #   @return [::Boolean]
+        #     If set to true, and the {::Google::Cloud::Retail::V2::Product Product} with name
+        #     {::Google::Cloud::Retail::V2::Product#name Product.name} is not found, the
+        #     inventory update will still be processed and retained for at most 1 day
+        #     until the {::Google::Cloud::Retail::V2::Product Product} is created. If set to
+        #     false, an INVALID_ARGUMENT error is returned if the
+        #     {::Google::Cloud::Retail::V2::Product Product} is not found.
+        class SetInventoryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the SetInventory operation.
+        # Currently empty because there is no meaningful metadata populated from the
+        # [SetInventory][] method.
+        class SetInventoryMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of the SetInventoryRequest.  Currently empty because
+        # there is no meaningful response populated from the [SetInventory][]
+        # method.
+        class SetInventoryResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for [AddFulfillmentPlaces][] method.
+        # @!attribute [rw] product
+        #   @return [::String]
+        #     Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
+        #     such as
+        #     `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
+        #
+        #     If the caller does not have permission to access the
+        #     {::Google::Cloud::Retail::V2::Product Product}, regardless of whether or not it
+        #     exists, a PERMISSION_DENIED error is returned.
+        # @!attribute [rw] type
+        #   @return [::String]
+        #     Required. The fulfillment type, including commonly used types (such as
+        #     pickup in store and same day delivery), and custom types.
+        #
+        #     Supported values:
+        #
+        #     * "pickup-in-store"
+        #     * "ship-to-store"
+        #     * "same-day-delivery"
+        #     * "next-day-delivery"
+        #     * "custom-type-1"
+        #     * "custom-type-2"
+        #     * "custom-type-3"
+        #     * "custom-type-4"
+        #     * "custom-type-5"
+        #
+        #     If this field is set to an invalid value other than these, an
+        #     INVALID_ARGUMENT error is returned.
+        #
+        #     This field directly corresponds to [Product.fulfillment_info.type][].
+        # @!attribute [rw] place_ids
+        #   @return [::Array<::String>]
+        #     Required. The IDs for this
+        #     {::Google::Cloud::Retail::V2::AddFulfillmentPlacesRequest#type type}, such as
+        #     the store IDs for "pickup-in-store" or the region IDs for
+        #     "same-day-delivery" to be added for this
+        #     {::Google::Cloud::Retail::V2::AddFulfillmentPlacesRequest#type type}. Duplicate
+        #     IDs will be automatically ignored.
+        #
+        #     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 [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+        #     INVALID_ARGUMENT error is returned.
+        #
+        #     If the total number of place IDs exceeds 2000 for this
+        #     {::Google::Cloud::Retail::V2::AddFulfillmentPlacesRequest#type type} after
+        #     adding, then the update will be rejected.
+        # @!attribute [rw] add_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     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.
+        # @!attribute [rw] allow_missing
+        #   @return [::Boolean]
+        #     If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
+        #     found, the fulfillment information will still be processed and retained for
+        #     at most 1 day and processed once the
+        #     {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, an
+        #     INVALID_ARGUMENT error is returned if the
+        #     {::Google::Cloud::Retail::V2::Product Product} is not found.
+        class AddFulfillmentPlacesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the AddFulfillmentPlaces operation.
+        # Currently empty because there is no meaningful metadata populated from the
+        # [AddFulfillmentPlaces][] method.
+        class AddFulfillmentPlacesMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of the RemoveFulfillmentPlacesRequest.  Currently empty because
+        # there is no meaningful response populated from the [AddFulfillmentPlaces][]
+        # method.
+        class AddFulfillmentPlacesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for [RemoveFulfillmentPlaces][] method.
+        # @!attribute [rw] product
+        #   @return [::String]
+        #     Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
+        #     such as
+        #     `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
+        #
+        #     If the caller does not have permission to access the
+        #     {::Google::Cloud::Retail::V2::Product Product}, regardless of whether or not it
+        #     exists, a PERMISSION_DENIED error is returned.
+        # @!attribute [rw] type
+        #   @return [::String]
+        #     Required. The fulfillment type, including commonly used types (such as
+        #     pickup in store and same day delivery), and custom types.
+        #
+        #     Supported values:
+        #
+        #     * "pickup-in-store"
+        #     * "ship-to-store"
+        #     * "same-day-delivery"
+        #     * "next-day-delivery"
+        #     * "custom-type-1"
+        #     * "custom-type-2"
+        #     * "custom-type-3"
+        #     * "custom-type-4"
+        #     * "custom-type-5"
+        #
+        #     If this field is set to an invalid value other than these, an
+        #     INVALID_ARGUMENT error is returned.
+        #
+        #     This field directly corresponds to [Product.fulfillment_info.type][].
+        # @!attribute [rw] place_ids
+        #   @return [::Array<::String>]
+        #     Required. The IDs for this
+        #     {::Google::Cloud::Retail::V2::RemoveFulfillmentPlacesRequest#type type}, such as
+        #     the store IDs for "pickup-in-store" or the region IDs for
+        #     "same-day-delivery", to be removed for this
+        #     {::Google::Cloud::Retail::V2::RemoveFulfillmentPlacesRequest#type type}.
+        #
+        #     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 [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+        #     INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] remove_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     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.
+        # @!attribute [rw] allow_missing
+        #   @return [::Boolean]
+        #     If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
+        #     found, the fulfillment information will still be processed and retained for
+        #     at most 1 day and processed once the
+        #     {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, an
+        #     INVALID_ARGUMENT error is returned if the
+        #     {::Google::Cloud::Retail::V2::Product Product} is not found.
+        class RemoveFulfillmentPlacesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the RemoveFulfillmentPlaces operation.
+        # Currently empty because there is no meaningful metadata populated from the
+        # [RemoveFulfillmentPlaces][] method.
+        class RemoveFulfillmentPlacesMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
+        # is no meaningful response populated from the [RemoveFulfillmentPlaces][]
+        # method.
+        class RemoveFulfillmentPlacesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end