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



2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2663

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



2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2135

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



934
935
936
937
938
939
940
941
942
943
944
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 934

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



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1127

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



1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1389

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



1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1709

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



1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1848

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



2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2443

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



1422
1423
1424
1425
1426
1427
1428
1429
1430
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1422

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



1742
1743
1744
1745
1746
1747
1748
1749
1750
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1742

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



1883
1884
1885
1886
1887
1888
1889
1890
1891
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1883

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



2479
2480
2481
2482
2483
2484
2485
2486
2487
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2479

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



1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1569

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



1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1604

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



1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1320

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



769
770
771
772
773
774
775
776
777
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 769

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



967
968
969
970
971
972
973
974
975
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 967

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



1160
1161
1162
1163
1164
1165
1166
1167
1168
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1160

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



1453
1454
1455
1456
1457
1458
1459
1460
1461
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1453

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



1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1637

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



1774
1775
1776
1777
1778
1779
1780
1781
1782
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1774

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



1914
1915
1916
1917
1918
1919
1920
1921
1922
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1914

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



2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2025

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



2168
2169
2170
2171
2172
2173
2174
2175
2176
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2168

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



2306
2307
2308
2309
2310
2311
2312
2313
2314
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2306

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



2375
2376
2377
2378
2379
2380
2381
2382
2383
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2375

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



2511
2512
2513
2514
2515
2516
2517
2518
2519
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2511

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



2696
2697
2698
2699
2700
2701
2702
2703
2704
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2696

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



2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2341

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



847
848
849
850
851
852
853
854
855
856
857
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 847

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



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1355

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



891
892
893
894
895
896
897
898
899
900
901
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 891

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



1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1091

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



1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1201

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



1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1496

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



1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1675

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



1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1952

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



2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2062

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



2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2205

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



2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2550

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



1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1240

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



1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1533

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



1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1990

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



2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2100

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



2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2589

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



2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2239

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.

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.

  • 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



696
697
698
699
700
701
702
703
704
705
706
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 696

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



2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2273

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



1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1276

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



2408
2409
2410
2411
2412
2413
2414
2415
2416
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2408

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



2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2731

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



999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 999

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



733
734
735
736
737
738
739
740
741
742
743
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 733

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



809
810
811
812
813
814
815
816
817
818
819
820
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 809

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



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1036

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



1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1810

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



2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 2624

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