Class: Google::Apis::MerchantapiAccountsV1beta::MerchantService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/merchantapi_accounts_v1beta/service.rb

Overview

Merchant API

Programmatically manage your Merchant Center Accounts.

Examples:

require 'google/apis/merchantapi_accounts_v1beta'

Merchantapi = Google::Apis::MerchantapiAccountsV1beta # Alias the module
service = Merchantapi::MerchantService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =
"https://merchantapi.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeMerchantService

Returns a new instance of MerchantService.



47
48
49
50
51
52
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-merchantapi_accounts_v1beta',
        client_version: Google::Apis::MerchantapiAccountsV1beta::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 40

def key
  @key
end

#quota_userString

Returns 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.

Returns:

  • (String)

    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.



45
46
47
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#accept_terms_of_service(name, account: nil, region_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::AcceptTermsOfServiceResponse

Accepts a TermsOfService. Executing this method requires admin access.

Parameters:

  • name (String)

    Required. The resource name of the terms of service version. Format: termsOfService/version``

  • account (String) (defaults to: nil)

    Required. The account for which to accept the ToS. Format: accounts/account``

  • region_code (String) (defaults to: nil)

    Required. Region code as defined by CLDR. This is either a country when the ToS applies specifically to that country or 001 when it applies globally.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2674

def accept_terms_of_service(name, account: nil, region_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+name}:accept', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AcceptTermsOfServiceResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::AcceptTermsOfServiceResponse
  command.params['name'] = name unless name.nil?
  command.query['account'] =  unless .nil?
  command.query['regionCode'] = region_code unless region_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#approve_account_service(name, approve_account_service_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::AccountService

Approve an account service proposal.

Parameters:

  • name (String)

    Required. The resource name of the account service to approve. Format: accounts/account/services/service``

  • approve_account_service_request_object (Google::Apis::MerchantapiAccountsV1beta::ApproveAccountServiceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2146

def (name,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+name}:approve', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::ApproveAccountServiceRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AccountService::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::AccountService
  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

#claim_homepage(name, claim_homepage_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Homepage

Claims a store's homepage. Executing this method requires admin access. If the homepage is already claimed, this will recheck the verification (unless the business is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message is returned: * PERMISSION_DENIED: User doesn't have the necessary permissions on this Merchant Center account. * FAILED_PRECONDITION: - The account is not a Merchant Center account. - Merchant Center account doesn' t have a homepage. - Claiming failed (in this case the error message contains more details).

Parameters:

  • name (String)

    Required. The name of the homepage to claim. Format: accounts/account/ homepage

  • claim_homepage_request_object (Google::Apis::MerchantapiAccountsV1beta::ClaimHomepageRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



945
946
947
948
949
950
951
952
953
954
955
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 945

def claim_homepage(name, claim_homepage_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+name}:claim', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::ClaimHomepageRequest::Representation
  command.request_object = claim_homepage_request_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Homepage::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::Homepage
  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

#create_account_omnichannel_setting(parent, omnichannel_setting_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting

Create the omnichannel settings for a given merchant.

Parameters:

  • parent (String)

    Required. The parent resource where this omnichannel setting will be created. Format: accounts/account``

  • omnichannel_setting_object (Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1138

def (parent, omnichannel_setting_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+parent}/omnichannelSettings', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting::Representation
  command.request_object = omnichannel_setting_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting
  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

#create_account_online_return_policy(parent, online_return_policy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy

Creates a new return policy for a given business.

Parameters:

  • parent (String)

    Required. The Merchant Center account for which the return policy will be created. Format: accounts/account``

  • online_return_policy_object (Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1400

def (parent, online_return_policy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+parent}/onlineReturnPolicies', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy::Representation
  command.request_object = online_return_policy_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy
  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

#create_account_program_checkout_setting(parent, checkout_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings

Creates CheckoutSettings for the given merchant.

Parameters:

  • parent (String)

    Required. The merchant account for which the CheckoutSettings will be created.

  • checkout_settings_object (Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1720

def (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

#create_account_region(parent, region_object = nil, region_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Region

Creates a region definition in your Merchant Center account. Executing this method requires admin access.

Parameters:

  • parent (String)

    Required. The account to create a region for. Format: accounts/account``

  • region_object (Google::Apis::MerchantapiAccountsV1beta::Region) (defaults to: nil)
  • region_id (String) (defaults to: nil)

    Required. The identifier for the region, unique over all regions of the same account.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1859

def (parent, region_object = nil, region_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+parent}/regions', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::Region::Representation
  command.request_object = region_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Region::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::Region
  command.params['parent'] = parent unless parent.nil?
  command.query['regionId'] = region_id unless region_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_account_test_account(parent, account_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Account

Creates a Merchant Center test account. Test accounts are intended for development and testing purposes, such as validating API integrations or new feature behavior. Key characteristics and limitations of test accounts: - Immutable Type: A test account cannot be converted into a regular (live) Merchant Center account. Likewise, a regular account cannot be converted into a test account. - Non-Serving Products: Any products, offers, or data created within a test account will not be published or made visible to end-users on any Google surfaces. They are strictly for testing environments. - Separate Environment: Test accounts operate in a sandbox-like manner, isolated from live serving and real user traffic.

Parameters:

  • parent (String)

    Required. The account resource name to create the test account under. Format: accounts/account

  • account_object (Google::Apis::MerchantapiAccountsV1beta::Account) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



116
117
118
119
120
121
122
123
124
125
126
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 116

def (parent,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+parent}:createTestAccount', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Account::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::Account
  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

#create_account_user(parent, user_object = nil, user_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::User

Creates a Merchant Center account user. Executing this method requires admin access.

Parameters:

  • parent (String)

    Required. The resource name of the account for which a user will be created. Format: accounts/account``

  • user_object (Google::Apis::MerchantapiAccountsV1beta::User) (defaults to: nil)
  • user_id (String) (defaults to: nil)

    Required. The email address of the user (for example, john.doe@gmail.com).

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2454

def (parent, user_object = nil, user_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+parent}/users', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::User::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::User
  command.params['parent'] = parent unless parent.nil?
  command.query['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_and_configure_account(create_and_configure_account_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Account

Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.

Parameters:

  • create_and_configure_account_request_object (Google::Apis::MerchantapiAccountsV1beta::CreateAndConfigureAccountRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



74
75
76
77
78
79
80
81
82
83
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 74

def ( = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/accounts:createAndConfigure', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::CreateAndConfigureAccountRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Account::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::Account
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_account(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Empty

Deletes the specified account regardless of its type: standalone, advanced account or sub-account. Deleting an advanced account leads to the deletion of all of its sub-accounts. This also deletes the account's developer registration entity and any associated GCP project to the account. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the force parameter to override this.

Parameters:

  • name (String)

    Required. The name of the account to delete. Format: accounts/account``

  • force (Boolean) (defaults to: nil)

    Optional. If set to true, the account is deleted even if it provides services to other accounts or has processed offers.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



158
159
160
161
162
163
164
165
166
167
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 158

def (name, force: nil, 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['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_account_online_return_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Empty

Deletes an existing return policy.

Parameters:

  • name (String)

    Required. The name of the return policy to delete. Format: accounts/account/ onlineReturnPolicies/return_policy``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1433
1434
1435
1436
1437
1438
1439
1440
1441
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1433

def (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

#delete_account_program_checkout_setting_checkout_settings(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Empty

Deletes CheckoutSettings and unenrolls merchant from Checkout program.

Parameters:

  • name (String)

    Required. The name/identifier of the merchant account. Format: accounts/ account/programs/program/checkoutSettings

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1753
1754
1755
1756
1757
1758
1759
1760
1761
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1753

def (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

#delete_account_region(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Empty

Deletes a region definition from your Merchant Center account. Executing this method requires admin access.

Parameters:

  • name (String)

    Required. The name of the region to delete. Format: accounts/account/ regions/region``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1894
1895
1896
1897
1898
1899
1900
1901
1902
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1894

def (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

#delete_account_user(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Empty

Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account.

Parameters:

  • name (String)

    Required. The name of the user to delete. Format: accounts/account/users/ email`It is also possible to delete the user corresponding to the caller by usingmerather than an email address as inaccounts/account/users/me`.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2490
2491
2492
2493
2494
2495
2496
2497
2498
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2490

def (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

#disable_program(name, disable_program_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Program

Disable participation in the specified program for the account.

Parameters:

  • name (String)

    Required. The name of the program for which to disable participation for the given account. Format: accounts/account/programs/program`. For example, accounts/123456/programs/free-listings`.

  • disable_program_request_object (Google::Apis::MerchantapiAccountsV1beta::DisableProgramRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1580

def disable_program(name, disable_program_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+name}:disable', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::DisableProgramRequest::Representation
  command.request_object = disable_program_request_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Program::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::Program
  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

#enable_program(name, enable_program_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Program

Enable participation in the specified program for the account.

Parameters:

  • name (String)

    Required. The name of the program for which to enable participation for the given account. Format: accounts/account/programs/program`. For example, accounts/123456/programs/free-listings`.

  • enable_program_request_object (Google::Apis::MerchantapiAccountsV1beta::EnableProgramRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1615

def enable_program(name, enable_program_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+name}:enable', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::EnableProgramRequest::Representation
  command.request_object = enable_program_request_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Program::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::Program
  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

#find_account_omnichannel_setting_lfp_provider(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::FindLfpProvidersResponse

Find the LFP provider candidates in a given country.

Parameters:

  • parent (String)

    Required. The name of the parent resource under which the LFP providers are found. Format: accounts/account/omnichannelSettings/omnichannel_setting``.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of LfpProvider resources to return. The service returns fewer than this value if the number of lfp providers is less that than the pageSize. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous FindLfpProviders call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to FindLfpProviders must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1331

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+parent}/lfpProviders:find', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::FindLfpProvidersResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::FindLfpProvidersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Account

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

Parameters:

  • name (String)

    Required. The name of the account to retrieve. Format: accounts/account``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



191
192
193
194
195
196
197
198
199
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 191

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Account::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::Account
  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

#get_account_autofeed_setting_autofeed_settings(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::AutofeedSettings

Retrieves the autofeed settings of an account.

Parameters:

  • name (String)

    Required. The resource name of the autofeed settings. Format: accounts/ account/autofeedSettings

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



352
353
354
355
356
357
358
359
360
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 352

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AutofeedSettings::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::AutofeedSettings
  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

#get_account_automatic_improvement_automatic_improvements(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::AutomaticImprovements

Retrieves the automatic improvements of an account.

Parameters:

  • name (String)

    Required. The resource name of the automatic improvements. Format: accounts/ account/automaticImprovements

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



420
421
422
423
424
425
426
427
428
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 420

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AutomaticImprovements::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::AutomaticImprovements
  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

#get_account_business_identity_business_identity(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::BusinessIdentity

Retrieves the business identity of an account.

Parameters:

  • name (String)

    Required. The resource name of the business identity. Format: accounts/ account/businessIdentity. For example, accounts/123456/businessIdentity.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



492
493
494
495
496
497
498
499
500
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 492

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::BusinessIdentity::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::BusinessIdentity
  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

#get_account_business_info_business_info(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::BusinessInfo

Retrieves the business info of an account.

Parameters:

  • name (String)

    Required. The resource name of the business info. Format: accounts/account/ businessInfo. For example, accounts/123456/businessInfo.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



563
564
565
566
567
568
569
570
571
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 563

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::BusinessInfo::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::BusinessInfo
  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

#get_account_developer_registration_account_for_gcp_registration(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::GetAccountForGcpRegistrationResponse

Retrieves the merchant account that the calling GCP is registered with.

Parameters:

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



631
632
633
634
635
636
637
638
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 631

def (fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/accounts:getAccountForGcpRegistration', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::GetAccountForGcpRegistrationResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::GetAccountForGcpRegistrationResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_developer_registration_developer_registration(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::DeveloperRegistration

Retrieves a developer registration for a merchant.

Parameters:

  • name (String)

    Required. The name (ID) of the developer registration.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



660
661
662
663
664
665
666
667
668
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 660

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::DeveloperRegistration::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::DeveloperRegistration
  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

#get_account_email_preference_email_preferences(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::EmailPreferences

Returns the email preferences for a Merchant Center account user. This service only permits retrieving and updating email preferences for the authenticated user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.

Parameters:

  • name (String)

    Required. The name of the EmailPreferences resource. Format: accounts/ account/users/email/emailPreferences

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



780
781
782
783
784
785
786
787
788
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 780

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::EmailPreferences::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::EmailPreferences
  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

#get_account_homepage_homepage(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Homepage

Retrieves a store's homepage.

Parameters:

  • name (String)

    Required. The name of the homepage to retrieve. Format: accounts/account/ homepage

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



978
979
980
981
982
983
984
985
986
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 978

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Homepage::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::Homepage
  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

#get_account_omnichannel_setting(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting

Get the omnichannel settings for a given merchant.

Parameters:

  • name (String)

    Required. The name of the omnichannel setting to retrieve. Format: accounts/ account/omnichannelSettings/omnichannel_setting``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1171
1172
1173
1174
1175
1176
1177
1178
1179
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1171

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting
  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

#get_account_online_return_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy

Gets an existing return policy for a given business.

Parameters:

  • name (String)

    Required. The name of the return policy to retrieve. Format: accounts/ account/onlineReturnPolicies/return_policy``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1464
1465
1466
1467
1468
1469
1470
1471
1472
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1464

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy
  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

#get_account_program(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Program

Retrieves the specified program for the account.

Parameters:

  • name (String)

    Required. The name of the program to retrieve. Format: accounts/account/ programs/program`. For example,accounts/123456/programs/free-listings`.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1648
1649
1650
1651
1652
1653
1654
1655
1656
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1648

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Program::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::Program
  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

#get_account_program_checkout_setting_checkout_settings(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings

Gets CheckoutSettings for the given merchant. This includes information about review state, enrollment state and URL settings.

Parameters:

  • name (String)

    Required. The name/identifier of the merchant account. Format: accounts/ account/programs/program/checkoutSettings

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1785

def (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

#get_account_region(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Region

Retrieves a region defined in your Merchant Center account.

Parameters:

  • name (String)

    Required. The name of the region to retrieve. Format: accounts/account/ regions/region``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1925
1926
1927
1928
1929
1930
1931
1932
1933
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1925

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Region::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::Region
  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

#get_account_relationship(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::AccountRelationship

Retrieve an account relationship.

Parameters:

  • name (String)

    Required. The resource name of the account relationship to get. Format: accounts/account/relationships/relationship`. For example,accounts/ 123456/relationships/567890`.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2036
2037
2038
2039
2040
2041
2042
2043
2044
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2036

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AccountRelationship::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::AccountRelationship
  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

#get_account_service(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::AccountService

Retrieve an account service.

Parameters:

  • name (String)

    Required. The resource name of the account service to get. Format: accounts/ account/services/service``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2179
2180
2181
2182
2183
2184
2185
2186
2187
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2179

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AccountService::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::AccountService
  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

#get_account_shipping_setting_shipping_settings(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::ShippingSettings

Retrieve shipping setting information.

Parameters:

  • name (String)

    Required. The name of the shipping setting to retrieve. Format: accounts/ account/shippingsettings

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2317
2318
2319
2320
2321
2322
2323
2324
2325
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2317

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ShippingSettings::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::ShippingSettings
  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

#get_account_terms_of_service_agreement_state(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::TermsOfServiceAgreementState

Returns the state of a terms of service agreement.

Parameters:

  • name (String)

    Required. The resource name of the terms of service version. Format: accounts/ account/termsOfServiceAgreementStates/identifierThe identifier format is: TermsOfServiceKind-country``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2386
2387
2388
2389
2390
2391
2392
2393
2394
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2386

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::TermsOfServiceAgreementState::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::TermsOfServiceAgreementState
  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

#get_account_user(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::User

Retrieves a Merchant Center account user.

Parameters:

  • name (String)

    Required. The name of the user to retrieve. Format: accounts/account/users/ email`It is also possible to retrieve the user corresponding to the caller by usingmerather than an email address as inaccounts/account/users/me`.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2522
2523
2524
2525
2526
2527
2528
2529
2530
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2522

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::User::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::User
  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

#get_terms_of_service(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::TermsOfService

Retrieves the TermsOfService associated with the provided version.

Parameters:

  • name (String)

    Required. The resource name of the terms of service version. Format: termsOfService/version``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2707
2708
2709
2710
2711
2712
2713
2714
2715
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2707

def get_terms_of_service(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::TermsOfService::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::TermsOfService
  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

#insert_account_shipping_setting(parent, shipping_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::ShippingSettings

Replace the shipping setting of a business with the request shipping setting. Executing this method requires admin access.

Parameters:

  • parent (String)

    Required. The account for which this shipping setting will be inserted. If you are using an advanced account, you must specify the unique identifier of the sub-account for which you want to insert the shipping setting. Format: accounts/ACCOUNT_ID``

  • shipping_settings_object (Google::Apis::MerchantapiAccountsV1beta::ShippingSettings) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2352

def (parent, shipping_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+parent}/shippingSettings:insert', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::ShippingSettings::Representation
  command.request_object = shipping_settings_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ShippingSettings::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::ShippingSettings
  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

Link the specified merchant to a GBP account for all countries. To run this method, you must have admin access to the Merchant Center account. If you don' t have admin access, the request fails with the error message User is not an administrator of accountACCOUNT_ID``.

Parameters:

  • parent (String)

    Required. The name of the parent resource to which the GBP account is linked. Format: accounts/account``.

  • link_gbp_account_request_object (Google::Apis::MerchantapiAccountsV1beta::LinkGbpAccountRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



858
859
860
861
862
863
864
865
866
867
868
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 858

def (parent,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+parent}/gbpAccounts:linkGbpAccount', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::LinkGbpAccountRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::LinkGbpAccountResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::LinkGbpAccountResponse
  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

Link the specified merchant to a LFP provider for the specified country.

Parameters:

  • name (String)

    Required. The name of the LFP provider resource to link. Format: accounts/ account/omnichannelSettings/omnichannel_setting/lfpProviders/lfp_provider` . Thelfp_provider` is the LFP provider ID.

  • link_lfp_provider_request_object (Google::Apis::MerchantapiAccountsV1beta::LinkLfpProviderRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1366

def link_lfp_provider(name, link_lfp_provider_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+name}:linkLfpProvider', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::LinkLfpProviderRequest::Representation
  command.request_object = link_lfp_provider_request_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::LinkLfpProviderResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::LinkLfpProviderResponse
  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

#list_account_gbp_accounts(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::ListGbpAccountsResponse

List the GBP accounts for a given merchant.

Parameters:

  • parent (String)

    Required. The name of the parent resource under which the GBP accounts are listed. Format: accounts/account``.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of GbpAccount resources to return. The service returns fewer than this value if the number of gbp accounts is less that than the pageSize. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous ListGbpAccounts call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListGbpAccounts must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



902
903
904
905
906
907
908
909
910
911
912
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 902

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+parent}/gbpAccounts', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListGbpAccountsResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListGbpAccountsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_issues(parent, language_code: nil, page_size: nil, page_token: nil, time_zone: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::ListAccountIssuesResponse

Lists all account issues of a Merchant Center account. When called on a multi- client account, this method only returns issues belonging to that account, not its sub-accounts. To retrieve issues for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call accounts.issues.list for each sub-account individually.

Parameters:

  • parent (String)

    Required. The parent, which owns this collection of issues. Format: accounts/ account``

  • language_code (String) (defaults to: nil)

    Optional. The issues in the response will have human-readable fields in the given language. The format is BCP-47, such as en-US or sr-Latn. If not value is provided, en-US will be used.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 50 issues will be returned. The maximum value is 100; values above 100 will be coerced to 100

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous ListAccountIssues call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccountIssues must match the call that provided the page token.

  • time_zone (String) (defaults to: nil)

    Optional. The IANA timezone used to localize times in human-readable fields. For example 'America/Los_Angeles'. If not set, 'America/Los_Angeles' will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1102

def (parent, language_code: nil, page_size: nil, page_token: nil, time_zone: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+parent}/issues', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListAccountIssuesResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListAccountIssuesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['timeZone'] = time_zone unless time_zone.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_omnichannel_settings(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::ListOmnichannelSettingsResponse

List all the omnichannel settings for a given merchant.

Parameters:

  • parent (String)

    Required. The parent, which owns this collection of omnichannel settings. Format: accounts/account``

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of omnichannel settings to return. The service may return fewer than this value. If unspecified, at most 50 omnichannel settings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous ListOmnichannelSettings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListOmnichannelSettings must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1212

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+parent}/omnichannelSettings', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListOmnichannelSettingsResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListOmnichannelSettingsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_online_return_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::ListOnlineReturnPoliciesResponse

Lists all existing return policies for a given business.

Parameters:

  • parent (String)

    Required. The Merchant Center account for which to list return policies. Format: accounts/account``

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of OnlineReturnPolicy resources to return. The service returns fewer than this value if the number of return policies for the given business is less that than the pageSize. The default value is 10. The maximum value is 100; If a value higher than the maximum is specified, then the pageSize will default to the maximum

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous ListOnlineReturnPolicies call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListOnlineReturnPolicies must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1507

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+parent}/onlineReturnPolicies', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListOnlineReturnPoliciesResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListOnlineReturnPoliciesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_programs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::ListProgramsResponse

Retrieves all programs for the account.

Parameters:

  • parent (String)

    Required. The name of the account for which to retrieve all programs. Format: accounts/account``

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of programs to return in a single response. If unspecified (or 0), a default size of 1000 is used. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    Optional. A continuation token, received from a previous ListPrograms call. Provide this to retrieve the next page.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1686

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+parent}/programs', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListProgramsResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListProgramsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_regions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::ListRegionsResponse

Lists the regions in your Merchant Center account.

Parameters:

  • parent (String)

    Required. The account to list regions for. Format: accounts/account``

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 regions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous ListRegions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRegions must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1963

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+parent}/regions', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListRegionsResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListRegionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_relationships(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::ListAccountRelationshipsResponse

List account relationships for the specified account.

Parameters:

  • parent (String)

    Required. The parent account of the account relationship to filter by. Format: accounts/account``

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of elements to return in the response. Use for paging. If no page_size is specified, 100 is used as the default value. The maximum allowed value is 1000.

  • page_token (String) (defaults to: nil)

    Optional. The token returned by the previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2073

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+parent}/relationships', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListAccountRelationshipsResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListAccountRelationshipsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_services(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::ListAccountServicesResponse

List account services for the specified accounts. Supports filtering.

Parameters:

  • parent (String)

    Required. The parent account of the account service to filter by. Format: accounts/account``

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of elements to return in the response. Use for paging. If no page_size is specified, 100 is used as the default value. The maximum allowed value is 1000.

  • page_token (String) (defaults to: nil)

    Optional. The token returned by the previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2216

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+parent}/services', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListAccountServicesResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListAccountServicesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_subaccounts(provider, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::ListSubAccountsResponse

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=parentAND service(type="ACCOUNT_AGGREGATION"))

Parameters:

  • provider (String)

    Required. The aggregation service provider. Format: accounts/accountId``

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous accounts.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided in the accounts.list request must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



280
281
282
283
284
285
286
287
288
289
290
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 280

def (provider, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+provider}:listSubaccounts', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListSubAccountsResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListSubAccountsResponse
  command.params['provider'] = provider unless provider.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_users(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::ListUsersResponse

Lists all users of a Merchant Center account.

Parameters:

  • parent (String)

    Required. The parent, which owns this collection of users. Format: accounts/ account``

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous ListUsers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUsers must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2561

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+parent}/users', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListUsersResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListUsersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_accounts(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::ListAccountsResponse

Note: For the accounts.list method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the accounts.listSubaccounts method, which is more suitable for advanced accounts use case.

Parameters:

  • filter (String) (defaults to: nil)

    Optional. Returns only accounts that match the filter. For more details, see the filter syntax reference.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous accounts.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided in the accounts.list request must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



236
237
238
239
240
241
242
243
244
245
246
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 236

def list_accounts(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/accounts', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListAccountsResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListAccountsResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_account(name, account_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Account

Updates an account regardless of its type: standalone, advanced account or sub- account. Executing this method requires admin access.

Parameters:

  • name (String)

    Identifier. The resource name of the account. Format: accounts/account``

  • account_object (Google::Apis::MerchantapiAccountsV1beta::Account) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): - account_name - adult_content - language_code - time_zone

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



318
319
320
321
322
323
324
325
326
327
328
329
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 318

def (name,  = 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::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Account::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::Account
  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

#patch_account_omnichannel_setting(name, omnichannel_setting_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting

Update the omnichannel setting for a given merchant in a given country.

Parameters:

  • name (String)

    Identifier. The resource name of the omnichannel setting. Format: accounts/ account/omnichannelSettings/omnichannel_setting``

  • omnichannel_setting_object (Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The list of fields to be updated. The following fields are supported in snake_case only: - lsf_type - in_stock - pickup - odo - about - inventory_verification Full replacement with wildcard *is supported, while empty/implied update mask is not.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1251

def (name, omnichannel_setting_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::OmnichannelSetting::Representation
  command.request_object = omnichannel_setting_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting
  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

#patch_account_online_return_policy(name, online_return_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy

Updates an existing return policy for a given business.

Parameters:

  • name (String)

    Identifier. The name of the OnlineReturnPolicy resource. Format: accounts/ account/onlineReturnPolicies/return_policy``

  • online_return_policy_object (Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Only support updating the entire OnlineReturnPolicy message. For update_mask, always use *.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1544

def (name, online_return_policy_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::OnlineReturnPolicy::Representation
  command.request_object = online_return_policy_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy
  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

#patch_account_region(name, region_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Region

Updates a region definition in your Merchant Center account. Executing this method requires admin access.

Parameters:

  • name (String)

    Identifier. The resource name of the region. Format: accounts/account/ regions/region``

  • region_object (Google::Apis::MerchantapiAccountsV1beta::Region) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. The comma-separated field mask indicating the fields to update. Example: "displayName,postalCodeArea.regionCode".

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2001

def (name, region_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::Region::Representation
  command.request_object = region_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Region::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::Region
  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

#patch_account_relationship(name, account_relationship_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::AccountRelationship

Updates the account relationship. Executing this method requires admin access.

Parameters:

  • name (String)

    Identifier. The resource name of the account relationship. Format: accounts/ account/relationships/relationship`. For example,accounts/123456/ relationships/567890`.

  • account_relationship_object (Google::Apis::MerchantapiAccountsV1beta::AccountRelationship) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): - account_id_alias

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2111

def (name,  = 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::AccountRelationship::Representation
  command.request_object = 
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AccountRelationship::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::AccountRelationship
  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

#patch_account_user(name, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::User

Updates a Merchant Center account user. Executing this method requires admin access.

Parameters:

  • name (String)

    Identifier. The resource name of the user. Format: accounts/account/user/ email`Usemeto refer to your own email address, for exampleaccounts/ account/users/me`.

  • user_object (Google::Apis::MerchantapiAccountsV1beta::User) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): - access_rights

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2600

def (name, user_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::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::User::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::User
  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

#propose_account_service(parent, propose_account_service_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::AccountService

Propose an account service.

Parameters:

  • parent (String)

    Required. The resource name of the parent account for the service. Format: accounts/account``

  • propose_account_service_request_object (Google::Apis::MerchantapiAccountsV1beta::ProposeAccountServiceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2250

def (parent,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+parent}/services:propose', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::ProposeAccountServiceRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AccountService::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::AccountService
  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

#register_developer_registration_gcp(name, register_gcp_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::DeveloperRegistration

Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the " developer_email" as a contact with "API notifications" email preference on. Restrictions: * The caller account must be authenticated and must not impersonate another account at registration time. Registering for subaccounts is not supported if the caller account is authenticated with the parent or the managing advanced account. * The caller account must have a verified website in Merchant Center. * Test accounts are not eligible for registration.

Parameters:

  • name (String)

    Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: accounts/ account/developerRegistration The account used must be the same account where user calling this API method is directly added to. Note: The account used must be a production account (can't be a test account ) and must have a verified website in Merchant Center.

  • register_gcp_request_object (Google::Apis::MerchantapiAccountsV1beta::RegisterGcpRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



707
708
709
710
711
712
713
714
715
716
717
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 707

def register_developer_registration_gcp(name, register_gcp_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+name}:registerGcp', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::RegisterGcpRequest::Representation
  command.request_object = register_gcp_request_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::DeveloperRegistration::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::DeveloperRegistration
  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

#reject_account_service(name, reject_account_service_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Empty

Reject an account service (both proposed and approve services can be rejected).

Parameters:

  • name (String)

    Required. The resource name of the account service to reject. Format: accounts/account/services/service``

  • reject_account_service_request_object (Google::Apis::MerchantapiAccountsV1beta::RejectAccountServiceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2284

def (name,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+name}:reject', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::RejectAccountServiceRequest::Representation
  command.request_object = 
  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

#request_omnichannel_setting_inventory_verification(name, request_inventory_verification_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::RequestInventoryVerificationResponse

Requests inventory verification for a given merchant in a given country.

Parameters:

  • name (String)

    Required. The name of the omnichannel setting to request inventory verification. Format: accounts/account/omnichannelSettings/ omnichannel_setting``

  • request_inventory_verification_request_object (Google::Apis::MerchantapiAccountsV1beta::RequestInventoryVerificationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1287

def request_omnichannel_setting_inventory_verification(name, request_inventory_verification_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+name}:requestInventoryVerification', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::RequestInventoryVerificationRequest::Representation
  command.request_object = request_inventory_verification_request_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::RequestInventoryVerificationResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::RequestInventoryVerificationResponse
  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

#retrieve_account_terms_of_service_agreement_state_for_application(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::TermsOfServiceAgreementState

Retrieves the state of the agreement for the application terms of service. Application terms of service covers permissions related to the usage of data provided through Merchant Center, CSS Center, Manufacturer Center, and more.

Parameters:

  • parent (String)

    Required. The account for which to get a TermsOfServiceAgreementState Format: accounts/account``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2419
2420
2421
2422
2423
2424
2425
2426
2427
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2419

def (parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+parent}/termsOfServiceAgreementStates:retrieveForApplication', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::TermsOfServiceAgreementState::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::TermsOfServiceAgreementState
  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

#retrieve_terms_of_service_latest(kind: nil, region_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::TermsOfService

Retrieves the latest version of the TermsOfService for a given kind and region_code.

Parameters:

  • kind (String) (defaults to: nil)

    Required. The Kind this terms of service version applies to.

  • region_code (String) (defaults to: nil)

    Required. Region code as defined by CLDR. This is either a country when the ToS applies specifically to that country or 001 when it applies globally.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2742

def retrieve_terms_of_service_latest(kind: nil, region_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/termsOfService:retrieveLatest', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::TermsOfService::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::TermsOfService
  command.query['kind'] = kind unless kind.nil?
  command.query['regionCode'] = region_code unless region_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unclaim_homepage(name, unclaim_homepage_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Homepage

Unclaims a store's homepage. Executing this method requires admin access.

Parameters:

  • name (String)

    Required. The name of the homepage to unclaim. Format: accounts/account/ homepage

  • unclaim_homepage_request_object (Google::Apis::MerchantapiAccountsV1beta::UnclaimHomepageRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1010

def unclaim_homepage(name, unclaim_homepage_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+name}:unclaim', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::UnclaimHomepageRequest::Representation
  command.request_object = unclaim_homepage_request_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Homepage::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::Homepage
  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

#unregister_developer_registration_gcp(name, unregister_gcp_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Empty

Unregister the calling GCP from the calling shopping account. Note that the GCP will still be able to access the API for at most 1 day from the unregister succussful call.

Parameters:

  • name (String)

    Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: accounts/ account/developerRegistration

  • unregister_gcp_request_object (Google::Apis::MerchantapiAccountsV1beta::UnregisterGcpRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



744
745
746
747
748
749
750
751
752
753
754
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 744

def unregister_developer_registration_gcp(name, unregister_gcp_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/v1beta/{+name}:unregisterGcp', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::UnregisterGcpRequest::Representation
  command.request_object = unregister_gcp_request_object
  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

#update_account_autofeed_setting_autofeed_settings(name, autofeed_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::AutofeedSettings

Updates the autofeed settings of an account.

Parameters:

  • name (String)

    Identifier. The resource name of the autofeed settings. Format: accounts/ account/autofeedSettings.

  • autofeed_settings_object (Google::Apis::MerchantapiAccountsV1beta::AutofeedSettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. List of fields being updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



386
387
388
389
390
391
392
393
394
395
396
397
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 386

def (name, autofeed_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::AutofeedSettings::Representation
  command.request_object = autofeed_settings_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AutofeedSettings::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::AutofeedSettings
  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

#update_account_automatic_improvement_automatic_improvements(name, automatic_improvements_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::AutomaticImprovements

Updates the automatic improvements of an account.

Parameters:

  • name (String)

    Identifier. The resource name of the automatic improvements. Format: accounts/ account/automaticImprovements.

  • automatic_improvements_object (Google::Apis::MerchantapiAccountsV1beta::AutomaticImprovements) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): - item_updates - item_updates. account_level_settings - image_improvements - image_improvements. account_level_settings - shipping_improvements - shipping_improvements. allow_shipping_improvements

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



458
459
460
461
462
463
464
465
466
467
468
469
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 458

def (name, automatic_improvements_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::AutomaticImprovements::Representation
  command.request_object = automatic_improvements_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AutomaticImprovements::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::AutomaticImprovements
  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

#update_account_business_identity_business_identity(name, business_identity_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::BusinessIdentity

Updates the business identity of an account. Executing this method requires admin access.

Parameters:

  • name (String)

    Identifier. The resource name of the business identity. Format: accounts/ account/businessIdentity

  • business_identity_object (Google::Apis::MerchantapiAccountsV1beta::BusinessIdentity) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): - black_owned - latino_owned - promotions_consent - small_business - veteran_owned - women_owned

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



529
530
531
532
533
534
535
536
537
538
539
540
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 529

def (name, business_identity_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::BusinessIdentity::Representation
  command.request_object = business_identity_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::BusinessIdentity::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::BusinessIdentity
  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

#update_account_business_info_business_info(name, business_info_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::BusinessInfo

Updates the business info of an account. Executing this method requires admin access.

Parameters:

  • name (String)

    Identifier. The resource name of the business info. Format: accounts/account /businessInfo

  • business_info_object (Google::Apis::MerchantapiAccountsV1beta::BusinessInfo) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): - address - customer_service - korean_business_registration_number

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



600
601
602
603
604
605
606
607
608
609
610
611
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 600

def (name, business_info_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::BusinessInfo::Representation
  command.request_object = business_info_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::BusinessInfo::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::BusinessInfo
  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

#update_account_email_preference_email_preferences(name, email_preferences_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::EmailPreferences

Updates the email preferences for a Merchant Center account user. Advanced account users should specify the advanced account rather than a sub-account of the advanced account. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/ emailPreferences alias to update preferences for the authenticated user.

Parameters:

  • name (String)

    Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.

  • email_preferences_object (Google::Apis::MerchantapiAccountsV1beta::EmailPreferences) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): - news_and_tips

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



820
821
822
823
824
825
826
827
828
829
830
831
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 820

def (name, email_preferences_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::EmailPreferences::Representation
  command.request_object = email_preferences_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::EmailPreferences::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::EmailPreferences
  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

#update_account_homepage_homepage(name, homepage_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Homepage

Updates a store's homepage. Executing this method requires admin access.

Parameters:

  • name (String)

    Identifier. The resource name of the store's homepage. Format: accounts/ account/homepage

  • homepage_object (Google::Apis::MerchantapiAccountsV1beta::Homepage) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): - uri

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1047

def (name, homepage_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::Homepage::Representation
  command.request_object = homepage_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Homepage::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::Homepage
  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

#update_account_program_checkout_setting_checkout_settings(name, checkout_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings

Updates CheckoutSettings for the given merchant.

Parameters:

  • name (String)

    Identifier. The resource name of the program configuration settings. Format: accounts/account/programs/program/checkoutSettings

  • checkout_settings_object (Google::Apis::MerchantapiAccountsV1beta::CheckoutSettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): - eligible_destinations - uri_settings

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1821

def (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

#verify_me_self(account, verify_self_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::User

Updates the user that is represented by the caller from pending to verified.

Parameters:

  • account (String)

    Required. The name of the account under which the caller is a user. Format: accounts/account``

  • verify_self_request_object (Google::Apis::MerchantapiAccountsV1beta::VerifySelfRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2635

def verify_me_self(, verify_self_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'accounts/v1beta/{+account}/users/me:verifySelf', options)
  command.request_representation = Google::Apis::MerchantapiAccountsV1beta::VerifySelfRequest::Representation
  command.request_object = verify_self_request_object
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::User::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::User
  command.params['account'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end