google-cloud-retail-v2 0.20.0 → 1.0.0

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

@@ -37,6 +37,12 @@ module Google
         #   @return [::Array<::Google::Cloud::Retail::V2::Condition::TimeRange>]
         #     Range of time(s) specifying when Condition is active.
         #     Condition true if any time range matches.
+        # @!attribute [rw] page_categories
+        #   @return [::Array<::String>]
+        #     Used to support browse uses cases.
+        #     A list (up to 10 entries) of categories or departments.
+        #     The format should be the same as
+        #     {::Google::Cloud::Retail::V2::UserEvent#page_categories UserEvent.page_categories};
         class Condition
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -103,6 +109,12 @@ module Google
         # @!attribute [rw] twoway_synonyms_action
         #   @return [::Google::Cloud::Retail::V2::Rule::TwowaySynonymsAction]
         #     Treats a set of terms as synonyms of one another.
+        # @!attribute [rw] force_return_facet_action
+        #   @return [::Google::Cloud::Retail::V2::Rule::ForceReturnFacetAction]
+        #     Force returns an attribute as a facet in the request.
+        # @!attribute [rw] remove_facet_action
+        #   @return [::Google::Cloud::Retail::V2::Rule::RemoveFacetAction]
+        #     Remove an attribute as a facet in the request (if present).
         # @!attribute [rw] condition
         #   @return [::Google::Cloud::Retail::V2::Condition]
         #     Required. The condition that triggers the rule.
@@ -153,17 +165,19 @@ module Google
           end
 
           # * Rule Condition:
-          #   - No
-          #   {::Google::Cloud::Retail::V2::Condition#query_terms Condition.query_terms}
-          #   provided is a global match.
-          #   - 1 or more
-          #   {::Google::Cloud::Retail::V2::Condition#query_terms Condition.query_terms}
-          #   provided are combined with OR operator.
+          #     - No
+          #     {::Google::Cloud::Retail::V2::Condition#query_terms Condition.query_terms}
+          #     provided is a global match.
+          #     - 1 or more
+          #     {::Google::Cloud::Retail::V2::Condition#query_terms Condition.query_terms}
+          #     provided are combined with OR operator.
+          #
           # * Action Input: The request query and filter that are applied to the
           # retrieved products, in addition to any filters already provided with the
           # SearchRequest. The AND operator is used to combine the query's existing
           # filters with the filter rule(s). NOTE: May result in 0 results when
           # filters conflict.
+          #
           # * Action Result: Filters the returned objects to be ONLY those that passed
           # the filter.
           # @!attribute [rw] filter
@@ -172,10 +186,9 @@ module Google
           #
           #     * {::Google::Cloud::Retail::V2::Rule::FilterAction#filter filter} must be set.
           #     * Filter syntax is identical to
-          #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}. See
+          #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}. For
           #     more
-          #       details at the Retail Search
-          #       [user guide](/retail/search/docs/filter-and-order#filter).
+          #       information, see [Filter](/retail/docs/filter-and-order#filter).
           #     * To filter products with product ID "product_1" or "product_2", and
           #     color
           #       "Red" or "Blue":<br>
@@ -190,7 +203,7 @@ module Google
           # Redirects a shopper to a specific page.
           #
           # * Rule Condition:
-          #   - Must specify
+          #   Must specify
           #   {::Google::Cloud::Retail::V2::Condition#query_terms Condition.query_terms}.
           # * Action Input: Request Query
           # * Action Result: Redirects shopper to provided uri.
@@ -289,6 +302,87 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # Force returns an attribute/facet in the request around a certain position
+          # or above.
+          #
+          # * Rule Condition:
+          #   Must specify non-empty
+          #   {::Google::Cloud::Retail::V2::Condition#query_terms Condition.query_terms}
+          #   (for search only) or
+          #   {::Google::Cloud::Retail::V2::Condition#page_categories Condition.page_categories}
+          #   (for browse only), but can't specify both.
+          #
+          # * Action Inputs: attribute name, position
+          #
+          # * Action Result: Will force return a facet key around a certain position
+          # or above if the condition is satisfied.
+          #
+          # Example: Suppose the query is "shoes", the
+          # {::Google::Cloud::Retail::V2::Condition#query_terms Condition.query_terms} is
+          # "shoes", the
+          # {::Google::Cloud::Retail::V2::Rule::ForceReturnFacetAction::FacetPositionAdjustment#attribute_name ForceReturnFacetAction.FacetPositionAdjustment.attribute_name}
+          # is "size" and the
+          # {::Google::Cloud::Retail::V2::Rule::ForceReturnFacetAction::FacetPositionAdjustment#position ForceReturnFacetAction.FacetPositionAdjustment.position}
+          # is 8.
+          #
+          # Two cases: a) The facet key "size" is not already in the top 8 slots, then
+          # the facet "size" will appear at a position close to 8. b) The facet key
+          # "size" in among the top 8 positions in the request, then it will stay at
+          # its current rank.
+          # @!attribute [rw] facet_position_adjustments
+          #   @return [::Array<::Google::Cloud::Retail::V2::Rule::ForceReturnFacetAction::FacetPositionAdjustment>]
+          #     Each instance corresponds to a force return attribute for the given
+          #     condition. There can't be more 3 instances here.
+          class ForceReturnFacetAction
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Each facet position adjustment consists of a single attribute name (i.e.
+            # facet key) along with a specified position.
+            # @!attribute [rw] attribute_name
+            #   @return [::String]
+            #     The attribute name to force return as a facet. Each attribute name
+            #     should be a valid attribute name, be non-empty and contain at most 80
+            #     characters long.
+            # @!attribute [rw] position
+            #   @return [::Integer]
+            #     This is the position in the request as explained above. It should be
+            #     strictly positive be at most 100.
+            class FacetPositionAdjustment
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Removes an attribute/facet in the request if is present.
+          #
+          # * Rule Condition:
+          #   Must specify non-empty
+          #   {::Google::Cloud::Retail::V2::Condition#query_terms Condition.query_terms}
+          #   (for search only) or
+          #   {::Google::Cloud::Retail::V2::Condition#page_categories Condition.page_categories}
+          #   (for browse only), but can't specify both.
+          #
+          # * Action Input: attribute name
+          #
+          # * Action Result: Will remove the attribute (as a facet) from the request
+          # if it is present.
+          #
+          # Example: Suppose the query is "shoes", the
+          # {::Google::Cloud::Retail::V2::Condition#query_terms Condition.query_terms} is
+          # "shoes" and the attribute name "size", then facet key "size" will be
+          # removed from the request (if it is present).
+          # @!attribute [rw] attribute_names
+          #   @return [::Array<::String>]
+          #     The attribute names (i.e. facet keys) to remove from the dynamic facets
+          #     (if present in the request). There can't be more 3 attribute names.
+          #     Each attribute name should be a valid attribute name, be non-empty and
+          #     contain at most 80 characters.
+          class RemoveFacetAction
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
 
         # An intended audience of the {::Google::Cloud::Retail::V2::Product Product} for

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

@@ -94,12 +94,17 @@ module Google
         #
         #     The maximum allowed max suggestions is 20. If it is set higher, it will be
         #     capped by 20.
+        # @!attribute [rw] enable_attribute_suggestions
+        #   @return [::Boolean]
+        #     If true, attribute suggestions are enabled and provided in response.
+        #
+        #     This field is only available for "cloud-retail" dataset.
         # @!attribute [rw] entity
         #   @return [::String]
-        #     The entity for customers that may run multiple different entities, domains,
-        #     sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
+        #     The entity for customers who run multiple entities, domains, sites, or
+        #     regions, for example, `Google US`, `Google Ads`, `Waymo`,
         #     `google.com`, `youtube.com`, etc.
-        #     If this is set, it should be exactly matched with
+        #     If this is set, it must be an exact match with
         #     {::Google::Cloud::Retail::V2::UserEvent#entity UserEvent.entity} to get
         #     per-entity autocomplete results.
         class CompleteQueryRequest
@@ -119,10 +124,11 @@ module Google
         #     for search events resulting from this completion, which enables accurate
         #     attribution of complete model performance.
         # @!attribute [rw] recent_search_results
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
         #   @return [::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::RecentSearchResult>]
-        #     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.
+        #     Deprecated. Matched recent searches of this user. The maximum number of
+        #     recent searches is 10. This field is a restricted feature. If you want to
+        #     enable it, contact Retail Search support.
         #
         #     This feature is only available when
         #     {::Google::Cloud::Retail::V2::CompleteQueryRequest#visitor_id CompleteQueryRequest.visitor_id}
@@ -174,7 +180,8 @@ module Google
             end
           end
 
-          # Recent search of this user.
+          # Deprecated: Recent search of this user.
+          # @deprecated This message is deprecated and may be removed in the next major version update.
           # @!attribute [rw] recent_search
           #   @return [::String]
           #     The recent search query.

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

@@ -176,7 +176,8 @@ module Google
         # @!attribute [rw] update_mask
         #   @return [::Google::Protobuf::FieldMask]
         #     Indicates which fields in the provided imported `products` to update. If
-        #     not set, all fields are updated.
+        #     not set, all fields are updated. If provided, only the existing product
+        #     fields are updated. Missing products will not be created.
         # @!attribute [rw] reconciliation_mode
         #   @return [::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode]
         #     The mode of reconciliation between existing products and the products to be
@@ -192,9 +193,14 @@ module Google
         #     Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has
         #     to be within the same project as
         #     {::Google::Cloud::Retail::V2::ImportProductsRequest#parent ImportProductsRequest.parent}.
-        #     Make sure that `service-<project
-        #     number>@gcp-sa-retail.iam.gserviceaccount.com` has the
-        #     `pubsub.topics.publish` IAM permission on the topic.
+        #     Make sure that both
+        #     `cloud-retail-customer-data-access@system.gserviceaccount.com` and
+        #     `service-<project number>@gcp-sa-retail.iam.gserviceaccount.com`
+        #     have the `pubsub.topics.publish` IAM permission on the topic.
+        #
+        #     Only supported when
+        #     {::Google::Cloud::Retail::V2::ImportProductsRequest#reconciliation_mode ImportProductsRequest.reconciliation_mode}
+        #     is set to `FULL`.
         class ImportProductsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -139,6 +139,9 @@ module Google
         #   @return [::Array<::Google::Cloud::Retail::V2::Model::ServingConfigList>]
         #     Output only. The list of valid serving configs associated with the
         #     PageOptimizationConfig.
+        # @!attribute [rw] model_features_config
+        #   @return [::Google::Cloud::Retail::V2::Model::ModelFeaturesConfig]
+        #     Optional. Additional model features config.
         class Model
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -154,6 +157,27 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Additional configs for the frequently-bought-together model type.
+          # @!attribute [rw] context_products_type
+          #   @return [::Google::Cloud::Retail::V2::Model::ContextProductsType]
+          #     Optional. Specifies the context of the model when it is used in predict
+          #     requests. Can only be set for the `frequently-bought-together` type. If
+          #     it isn't specified, it defaults to
+          #     {::Google::Cloud::Retail::V2::Model::ContextProductsType::MULTIPLE_CONTEXT_PRODUCTS MULTIPLE_CONTEXT_PRODUCTS}.
+          class FrequentlyBoughtTogetherFeaturesConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Additional model features config.
+          # @!attribute [rw] frequently_bought_together_config
+          #   @return [::Google::Cloud::Retail::V2::Model::FrequentlyBoughtTogetherFeaturesConfig]
+          #     Additional configs for frequently-bought-together models.
+          class ModelFeaturesConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # The serving state of the model.
           module ServingState
             # Unspecified serving state.
@@ -221,6 +245,22 @@ module Google
             # messages can be queried via Stackdriver.
             DATA_ERROR = 2
           end
+
+          # Use single or multiple context products for recommendations.
+          module ContextProductsType
+            # Unspecified default value, should never be explicitly set.
+            # Defaults to
+            # {::Google::Cloud::Retail::V2::Model::ContextProductsType::MULTIPLE_CONTEXT_PRODUCTS MULTIPLE_CONTEXT_PRODUCTS}.
+            CONTEXT_PRODUCTS_TYPE_UNSPECIFIED = 0
+
+            # Use only a single product as context for the recommendation. Typically
+            # used on pages like add-to-cart or product details.
+            SINGLE_CONTEXT_PRODUCT = 1
+
+            # Use one or multiple products as context for the recommendation. Typically
+            # used on shopping cart pages.
+            MULTIPLE_CONTEXT_PRODUCTS = 2
+          end
         end
       end
     end

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

@@ -25,23 +25,22 @@ module Google
         # 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}. Note
-        #     that this is only applicable to
-        #     {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY} and
-        #     {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Type.COLLECTION}, and
-        #     ignored for {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}.
-        #     In general, we suggest the users to delete the stale products explicitly,
-        #     instead of using this field to determine staleness.
+        #     Note that this field is applied in the following ways:
         #
-        #     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}.
+        #     * If the {::Google::Cloud::Retail::V2::Product Product} is already expired
+        #     when it is uploaded, this product
+        #       is not indexed for search.
+        #
+        #     * If the {::Google::Cloud::Retail::V2::Product Product} is not expired when it
+        #     is uploaded, only the
+        #       {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}'s and
+        #       {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Type.COLLECTION}'s
+        #       expireTime is respected, and
+        #       {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}'s
+        #       expireTime is not used.
+        #
+        #     In general, we suggest the users to delete the stale
+        #     products explicitly, instead of using this field to determine staleness.
         #
         #     {::Google::Cloud::Retail::V2::Product#expire_time expire_time} must be later
         #     than {::Google::Cloud::Retail::V2::Product#available_time available_time} and
@@ -176,9 +175,10 @@ module Google
         #     error is returned.
         #
         #     At most 250 values are allowed per
-        #     {::Google::Cloud::Retail::V2::Product Product}. Empty values are not allowed.
-        #     Each value must be a UTF-8 encoded string with a length limit of 5,000
-        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        #     {::Google::Cloud::Retail::V2::Product Product} unless overridden through the
+        #     Google Cloud console. Empty values are not allowed. Each value must be a
+        #     UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an
+        #     INVALID_ARGUMENT error is returned.
         #
         #     Corresponding properties: Google Merchant Center property
         #     [google_product_category][mc_google_product_category]. Schema.org property
@@ -200,9 +200,10 @@ module Google
         #   @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.
+        #     A maximum of 30 brands are allowed unless overridden through the Google
+        #     Cloud console. Each
+        #     brand must be a UTF-8 encoded string with a length limit of 1,000
+        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
         #
         #     Corresponding properties: Google Merchant Center property
         #     [brand](https://support.google.com/merchants/answer/6324351). Schema.org

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

@@ -31,8 +31,8 @@ module Google
         #     id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is
         #     returned.
         #
-        #     Google Merchant Center property
-        #     [promotion](https://support.google.com/merchants/answer/7050148).
+        #     Corresponds to Google Merchant Center property
+        #     [promotion_id](https://support.google.com/merchants/answer/7050148).
         class Promotion
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -28,6 +28,99 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Metadata related to the progress of the PurgeProducts operation.
+        # This will be returned by the google.longrunning.Operation.metadata field.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        # @!attribute [rw] success_count
+        #   @return [::Integer]
+        #     Count of entries that were deleted successfully.
+        # @!attribute [rw] failure_count
+        #   @return [::Integer]
+        #     Count of entries that encountered errors while processing.
+        class PurgeProductsMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for PurgeProducts method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the branch under which the products are
+        #     created. The format is
+        #     `projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}`
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Required. The filter string to specify the products to be deleted with a
+        #     length limit of 5,000 characters.
+        #
+        #     Empty string filter is not allowed. "*" implies delete all items in a
+        #     branch.
+        #
+        #     The eligible fields for filtering are:
+        #
+        #     * `availability`: Double quoted
+        #     {::Google::Cloud::Retail::V2::Product#availability Product.availability} string.
+        #     * `create_time` : in ISO 8601 "zulu" format.
+        #
+        #     Supported syntax:
+        #
+        #     * Comparators (">", "<", ">=", "<=", "=").
+        #       Examples:
+        #       * create_time <= "2015-02-13T17:05:46Z"
+        #       * availability = "IN_STOCK"
+        #
+        #     * Conjunctions ("AND")
+        #       Examples:
+        #       * create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER"
+        #
+        #     * Disjunctions ("OR")
+        #       Examples:
+        #       * create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK"
+        #
+        #     * Can support nested queries.
+        #       Examples:
+        #       * (create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER")
+        #       OR (create_time >= "2015-02-14T13:03:32Z" AND availability = "IN_STOCK")
+        #
+        #     * Filter Limits:
+        #       * Filter should not contain more than 6 conditions.
+        #       * Max nesting depth should not exceed 2 levels.
+        #
+        #     Examples queries:
+        #     * Delete back order products created before a timestamp.
+        #       create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER"
+        # @!attribute [rw] force
+        #   @return [::Boolean]
+        #     Actually perform the purge.
+        #     If `force` is set to false, the method will return the expected purge count
+        #     without deleting any products.
+        class PurgeProductsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of the PurgeProductsRequest. If the long running operation is
+        # successfully done, then this message is returned by the
+        # google.longrunning.Operations.response field.
+        # @!attribute [rw] purge_count
+        #   @return [::Integer]
+        #     The total count of products purged as a result of the operation.
+        # @!attribute [rw] purge_sample
+        #   @return [::Array<::String>]
+        #     A sample of the product names that will be deleted.
+        #     Only populated if `force` is set to false. A max of 100 names will be
+        #     returned and the names are chosen at random.
+        class PurgeProductsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for PurgeUserEvents method.
         # @!attribute [rw] parent
         #   @return [::String]