Class: Google::Apis::ContentV2_1::ShoppingContentService

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

Overview

Content API for Shopping

Manage your product listings and accounts for Google Shopping

Examples:

require 'google/apis/content_v2_1'

Content = Google::Apis::ContentV2_1 # Alias the module
service = Content::ShoppingContentService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeShoppingContentService

Returns a new instance of ShoppingContentService.



45
46
47
48
49
50
# File 'lib/google/apis/content_v2_1/service.rb', line 45

def initialize
  super('https://shoppingcontent.googleapis.com/', 'content/v2.1/',
        client_name: 'google-apis-content_v2_1',
        client_version: Google::Apis::ContentV2_1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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

Returns:

  • (String)

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



38
39
40
# File 'lib/google/apis/content_v2_1/service.rb', line 38

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



43
44
45
# File 'lib/google/apis/content_v2_1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#acknowledge_order(merchant_id, order_id, orders_acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersAcknowledgeResponse

Marks an order as acknowledged.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order.

  • orders_acknowledge_request_object (Google::Apis::ContentV2_1::OrdersAcknowledgeRequest) (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



2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
# File 'lib/google/apis/content_v2_1/service.rb', line 2802

def acknowledge_order(merchant_id, order_id, orders_acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/acknowledge', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersAcknowledgeRequest::Representation
  command.request_object = orders_acknowledge_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersAcknowledgeResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersAcknowledgeResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#acknowledge_orderreturn(merchant_id, return_id, orderreturns_acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrderreturnsAcknowledgeResponse

Acks an order return in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • return_id (String)

    The ID of the return.

  • orderreturns_acknowledge_request_object (Google::Apis::ContentV2_1::OrderreturnsAcknowledgeRequest) (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



2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
# File 'lib/google/apis/content_v2_1/service.rb', line 2531

def acknowledge_orderreturn(merchant_id, return_id, orderreturns_acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orderreturns/{returnId}/acknowledge', options)
  command.request_representation = Google::Apis::ContentV2_1::OrderreturnsAcknowledgeRequest::Representation
  command.request_object = orderreturns_acknowledge_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrderreturnsAcknowledgeResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrderreturnsAcknowledgeResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['returnId'] = return_id unless return_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

#activate_buyongoogleprogram_buy_on_google_program(merchant_id, region_code, activate_buy_on_google_program_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Reactivates the BoG program in your Merchant Center account. Moves the program to the active state when allowed, e.g. when paused. Important: This method is only whitelisted for selected merchants.

Parameters:

  • merchant_id (Fixnum)

    Required. The ID of the account.

  • region_code (String)

    The program region code ISO 3166-1 alpha-2. Currently only US is available.

  • activate_buy_on_google_program_request_object (Google::Apis::ContentV2_1::ActivateBuyOnGoogleProgramRequest) (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:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



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

def activate_buyongoogleprogram_buy_on_google_program(merchant_id, region_code, activate_buy_on_google_program_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/buyongoogleprograms/{regionCode}/activate', options)
  command.request_representation = Google::Apis::ContentV2_1::ActivateBuyOnGoogleProgramRequest::Representation
  command.request_object = activate_buy_on_google_program_request_object
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['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

#advancetestorder_order(merchant_id, order_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersAdvanceTestOrderResponse

Sandbox only. Moves a test order from state "inProgress" to state " pendingShipment".

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the test order to modify.

  • 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



2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
# File 'lib/google/apis/content_v2_1/service.rb', line 2839

def advancetestorder_order(merchant_id, order_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/testorders/{orderId}/advance', options)
  command.response_representation = Google::Apis::ContentV2_1::OrdersAdvanceTestOrderResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersAdvanceTestOrderResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#authinfo_account(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountsAuthInfoResponse

Returns information about the authenticated user.

Parameters:

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



70
71
72
73
74
75
76
77
# File 'lib/google/apis/content_v2_1/service.rb', line 70

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

#cancel_order(merchant_id, order_id, orders_cancel_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersCancelResponse

Cancels all line items in an order, making a full refund.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order to cancel.

  • orders_cancel_request_object (Google::Apis::ContentV2_1::OrdersCancelRequest) (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



2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
# File 'lib/google/apis/content_v2_1/service.rb', line 2874

def cancel_order(merchant_id, order_id, orders_cancel_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/cancel', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersCancelRequest::Representation
  command.request_object = orders_cancel_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersCancelResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersCancelResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#cancellineitem_order(merchant_id, order_id, orders_cancel_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersCancelLineItemResponse

Cancels a line item, making a full refund.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order.

  • orders_cancel_line_item_request_object (Google::Apis::ContentV2_1::OrdersCancelLineItemRequest) (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



2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
# File 'lib/google/apis/content_v2_1/service.rb', line 2911

def cancellineitem_order(merchant_id, order_id, orders_cancel_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/cancelLineItem', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersCancelLineItemRequest::Representation
  command.request_object = orders_cancel_line_item_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersCancelLineItemResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersCancelLineItemResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#canceltestorderbycustomer_order(merchant_id, order_id, orders_cancel_test_order_by_customer_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersCancelTestOrderByCustomerResponse

Sandbox only. Cancels a test order for customer-initiated cancellation.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the test order to cancel.

  • orders_cancel_test_order_by_customer_request_object (Google::Apis::ContentV2_1::OrdersCancelTestOrderByCustomerRequest) (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



2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
# File 'lib/google/apis/content_v2_1/service.rb', line 2948

def canceltestorderbycustomer_order(merchant_id, order_id, orders_cancel_test_order_by_customer_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/testorders/{orderId}/cancelByCustomer', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersCancelTestOrderByCustomerRequest::Representation
  command.request_object = orders_cancel_test_order_by_customer_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersCancelTestOrderByCustomerResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersCancelTestOrderByCustomerResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#claimwebsite_account(merchant_id, account_id, overwrite: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountsClaimWebsiteResponse

Claims the website of a Merchant Center sub-account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account whose website is claimed.

  • overwrite (Boolean) (defaults to: nil)

    Only available to selected merchants. When set to True, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this 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
116
117
# File 'lib/google/apis/content_v2_1/service.rb', line 107

def (merchant_id, , overwrite: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/accounts/{accountId}/claimwebsite', options)
  command.response_representation = Google::Apis::ContentV2_1::AccountsClaimWebsiteResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountsClaimWebsiteResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['overwrite'] = overwrite unless overwrite.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_credential(account_id, account_credentials_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountCredentials

Uploads credentials for the Merchant Center account. If credentials already exist for this Merchant Center account and purpose, this method updates them.

Parameters:

  • account_id (Fixnum)

    Required. The merchant id of the account these credentials belong to.

  • account_credentials_object (Google::Apis::ContentV2_1::AccountCredentials) (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



484
485
486
487
488
489
490
491
492
493
494
# File 'lib/google/apis/content_v2_1/service.rb', line 484

def (,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/{accountId}/credentials', options)
  command.request_representation = Google::Apis::ContentV2_1::AccountCredentials::Representation
  command.request_object = 
  command.response_representation = Google::Apis::ContentV2_1::AccountCredentials::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountCredentials
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_account_label(account_id, account_label_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountLabel

Creates a new label, not assigned to any account.

Parameters:

  • account_id (Fixnum)

    Required. The id of the account this label belongs to.

  • account_label_object (Google::Apis::ContentV2_1::AccountLabel) (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



517
518
519
520
521
522
523
524
525
526
527
# File 'lib/google/apis/content_v2_1/service.rb', line 517

def (,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/{accountId}/labels', options)
  command.request_representation = Google::Apis::ContentV2_1::AccountLabel::Representation
  command.request_object = 
  command.response_representation = Google::Apis::ContentV2_1::AccountLabel::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountLabel
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_account_returncarrier(account_id, account_return_carrier_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountReturnCarrier

Links return carrier to a merchant account.

Parameters:

  • account_id (Fixnum)

    Required. The Merchant Center Account Id under which the Return Carrier is to be linked.

  • account_return_carrier_object (Google::Apis::ContentV2_1::AccountReturnCarrier) (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



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

def (,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/{accountId}/returncarrier', options)
  command.request_representation = Google::Apis::ContentV2_1::AccountReturnCarrier::Representation
  command.request_object = 
  command.response_representation = Google::Apis::ContentV2_1::AccountReturnCarrier::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountReturnCarrier
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_collection(merchant_id, collection_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Collection

Uploads a collection to your Merchant Center account. If a collection with the same collectionId already exists, this method updates that entry. In each update, the collection is completely replaced by the fields in the body of the update request.

Parameters:

  • merchant_id (Fixnum)

    Required. The ID of the account that contains the collection. This account cannot be a multi-client account.

  • collection_object (Google::Apis::ContentV2_1::Collection) (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



1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File 'lib/google/apis/content_v2_1/service.rb', line 1235

def create_collection(merchant_id, collection_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/collections', options)
  command.request_representation = Google::Apis::ContentV2_1::Collection::Representation
  command.request_object = collection_object
  command.response_representation = Google::Apis::ContentV2_1::Collection::Representation
  command.response_class = Google::Apis::ContentV2_1::Collection
  command.params['merchantId'] = merchant_id unless merchant_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_orderreturn_label(merchant_id, return_id, return_shipping_label_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ReturnShippingLabel

Links a return shipping label to a return id. You can only create one return label per return id. Since the label is sent to the buyer, the linked return label cannot be updated or deleted. If you try to create multiple return shipping labels for a single return id, every create request except the first will fail.

Parameters:

  • merchant_id (Fixnum)

    Required. The merchant the Return Shipping Label belongs to.

  • return_id (String)

    Required. Provide the Google-generated merchant order return ID.

  • return_shipping_label_object (Google::Apis::ContentV2_1::ReturnShippingLabel) (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



2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'lib/google/apis/content_v2_1/service.rb', line 2765

def create_orderreturn_label(merchant_id, return_id, return_shipping_label_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orderreturns/{returnId}/labels', options)
  command.request_representation = Google::Apis::ContentV2_1::ReturnShippingLabel::Representation
  command.request_object = return_shipping_label_object
  command.response_representation = Google::Apis::ContentV2_1::ReturnShippingLabel::Representation
  command.response_class = Google::Apis::ContentV2_1::ReturnShippingLabel
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['returnId'] = return_id unless return_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_ordertrackingsignal(merchant_id, order_tracking_signal_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrderTrackingSignal

Creates new order tracking signal.

Parameters:

  • merchant_id (Fixnum)

    The ID of the merchant for which the order signal is created.

  • order_tracking_signal_object (Google::Apis::ContentV2_1::OrderTrackingSignal) (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



3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
# File 'lib/google/apis/content_v2_1/service.rb', line 3607

def create_ordertrackingsignal(merchant_id, order_tracking_signal_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/ordertrackingsignals', options)
  command.request_representation = Google::Apis::ContentV2_1::OrderTrackingSignal::Representation
  command.request_object = order_tracking_signal_object
  command.response_representation = Google::Apis::ContentV2_1::OrderTrackingSignal::Representation
  command.response_class = Google::Apis::ContentV2_1::OrderTrackingSignal
  command.params['merchantId'] = merchant_id unless merchant_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_region(merchant_id, region_object = nil, region_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Region

Creates a region definition in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant for which to create region definition.

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

    Required. The id of the region to create.

  • 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



4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
# File 'lib/google/apis/content_v2_1/service.rb', line 4412

def create_region(merchant_id, region_object = nil, region_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/regions', options)
  command.request_representation = Google::Apis::ContentV2_1::Region::Representation
  command.request_object = region_object
  command.response_representation = Google::Apis::ContentV2_1::Region::Representation
  command.response_class = Google::Apis::ContentV2_1::Region
  command.params['merchantId'] = merchant_id unless merchant_id.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_repricingrule(merchant_id, repricing_rule_object = nil, rule_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::RepricingRule

Creates a repricing rule for your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant who owns the repricing rule.

  • repricing_rule_object (Google::Apis::ContentV2_1::RepricingRule) (defaults to: nil)
  • rule_id (String) (defaults to: nil)

    Required. The id of the rule to create.

  • 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



4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
# File 'lib/google/apis/content_v2_1/service.rb', line 4627

def create_repricingrule(merchant_id, repricing_rule_object = nil, rule_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/repricingrules', options)
  command.request_representation = Google::Apis::ContentV2_1::RepricingRule::Representation
  command.request_object = repricing_rule_object
  command.response_representation = Google::Apis::ContentV2_1::RepricingRule::Representation
  command.response_class = Google::Apis::ContentV2_1::RepricingRule
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['ruleId'] = rule_id unless rule_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_returnpolicyonline(merchant_id, return_policy_online_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ReturnPolicyOnline

Creates a new return policy.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant for which to retrieve the return policy online object.

  • return_policy_online_object (Google::Apis::ContentV2_1::ReturnPolicyOnline) (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



5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
# File 'lib/google/apis/content_v2_1/service.rb', line 5192

def create_returnpolicyonline(merchant_id, return_policy_online_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/returnpolicyonline', options)
  command.request_representation = Google::Apis::ContentV2_1::ReturnPolicyOnline::Representation
  command.request_object = return_policy_online_object
  command.response_representation = Google::Apis::ContentV2_1::ReturnPolicyOnline::Representation
  command.response_class = Google::Apis::ContentV2_1::ReturnPolicyOnline
  command.params['merchantId'] = merchant_id unless merchant_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

#createchargeinvoice_orderinvoice(merchant_id, order_id, orderinvoices_create_charge_invoice_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrderinvoicesCreateChargeInvoiceResponse

Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order.

  • orderinvoices_create_charge_invoice_request_object (Google::Apis::ContentV2_1::OrderinvoicesCreateChargeInvoiceRequest) (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



2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
# File 'lib/google/apis/content_v2_1/service.rb', line 2362

def createchargeinvoice_orderinvoice(merchant_id, order_id, orderinvoices_create_charge_invoice_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orderinvoices/{orderId}/createChargeInvoice', options)
  command.request_representation = Google::Apis::ContentV2_1::OrderinvoicesCreateChargeInvoiceRequest::Representation
  command.request_object = orderinvoices_create_charge_invoice_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrderinvoicesCreateChargeInvoiceResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrderinvoicesCreateChargeInvoiceResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#createorderreturn_orderreturn(merchant_id, orderreturns_create_order_return_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrderreturnsCreateOrderReturnResponse

Create return in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • orderreturns_create_order_return_request_object (Google::Apis::ContentV2_1::OrderreturnsCreateOrderReturnRequest) (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



2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'lib/google/apis/content_v2_1/service.rb', line 2566

def createorderreturn_orderreturn(merchant_id, orderreturns_create_order_return_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orderreturns/createOrderReturn', options)
  command.request_representation = Google::Apis::ContentV2_1::OrderreturnsCreateOrderReturnRequest::Representation
  command.request_object = orderreturns_create_order_return_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrderreturnsCreateOrderReturnResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrderreturnsCreateOrderReturnResponse
  command.params['merchantId'] = merchant_id unless merchant_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

#createrefundinvoice_orderinvoice(merchant_id, order_id, orderinvoices_create_refund_invoice_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrderinvoicesCreateRefundInvoiceResponse

Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using createChargeInvoice. All amounts ( except for the summary) are incremental with respect to the previous invoice.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order.

  • orderinvoices_create_refund_invoice_request_object (Google::Apis::ContentV2_1::OrderinvoicesCreateRefundInvoiceRequest) (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



2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
# File 'lib/google/apis/content_v2_1/service.rb', line 2402

def createrefundinvoice_orderinvoice(merchant_id, order_id, orderinvoices_create_refund_invoice_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orderinvoices/{orderId}/createRefundInvoice', options)
  command.request_representation = Google::Apis::ContentV2_1::OrderinvoicesCreateRefundInvoiceRequest::Representation
  command.request_object = orderinvoices_create_refund_invoice_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrderinvoicesCreateRefundInvoiceResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrderinvoicesCreateRefundInvoiceResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#createtestorder_order(merchant_id, orders_create_test_order_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersCreateTestOrderResponse

Sandbox only. Creates a test order.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that should manage the order. This cannot be a multi- client account.

  • orders_create_test_order_request_object (Google::Apis::ContentV2_1::OrdersCreateTestOrderRequest) (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



2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
# File 'lib/google/apis/content_v2_1/service.rb', line 2983

def createtestorder_order(merchant_id, orders_create_test_order_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/testorders', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersCreateTestOrderRequest::Representation
  command.request_object = orders_create_test_order_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersCreateTestOrderResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersCreateTestOrderResponse
  command.params['merchantId'] = merchant_id unless merchant_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

#createtestreturn_order(merchant_id, order_id, orders_create_test_return_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersCreateTestReturnResponse

Sandbox only. Creates a test return.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order.

  • orders_create_test_return_request_object (Google::Apis::ContentV2_1::OrdersCreateTestReturnRequest) (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



3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
# File 'lib/google/apis/content_v2_1/service.rb', line 3019

def createtestreturn_order(merchant_id, order_id, orders_create_test_return_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/testreturn', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersCreateTestReturnRequest::Representation
  command.request_object = orders_create_test_return_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersCreateTestReturnResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersCreateTestReturnResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#custombatch_account(accounts_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountsCustomBatchResponse

Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-) accounts in a single request.

Parameters:

  • accounts_custom_batch_request_object (Google::Apis::ContentV2_1::AccountsCustomBatchRequest) (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



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

def (accounts_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounts/batch', options)
  command.request_representation = Google::Apis::ContentV2_1::AccountsCustomBatchRequest::Representation
  command.request_object = accounts_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2_1::AccountsCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountsCustomBatchResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_accountstatus(accountstatuses_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountstatusesCustomBatchResponse

Retrieves multiple Merchant Center account statuses in a single request.

Parameters:

  • accountstatuses_custom_batch_request_object (Google::Apis::ContentV2_1::AccountstatusesCustomBatchRequest) (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



790
791
792
793
794
795
796
797
798
799
# File 'lib/google/apis/content_v2_1/service.rb', line 790

def custombatch_accountstatus(accountstatuses_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accountstatuses/batch', options)
  command.request_representation = Google::Apis::ContentV2_1::AccountstatusesCustomBatchRequest::Representation
  command.request_object = accountstatuses_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2_1::AccountstatusesCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountstatusesCustomBatchResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_accounttax(accounttax_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccounttaxCustomBatchResponse

Retrieves and updates tax settings of multiple accounts in a single request.

Parameters:

  • accounttax_custom_batch_request_object (Google::Apis::ContentV2_1::AccounttaxCustomBatchRequest) (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



905
906
907
908
909
910
911
912
913
914
# File 'lib/google/apis/content_v2_1/service.rb', line 905

def custombatch_accounttax(accounttax_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'accounttax/batch', options)
  command.request_representation = Google::Apis::ContentV2_1::AccounttaxCustomBatchRequest::Representation
  command.request_object = accounttax_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2_1::AccounttaxCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::AccounttaxCustomBatchResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_datafeed(datafeeds_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::DatafeedsCustomBatchResponse

Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.

Parameters:

  • datafeeds_custom_batch_request_object (Google::Apis::ContentV2_1::DatafeedsCustomBatchRequest) (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



1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
# File 'lib/google/apis/content_v2_1/service.rb', line 1560

def custombatch_datafeed(datafeeds_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'datafeeds/batch', options)
  command.request_representation = Google::Apis::ContentV2_1::DatafeedsCustomBatchRequest::Representation
  command.request_object = datafeeds_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2_1::DatafeedsCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::DatafeedsCustomBatchResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_datafeedstatus(datafeedstatuses_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::DatafeedstatusesCustomBatchResponse

Gets multiple Merchant Center datafeed statuses in a single request.

Parameters:

  • datafeedstatuses_custom_batch_request_object (Google::Apis::ContentV2_1::DatafeedstatusesCustomBatchRequest) (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



1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
# File 'lib/google/apis/content_v2_1/service.rb', line 1801

def custombatch_datafeedstatus(datafeedstatuses_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'datafeedstatuses/batch', options)
  command.request_representation = Google::Apis::ContentV2_1::DatafeedstatusesCustomBatchRequest::Representation
  command.request_object = datafeedstatuses_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2_1::DatafeedstatusesCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::DatafeedstatusesCustomBatchResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_liasetting(liasettings_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::LiasettingsCustomBatchResponse

Retrieves and/or updates the LIA settings of multiple accounts in a single request.

Parameters:

  • liasettings_custom_batch_request_object (Google::Apis::ContentV2_1::LiasettingsCustomBatchRequest) (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



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

def custombatch_liasetting(liasettings_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'liasettings/batch', options)
  command.request_representation = Google::Apis::ContentV2_1::LiasettingsCustomBatchRequest::Representation
  command.request_object = liasettings_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2_1::LiasettingsCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::LiasettingsCustomBatchResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_localinventory(localinventory_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::LocalinventoryCustomBatchResponse

Updates local inventory for multiple products or stores in a single request.

Parameters:

  • localinventory_custom_batch_request_object (Google::Apis::ContentV2_1::LocalinventoryCustomBatchRequest) (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



2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
# File 'lib/google/apis/content_v2_1/service.rb', line 2289

def custombatch_localinventory(localinventory_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'localinventory/batch', options)
  command.request_representation = Google::Apis::ContentV2_1::LocalinventoryCustomBatchRequest::Representation
  command.request_object = localinventory_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2_1::LocalinventoryCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::LocalinventoryCustomBatchResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_po(pos_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::PosCustomBatchResponse

Batches multiple POS-related calls in a single request.

Parameters:

  • pos_custom_batch_request_object (Google::Apis::ContentV2_1::PosCustomBatchRequest) (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



3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
# File 'lib/google/apis/content_v2_1/service.rb', line 3638

def custombatch_po(pos_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'pos/batch', options)
  command.request_representation = Google::Apis::ContentV2_1::PosCustomBatchRequest::Representation
  command.request_object = pos_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2_1::PosCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::PosCustomBatchResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_product(products_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ProductsCustomBatchResponse

Retrieves, inserts, and deletes multiple products in a single request.

Parameters:

  • products_custom_batch_request_object (Google::Apis::ContentV2_1::ProductsCustomBatchRequest) (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



3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
# File 'lib/google/apis/content_v2_1/service.rb', line 3879

def custombatch_product(products_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'products/batch', options)
  command.request_representation = Google::Apis::ContentV2_1::ProductsCustomBatchRequest::Representation
  command.request_object = products_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2_1::ProductsCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ProductsCustomBatchResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_productstatus(productstatuses_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ProductstatusesCustomBatchResponse

Gets the statuses of multiple products in a single request.

Parameters:

  • productstatuses_custom_batch_request_object (Google::Apis::ContentV2_1::ProductstatusesCustomBatchRequest) (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



4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
# File 'lib/google/apis/content_v2_1/service.rb', line 4103

def custombatch_productstatus(productstatuses_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'productstatuses/batch', options)
  command.request_representation = Google::Apis::ContentV2_1::ProductstatusesCustomBatchRequest::Representation
  command.request_object = productstatuses_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2_1::ProductstatusesCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ProductstatusesCustomBatchResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_regionalinventory(regionalinventory_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::RegionalinventoryCustomBatchResponse

Updates regional inventory for multiple products or regions in a single request.

Parameters:

  • regionalinventory_custom_batch_request_object (Google::Apis::ContentV2_1::RegionalinventoryCustomBatchRequest) (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



4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
# File 'lib/google/apis/content_v2_1/service.rb', line 4339

def custombatch_regionalinventory(regionalinventory_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'regionalinventory/batch', options)
  command.request_representation = Google::Apis::ContentV2_1::RegionalinventoryCustomBatchRequest::Representation
  command.request_object = regionalinventory_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2_1::RegionalinventoryCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::RegionalinventoryCustomBatchResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_returnaddress(returnaddress_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ReturnaddressCustomBatchResponse

Batches multiple return address related calls in a single request.

Parameters:

  • returnaddress_custom_batch_request_object (Google::Apis::ContentV2_1::ReturnaddressCustomBatchRequest) (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



4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
# File 'lib/google/apis/content_v2_1/service.rb', line 4865

def custombatch_returnaddress(returnaddress_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'returnaddress/batch', options)
  command.request_representation = Google::Apis::ContentV2_1::ReturnaddressCustomBatchRequest::Representation
  command.request_object = returnaddress_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2_1::ReturnaddressCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ReturnaddressCustomBatchResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_returnpolicy(returnpolicy_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ReturnpolicyCustomBatchResponse

Batches multiple return policy related calls in a single request.

Parameters:

  • returnpolicy_custom_batch_request_object (Google::Apis::ContentV2_1::ReturnpolicyCustomBatchRequest) (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



5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
# File 'lib/google/apis/content_v2_1/service.rb', line 5032

def custombatch_returnpolicy(returnpolicy_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'returnpolicy/batch', options)
  command.request_representation = Google::Apis::ContentV2_1::ReturnpolicyCustomBatchRequest::Representation
  command.request_object = returnpolicy_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2_1::ReturnpolicyCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ReturnpolicyCustomBatchResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_shippingsetting(shippingsettings_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ShippingsettingsCustomBatchResponse

Retrieves and updates the shipping settings of multiple accounts in a single request.

Parameters:

  • shippingsettings_custom_batch_request_object (Google::Apis::ContentV2_1::ShippingsettingsCustomBatchRequest) (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



5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
# File 'lib/google/apis/content_v2_1/service.rb', line 5482

def custombatch_shippingsetting(shippingsettings_custom_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'shippingsettings/batch', options)
  command.request_representation = Google::Apis::ContentV2_1::ShippingsettingsCustomBatchRequest::Representation
  command.request_object = shippingsettings_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2_1::ShippingsettingsCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ShippingsettingsCustomBatchResponse
  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(merchant_id, account_id, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a Merchant Center sub-account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. This must be a multi-client account, and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account.

  • force (Boolean) (defaults to: nil)

    Flag to delete sub-accounts with products. The default value is false.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



175
176
177
178
179
180
181
182
183
# File 'lib/google/apis/content_v2_1/service.rb', line 175

def (merchant_id, , force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '{merchantId}/accounts/{accountId}', options)
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_account_label(account_id, label_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a label and removes it from all accounts to which it was assigned.

Parameters:

  • account_id (Fixnum)

    Required. The id of the account that owns the label.

  • label_id (Fixnum)

    Required. The id of the label to delete.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



551
552
553
554
555
556
557
558
# File 'lib/google/apis/content_v2_1/service.rb', line 551

def (, label_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'accounts/{accountId}/labels/{labelId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['labelId'] = label_id unless label_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

#delete_account_returncarrier(account_id, carrier_account_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete a return carrier in the merchant account.

Parameters:

  • account_id (Fixnum)

    Required. The Merchant Center Account Id under which the Return Carrier is to be linked.

  • carrier_account_id (Fixnum)

    Required. The Google-provided unique carrier ID, used to update the resource.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



694
695
696
697
698
699
700
701
# File 'lib/google/apis/content_v2_1/service.rb', line 694

def (, , fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'accounts/{accountId}/returncarrier/{carrierAccountId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['carrierAccountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_collection(merchant_id, collection_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a collection from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    Required. The ID of the account that contains the collection. This account cannot be a multi-client account.

  • collection_id (String)

    Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



1271
1272
1273
1274
1275
1276
1277
1278
# File 'lib/google/apis/content_v2_1/service.rb', line 1271

def delete_collection(merchant_id, collection_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '{merchantId}/collections/{collectionId}', options)
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['collectionId'] = collection_id unless collection_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

#delete_datafeed(merchant_id, datafeed_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a datafeed configuration from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the datafeed. This account cannot be a multi-client account.

  • datafeed_id (Fixnum)

    The ID of the datafeed.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



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

def delete_datafeed(merchant_id, datafeed_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '{merchantId}/datafeeds/{datafeedId}', options)
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['datafeedId'] = datafeed_id unless datafeed_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

#delete_po(merchant_id, target_merchant_id, store_code, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a store for the given merchant.

Parameters:

  • merchant_id (Fixnum)

    The ID of the POS or inventory data provider.

  • target_merchant_id (Fixnum)

    The ID of the target merchant.

  • store_code (String)

    A store code that is unique per merchant.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



3673
3674
3675
3676
3677
3678
3679
3680
3681
# File 'lib/google/apis/content_v2_1/service.rb', line 3673

def delete_po(merchant_id, target_merchant_id, store_code, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '{merchantId}/pos/{targetMerchantId}/store/{storeCode}', options)
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['targetMerchantId'] = target_merchant_id unless target_merchant_id.nil?
  command.params['storeCode'] = store_code unless store_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

#delete_product(merchant_id, product_id, feed_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a product from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that contains the product. This account cannot be a multi-client account.

  • product_id (String)

    The REST ID of the product.

  • feed_id (Fixnum) (defaults to: nil)

    The Content API Supplemental Feed ID. If present then product deletion applies to the data in a supplemental feed. If absent, entire product will be deleted.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



3916
3917
3918
3919
3920
3921
3922
3923
3924
# File 'lib/google/apis/content_v2_1/service.rb', line 3916

def delete_product(merchant_id, product_id, feed_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '{merchantId}/products/{productId}', options)
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['feedId'] = feed_id unless feed_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

#delete_region(merchant_id, region_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a region definition from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant for which to delete region definition.

  • region_id (String)

    Required. The id of the region to delete.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



4447
4448
4449
4450
4451
4452
4453
4454
# File 'lib/google/apis/content_v2_1/service.rb', line 4447

def delete_region(merchant_id, region_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '{merchantId}/regions/{regionId}', options)
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['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

#delete_repricingrule(merchant_id, rule_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a repricing rule in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant who owns the repricing rule.

  • rule_id (String)

    Required. The id of the rule to Delete.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



4662
4663
4664
4665
4666
4667
4668
4669
# File 'lib/google/apis/content_v2_1/service.rb', line 4662

def delete_repricingrule(merchant_id, rule_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '{merchantId}/repricingrules/{ruleId}', options)
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['ruleId'] = rule_id unless rule_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

#delete_returnaddress(merchant_id, return_address_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a return address for the given Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The Merchant Center account from which to delete the given return address.

  • return_address_id (String)

    Return address ID generated by Google.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



4898
4899
4900
4901
4902
4903
4904
4905
# File 'lib/google/apis/content_v2_1/service.rb', line 4898

def delete_returnaddress(merchant_id, return_address_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '{merchantId}/returnaddress/{returnAddressId}', options)
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['returnAddressId'] = return_address_id unless return_address_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

#delete_returnpolicy(merchant_id, return_policy_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a return policy for the given Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The Merchant Center account from which to delete the given return policy.

  • return_policy_id (String)

    Return policy ID generated by Google.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



5065
5066
5067
5068
5069
5070
5071
5072
# File 'lib/google/apis/content_v2_1/service.rb', line 5065

def delete_returnpolicy(merchant_id, return_policy_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '{merchantId}/returnpolicy/{returnPolicyId}', options)
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['returnPolicyId'] = return_policy_id unless return_policy_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

#delete_returnpolicyonline(merchant_id, return_policy_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an existing return policy.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant for which to retrieve the return policy online object.

  • return_policy_id (String)

    Required. The id of the return policy to delete.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



5227
5228
5229
5230
5231
5232
5233
5234
# File 'lib/google/apis/content_v2_1/service.rb', line 5227

def delete_returnpolicyonline(merchant_id, return_policy_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '{merchantId}/returnpolicyonline/{returnPolicyId}', options)
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['returnPolicyId'] = return_policy_id unless return_policy_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

#fetchnow_datafeed(merchant_id, datafeed_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::DatafeedsFetchNowResponse

Invokes a fetch for the datafeed in your Merchant Center account. If you need to call this method more than once per day, we recommend you use the Products service to update your product data.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the datafeed. This account cannot be a multi-client account.

  • datafeed_id (Fixnum)

    The ID of the datafeed to be fetched.

  • 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



1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
# File 'lib/google/apis/content_v2_1/service.rb', line 1628

def fetchnow_datafeed(merchant_id, datafeed_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/datafeeds/{datafeedId}/fetchNow', options)
  command.response_representation = Google::Apis::ContentV2_1::DatafeedsFetchNowResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::DatafeedsFetchNowResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['datafeedId'] = datafeed_id unless datafeed_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

#get_account(merchant_id, account_id, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Account

Retrieves a Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account.

  • view (String) (defaults to: nil)

    Controls which fields will be populated. Acceptable values are: "merchant" and "css". The default value is "merchant".

  • 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



212
213
214
215
216
217
218
219
220
221
222
# File 'lib/google/apis/content_v2_1/service.rb', line 212

def (merchant_id, , view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/accounts/{accountId}', options)
  command.response_representation = Google::Apis::ContentV2_1::Account::Representation
  command.response_class = Google::Apis::ContentV2_1::Account
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['view'] = view unless view.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_accountstatus(merchant_id, account_id, destinations: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountStatus

Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account.

  • destinations (Array<String>, String) (defaults to: nil)

    If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.

  • 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



829
830
831
832
833
834
835
836
837
838
839
# File 'lib/google/apis/content_v2_1/service.rb', line 829

def get_accountstatus(merchant_id, , destinations: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/accountstatuses/{accountId}', options)
  command.response_representation = Google::Apis::ContentV2_1::AccountStatus::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountStatus
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['destinations'] = destinations unless destinations.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_accounttax(merchant_id, account_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountTax

Retrieves the tax settings of the account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account for which to get/update account tax settings.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



940
941
942
943
944
945
946
947
948
949
# File 'lib/google/apis/content_v2_1/service.rb', line 940

def get_accounttax(merchant_id, , fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/accounttax/{accountId}', options)
  command.response_representation = Google::Apis::ContentV2_1::AccountTax::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountTax
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_buyongoogleprogram(merchant_id, region_code, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::BuyOnGoogleProgramStatus

Retrieves a status of the BoG program for your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    Required. The ID of the account.

  • region_code (String)

    The Program region code ISO 3166-1 alpha-2. Currently only US is available.

  • 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



1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
# File 'lib/google/apis/content_v2_1/service.rb', line 1086

def get_buyongoogleprogram(merchant_id, region_code, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/buyongoogleprograms/{regionCode}', options)
  command.response_representation = Google::Apis::ContentV2_1::BuyOnGoogleProgramStatus::Representation
  command.response_class = Google::Apis::ContentV2_1::BuyOnGoogleProgramStatus
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['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

#get_collection(merchant_id, collection_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Collection

Retrieves a collection from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    Required. The ID of the account that contains the collection. This account cannot be a multi-client account.

  • collection_id (String)

    Required. The REST ID of the collection.

  • 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



1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
# File 'lib/google/apis/content_v2_1/service.rb', line 1303

def get_collection(merchant_id, collection_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/collections/{collectionId}', options)
  command.response_representation = Google::Apis::ContentV2_1::Collection::Representation
  command.response_class = Google::Apis::ContentV2_1::Collection
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['collectionId'] = collection_id unless collection_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

#get_collectionstatus(merchant_id, collection_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::CollectionStatus

Gets the status of a collection from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    Required. The ID of the account that contains the collection. This account cannot be a multi-client account.

  • collection_id (String)

    Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection.

  • 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



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
# File 'lib/google/apis/content_v2_1/service.rb', line 1379

def get_collectionstatus(merchant_id, collection_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/collectionstatuses/{collectionId}', options)
  command.response_representation = Google::Apis::ContentV2_1::CollectionStatus::Representation
  command.response_class = Google::Apis::ContentV2_1::CollectionStatus
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['collectionId'] = collection_id unless collection_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

#get_css(css_group_id, css_domain_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Css

Retrieves a single CSS domain by ID.

Parameters:

  • css_group_id (Fixnum)

    Required. The ID of the managing account. If this parameter is not the same as cssDomainId, then this ID must be a CSS group ID and cssDomainId must be the ID of a CSS domain affiliated with this group.

  • css_domain_id (Fixnum)

    Required. The ID of the CSS domain to return.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def get_css(css_group_id, css_domain_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{cssGroupId}/csses/{cssDomainId}', options)
  command.response_representation = Google::Apis::ContentV2_1::Css::Representation
  command.response_class = Google::Apis::ContentV2_1::Css
  command.params['cssGroupId'] = css_group_id unless css_group_id.nil?
  command.params['cssDomainId'] = css_domain_id unless css_domain_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

#get_datafeed(merchant_id, datafeed_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Datafeed

Retrieves a datafeed configuration from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the datafeed. This account cannot be a multi-client account.

  • datafeed_id (Fixnum)

    The ID of the datafeed.

  • 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



1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
# File 'lib/google/apis/content_v2_1/service.rb', line 1662

def get_datafeed(merchant_id, datafeed_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/datafeeds/{datafeedId}', options)
  command.response_representation = Google::Apis::ContentV2_1::Datafeed::Representation
  command.response_class = Google::Apis::ContentV2_1::Datafeed
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['datafeedId'] = datafeed_id unless datafeed_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

#get_datafeedstatus(merchant_id, datafeed_id, country: nil, language: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::DatafeedStatus

Retrieves the status of a datafeed from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the datafeed. This account cannot be a multi-client account.

  • datafeed_id (Fixnum)

    The ID of the datafeed.

  • country (String) (defaults to: nil)

    The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.

  • language (String) (defaults to: nil)

    The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.

  • 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



1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
# File 'lib/google/apis/content_v2_1/service.rb', line 1845

def get_datafeedstatus(merchant_id, datafeed_id, country: nil, language: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/datafeedstatuses/{datafeedId}', options)
  command.response_representation = Google::Apis::ContentV2_1::DatafeedStatus::Representation
  command.response_class = Google::Apis::ContentV2_1::DatafeedStatus
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['datafeedId'] = datafeed_id unless datafeed_id.nil?
  command.query['country'] = country unless country.nil?
  command.query['language'] = language unless language.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_liasetting(merchant_id, account_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::LiaSettings

Retrieves the LIA settings of the account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account for which to get or update LIA settings.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
# File 'lib/google/apis/content_v2_1/service.rb', line 1950

def get_liasetting(merchant_id, , fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/liasettings/{accountId}', options)
  command.response_representation = Google::Apis::ContentV2_1::LiaSettings::Representation
  command.response_class = Google::Apis::ContentV2_1::LiaSettings
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_order(merchant_id, order_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Order

Retrieves an order from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order.

  • 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



3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
# File 'lib/google/apis/content_v2_1/service.rb', line 3055

def get_order(merchant_id, order_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/orders/{orderId}', options)
  command.response_representation = Google::Apis::ContentV2_1::Order::Representation
  command.response_class = Google::Apis::ContentV2_1::Order
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#get_orderreturn(merchant_id, return_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::MerchantOrderReturn

Retrieves an order return from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • return_id (String)

    Merchant order return ID generated by Google.

  • 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



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

def get_orderreturn(merchant_id, return_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/orderreturns/{returnId}', options)
  command.response_representation = Google::Apis::ContentV2_1::MerchantOrderReturn::Representation
  command.response_class = Google::Apis::ContentV2_1::MerchantOrderReturn
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['returnId'] = return_id unless return_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

#get_po(merchant_id, target_merchant_id, store_code, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::PosStore

Retrieves information about the given store.

Parameters:

  • merchant_id (Fixnum)

    The ID of the POS or inventory data provider.

  • target_merchant_id (Fixnum)

    The ID of the target merchant.

  • store_code (String)

    A store code that is unique per merchant.

  • 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



3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
# File 'lib/google/apis/content_v2_1/service.rb', line 3707

def get_po(merchant_id, target_merchant_id, store_code, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/pos/{targetMerchantId}/store/{storeCode}', options)
  command.response_representation = Google::Apis::ContentV2_1::PosStore::Representation
  command.response_class = Google::Apis::ContentV2_1::PosStore
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['targetMerchantId'] = target_merchant_id unless target_merchant_id.nil?
  command.params['storeCode'] = store_code unless store_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

#get_product(merchant_id, product_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Product

Retrieves a product from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that contains the product. This account cannot be a multi-client account.

  • product_id (String)

    The REST ID of the product.

  • 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



3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
# File 'lib/google/apis/content_v2_1/service.rb', line 3949

def get_product(merchant_id, product_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/products/{productId}', options)
  command.response_representation = Google::Apis::ContentV2_1::Product::Representation
  command.response_class = Google::Apis::ContentV2_1::Product
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['productId'] = product_id unless product_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

#get_productstatus(merchant_id, product_id, destinations: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ProductStatus

Gets the status of a product from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that contains the product. This account cannot be a multi-client account.

  • product_id (String)

    The REST ID of the product.

  • destinations (Array<String>, String) (defaults to: nil)

    If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.

  • 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



4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
# File 'lib/google/apis/content_v2_1/service.rb', line 4140

def get_productstatus(merchant_id, product_id, destinations: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/productstatuses/{productId}', options)
  command.response_representation = Google::Apis::ContentV2_1::ProductStatus::Representation
  command.response_class = Google::Apis::ContentV2_1::ProductStatus
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['destinations'] = destinations unless destinations.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_pubsubnotificationsetting(merchant_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::PubsubNotificationSettings

Retrieves a Merchant Center account's pubsub notification settings.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account for which to get pubsub notification settings.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4275
4276
4277
4278
4279
4280
4281
4282
4283
# File 'lib/google/apis/content_v2_1/service.rb', line 4275

def get_pubsubnotificationsetting(merchant_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/pubsubnotificationsettings', options)
  command.response_representation = Google::Apis::ContentV2_1::PubsubNotificationSettings::Representation
  command.response_class = Google::Apis::ContentV2_1::PubsubNotificationSettings
  command.params['merchantId'] = merchant_id unless merchant_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

#get_region(merchant_id, region_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Region

Retrieves a region defined in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant for which to retrieve region definition.

  • region_id (String)

    Required. The id of the region to retrieve.

  • 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



4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
# File 'lib/google/apis/content_v2_1/service.rb', line 4478

def get_region(merchant_id, region_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/regions/{regionId}', options)
  command.response_representation = Google::Apis::ContentV2_1::Region::Representation
  command.response_class = Google::Apis::ContentV2_1::Region
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['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

#get_repricingrule(merchant_id, rule_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::RepricingRule

Retrieves a repricing rule from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant who owns the repricing rule.

  • rule_id (String)

    Required. The id of the rule to retrieve.

  • 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



4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
# File 'lib/google/apis/content_v2_1/service.rb', line 4693

def get_repricingrule(merchant_id, rule_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/repricingrules/{ruleId}', options)
  command.response_representation = Google::Apis::ContentV2_1::RepricingRule::Representation
  command.response_class = Google::Apis::ContentV2_1::RepricingRule
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['ruleId'] = rule_id unless rule_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

#get_returnaddress(merchant_id, return_address_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ReturnAddress

Gets a return address of the Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The Merchant Center account to get a return address for.

  • return_address_id (String)

    Return address ID generated by Google.

  • 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



4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
# File 'lib/google/apis/content_v2_1/service.rb', line 4929

def get_returnaddress(merchant_id, return_address_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/returnaddress/{returnAddressId}', options)
  command.response_representation = Google::Apis::ContentV2_1::ReturnAddress::Representation
  command.response_class = Google::Apis::ContentV2_1::ReturnAddress
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['returnAddressId'] = return_address_id unless return_address_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

#get_returnpolicy(merchant_id, return_policy_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ReturnPolicy

Gets a return policy of the Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The Merchant Center account to get a return policy for.

  • return_policy_id (String)

    Return policy ID generated by Google.

  • 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



5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
# File 'lib/google/apis/content_v2_1/service.rb', line 5096

def get_returnpolicy(merchant_id, return_policy_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/returnpolicy/{returnPolicyId}', options)
  command.response_representation = Google::Apis::ContentV2_1::ReturnPolicy::Representation
  command.response_class = Google::Apis::ContentV2_1::ReturnPolicy
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['returnPolicyId'] = return_policy_id unless return_policy_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

#get_returnpolicyonline(merchant_id, return_policy_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ReturnPolicyOnline

Gets an existing return policy.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant for which to retrieve the return policy online object.

  • return_policy_id (String)

    Required. The id of the return policy to retrieve.

  • 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



5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
# File 'lib/google/apis/content_v2_1/service.rb', line 5259

def get_returnpolicyonline(merchant_id, return_policy_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/returnpolicyonline/{returnPolicyId}', options)
  command.response_representation = Google::Apis::ContentV2_1::ReturnPolicyOnline::Representation
  command.response_class = Google::Apis::ContentV2_1::ReturnPolicyOnline
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['returnPolicyId'] = return_policy_id unless return_policy_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

#get_settlementreport(merchant_id, settlement_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::SettlementReport

Retrieves a settlement report from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The Merchant Center account of the settlement report.

  • settlement_id (String)

    The Google-provided ID of the settlement.

  • 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



5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
# File 'lib/google/apis/content_v2_1/service.rb', line 5360

def get_settlementreport(merchant_id, settlement_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/settlementreports/{settlementId}', options)
  command.response_representation = Google::Apis::ContentV2_1::SettlementReport::Representation
  command.response_class = Google::Apis::ContentV2_1::SettlementReport
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['settlementId'] = settlement_id unless settlement_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

#get_shippingsetting(merchant_id, account_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ShippingSettings

Retrieves the shipping settings of the account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account for which to get/update shipping settings.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/google/apis/content_v2_1/service.rb', line 5517

def get_shippingsetting(merchant_id, , fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/shippingsettings/{accountId}', options)
  command.response_representation = Google::Apis::ContentV2_1::ShippingSettings::Representation
  command.response_class = Google::Apis::ContentV2_1::ShippingSettings
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#getaccessiblegmbaccounts_liasetting(merchant_id, account_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::LiasettingsGetAccessibleGmbAccountsResponse

Retrieves the list of accessible Google My Business accounts.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account for which to retrieve accessible Google My Business accounts.

  • 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



1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
# File 'lib/google/apis/content_v2_1/service.rb', line 1986

def getaccessiblegmbaccounts_liasetting(merchant_id, , fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/liasettings/{accountId}/accessiblegmbaccounts', options)
  command.response_representation = Google::Apis::ContentV2_1::LiasettingsGetAccessibleGmbAccountsResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::LiasettingsGetAccessibleGmbAccountsResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#getbymerchantorderid_order(merchant_id, merchant_order_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersGetByMerchantOrderIdResponse

Retrieves an order using merchant order ID.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • merchant_order_id (String)

    The merchant order ID to be looked for.

  • 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



3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'lib/google/apis/content_v2_1/service.rb', line 3089

def getbymerchantorderid_order(merchant_id, merchant_order_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/ordersbymerchantid/{merchantOrderId}', options)
  command.response_representation = Google::Apis::ContentV2_1::OrdersGetByMerchantOrderIdResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersGetByMerchantOrderIdResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['merchantOrderId'] = merchant_order_id unless merchant_order_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

#getsupportedcarriers_shippingsetting(merchant_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ShippingsettingsGetSupportedCarriersResponse

Retrieves supported carriers and carrier services for an account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account for which to retrieve the supported carriers.

  • 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



5548
5549
5550
5551
5552
5553
5554
5555
5556
# File 'lib/google/apis/content_v2_1/service.rb', line 5548

def getsupportedcarriers_shippingsetting(merchant_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/supportedCarriers', options)
  command.response_representation = Google::Apis::ContentV2_1::ShippingsettingsGetSupportedCarriersResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ShippingsettingsGetSupportedCarriersResponse
  command.params['merchantId'] = merchant_id unless merchant_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

#getsupportedholidays_shippingsetting(merchant_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ShippingsettingsGetSupportedHolidaysResponse

Retrieves supported holidays for an account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account for which to retrieve the supported holidays.

  • 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



5578
5579
5580
5581
5582
5583
5584
5585
5586
# File 'lib/google/apis/content_v2_1/service.rb', line 5578

def getsupportedholidays_shippingsetting(merchant_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/supportedHolidays', options)
  command.response_representation = Google::Apis::ContentV2_1::ShippingsettingsGetSupportedHolidaysResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ShippingsettingsGetSupportedHolidaysResponse
  command.params['merchantId'] = merchant_id unless merchant_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

#getsupportedpickupservices_shippingsetting(merchant_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ShippingsettingsGetSupportedPickupServicesResponse

Retrieves supported pickup services for an account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account for which to retrieve the supported pickup services.

  • 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



5608
5609
5610
5611
5612
5613
5614
5615
5616
# File 'lib/google/apis/content_v2_1/service.rb', line 5608

def getsupportedpickupservices_shippingsetting(merchant_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/supportedPickupServices', options)
  command.response_representation = Google::Apis::ContentV2_1::ShippingsettingsGetSupportedPickupServicesResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ShippingsettingsGetSupportedPickupServicesResponse
  command.params['merchantId'] = merchant_id unless merchant_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

#gettestordertemplate_order(merchant_id, template_name, country: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersGetTestOrderTemplateResponse

Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that should manage the order. This cannot be a multi- client account.

  • template_name (String)

    The name of the template to retrieve.

  • country (String) (defaults to: nil)

    The country of the template to retrieve. Defaults to US.

  • 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



3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
# File 'lib/google/apis/content_v2_1/service.rb', line 3126

def gettestordertemplate_order(merchant_id, template_name, country: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/testordertemplates/{templateName}', options)
  command.response_representation = Google::Apis::ContentV2_1::OrdersGetTestOrderTemplateResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersGetTestOrderTemplateResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['templateName'] = template_name unless template_name.nil?
  command.query['country'] = country unless country.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(merchant_id, account_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Account

Creates a Merchant Center sub-account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. This must be a multi-client account.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



245
246
247
248
249
250
251
252
253
254
255
# File 'lib/google/apis/content_v2_1/service.rb', line 245

def (merchant_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/accounts', options)
  command.request_representation = Google::Apis::ContentV2_1::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::ContentV2_1::Account::Representation
  command.response_class = Google::Apis::ContentV2_1::Account
  command.params['merchantId'] = merchant_id unless merchant_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

#insert_datafeed(merchant_id, datafeed_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Datafeed

Registers a datafeed configuration with your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the datafeed. This account cannot be a multi-client account.

  • datafeed_object (Google::Apis::ContentV2_1::Datafeed) (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



1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
# File 'lib/google/apis/content_v2_1/service.rb', line 1695

def insert_datafeed(merchant_id, datafeed_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/datafeeds', options)
  command.request_representation = Google::Apis::ContentV2_1::Datafeed::Representation
  command.request_object = datafeed_object
  command.response_representation = Google::Apis::ContentV2_1::Datafeed::Representation
  command.response_class = Google::Apis::ContentV2_1::Datafeed
  command.params['merchantId'] = merchant_id unless merchant_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

#insert_localinventory(merchant_id, product_id, local_inventory_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::LocalInventory

Updates the local inventory of a product in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that contains the product. This account cannot be a multi-client account.

  • product_id (String)

    The REST ID of the product for which to update local inventory.

  • local_inventory_object (Google::Apis::ContentV2_1::LocalInventory) (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



2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
# File 'lib/google/apis/content_v2_1/service.rb', line 2324

def insert_localinventory(merchant_id, product_id, local_inventory_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/products/{productId}/localinventory', options)
  command.request_representation = Google::Apis::ContentV2_1::LocalInventory::Representation
  command.request_object = local_inventory_object
  command.response_representation = Google::Apis::ContentV2_1::LocalInventory::Representation
  command.response_class = Google::Apis::ContentV2_1::LocalInventory
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['productId'] = product_id unless product_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

#insert_po(merchant_id, target_merchant_id, pos_store_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::PosStore

Creates a store for the given merchant.

Parameters:

  • merchant_id (Fixnum)

    The ID of the POS or inventory data provider.

  • target_merchant_id (Fixnum)

    The ID of the target merchant.

  • pos_store_object (Google::Apis::ContentV2_1::PosStore) (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



3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
# File 'lib/google/apis/content_v2_1/service.rb', line 3742

def insert_po(merchant_id, target_merchant_id, pos_store_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/pos/{targetMerchantId}/store', options)
  command.request_representation = Google::Apis::ContentV2_1::PosStore::Representation
  command.request_object = pos_store_object
  command.response_representation = Google::Apis::ContentV2_1::PosStore::Representation
  command.response_class = Google::Apis::ContentV2_1::PosStore
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['targetMerchantId'] = target_merchant_id unless target_merchant_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

#insert_product(merchant_id, product_object = nil, feed_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Product

Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that contains the product. This account cannot be a multi-client account.

  • product_object (Google::Apis::ContentV2_1::Product) (defaults to: nil)
  • feed_id (Fixnum) (defaults to: nil)

    The Content API Supplemental Feed ID. If present then product insertion applies to the data in a supplemental feed.

  • 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



3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
# File 'lib/google/apis/content_v2_1/service.rb', line 3987

def insert_product(merchant_id, product_object = nil, feed_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/products', options)
  command.request_representation = Google::Apis::ContentV2_1::Product::Representation
  command.request_object = product_object
  command.response_representation = Google::Apis::ContentV2_1::Product::Representation
  command.response_class = Google::Apis::ContentV2_1::Product
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['feedId'] = feed_id unless feed_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

#insert_regionalinventory(merchant_id, product_id, regional_inventory_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::RegionalInventory

Update the regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that contains the product. This account cannot be a multi-client account.

  • product_id (String)

    The REST ID of the product for which to update the regional inventory.

  • regional_inventory_object (Google::Apis::ContentV2_1::RegionalInventory) (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



4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
# File 'lib/google/apis/content_v2_1/service.rb', line 4376

def insert_regionalinventory(merchant_id, product_id, regional_inventory_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/products/{productId}/regionalinventory', options)
  command.request_representation = Google::Apis::ContentV2_1::RegionalInventory::Representation
  command.request_object = regional_inventory_object
  command.response_representation = Google::Apis::ContentV2_1::RegionalInventory::Representation
  command.response_class = Google::Apis::ContentV2_1::RegionalInventory
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['productId'] = product_id unless product_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

#insert_returnaddress(merchant_id, return_address_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ReturnAddress

Inserts a return address for the Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The Merchant Center account to insert a return address for.

  • return_address_object (Google::Apis::ContentV2_1::ReturnAddress) (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



4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
# File 'lib/google/apis/content_v2_1/service.rb', line 4961

def insert_returnaddress(merchant_id, return_address_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/returnaddress', options)
  command.request_representation = Google::Apis::ContentV2_1::ReturnAddress::Representation
  command.request_object = return_address_object
  command.response_representation = Google::Apis::ContentV2_1::ReturnAddress::Representation
  command.response_class = Google::Apis::ContentV2_1::ReturnAddress
  command.params['merchantId'] = merchant_id unless merchant_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

#insert_returnpolicy(merchant_id, return_policy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ReturnPolicy

Inserts a return policy for the Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The Merchant Center account to insert a return policy for.

  • return_policy_object (Google::Apis::ContentV2_1::ReturnPolicy) (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



5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
# File 'lib/google/apis/content_v2_1/service.rb', line 5128

def insert_returnpolicy(merchant_id, return_policy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/returnpolicy', options)
  command.request_representation = Google::Apis::ContentV2_1::ReturnPolicy::Representation
  command.request_object = return_policy_object
  command.response_representation = Google::Apis::ContentV2_1::ReturnPolicy::Representation
  command.response_class = Google::Apis::ContentV2_1::ReturnPolicy
  command.params['merchantId'] = merchant_id unless merchant_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

#instorerefundlineitem_order(merchant_id, order_id, orders_in_store_refund_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersInStoreRefundLineItemResponse

Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store) . Note: We recommend calling the returnrefundlineitem method to refund in- store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order.

  • orders_in_store_refund_line_item_request_object (Google::Apis::ContentV2_1::OrdersInStoreRefundLineItemRequest) (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



3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
# File 'lib/google/apis/content_v2_1/service.rb', line 3169

def instorerefundlineitem_order(merchant_id, order_id, orders_in_store_refund_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/inStoreRefundLineItem', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersInStoreRefundLineItemRequest::Representation
  command.request_object = orders_in_store_refund_line_item_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersInStoreRefundLineItemResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersInStoreRefundLineItemResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#inventory_po(merchant_id, target_merchant_id, pos_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::PosInventoryResponse

Submit inventory for the given merchant.

Parameters:

  • merchant_id (Fixnum)

    The ID of the POS or inventory data provider.

  • target_merchant_id (Fixnum)

    The ID of the target merchant.

  • pos_inventory_request_object (Google::Apis::ContentV2_1::PosInventoryRequest) (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



3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
# File 'lib/google/apis/content_v2_1/service.rb', line 3778

def inventory_po(merchant_id, target_merchant_id, pos_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/pos/{targetMerchantId}/inventory', options)
  command.request_representation = Google::Apis::ContentV2_1::PosInventoryRequest::Representation
  command.request_object = pos_inventory_request_object
  command.response_representation = Google::Apis::ContentV2_1::PosInventoryResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::PosInventoryResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['targetMerchantId'] = target_merchant_id unless target_merchant_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

Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account that should be linked.

  • accounts_link_request_object (Google::Apis::ContentV2_1::AccountsLinkRequest) (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



283
284
285
286
287
288
289
290
291
292
293
294
# File 'lib/google/apis/content_v2_1/service.rb', line 283

def (merchant_id, , accounts_link_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/accounts/{accountId}/link', options)
  command.request_representation = Google::Apis::ContentV2_1::AccountsLinkRequest::Representation
  command.request_object = accounts_link_request_object
  command.response_representation = Google::Apis::ContentV2_1::AccountsLinkResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountsLinkResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_labels(account_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ListAccountLabelsResponse

Lists the labels assigned to an account.

Parameters:

  • account_id (Fixnum)

    Required. The account id for whose labels are to be listed.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    A page token, received from a previous ListAccountLabels call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccountLabels 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



589
590
591
592
593
594
595
596
597
598
599
# File 'lib/google/apis/content_v2_1/service.rb', line 589

def (, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/labels', options)
  command.response_representation = Google::Apis::ContentV2_1::ListAccountLabelsResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ListAccountLabelsResponse
  command.params['accountId'] =  unless .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_returncarriers(account_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ListAccountReturnCarrierResponse

Lists available return carriers in the merchant account.

Parameters:

  • account_id (Fixnum)

    Required. The Merchant Center Account Id under which the Return Carrier is to be linked.

  • 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



724
725
726
727
728
729
730
731
732
# File 'lib/google/apis/content_v2_1/service.rb', line 724

def (, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/returncarrier', options)
  command.response_representation = Google::Apis::ContentV2_1::ListAccountReturnCarrierResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ListAccountReturnCarrierResponse
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_accounts(merchant_id, label: nil, max_results: nil, name: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountsListResponse

Lists the sub-accounts in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. This must be a multi-client account.

  • label (Fixnum) (defaults to: nil)

    If view is set to "css", only return accounts that are assigned label with given ID.

  • max_results (Fixnum) (defaults to: nil)

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

  • name (String) (defaults to: nil)

    If set, only the accounts with the given name (case sensitive) will be returned.

  • page_token (String) (defaults to: nil)

    The token returned by the previous request.

  • view (String) (defaults to: nil)

    Controls which fields will be populated. Acceptable values are: "merchant" and "css". The default value is "merchant".

  • 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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
# File 'lib/google/apis/content_v2_1/service.rb', line 329

def list_accounts(merchant_id, label: nil, max_results: nil, name: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/accounts', options)
  command.response_representation = Google::Apis::ContentV2_1::AccountsListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountsListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['label'] = label unless label.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['name'] = name unless name.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.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_accountstatuses(merchant_id, destinations: nil, max_results: nil, name: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountstatusesListResponse

Lists the statuses of the sub-accounts in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. This must be a multi-client account.

  • destinations (Array<String>, String) (defaults to: nil)

    If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of account statuses to return in the response, used for paging.

  • name (String) (defaults to: nil)

    If set, only the accounts with the given name (case sensitive) will be returned.

  • 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



872
873
874
875
876
877
878
879
880
881
882
883
884
# File 'lib/google/apis/content_v2_1/service.rb', line 872

def list_accountstatuses(merchant_id, destinations: nil, max_results: nil, name: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/accountstatuses', options)
  command.response_representation = Google::Apis::ContentV2_1::AccountstatusesListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountstatusesListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['destinations'] = destinations unless destinations.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['name'] = name unless name.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_accounttaxes(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccounttaxListResponse

Lists the tax settings of the sub-accounts in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. This must be a multi-client account.

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



975
976
977
978
979
980
981
982
983
984
985
# File 'lib/google/apis/content_v2_1/service.rb', line 975

def list_accounttaxes(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/accounttax', options)
  command.response_representation = Google::Apis::ContentV2_1::AccounttaxListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::AccounttaxListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['maxResults'] = max_results unless max_results.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_collections(merchant_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ListCollectionsResponse

Lists the collections in your Merchant Center account. The response might contain fewer items than specified by page_size. Rely on next_page_token to determine if there are more items to be requested.

Parameters:

  • merchant_id (Fixnum)

    Required. The ID of the account that contains the collection. This account cannot be a multi-client account.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of collections to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    Token (if provided) to retrieve the subsequent page. All other parameters must match the original 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



1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
# File 'lib/google/apis/content_v2_1/service.rb', line 1343

def list_collections(merchant_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/collections', options)
  command.response_representation = Google::Apis::ContentV2_1::ListCollectionsResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ListCollectionsResponse
  command.params['merchantId'] = merchant_id unless merchant_id.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_collectionstatuses(merchant_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ListCollectionStatusesResponse

Lists the statuses of the collections in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    Required. The ID of the account that contains the collection. This account cannot be a multi-client account.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of collection statuses to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    Token (if provided) to retrieve the subsequent page. All other parameters must match the original 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



1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
# File 'lib/google/apis/content_v2_1/service.rb', line 1417

def list_collectionstatuses(merchant_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/collectionstatuses', options)
  command.response_representation = Google::Apis::ContentV2_1::ListCollectionStatusesResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ListCollectionStatusesResponse
  command.params['merchantId'] = merchant_id unless merchant_id.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_csses(css_group_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ListCssesResponse

Lists CSS domains affiliated with a CSS group.

Parameters:

  • css_group_id (Fixnum)

    Required. The CSS group ID of CSS domains to be listed.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    A page token, received from a previous ListCsses call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListCsses 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



1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
# File 'lib/google/apis/content_v2_1/service.rb', line 1492

def list_csses(css_group_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{cssGroupId}/csses', options)
  command.response_representation = Google::Apis::ContentV2_1::ListCssesResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ListCssesResponse
  command.params['cssGroupId'] = css_group_id unless css_group_id.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_datafeeds(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::DatafeedsListResponse

Lists the configurations for datafeeds in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the datafeeds. This account cannot be a multi-client account.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of products 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



1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
# File 'lib/google/apis/content_v2_1/service.rb', line 1732

def list_datafeeds(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/datafeeds', options)
  command.response_representation = Google::Apis::ContentV2_1::DatafeedsListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::DatafeedsListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['maxResults'] = max_results unless max_results.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_datafeedstatuses(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::DatafeedstatusesListResponse

Lists the statuses of the datafeeds in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the datafeeds. This account cannot be a multi-client account.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of products 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



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

def list_datafeedstatuses(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/datafeedstatuses', options)
  command.response_representation = Google::Apis::ContentV2_1::DatafeedstatusesListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::DatafeedstatusesListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['maxResults'] = max_results unless max_results.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_liasettings(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::LiasettingsListResponse

Lists the LIA settings of the sub-accounts in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. This must be a multi-client account.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of LIA 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



2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
# File 'lib/google/apis/content_v2_1/service.rb', line 2021

def list_liasettings(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/liasettings', options)
  command.response_representation = Google::Apis::ContentV2_1::LiasettingsListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::LiasettingsListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['maxResults'] = max_results unless max_results.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_orderreturns(merchant_id, acknowledged: nil, created_end_date: nil, created_start_date: nil, google_order_ids: nil, max_results: nil, order_by: nil, page_token: nil, shipment_states: nil, shipment_status: nil, shipment_tracking_numbers: nil, shipment_types: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrderreturnsListResponse

Lists order returns in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • acknowledged (Boolean) (defaults to: nil)

    Obtains order returns that match the acknowledgement status. When set to true, obtains order returns that have been acknowledged. When false, obtains order returns that have not been acknowledged. When not provided, obtains order returns regardless of their acknowledgement status. We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged order returns are returned.

  • created_end_date (String) (defaults to: nil)

    Obtains order returns created before this date (inclusively), in ISO 8601 format.

  • created_start_date (String) (defaults to: nil)

    Obtains order returns created after this date (inclusively), in ISO 8601 format.

  • google_order_ids (Array<String>, String) (defaults to: nil)

    Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.

  • order_by (String) (defaults to: nil)

    Return the results in the specified order.

  • page_token (String) (defaults to: nil)

    The token returned by the previous request.

  • shipment_states (Array<String>, String) (defaults to: nil)

    Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states.

  • shipment_status (Array<String>, String) (defaults to: nil)

    Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses.

  • shipment_tracking_numbers (Array<String>, String) (defaults to: nil)

    Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.

  • shipment_types (Array<String>, String) (defaults to: nil)

    Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types.

  • 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



2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
# File 'lib/google/apis/content_v2_1/service.rb', line 2680

def list_orderreturns(merchant_id, acknowledged: nil, created_end_date: nil, created_start_date: nil, google_order_ids: nil, max_results: nil, order_by: nil, page_token: nil, shipment_states: nil, shipment_status: nil, shipment_tracking_numbers: nil, shipment_types: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/orderreturns', options)
  command.response_representation = Google::Apis::ContentV2_1::OrderreturnsListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrderreturnsListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['acknowledged'] = acknowledged unless acknowledged.nil?
  command.query['createdEndDate'] = created_end_date unless created_end_date.nil?
  command.query['createdStartDate'] = created_start_date unless created_start_date.nil?
  command.query['googleOrderIds'] = google_order_ids unless google_order_ids.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['shipmentStates'] = shipment_states unless shipment_states.nil?
  command.query['shipmentStatus'] = shipment_status unless shipment_status.nil?
  command.query['shipmentTrackingNumbers'] = shipment_tracking_numbers unless shipment_tracking_numbers.nil?
  command.query['shipmentTypes'] = shipment_types unless shipment_types.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_orders(merchant_id, acknowledged: nil, max_results: nil, order_by: nil, page_token: nil, placed_date_end: nil, placed_date_start: nil, statuses: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersListResponse

Lists the orders in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • acknowledged (Boolean) (defaults to: nil)

    Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.

  • order_by (String) (defaults to: nil)

    Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc

  • page_token (String) (defaults to: nil)

    The token returned by the previous request.

  • placed_date_end (String) (defaults to: nil)

    Obtains orders placed before this date (exclusively), in ISO 8601 format.

  • placed_date_start (String) (defaults to: nil)

    Obtains orders placed after this date (inclusively), in ISO 8601 format.

  • statuses (Array<String>, String) (defaults to: nil)

    Obtains orders that match any of the specified statuses. Please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, returned, and canceled.

  • 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



3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
# File 'lib/google/apis/content_v2_1/service.rb', line 3227

def list_orders(merchant_id, acknowledged: nil, max_results: nil, order_by: nil, page_token: nil, placed_date_end: nil, placed_date_start: nil, statuses: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/orders', options)
  command.response_representation = Google::Apis::ContentV2_1::OrdersListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['acknowledged'] = acknowledged unless acknowledged.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['placedDateEnd'] = placed_date_end unless placed_date_end.nil?
  command.query['placedDateStart'] = placed_date_start unless placed_date_start.nil?
  command.query['statuses'] = statuses unless statuses.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_pos(merchant_id, target_merchant_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::PosListResponse

Lists the stores of the target merchant.

Parameters:

  • merchant_id (Fixnum)

    The ID of the POS or inventory data provider.

  • target_merchant_id (Fixnum)

    The ID of the target merchant.

  • 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



3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
# File 'lib/google/apis/content_v2_1/service.rb', line 3813

def list_pos(merchant_id, target_merchant_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/pos/{targetMerchantId}/store', options)
  command.response_representation = Google::Apis::ContentV2_1::PosListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::PosListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['targetMerchantId'] = target_merchant_id unless target_merchant_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

#list_products(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ProductsListResponse

Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that contains the products. This account cannot be a multi-client account.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of products 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



4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
# File 'lib/google/apis/content_v2_1/service.rb', line 4027

def list_products(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/products', options)
  command.response_representation = Google::Apis::ContentV2_1::ProductsListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ProductsListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['maxResults'] = max_results unless max_results.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_productstatus_repricingreports(merchant_id, product_id, end_date: nil, page_size: nil, page_token: nil, rule_id: nil, start_date: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ListRepricingProductReportsResponse

Lists the metrics report for a given Repricing product.

Parameters:

  • merchant_id (Fixnum)

    Required. Id of the merchant who owns the Repricing rule.

  • product_id (String)

    Required. Id of the Repricing product. Also known as the REST_ID

  • end_date (String) (defaults to: nil)

    Gets Repricing reports on and before this date in the merchant's timezone. You can only retrieve data up to 7 days ago (default) or earlier. Format is YYYY- MM-DD.

  • page_size (Fixnum) (defaults to: nil)

    Maximum number of days of reports to return. There can be more than one rule report returned per day. For example, if 3 rule types got applied to the same product within a 24-hour period, then a page_size of 1 will return 3 rule reports. The page size defaults to 50 and values above 1000 are coerced to

    1. This service may return fewer days of reports than this value, for example, if the time between your start and end date is less than the page size.
  • page_token (String) (defaults to: nil)

    Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.

  • rule_id (String) (defaults to: nil)

    Id of the Repricing rule. If specified, only gets this rule's reports.

  • start_date (String) (defaults to: nil)

    Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago. Do not use a start date later than 7 days ago (default). Format is YYYY-MM-DD.

  • 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



4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
# File 'lib/google/apis/content_v2_1/service.rb', line 4239

def list_productstatus_repricingreports(merchant_id, product_id, end_date: nil, page_size: nil, page_token: nil, rule_id: nil, start_date: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/productstatuses/{productId}/repricingreports', options)
  command.response_representation = Google::Apis::ContentV2_1::ListRepricingProductReportsResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ListRepricingProductReportsResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['endDate'] = end_date unless end_date.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['ruleId'] = rule_id unless rule_id.nil?
  command.query['startDate'] = start_date unless start_date.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_productstatuses(merchant_id, destinations: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ProductstatusesListResponse

Lists the statuses of the products in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that contains the products. This account cannot be a multi-client account.

  • destinations (Array<String>, String) (defaults to: nil)

    If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of product statuses 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



4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
# File 'lib/google/apis/content_v2_1/service.rb', line 4181

def list_productstatuses(merchant_id, destinations: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/productstatuses', options)
  command.response_representation = Google::Apis::ContentV2_1::ProductstatusesListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ProductstatusesListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['destinations'] = destinations unless destinations.nil?
  command.query['maxResults'] = max_results unless max_results.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_regions(merchant_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ListRegionsResponse

Lists the regions in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant for which to list region definitions.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    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



4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
# File 'lib/google/apis/content_v2_1/service.rb', line 4517

def list_regions(merchant_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/regions', options)
  command.response_representation = Google::Apis::ContentV2_1::ListRegionsResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ListRegionsResponse
  command.params['merchantId'] = merchant_id unless merchant_id.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_repricingrule_repricingreports(merchant_id, rule_id, end_date: nil, page_size: nil, page_token: nil, start_date: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ListRepricingRuleReportsResponse

Lists the metrics report for a given Repricing rule.

Parameters:

  • merchant_id (Fixnum)

    Required. Id of the merchant who owns the Repricing rule.

  • rule_id (String)

    Required. Id of the Repricing rule.

  • end_date (String) (defaults to: nil)

    Gets Repricing reports on and before this date in the merchant's timezone. You can only retrieve data up to 7 days ago (default) or earlier. Format: YYYY-MM- DD.

  • page_size (Fixnum) (defaults to: nil)

    Maximum number of daily reports to return. Each report includes data from a single 24-hour period. The page size defaults to 50 and values above 1000 are coerced to 1000. This service may return fewer days than this value, for example, if the time between your start and end date is less than page size.

  • page_token (String) (defaults to: nil)

    Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.

  • start_date (String) (defaults to: nil)

    Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago. Do not use a start date later than 7 days ago (default). Format: YYYY-MM-DD.

  • 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



4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
# File 'lib/google/apis/content_v2_1/service.rb', line 4831

def list_repricingrule_repricingreports(merchant_id, rule_id, end_date: nil, page_size: nil, page_token: nil, start_date: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/repricingrules/{ruleId}/repricingreports', options)
  command.response_representation = Google::Apis::ContentV2_1::ListRepricingRuleReportsResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ListRepricingRuleReportsResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['ruleId'] = rule_id unless rule_id.nil?
  command.query['endDate'] = end_date unless end_date.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['startDate'] = start_date unless start_date.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_repricingrules(merchant_id, country_code: nil, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ListRepricingRulesResponse

Lists the repricing rules in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant who owns the repricing rule.

  • country_code (String) (defaults to: nil)

    CLDR country code (e.g. "US"), used as a filter on repricing rules.

  • language_code (String) (defaults to: nil)

    The two-letter ISO 639-1 language code associated with the repricing rule, used as a filter.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    A page token, received from a previous ListRepricingRules call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRepricingRules 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



4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
# File 'lib/google/apis/content_v2_1/service.rb', line 4739

def list_repricingrules(merchant_id, country_code: nil, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/repricingrules', options)
  command.response_representation = Google::Apis::ContentV2_1::ListRepricingRulesResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ListRepricingRulesResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['countryCode'] = country_code unless country_code.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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_returnaddresses(merchant_id, country: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ReturnaddressListResponse

Lists the return addresses of the Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The Merchant Center account to list return addresses for.

  • country (String) (defaults to: nil)

    List only return addresses applicable to the given country of sale. When omitted, all return addresses are listed.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of addresses 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



5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
# File 'lib/google/apis/content_v2_1/service.rb', line 5000

def list_returnaddresses(merchant_id, country: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/returnaddress', options)
  command.response_representation = Google::Apis::ContentV2_1::ReturnaddressListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ReturnaddressListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['country'] = country unless country.nil?
  command.query['maxResults'] = max_results unless max_results.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_returnpolicies(merchant_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ReturnpolicyListResponse

Lists the return policies of the Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The Merchant Center account to list return policies for.

  • 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



5160
5161
5162
5163
5164
5165
5166
5167
5168
# File 'lib/google/apis/content_v2_1/service.rb', line 5160

def list_returnpolicies(merchant_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/returnpolicy', options)
  command.response_representation = Google::Apis::ContentV2_1::ReturnpolicyListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ReturnpolicyListResponse
  command.params['merchantId'] = merchant_id unless merchant_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

#list_returnpolicyonlines(merchant_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ListReturnPolicyOnlineResponse

Lists all existing return policies.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant for which to retrieve the return policy online object.

  • 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



5291
5292
5293
5294
5295
5296
5297
5298
5299
# File 'lib/google/apis/content_v2_1/service.rb', line 5291

def list_returnpolicyonlines(merchant_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/returnpolicyonline', options)
  command.response_representation = Google::Apis::ContentV2_1::ListReturnPolicyOnlineResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ListReturnPolicyOnlineResponse
  command.params['merchantId'] = merchant_id unless merchant_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

#list_settlementreports(merchant_id, max_results: nil, page_token: nil, transfer_end_date: nil, transfer_start_date: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::SettlementreportsListResponse

Retrieves a list of settlement reports from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The Merchant Center account to list settlements for.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of settlements to return in the response, used for paging. The default value is 200 returns per page, and the maximum allowed value is 5000 returns per page.

  • page_token (String) (defaults to: nil)

    The token returned by the previous request.

  • transfer_end_date (String) (defaults to: nil)

    Obtains settlements which have transactions before this date (inclusively), in ISO 8601 format.

  • transfer_start_date (String) (defaults to: nil)

    Obtains settlements which have transactions after this date (inclusively), in ISO 8601 format.

  • 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



5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
# File 'lib/google/apis/content_v2_1/service.rb', line 5403

def list_settlementreports(merchant_id, max_results: nil, page_token: nil, transfer_end_date: nil, transfer_start_date: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/settlementreports', options)
  command.response_representation = Google::Apis::ContentV2_1::SettlementreportsListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::SettlementreportsListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['transferEndDate'] = transfer_end_date unless transfer_end_date.nil?
  command.query['transferStartDate'] = transfer_start_date unless transfer_start_date.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_settlementtransactions(merchant_id, settlement_id, max_results: nil, page_token: nil, transaction_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::SettlementtransactionsListResponse

Retrieves a list of transactions for the settlement.

Parameters:

  • merchant_id (Fixnum)

    The Merchant Center account to list transactions for.

  • settlement_id (String)

    The Google-provided ID of the settlement.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of transactions to return in the response, used for paging. The default value is 200 transactions per page, and the maximum allowed value is 5000 transactions per page.

  • page_token (String) (defaults to: nil)

    The token returned by the previous request.

  • transaction_ids (Array<String>, String) (defaults to: nil)

    The list of transactions to return. If not set, all transactions will be returned.

  • 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



5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
# File 'lib/google/apis/content_v2_1/service.rb', line 5448

def list_settlementtransactions(merchant_id, settlement_id, max_results: nil, page_token: nil, transaction_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/settlementreports/{settlementId}/transactions', options)
  command.response_representation = Google::Apis::ContentV2_1::SettlementtransactionsListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::SettlementtransactionsListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['settlementId'] = settlement_id unless settlement_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['transactionIds'] = transaction_ids unless transaction_ids.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_shippingsettings(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ShippingsettingsListResponse

Lists the shipping settings of the sub-accounts in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. This must be a multi-client account.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of shipping 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



5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
# File 'lib/google/apis/content_v2_1/service.rb', line 5644

def list_shippingsettings(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/shippingsettings', options)
  command.response_representation = Google::Apis::ContentV2_1::ShippingsettingsListResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::ShippingsettingsListResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['maxResults'] = max_results unless max_results.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

#listdisbursements_orderreport(merchant_id, disbursement_end_date: nil, disbursement_start_date: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrderreportsListDisbursementsResponse

Retrieves a report for disbursements from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • disbursement_end_date (String) (defaults to: nil)

    The last date which disbursements occurred. In ISO 8601 format. Default: current date.

  • disbursement_start_date (String) (defaults to: nil)

    The first date which disbursements occurred. In ISO 8601 format.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of disbursements 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



2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
# File 'lib/google/apis/content_v2_1/service.rb', line 2445

def listdisbursements_orderreport(merchant_id, disbursement_end_date: nil, disbursement_start_date: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/orderreports/disbursements', options)
  command.response_representation = Google::Apis::ContentV2_1::OrderreportsListDisbursementsResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrderreportsListDisbursementsResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['disbursementEndDate'] = disbursement_end_date unless disbursement_end_date.nil?
  command.query['disbursementStartDate'] = disbursement_start_date unless disbursement_start_date.nil?
  command.query['maxResults'] = max_results unless max_results.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

Returns the list of accounts linked to your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account for which to list links.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of links to return in the response, used for pagination. The minimum allowed value is 5 results per page. If provided value is lower than 5, it will be automatically increased to 5.

  • 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



374
375
376
377
378
379
380
381
382
383
384
385
# File 'lib/google/apis/content_v2_1/service.rb', line 374

def (merchant_id, , max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/accounts/{accountId}/listlinks', options)
  command.response_representation = Google::Apis::ContentV2_1::AccountsListLinksResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountsListLinksResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['maxResults'] = max_results unless max_results.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

#listposdataproviders_liasetting(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::LiasettingsListPosDataProvidersResponse

Retrieves the list of POS data providers that have active settings for the all eiligible countries.

Parameters:

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2052
2053
2054
2055
2056
2057
2058
2059
# File 'lib/google/apis/content_v2_1/service.rb', line 2052

def listposdataproviders_liasetting(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'liasettings/posdataproviders', options)
  command.response_representation = Google::Apis::ContentV2_1::LiasettingsListPosDataProvidersResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::LiasettingsListPosDataProvidersResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#listtransactions_orderreport(merchant_id, disbursement_id, max_results: nil, page_token: nil, transaction_end_date: nil, transaction_start_date: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrderreportsListTransactionsResponse

Retrieves a list of transactions for a disbursement from your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • disbursement_id (String)

    The Google-provided ID of the disbursement (found in Wallet).

  • max_results (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    The token returned by the previous request.

  • transaction_end_date (String) (defaults to: nil)

    The last date in which transaction occurred. In ISO 8601 format. Default: current date.

  • transaction_start_date (String) (defaults to: nil)

    The first date in which transaction occurred. In ISO 8601 format.

  • 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



2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
# File 'lib/google/apis/content_v2_1/service.rb', line 2492

def listtransactions_orderreport(merchant_id, disbursement_id, max_results: nil, page_token: nil, transaction_end_date: nil, transaction_start_date: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '{merchantId}/orderreports/disbursements/{disbursementId}/transactions', options)
  command.response_representation = Google::Apis::ContentV2_1::OrderreportsListTransactionsResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrderreportsListTransactionsResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['disbursementId'] = disbursement_id unless disbursement_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['transactionEndDate'] = transaction_end_date unless transaction_end_date.nil?
  command.query['transactionStartDate'] = transaction_start_date unless transaction_start_date.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#onboard_buyongoogleprogram_buy_on_google_program(merchant_id, region_code, onboard_buy_on_google_program_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Onboards the BoG program in your Merchant Center account. By using this method, you agree to the Terms of Service. Calling this method is only possible if the authenticated account is the same as the merchant id in the request. Calling this method multiple times will only accept Terms of Service if the latest version is not currently signed.

Parameters:

  • merchant_id (Fixnum)

    Required. The ID of the account.

  • region_code (String)

    The program region code ISO 3166-1 alpha-2. Currently only US is available.

  • onboard_buy_on_google_program_request_object (Google::Apis::ContentV2_1::OnboardBuyOnGoogleProgramRequest) (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:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



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

def onboard_buyongoogleprogram_buy_on_google_program(merchant_id, region_code, onboard_buy_on_google_program_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/buyongoogleprograms/{regionCode}/onboard', options)
  command.request_representation = Google::Apis::ContentV2_1::OnboardBuyOnGoogleProgramRequest::Representation
  command.request_object = onboard_buy_on_google_program_request_object
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['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

#patch_account_label(account_id, label_id, account_label_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountLabel

Updates a label.

Parameters:

  • account_id (Fixnum)

    Required. The id of the account this label belongs to.

  • label_id (Fixnum)

    Required. The id of the label to update.

  • account_label_object (Google::Apis::ContentV2_1::AccountLabel) (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



624
625
626
627
628
629
630
631
632
633
634
635
# File 'lib/google/apis/content_v2_1/service.rb', line 624

def (, label_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'accounts/{accountId}/labels/{labelId}', options)
  command.request_representation = Google::Apis::ContentV2_1::AccountLabel::Representation
  command.request_object = 
  command.response_representation = Google::Apis::ContentV2_1::AccountLabel::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountLabel
  command.params['accountId'] =  unless .nil?
  command.params['labelId'] = label_id unless label_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

#patch_account_returncarrier(account_id, carrier_account_id, account_return_carrier_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountReturnCarrier

Updates a return carrier in the merchant account.

Parameters:

  • account_id (Fixnum)

    Required. The Merchant Center Account Id under which the Return Carrier is to be linked.

  • carrier_account_id (Fixnum)

    Required. The Google-provided unique carrier ID, used to update the resource.

  • account_return_carrier_object (Google::Apis::ContentV2_1::AccountReturnCarrier) (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



758
759
760
761
762
763
764
765
766
767
768
769
# File 'lib/google/apis/content_v2_1/service.rb', line 758

def (, ,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'accounts/{accountId}/returncarrier/{carrierAccountId}', options)
  command.request_representation = Google::Apis::ContentV2_1::AccountReturnCarrier::Representation
  command.request_object = 
  command.response_representation = Google::Apis::ContentV2_1::AccountReturnCarrier::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountReturnCarrier
  command.params['accountId'] =  unless .nil?
  command.params['carrierAccountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_region(merchant_id, region_id, region_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Region

Updates a region definition in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant for which to update region definition.

  • region_id (String)

    Required. The id of the region to update.

  • region_object (Google::Apis::ContentV2_1::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



4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
# File 'lib/google/apis/content_v2_1/service.rb', line 4555

def patch_region(merchant_id, region_id, region_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, '{merchantId}/regions/{regionId}', options)
  command.request_representation = Google::Apis::ContentV2_1::Region::Representation
  command.request_object = region_object
  command.response_representation = Google::Apis::ContentV2_1::Region::Representation
  command.response_class = Google::Apis::ContentV2_1::Region
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['regionId'] = region_id unless region_id.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_repricingrule(merchant_id, rule_id, repricing_rule_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::RepricingRule

Updates a repricing rule in your Merchant Center account. All mutable fields will be overwritten in each update request. In each update, you must provide all required mutable fields, or an error will be thrown. If you do not provide an optional field in the update request, if that field currently exists, it will be deleted from the rule.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant who owns the repricing rule.

  • rule_id (String)

    Required. The id of the rule to update.

  • repricing_rule_object (Google::Apis::ContentV2_1::RepricingRule) (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



4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
# File 'lib/google/apis/content_v2_1/service.rb', line 4780

def patch_repricingrule(merchant_id, rule_id, repricing_rule_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, '{merchantId}/repricingrules/{ruleId}', options)
  command.request_representation = Google::Apis::ContentV2_1::RepricingRule::Representation
  command.request_object = repricing_rule_object
  command.response_representation = Google::Apis::ContentV2_1::RepricingRule::Representation
  command.response_class = Google::Apis::ContentV2_1::RepricingRule
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['ruleId'] = rule_id unless rule_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

#patch_returnpolicyonline(merchant_id, return_policy_id, return_policy_online_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ReturnPolicyOnline

Updates an existing return policy.

Parameters:

  • merchant_id (Fixnum)

    Required. The id of the merchant for which to retrieve the return policy online object.

  • return_policy_id (String)

    Required. The id of the return policy to update.

  • return_policy_online_object (Google::Apis::ContentV2_1::ReturnPolicyOnline) (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



5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
# File 'lib/google/apis/content_v2_1/service.rb', line 5325

def patch_returnpolicyonline(merchant_id, return_policy_id, return_policy_online_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, '{merchantId}/returnpolicyonline/{returnPolicyId}', options)
  command.request_representation = Google::Apis::ContentV2_1::ReturnPolicyOnline::Representation
  command.request_object = return_policy_online_object
  command.response_representation = Google::Apis::ContentV2_1::ReturnPolicyOnline::Representation
  command.response_class = Google::Apis::ContentV2_1::ReturnPolicyOnline
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['returnPolicyId'] = return_policy_id unless return_policy_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

#pause_buyongoogleprogram_buy_on_google_program(merchant_id, region_code, pause_buy_on_google_program_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Pauses the BoG program in your Merchant Center account. Important: This method is only whitelisted for selected merchants.

Parameters:

  • merchant_id (Fixnum)

    Required. The ID of the account.

  • region_code (String)

    The program region code ISO 3166-1 alpha-2. Currently only US is available.

  • pause_buy_on_google_program_request_object (Google::Apis::ContentV2_1::PauseBuyOnGoogleProgramRequest) (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:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'lib/google/apis/content_v2_1/service.rb', line 1162

def pause_buyongoogleprogram_buy_on_google_program(merchant_id, region_code, pause_buy_on_google_program_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/buyongoogleprograms/{regionCode}/pause', options)
  command.request_representation = Google::Apis::ContentV2_1::PauseBuyOnGoogleProgramRequest::Representation
  command.request_object = pause_buy_on_google_program_request_object
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['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

#process_orderreturn(merchant_id, return_id, orderreturns_process_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrderreturnsProcessResponse

Processes return in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • return_id (String)

    The ID of the return.

  • orderreturns_process_request_object (Google::Apis::ContentV2_1::OrderreturnsProcessRequest) (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



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
# File 'lib/google/apis/content_v2_1/service.rb', line 2725

def process_orderreturn(merchant_id, return_id, orderreturns_process_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orderreturns/{returnId}/process', options)
  command.request_representation = Google::Apis::ContentV2_1::OrderreturnsProcessRequest::Representation
  command.request_object = orderreturns_process_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrderreturnsProcessResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrderreturnsProcessResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['returnId'] = return_id unless return_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

#refunditem_order(merchant_id, order_id, orders_refund_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersRefundItemResponse

Issues a partial or total refund for items and shipment.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order to refund.

  • orders_refund_item_request_object (Google::Apis::ContentV2_1::OrdersRefundItemRequest) (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



3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'lib/google/apis/content_v2_1/service.rb', line 3268

def refunditem_order(merchant_id, order_id, orders_refund_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/refunditem', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersRefundItemRequest::Representation
  command.request_object = orders_refund_item_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersRefundItemResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersRefundItemResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#refundorder_order(merchant_id, order_id, orders_refund_order_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersRefundOrderResponse

Issues a partial or total refund for an order.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order to refund.

  • orders_refund_order_request_object (Google::Apis::ContentV2_1::OrdersRefundOrderRequest) (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



3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
# File 'lib/google/apis/content_v2_1/service.rb', line 3305

def refundorder_order(merchant_id, order_id, orders_refund_order_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/refundorder', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersRefundOrderRequest::Representation
  command.request_object = orders_refund_order_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersRefundOrderResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersRefundOrderResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#rejectreturnlineitem_order(merchant_id, order_id, orders_reject_return_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersRejectReturnLineItemResponse

Rejects return on an line item.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order.

  • orders_reject_return_line_item_request_object (Google::Apis::ContentV2_1::OrdersRejectReturnLineItemRequest) (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



3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'lib/google/apis/content_v2_1/service.rb', line 3342

def rejectreturnlineitem_order(merchant_id, order_id, orders_reject_return_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/rejectReturnLineItem', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersRejectReturnLineItemRequest::Representation
  command.request_object = orders_reject_return_line_item_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersRejectReturnLineItemResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersRejectReturnLineItemResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#requestgmbaccess_liasetting(merchant_id, account_id, gmb_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::LiasettingsRequestGmbAccessResponse

Requests access to a specified Google My Business account.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account for which GMB access is requested.

  • gmb_email (String)

    The email of the Google My Business 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



2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
# File 'lib/google/apis/content_v2_1/service.rb', line 2087

def requestgmbaccess_liasetting(merchant_id, , gmb_email, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/liasettings/{accountId}/requestgmbaccess', options)
  command.response_representation = Google::Apis::ContentV2_1::LiasettingsRequestGmbAccessResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::LiasettingsRequestGmbAccessResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['gmbEmail'] = gmb_email unless gmb_email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#requestinventoryverification_liasetting(merchant_id, account_id, country, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::LiasettingsRequestInventoryVerificationResponse

Requests inventory validation for the specified country.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • country (String)

    The country for which inventory validation is requested.

  • 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



2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
# File 'lib/google/apis/content_v2_1/service.rb', line 2126

def requestinventoryverification_liasetting(merchant_id, , country, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}', options)
  command.response_representation = Google::Apis::ContentV2_1::LiasettingsRequestInventoryVerificationResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::LiasettingsRequestInventoryVerificationResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.params['country'] = country unless country.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#requestreview_buyongoogleprogram(merchant_id, region_code, request_review_buy_on_google_program_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Requests review and then activates the BoG program in your Merchant Center account for the first time. Moves the program to the REVIEW_PENDING state. Important: This method is only whitelisted for selected merchants.

Parameters:

  • merchant_id (Fixnum)

    Required. The ID of the account.

  • region_code (String)

    The program region code ISO 3166-1 alpha-2. Currently only US is available.

  • request_review_buy_on_google_program_request_object (Google::Apis::ContentV2_1::RequestReviewBuyOnGoogleProgramRequest) (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:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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
1208
# File 'lib/google/apis/content_v2_1/service.rb', line 1199

def requestreview_buyongoogleprogram(merchant_id, region_code, request_review_buy_on_google_program_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/buyongoogleprograms/{regionCode}/requestreview', options)
  command.request_representation = Google::Apis::ContentV2_1::RequestReviewBuyOnGoogleProgramRequest::Representation
  command.request_object = request_review_buy_on_google_program_request_object
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['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

#returnrefundlineitem_order(merchant_id, order_id, orders_return_refund_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersReturnRefundLineItemResponse

Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order.

  • orders_return_refund_line_item_request_object (Google::Apis::ContentV2_1::OrdersReturnRefundLineItemRequest) (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



3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
# File 'lib/google/apis/content_v2_1/service.rb', line 3384

def returnrefundlineitem_order(merchant_id, order_id, orders_return_refund_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/returnRefundLineItem', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersReturnRefundLineItemRequest::Representation
  command.request_object = orders_return_refund_line_item_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersReturnRefundLineItemResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersReturnRefundLineItemResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#sale_po(merchant_id, target_merchant_id, pos_sale_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::PosSaleResponse

Submit a sale event for the given merchant.

Parameters:

  • merchant_id (Fixnum)

    The ID of the POS or inventory data provider.

  • target_merchant_id (Fixnum)

    The ID of the target merchant.

  • pos_sale_request_object (Google::Apis::ContentV2_1::PosSaleRequest) (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



3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
# File 'lib/google/apis/content_v2_1/service.rb', line 3847

def sale_po(merchant_id, target_merchant_id, pos_sale_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/pos/{targetMerchantId}/sale', options)
  command.request_representation = Google::Apis::ContentV2_1::PosSaleRequest::Representation
  command.request_object = pos_sale_request_object
  command.response_representation = Google::Apis::ContentV2_1::PosSaleResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::PosSaleResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['targetMerchantId'] = target_merchant_id unless target_merchant_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

#search_report(merchant_id, search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::SearchResponse

Retrieves merchant performance mertrics matching the search query and optionally segmented by selected dimensions.

Parameters:

  • merchant_id (Fixnum)

    Required. Id of the merchant making the call. Must be a standalone account or an MCA subaccount.

  • search_request_object (Google::Apis::ContentV2_1::SearchRequest) (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



4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
# File 'lib/google/apis/content_v2_1/service.rb', line 4592

def search_report(merchant_id, search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/reports/search', options)
  command.request_representation = Google::Apis::ContentV2_1::SearchRequest::Representation
  command.request_object = search_request_object
  command.response_representation = Google::Apis::ContentV2_1::SearchResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::SearchResponse
  command.params['merchantId'] = merchant_id unless merchant_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

#setinventoryverificationcontact_liasetting(merchant_id, account_id, country, language, contact_name, contact_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::LiasettingsSetInventoryVerificationContactResponse

Sets the inventory verification contract for the specified country.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • country (String)

    The country for which inventory verification is requested.

  • language (String)

    The language for which inventory verification is requested.

  • contact_name (String)

    The name of the inventory verification contact.

  • contact_email (String)

    The email of the inventory verification contact.

  • 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



2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
# File 'lib/google/apis/content_v2_1/service.rb', line 2171

def setinventoryverificationcontact_liasetting(merchant_id, , country, language, contact_name, contact_email, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/liasettings/{accountId}/setinventoryverificationcontact', options)
  command.response_representation = Google::Apis::ContentV2_1::LiasettingsSetInventoryVerificationContactResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::LiasettingsSetInventoryVerificationContactResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['contactEmail'] = contact_email unless contact_email.nil?
  command.query['contactName'] = contact_name unless contact_name.nil?
  command.query['country'] = country unless country.nil?
  command.query['language'] = language unless language.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#setlineitemmetadata_order(merchant_id, order_id, orders_set_line_item_metadata_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersSetLineItemMetadataResponse

Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order.

  • orders_set_line_item_metadata_request_object (Google::Apis::ContentV2_1::OrdersSetLineItemMetadataRequest) (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



3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
# File 'lib/google/apis/content_v2_1/service.rb', line 3425

def (merchant_id, order_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/setLineItemMetadata', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersSetLineItemMetadataRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::ContentV2_1::OrdersSetLineItemMetadataResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersSetLineItemMetadataResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#setposdataprovider_liasetting(merchant_id, account_id, country, pos_data_provider_id: nil, pos_external_account_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::LiasettingsSetPosDataProviderResponse

Sets the POS data provider for the specified country.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account for which to retrieve accessible Google My Business accounts.

  • country (String)

    The country for which the POS data provider is selected.

  • pos_data_provider_id (Fixnum) (defaults to: nil)

    The ID of POS data provider.

  • pos_external_account_id (String) (defaults to: nil)

    The account ID by which this merchant is known to the POS data provider.

  • 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



2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
# File 'lib/google/apis/content_v2_1/service.rb', line 2217

def setposdataprovider_liasetting(merchant_id, , country, pos_data_provider_id: nil, pos_external_account_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/liasettings/{accountId}/setposdataprovider', options)
  command.response_representation = Google::Apis::ContentV2_1::LiasettingsSetPosDataProviderResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::LiasettingsSetPosDataProviderResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['country'] = country unless country.nil?
  command.query['posDataProviderId'] = pos_data_provider_id unless pos_data_provider_id.nil?
  command.query['posExternalAccountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#shiplineitems_order(merchant_id, order_id, orders_ship_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersShipLineItemsResponse

Marks line item(s) as shipped.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order.

  • orders_ship_line_items_request_object (Google::Apis::ContentV2_1::OrdersShipLineItemsRequest) (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



3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
# File 'lib/google/apis/content_v2_1/service.rb', line 3462

def shiplineitems_order(merchant_id, order_id, orders_ship_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/shipLineItems', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersShipLineItemsRequest::Representation
  command.request_object = orders_ship_line_items_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersShipLineItemsResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersShipLineItemsResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#update_account(merchant_id, account_id, account_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Account

Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



413
414
415
416
417
418
419
420
421
422
423
424
# File 'lib/google/apis/content_v2_1/service.rb', line 413

def (merchant_id, ,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, '{merchantId}/accounts/{accountId}', options)
  command.request_representation = Google::Apis::ContentV2_1::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::ContentV2_1::Account::Representation
  command.response_class = Google::Apis::ContentV2_1::Account
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_accounttax(merchant_id, account_id, account_tax_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountTax

Updates the tax settings of the account. Any fields that are not provided are deleted from the resource.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account for which to get/update account tax settings.

  • account_tax_object (Google::Apis::ContentV2_1::AccountTax) (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



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
# File 'lib/google/apis/content_v2_1/service.rb', line 1013

def update_accounttax(merchant_id, ,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, '{merchantId}/accounttax/{accountId}', options)
  command.request_representation = Google::Apis::ContentV2_1::AccountTax::Representation
  command.request_object = 
  command.response_representation = Google::Apis::ContentV2_1::AccountTax::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountTax
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_datafeed(merchant_id, datafeed_id, datafeed_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Datafeed

Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the datafeed. This account cannot be a multi-client account.

  • datafeed_id (Fixnum)

    The ID of the datafeed.

  • datafeed_object (Google::Apis::ContentV2_1::Datafeed) (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



1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
# File 'lib/google/apis/content_v2_1/service.rb', line 1769

def update_datafeed(merchant_id, datafeed_id, datafeed_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, '{merchantId}/datafeeds/{datafeedId}', options)
  command.request_representation = Google::Apis::ContentV2_1::Datafeed::Representation
  command.request_object = datafeed_object
  command.response_representation = Google::Apis::ContentV2_1::Datafeed::Representation
  command.response_class = Google::Apis::ContentV2_1::Datafeed
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['datafeedId'] = datafeed_id unless datafeed_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

#update_liasetting(merchant_id, account_id, lia_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::LiaSettings

Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account for which to get or update LIA settings.

  • lia_settings_object (Google::Apis::ContentV2_1::LiaSettings) (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



2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
# File 'lib/google/apis/content_v2_1/service.rb', line 2257

def update_liasetting(merchant_id, , lia_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, '{merchantId}/liasettings/{accountId}', options)
  command.request_representation = Google::Apis::ContentV2_1::LiaSettings::Representation
  command.request_object = lia_settings_object
  command.response_representation = Google::Apis::ContentV2_1::LiaSettings::Representation
  command.response_class = Google::Apis::ContentV2_1::LiaSettings
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_product(merchant_id, product_id, product_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Product

Updates an existing product in your Merchant Center account. Only updates attributes provided in the request.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that contains the product. This account cannot be a multi-client account.

  • product_id (String)

    The REST ID of the product for which to update.

  • product_object (Google::Apis::ContentV2_1::Product) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The comma-separated list of product attributes to be updated. Example: "title, salePrice". Attributes specified in the update mask without a value specified in the body will be deleted from the product. Only top-level product attributes can be updated. If not defined, product attributes with set values will be updated and other attributes will stay unchanged.

  • 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



4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
# File 'lib/google/apis/content_v2_1/service.rb', line 4070

def update_product(merchant_id, product_id, product_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, '{merchantId}/products/{productId}', options)
  command.request_representation = Google::Apis::ContentV2_1::Product::Representation
  command.request_object = product_object
  command.response_representation = Google::Apis::ContentV2_1::Product::Representation
  command.response_class = Google::Apis::ContentV2_1::Product
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['productId'] = product_id unless product_id.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_pubsubnotificationsetting(merchant_id, pubsub_notification_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::PubsubNotificationSettings

Register a Merchant Center account for pubsub notifications. Note that cloud topic name should not be provided as part of the request.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account.

  • pubsub_notification_settings_object (Google::Apis::ContentV2_1::PubsubNotificationSettings) (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



4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
# File 'lib/google/apis/content_v2_1/service.rb', line 4307

def update_pubsubnotificationsetting(merchant_id, pubsub_notification_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, '{merchantId}/pubsubnotificationsettings', options)
  command.request_representation = Google::Apis::ContentV2_1::PubsubNotificationSettings::Representation
  command.request_object = pubsub_notification_settings_object
  command.response_representation = Google::Apis::ContentV2_1::PubsubNotificationSettings::Representation
  command.response_class = Google::Apis::ContentV2_1::PubsubNotificationSettings
  command.params['merchantId'] = merchant_id unless merchant_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

#update_shippingsetting(merchant_id, account_id, shipping_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::ShippingSettings

Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.

  • account_id (Fixnum)

    The ID of the account for which to get/update shipping settings.

  • shipping_settings_object (Google::Apis::ContentV2_1::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



5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
# File 'lib/google/apis/content_v2_1/service.rb', line 5682

def update_shippingsetting(merchant_id, , shipping_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, '{merchantId}/shippingsettings/{accountId}', options)
  command.request_representation = Google::Apis::ContentV2_1::ShippingSettings::Representation
  command.request_object = shipping_settings_object
  command.response_representation = Google::Apis::ContentV2_1::ShippingSettings::Representation
  command.response_class = Google::Apis::ContentV2_1::ShippingSettings
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#updatelabels_account(merchant_id, account_id, accounts_update_labels_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::AccountsUpdateLabelsResponse

Updates labels that are assigned to the Merchant Center account by CSS user.

Parameters:

  • merchant_id (Fixnum)

    The ID of the managing account.

  • account_id (Fixnum)

    The ID of the account whose labels are updated.

  • accounts_update_labels_request_object (Google::Apis::ContentV2_1::AccountsUpdateLabelsRequest) (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



449
450
451
452
453
454
455
456
457
458
459
460
# File 'lib/google/apis/content_v2_1/service.rb', line 449

def (merchant_id, , accounts_update_labels_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/accounts/{accountId}/updatelabels', options)
  command.request_representation = Google::Apis::ContentV2_1::AccountsUpdateLabelsRequest::Representation
  command.request_object = accounts_update_labels_request_object
  command.response_representation = Google::Apis::ContentV2_1::AccountsUpdateLabelsResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::AccountsUpdateLabelsResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#updatelabels_css(css_group_id, css_domain_id, label_ids_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::Css

Updates labels that are assigned to a CSS domain by its CSS group.

Parameters:

  • css_group_id (Fixnum)

    Required. The CSS group ID of the updated CSS domain.

  • css_domain_id (Fixnum)

    Required. The ID of the updated CSS domain.

  • label_ids_object (Google::Apis::ContentV2_1::LabelIds) (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



1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
# File 'lib/google/apis/content_v2_1/service.rb', line 1527

def updatelabels_css(css_group_id, css_domain_id, label_ids_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{cssGroupId}/csses/{cssDomainId}/updatelabels', options)
  command.request_representation = Google::Apis::ContentV2_1::LabelIds::Representation
  command.request_object = label_ids_object
  command.response_representation = Google::Apis::ContentV2_1::Css::Representation
  command.response_class = Google::Apis::ContentV2_1::Css
  command.params['cssGroupId'] = css_group_id unless css_group_id.nil?
  command.params['cssDomainId'] = css_domain_id unless css_domain_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

#updatelineitemshippingdetails_order(merchant_id, order_id, orders_update_line_item_shipping_details_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersUpdateLineItemShippingDetailsResponse

Updates ship by and delivery by dates for a line item.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order.

  • orders_update_line_item_shipping_details_request_object (Google::Apis::ContentV2_1::OrdersUpdateLineItemShippingDetailsRequest) (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



3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
# File 'lib/google/apis/content_v2_1/service.rb', line 3499

def updatelineitemshippingdetails_order(merchant_id, order_id, orders_update_line_item_shipping_details_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/updateLineItemShippingDetails', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersUpdateLineItemShippingDetailsRequest::Representation
  command.request_object = orders_update_line_item_shipping_details_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersUpdateLineItemShippingDetailsResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersUpdateLineItemShippingDetailsResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#updatemerchantorderid_order(merchant_id, order_id, orders_update_merchant_order_id_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersUpdateMerchantOrderIdResponse

Updates the merchant order ID for a given order.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order.

  • orders_update_merchant_order_id_request_object (Google::Apis::ContentV2_1::OrdersUpdateMerchantOrderIdRequest) (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



3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
# File 'lib/google/apis/content_v2_1/service.rb', line 3536

def updatemerchantorderid_order(merchant_id, order_id, orders_update_merchant_order_id_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/updateMerchantOrderId', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersUpdateMerchantOrderIdRequest::Representation
  command.request_object = orders_update_merchant_order_id_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersUpdateMerchantOrderIdResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersUpdateMerchantOrderIdResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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

#updateshipment_order(merchant_id, order_id, orders_update_shipment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2_1::OrdersUpdateShipmentResponse

Updates a shipment's status, carrier, and/or tracking ID.

Parameters:

  • merchant_id (Fixnum)

    The ID of the account that manages the order. This cannot be a multi-client account.

  • order_id (String)

    The ID of the order.

  • orders_update_shipment_request_object (Google::Apis::ContentV2_1::OrdersUpdateShipmentRequest) (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



3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
# File 'lib/google/apis/content_v2_1/service.rb', line 3573

def updateshipment_order(merchant_id, order_id, orders_update_shipment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/updateShipment', options)
  command.request_representation = Google::Apis::ContentV2_1::OrdersUpdateShipmentRequest::Representation
  command.request_object = orders_update_shipment_request_object
  command.response_representation = Google::Apis::ContentV2_1::OrdersUpdateShipmentResponse::Representation
  command.response_class = Google::Apis::ContentV2_1::OrdersUpdateShipmentResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_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