google-apis-merchantapi_accounts_v1beta 0.15.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ac41317f4629b9f250e6858e4b5cb970cd0ad85d8ac185aa89b2f2a4660bf81
-  data.tar.gz: def5efc40668436d863f4775c1d12e8f00fd90f9230eb295518a0a55ad468939
+  metadata.gz: 85ed895c20124b840e23e363906b043bfbbe02260ac4826dd257651ed2390d67
+  data.tar.gz: 6d2f63f30a5bd92b1311f7da13e3f4bbf6c81750cd690b02ce0e12ff61ab3739
 SHA512:
-  metadata.gz: a351c91f29ef076e76ec9a925499cd3189b28aa25dc8a07b06fec0e75e156402a102762f1f0eb80e66c5f81e51b852edbc9a8b6747ea1ee738d1134caba791df
-  data.tar.gz: 6b1224bded0809122f59c3f30f378e2c56b818e4904f289553ed226c9999a4a10d12c7a13a46b4370369214b288dfce18a4cb3122f7c3f42be21e093de710b52
+  metadata.gz: aa49005b03477e0375c0c6fe67d06c4de58a0b5853e03f4c4d0861c00e998cb811614dcbb6fd360c909d3bc1e5d82b98cb1d1f972e2c601fdf5986d7ea847f3a
+  data.tar.gz: b12de1bbb6d3da47b8891a6cbe33ba46d1caeb181c1be6c17fd9799332715b11dda09b06da04a5de484f95099174a5435876df375956af84dad9474c6e930584

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-merchantapi_accounts_v1beta
 
+### v0.17.0 (2025-07-06)
+
+* Regenerated from discovery document revision 20250628
+
+### v0.16.0 (2025-06-29)
+
+* Regenerated from discovery document revision 20250621
+
 ### v0.15.0 (2025-06-22)
 
 * Regenerated from discovery document revision 20250618

data/OVERVIEW.md

@@ -79,7 +79,7 @@ Gem names for modern clients are often of the form `google-cloud-<service_name>`
 
 **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
 
-The [product documentation](https://developers.devsite.corp.google.com/merchant/api) may provide guidance regarding the preferred client library to use.
+The [product documentation](https://developers.google.com/merchant/api) may provide guidance regarding the preferred client library to use.
 
 ## Supported Ruby versions
 

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

@@ -990,6 +990,81 @@ module Google
         end
       end
       
+      # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a
+      # specific merchant.
+      class CheckoutSettings
+        include Google::Apis::Core::Hashable
+      
+        # Output only. The effective value of enrollment_state for a given merchant ID.
+        # If account level settings are present then this value will be a copy of the
+        # account level settings. Otherwise, it will have the value of the parent
+        # account (for only marketplace sellers).
+        # Corresponds to the JSON property `effectiveEnrollmentState`
+        # @return [String]
+        attr_accessor :effective_enrollment_state
+      
+        # Output only. The effective value of `review_state` for a given merchant ID. If
+        # account level settings are present then this value will be a copy of the
+        # account level settings. Otherwise, it will have the value of the parent
+        # account (for only marketplace sellers).
+        # Corresponds to the JSON property `effectiveReviewState`
+        # @return [String]
+        attr_accessor :effective_review_state
+      
+        # URL settings for cart or checkout URL.
+        # Corresponds to the JSON property `effectiveUriSettings`
+        # @return [Google::Apis::MerchantapiAccountsV1beta::UriSettings]
+        attr_accessor :effective_uri_settings
+      
+        # Optional. The destinations to which the checkout program applies, valid
+        # destination values are `SHOPPING_ADS`, `FREE_LISTINGS`
+        # Corresponds to the JSON property `eligibleDestinations`
+        # @return [Array<String>]
+        attr_accessor :eligible_destinations
+      
+        # Output only. Reflects the merchant enrollment state in `Checkout` program.
+        # Corresponds to the JSON property `enrollmentState`
+        # @return [String]
+        attr_accessor :enrollment_state
+      
+        # Identifier. The resource name of the program configuration settings. Format: `
+        # accounts/`account`/programs/`program`/checkoutSettings`
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Output only. Reflects the merchant review state in `Checkout` program. This is
+        # set based on the data quality reviews of the URL provided by the merchant. A
+        # merchant with enrollment state as `ENROLLED` can be in the following review
+        # states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an `
+        # enrollment_state` of `ENROLLED` before a review can begin for the merchant.For
+        # more details, check the help center doc.
+        # Corresponds to the JSON property `reviewState`
+        # @return [String]
+        attr_accessor :review_state
+      
+        # URL settings for cart or checkout URL.
+        # Corresponds to the JSON property `uriSettings`
+        # @return [Google::Apis::MerchantapiAccountsV1beta::UriSettings]
+        attr_accessor :uri_settings
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @effective_enrollment_state = args[:effective_enrollment_state] if args.key?(:effective_enrollment_state)
+          @effective_review_state = args[:effective_review_state] if args.key?(:effective_review_state)
+          @effective_uri_settings = args[:effective_uri_settings] if args.key?(:effective_uri_settings)
+          @eligible_destinations = args[:eligible_destinations] if args.key?(:eligible_destinations)
+          @enrollment_state = args[:enrollment_state] if args.key?(:enrollment_state)
+          @name = args[:name] if args.key?(:name)
+          @review_state = args[:review_state] if args.key?(:review_state)
+          @uri_settings = args[:uri_settings] if args.key?(:uri_settings)
+        end
+      end
+      
       # Request message for the `ClaimHomepage` method.
       class ClaimHomepageRequest
         include Google::Apis::Core::Hashable
@@ -2088,7 +2163,7 @@ module Google
         end
       end
       
-      # Response message for the `ListAccounts` method.
+      # Response message for the `accounts.list` method.
       class ListAccountsResponse
         include Google::Apis::Core::Hashable
       
@@ -4116,6 +4191,39 @@ module Google
         end
       end
       
+      # URL settings for cart or checkout URL.
+      class UriSettings
+        include Google::Apis::Core::Hashable
+      
+        # Cart URL template. When the placeholders are expanded will redirect the buyer
+        # to the cart page on the merchant website with the selected item in cart. For
+        # more details, check the [help center doc](https://support.google.com/merchants/
+        # answer/13945960#method1&zippy=%2Cproduct-level-url-formatting%2Caccount-level-
+        # url-formatting)
+        # Corresponds to the JSON property `cartUriTemplate`
+        # @return [String]
+        attr_accessor :cart_uri_template
+      
+        # Checkout URL template. When the placeholders are expanded will redirect the
+        # buyer to the merchant checkout page with the item in the cart. For more
+        # details, check the [help center doc](https://support.google.com/merchants/
+        # answer/13945960#method1&zippy=%2Cproduct-level-url-formatting%2Caccount-level-
+        # url-formatting)
+        # Corresponds to the JSON property `checkoutUriTemplate`
+        # @return [String]
+        attr_accessor :checkout_uri_template
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @cart_uri_template = args[:cart_uri_template] if args.key?(:cart_uri_template)
+          @checkout_uri_template = args[:checkout_uri_template] if args.key?(:checkout_uri_template)
+        end
+      end
+      
       # The `User` message represents a user associated with a Merchant Center account.
       # It is used to manage user permissions and access rights within the account.
       # For more information, see [Frequently asked questions about people and access

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module MerchantapiAccountsV1beta
       # Version of the google-apis-merchantapi_accounts_v1beta gem
-      GEM_VERSION = "0.15.0"
+      GEM_VERSION = "0.17.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.18.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20250618"
+      REVISION = "20250628"
     end
   end
 end

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

@@ -160,6 +160,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class CheckoutSettings
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ClaimHomepageRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -688,6 +694,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class UriSettings
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class User
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -966,6 +978,22 @@ module Google
         end
       end
       
+      class CheckoutSettings
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :effective_enrollment_state, as: 'effectiveEnrollmentState'
+          property :effective_review_state, as: 'effectiveReviewState'
+          property :effective_uri_settings, as: 'effectiveUriSettings', class: Google::Apis::MerchantapiAccountsV1beta::UriSettings, decorator: Google::Apis::MerchantapiAccountsV1beta::UriSettings::Representation
+      
+          collection :eligible_destinations, as: 'eligibleDestinations'
+          property :enrollment_state, as: 'enrollmentState'
+          property :name, as: 'name'
+          property :review_state, as: 'reviewState'
+          property :uri_settings, as: 'uriSettings', class: Google::Apis::MerchantapiAccountsV1beta::UriSettings, decorator: Google::Apis::MerchantapiAccountsV1beta::UriSettings::Representation
+      
+        end
+      end
+      
       class ClaimHomepageRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1821,6 +1849,14 @@ module Google
         end
       end
       
+      class UriSettings
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :cart_uri_template, as: 'cartUriTemplate'
+          property :checkout_uri_template, as: 'checkoutUriTemplate'
+        end
+      end
+      
       class User
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -30,7 +30,7 @@ module Google
       #    Merchantapi = Google::Apis::MerchantapiAccountsV1beta # Alias the module
       #    service = Merchantapi::MerchantService.new
       #
-      # @see https://developers.devsite.corp.google.com/merchant/api
+      # @see https://developers.google.com/merchant/api
       class MerchantService < Google::Apis::Core::BaseService
         DEFAULT_ENDPOINT_TEMPLATE = "https://merchantapi.$UNIVERSE_DOMAIN$/"
 
@@ -167,9 +167,10 @@ module Google
         #   fewer than this value. If unspecified, at most 250 accounts are returned. The
         #   maximum value is 500; values above 500 are coerced to 500.
         # @param [String] page_token
-        #   Optional. A page token, received from a previous `ListAccounts` call. Provide
+        #   Optional. A page token, received from a previous `accounts.list` call. Provide
         #   this to retrieve the subsequent page. When paginating, all other parameters
-        #   provided to `ListAccounts` must match the call that provided the page token.
+        #   provided in the `accounts.list` request must match the call that provided the
+        #   page token.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -199,8 +200,8 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # List all sub-accounts for a given multi client account. This is a convenience
-        # wrapper for the more powerful `ListAccounts` method. This method will produce
+        # List all sub-accounts for a given advanced account. This is a convenience
+        # wrapper for the more powerful `accounts.list` method. This method will produce
         # the same results as calling `ListsAccounts` with the following filter: `
         # relationship(providerId=`parent` AND service(type="ACCOUNT_AGGREGATION"))`
         # @param [String] provider
@@ -210,9 +211,10 @@ module Google
         #   fewer than this value. If unspecified, at most 250 accounts are returned. The
         #   maximum value is 500; values above 500 are coerced to 500.
         # @param [String] page_token
-        #   Optional. A page token, received from a previous `ListAccounts` call. Provide
+        #   Optional. A page token, received from a previous `accounts.list` call. Provide
         #   this to retrieve the subsequent page. When paginating, all other parameters
-        #   provided to `ListAccounts` must match the call that provided the page token.
+        #   provided in the `accounts.list` request must match the call that provided the
+        #   page token.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1508,6 +1510,142 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Creates `CheckoutSettings` for the given merchant.
+        # @param [String] parent
+        #   Required. The merchant account for which the `CheckoutSettings` will be
+        #   created.
+        # @param [Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings] checkout_settings_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::MerchantapiAccountsV1beta::CheckoutSettings] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings]
+        #
+        # @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 create_account_program_checkout_setting(parent, checkout_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'accounts/v1beta/{+parent}/checkoutSettings', options)
+          command.request_representation = Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings::Representation
+          command.request_object = checkout_settings_object
+          command.response_representation = Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings::Representation
+          command.response_class = Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Deletes `CheckoutSettings` and unenrolls merchant from `Checkout` program.
+        # @param [String] name
+        #   Required. The name/identifier of the merchant account. Format: `accounts/`
+        #   account`/programs/`program`/checkoutSettings`
+        # @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::MerchantapiAccountsV1beta::Empty] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::MerchantapiAccountsV1beta::Empty]
+        #
+        # @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 delete_account_program_checkout_setting_checkout_settings(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:delete, 'accounts/v1beta/{+name}', options)
+          command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Empty::Representation
+          command.response_class = Google::Apis::MerchantapiAccountsV1beta::Empty
+          command.params['name'] = name unless name.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 `CheckoutSettings` for the given merchant. This includes information
+        # about review state, enrollment state and URL settings.
+        # @param [String] name
+        #   Required. The name/identifier of the merchant account. Format: `accounts/`
+        #   account`/programs/`program`/checkoutSettings`
+        # @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::MerchantapiAccountsV1beta::CheckoutSettings] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings]
+        #
+        # @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_account_program_checkout_setting_checkout_settings(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
+          command.response_representation = Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings::Representation
+          command.response_class = Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Updates `CheckoutSettings` for the given merchant.
+        # @param [String] name
+        #   Identifier. The resource name of the program configuration settings. Format: `
+        #   accounts/`account`/programs/`program`/checkoutSettings`
+        # @param [Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings] checkout_settings_object
+        # @param [String] update_mask
+        #   Required. List of fields being updated. The following fields are supported (in
+        #   both `snake_case` and `lowerCamelCase`): - `eligible_destinations` - `
+        #   uri_settings`
+        # @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::MerchantapiAccountsV1beta::CheckoutSettings] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings]
+        #
+        # @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 update_account_program_checkout_setting_checkout_settings(name, checkout_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'accounts/v1beta/{+name}', options)
+          command.request_representation = Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings::Representation
+          command.request_object = checkout_settings_object
+          command.response_representation = Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings::Representation
+          command.response_class = Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings
+          command.params['name'] = name unless name.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a region definition in your Merchant Center account. Executing this
         # method requires admin access.
         # @param [String] parent

data/lib/google/apis/merchantapi_accounts_v1beta.rb

@@ -23,7 +23,7 @@ module Google
     #
     # Programmatically manage your Merchant Center Accounts.
     #
-    # @see https://developers.devsite.corp.google.com/merchant/api
+    # @see https://developers.google.com/merchant/api
     module MerchantapiAccountsV1beta
       # Version of the Merchant API this client connects to.
       # This is NOT the gem version.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-merchantapi_accounts_v1beta
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Google LLC
@@ -57,7 +57,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-merchantapi_accounts_v1beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-merchantapi_accounts_v1beta/v0.15.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-merchantapi_accounts_v1beta/v0.17.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-merchantapi_accounts_v1beta
 rdoc_options: []
 require_paths: