google-api-ruby-client/generated/google/apis/manufacturers_v1/service.rb

255 lines
14 KiB
Ruby
Raw Normal View History

# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module ManufacturersV1
# 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 https://developers.google.com/manufacturers/
class ManufacturerCenterService < Google::Apis::Core::BaseService
# @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.
attr_accessor :key
# @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.
attr_accessor :quota_user
def initialize
super('https://manufacturers.googleapis.com/', '')
2017-04-03 20:18:48 +00:00
@batch_path = 'batch'
end
2017-07-12 20:10:42 +00:00
# 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
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
# Gets the product from a Manufacturer Center account, including product
# issues.
Autogenerated update (2017-08-25) Add: - adexperiencereport_v1 - androiddeviceprovisioning_v1 - androidmanagement_v1 - bigquerydatatransfer_v1 - cloudtrace_v2 - clouduseraccounts_vm_alpha - consumersurveys_v2 - dlp_v2beta1 - oslogin_v1alpha - playcustomapp_v1 - playmoviespartner_v1 - safebrowsing_v4 - spectrum_v1explorer - speech_v1 - streetviewpublish_v1 - vault_v1 - videointelligence_v1beta1 Update: - acceleratedmobilepageurl_v1 - adexchangebuyer2_v2beta1 - adexchangebuyer_v1_4 - adsense_v1_4 - adsensehost_v4_1 - analytics_v3 - analyticsreporting_v4 - androidenterprise_v1 - androidpublisher_v2 - appengine_v1 - appsactivity_v1 - appstate_v1 - bigquery_v2 - calendar_v3 - classroom_v1 - cloudbilling_v1 - cloudbuild_v1 - clouddebugger_v2 - clouderrorreporting_v1beta1 - cloudfunctions_v1 - cloudkms_v1 - cloudmonitoring_v2beta2 - cloudresourcemanager_v1 - compute_beta - compute_v1 - container_v1 - content_v2 - dataflow_v1b3 - dataproc_v1 - datastore_v1 - deploymentmanager_v2 - dfareporting_v2_8 - dns_v1 - doubleclicksearch_v2 - drive_v3 - firebasedynamiclinks_v1 - firebaserules_v1 - fitness_v1 - games_configuration_v1configuration - games_management_v1management - games_v1 - genomics_v1 - gmail_v1 - iam_v1 - identitytoolkit_v3 - language_v1 - logging_v2 - manufacturers_v1 - ml_v1 - monitoring_v3 - oauth2_v2 - partners_v2 - people_v1 - plus_domains_v1 - plus_v1 - proximitybeacon_v1beta1 - pubsub_v1 - runtimeconfig_v1 - script_v1 - searchconsole_v1 - servicecontrol_v1 - servicemanagement_v1 - serviceuser_v1 - sheets_v4 - slides_v1 - sourcerepo_v1 - spanner_v1 - sqladmin_v1beta4 - storage_v1 - storagetransfer_v1 - toolresults_v1beta3 - vision_v1 - webmasters_v3 - youtube_analytics_v1 - youtube_partner_v1 - youtubereporting_v1
2017-08-25 19:54:22 +00:00
# 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.
2017-07-12 20:10:42 +00:00
# @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.
# If this parameter is not specified, ATTRIBUTES and ISSUES are returned.
# This behavior is temporary and will be removed once all clients are ready
# or at the latest end of July 2018. After that no sections will be returned.
2017-07-12 20:10:42 +00:00
# @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
def get_account_product(parent, name, include: nil, fields: nil, quota_user: nil, options: nil, &block)
2017-07-12 20:10:42 +00:00
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?
2017-07-12 20:10:42 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
2017-03-10 21:11:09 +00:00
# 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.
# If this parameter is not specified, ATTRIBUTES and ISSUES are returned.
# This behavior is temporary and will be removed once all clients are ready
# or at the latest end of July 2018. After that no sections will be returned.
2017-03-10 21:11:09 +00:00
# @param [Fixnum] page_size
# Maximum number of product statuses to return in the response, used for
# paging.
Autogenerated update (2017-08-25) Add: - adexperiencereport_v1 - androiddeviceprovisioning_v1 - androidmanagement_v1 - bigquerydatatransfer_v1 - cloudtrace_v2 - clouduseraccounts_vm_alpha - consumersurveys_v2 - dlp_v2beta1 - oslogin_v1alpha - playcustomapp_v1 - playmoviespartner_v1 - safebrowsing_v4 - spectrum_v1explorer - speech_v1 - streetviewpublish_v1 - vault_v1 - videointelligence_v1beta1 Update: - acceleratedmobilepageurl_v1 - adexchangebuyer2_v2beta1 - adexchangebuyer_v1_4 - adsense_v1_4 - adsensehost_v4_1 - analytics_v3 - analyticsreporting_v4 - androidenterprise_v1 - androidpublisher_v2 - appengine_v1 - appsactivity_v1 - appstate_v1 - bigquery_v2 - calendar_v3 - classroom_v1 - cloudbilling_v1 - cloudbuild_v1 - clouddebugger_v2 - clouderrorreporting_v1beta1 - cloudfunctions_v1 - cloudkms_v1 - cloudmonitoring_v2beta2 - cloudresourcemanager_v1 - compute_beta - compute_v1 - container_v1 - content_v2 - dataflow_v1b3 - dataproc_v1 - datastore_v1 - deploymentmanager_v2 - dfareporting_v2_8 - dns_v1 - doubleclicksearch_v2 - drive_v3 - firebasedynamiclinks_v1 - firebaserules_v1 - fitness_v1 - games_configuration_v1configuration - games_management_v1management - games_v1 - genomics_v1 - gmail_v1 - iam_v1 - identitytoolkit_v3 - language_v1 - logging_v2 - manufacturers_v1 - ml_v1 - monitoring_v3 - oauth2_v2 - partners_v2 - people_v1 - plus_domains_v1 - plus_v1 - proximitybeacon_v1beta1 - pubsub_v1 - runtimeconfig_v1 - script_v1 - searchconsole_v1 - servicecontrol_v1 - servicemanagement_v1 - serviceuser_v1 - sheets_v4 - slides_v1 - sourcerepo_v1 - spanner_v1 - sqladmin_v1beta4 - storage_v1 - storagetransfer_v1 - toolresults_v1beta3 - vision_v1 - webmasters_v3 - youtube_analytics_v1 - youtube_partner_v1 - youtubereporting_v1
2017-08-25 19:54:22 +00:00
# @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
2017-03-10 21:11:09 +00:00
# @yieldparam result [Google::Apis::ManufacturersV1::ListProductsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
2017-03-10 21:11:09 +00:00
# @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
def list_account_products(parent, include: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2017-03-10 21:11:09 +00:00
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?
2017-03-27 22:14:47 +00:00
command.query['pageSize'] = page_size unless page_size.nil?
Autogenerated update (2017-08-25) Add: - adexperiencereport_v1 - androiddeviceprovisioning_v1 - androidmanagement_v1 - bigquerydatatransfer_v1 - cloudtrace_v2 - clouduseraccounts_vm_alpha - consumersurveys_v2 - dlp_v2beta1 - oslogin_v1alpha - playcustomapp_v1 - playmoviespartner_v1 - safebrowsing_v4 - spectrum_v1explorer - speech_v1 - streetviewpublish_v1 - vault_v1 - videointelligence_v1beta1 Update: - acceleratedmobilepageurl_v1 - adexchangebuyer2_v2beta1 - adexchangebuyer_v1_4 - adsense_v1_4 - adsensehost_v4_1 - analytics_v3 - analyticsreporting_v4 - androidenterprise_v1 - androidpublisher_v2 - appengine_v1 - appsactivity_v1 - appstate_v1 - bigquery_v2 - calendar_v3 - classroom_v1 - cloudbilling_v1 - cloudbuild_v1 - clouddebugger_v2 - clouderrorreporting_v1beta1 - cloudfunctions_v1 - cloudkms_v1 - cloudmonitoring_v2beta2 - cloudresourcemanager_v1 - compute_beta - compute_v1 - container_v1 - content_v2 - dataflow_v1b3 - dataproc_v1 - datastore_v1 - deploymentmanager_v2 - dfareporting_v2_8 - dns_v1 - doubleclicksearch_v2 - drive_v3 - firebasedynamiclinks_v1 - firebaserules_v1 - fitness_v1 - games_configuration_v1configuration - games_management_v1management - games_v1 - genomics_v1 - gmail_v1 - iam_v1 - identitytoolkit_v3 - language_v1 - logging_v2 - manufacturers_v1 - ml_v1 - monitoring_v3 - oauth2_v2 - partners_v2 - people_v1 - plus_domains_v1 - plus_v1 - proximitybeacon_v1beta1 - pubsub_v1 - runtimeconfig_v1 - script_v1 - searchconsole_v1 - servicecontrol_v1 - servicemanagement_v1 - serviceuser_v1 - sheets_v4 - slides_v1 - sourcerepo_v1 - spanner_v1 - sqladmin_v1beta4 - storage_v1 - storagetransfer_v1 - toolresults_v1beta3 - vision_v1 - webmasters_v3 - youtube_analytics_v1 - youtube_partner_v1 - youtubereporting_v1
2017-08-25 19:54:22 +00:00
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
# 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
2017-07-12 20:10:42 +00:00
# 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.
2017-03-10 21:11:09 +00:00
# @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
def update_account_product(parent, name, attributes_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2017-07-12 20:10:42 +00:00
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?
2017-03-10 21:11:09 +00:00
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
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end