Class: Google::Apis::ContentV2::ShoppingContentService

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

Overview

Content API for Shopping

Manages product items, inventory, and Merchant Center accounts for Google Shopping.

Examples:

require 'google/apis/content_v2'

Content = Google::Apis::ContentV2 # 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/service.rb', line 50

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


1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'generated/google/apis/content_v2/service.rb', line 1889

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::OrdersAcknowledgeRequest::Representation
  command.request_object = orders_acknowledge_request_object
  command.response_representation = Google::Apis::ContentV2::OrdersAcknowledgeResponse::Representation
  command.response_class = Google::Apis::ContentV2::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

#advance_test_order(merchant_id, order_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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:


1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
# File 'generated/google/apis/content_v2/service.rb', line 1929

def advance_test_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::OrdersAdvanceTestOrderResponse::Representation
  command.response_class = Google::Apis::ContentV2::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

#batch_account(batch_accounts_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::BatchAccountsResponse

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

Parameters:

  • batch_accounts_request_object (Google::Apis::ContentV2::BatchAccountsRequest) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


153
154
155
156
157
158
159
160
161
162
163
164
# File 'generated/google/apis/content_v2/service.rb', line 153

def (batch_accounts_request_object = nil, dry_run: 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::BatchAccountsRequest::Representation
  command.request_object = batch_accounts_request_object
  command.response_representation = Google::Apis::ContentV2::BatchAccountsResponse::Representation
  command.response_class = Google::Apis::ContentV2::BatchAccountsResponse
  command.query['dryRun'] = dry_run unless dry_run.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

#batch_account_status(batch_account_statuses_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::BatchAccountStatusesResponse

Retrieves multiple Merchant Center account statuses in a single request.

Parameters:

  • batch_account_statuses_request_object (Google::Apis::ContentV2::BatchAccountStatusesRequest) (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:


433
434
435
436
437
438
439
440
441
442
443
# File 'generated/google/apis/content_v2/service.rb', line 433

def ( = 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::BatchAccountStatusesRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::ContentV2::BatchAccountStatusesResponse::Representation
  command.response_class = Google::Apis::ContentV2::BatchAccountStatusesResponse
  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

#batch_account_tax(batch_account_tax_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::BatchAccountTaxResponse

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

Parameters:

  • batch_account_tax_request_object (Google::Apis::ContentV2::BatchAccountTaxRequest) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


556
557
558
559
560
561
562
563
564
565
566
567
# File 'generated/google/apis/content_v2/service.rb', line 556

def ( = nil, dry_run: 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::BatchAccountTaxRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::ContentV2::BatchAccountTaxResponse::Representation
  command.response_class = Google::Apis::ContentV2::BatchAccountTaxResponse
  command.query['dryRun'] = dry_run unless dry_run.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

#batch_datafeed(batch_datafeeds_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::BatchDatafeedsResponse

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

Parameters:

  • batch_datafeeds_request_object (Google::Apis::ContentV2::BatchDatafeedsRequest) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


716
717
718
719
720
721
722
723
724
725
726
727
# File 'generated/google/apis/content_v2/service.rb', line 716

def batch_datafeed(batch_datafeeds_request_object = nil, dry_run: 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::BatchDatafeedsRequest::Representation
  command.request_object = batch_datafeeds_request_object
  command.response_representation = Google::Apis::ContentV2::BatchDatafeedsResponse::Representation
  command.response_class = Google::Apis::ContentV2::BatchDatafeedsResponse
  command.query['dryRun'] = dry_run unless dry_run.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

#batch_datafeed_status(batch_datafeed_statuses_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::BatchDatafeedStatusesResponse

Gets multiple Merchant Center datafeed statuses in a single request.

Parameters:

  • batch_datafeed_statuses_request_object (Google::Apis::ContentV2::BatchDatafeedStatusesRequest) (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/service.rb', line 992

def batch_datafeed_status(batch_datafeed_statuses_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::BatchDatafeedStatusesRequest::Representation
  command.request_object = batch_datafeed_statuses_request_object
  command.response_representation = Google::Apis::ContentV2::BatchDatafeedStatusesResponse::Representation
  command.response_class = Google::Apis::ContentV2::BatchDatafeedStatusesResponse
  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

#batch_inventory(batch_inventory_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::BatchInventoryResponse

Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products.

Parameters:

  • batch_inventory_request_object (Google::Apis::ContentV2::BatchInventoryRequest) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
# File 'generated/google/apis/content_v2/service.rb', line 1118

def batch_inventory(batch_inventory_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'inventory/batch', options)
  command.request_representation = Google::Apis::ContentV2::BatchInventoryRequest::Representation
  command.request_object = batch_inventory_request_object
  command.response_representation = Google::Apis::ContentV2::BatchInventoryResponse::Representation
  command.response_class = Google::Apis::ContentV2::BatchInventoryResponse
  command.query['dryRun'] = dry_run unless dry_run.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

#batch_product(batch_products_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::BatchProductsResponse

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

Parameters:

  • batch_products_request_object (Google::Apis::ContentV2::BatchProductsRequest) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

  • 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/service.rb', line 3072

def batch_product(batch_products_request_object = nil, dry_run: 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::BatchProductsRequest::Representation
  command.request_object = batch_products_request_object
  command.response_representation = Google::Apis::ContentV2::BatchProductsResponse::Representation
  command.response_class = Google::Apis::ContentV2::BatchProductsResponse
  command.query['dryRun'] = dry_run unless dry_run.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

#batch_product_status(batch_product_statuses_request_object = nil, include_attributes: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::BatchProductStatusesResponse

Gets the statuses of multiple products in a single request.

Parameters:

  • batch_product_statuses_request_object (Google::Apis::ContentV2::BatchProductStatusesRequest) (defaults to: nil)
  • include_attributes (Boolean) (defaults to: nil)

    Flag to include full product data in the results of this request. 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:

Returns:

Raises:


3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
# File 'generated/google/apis/content_v2/service.rb', line 3272

def batch_product_status(batch_product_statuses_request_object = nil, include_attributes: 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::BatchProductStatusesRequest::Representation
  command.request_object = batch_product_statuses_request_object
  command.response_representation = Google::Apis::ContentV2::BatchProductStatusesResponse::Representation
  command.response_class = Google::Apis::ContentV2::BatchProductStatusesResponse
  command.query['includeAttributes'] = include_attributes unless include_attributes.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

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


1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
# File 'generated/google/apis/content_v2/service.rb', line 1967

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::OrdersCancelRequest::Representation
  command.request_object = orders_cancel_request_object
  command.response_representation = Google::Apis::ContentV2::OrdersCancelResponse::Representation
  command.response_class = Google::Apis::ContentV2::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

#cancel_order_line_item(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::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::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:


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
# File 'generated/google/apis/content_v2/service.rb', line 2007

def cancel_order_line_item(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::OrdersCancelLineItemRequest::Representation
  command.request_object = orders_cancel_line_item_request_object
  command.response_representation = Google::Apis::ContentV2::OrdersCancelLineItemResponse::Representation
  command.response_class = Google::Apis::ContentV2::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::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::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:


2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
# File 'generated/google/apis/content_v2/service.rb', line 2047

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::OrdersCancelTestOrderByCustomerRequest::Representation
  command.request_object = orders_cancel_test_order_by_customer_request_object
  command.response_representation = Google::Apis::ContentV2::OrdersCancelTestOrderByCustomerResponse::Representation
  command.response_class = Google::Apis::ContentV2::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::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/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::AccountsClaimWebsiteResponse::Representation
  command.response_class = Google::Apis::ContentV2::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

#create_test_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::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::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:


2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
# File 'generated/google/apis/content_v2/service.rb', line 2085

def create_test_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::OrdersCreateTestOrderRequest::Representation
  command.request_object = orders_create_test_order_request_object
  command.response_representation = Google::Apis::ContentV2::OrdersCreateTestOrderResponse::Representation
  command.response_class = Google::Apis::ContentV2::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

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


1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
# File 'generated/google/apis/content_v2/service.rb', line 1618

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::OrderinvoicesCreateChargeInvoiceRequest::Representation
  command.request_object = orderinvoices_create_charge_invoice_request_object
  command.response_representation = Google::Apis::ContentV2::OrderinvoicesCreateChargeInvoiceResponse::Representation
  command.response_class = Google::Apis::ContentV2::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::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::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:


1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
# File 'generated/google/apis/content_v2/service.rb', line 1661

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::OrderinvoicesCreateRefundInvoiceRequest::Representation
  command.request_object = orderinvoices_create_refund_invoice_request_object
  command.response_representation = Google::Apis::ContentV2::OrderinvoicesCreateRefundInvoiceResponse::Representation
  command.response_class = Google::Apis::ContentV2::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

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


2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
# File 'generated/google/apis/content_v2/service.rb', line 2124

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::OrdersCreateTestReturnRequest::Representation
  command.request_object = orders_create_test_return_request_object
  command.response_representation = Google::Apis::ContentV2::OrdersCreateTestReturnResponse::Representation
  command.response_class = Google::Apis::ContentV2::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

#custom_order_batch(orders_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::OrdersCustomBatchResponse

Retrieves or modifies multiple orders in a single request.

Parameters:

  • orders_custom_batch_request_object (Google::Apis::ContentV2::OrdersCustomBatchRequest) (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:


2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
# File 'generated/google/apis/content_v2/service.rb', line 2159

def custom_order_batch(orders_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'orders/batch', options)
  command.request_representation = Google::Apis::ContentV2::OrdersCustomBatchRequest::Representation
  command.request_object = orders_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2::OrdersCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2::OrdersCustomBatchResponse
  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, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::LiasettingsCustomBatchResponse

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

Parameters:

  • liasettings_custom_batch_request_object (Google::Apis::ContentV2::LiasettingsCustomBatchRequest) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
# File 'generated/google/apis/content_v2/service.rb', line 1204

def custombatch_liasetting(liasettings_custom_batch_request_object = nil, dry_run: 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::LiasettingsCustomBatchRequest::Representation
  command.request_object = liasettings_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2::LiasettingsCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2::LiasettingsCustomBatchResponse
  command.query['dryRun'] = dry_run unless dry_run.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_po(pos_custom_batch_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::PosCustomBatchResponse

Batches multiple POS-related calls in a single request.

Parameters:

  • pos_custom_batch_request_object (Google::Apis::ContentV2::PosCustomBatchRequest) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'generated/google/apis/content_v2/service.rb', line 2790

def custombatch_po(pos_custom_batch_request_object = nil, dry_run: 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::PosCustomBatchRequest::Representation
  command.request_object = pos_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2::PosCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2::PosCustomBatchResponse
  command.query['dryRun'] = dry_run unless dry_run.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_shippingsetting(shippingsettings_custom_batch_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::ShippingsettingsCustomBatchResponse

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

Parameters:

  • shippingsettings_custom_batch_request_object (Google::Apis::ContentV2::ShippingsettingsCustomBatchRequest) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


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

def custombatch_shippingsetting(shippingsettings_custom_batch_request_object = nil, dry_run: 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::ShippingsettingsCustomBatchRequest::Representation
  command.request_object = shippingsettings_custom_batch_request_object
  command.response_representation = Google::Apis::ContentV2::ShippingsettingsCustomBatchResponse::Representation
  command.response_class = Google::Apis::ContentV2::ShippingsettingsCustomBatchResponse
  command.query['dryRun'] = dry_run unless dry_run.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_account(merchant_id, account_id, dry_run: nil, 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.

  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


196
197
198
199
200
201
202
203
204
205
206
# File 'generated/google/apis/content_v2/service.rb', line 196

def (merchant_id, , dry_run: nil, 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['dryRun'] = dry_run unless dry_run.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, dry_run: nil, 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.

  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


757
758
759
760
761
762
763
764
765
766
# File 'generated/google/apis/content_v2/service.rb', line 757

def delete_datafeed(merchant_id, datafeed_id, dry_run: nil, 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['dryRun'] = dry_run unless dry_run.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, dry_run: nil, 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.

  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'generated/google/apis/content_v2/service.rb', line 2832

def delete_po(merchant_id, target_merchant_id, store_code, dry_run: nil, 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['dryRun'] = dry_run unless dry_run.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, dry_run: 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.

  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
# File 'generated/google/apis/content_v2/service.rb', line 3113

def delete_product(merchant_id, product_id, dry_run: 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['dryRun'] = dry_run unless dry_run.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, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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.

  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


796
797
798
799
800
801
802
803
804
805
806
807
# File 'generated/google/apis/content_v2/service.rb', line 796

def fetchnow_datafeed(merchant_id, datafeed_id, dry_run: nil, 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::DatafeedsFetchNowResponse::Representation
  command.response_class = Google::Apis::ContentV2::DatafeedsFetchNowResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['datafeedId'] = datafeed_id unless datafeed_id.nil?
  command.query['dryRun'] = dry_run unless dry_run.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::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:


234
235
236
237
238
239
240
241
242
243
244
# File 'generated/google/apis/content_v2/service.rb', line 234

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::Account::Representation
  command.response_class = Google::Apis::ContentV2::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_account_authinfo(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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/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::AccountsAuthInfoResponse::Representation
  command.response_class = Google::Apis::ContentV2::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

#get_account_status(merchant_id, account_id, destinations: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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:


475
476
477
478
479
480
481
482
483
484
485
486
# File 'generated/google/apis/content_v2/service.rb', line 475

def (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::AccountStatus::Representation
  command.response_class = Google::Apis::ContentV2::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_account_tax(merchant_id, account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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:


595
596
597
598
599
600
601
602
603
604
605
# File 'generated/google/apis/content_v2/service.rb', line 595

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


834
835
836
837
838
839
840
841
842
843
844
# File 'generated/google/apis/content_v2/service.rb', line 834

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::Datafeed::Representation
  command.response_class = Google::Apis::ContentV2::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_datafeed_status(merchant_id, datafeed_id, country: nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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/service.rb', line 1039

def get_datafeed_status(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::DatafeedStatus::Representation
  command.response_class = Google::Apis::ContentV2::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::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:


1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
# File 'generated/google/apis/content_v2/service.rb', line 1243

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::LiaSettings::Representation
  command.response_class = Google::Apis::ContentV2::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::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:


2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
# File 'generated/google/apis/content_v2/service.rb', line 2196

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::Order::Representation
  command.response_class = Google::Apis::ContentV2::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_order_by_merchant_order_id(merchant_id, merchant_order_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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:


2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
# File 'generated/google/apis/content_v2/service.rb', line 2233

def get_order_by_merchant_order_id(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::OrdersGetByMerchantOrderIdResponse::Representation
  command.response_class = Google::Apis::ContentV2::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

#get_orderreturn(merchant_id, return_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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:


1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
# File 'generated/google/apis/content_v2/service.rb', line 1798

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::MerchantOrderReturn::Representation
  command.response_class = Google::Apis::ContentV2::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::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:


2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
# File 'generated/google/apis/content_v2/service.rb', line 2870

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::PosStore::Representation
  command.response_class = Google::Apis::ContentV2::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::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:


3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
# File 'generated/google/apis/content_v2/service.rb', line 3149

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::Product::Representation
  command.response_class = Google::Apis::ContentV2::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_product_status(merchant_id, product_id, destinations: nil, include_attributes: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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.

  • include_attributes (Boolean) (defaults to: nil)

    Flag to include full product data in the result of this get request. 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:

Returns:

Raises:


3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
# File 'generated/google/apis/content_v2/service.rb', line 3316

def get_product_status(merchant_id, product_id, destinations: nil, include_attributes: 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::ProductStatus::Representation
  command.response_class = Google::Apis::ContentV2::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['includeAttributes'] = include_attributes unless include_attributes.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::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:


3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
# File 'generated/google/apis/content_v2/service.rb', line 3447

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::ShippingSettings::Representation
  command.response_class = Google::Apis::ContentV2::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

#get_test_order_template(merchant_id, template_name, country: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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:


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

def get_test_order_template(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::OrdersGetTestOrderTemplateResponse::Representation
  command.response_class = Google::Apis::ContentV2::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

#getaccessiblegmbaccounts_liasetting(merchant_id, account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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:


1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
# File 'generated/google/apis/content_v2/service.rb', line 1282

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::LiasettingsGetAccessibleGmbAccountsResponse::Representation
  command.response_class = Google::Apis::ContentV2::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

#getsupportedcarriers_shippingsetting(merchant_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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:


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

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::ShippingsettingsGetSupportedCarriersResponse::Representation
  command.response_class = Google::Apis::ContentV2::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::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:


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

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::ShippingsettingsGetSupportedHolidaysResponse::Representation
  command.response_class = Google::Apis::ContentV2::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::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:


3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
# File 'generated/google/apis/content_v2/service.rb', line 3547

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::ShippingsettingsGetSupportedPickupServicesResponse::Representation
  command.response_class = Google::Apis::ContentV2::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

#insert_account(merchant_id, account_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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::Account) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


272
273
274
275
276
277
278
279
280
281
282
283
284
# File 'generated/google/apis/content_v2/service.rb', line 272

def (merchant_id,  = nil, dry_run: 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::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::ContentV2::Account::Representation
  command.response_class = Google::Apis::ContentV2::Account
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['dryRun'] = dry_run unless dry_run.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, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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::Datafeed) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


873
874
875
876
877
878
879
880
881
882
883
884
885
# File 'generated/google/apis/content_v2/service.rb', line 873

def insert_datafeed(merchant_id, datafeed_object = nil, dry_run: 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::Datafeed::Representation
  command.request_object = datafeed_object
  command.response_representation = Google::Apis::ContentV2::Datafeed::Representation
  command.response_class = Google::Apis::ContentV2::Datafeed
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['dryRun'] = dry_run unless dry_run.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, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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::PosStore) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'generated/google/apis/content_v2/service.rb', line 2911

def insert_po(merchant_id, target_merchant_id, pos_store_object = nil, dry_run: 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::PosStore::Representation
  command.request_object = pos_store_object
  command.response_representation = Google::Apis::ContentV2::PosStore::Representation
  command.response_class = Google::Apis::ContentV2::PosStore
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['targetMerchantId'] = target_merchant_id unless target_merchant_id.nil?
  command.query['dryRun'] = dry_run unless dry_run.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, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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::Product) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
# File 'generated/google/apis/content_v2/service.rb', line 3190

def insert_product(merchant_id, product_object = nil, dry_run: 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::Product::Representation
  command.request_object = product_object
  command.response_representation = Google::Apis::ContentV2::Product::Representation
  command.response_class = Google::Apis::ContentV2::Product
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['dryRun'] = dry_run unless dry_run.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::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::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:


2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
# File 'generated/google/apis/content_v2/service.rb', line 2320

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::OrdersInStoreRefundLineItemRequest::Representation
  command.request_object = orders_in_store_refund_line_item_request_object
  command.response_representation = Google::Apis::ContentV2::OrdersInStoreRefundLineItemResponse::Representation
  command.response_class = Google::Apis::ContentV2::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, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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::PosInventoryRequest) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
# File 'generated/google/apis/content_v2/service.rb', line 2954

def inventory_po(merchant_id, target_merchant_id, pos_inventory_request_object = nil, dry_run: 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::PosInventoryRequest::Representation
  command.request_object = pos_inventory_request_object
  command.response_representation = Google::Apis::ContentV2::PosInventoryResponse::Representation
  command.response_class = Google::Apis::ContentV2::PosInventoryResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['targetMerchantId'] = target_merchant_id unless target_merchant_id.nil?
  command.query['dryRun'] = dry_run unless dry_run.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::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:


314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'generated/google/apis/content_v2/service.rb', line 314

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::AccountsLinkRequest::Representation
  command.request_object = accounts_link_request_object
  command.response_representation = Google::Apis::ContentV2::AccountsLinkResponse::Representation
  command.response_class = Google::Apis::ContentV2::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_account_statuses(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::ListAccountStatusesResponse

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:


518
519
520
521
522
523
524
525
526
527
528
529
530
# File 'generated/google/apis/content_v2/service.rb', line 518

def (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::ListAccountStatusesResponse::Representation
  command.response_class = Google::Apis::ContentV2::ListAccountStatusesResponse
  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_account_taxes(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::ListAccountTaxResponse

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:


633
634
635
636
637
638
639
640
641
642
643
644
# File 'generated/google/apis/content_v2/service.rb', line 633

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}/accounttax', options)
  command.response_representation = Google::Apis::ContentV2::ListAccountTaxResponse::Representation
  command.response_class = Google::Apis::ContentV2::ListAccountTaxResponse
  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_accounts(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::ListAccountsResponse

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:


354
355
356
357
358
359
360
361
362
363
364
365
# File 'generated/google/apis/content_v2/service.rb', line 354

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::ListAccountsResponse::Representation
  command.response_class = Google::Apis::ContentV2::ListAccountsResponse
  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_datafeed_statuses(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::ListDatafeedStatusesResponse

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/service.rb', line 1080

def list_datafeed_statuses(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::ListDatafeedStatusesResponse::Representation
  command.response_class = Google::Apis::ContentV2::ListDatafeedStatusesResponse
  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::ListDatafeedsResponse

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:


914
915
916
917
918
919
920
921
922
923
924
925
# File 'generated/google/apis/content_v2/service.rb', line 914

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::ListDatafeedsResponse::Representation
  command.response_class = Google::Apis::ContentV2::ListDatafeedsResponse
  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::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:


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

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::LiasettingsListResponse::Representation
  command.response_class = Google::Apis::ContentV2::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::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:


1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
# File 'generated/google/apis/content_v2/service.rb', line 1847

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::OrderreturnsListResponse::Representation
  command.response_class = Google::Apis::ContentV2::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::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:


2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
# File 'generated/google/apis/content_v2/service.rb', line 2383

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::OrdersListResponse::Representation
  command.response_class = Google::Apis::ContentV2::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::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:


2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
# File 'generated/google/apis/content_v2/service.rb', line 2993

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::PosListResponse::Representation
  command.response_class = Google::Apis::ContentV2::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_product_statuses(merchant_id, destinations: nil, include_attributes: nil, include_invalid_inserted_items: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::ListProductStatusesResponse

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.

  • include_attributes (Boolean) (defaults to: nil)

    Flag to include full product data in the results of the list request. The default value is false.

  • include_invalid_inserted_items (Boolean) (defaults to: nil)

    Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).

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


3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
# File 'generated/google/apis/content_v2/service.rb', line 3367

def list_product_statuses(merchant_id, destinations: nil, include_attributes: nil, include_invalid_inserted_items: 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::ListProductStatusesResponse::Representation
  command.response_class = Google::Apis::ContentV2::ListProductStatusesResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['destinations'] = destinations unless destinations.nil?
  command.query['includeAttributes'] = include_attributes unless include_attributes.nil?
  command.query['includeInvalidInsertedItems'] = include_invalid_inserted_items unless include_invalid_inserted_items.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_products(merchant_id, include_invalid_inserted_items: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::ListProductsResponse

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.

  • include_invalid_inserted_items (Boolean) (defaults to: nil)

    Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).

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


3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'generated/google/apis/content_v2/service.rb', line 3234

def list_products(merchant_id, include_invalid_inserted_items: nil, 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::ListProductsResponse::Representation
  command.response_class = Google::Apis::ContentV2::ListProductsResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.query['includeInvalidInsertedItems'] = include_invalid_inserted_items unless include_invalid_inserted_items.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_shippingsettings(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::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:


3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
# File 'generated/google/apis/content_v2/service.rb', line 3586

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::ShippingsettingsListResponse::Representation
  command.response_class = Google::Apis::ContentV2::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::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:


1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
# File 'generated/google/apis/content_v2/service.rb', line 1707

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::OrderreportsListDisbursementsResponse::Representation
  command.response_class = Google::Apis::ContentV2::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

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

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

Parameters:

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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:


1354
1355
1356
1357
1358
1359
1360
1361
1362
# File 'generated/google/apis/content_v2/service.rb', line 1354

def listposdataproviders_liasetting(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'liasettings/posdataproviders', options)
  command.response_representation = Google::Apis::ContentV2::LiasettingsListPosDataProvidersResponse::Representation
  command.response_class = Google::Apis::ContentV2::LiasettingsListPosDataProvidersResponse
  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

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

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

Parameters:

  • merchant_id (Fixnum)

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

  • disbursement_id (String)

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

  • transaction_start_date (String)

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

  • max_results (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    The token returned by the previous request.

  • transaction_end_date (String) (defaults to: nil)

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

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


1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
# File 'generated/google/apis/content_v2/service.rb', line 1757

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

#refund_order(merchant_id, order_id, orders_refund_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::OrdersRefundResponse

Deprecated, please use returnRefundLineItem instead.

Parameters:

  • merchant_id (Fixnum)

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

  • order_id (String)

    The ID of the order to refund.

  • orders_refund_request_object (Google::Apis::ContentV2::OrdersRefundRequest) (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:


2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
# File 'generated/google/apis/content_v2/service.rb', line 2427

def refund_order(merchant_id, order_id, orders_refund_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/refund', options)
  command.request_representation = Google::Apis::ContentV2::OrdersRefundRequest::Representation
  command.request_object = orders_refund_request_object
  command.response_representation = Google::Apis::ContentV2::OrdersRefundResponse::Representation
  command.response_class = Google::Apis::ContentV2::OrdersRefundResponse
  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

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

Rejects return on an line item.

Parameters:

  • merchant_id (Fixnum)

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

  • order_id (String)

    The ID of the order.

  • orders_reject_return_line_item_request_object (Google::Apis::ContentV2::OrdersRejectReturnLineItemRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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:


2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
# File 'generated/google/apis/content_v2/service.rb', line 2467

def rejectreturnlineitem_order(merchant_id, order_id, orders_reject_return_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/rejectReturnLineItem', options)
  command.request_representation = Google::Apis::ContentV2::OrdersRejectReturnLineItemRequest::Representation
  command.request_object = orders_reject_return_line_item_request_object
  command.response_representation = Google::Apis::ContentV2::OrdersRejectReturnLineItemResponse::Representation
  command.response_class = Google::Apis::ContentV2::OrdersRejectReturnLineItemResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Requests access to a specified Google My Business account.

Parameters:

  • merchant_id (Fixnum)

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

  • account_id (Fixnum)

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

  • gmb_email (String)

    The email of the Google My Business account.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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:


1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
# File 'generated/google/apis/content_v2/service.rb', line 1392

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

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

Requests inventory validation for the specified country.

Parameters:

  • merchant_id (Fixnum)

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

  • account_id (Fixnum)

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

  • country (String)

    The country for which inventory validation is requested.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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:


1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
# File 'generated/google/apis/content_v2/service.rb', line 1434

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

#return_order_line_item(merchant_id, order_id, orders_return_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::OrdersReturnLineItemResponse

Returns a line item.

Parameters:

  • merchant_id (Fixnum)

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

  • order_id (String)

    The ID of the order.

  • orders_return_line_item_request_object (Google::Apis::ContentV2::OrdersReturnLineItemRequest) (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:


2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
# File 'generated/google/apis/content_v2/service.rb', line 2507

def return_order_line_item(merchant_id, order_id, orders_return_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/orders/{orderId}/returnLineItem', options)
  command.request_representation = Google::Apis::ContentV2::OrdersReturnLineItemRequest::Representation
  command.request_object = orders_return_line_item_request_object
  command.response_representation = Google::Apis::ContentV2::OrdersReturnLineItemResponse::Representation
  command.response_class = Google::Apis::ContentV2::OrdersReturnLineItemResponse
  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

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

Returns and refunds a line item. Note that this method can only be called on fully shipped 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.

  • orders_return_refund_line_item_request_object (Google::Apis::ContentV2::OrdersReturnRefundLineItemRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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:


2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
# File 'generated/google/apis/content_v2/service.rb', line 2548

def returnrefundlineitem_order(merchant_id, order_id, orders_return_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}/returnRefundLineItem', options)
  command.request_representation = Google::Apis::ContentV2::OrdersReturnRefundLineItemRequest::Representation
  command.request_object = orders_return_refund_line_item_request_object
  command.response_representation = Google::Apis::ContentV2::OrdersReturnRefundLineItemResponse::Representation
  command.response_class = Google::Apis::ContentV2::OrdersReturnRefundLineItemResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Submit a sale event for the given merchant.

Parameters:

  • merchant_id (Fixnum)

    The ID of the POS or inventory data provider.

  • target_merchant_id (Fixnum)

    The ID of the target merchant.

  • pos_sale_request_object (Google::Apis::ContentV2::PosSaleRequest) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil)

    Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

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


3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
# File 'generated/google/apis/content_v2/service.rb', line 3033

def sale_po(merchant_id, target_merchant_id, pos_sale_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{merchantId}/pos/{targetMerchantId}/sale', options)
  command.request_representation = Google::Apis::ContentV2::PosSaleRequest::Representation
  command.request_object = pos_sale_request_object
  command.response_representation = Google::Apis::ContentV2::