Class: Google::Apis::ManufacturersV1::ManufacturerCenterService

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

Overview

Manufacturer Center API

Public API for managing Manufacturer Center related data.

Examples:

require 'google/apis/manufacturers_v1'

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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ManufacturerCenterService

Returns a new instance of ManufacturerCenterService.



45
46
47
48
 
# File 'generated/google/apis/manufacturers_v1/service.rb', line 45

def initialize
  super('https://manufacturers.googleapis.com/', '')
  @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.



38
39
40
 
# File 'generated/google/apis/manufacturers_v1/service.rb', line 38

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.



43
44
45
 
# File 'generated/google/apis/manufacturers_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#delete_account_product(parent, name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManufacturersV1::Empty

Deletes the product from a Manufacturer Center account.

Parameters:

  • parent (String) —

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

  • name (String) —

    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.

  • 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



78
79
80
81
82
83
84
85
86
87
 
# File 'generated/google/apis/manufacturers_v1/service.rb', line 78

def (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) {|result, err| ... } ⇒ Google::Apis::ManufacturersV1::Product

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.

Parameters:

  • parent (String) —

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

  • name (String) —

    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.

  • include (Array<String>, String) (defaults to: nil) —

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

  • 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



123
124
125
126
127
128
129
130
131
132
133
 
# File 'generated/google/apis/manufacturers_v1/service.rb', line 123

def (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) {|result, err| ... } ⇒ Google::Apis::ManufacturersV1::ListProductsResponse

Lists all the products in a Manufacturer Center account.

Parameters:

  • parent (String) —

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

  • include (Array<String>, String) (defaults to: nil) —

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

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

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

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

    The token returned by the previous request.

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

    Selector specifying which fields to include in a partial response.

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

    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



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'generated/google/apis/manufacturers_v1/service.rb', line 163

def (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) {|result, err| ... } ⇒ Google::Apis::ManufacturersV1::Empty

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.

Parameters:

  • parent (String) —

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

  • name (String) —

    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.

  • attributes_object (Google::Apis::ManufacturersV1::Attributes) (defaults to: nil)
  • 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



215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'generated/google/apis/manufacturers_v1/service.rb', line 215

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