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

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/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:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ManufacturerCenterService

Returns a new instance of ManufacturerCenterService.



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

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-manufacturers_v1',
        client_version: Google::Apis::ManufacturersV1::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/manufacturers_v1/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/manufacturers_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

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

Deletes a product certification by its name. This method can only be called by certification bodies.

Parameters:

  • name (String) —

    Required. The name of the product certification to delete. Format: accounts/ account/languages/language_code/productCertifications/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



76
77
78
79
80
81
82
83
84
 
# File 'lib/google/apis/manufacturers_v1/service.rb', line 76

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManufacturersV1::Empty::Representation
  command.response_class = Google::Apis::ManufacturersV1::Empty
  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

#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



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

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_language_product_certification(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManufacturersV1::ProductCertification

Gets a product certification by its name. This method can only be called by certification bodies.

Parameters:

  • name (String) —

    Required. The name of the product certification to get. Format: accounts/ account/languages/language_code/productCertifications/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



108
109
110
111
112
113
114
115
116
 
# File 'lib/google/apis/manufacturers_v1/service.rb', line 108

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ManufacturersV1::ProductCertification::Representation
  command.response_class = Google::Apis::ManufacturersV1::ProductCertification
  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



279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/google/apis/manufacturers_v1/service.rb', line 279

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_language_product_certifications(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManufacturersV1::ListProductCertificationsResponse

Lists product certifications from a specified certification body. This method can only be called by certification bodies.

Parameters:

  • parent (String) —

    Required. The parent, which owns this collection of product certifications. Format: accounts/account/languages/language_code

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

    Optional. The maximum number of product certifications to return. The service may return fewer than this value. If unspecified, at most 50 product certifications will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

    Optional. A page token, received from a previous ListProductCertifications call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListProductCertifications must match the call that provided the page token. Required if requesting the second or higher page.

  • 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



150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/google/apis/manufacturers_v1/service.rb', line 150

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/productCertifications', options)
  command.response_representation = Google::Apis::ManufacturersV1::ListProductCertificationsResponse::Representation
  command.response_class = Google::Apis::ManufacturersV1::ListProductCertificationsResponse
  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

#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



319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/google/apis/manufacturers_v1/service.rb', line 319

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

#patch_account_language_product_certification(name, product_certification_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ManufacturersV1::ProductCertification

Updates (or creates if allow_missing = true) a product certification which links certifications with products. This method can only be called by certification bodies.

Parameters:

  • name (String) —

    Required. The unique name identifier of a product certification Format: accounts/account/languages/language_code/productCertifications/id Where id is a some unique identifier and language_code is a 2-letter ISO 639-1 code of a Shopping supported language according to https://support.google.com/ merchants/answer/160637.

  • product_certification_object (Google::Apis::ManufacturersV1::ProductCertification) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Optional. The list of fields to update according to aip.dev/134. However, only full update is supported as of right now. Therefore, it can be either ignored or set to "*". Setting any other values will returns UNIMPLEMENTED error.

  • 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



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

def (name, product_certification_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ManufacturersV1::ProductCertification::Representation
  command.request_object = product_certification_object
  command.response_representation = Google::Apis::ManufacturersV1::ProductCertification::Representation
  command.response_class = Google::Apis::ManufacturersV1::ProductCertification
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.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



371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/google/apis/manufacturers_v1/service.rb', line 371

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