class Google::Apis::ManufacturersV1::ManufacturerCenterService

Manufacturer Center API

Public API for managing Manufacturer Center related data.

@example

require 'google/apis/manufacturers_v1'

Manufacturers = Google::Apis::ManufacturersV1 # Alias the module
service = Manufacturers::ManufacturerCenterService.new

@see developers.google.com/manufacturers/

Attributes

key[RW]

@return [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.
quota_user[RW]

@return [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.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/manufacturers_v1/service.rb, line 45
def initialize
  super('https://manufacturers.googleapis.com/', '',
        client_name: 'google-apis-manufacturers_v1',
        client_version: Google::Apis::ManufacturersV1::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

delete_account_product(parent, name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes the product from a Manufacturer Center account. @param [String] parent

Parent ID in the format `accounts/`account_id``. `account_id` - The ID of the
Manufacturer Center account.

@param [String] name

Name in the format ``target_country`:`content_language`:`product_id``. `
target_country` - The target country of the product as a CLDR territory code (
for example, US). `content_language` - The content language of the product as
a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID
of the product. For more information, see https://support.google.com/
manufacturers/answer/6124116#id.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::ManufacturersV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::ManufacturersV1::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/manufacturers_v1/service.rb, line 80
def delete_account_product(parent, name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+parent}/products/{+name}', options)
  command.response_representation = Google::Apis::ManufacturersV1::Empty::Representation
  command.response_class = Google::Apis::ManufacturersV1::Empty
  command.params['parent'] = parent unless parent.nil?
  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
get_account_product(parent, name, include: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets the product from a Manufacturer Center account, including product issues. A recently updated product takes around 15 minutes to process. Changes are only visible after it has been processed. While some issues may be available once the product has been processed, other issues may take days to appear. @param [String] parent

Parent ID in the format `accounts/`account_id``. `account_id` - The ID of the
Manufacturer Center account.

@param [String] name

Name in the format ``target_country`:`content_language`:`product_id``. `
target_country` - The target country of the product as a CLDR territory code (
for example, US). `content_language` - The content language of the product as
a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID
of the product. For more information, see https://support.google.com/
manufacturers/answer/6124116#id.

@param [Array<String>, String] include

The information to be included in the response. Only sections listed here will
be returned.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::ManufacturersV1::Product] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::ManufacturersV1::Product]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/manufacturers_v1/service.rb, line 125
def get_account_product(parent, name, include: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/products/{+name}', options)
  command.response_representation = Google::Apis::ManufacturersV1::Product::Representation
  command.response_class = Google::Apis::ManufacturersV1::Product
  command.params['parent'] = parent unless parent.nil?
  command.params['name'] = name unless name.nil?
  command.query['include'] = include unless include.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, include: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists all the products in a Manufacturer Center account. @param [String] parent

Parent ID in the format `accounts/`account_id``. `account_id` - The ID of the
Manufacturer Center account.

@param [Array<String>, String] include

The information to be included in the response. Only sections listed here will
be returned.

@param [Fixnum] page_size

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

@param [String] page_token

The token returned by the previous request.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::ManufacturersV1::ListProductsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::ManufacturersV1::ListProductsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/manufacturers_v1/service.rb, line 165
def list_account_products(parent, include: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/products', options)
  command.response_representation = Google::Apis::ManufacturersV1::ListProductsResponse::Representation
  command.response_class = Google::Apis::ManufacturersV1::ListProductsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['include'] = include unless include.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
update_account_product(parent, name, attributes_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Inserts or updates the attributes of the product in a Manufacturer Center account. Creates a product with the provided attributes. If the product already exists, then all attributes are replaced with the new ones. The checks at upload time are minimal. All required attributes need to be present for a product to be valid. Issues may show up later after the API has accepted a new upload for a product and it is possible to overwrite an existing valid product with an invalid product. To detect this, you should retrieve the product and check it for issues once the new version is available. Uploaded attributes first need to be processed before they can be retrieved. Until then, new products will be unavailable, and retrieval of previously uploaded products will return the original state of the product. @param [String] parent

Parent ID in the format `accounts/`account_id``. `account_id` - The ID of the
Manufacturer Center account.

@param [String] name

Name in the format ``target_country`:`content_language`:`product_id``. `
target_country` - The target country of the product as a CLDR territory code (
for example, US). `content_language` - The content language of the product as
a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID
of the product. For more information, see https://support.google.com/
manufacturers/answer/6124116#id.

@param [Google::Apis::ManufacturersV1::Attributes] attributes_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::ManufacturersV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::ManufacturersV1::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/manufacturers_v1/service.rb, line 217
def update_account_product(parent, name, attributes_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+parent}/products/{+name}', options)
  command.request_representation = Google::Apis::ManufacturersV1::Attributes::Representation
  command.request_object = attributes_object
  command.response_representation = Google::Apis::ManufacturersV1::Empty::Representation
  command.response_class = Google::Apis::ManufacturersV1::Empty
  command.params['parent'] = parent unless parent.nil?
  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

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/manufacturers_v1/service.rb, line 232
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end