Class: Google::Apis::MerchantapiProductsV1beta::MerchantService

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

Overview

Merchant API

Programmatically manage your Merchant Center Accounts.

Examples:

require 'google/apis/merchantapi_products_v1beta'

Merchantapi = Google::Apis::MerchantapiProductsV1beta # Alias the module
service = Merchantapi::MerchantService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://merchantapi.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ MerchantService

Returns a new instance of MerchantService.



47
48
49
50
51
52
 
# File 'lib/google/apis/merchantapi_products_v1beta/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-merchantapi_products_v1beta',
        client_version: Google::Apis::MerchantapiProductsV1beta::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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.



40
41
42
 
# File 'lib/google/apis/merchantapi_products_v1beta/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

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



45
46
47
 
# File 'lib/google/apis/merchantapi_products_v1beta/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#delete_account_product_input(name, data_source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiProductsV1beta::Empty

Deletes a product input from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.

Parameters:

  • name (String) —

    Required. The name of the product input resource to delete. Format: accounts/ account/productInputs/product

  • data_source (String) (defaults to: nil) —

    Required. The primary or supplemental data source from which the product input should be deleted. Format: accounts/account/dataSources/datasource``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/google/apis/merchantapi_products_v1beta/service.rb', line 80

def (name, data_source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'products/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiProductsV1beta::Empty::Representation
  command.response_class = Google::Apis::MerchantapiProductsV1beta::Empty
  command.params['name'] = name unless name.nil?
  command.query['dataSource'] = data_source unless data_source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_product(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiProductsV1beta::Product

Retrieves the processed product from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.

Parameters:

  • name (String) —

    Required. The name of the product to retrieve. Format: accounts/account/ products/product``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



157
158
159
160
161
162
163
164
165
 
# File 'lib/google/apis/merchantapi_products_v1beta/service.rb', line 157

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'products/v1beta/{+name}', options)
  command.response_representation = Google::Apis::MerchantapiProductsV1beta::Product::Representation
  command.response_class = Google::Apis::MerchantapiProductsV1beta::Product
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_account_product_input(parent, product_input_object = nil, data_source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiProductsV1beta::ProductInput

Uploads a product input to your Merchant Center account. If an input with the same contentLanguage, offerId, and dataSource already exists, this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.

Parameters:

  • parent (String) —

    Required. The account where this product will be inserted. Format: accounts/ account

  • product_input_object (Google::Apis::MerchantapiProductsV1beta::ProductInput) (defaults to: nil)
  • data_source (String) (defaults to: nil) —

    Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. Format: accounts/account/dataSources/ datasource``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/google/apis/merchantapi_products_v1beta/service.rb', line 121

def (parent, product_input_object = nil, data_source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'products/v1beta/{+parent}/productInputs:insert', options)
  command.request_representation = Google::Apis::MerchantapiProductsV1beta::ProductInput::Representation
  command.request_object = product_input_object
  command.response_representation = Google::Apis::MerchantapiProductsV1beta::ProductInput::Representation
  command.response_class = Google::Apis::MerchantapiProductsV1beta::ProductInput
  command.params['parent'] = parent unless parent.nil?
  command.query['dataSource'] = data_source unless data_source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_products(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MerchantapiProductsV1beta::ListProductsResponse

Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.

Parameters:

  • parent (String) —

    Required. The account to list processed products for. Format: accounts/ account

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to

    1. If unspecified, the maximum number of products will be returned.
  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListProducts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListProducts must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/google/apis/merchantapi_products_v1beta/service.rb', line 200

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'products/v1beta/{+parent}/products', options)
  command.response_representation = Google::Apis::MerchantapiProductsV1beta::ListProductsResponse::Representation
  command.response_class = Google::Apis::MerchantapiProductsV1beta::ListProductsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end