google-apis-retail_v2 0.33.0 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18e916d64c386f6c9b65fcf3e6d27b2460371aa7dc0a23749c10f5c59b27db0f
-  data.tar.gz: f439bdacce1ca3cefdcde5cfdeb3ad8a026141758711ef1a7cc223c6261021ed
+  metadata.gz: a1176a95df6f47189465edd0a3ad3b8889c60ec42deb7c350350e78b8194d48c
+  data.tar.gz: 41654fa63564cb523233faf5f9f2c2a89a2b5f420364e948b95038197eb787d1
 SHA512:
-  metadata.gz: d7d59732abbc3a970e1a29a1eaef0d359ae436415e4166a69a09962fdfc67d766a9071c79050f11f4a77d14dcc30284626a63d24caf5346d3dd05b3929f5bafb
-  data.tar.gz: f1fb7248f0492d2ef6e237b224a75cb1ffb7b9d338e38aa33416eac49b4f5f20e94bdb7b646b14be02c499c0cc3b748a54d9d81bd113414441604114a0defb23
+  metadata.gz: 5954282fe9adc8af9905659fad8bc938b4da81bf5c2362147f117713092a5c8d4f9b3fe66ec5cd14f83d8dd9cec58baba9ba49a4698fec3036dfade3c7449dab
+  data.tar.gz: 1bed26a6aafa607dd3c3b81f3ed233dd17823b16e5616f578df3eec2ac8be868a491553581fdc10c1185d3031665ca25e55f1181c0275f8afc909f2bf3064658

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release history for google-apis-retail_v2
 
+### v0.36.0 (2022-04-28)
+
+* Regenerated from discovery document revision 20220421
+
+### v0.35.0 (2022-04-22)
+
+* Regenerated from discovery document revision 20220414
+
+### v0.34.0 (2022-04-14)
+
+* Regenerated from discovery document revision 20220408
+
 ### v0.33.0 (2022-03-31)
 
 * Regenerated from discovery document revision 20220324

data/lib/google/apis/retail_v2/classes.rb

@@ -774,12 +774,13 @@ module Google
       class GoogleCloudRetailV2CustomAttribute
         include Google::Apis::Core::Hashable
       
-        # This field will only be used when AttributesConfig.attribute_config_level of
-        # the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
-        # values are indexed, so that it can be filtered, faceted or boosted in
-        # SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.
-        # filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more
-        # details.
+        # This field is normally ignored unless AttributesConfig.attribute_config_level
+        # of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode.
+        # You may learn more on [configuration mode] (https://cloud.google.com/retail/
+        # docs/attribute-config#config-modes). if true, custom attribute values are
+        # indexed, so that it can be filtered, faceted or boosted in SearchService.
+        # Search. This field is ignored in a UserEvent. See SearchRequest.filter,
+        # SearchRequest.facet_specs and SearchRequest.boost_spec for more details.
         # Corresponds to the JSON property `indexable`
         # @return [Boolean]
         attr_accessor :indexable
@@ -792,11 +793,13 @@ module Google
         # @return [Array<Float>]
         attr_accessor :numbers
       
-        # This field will only be used when AttributesConfig.attribute_config_level of
-        # the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
-        # values are searchable by text queries in SearchService.Search. This field is
-        # ignored in a UserEvent. Only set if type text is set. Otherwise, a
-        # INVALID_ARGUMENT error is returned.
+        # This field is normally ignored unless AttributesConfig.attribute_config_level
+        # of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode.
+        # You may learn more on [configuration mode] (https://cloud.google.com/retail/
+        # docs/attribute-config#config-modes). If true, custom attribute values are
+        # searchable by text queries in SearchService.Search. This field is ignored in a
+        # UserEvent. Only set if type text is set. Otherwise, a INVALID_ARGUMENT error
+        # is returned.
         # Corresponds to the JSON property `searchable`
         # @return [Boolean]
         attr_accessor :searchable
@@ -1109,11 +1112,15 @@ module Google
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ProductInputConfig]
         attr_accessor :input_config
       
-        # Pub/Sub topic for receiving notification. If this field is set, when the
-        # import is finished, a notification will be sent to specified Pub/Sub topic.
+        # Full Pub/Sub topic name for receiving notification. If this field is set, when
+        # the import is finished, a notification will be sent to specified Pub/Sub topic.
         # The message data will be JSON string of a Operation. Format of the Pub/Sub
-        # topic is `projects/`project`/topics/`topic``. Only supported when
-        # ImportProductsRequest.reconciliation_mode is set to `FULL`.
+        # topic is `projects/`project`/topics/`topic``. It has to be within the same
+        # project as ImportProductsRequest.parent. Make sure that both `cloud-retail-
+        # customer-data-access@system.gserviceaccount.com` and `service-@gcp-sa-retail.
+        # iam.gserviceaccount.com` have the `pubsub.topics.publish` IAM permission on
+        # the topic. Only supported when ImportProductsRequest.reconciliation_mode is
+        # set to `FULL`.
         # Corresponds to the JSON property `notificationPubsubTopic`
         # @return [String]
         attr_accessor :notification_pubsub_topic
@@ -1573,7 +1580,8 @@ module Google
         attr_accessor :currency_code
       
         # Price of the product without any discount. If zero, by default set to be the
-        # price.
+        # price. If set, original_price should be greater than or equal to price,
+        # otherwise an INVALID_ARGUMENT error is thrown.
         # Corresponds to the JSON property `originalPrice`
         # @return [Float]
         attr_accessor :original_price
@@ -2109,13 +2117,13 @@ module Google
         # The type of Products allowed to be ingested into the catalog. Acceptable
         # values are: * `primary` (default): You can ingest Products of all types. When
         # ingesting a Product, its type will default to Product.Type.PRIMARY if unset. *
-        # `variant`: You can only ingest Product.Type.VARIANT Products. This means
-        # Product.primary_product_id cannot be empty. If this field is set to an invalid
-        # value other than these, an INVALID_ARGUMENT error is returned. If this field
-        # is `variant` and merchant_center_product_id_field is `itemGroupId`, an
-        # INVALID_ARGUMENT error is returned. See [Using product levels](https://cloud.
-        # google.com/retail/recommendations-ai/docs/catalog#product-levels) for more
-        # details.
+        # `variant` (incompatible with Retail Search): You can only ingest Product.Type.
+        # VARIANT Products. This means Product.primary_product_id cannot be empty. If
+        # this field is set to an invalid value other than these, an INVALID_ARGUMENT
+        # error is returned. If this field is `variant` and
+        # merchant_center_product_id_field is `itemGroupId`, an INVALID_ARGUMENT error
+        # is returned. See [Product levels](https://cloud.google.com/retail/docs/catalog#
+        # product-levels) for more details.
         # Corresponds to the JSON property `ingestionProductType`
         # @return [String]
         attr_accessor :ingestion_product_type
@@ -2128,8 +2136,8 @@ module Google
         # the item group. If this field is set to an invalid value other than these, an
         # INVALID_ARGUMENT error is returned. If this field is `itemGroupId` and
         # ingestion_product_type is `variant`, an INVALID_ARGUMENT error is returned.
-        # See [Using product levels](https://cloud.google.com/retail/recommendations-ai/
-        # docs/catalog#product-levels) for more details.
+        # See [Product levels](https://cloud.google.com/retail/docs/catalog#product-
+        # levels) for more details.
         # Corresponds to the JSON property `merchantCenterProductIdField`
         # @return [String]
         attr_accessor :merchant_center_product_id_field
@@ -2578,6 +2586,21 @@ module Google
         # @return [String]
         attr_accessor :filter
       
+        # The labels applied to a resource must meet the following requirements: * Each
+        # resource can have multiple labels, up to a maximum of 64. * Each label must be
+        # a key-value pair. * Keys have a minimum length of 1 character and a maximum
+        # length of 63 characters, and cannot be empty. Values can be empty, and have a
+        # maximum length of 63 characters. * Keys and values can contain only lowercase
+        # letters, numeric characters, underscores, and dashes. All characters must use
+        # UTF-8 encoding, and international characters are allowed. * The key portion of
+        # a label must be unique. However, you can use the same key with multiple
+        # resources. * Keys must start with a lowercase letter or international
+        # character. See [Google Cloud Document](https://cloud.google.com/resource-
+        # manager/docs/creating-managing-labels#requirements) for more details.
+        # Corresponds to the JSON property `labels`
+        # @return [Hash<String,String>]
+        attr_accessor :labels
+      
         # A 0-indexed integer that specifies the current offset (that is, starting
         # result location, amongst the Products deemed by the API as relevant) in search
         # results. This field is only considered if page_token is unset. If this field
@@ -2627,7 +2650,8 @@ module Google
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestPersonalizationSpec]
         attr_accessor :personalization_spec
       
-        # Raw search query.
+        # Raw search query. If this field is empty, the request is considered a category
+        # browsing request and returned results are based on filter and page_categories.
         # Corresponds to the JSON property `query`
         # @return [String]
         attr_accessor :query
@@ -2700,6 +2724,7 @@ module Google
           @dynamic_facet_spec = args[:dynamic_facet_spec] if args.key?(:dynamic_facet_spec)
           @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
           @filter = args[:filter] if args.key?(:filter)
+          @labels = args[:labels] if args.key?(:labels)
           @offset = args[:offset] if args.key?(:offset)
           @order_by = args[:order_by] if args.key?(:order_by)
           @page_categories = args[:page_categories] if args.key?(:page_categories)
@@ -3029,7 +3054,9 @@ module Google
         # @return [String]
         attr_accessor :attribution_token
       
-        # If spell correction applies, the corrected query. Otherwise, empty.
+        # Contains the spell corrected query, if found. If the spell correction type is
+        # AUTOMATIC, then the search results will be based on corrected_query, otherwise
+        # the original query will be used for search.
         # Corresponds to the JSON property `correctedQuery`
         # @return [String]
         attr_accessor :corrected_query
@@ -3490,9 +3517,9 @@ module Google
         # @return [String]
         attr_accessor :page_view_id
       
-        # The main product details related to the event. This field is required for the
-        # following event types: * `add-to-cart` * `detail-page-view` * `purchase-
-        # complete` * `search` In a `search` event, this field represents the products
+        # The main product details related to the event. This field is optional except
+        # for the following event types: * `add-to-cart` * `detail-page-view` * `
+        # purchase-complete` In a `search` event, this field represents the products
         # returned to the end user on the current page (the end user may have not
         # finished browsing the whole page yet). When a new page is returned to the end
         # user, after pagination/filtering/ordering even for the same query, a new `
@@ -3547,10 +3574,12 @@ module Google
         # Required. A unique identifier for tracking visitors. For example, this could
         # be implemented with an HTTP cookie, which should be able to uniquely identify
         # a visitor on a single device. This unique identifier should not change if the
-        # visitor log in/out of the website. The field must be a UTF-8 encoded string
-        # with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is
-        # returned. The field should not contain PII or user-data. We recommend to use
-        # Google Analystics [Client ID](https://developers.google.com/analytics/
+        # visitor log in/out of the website. Don't set the field to the same fixed ID
+        # for different users. This mixes the event history of those users together,
+        # which results in degraded model quality. The field must be a UTF-8 encoded
+        # string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
+        # error is returned. The field should not contain PII or user-data. We recommend
+        # to use Google Analystics [Client ID](https://developers.google.com/analytics/
         # devguides/collection/analyticsjs/field-reference#clientId) for this field.
         # Corresponds to the JSON property `visitorId`
         # @return [String]
@@ -3698,9 +3727,11 @@ module Google
         attr_accessor :user_agent
       
         # Highly recommended for logged-in users. Unique identifier for logged-in user,
-        # such as a user name. Always use a hashed value for this ID. The field must be
-        # a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
-        # INVALID_ARGUMENT error is returned.
+        # such as a user name. Don't set for anonymous users. Always use a hashed value
+        # for this ID. Don't set the field to the same fixed ID for different users.
+        # This mixes the event history of those users together, which results in
+        # degraded model quality. The field must be a UTF-8 encoded string with a length
+        # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
         # Corresponds to the JSON property `userId`
         # @return [String]
         attr_accessor :user_id

data/lib/google/apis/retail_v2/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2
       # Version of the google-apis-retail_v2 gem
-      GEM_VERSION = "0.33.0"
+      GEM_VERSION = "0.36.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220324"
+      REVISION = "20220421"
     end
   end
 end

data/lib/google/apis/retail_v2/representations.rb

@@ -1496,6 +1496,7 @@ module Google
           collection :facet_specs, as: 'facetSpecs', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestFacetSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestFacetSpec::Representation
       
           property :filter, as: 'filter'
+          hash :labels, as: 'labels'
           property :offset, as: 'offset'
           property :order_by, as: 'orderBy'
           collection :page_categories, as: 'pageCategories'

data/lib/google/apis/retail_v2/service.rb

@@ -638,7 +638,9 @@ module Google
         #   output only fields are NOT supported. If not set, all supported fields (the
         #   fields that are neither immutable nor output only) are updated. If an
         #   unsupported or unknown field is provided, an INVALID_ARGUMENT error is
-        #   returned.
+        #   returned. The attribute key can be updated by setting the mask path as "
+        #   attributes.$`key_name`". If a key name is present in the mask but not in the
+        #   patching product from the request, this key will be deleted after the update.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -927,8 +929,7 @@ module Google
         # Makes a recommendation prediction.
         # @param [String] placement
         #   Required. Full resource name of the format: `name=projects/*/locations/global/
-        #   catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
-        #   catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
+        #   catalogs/default_catalog/placements/*` The ID of the Recommendations AI
         #   placement. Before you can request predictions from your model, you must create
         #   at least one placement for it. For more information, see [Managing placements](
         #   https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
@@ -969,10 +970,9 @@ module Google
         # feature.
         # @param [String] placement
         #   Required. The resource name of the search engine placement, such as `projects/*
-        #   /locations/global/catalogs/default_catalog/placements/default_search` or `
-        #   projects/*/locations/global/catalogs/default_catalog/servingConfigs/
-        #   default_serving_config` This field is used to identify the serving
-        #   configuration name and the set of models that will be used to make the search.
+        #   /locations/global/catalogs/default_catalog/placements/default_search`. This
+        #   field is used to identify the serving configuration name and the set of models
+        #   that will be used to make the search.
         # @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1003,85 +1003,6 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Makes a recommendation prediction.
-        # @param [String] placement
-        #   Required. Full resource name of the format: `name=projects/*/locations/global/
-        #   catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
-        #   catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
-        #   placement. Before you can request predictions from your model, you must create
-        #   at least one placement for it. For more information, see [Managing placements](
-        #   https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
-        #   The full list of available placements can be seen at https://console.cloud.
-        #   google.com/recommendation/catalogs/default_catalog/placements
-        # @param [Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest] google_cloud_retail_v2_predict_request_object
-        # @param [String] fields
-        #   Selector specifying which fields to include in a partial response.
-        # @param [String] quota_user
-        #   Available to use for quota purposes for server-side applications. Can be any
-        #   arbitrary string assigned to a user, but should not exceed 40 characters.
-        # @param [Google::Apis::RequestOptions] options
-        #   Request-specific options
-        #
-        # @yield [result, err] Result & error if block supplied
-        # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse] parsed result object
-        # @yieldparam err [StandardError] error object if request failed
-        #
-        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse]
-        #
-        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
-        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
-        # @raise [Google::Apis::AuthorizationError] Authorization is required
-        def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
-          command = make_simple_command(:post, 'v2/{+placement}:predict', options)
-          command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest::Representation
-          command.request_object = google_cloud_retail_v2_predict_request_object
-          command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse::Representation
-          command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse
-          command.params['placement'] = placement unless placement.nil?
-          command.query['fields'] = fields unless fields.nil?
-          command.query['quotaUser'] = quota_user unless quota_user.nil?
-          execute_or_queue_command(command, &block)
-        end
-        
-        # Performs a search. This feature is only available for users who have Retail
-        # Search enabled. Please enable Retail Search on Cloud Console before using this
-        # feature.
-        # @param [String] placement
-        #   Required. The resource name of the search engine placement, such as `projects/*
-        #   /locations/global/catalogs/default_catalog/placements/default_search` or `
-        #   projects/*/locations/global/catalogs/default_catalog/servingConfigs/
-        #   default_serving_config` This field is used to identify the serving
-        #   configuration name and the set of models that will be used to make the search.
-        # @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
-        # @param [String] fields
-        #   Selector specifying which fields to include in a partial response.
-        # @param [String] quota_user
-        #   Available to use for quota purposes for server-side applications. Can be any
-        #   arbitrary string assigned to a user, but should not exceed 40 characters.
-        # @param [Google::Apis::RequestOptions] options
-        #   Request-specific options
-        #
-        # @yield [result, err] Result & error if block supplied
-        # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse] parsed result object
-        # @yieldparam err [StandardError] error object if request failed
-        #
-        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse]
-        #
-        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
-        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
-        # @raise [Google::Apis::AuthorizationError] Authorization is required
-        def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
-          command = make_simple_command(:post, 'v2/{+placement}:search', options)
-          command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest::Representation
-          command.request_object = google_cloud_retail_v2_search_request_object
-          command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse::Representation
-          command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse
-          command.params['placement'] = placement unless placement.nil?
-          command.query['fields'] = fields unless fields.nil?
-          command.query['quotaUser'] = quota_user unless quota_user.nil?
-          execute_or_queue_command(command, &block)
-        end
-        
         # Writes a single user event from the browser. This uses a GET request to due to
         # browser restriction of POST-ing to a 3rd party domain. This method is used
         # only by the Retail API JavaScript pixel and Google Tag Manager. Users should

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.36.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.33.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.36.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 post_install_message: 
 rdoc_options: []