google-cloud-retail-v2 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35215e1d3d5140386a8e08763025e0a07c99c687e1bf1542c6bb4339a7e2655c
-  data.tar.gz: b5fb941505e7c27c0caea1a80efe0742a4a3faae2719401e9feae4e2541abc47
+  metadata.gz: 89163592b295d93348803898a24239837bdb48bbf061a099a2112d914cc53e47
+  data.tar.gz: 12193ad19dff4ed242f1329e90a1c40adb99d837eafc5adc7b2a478006e9fb57
 SHA512:
-  metadata.gz: fda3f7dcb3d866875e857ca6cf01407a67e470a6f37667f78f658da607b3f1ffd774a34adaee1b18ef16f3384a5ce49625ec410b487cc473aa2e1df2771f7be0
-  data.tar.gz: 843c7d75995780b23316185e421aec2f11b782eed90300db75f32a68e1198e02df254602014e7cea773bdc110730b0248d7b00d7b5fd8ecc89f9737ec236388c
+  metadata.gz: bd235626e52464707b3c9a3631960409b73adc577ca457cacb18af1f07bf1484edc97493525fc062134a2a791d7e70d0833bea9a9584df9844ae58cbe968ca04
+  data.tar.gz: 2be8ed1a45db9dd9aa5cb14def5fcf6cb7de39162cef3c9328c7a716585bd211ffc15d1cc1c59861d13ae51888815700d17d074592fdf86f9f153b57b9d037bc

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=Retail V2 API
+--title="Retail V2 API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

data/AUTHENTICATION.md

@@ -120,15 +120,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
 [Google Cloud Platform environments](#google-cloud-platform-environments), you
 need a Google Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 2. Create a new project or click on an existing project.
-3. Activate the slide-out navigation tray and select **API Manager**. From
+3. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 4. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
    If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
+   new key file. Just select the account you wish to re-use, click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

data/README.md

@@ -37,7 +37,7 @@ request = ::Google::Cloud::Retail::V2::ListCatalogsRequest.new # (request fields
 response = client.list_catalogs request
 ```
 
-View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-retail-v2/latest)
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest)
 for class and method documentation.
 
 See also the [Product Documentation](https://cloud.google.com/retail/docs/apis)

data/lib/google/cloud/retail/v2/catalog_pb.rb

@@ -1,11 +1,8 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/catalog.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
-require 'google/cloud/retail/v2/common_pb'
-require 'google/cloud/retail/v2/import_config_pb'
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/lib/google/cloud/retail/v2/catalog_service/client.rb

@@ -397,10 +397,6 @@ module Google
             # * UserEventService will only join events with products from branch
             #   \\{newBranch}.
             #
-            # This feature is only available for users who have Retail Search enabled.
-            # Please submit a form [here](https://cloud.google.com/contact) to contact
-            # cloud sales if you are interested in using Retail Search.
-            #
             # @overload set_default_branch(request, options = nil)
             #   Pass arguments to `set_default_branch` via a request object, either of type
             #   {::Google::Cloud::Retail::V2::SetDefaultBranchRequest} or an equivalent Hash.
@@ -411,7 +407,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload set_default_branch(catalog: nil, branch_id: nil, note: nil)
+            # @overload set_default_branch(catalog: nil, branch_id: nil, note: nil, force: nil)
             #   Pass arguments to `set_default_branch` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -424,6 +420,10 @@ module Google
             #
             #     This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT
             #     error is returned.
+            #
+            #     If there are no sufficient active products in the targeted branch and
+            #     {::Google::Cloud::Retail::V2::SetDefaultBranchRequest#force force} is not set, a
+            #     FAILED_PRECONDITION error is returned.
             #   @param note [::String]
             #     Some note on this request, this can be retrieved by
             #     {::Google::Cloud::Retail::V2::CatalogService::Client#get_default_branch CatalogService.GetDefaultBranch}
@@ -431,6 +431,10 @@ module Google
             #
             #     This field must be a UTF-8 encoded string with a length limit of 1,000
             #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+            #   @param force [::Boolean]
+            #     If set to true, it permits switching to a branch with
+            #     {::Google::Cloud::Retail::V2::SetDefaultBranchRequest#branch_id branch_id} even
+            #     if it has no sufficient active products.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Protobuf::Empty]
@@ -501,10 +505,6 @@ module Google
             # {::Google::Cloud::Retail::V2::CatalogService::Client#set_default_branch CatalogService.SetDefaultBranch}
             # method under a specified parent catalog.
             #
-            # This feature is only available for users who have Retail Search enabled.
-            # Please submit a form [here](https://cloud.google.com/contact) to contact
-            # cloud sales if you are interested in using Retail Search.
-            #
             # @overload get_default_branch(request, options = nil)
             #   Pass arguments to `get_default_branch` via a request object, either of type
             #   {::Google::Cloud::Retail::V2::GetDefaultBranchRequest} or an equivalent Hash.

data/lib/google/cloud/retail/v2/catalog_service_pb.rb

@@ -30,6 +30,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :catalog, :string, 1
       optional :branch_id, :string, 2
       optional :note, :string, 3
+      optional :force, :bool, 4
     end
     add_message "google.cloud.retail.v2.GetDefaultBranchRequest" do
       optional :catalog, :string, 1

data/lib/google/cloud/retail/v2/catalog_service_services_pb.rb

@@ -71,18 +71,10 @@ module Google
             #   (if branch is not explicitly set).
             # * UserEventService will only join events with products from branch
             #   {newBranch}.
-            #
-            # This feature is only available for users who have Retail Search enabled.
-            # Please submit a form [here](https://cloud.google.com/contact) to contact
-            # cloud sales if you are interested in using Retail Search.
             rpc :SetDefaultBranch, ::Google::Cloud::Retail::V2::SetDefaultBranchRequest, ::Google::Protobuf::Empty
             # Get which branch is currently default branch set by
             # [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
             # method under a specified parent catalog.
-            #
-            # This feature is only available for users who have Retail Search enabled.
-            # Please submit a form [here](https://cloud.google.com/contact) to contact
-            # cloud sales if you are interested in using Retail Search.
             rpc :GetDefaultBranch, ::Google::Cloud::Retail::V2::GetDefaultBranchRequest, ::Google::Cloud::Retail::V2::GetDefaultBranchResponse
           end
 

data/lib/google/cloud/retail/v2/common_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/common.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/protobuf'
@@ -65,8 +64,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :user_agent, :string, 3
       optional :direct_user_request, :bool, 4
     end
-    add_message "google.cloud.retail.v2.Promotion" do
-      optional :promotion_id, :string, 1
+    add_message "google.cloud.retail.v2.LocalInventory" do
+      optional :place_id, :string, 1
+      optional :price_info, :message, 2, "google.cloud.retail.v2.PriceInfo"
+      map :attributes, :string, :message, 3, "google.cloud.retail.v2.CustomAttribute"
+      repeated :fulfillment_types, :string, 4
     end
   end
 end
@@ -85,7 +87,7 @@ module Google
         PriceInfo::PriceRange = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.PriceInfo.PriceRange").msgclass
         Rating = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Rating").msgclass
         UserInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UserInfo").msgclass
-        Promotion = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Promotion").msgclass
+        LocalInventory = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.LocalInventory").msgclass
       end
     end
   end

data/lib/google/cloud/retail/v2/completion_service/client.rb

@@ -30,8 +30,7 @@ module Google
           # Auto-completion service for retail.
           #
           # This feature is only available for users who have Retail Search enabled.
-          # Please submit a form [here](https://cloud.google.com/contact) to contact
-          # cloud sales if you are interested in using Retail Search.
+          # Please enable Retail Search on Cloud Console before using this feature.
           #
           class Client
             include Paths
@@ -144,6 +143,7 @@ module Google
 
               @operations_client = Operations.new do |config|
                 config.credentials = credentials
+                config.quota_project = @quota_project_id
                 config.endpoint = @config.endpoint
               end
 
@@ -169,8 +169,7 @@ module Google
             # Completes the specified prefix with keyword suggestions.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please submit a form [here](https://cloud.google.com/contact) to contact
-            # cloud sales if you are interested in using Retail Search.
+            # Please enable Retail Search on Cloud Console before using this feature.
             #
             # @overload complete_query(request, options = nil)
             #   Pass arguments to `complete_query` via a request object, either of type
@@ -197,21 +196,20 @@ module Google
             #
             #     The maximum number of allowed characters is 255.
             #   @param visitor_id [::String]
-            #     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 logs in or out of the website.
+            #     Required field. 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 logs in or 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.
             #   @param language_codes [::Array<::String>]
-            #     The list of languages of the query. This is
-            #     the BCP-47 language code, such as "en-US" or "sr-Latn".
-            #     For more information, see
-            #     [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
-            #
-            #     The maximum number of allowed characters is 255.
-            #     Only "en-US" is currently supported.
+            #     The language filters applied to the output suggestions. If set, it should
+            #     contain the language of the query. If not set, suggestions are returned
+            #     without considering language restrictions. This is the BCP-47 language
+            #     code, such as "en-US" or "sr-Latn". For more information, see [Tags for
+            #     Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
+            #     number of language codes is 3.
             #   @param device_type [::String]
             #     The device type context for completion suggestions.
             #     It is useful to apply different suggestions on different device types, e.g.
@@ -315,11 +313,13 @@ module Google
             ##
             # Bulk import of processed completion dataset.
             #
-            # Request processing may be synchronous. Partial updating is not supported.
+            # Request processing is asynchronous. Partial updating is not supported.
+            #
+            # The operation is successfully finished only after the imported suggestions
+            # are indexed successfully and ready for serving. The process takes hours.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please submit a form [here](https://cloud.google.com/contact) to contact
-            # cloud sales if you are interested in using Retail Search.
+            # Please enable Retail Search on Cloud Console before using this feature.
             #
             # @overload import_completion_data(request, options = nil)
             #   Pass arguments to `import_completion_data` via a request object, either of type

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

@@ -35,8 +35,7 @@ module Google
         # Auto-completion service for retail.
         #
         # This feature is only available for users who have Retail Search enabled.
-        # Please submit a form [here](https://cloud.google.com/contact) to contact
-        # cloud sales if you are interested in using Retail Search.
+        # Please enable Retail Search on Cloud Console before using this feature.
         #
         # To load this service and instantiate a client:
         #

data/lib/google/cloud/retail/v2/completion_service_services_pb.rb

@@ -27,8 +27,7 @@ module Google
           # Auto-completion service for retail.
           #
           # This feature is only available for users who have Retail Search enabled.
-          # Please submit a form [here](https://cloud.google.com/contact) to contact
-          # cloud sales if you are interested in using Retail Search.
+          # Please enable Retail Search on Cloud Console before using this feature.
           class Service
 
             include ::GRPC::GenericService
@@ -40,16 +39,17 @@ module Google
             # Completes the specified prefix with keyword suggestions.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please submit a form [here](https://cloud.google.com/contact) to contact
-            # cloud sales if you are interested in using Retail Search.
+            # Please enable Retail Search on Cloud Console before using this feature.
             rpc :CompleteQuery, ::Google::Cloud::Retail::V2::CompleteQueryRequest, ::Google::Cloud::Retail::V2::CompleteQueryResponse
             # Bulk import of processed completion dataset.
             #
-            # Request processing may be synchronous. Partial updating is not supported.
+            # Request processing is asynchronous. Partial updating is not supported.
+            #
+            # The operation is successfully finished only after the imported suggestions
+            # are indexed successfully and ready for serving. The process takes hours.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please submit a form [here](https://cloud.google.com/contact) to contact
-            # cloud sales if you are interested in using Retail Search.
+            # Please enable Retail Search on Cloud Console before using this feature.
             rpc :ImportCompletionData, ::Google::Cloud::Retail::V2::ImportCompletionDataRequest, ::Google::Longrunning::Operation
           end
 

data/lib/google/cloud/retail/v2/import_config_pb.rb

@@ -1,7 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/import_config.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/retail/v2/product_pb'

data/lib/google/cloud/retail/v2/prediction_service/client.rb

@@ -213,9 +213,12 @@ module Google
             #      * filterOutOfStockItems  tag=(-"promotional")
             #      * filterOutOfStockItems
             #
-            #     If your filter blocks all prediction results, nothing will be returned. If
-            #     you want generic (unfiltered) popular products to be returned instead, set
-            #     `strictFiltering` to false in `PredictRequest.params`.
+            #     If your filter blocks all prediction results, the API will return generic
+            #     (unfiltered) popular products. If you only want results strictly matching
+            #     the filters, set `strictFiltering` to True in `PredictRequest.params` to
+            #     receive empty results instead.
+            #     Note that the API will never return items with storageStatus of "EXPIRED"
+            #     or "DELETED" regardless of filter choices.
             #   @param validate_only [::Boolean]
             #     Use validate only mode for this prediction query. If set to true, a
             #     dummy model will be used that returns arbitrary products.

data/lib/google/cloud/retail/v2/product_pb.rb

@@ -1,10 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/product.proto
 
-require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/retail/v2/common_pb'
+require 'google/cloud/retail/v2/promotion_pb'
 require 'google/protobuf/duration_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'