google-shopping-merchant-lfp 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51e6a8de0d25ee5c72beb9849a38e04352822d70329d9ed2af57f991b568a795
-  data.tar.gz: 9a501f2a9b22af32b16876c29eff02427d3d4c722f30856d5f44f5383d90cfb8
+  metadata.gz: d0aeb15d4fc7b4f5c450352bb84abe04ba86c47cfcfbf485d96263be9481be36
+  data.tar.gz: 7dda683a356ac21f9eaffd2d0e3af3ec280c4774e381bfb390f1af1cb5d1f626
 SHA512:
-  metadata.gz: 16e88ba02d702763c7b25635719ed8b516003b3064425a9700e0810678e1cd796c1c58ae217068a1e68a200f665ecfc559777dd7d9d2044b38bfa6e9a0166320
-  data.tar.gz: 0b415c28f4f2436748fa9724929644241001c7e25a0c53b7145240c92dfb179abcfd0558db6c07b33a3f75be2051cfaf32f53f729ac8732519231da6f21f4ced
+  metadata.gz: f877ceae1a52e79eb0ed0721dd25ba414e0376b16bbfbcaf0e884af0bfa9b8b3ce9c1e674061b220edec63abb158e6d8274bdb51404de7a865ab8186d80248ab
+  data.tar.gz: cee10a1355966c068820c59d8bcb16fa5569e35d467cc5dc1fd904bb4719d0d3a2f4354d62f39dd13e891985ba8c099b1231dd752d973c704a61690502970c24

data/README.md

@@ -1,8 +1,8 @@
 # Ruby Client for the Merchant API
 
-Programmatically manage your Merchant Center accounts.
+Programmatically manage your Merchant Center Accounts.
 
-Programmatically manage your Merchant Center accounts.
+Merchant API consists of multiple Sub-APIs. Accounts Sub-API: Enables you to programmatically manage your accounts. Conversions Sub-API: Enables you to programmatically manage your conversion sources for a merchant account. Datasources Sub-API: Enables you to programmatically manage your datasources. Inventories Sub-API: This bundle enables you to programmatically manage your local and regional inventories. Local Feeds Partnerships Sub-API: This bundle enables LFP partners to submit local inventories for a merchant. Notifications Sub-API: This bundle enables you to programmatically manage your notification subscriptions. Products Sub-API: This bundle enables you to programmatically manage your products. Promotions Sub-API: This bundle enables you to programmatically manage your promotions for products. Quota Sub-API: This bundle enables you to list your quotas for all APIs you are using. Reports Sub-API: This bundle enables you to programmatically retrieve reports and insights about products, their performance and their competitive environment.
 
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-shopping-merchant-lfp-v*`.
@@ -34,9 +34,39 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable the API.](https://console.cloud.google.com/apis/library/merchantapi.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+Debug logging also requires that the versioned clients for this service be
+sufficiently recent, released after about Dec 10, 2024. If logging is not
+working, try updating the versioned clients in your bundle or installed gems:
+[google-shopping-merchant-lfp-v1beta](https://rubydoc.info/gems/google-shopping-merchant-lfp-v1beta).
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

data/lib/google/shopping/merchant/lfp/version.rb

@@ -21,7 +21,7 @@ module Google
   module Shopping
     module Merchant
       module Lfp
-        VERSION = "0.1.0"
+        VERSION = "0.3.0"
       end
     end
   end

data/lib/google/shopping/merchant/lfp.rb

@@ -41,6 +41,11 @@ module Google
         # You can also specify a different transport by passing `:rest` or `:grpc` in
         # the `transport` parameter.
         #
+        # Raises an exception if the currently installed versioned client gem for the
+        # given API version does not support the given transport of the LfpInventoryService service.
+        # You can determine whether the method will succeed by calling
+        # {Google::Shopping::Merchant::Lfp.lfp_inventory_service_available?}.
+        #
         # ## About LfpInventoryService
         #
         # Service for a [LFP
@@ -64,6 +69,109 @@ module Google
           service_module.const_get(:Client).new(&block)
         end
 
+        ##
+        # Determines whether the LfpInventoryService service is supported by the current client.
+        # If true, you can retrieve a client object by calling {Google::Shopping::Merchant::Lfp.lfp_inventory_service}.
+        # If false, that method will raise an exception. This could happen if the given
+        # API version does not exist or does not support the LfpInventoryService service,
+        # or if the versioned client gem needs an update to support the LfpInventoryService service.
+        #
+        # @param version [::String, ::Symbol] The API version to connect to. Optional.
+        #   Defaults to `:v1beta`.
+        # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+        # @return [boolean] Whether the service is available.
+        #
+        def self.lfp_inventory_service_available? version: :v1beta, transport: :grpc
+          require "google/shopping/merchant/lfp/#{version.to_s.downcase}"
+          package_name = Google::Shopping::Merchant::Lfp
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          return false unless package_name
+          service_module = Google::Shopping::Merchant::Lfp.const_get package_name
+          return false unless service_module.const_defined? :LfpInventoryService
+          service_module = service_module.const_get :LfpInventoryService
+          if transport == :rest
+            return false unless service_module.const_defined? :Rest
+            service_module = service_module.const_get :Rest
+          end
+          service_module.const_defined? :Client
+        rescue ::LoadError
+          false
+        end
+
+        ##
+        # Create a new client object for LfpMerchantStateService.
+        #
+        # By default, this returns an instance of
+        # [Google::Shopping::Merchant::Lfp::V1beta::LfpMerchantStateService::Client](https://rubydoc.info/gems/google-shopping-merchant-lfp-v1beta/Google/Shopping/Merchant/Lfp/V1beta/LfpMerchantStateService/Client)
+        # for a gRPC client for version V1beta of the API.
+        # However, you can specify a different API version by passing it in the
+        # `version` parameter. If the LfpMerchantStateService service is
+        # supported by that API version, and the corresponding gem is available, the
+        # appropriate versioned client will be returned.
+        # You can also specify a different transport by passing `:rest` or `:grpc` in
+        # the `transport` parameter.
+        #
+        # Raises an exception if the currently installed versioned client gem for the
+        # given API version does not support the given transport of the LfpMerchantStateService service.
+        # You can determine whether the method will succeed by calling
+        # {Google::Shopping::Merchant::Lfp.lfp_merchant_state_service_available?}.
+        #
+        # ## About LfpMerchantStateService
+        #
+        # Service for a [LFP
+        # partner](https://support.google.com/merchants/answer/7676652) to get the
+        # state of a merchant.
+        #
+        # @param version [::String, ::Symbol] The API version to connect to. Optional.
+        #   Defaults to `:v1beta`.
+        # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+        # @return [::Object] A client object for the specified version.
+        #
+        def self.lfp_merchant_state_service version: :v1beta, transport: :grpc, &block
+          require "google/shopping/merchant/lfp/#{version.to_s.downcase}"
+
+          package_name = Google::Shopping::Merchant::Lfp
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          service_module = Google::Shopping::Merchant::Lfp.const_get(package_name).const_get(:LfpMerchantStateService)
+          service_module = service_module.const_get(:Rest) if transport == :rest
+          service_module.const_get(:Client).new(&block)
+        end
+
+        ##
+        # Determines whether the LfpMerchantStateService service is supported by the current client.
+        # If true, you can retrieve a client object by calling {Google::Shopping::Merchant::Lfp.lfp_merchant_state_service}.
+        # If false, that method will raise an exception. This could happen if the given
+        # API version does not exist or does not support the LfpMerchantStateService service,
+        # or if the versioned client gem needs an update to support the LfpMerchantStateService service.
+        #
+        # @param version [::String, ::Symbol] The API version to connect to. Optional.
+        #   Defaults to `:v1beta`.
+        # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+        # @return [boolean] Whether the service is available.
+        #
+        def self.lfp_merchant_state_service_available? version: :v1beta, transport: :grpc
+          require "google/shopping/merchant/lfp/#{version.to_s.downcase}"
+          package_name = Google::Shopping::Merchant::Lfp
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          return false unless package_name
+          service_module = Google::Shopping::Merchant::Lfp.const_get package_name
+          return false unless service_module.const_defined? :LfpMerchantStateService
+          service_module = service_module.const_get :LfpMerchantStateService
+          if transport == :rest
+            return false unless service_module.const_defined? :Rest
+            service_module = service_module.const_get :Rest
+          end
+          service_module.const_defined? :Client
+        rescue ::LoadError
+          false
+        end
+
         ##
         # Create a new client object for LfpSaleService.
         #
@@ -77,6 +185,11 @@ module Google
         # You can also specify a different transport by passing `:rest` or `:grpc` in
         # the `transport` parameter.
         #
+        # Raises an exception if the currently installed versioned client gem for the
+        # given API version does not support the given transport of the LfpSaleService service.
+        # You can determine whether the method will succeed by calling
+        # {Google::Shopping::Merchant::Lfp.lfp_sale_service_available?}.
+        #
         # ## About LfpSaleService
         #
         # Service for a [LFP
@@ -100,6 +213,37 @@ module Google
           service_module.const_get(:Client).new(&block)
         end
 
+        ##
+        # Determines whether the LfpSaleService service is supported by the current client.
+        # If true, you can retrieve a client object by calling {Google::Shopping::Merchant::Lfp.lfp_sale_service}.
+        # If false, that method will raise an exception. This could happen if the given
+        # API version does not exist or does not support the LfpSaleService service,
+        # or if the versioned client gem needs an update to support the LfpSaleService service.
+        #
+        # @param version [::String, ::Symbol] The API version to connect to. Optional.
+        #   Defaults to `:v1beta`.
+        # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+        # @return [boolean] Whether the service is available.
+        #
+        def self.lfp_sale_service_available? version: :v1beta, transport: :grpc
+          require "google/shopping/merchant/lfp/#{version.to_s.downcase}"
+          package_name = Google::Shopping::Merchant::Lfp
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          return false unless package_name
+          service_module = Google::Shopping::Merchant::Lfp.const_get package_name
+          return false unless service_module.const_defined? :LfpSaleService
+          service_module = service_module.const_get :LfpSaleService
+          if transport == :rest
+            return false unless service_module.const_defined? :Rest
+            service_module = service_module.const_get :Rest
+          end
+          service_module.const_defined? :Client
+        rescue ::LoadError
+          false
+        end
+
         ##
         # Create a new client object for LfpStoreService.
         #
@@ -113,6 +257,11 @@ module Google
         # You can also specify a different transport by passing `:rest` or `:grpc` in
         # the `transport` parameter.
         #
+        # Raises an exception if the currently installed versioned client gem for the
+        # given API version does not support the given transport of the LfpStoreService service.
+        # You can determine whether the method will succeed by calling
+        # {Google::Shopping::Merchant::Lfp.lfp_store_service_available?}.
+        #
         # ## About LfpStoreService
         #
         # Service for a [LFP
@@ -135,6 +284,37 @@ module Google
           service_module = service_module.const_get(:Rest) if transport == :rest
           service_module.const_get(:Client).new(&block)
         end
+
+        ##
+        # Determines whether the LfpStoreService service is supported by the current client.
+        # If true, you can retrieve a client object by calling {Google::Shopping::Merchant::Lfp.lfp_store_service}.
+        # If false, that method will raise an exception. This could happen if the given
+        # API version does not exist or does not support the LfpStoreService service,
+        # or if the versioned client gem needs an update to support the LfpStoreService service.
+        #
+        # @param version [::String, ::Symbol] The API version to connect to. Optional.
+        #   Defaults to `:v1beta`.
+        # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+        # @return [boolean] Whether the service is available.
+        #
+        def self.lfp_store_service_available? version: :v1beta, transport: :grpc
+          require "google/shopping/merchant/lfp/#{version.to_s.downcase}"
+          package_name = Google::Shopping::Merchant::Lfp
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          return false unless package_name
+          service_module = Google::Shopping::Merchant::Lfp.const_get package_name
+          return false unless service_module.const_defined? :LfpStoreService
+          service_module = service_module.const_get :LfpStoreService
+          if transport == :rest
+            return false unless service_module.const_defined? :Rest
+            service_module = service_module.const_get :Rest
+          end
+          service_module.const_defined? :Client
+        rescue ::LoadError
+          false
+        end
       end
     end
   end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-shopping-merchant-lfp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-25 00:00:00.000000000 Z
+date: 2025-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -44,7 +43,19 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
-description: Programmatically manage your Merchant Center accounts.
+description: 'Merchant API consists of multiple Sub-APIs. Accounts Sub-API: Enables
+  you to programmatically manage your accounts. Conversions Sub-API: Enables you to
+  programmatically manage your conversion sources for a merchant account. Datasources
+  Sub-API: Enables you to programmatically manage your datasources. Inventories Sub-API:
+  This bundle enables you to programmatically manage your local and regional inventories.
+  Local Feeds Partnerships Sub-API: This bundle enables LFP partners to submit local
+  inventories for a merchant. Notifications Sub-API: This bundle enables you to programmatically
+  manage your notification subscriptions. Products Sub-API: This bundle enables you
+  to programmatically manage your products. Promotions Sub-API: This bundle enables
+  you to programmatically manage your promotions for products. Quota Sub-API: This
+  bundle enables you to list your quotas for all APIs you are using. Reports Sub-API:
+  This bundle enables you to programmatically retrieve reports and insights about
+  products, their performance and their competitive environment.'
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -61,7 +72,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -69,15 +79,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.5
 specification_version: 4
-summary: Programmatically manage your Merchant Center accounts.
+summary: Programmatically manage your Merchant Center Accounts.
 test_files: []