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



2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
# File 'lib/google/apis/content_v2_1/service.rb', line 2794

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



2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
# File 'lib/google/apis/content_v2_1/service.rb', line 2523

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



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
# File 'lib/google/apis/content_v2_1/service.rb', line 1044

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



2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
# File 'lib/google/apis/content_v2_1/service.rb', line 2831

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



2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
# File 'lib/google/apis/content_v2_1/service.rb', line 2866

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



2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
# File 'lib/google/apis/content_v2_1/service.rb', line 2903

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



2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
# File 'lib/google/apis/content_v2_1/service.rb', line 2940

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



480
481
482
483
484
485
486
487
488
489
490
# File 'lib/google/apis/content_v2_1/service.rb', line 480

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



513
514
515
516
517
518
519
520
521
522
523
# File 'lib/google/apis/content_v2_1/service.rb', line 513

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



655
656
657
658
659
660
661
662
663
664
665
# File 'lib/google/apis/content_v2_1/service.rb', line 655

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



1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
# File 'lib/google/apis/content_v2_1/service.rb', line 1227

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



2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
# File 'lib/google/apis/content_v2_1/service.rb', line 2757

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



3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
# File 'lib/google/apis/content_v2_1/service.rb', line 3599

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



4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
# File 'lib/google/apis/content_v2_1/service.rb', line 4402

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



4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
# File 'lib/google/apis/content_v2_1/service.rb', line 4616

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



5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
# File 'lib/google/apis/content_v2_1/service.rb', line 5181

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



2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
# File 'lib/google/apis/content_v2_1/service.rb', line 2354

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



2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
# File 'lib/google/apis/content_v2_1/service.rb', line 2558

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



2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
# File 'lib/google/apis/content_v2_1/service.rb', line 2394

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



2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
# File 'lib/google/apis/content_v2_1/service.rb', line 2975

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



3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# File 'lib/google/apis/content_v2_1/service.rb', line 3011

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



786
787
788
789
790
791
792
793
794
795
# File 'lib/google/apis/content_v2_1/service.rb', line 786

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



897
898
899
900
901
902
903
904
905
906
# File 'lib/google/apis/content_v2_1/service.rb', line 897

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



1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
# File 'lib/google/apis/content_v2_1/service.rb', line 1552

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



1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
# File 'lib/google/apis/content_v2_1/service.rb', line 1793

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



1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
# File 'lib/google/apis/content_v2_1/service.rb', line 1907

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



2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
# File 'lib/google/apis/content_v2_1/service.rb', line 2281

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



3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
# File 'lib/google/apis/content_v2_1/service.rb', line 3630

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



3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
# File 'lib/google/apis/content_v2_1/service.rb', line 3871

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



4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
# File 'lib/google/apis/content_v2_1/service.rb', line 4093

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



4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
# File 'lib/google/apis/content_v2_1/service.rb', line 4329

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



4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'lib/google/apis/content_v2_1/service.rb', line 4854

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



5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
# File 'lib/google/apis/content_v2_1/service.rb', line 5021

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



5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
# File 'lib/google/apis/content_v2_1/service.rb', line 5471

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



547
548
549
550
551
552
553
554
# File 'lib/google/apis/content_v2_1/service.rb', line 547

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



690
691
692
693
694
695
696
697
# File 'lib/google/apis/content_v2_1/service.rb', line 690

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



1263
1264
1265
1266
1267
1268
1269
1270
# File 'lib/google/apis/content_v2_1/service.rb', line 1263

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



1586
1587
1588
1589
1590
1591
1592
1593
# File 'lib/google/apis/content_v2_1/service.rb', line 1586

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



3665
3666
3667
3668
3669
3670
3671
3672
3673
# File 'lib/google/apis/content_v2_1/service.rb', line 3665

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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should 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



3907
3908
3909
3910
3911
3912
3913
3914
3915
# File 'lib/google/apis/content_v2_1/service.rb', line 3907

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



4437
4438
4439
4440
4441
4442
4443
4444
# File 'lib/google/apis/content_v2_1/service.rb', line 4437

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



4651
4652
4653
4654
4655
4656
4657
4658
# File 'lib/google/apis/content_v2_1/service.rb', line 4651

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



4887
4888
4889
4890
4891
4892
4893
4894
# File 'lib/google/apis/content_v2_1/service.rb', line 4887

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



5054
5055
5056
5057
5058
5059
5060
5061
# File 'lib/google/apis/content_v2_1/service.rb', line 5054

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



5216
5217
5218
5219
5220
5221
5222
5223
# File 'lib/google/apis/content_v2_1/service.rb', line 5216

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



1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
# File 'lib/google/apis/content_v2_1/service.rb', line 1620

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



825
826
827
828
829
830
831
832
833
834
835
# File 'lib/google/apis/content_v2_1/service.rb', line 825

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



932
933
934
935
936
937
938
939
940
941
# File 'lib/google/apis/content_v2_1/service.rb', line 932

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



1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
# File 'lib/google/apis/content_v2_1/service.rb', line 1078

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



1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'lib/google/apis/content_v2_1/service.rb', line 1295

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



1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'lib/google/apis/content_v2_1/service.rb', line 1371

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



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

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



1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
# File 'lib/google/apis/content_v2_1/service.rb', line 1654

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



1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
# File 'lib/google/apis/content_v2_1/service.rb', line 1837

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



1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
# File 'lib/google/apis/content_v2_1/service.rb', line 1942

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



3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
# File 'lib/google/apis/content_v2_1/service.rb', line 3047

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



2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
# File 'lib/google/apis/content_v2_1/service.rb', line 2593

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



3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
# File 'lib/google/apis/content_v2_1/service.rb', line 3699

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



3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/google/apis/content_v2_1/service.rb', line 3940

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



4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'lib/google/apis/content_v2_1/service.rb', line 4130

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



4265
4266
4267
4268
4269
4270
4271
4272
4273
# File 'lib/google/apis/content_v2_1/service.rb', line 4265

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



4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
# File 'lib/google/apis/content_v2_1/service.rb', line 4468

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



4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
# File 'lib/google/apis/content_v2_1/service.rb', line 4682

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



4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
# File 'lib/google/apis/content_v2_1/service.rb', line 4918

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



5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
# File 'lib/google/apis/content_v2_1/service.rb', line 5085

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



5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
# File 'lib/google/apis/content_v2_1/service.rb', line 5248

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



5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
# File 'lib/google/apis/content_v2_1/service.rb', line 5349

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



5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
# File 'lib/google/apis/content_v2_1/service.rb', line 5506

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



1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
# File 'lib/google/apis/content_v2_1/service.rb', line 1978

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



3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
# File 'lib/google/apis/content_v2_1/service.rb', line 3081

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



5537
5538
5539
5540
5541
5542
5543
5544
5545
# File 'lib/google/apis/content_v2_1/service.rb', line 5537

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



5567
5568
5569
5570
5571
5572
5573
5574
5575
# File 'lib/google/apis/content_v2_1/service.rb', line 5567

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



5597
5598
5599
5600
5601
5602
5603
5604
5605
# File 'lib/google/apis/content_v2_1/service.rb', line 5597

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



3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
# File 'lib/google/apis/content_v2_1/service.rb', line 3118

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



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

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



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

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



3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
# File 'lib/google/apis/content_v2_1/service.rb', line 3734

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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
# File 'lib/google/apis/content_v2_1/service.rb', line 3977

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



4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
# File 'lib/google/apis/content_v2_1/service.rb', line 4366

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



4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
# File 'lib/google/apis/content_v2_1/service.rb', line 4950

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



5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
# File 'lib/google/apis/content_v2_1/service.rb', line 5117

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



3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'lib/google/apis/content_v2_1/service.rb', line 3161

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



3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
# File 'lib/google/apis/content_v2_1/service.rb', line 3770

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



585
586
587
588
589
590
591
592
593
594
595
# File 'lib/google/apis/content_v2_1/service.rb', line 585

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



720
721
722
723
724
725
726
727
728
# File 'lib/google/apis/content_v2_1/service.rb', line 720

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

  • 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



326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'lib/google/apis/content_v2_1/service.rb', line 326

def list_accounts(merchant_id, label: nil, max_results: 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['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, 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.

  • 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



865
866
867
868
869
870
871
872
873
874
875
876
# File 'lib/google/apis/content_v2_1/service.rb', line 865

def list_accountstatuses(merchant_id, destinations: nil, max_results: 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['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



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

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



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
# File 'lib/google/apis/content_v2_1/service.rb', line 1335

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



1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
# File 'lib/google/apis/content_v2_1/service.rb', line 1409

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



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

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



1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
# File 'lib/google/apis/content_v2_1/service.rb', line 1724

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



1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'lib/google/apis/content_v2_1/service.rb', line 1875

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



2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
# File 'lib/google/apis/content_v2_1/service.rb', line 2013

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



2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
# File 'lib/google/apis/content_v2_1/service.rb', line 2672

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



3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
# File 'lib/google/apis/content_v2_1/service.rb', line 3219

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



3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'lib/google/apis/content_v2_1/service.rb', line 3805

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



4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
# File 'lib/google/apis/content_v2_1/service.rb', line 4017

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



4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
# File 'lib/google/apis/content_v2_1/service.rb', line 4229

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



4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
# File 'lib/google/apis/content_v2_1/service.rb', line 4171

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



4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
# File 'lib/google/apis/content_v2_1/service.rb', line 4507

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



4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
# File 'lib/google/apis/content_v2_1/service.rb', line 4820

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



4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
# File 'lib/google/apis/content_v2_1/service.rb', line 4728

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



4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
# File 'lib/google/apis/content_v2_1/service.rb', line 4989

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



5149
5150
5151
5152
5153
5154
5155
5156
5157
# File 'lib/google/apis/content_v2_1/service.rb', line 5149

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



5280
5281
5282
5283
5284
5285
5286
5287
5288
# File 'lib/google/apis/content_v2_1/service.rb', line 5280

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



5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
# File 'lib/google/apis/content_v2_1/service.rb', line 5392

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



5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
# File 'lib/google/apis/content_v2_1/service.rb', line 5437

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



5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
# File 'lib/google/apis/content_v2_1/service.rb', line 5633

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



2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
# File 'lib/google/apis/content_v2_1/service.rb', line 2437

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



370
371
372
373
374
375
376
377
378
379
380
381
# File 'lib/google/apis/content_v2_1/service.rb', line 370

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



2044
2045
2046
2047
2048
2049
2050
2051
# File 'lib/google/apis/content_v2_1/service.rb', line 2044

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



2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'lib/google/apis/content_v2_1/service.rb', line 2484

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



1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
# File 'lib/google/apis/content_v2_1/service.rb', line 1118

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



620
621
622
623
624
625
626
627
628
629
630
631
# File 'lib/google/apis/content_v2_1/service.rb', line 620

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



754
755
756
757
758
759
760
761
762
763
764
765
# File 'lib/google/apis/content_v2_1/service.rb', line 754

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 field mask indicating the fields to update.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
# File 'lib/google/apis/content_v2_1/service.rb', line 4544

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



4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
# File 'lib/google/apis/content_v2_1/service.rb', line 4769

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



5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
# File 'lib/google/apis/content_v2_1/service.rb', line 5314

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



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
# File 'lib/google/apis/content_v2_1/service.rb', line 1154

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



2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
# File 'lib/google/apis/content_v2_1/service.rb', line 2717

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



3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
# File 'lib/google/apis/content_v2_1/service.rb', line 3260

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



3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
# File 'lib/google/apis/content_v2_1/service.rb', line 3297

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



3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
# File 'lib/google/apis/content_v2_1/service.rb', line 3334

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



2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
# File 'lib/google/apis/content_v2_1/service.rb', line 2079

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



2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
# File 'lib/google/apis/content_v2_1/service.rb', line 2118

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



1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
# File 'lib/google/apis/content_v2_1/service.rb', line 1191

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



3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
# File 'lib/google/apis/content_v2_1/service.rb', line 3376

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



3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
# File 'lib/google/apis/content_v2_1/service.rb', line 3839

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



4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
# File 'lib/google/apis/content_v2_1/service.rb', line 4581

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



2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
# File 'lib/google/apis/content_v2_1/service.rb', line 2163

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



3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
# File 'lib/google/apis/content_v2_1/service.rb', line 3417

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



2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
# File 'lib/google/apis/content_v2_1/service.rb', line 2209

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



3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
# File 'lib/google/apis/content_v2_1/service.rb', line 3454

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



409
410
411
412
413
414
415
416
417
418
419
420
# File 'lib/google/apis/content_v2_1/service.rb', line 409

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



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
# File 'lib/google/apis/content_v2_1/service.rb', line 1005

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



1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
# File 'lib/google/apis/content_v2_1/service.rb', line 1761

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



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

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 list of product attributes to be updated. 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



4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
# File 'lib/google/apis/content_v2_1/service.rb', line 4060

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



4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
# File 'lib/google/apis/content_v2_1/service.rb', line 4297

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



5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
# File 'lib/google/apis/content_v2_1/service.rb', line 5671

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



445
446
447
448
449
450
451
452
453
454
455
456
# File 'lib/google/apis/content_v2_1/service.rb', line 445

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



1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
# File 'lib/google/apis/content_v2_1/service.rb', line 1519

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



3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
# File 'lib/google/apis/content_v2_1/service.rb', line 3491

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



3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
# File 'lib/google/apis/content_v2_1/service.rb', line 3528

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



3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
# File 'lib/google/apis/content_v2_1/service.rb', line 3565

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