google-apis-retail_v2alpha 0.100.0 → 0.101.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29ba7258c7460247dad29ed297c39aed165b75c48ebef9a1e41f5ea31917b9f6
-  data.tar.gz: d5fad12ad52d3b2d318b5008bf705d681f34cf1e3063d79db4611a1771737a06
+  metadata.gz: 6a4392b598f8fc3e7c8c2061bf03489e159cef8c2b107896d302813c26482665
+  data.tar.gz: 19eddb801b364a6dc7f29d69329e4370711c6b4f0bb6be2624bf3d18203f53e5
 SHA512:
-  metadata.gz: 611345a3dd3a260246846c0f17d026cd6b12a1fecc8d025463b441928ae608db6f39b91024ac4539ae034a738214e4106ef72299e2c0df6899575f9322f74000
-  data.tar.gz: 0e9d8c3e2239e16e7334a5a53d62a5d0cad6c87ac2179a05353a142e08cea2e5aed5ad96fb40f3b579eb086c739678f43e2724a163a9f25320585ab3ce2f6556
+  metadata.gz: 800dc389db1f574729f211ccc7771b50c491fd6bc3160cba7900b9dbc9b86bc398a462a03a4763713f2cd1bc0c7901073759cfeb4c9b7530887a2c10ed78808f
+  data.tar.gz: 766c8f254d200218b475f2e7b5772a5747746dcde23244ef3376a3d80f8e49bb212f3162cb6ab09594c0d49e09e3e89a60f8c236113ef6886f003c8b94e4de5d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-retail_v2alpha
 
+### v0.101.0 (2024-04-28)
+
+* Regenerated from discovery document revision 20240418
+
 ### v0.100.0 (2024-04-21)
 
 * Regenerated from discovery document revision 20240411

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

@@ -1678,6 +1678,191 @@ module Google
         end
       end
       
+      # A data branch that stores Products.
+      class GoogleCloudRetailV2alphaBranch
+        include Google::Apis::Core::Hashable
+      
+        # Output only. Human readable name of the branch to display in the UI.
+        # Corresponds to the JSON property `displayName`
+        # @return [String]
+        attr_accessor :display_name
+      
+        # Output only. Indicates whether this branch is set as the default branch of its
+        # parent catalog.
+        # Corresponds to the JSON property `isDefault`
+        # @return [Boolean]
+        attr_accessor :is_default
+        alias_method :is_default?, :is_default
+      
+        # Output only. Timestamp of last import through ProductService.ImportProducts.
+        # Empty value means no import has been made to this branch.
+        # Corresponds to the JSON property `lastProductImportTime`
+        # @return [String]
+        attr_accessor :last_product_import_time
+      
+        # Immutable. Full resource name of the branch, such as `projects/*/locations/
+        # global/catalogs/default_catalog/branches/branch_id`.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Output only. Statistics for number of products in the branch, provided for
+        # different scopes. This field is not populated in BranchView.BASIC view.
+        # Corresponds to the JSON property `productCountStats`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranchProductCountStatistic>]
+        attr_accessor :product_count_stats
+      
+        # Output only. The number of products in different groups that this branch has.
+        # The key is a group representing a set of products, and the value is the number
+        # of products in that group. Note: keys in this map may change over time.
+        # Possible keys: * "primary-in-stock", products have Product.Type.PRIMARY type
+        # and Product.Availability.IN_STOCK availability. * "primary-out-of-stock",
+        # products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK
+        # availability. * "primary-preorder", products have Product.Type.PRIMARY type
+        # and Product.Availability.PREORDER availability. * "primary-backorder",
+        # products have Product.Type.PRIMARY type and Product.Availability.BACKORDER
+        # availability. * "variant-in-stock", products have Product.Type.VARIANT type
+        # and Product.Availability.IN_STOCK availability. * "variant-out-of-stock",
+        # products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK
+        # availability. * "variant-preorder", products have Product.Type.VARIANT type
+        # and Product.Availability.PREORDER availability. * "variant-backorder",
+        # products have Product.Type.VARIANT type and Product.Availability.BACKORDER
+        # availability. * "price-discounted", products have [Product.price_info.price] <
+        # [Product.price_info.original_price]. This field is not populated in BranchView.
+        # BASIC view.
+        # Corresponds to the JSON property `productCounts`
+        # @return [Hash<String,Fixnum>]
+        attr_accessor :product_counts
+      
+        # Output only. The quality metrics measured among products of this branch. See
+        # QualityMetric.requirement_key for supported metrics. Metrics could be missing
+        # if failed to retrieve. This field is not populated in BranchView.BASIC view.
+        # Corresponds to the JSON property `qualityMetrics`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranchQualityMetric>]
+        attr_accessor :quality_metrics
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @display_name = args[:display_name] if args.key?(:display_name)
+          @is_default = args[:is_default] if args.key?(:is_default)
+          @last_product_import_time = args[:last_product_import_time] if args.key?(:last_product_import_time)
+          @name = args[:name] if args.key?(:name)
+          @product_count_stats = args[:product_count_stats] if args.key?(:product_count_stats)
+          @product_counts = args[:product_counts] if args.key?(:product_counts)
+          @quality_metrics = args[:quality_metrics] if args.key?(:quality_metrics)
+        end
+      end
+      
+      # A statistic about the number of products in a branch.
+      class GoogleCloudRetailV2alphaBranchProductCountStatistic
+        include Google::Apis::Core::Hashable
+      
+        # The number of products in scope broken down into different groups. The key is
+        # a group representing a set of products, and the value is the number of
+        # products in that group. Note: keys in this map may change over time. Possible
+        # keys: * "primary-in-stock", products have Product.Type.PRIMARY type and
+        # Product.Availability.IN_STOCK availability. * "primary-out-of-stock", products
+        # have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK
+        # availability. * "primary-preorder", products have Product.Type.PRIMARY type
+        # and Product.Availability.PREORDER availability. * "primary-backorder",
+        # products have Product.Type.PRIMARY type and Product.Availability.BACKORDER
+        # availability. * "variant-in-stock", products have Product.Type.VARIANT type
+        # and Product.Availability.IN_STOCK availability. * "variant-out-of-stock",
+        # products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK
+        # availability. * "variant-preorder", products have Product.Type.VARIANT type
+        # and Product.Availability.PREORDER availability. * "variant-backorder",
+        # products have Product.Type.VARIANT type and Product.Availability.BACKORDER
+        # availability. * "price-discounted", products have [Product.price_info.price] <
+        # [Product.price_info.original_price].
+        # Corresponds to the JSON property `counts`
+        # @return [Hash<String,Fixnum>]
+        attr_accessor :counts
+      
+        # [ProductCountScope] of the [counts].
+        # Corresponds to the JSON property `scope`
+        # @return [String]
+        attr_accessor :scope
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @counts = args[:counts] if args.key?(:counts)
+          @scope = args[:scope] if args.key?(:scope)
+        end
+      end
+      
+      # Metric measured on a group of Products against a certain quality requirement.
+      # Contains the number of products that pass the check and the number of products
+      # that don't.
+      class GoogleCloudRetailV2alphaBranchQualityMetric
+        include Google::Apis::Core::Hashable
+      
+        # Number of products passing the quality requirement check. We only check
+        # searchable products.
+        # Corresponds to the JSON property `qualifiedProductCount`
+        # @return [Fixnum]
+        attr_accessor :qualified_product_count
+      
+        # The key that represents a quality requirement rule. Supported keys: * "has-
+        # valid-uri": product has a valid and accessible uri. * "available-expire-time-
+        # conformance": Product.available_time is early than "now", and Product.
+        # expire_time is greater than "now". * "has-searchable-attributes": product has
+        # at least one attribute set to searchable. * "has-description": product has non-
+        # empty description. * "has-at-least-bigram-title": Product title has at least
+        # two words. A comprehensive title helps to improve search quality. * "variant-
+        # has-image": the variant products has at least one image. You may ignore this
+        # metric if all your products are at primary level. * "variant-has-price-info":
+        # the variant products has price_info set. You may ignore this metric if all
+        # your products are at primary level. * "has-publish-time": product has non-
+        # empty publish_time.
+        # Corresponds to the JSON property `requirementKey`
+        # @return [String]
+        attr_accessor :requirement_key
+      
+        # Value from 0 to 100 representing the suggested percentage of products that
+        # meet the quality requirements to get good search and recommendation
+        # performance. 100 * (qualified_product_count) / (qualified_product_count +
+        # unqualified_product_count) should be greater or equal to this suggestion.
+        # Corresponds to the JSON property `suggestedQualityPercentThreshold`
+        # @return [Float]
+        attr_accessor :suggested_quality_percent_threshold
+      
+        # Number of products failing the quality requirement check. We only check
+        # searchable products.
+        # Corresponds to the JSON property `unqualifiedProductCount`
+        # @return [Fixnum]
+        attr_accessor :unqualified_product_count
+      
+        # A list of a maximum of 100 sample products that do not qualify for this
+        # requirement. This field is only populated in the response to BranchService.
+        # GetBranch API, and is always empty for BranchService.ListBranches. Only the
+        # following fields are set in the Product. * Product.name * Product.id * Product.
+        # title
+        # Corresponds to the JSON property `unqualifiedSampleProducts`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct>]
+        attr_accessor :unqualified_sample_products
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @qualified_product_count = args[:qualified_product_count] if args.key?(:qualified_product_count)
+          @requirement_key = args[:requirement_key] if args.key?(:requirement_key)
+          @suggested_quality_percent_threshold = args[:suggested_quality_percent_threshold] if args.key?(:suggested_quality_percent_threshold)
+          @unqualified_product_count = args[:unqualified_product_count] if args.key?(:unqualified_product_count)
+          @unqualified_sample_products = args[:unqualified_sample_products] if args.key?(:unqualified_sample_products)
+        end
+      end
+      
       # The catalog configuration.
       class GoogleCloudRetailV2alphaCatalog
         include Google::Apis::Core::Hashable
@@ -3412,6 +3597,25 @@ module Google
         end
       end
       
+      # Response for BranchService.ListBranches method.
+      class GoogleCloudRetailV2alphaListBranchesResponse
+        include Google::Apis::Core::Hashable
+      
+        # The Branches.
+        # Corresponds to the JSON property `branches`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranch>]
+        attr_accessor :branches
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @branches = args[:branches] if args.key?(:branches)
+        end
+      end
+      
       # Response for CatalogService.ListCatalogs method.
       class GoogleCloudRetailV2alphaListCatalogsResponse
         include Google::Apis::Core::Hashable

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2alpha
       # Version of the google-apis-retail_v2alpha gem
-      GEM_VERSION = "0.100.0"
+      GEM_VERSION = "0.101.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.14.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240411"
+      REVISION = "20240418"
     end
   end
 end

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

@@ -382,6 +382,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaBranch
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaBranchProductCountStatistic
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaBranchQualityMetric
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaCatalog
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -664,6 +682,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaListBranchesResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaListCatalogsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -2033,6 +2057,41 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaBranch
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :display_name, as: 'displayName'
+          property :is_default, as: 'isDefault'
+          property :last_product_import_time, as: 'lastProductImportTime'
+          property :name, as: 'name'
+          collection :product_count_stats, as: 'productCountStats', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranchProductCountStatistic, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranchProductCountStatistic::Representation
+      
+          hash :product_counts, as: 'productCounts'
+          collection :quality_metrics, as: 'qualityMetrics', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranchQualityMetric, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranchQualityMetric::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaBranchProductCountStatistic
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :counts, as: 'counts'
+          property :scope, as: 'scope'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaBranchQualityMetric
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :qualified_product_count, as: 'qualifiedProductCount'
+          property :requirement_key, as: 'requirementKey'
+          property :suggested_quality_percent_threshold, as: 'suggestedQualityPercentThreshold'
+          property :unqualified_product_count, as: 'unqualifiedProductCount'
+          collection :unqualified_sample_products, as: 'unqualifiedSampleProducts', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct::Representation
+      
+        end
+      end
+      
       class GoogleCloudRetailV2alphaCatalog
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2496,6 +2555,14 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaListBranchesResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :branches, as: 'branches', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranch, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranch::Representation
+      
+        end
+      end
+      
       class GoogleCloudRetailV2alphaListCatalogsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -867,6 +867,79 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Retrieves a Branch.
+        # @param [String] name
+        #   Required. The name of the branch to retrieve. Format: `projects/*/locations/
+        #   global/catalogs/default_catalog/branches/some_branch_id`. "default_branch" can
+        #   be used as a special branch_id, it returns the default branch that has been
+        #   set for the catalog.
+        # @param [String] view
+        #   The view to apply to the returned Branch. Defaults to [Branch.BranchView.BASIC]
+        #   if unspecified. See documentation of fields of Branch to find what fields are
+        #   excluded from BASIC view.
+        # @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::RetailV2alpha::GoogleCloudRetailV2alphaBranch] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranch]
+        #
+        # @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 get_project_location_catalog_branch(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2alpha/{+name}', options)
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranch::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBranch
+          command.params['name'] = name unless name.nil?
+          command.query['view'] = view unless view.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Lists all Branchs under the specified parent Catalog.
+        # @param [String] parent
+        #   Required. The parent catalog resource name.
+        # @param [String] view
+        #   The view to apply to the returned Branch. Defaults to [Branch.BranchView.BASIC]
+        #   if unspecified. See documentation of fields of Branch to find what fields are
+        #   excluded from BASIC view.
+        # @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::RetailV2alpha::GoogleCloudRetailV2alphaListBranchesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListBranchesResponse]
+        #
+        # @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 list_project_location_catalog_branches(parent, view: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2alpha/{+parent}/branches', options)
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListBranchesResponse::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListBranchesResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['view'] = view unless view.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets the latest state of a long-running operation. Clients can use this method
         # to poll the operation result at intervals as recommended by the API service.
         # @param [String] name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2alpha
 version: !ruby/object:Gem::Version
-  version: 0.100.0
+  version: 0.101.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-21 00:00:00.000000000 Z
+date: 2024-04-28 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_v2alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.100.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.101.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
 post_install_message: 
 rdoc_options: []