google-cloud-retail-v2 0.11.0 → 0.13.0

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

@@ -26,7 +26,13 @@ module Google
         # @!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}.
+        #     {::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.
         #
         #     If it is set, the {::Google::Cloud::Retail::V2::Product Product} is not
         #     available for
@@ -46,7 +52,13 @@ module Google
         #     [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.
+        #     Input only. The TTL (time to live) of the product. 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.
         #
         #     If it is set, it must be a non-negative value, and
         #     {::Google::Cloud::Retail::V2::Product#expire_time expire_time} is set as
@@ -146,7 +158,7 @@ module Google
         #
         #
         #     To represent full path of category, use '>' sign to separate different
-        #     hierarchies. If '>' is part of the category name, please replace it with
+        #     hierarchies. If '>' is part of the category name, replace it with
         #     other character(s).
         #
         #     For example, if a shoes product belongs to both
@@ -276,7 +288,11 @@ module Google
         #   @return [::Google::Protobuf::Timestamp]
         #     The timestamp when this {::Google::Cloud::Retail::V2::Product Product} becomes
         #     available for
-        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
+        #     {::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}.
         # @!attribute [rw] availability
         #   @return [::Google::Cloud::Retail::V2::Product::Availability]
         #     The online availability of the {::Google::Cloud::Retail::V2::Product Product}.
@@ -462,6 +478,8 @@ module Google
         #     Note: Returning more fields in
         #     {::Google::Cloud::Retail::V2::SearchResponse SearchResponse} can increase
         #     response payload size and serving latency.
+        #
+        #     This field is deprecated. Use the retrievable site-wide control instead.
         # @!attribute [r] variants
         #   @return [::Array<::Google::Cloud::Retail::V2::Product>]
         #     Output only. Product variants grouped together on primary product which
@@ -479,7 +497,11 @@ module Google
         #     Output only. A list of local inventories specific to different places.
         #
         #     This is only available for users who have Retail Search enabled, and it can
-        #     be managed by [AddLocalInventories][] and [RemoveLocalInventories][] APIs.
+        #     be managed by
+        #     {::Google::Cloud::Retail::V2::ProductService::Client#add_local_inventories ProductService.AddLocalInventories}
+        #     and
+        #     {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
+        #     APIs.
         class Product
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -29,7 +29,7 @@ module Google
         #     `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
         #     or the name of the legacy placement resource, such as
         #     `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
-        #     This field is used to identify the serving configuration name and the set
+        #     This field is used to identify the serving config name and the set
         #     of models that will be used to make the search.
         # @!attribute [rw] branch
         #   @return [::String]
@@ -230,7 +230,7 @@ module Google
         #     {::Google::Cloud::Retail::V2::UserEvent#page_categories UserEvent.page_categories};
         #
         #     To represent full path of category, use '>' sign to separate different
-        #     hierarchies. If '>' is part of the category name, please replace it with
+        #     hierarchies. If '>' is part of the category name, replace it with
         #     other character(s).
         #
         #     Category pages include special pages such as sales or promotions. For
@@ -286,7 +286,7 @@ module Google
           # @!attribute [rw] limit
           #   @return [::Integer]
           #     Maximum of facet values that should be returned for this facet. If
-          #     unspecified, defaults to 20. The maximum allowed value is 300. Values
+          #     unspecified, defaults to 50. The maximum allowed value is 300. Values
           #     above 300 will be coerced to 300.
           #
           #     If this field is negative, an INVALID_ARGUMENT is returned.
@@ -686,15 +686,20 @@ module Google
           # The search mode of each search request.
           module SearchMode
             # Default value. In this case both product search and faceted search will
-            # be performed. Both [SearchResponse.SearchResult] and
-            # [SearchResponse.Facet] will be returned.
+            # be performed. Both
+            # {::Google::Cloud::Retail::V2::SearchResponse::SearchResult SearchResponse.SearchResult}
+            # and {::Google::Cloud::Retail::V2::SearchResponse::Facet SearchResponse.Facet}
+            # will be returned.
             SEARCH_MODE_UNSPECIFIED = 0
 
             # Only product search will be performed. The faceted search will be
             # disabled.
             #
-            # Only [SearchResponse.SearchResult] will be returned.
-            # [SearchResponse.Facet] will not be returned, even if
+            # Only
+            # {::Google::Cloud::Retail::V2::SearchResponse::SearchResult SearchResponse.SearchResult}
+            # will be returned.
+            # {::Google::Cloud::Retail::V2::SearchResponse::Facet SearchResponse.Facet} will
+            # not be returned, even if
             # {::Google::Cloud::Retail::V2::SearchRequest#facet_specs SearchRequest.facet_specs}
             # or
             # {::Google::Cloud::Retail::V2::SearchRequest#dynamic_facet_spec SearchRequest.dynamic_facet_spec}
@@ -709,7 +714,9 @@ module Google
             # and
             # {::Google::Cloud::Retail::V2::SearchRequest#dynamic_facet_spec SearchRequest.dynamic_facet_spec}
             # should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only
-            # [SearchResponse.Facet] will be returned. [SearchResponse.SearchResult]
+            # {::Google::Cloud::Retail::V2::SearchResponse::Facet SearchResponse.Facet} will
+            # be returned.
+            # {::Google::Cloud::Retail::V2::SearchResponse::SearchResult SearchResponse.SearchResult}
             # will not be returned.
             FACETED_SEARCH_ONLY = 2
           end

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

@@ -54,13 +54,13 @@ module Google
         #     click-through and conversion rates.
         #      Allowed values are:
         #
-        #     * 'no-price-reranking'
-        #     * 'low-price-raranking'
-        #     * 'medium-price-reranking'
-        #     * 'high-price-reranking'
+        #     * `no-price-reranking`
+        #     * `low-price-raranking`
+        #     * `medium-price-reranking`
+        #     * `high-price-reranking`
         #
         #     If not specified, we choose default based on model type. Default value:
-        #     'no-price-reranking'.
+        #     `no-price-reranking`.
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
@@ -178,29 +178,34 @@ module Google
         # @!attribute [rw] diversity_level
         #   @return [::String]
         #     How much diversity to use in recommendation model results e.g.
-        #     'medium-diversity' or 'high-diversity'. Currently supported values:
+        #     `medium-diversity` or `high-diversity`. Currently supported values:
         #
-        #     * 'no-diversity'
-        #     * 'low-diversity'
-        #     * 'medium-diversity'
-        #     * 'high-diversity'
-        #     * 'auto-diversity'
+        #     * `no-diversity`
+        #     * `low-diversity`
+        #     * `medium-diversity`
+        #     * `high-diversity`
+        #     * `auto-diversity`
         #
         #     If not specified, we choose default based on recommendation model
-        #     type. Default value: 'no-diversity'.
+        #     type. Default value: `no-diversity`.
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
         #     [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
+        # @!attribute [rw] diversity_type
+        #   @return [::Google::Cloud::Retail::V2::ServingConfig::DiversityType]
+        #     What kind of diversity to use - data driven or rule based. If unset,
+        #     the server behavior defaults to
+        #     {::Google::Cloud::Retail::V2::ServingConfig::DiversityType::RULE_BASED_DIVERSITY RULE_BASED_DIVERSITY}.
         # @!attribute [rw] enable_category_filter_level
         #   @return [::String]
-        #     Whether to add additional category filters on the 'similar-items' model.
+        #     Whether to add additional category filters on the `similar-items` model.
         #     If not specified, we enable it by default.
         #      Allowed values are:
         #
-        #     * 'no-category-match': No additional filtering of original results from
+        #     * `no-category-match`: No additional filtering of original results from
         #       the model and the customer's filters.
-        #     * 'relaxed-category-match': Only keep results with categories that match
+        #     * `relaxed-category-match`: Only keep results with categories that match
         #       at least one item categories in the PredictRequests's context item.
         #       * If customer also sends filters in the PredictRequest, then the results
         #       will satisfy both conditions (user given and category match).
@@ -231,6 +236,18 @@ module Google
         class ServingConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # What type of diversity - data or rule based.
+          module DiversityType
+            # Default value.
+            DIVERSITY_TYPE_UNSPECIFIED = 0
+
+            # Rule based diversity.
+            RULE_BASED_DIVERSITY = 2
+
+            # Data driven diversity.
+            DATA_DRIVEN_DIVERSITY = 3
+          end
         end
       end
     end

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

@@ -63,7 +63,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the ServingConfig to delete. Format:
-        #     projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/servingConfigs/\\{serving_config_id}
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
         class DeleteServingConfigRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -73,7 +73,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the ServingConfig to get. Format:
-        #     projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/servingConfigs/\\{serving_config_id}
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
         class GetServingConfigRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -83,7 +83,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The catalog resource name. Format:
-        #     projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. Maximum number of results to return. If unspecified, defaults
@@ -114,7 +114,7 @@ module Google
         # @!attribute [rw] serving_config
         #   @return [::String]
         #     Required. The source ServingConfig resource name . Format:
-        #     projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/servingConfigs/\\{serving_config_id}
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
         # @!attribute [rw] control_id
         #   @return [::String]
         #     Required. The id of the control to apply. Assumed to be in the same catalog
@@ -128,7 +128,7 @@ module Google
         # @!attribute [rw] serving_config
         #   @return [::String]
         #     Required. The source ServingConfig resource name . Format:
-        #     projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/servingConfigs/\\{serving_config_id}
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
         # @!attribute [rw] control_id
         #   @return [::String]
         #     Required. The id of the control to apply. Assumed to be in the same catalog

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

@@ -217,7 +217,7 @@ module Google
         #     The categories associated with a category page.
         #
         #     To represent full path of category, use '>' sign to separate different
-        #     hierarchies. If '>' is part of the category name, please replace it with
+        #     hierarchies. If '>' is part of the category name, replace it with
         #     other character(s).
         #
         #     Category pages include special pages such as sales or promotions. For

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

@@ -29,12 +29,22 @@ module Google
         # @!attribute [rw] user_event
         #   @return [::Google::Cloud::Retail::V2::UserEvent]
         #     Required. User event to write.
+        # @!attribute [rw] write_async
+        #   @return [::Boolean]
+        #     If set to true, the user event will be written asynchronously after
+        #     validation, and the API will respond without waiting for the write.
+        #     Therefore, silent failures can occur even if the API returns success. In
+        #     case of silent failures, error messages can be found in Stackdriver logs.
         class WriteUserEventRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
         # Request message for CollectUserEvent method.
+        # @!attribute [rw] prebuilt_rule
+        #   @return [::String]
+        #     The prebuilt rule name that can convert a specific type of raw_json.
+        #     For example: "default_schema/v1.0"
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent catalog name, such as
@@ -54,6 +64,12 @@ module Google
         #     The event timestamp in milliseconds. This prevents browser caching of
         #     otherwise identical get requests. The name is abbreviated to reduce the
         #     payload bytes.
+        # @!attribute [rw] raw_json
+        #   @return [::String]
+        #     An arbitrary serialized JSON string that contains necessary information
+        #     that can comprise a user event. When this field is specified, the
+        #     user_event field will be ignored. Note: line-delimited JSON is not
+        #     supported, a single JSON only.
         class CollectUserEventRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -68,19 +84,19 @@ module Google
         #   @return [::Google::Cloud::Retail::V2::RejoinUserEventsRequest::UserEventRejoinScope]
         #     The type of the user event rejoin to define the scope and range of the user
         #     events to be rejoined with the latest product catalog. Defaults to
-        #     USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an
-        #     invalid integer value.
+        #     `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED` if this field is not set, or set to
+        #     an invalid integer value.
         class RejoinUserEventsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
           # The scope of user events to be rejoined with the latest product catalog.
           # If the rejoining aims at reducing number of unjoined events, set
-          # UserEventRejoinScope to UNJOINED_EVENTS.
+          # `UserEventRejoinScope` to `UNJOINED_EVENTS`.
           # If the rejoining aims at correcting product catalog information in joined
-          # events, set UserEventRejoinScope to JOINED_EVENTS.
-          # If all events needs to be rejoined, set UserEventRejoinScope to
-          # USER_EVENT_REJOIN_SCOPE_UNSPECIFIED.
+          # events, set `UserEventRejoinScope` to `JOINED_EVENTS`.
+          # If all events needs to be rejoined, set `UserEventRejoinScope` to
+          # `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED`.
           module UserEventRejoinScope
             # Rejoin all events with the latest product catalog, including both joined
             # events and unjoined events.
@@ -94,7 +110,7 @@ module Google
           end
         end
 
-        # Response message for RejoinUserEvents method.
+        # Response message for `RejoinUserEvents` method.
         # @!attribute [rw] rejoined_user_events_count
         #   @return [::Integer]
         #     Number of user events that were joined with latest product catalog.
@@ -103,7 +119,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Metadata for RejoinUserEvents method.
+        # Metadata for `RejoinUserEvents` method.
         class RejoinUserEventsMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/rpc/status.rb

@@ -28,12 +28,14 @@ module Google
     # [API Design Guide](https://cloud.google.com/apis/design/errors).
     # @!attribute [rw] code
     #   @return [::Integer]
-    #     The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
+    #     The status code, which should be an enum value of
+    #     [google.rpc.Code][google.rpc.Code].
     # @!attribute [rw] message
     #   @return [::String]
     #     A developer-facing error message, which should be in English. Any
     #     user-facing error message should be localized and sent in the
-    #     {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
+    #     {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
+    #     by the client.
     # @!attribute [rw] details
     #   @return [::Array<::Google::Protobuf::Any>]
     #     A list of messages that carry the error details.  There is a common set of

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-retail-v2
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-24 00:00:00.000000000 Z
+date: 2023-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.17.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.17.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -44,20 +44,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-location
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.26.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.26.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -234,8 +254,10 @@ files:
 - lib/google/cloud/retail/v2/user_event_service_services_pb.rb
 - lib/google/cloud/retail/v2/version.rb
 - proto_docs/README.md
+- proto_docs/google/api/client.rb
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/httpbody.rb
+- proto_docs/google/api/launch_stage.rb
 - proto_docs/google/api/resource.rb
 - proto_docs/google/cloud/retail/v2/catalog.rb
 - proto_docs/google/cloud/retail/v2/catalog_service.rb
@@ -283,7 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
 summary: API Client library for the Retail V2 API