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

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

Overview

Content API for Shopping

Manages product items, inventory, and Merchant Center 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

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initializeShoppingContentService

Returns a new instance of ShoppingContentService.


50
51
52
53
# File 'generated/google/apis/content_v2_1/service.rb', line 50

def initialize
  super('https://www.googleapis.com/', 'content/v2.1/')
  @batch_path = 'batch/content/v2.1'
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.


39
40
41
# File 'generated/google/apis/content_v2_1/service.rb', line 39

def key
  @key
end

#quota_userString

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.


44
45
46
# File 'generated/google/apis/content_v2_1/service.rb', line 44

def quota_user
  @quota_user
end

#user_ipString

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String)

    Deprecated. Please use quotaUser instead.


48
49
50
# File 'generated/google/apis/content_v2_1/service.rb', line 48

def user_ip
  @user_ip
end

Instance Method Details

#acknowledge_order(merchant_id, order_id, orders_acknowledge_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
# File 'generated/google/apis/content_v2_1/service.rb', line 1795

def acknowledge_order(merchant_id, order_id, orders_acknowledge_request_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#advancetestorder_order(merchant_id, order_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
# File 'generated/google/apis/content_v2_1/service.rb', line 1835

def advancetestorder_order(merchant_id, order_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#authinfo_account(fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

#cancel_order(merchant_id, order_id, orders_cancel_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def cancel_order(merchant_id, order_id, orders_cancel_request_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def cancellineitem_order(merchant_id, order_id, orders_cancel_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
# File 'generated/google/apis/content_v2_1/service.rb', line 1953

def canceltestorderbycustomer_order(merchant_id, order_id, orders_cancel_test_order_by_customer_request_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#claimwebsite_account(merchant_id, account_id, overwrite: nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (merchant_id, , overwrite: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'generated/google/apis/content_v2_1/service.rb', line 1524

def createchargeinvoice_orderinvoice(merchant_id, order_id, orderinvoices_create_charge_invoice_request_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
# File 'generated/google/apis/content_v2_1/service.rb', line 1567

def createrefundinvoice_orderinvoice(merchant_id, order_id, orderinvoices_create_refund_invoice_request_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#createtestorder_order(merchant_id, orders_create_test_order_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
# File 'generated/google/apis/content_v2_1/service.rb', line 1991

def createtestorder_order(merchant_id, orders_create_test_order_request_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
# File 'generated/google/apis/content_v2_1/service.rb', line 2030

def createtestreturn_order(merchant_id, order_id, orders_create_test_return_request_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#custombatch_account(accounts_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


150
151
152
153
154
155
156
157
158
159
160
# File 'generated/google/apis/content_v2_1/service.rb', line 150

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

#custombatch_accountstatus(accountstatuses_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

#custombatch_accounttax(accounttax_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


581
582
583
584
585
586
587
588
589
590
591
# File 'generated/google/apis/content_v2_1/service.rb', line 581

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

#custombatch_datafeed(datafeeds_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

#custombatch_datafeedstatus(datafeedstatuses_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


992
993
994
995
996
997
998
999
1000
1001
1002
# File 'generated/google/apis/content_v2_1/service.rb', line 992

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

#custombatch_liasetting(liasettings_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
# File 'generated/google/apis/content_v2_1/service.rb', line 1115

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

#custombatch_po(pos_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
# File 'generated/google/apis/content_v2_1/service.rb', line 2580

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

#custombatch_product(products_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
# File 'generated/google/apis/content_v2_1/service.rb', line 2842

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

#custombatch_productstatus(productstatuses_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
# File 'generated/google/apis/content_v2_1/service.rb', line 3032

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

#custombatch_regionalinventory(regionalinventory_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
# File 'generated/google/apis/content_v2_1/service.rb', line 3152

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

#custombatch_returnaddress(returnaddress_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
# File 'generated/google/apis/content_v2_1/service.rb', line 3227

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

#custombatch_returnpolicy(returnpolicy_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
# File 'generated/google/apis/content_v2_1/service.rb', line 3409

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

#custombatch_shippingsetting(shippingsettings_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
# File 'generated/google/apis/content_v2_1/service.rb', line 3582

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

#delete_account(merchant_id, account_id, force: nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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


189
190
191
192
193
194
195
196
197
198
# File 'generated/google/apis/content_v2_1/service.rb', line 189

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

#delete_datafeed(merchant_id, datafeed_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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


770
771
772
773
774
775
776
777
778
# File 'generated/google/apis/content_v2_1/service.rb', line 770

def delete_datafeed(merchant_id, datafeed_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_po(merchant_id, target_merchant_id, store_code, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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


2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'generated/google/apis/content_v2_1/service.rb', line 2618

def delete_po(merchant_id, target_merchant_id, store_code, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_product(merchant_id, product_id, feed_id: nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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


2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
# File 'generated/google/apis/content_v2_1/service.rb', line 2881

def delete_product(merchant_id, product_id, feed_id: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_returnaddress(merchant_id, return_address_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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


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

def delete_returnaddress(merchant_id, return_address_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_returnpolicy(merchant_id, return_policy_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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


3445
3446
3447
3448
3449
3450
3451
3452
3453
# File 'generated/google/apis/content_v2_1/service.rb', line 3445

def delete_returnpolicy(merchant_id, return_policy_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Invokes a fetch for the datafeed in 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 to be fetched.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


805
806
807
808
809
810
811
812
813
814
815
# File 'generated/google/apis/content_v2_1/service.rb', line 805

def fetchnow_datafeed(merchant_id, datafeed_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_account(merchant_id, account_id, fields: nil, quota_user: nil, user_ip: 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


226
227
228
229
230
231
232
233
234
235
236
# File 'generated/google/apis/content_v2_1/service.rb', line 226

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

#get_accountstatus(merchant_id, account_id, destinations: nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


503
504
505
506
507
508
509
510
511
512
513
514
# File 'generated/google/apis/content_v2_1/service.rb', line 503

def get_accountstatus(merchant_id, , destinations: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_accounttax(merchant_id, account_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

#get_datafeed(merchant_id, datafeed_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


842
843
844
845
846
847
848
849
850
851
852
# File 'generated/google/apis/content_v2_1/service.rb', line 842

def get_datafeed(merchant_id, datafeed_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_datafeedstatus(merchant_id, datafeed_id, country: nil, language: nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
# File 'generated/google/apis/content_v2_1/service.rb', line 1039

def get_datafeedstatus(merchant_id, datafeed_id, country: nil, language: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_liasetting(merchant_id, account_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

#get_order(merchant_id, order_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
# File 'generated/google/apis/content_v2_1/service.rb', line 2069

def get_order(merchant_id, order_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_orderreturn(merchant_id, return_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
# File 'generated/google/apis/content_v2_1/service.rb', line 1704

def get_orderreturn(merchant_id, return_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_po(merchant_id, target_merchant_id, store_code, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
# File 'generated/google/apis/content_v2_1/service.rb', line 2655

def get_po(merchant_id, target_merchant_id, store_code, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_product(merchant_id, product_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
# File 'generated/google/apis/content_v2_1/service.rb', line 2917

def get_product(merchant_id, product_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_productstatus(merchant_id, product_id, destinations: nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
# File 'generated/google/apis/content_v2_1/service.rb', line 3072

def get_productstatus(merchant_id, product_id, destinations: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_returnaddress(merchant_id, return_address_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def get_returnaddress(merchant_id, return_address_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_returnpolicy(merchant_id, return_policy_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
# File 'generated/google/apis/content_v2_1/service.rb', line 3479

def get_returnpolicy(merchant_id, return_policy_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_shippingsetting(merchant_id, account_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
# File 'generated/google/apis/content_v2_1/service.rb', line 3620

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

#getaccessiblegmbaccounts_liasetting(merchant_id, account_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

#getbymerchantorderid_order(merchant_id, merchant_order_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
# File 'generated/google/apis/content_v2_1/service.rb', line 2106

def getbymerchantorderid_order(merchant_id, merchant_order_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#getsupportedcarriers_shippingsetting(merchant_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
# File 'generated/google/apis/content_v2_1/service.rb', line 3654

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

#getsupportedholidays_shippingsetting(merchant_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
# File 'generated/google/apis/content_v2_1/service.rb', line 3687

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

#getsupportedpickupservices_shippingsetting(merchant_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
# File 'generated/google/apis/content_v2_1/service.rb', line 3720

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

#gettestordertemplate_order(merchant_id, template_name, country: nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def gettestordertemplate_order(merchant_id, template_name, country: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_account(merchant_id, account_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


261
262
263
264
265
266
267
268
269
270
271
272
# File 'generated/google/apis/content_v2_1/service.rb', line 261

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

#insert_datafeed(merchant_id, datafeed_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


878
879
880
881
882
883
884
885
886
887
888
889
# File 'generated/google/apis/content_v2_1/service.rb', line 878

def insert_datafeed(merchant_id, datafeed_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_po(merchant_id, target_merchant_id, pos_store_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
# File 'generated/google/apis/content_v2_1/service.rb', line 2693

def insert_po(merchant_id, target_merchant_id, pos_store_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_product(merchant_id, product_object = nil, feed_id: nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
# File 'generated/google/apis/content_v2_1/service.rb', line 2957

def insert_product(merchant_id, product_object = nil, feed_id: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_regionalinventory(merchant_id, product_id, regional_inventory_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
# File 'generated/google/apis/content_v2_1/service.rb', line 3192

def insert_regionalinventory(merchant_id, product_id, regional_inventory_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_returnaddress(merchant_id, return_address_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
# File 'generated/google/apis/content_v2_1/service.rb', line 3332

def insert_returnaddress(merchant_id, return_address_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_returnpolicy(merchant_id, return_policy_object = nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
# File 'generated/google/apis/content_v2_1/service.rb', line 3514

def insert_returnpolicy(merchant_id, return_policy_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
# File 'generated/google/apis/content_v2_1/service.rb', line 2193

def instorerefundlineitem_order(merchant_id, order_id, orders_in_store_refund_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
# File 'generated/google/apis/content_v2_1/service.rb', line 2732

def inventory_po(merchant_id, target_merchant_id, pos_inventory_request_object = nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'generated/google/apis/content_v2_1/service.rb', line 302

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

#list_accounts(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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.

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


342
343
344
345
346
347
348
349
350
351
352
353
# File 'generated/google/apis/content_v2_1/service.rb', line 342

def list_accounts(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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['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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


546
547
548
549
550
551
552
553
554
555
556
557
558
# File 'generated/google/apis/content_v2_1/service.rb', line 546

def list_accountstatuses(merchant_id, destinations: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_accounttaxes(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def list_accounttaxes(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_datafeeds(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


918
919
920
921
922
923
924
925
926
927
928
929
# File 'generated/google/apis/content_v2_1/service.rb', line 918

def list_datafeeds(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_datafeedstatuses(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
# File 'generated/google/apis/content_v2_1/service.rb', line 1080

def list_datafeedstatuses(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_liasettings(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
# File 'generated/google/apis/content_v2_1/service.rb', line 1230

def list_liasettings(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_orderreturns(merchant_id, created_end_date: nil, created_start_date: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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.

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

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
# File 'generated/google/apis/content_v2_1/service.rb', line 1753

def list_orderreturns(merchant_id, created_end_date: nil, created_start_date: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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['createdEndDate'] = created_end_date unless created_end_date.nil?
  command.query['createdStartDate'] = created_start_date unless created_start_date.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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
# File 'generated/google/apis/content_v2_1/service.rb', line 2256

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, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_pos(merchant_id, target_merchant_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'generated/google/apis/content_v2_1/service.rb', line 2770

def list_pos(merchant_id, target_merchant_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

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

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'generated/google/apis/content_v2_1/service.rb', line 2998

def list_products(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def list_productstatuses(merchant_id, destinations: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def list_returnaddresses(merchant_id, country: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_returnpolicies(merchant_id, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
# File 'generated/google/apis/content_v2_1/service.rb', line 3549

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

#list_shippingsettings(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
# File 'generated/google/apis/content_v2_1/service.rb', line 3759

def list_shippingsettings(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#listdisbursements_orderreport(merchant_id, disbursement_start_date, disbursement_end_date: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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_start_date (String)

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

  • disbursement_end_date (String) (defaults to: nil)

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

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'generated/google/apis/content_v2_1/service.rb', line 1613

def listdisbursements_orderreport(merchant_id, disbursement_start_date, disbursement_end_date: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.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.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (merchant_id, , max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: 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?
  command.query[