1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
|
# 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/', '')
@batch_path = 'batch'
end
# 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.
# 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
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
# 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
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
# 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
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
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
|