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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

Parameters:

  • batch_account_statuses_request_object (Google::Apis::ContentV2::BatchAccountStatusesRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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
606
# File 'generated/google/apis/content_v2/service.rb', line 595

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

Parameters:

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

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

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

Parameters:

  • batch_datafeed_statuses_request_object (Google::Apis::ContentV2::BatchDatafeedStatusesRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
# File 'generated/google/apis/content_v2/service.rb', line 1112

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
# File 'generated/google/apis/content_v2/service.rb', line 1237

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
# File 'generated/google/apis/content_v2/service.rb', line 3380

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)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
# File 'generated/google/apis/content_v2/service.rb', line 3578

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
# File 'generated/google/apis/content_v2/service.rb', line 2287

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
# File 'generated/google/apis/content_v2/service.rb', line 2327

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
# File 'generated/google/apis/content_v2/service.rb', line 2367

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)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
# File 'generated/google/apis/content_v2/service.rb', line 2405

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 non-facilitated payment 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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
# File 'generated/google/apis/content_v2/service.rb', line 1778

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 non-facilitated payment 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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
# File 'generated/google/apis/content_v2/service.rb', line 1821

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
# File 'generated/google/apis/content_v2/service.rb', line 2444

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
# File 'generated/google/apis/content_v2/service.rb', line 2479

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
# File 'generated/google/apis/content_v2/service.rb', line 3103

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
# File 'generated/google/apis/content_v2/service.rb', line 3713

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)

    Flag to run the request in dry-run mode.

  • force (Boolean)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



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

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



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

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
# File 'generated/google/apis/content_v2/service.rb', line 3144

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
# File 'generated/google/apis/content_v2/service.rb', line 3420

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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. Multi-client accounts can only call this method for sub-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)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



515
516
517
518
519
520
521
522
523
524
525
526
# File 'generated/google/apis/content_v2/service.rb', line 515

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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)

    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)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'generated/google/apis/content_v2/service.rb', line 1159

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
# File 'generated/google/apis/content_v2/service.rb', line 1360

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
# File 'generated/google/apis/content_v2/service.rb', line 2516

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
# File 'generated/google/apis/content_v2/service.rb', line 2553

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
# File 'generated/google/apis/content_v2/service.rb', line 3182

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
# File 'generated/google/apis/content_v2/service.rb', line 3456

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)

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

  • include_attributes (Boolean)

    Flag to include full product data in the result of this get request. The default value is false.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
# File 'generated/google/apis/content_v2/service.rb', line 3622

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
# File 'generated/google/apis/content_v2/service.rb', line 3752

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)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'generated/google/apis/content_v2/service.rb', line 2593

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
# File 'generated/google/apis/content_v2/service.rb', line 1399

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
# File 'generated/google/apis/content_v2/service.rb', line 3786

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
# File 'generated/google/apis/content_v2/service.rb', line 3819

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

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

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'generated/google/apis/content_v2/service.rb', line 269

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



950
951
952
953
954
955
956
957
958
959
960
961
962
# File 'generated/google/apis/content_v2/service.rb', line 950

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
# File 'generated/google/apis/content_v2/service.rb', line 3222

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
# File 'generated/google/apis/content_v2/service.rb', line 3496

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

Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store).

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
# File 'generated/google/apis/content_v2/service.rb', line 2633

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
# File 'generated/google/apis/content_v2/service.rb', line 3264

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 a Merchant Center account and another 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 that should be linked.

  • accounts_link_request_object (Google::Apis::ContentV2::AccountsLinkRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



311
312
313
314
315
316
317
318
319
320
321
322
323
# File 'generated/google/apis/content_v2/service.rb', line 311

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)

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

  • max_results (Fixnum)

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

  • page_token (String)

    The token returned by the previous request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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)

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

  • page_token (String)

    The token returned by the previous request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



672
673
674
675
676
677
678
679
680
681
682
683
# File 'generated/google/apis/content_v2/service.rb', line 672

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)

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

  • page_token (String)

    The token returned by the previous request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



351
352
353
354
355
356
357
358
359
360
361
362
# File 'generated/google/apis/content_v2/service.rb', line 351

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)

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

  • page_token (String)

    The token returned by the previous request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
# File 'generated/google/apis/content_v2/service.rb', line 1200

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)

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

  • page_token (String)

    The token returned by the previous request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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)

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

  • page_token (String)

    The token returned by the previous request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
# File 'generated/google/apis/content_v2/service.rb', line 1437

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)

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

  • created_start_date (String)

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

  • max_results (Fixnum)

    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)

    Return the results in the specified order.

  • page_token (String)

    The token returned by the previous request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
# File 'generated/google/apis/content_v2/service.rb', line 2167

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)

    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)

    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. Known issue: All List calls will return all Orders without limit regardless of the value of this field.

  • order_by (String)

    The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.

  • page_token (String)

    The token returned by the previous request.

  • placed_date_end (String)

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

  • placed_date_start (String)

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

  • statuses (Array<String>, String)

    Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, 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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
# File 'generated/google/apis/content_v2/service.rb', line 2701

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
# File 'generated/google/apis/content_v2/service.rb', line 3303

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)

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

  • include_attributes (Boolean)

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

  • include_invalid_inserted_items (Boolean)

    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)

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

  • page_token (String)

    The token returned by the previous request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
# File 'generated/google/apis/content_v2/service.rb', line 3673

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)

    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)

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

  • page_token (String)

    The token returned by the previous request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
# File 'generated/google/apis/content_v2/service.rb', line 3540

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)

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

  • page_token (String)

    The token returned by the previous request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
# File 'generated/google/apis/content_v2/service.rb', line 3858

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)

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

  • max_results (Fixnum)

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

  • page_token (String)

    The token returned by the previous request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
# File 'generated/google/apis/content_v2/service.rb', line 2027

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1471
1472
1473
1474
1475
1476
1477
1478
1479
# File 'generated/google/apis/content_v2/service.rb', line 1471

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)

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

  • page_token (String)

    The token returned by the previous request.

  • transaction_end_date (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
# File 'generated/google/apis/content_v2/service.rb', line 2077

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

#notifyauthapproved_orderpayment(merchant_id, order_id, orderpayments_notify_auth_approved_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::OrderpaymentsNotifyAuthApprovedResponse

Notify about successfully authorizing user's payment method for a given amount.

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 for for which payment authorization is happening.

  • orderpayments_notify_auth_approved_request_object (Google::Apis::ContentV2::OrderpaymentsNotifyAuthApprovedRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
# File 'generated/google/apis/content_v2/service.rb', line 1861

def notifyauthapproved_orderpayment(merchant_id, order_id, orderpayments_notify_auth_approved_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orderpayments/{orderId}/notifyAuthApproved', options)
  command.request_representation = Google::Apis::ContentV2::OrderpaymentsNotifyAuthApprovedRequest::Representation
  command.request_object = orderpayments_notify_auth_approved_request_object
  command.response_representation = Google::Apis::ContentV2::OrderpaymentsNotifyAuthApprovedResponse::Representation
  command.response_class = Google::Apis::ContentV2::OrderpaymentsNotifyAuthApprovedResponse
  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

#notifyauthdeclined_orderpayment(merchant_id, order_id, orderpayments_notify_auth_declined_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::OrderpaymentsNotifyAuthDeclinedResponse

Notify about failure to authorize user's payment method.

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 for which payment authorization was declined.

  • orderpayments_notify_auth_declined_request_object (Google::Apis::ContentV2::OrderpaymentsNotifyAuthDeclinedRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
# File 'generated/google/apis/content_v2/service.rb', line 1901

def notifyauthdeclined_orderpayment(merchant_id, order_id, orderpayments_notify_auth_declined_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orderpayments/{orderId}/notifyAuthDeclined', options)
  command.request_representation = Google::Apis::ContentV2::OrderpaymentsNotifyAuthDeclinedRequest::Representation
  command.request_object = orderpayments_notify_auth_declined_request_object
  command.response_representation = Google::Apis::ContentV2::OrderpaymentsNotifyAuthDeclinedResponse::Representation
  command.response_class = Google::Apis::ContentV2::OrderpaymentsNotifyAuthDeclinedResponse
  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

#notifycharge_orderpayment(merchant_id, order_id, orderpayments_notify_charge_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::OrderpaymentsNotifyChargeResponse

Notify about charge on user's selected payments method.

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 for which charge is happening.

  • orderpayments_notify_charge_request_object (Google::Apis::ContentV2::OrderpaymentsNotifyChargeRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
# File 'generated/google/apis/content_v2/service.rb', line 1941

def notifycharge_orderpayment(merchant_id, order_id, orderpayments_notify_charge_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orderpayments/{orderId}/notifyCharge', options)
  command.request_representation = Google::Apis::ContentV2::OrderpaymentsNotifyChargeRequest::Representation
  command.request_object = orderpayments_notify_charge_request_object
  command.response_representation = Google::Apis::ContentV2::OrderpaymentsNotifyChargeResponse::Representation
  command.response_class = Google::Apis::ContentV2::OrderpaymentsNotifyChargeResponse
  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

#notifyrefund_orderpayment(merchant_id, order_id, orderpayments_notify_refund_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::OrderpaymentsNotifyRefundResponse

Notify about refund on user's selected payments method.

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 for which charge is happening.

  • orderpayments_notify_refund_request_object (Google::Apis::ContentV2::OrderpaymentsNotifyRefundRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'generated/google/apis/content_v2/service.rb', line 1981

def notifyrefund_orderpayment(merchant_id, order_id, orderpayments_notify_refund_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/orderpayments/{orderId}/notifyRefund', options)
  command.request_representation = Google::Apis::ContentV2::OrderpaymentsNotifyRefundRequest::Representation
  command.request_object = orderpayments_notify_refund_request_object
  command.response_representation = Google::Apis::ContentV2::OrderpaymentsNotifyRefundResponse::Representation
  command.response_class = Google::Apis::ContentV2::OrderpaymentsNotifyRefundResponse
  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

#patch_account(merchant_id, account_id, account_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::Account

Updates a Merchant Center account. This method supports patch semantics.

Parameters:

  • merchant_id (Fixnum)

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

  • account_id (Fixnum)

    The ID of the account.

  • account_object (Google::Apis::ContentV2::Account) (defaults to: nil)
  • dry_run (Boolean)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



393
394
395
396
397
398
399
400
401
402
403
404
405
406
# File 'generated/google/apis/content_v2/service.rb', line 393

def (merchant_id, ,  = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{merchantId}/accounts/{accountId}', 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.params['accountId'] =  unless .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

#patch_account_tax(merchant_id, account_id, account_tax_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::AccountTax

Updates the tax settings of the account. This method supports patch semantics.

Parameters:

  • merchant_id (Fixnum)

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

  • account_id (Fixnum)

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

  • account_tax_object (Google::Apis::ContentV2::AccountTax) (defaults to: nil)
  • dry_run (Boolean)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def (merchant_id, ,  = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{merchantId}/accounttax/{accountId}', options)
  command.request_representation = Google::Apis::ContentV2::AccountTax::Representation
  command.request_object = 
  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['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

#patch_datafeed(merchant_id, datafeed_id, datafeed_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::Datafeed

Updates a datafeed configuration of your Merchant Center account. This method supports patch semantics.

Parameters:

  • merchant_id (Fixnum)

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

  • datafeed_id (Fixnum)

    The ID of the datafeed.

  • datafeed_object (Google::Apis::ContentV2::Datafeed) (defaults to: nil)
  • dry_run (Boolean)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
# File 'generated/google/apis/content_v2/service.rb', line 1033

def patch_datafeed(merchant_id, datafeed_id, datafeed_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{merchantId}/datafeeds/{datafeedId}', 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.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

#patch_liasetting(merchant_id, account_id, lia_settings_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::LiaSettings

Updates the LIA settings of the account. This method supports patch semantics.

Parameters:

  • merchant_id (Fixnum)

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

  • account_id (Fixnum)

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

  • lia_settings_object (Google::Apis::ContentV2::LiaSettings) (defaults to: nil)
  • dry_run (Boolean)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
# File 'generated/google/apis/content_v2/service.rb', line 1510

def patch_liasetting(merchant_id, , lia_settings_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{merchantId}/liasettings/{accountId}', options)
  command.request_representation = Google::Apis::ContentV2::LiaSettings::Representation
  command.request_object = lia_settings_object
  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['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

#patch_shippingsetting(merchant_id, account_id, shipping_settings_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::ShippingSettings

Updates the shipping settings of the account. This method supports patch semantics.

Parameters:

  • merchant_id (Fixnum)

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

  • account_id (Fixnum)

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

  • shipping_settings_object (Google::Apis::ContentV2::ShippingSettings) (defaults to: nil)
  • dry_run (Boolean)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
# File 'generated/google/apis/content_v2/service.rb', line 3901

def patch_shippingsetting(merchant_id, , shipping_settings_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{merchantId}/shippingsettings/{accountId}', options)
  command.request_representation = Google::Apis::ContentV2::ShippingSettings::Representation
  command.request_object = shipping_settings_object
  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['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

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'generated/google/apis/content_v2/service.rb', line 2745

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
# File 'generated/google/apis/content_v2/service.rb', line 2785

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
# File 'generated/google/apis/content_v2/service.rb', line 1553

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
# File 'generated/google/apis/content_v2/service.rb', line 1595

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
# File 'generated/google/apis/content_v2/service.rb', line 2825

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
# File 'generated/google/apis/content_v2/service.rb', line 3342

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

#set_inventory(merchant_id, store_code, product_id, set_inventory_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::SetInventoryResponse

Updates price and availability of a product in your Merchant Center account.

Parameters:

  • merchant_id (Fixnum)

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

  • store_code (String)

    The code of the store for which to update price and availability. Use online to update price and availability of an online product.

  • product_id (String)

    The REST id of the product for which to update price and availability.

  • set_inventory_request_object (Google::Apis::ContentV2::SetInventoryRequest) (defaults to: nil)
  • dry_run (Boolean)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def set_inventory(merchant_id, store_code, product_id, set_inventory_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{merchantId}/inventory/{storeCode}/products/{productId}', options)
  command.request_representation = Google::Apis::ContentV2::SetInventoryRequest::Representation
  command.request_object = set_inventory_request_object
  command.response_representation = Google::Apis::ContentV2::SetInventoryResponse::Representation
  command.response_class = Google::Apis::ContentV2::SetInventoryResponse
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
  command.params['storeCode'] = store_code unless store_code.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

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

Sets the inventory verification contract for the specified country.

Parameters:

  • merchant_id (Fixnum)

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

  • account_id (Fixnum)

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

  • contact_email (String)

    The email of the inventory verification contact.

  • contact_name (String)

    The name of the inventory verification contact.

  • country (String)

    The country for which inventory verification is requested.

  • language (String)

    The language for which inventory verification is requested.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
# File 'generated/google/apis/content_v2/service.rb', line 1643

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

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

Sets (overrides) merchant provided annotations on the 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_set_line_item_metadata_request_object (Google::Apis::ContentV2::OrdersSetLineItemMetadataRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
# File 'generated/google/apis/content_v2/service.rb', line 2906

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

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

Sets the POS data provider for the specified country.

Parameters:

  • merchant_id (Fixnum)

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

  • account_id (Fixnum)

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

  • country (String)

    The country for which the POS data provider is selected.

  • pos_data_provider_id (Fixnum)

    The ID of POS data provider.

  • pos_external_account_id (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
# File 'generated/google/apis/content_v2/service.rb', line 1692

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

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

Marks line item(s) as shipped.

Parameters:

  • merchant_id (Fixnum)

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

  • order_id (String)

    The ID of the order.

  • orders_ship_line_items_request_object (Google::Apis::ContentV2::OrdersShipLineItemsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
# File 'generated/google/apis/content_v2/service.rb', line 2946

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

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

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

  • account_object (Google::Apis::ContentV2::Account) (defaults to: nil)
  • dry_run (Boolean)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



437
438
439
440
441
442
443
444
445
446
447
448
449
450
# File 'generated/google/apis/content_v2/service.rb', line 437

def (merchant_id, ,  = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{merchantId}/accounts/{accountId}', 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.params['accountId'] =  unless .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

#update_account_tax(merchant_id, account_id, account_tax_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::AccountTax

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

  • account_tax_object (Google::Apis::ContentV2::AccountTax) (defaults to: nil)
  • dry_run (Boolean)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



758
759
760
761
762
763
764
765
766
767
768
769
770
771
# File 'generated/google/apis/content_v2/service.rb', line 758

def (merchant_id, ,  = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{merchantId}/accounttax/{accountId}', options)
  command.request_representation = Google::Apis::ContentV2::AccountTax::Representation
  command.request_object = 
  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['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

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

Updates a datafeed configuration of 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.

  • datafeed_object (Google::Apis::ContentV2::Datafeed) (defaults to: nil)
  • dry_run (Boolean)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'generated/google/apis/content_v2/service.rb', line 1076

def update_datafeed(merchant_id, datafeed_id, datafeed_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{merchantId}/datafeeds/{datafeedId}', 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.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

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

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

  • lia_settings_object (Google::Apis::ContentV2::LiaSettings) (defaults to: nil)
  • dry_run (Boolean)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
# File 'generated/google/apis/content_v2/service.rb', line 1736

def update_liasetting(merchant_id, , lia_settings_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{merchantId}/liasettings/{accountId}', options)
  command.request_representation = Google::Apis::ContentV2::LiaSettings::Representation
  command.request_object = lia_settings_object
  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['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

#update_merchant_order_id(merchant_id, order_id, orders_update_merchant_order_id_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::OrdersUpdateMerchantOrderIdResponse

Updates the merchant order ID for a given order.

Parameters:

  • merchant_id (Fixnum)

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

  • order_id (String)

    The ID of the order.

  • orders_update_merchant_order_id_request_object (Google::Apis::ContentV2::OrdersUpdateMerchantOrderIdRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
# File 'generated/google/apis/content_v2/service.rb', line 3026

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

#update_order_shipment(merchant_id, order_id, orders_update_shipment_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::OrdersUpdateShipmentResponse

Updates a shipment's status, carrier, and/or tracking ID.

Parameters:

  • merchant_id (Fixnum)

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

  • order_id (String)

    The ID of the order.

  • orders_update_shipment_request_object (Google::Apis::ContentV2::OrdersUpdateShipmentRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'generated/google/apis/content_v2/service.rb', line 3066

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

#update_shippingsetting(merchant_id, account_id, shipping_settings_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::ShippingSettings

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

  • shipping_settings_object (Google::Apis::ContentV2::ShippingSettings) (defaults to: nil)
  • dry_run (Boolean)

    Flag to run the request in dry-run mode.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
# File 'generated/google/apis/content_v2/service.rb', line 3945

def update_shippingsetting(merchant_id, , shipping_settings_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{merchantId}/shippingsettings/{accountId}', options)
  command.request_representation = Google::Apis::ContentV2::ShippingSettings::Representation
  command.request_object = shipping_settings_object
  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['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

#updatelineitemshippingdetails_order(merchant_id, order_id, orders_update_line_item_shipping_details_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContentV2::OrdersUpdateLineItemShippingDetailsResponse

Updates ship by and delivery by dates for a line item.

Parameters:

  • merchant_id (Fixnum)

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

  • order_id (String)

    The ID of the order.

  • orders_update_line_item_shipping_details_request_object (Google::Apis::ContentV2::OrdersUpdateLineItemShippingDetailsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'generated/google/apis/content_v2/service.rb', line 2986

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