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

#initialize ⇒ MerchantService

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

#key ⇒ String

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_user ⇒ String

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::Empty

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.

  • 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



1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1525

def accept_terms_of_service(name, account: nil, region_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+name}:accept', 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['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

#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 merchant 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 will be returned: * PERMISSION_DENIED: user doesn't have the necessary permissions on this MC account; * FAILED_PRECONDITION: - The account is not a Merchant Center account; - MC account doesn't have a homepage; - claiming failed (in this case the error message will contain 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



647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 647

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_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



988
989
990
991
992
993
994
995
996
997
998
999
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 988

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_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



1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1265

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 standalone 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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::Empty

Deletes the specified account regardless of its type: standalone, MCA or sub- account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access.

Parameters:

  • name (String) —

    Required. The name of the account to delete. 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



107
108
109
110
111
112
113
114
115
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 107

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



1023
1024
1025
1026
1027
1028
1029
1030
1031
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1023

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.

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



1301
1302
1303
1304
1305
1306
1307
1308
1309
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1301

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. Executing this method requires admin access.

Parameters:

  • name (String) —

    Required. The name of the program for which to disable participation for the given account. Format: accounts/account/programs/program``

  • 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



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

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. Executing this method requires admin access.

Parameters:

  • name (String) —

    Required. The name of the program for which to enable participation for the given account. Format: accounts/account/programs/program``

  • 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



880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 880

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

#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



139
140
141
142
143
144
145
146
147
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 139

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_accounttax(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::AccountTax

Returns the tax rules that match the conditions of GetAccountTaxRequest

Parameters:

  • name (String) —

    Required. The name from which tax settings will be retrieved

  • 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



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

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::AccountTax::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::AccountTax
  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(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

  • 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



170
171
172
173
174
175
176
177
178
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 170

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

  • 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



201
202
203
204
205
206
207
208
209
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 201

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_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



232
233
234
235
236
237
238
239
240
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 232

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_online_return_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy

Gets an existing return policy.

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



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

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``

  • 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



913
914
915
916
917
918
919
920
921
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 913

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_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



1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1054

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_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/shippingsetting

  • 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



263
264
265
266
267
268
269
270
271
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 263

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/termsOfServiceAgreementState/identifier``

  • 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



1199
1200
1201
1202
1203
1204
1205
1206
1207
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1199

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



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

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



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

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_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



1558
1559
1560
1561
1562
1563
1564
1565
1566
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1558

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 merchant with the request shipping setting. Executing this method requires admin access.

Parameters:

  • parent (String) —

    Required. The account where this product will be inserted. Format: accounts/ account

  • 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



1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1166

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

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

Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.

Parameters:

  • parent (String) —

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

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of tax settings to return in the response, used for paging.

  • page_token (String) (defaults to: nil) —

    The token returned by 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



568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 568

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/v1beta/{+parent}/accounttax', options)
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListAccountTaxResponse::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListAccountTaxResponse
  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_id: nil, time_zone_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::ListAccountIssuesResponse

Lists all account issues of a Merchant Center account.

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 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 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_id (String) (defaults to: nil) —

    IANA Time Zone Database time zone, e.g. "America/New_York".

  • time_zone_version (String) (defaults to: nil) —

    Optional. IANA Time Zone Database version number, e.g. "2019a".

  • 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



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

def (parent, language_code: nil, page_size: nil, page_token: nil, time_zone_id: nil, time_zone_version: 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.id'] = time_zone_id unless time_zone_id.nil?
  command.query['timeZone.version'] = time_zone_version unless time_zone_version.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.

Parameters:

  • parent (String) —

    Required. The merchant 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 merchant 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



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

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



951
952
953
954
955
956
957
958
959
960
961
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 951

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



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

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_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 multi client account. This is a convenience wrapper for the more powerful ListAccounts 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 parent account. Format: accounts/account``

  • 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 ListAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccounts must match the call that provided the page token.

  • 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



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

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



1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1405

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

Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub- accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.

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 ListAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccounts must match the call that provided the page token.

  • 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



306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 306

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, MCA 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) —

    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



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

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_accounttax(name, account_tax_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiAccountsV1beta::AccountTax

Updates the tax settings of the account.

Parameters:

  • name (String) —

    Identifier. The name of the tax setting. Format: "account_tax.name=accounts/ account``"

  • account_tax_object (Google::Apis::MerchantapiAccountsV1beta::AccountTax) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to be 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



604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 604

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::AccountTax::Representation
  command.request_object = 
  command.response_representation = Google::Apis::MerchantapiAccountsV1beta::AccountTax::Representation
  command.response_class = Google::Apis::MerchantapiAccountsV1beta::AccountTax
  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



1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1130

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_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) —

    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



1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1443

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

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

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



1230
1231
1232
1233
1234
1235
1236
1237
1238
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1230

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) —

    The Kind this terms of service version applies to.

  • region_code (String) (defaults to: nil) —

    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



1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1593

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



681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 681

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

#update_account_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) —

    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



423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 423

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(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) —

    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



461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 461

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_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) —

    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



498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 498

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_user_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. MCA users should specify the MCA account rather than a sub-account of the MCA. 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.

  • 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



1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/service.rb', line 1485

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