v1.d.ts
27.9 KB
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
/**
* Copyright 2019 Google LLC
*
* 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.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace manufacturers_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Manufacturer Center API
*
* Public API for managing Manufacturer Center related data.
*
* @example
* const {google} = require('googleapis');
* const manufacturers = google.manufacturers('v1');
*
* @namespace manufacturers
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Manufacturers
*/
export class Manufacturers {
context: APIRequestContext;
accounts: Resource$Accounts;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Attributes of the product. For more information, see https://support.google.com/manufacturers/answer/6124116.
*/
export interface Schema$Attributes {
/**
* The additional images of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#addlimage.
*/
additionalImageLink?: Schema$Image[];
/**
* The target age group of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#agegroup.
*/
ageGroup?: string | null;
/**
* The brand name of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#brand.
*/
brand?: string | null;
/**
* The capacity of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#capacity.
*/
capacity?: Schema$Capacity;
/**
* The color of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#color.
*/
color?: string | null;
/**
* The count of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#count.
*/
count?: Schema$Count;
/**
* The description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#description.
*/
description?: string | null;
/**
* The disclosure date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#disclosure.
*/
disclosureDate?: string | null;
/**
* A list of excluded destinations.
*/
excludedDestination?: string[] | null;
/**
* The rich format description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#featuredesc.
*/
featureDescription?: Schema$FeatureDescription[];
/**
* The flavor of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#flavor.
*/
flavor?: string | null;
/**
* The format of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#format.
*/
format?: string | null;
/**
* The target gender of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#gender.
*/
gender?: string | null;
/**
* The Global Trade Item Number (GTIN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#gtin.
*/
gtin?: string[] | null;
/**
* The image of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#image.
*/
imageLink?: Schema$Image;
/**
* A list of included destinations.
*/
includedDestination?: string[] | null;
/**
* The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid.
*/
itemGroupId?: string | null;
/**
* The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material.
*/
material?: string | null;
/**
* The Manufacturer Part Number (MPN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#mpn.
*/
mpn?: string | null;
/**
* The pattern of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#pattern.
*/
pattern?: string | null;
/**
* The details of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail.
*/
productDetail?: Schema$ProductDetail[];
/**
* The name of the group of products related to the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productline.
*/
productLine?: string | null;
/**
* The canonical name of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productname.
*/
productName?: string | null;
/**
* The URL of the detail page of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productpage.
*/
productPageUrl?: string | null;
/**
* The type or category of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#producttype.
*/
productType?: string[] | null;
/**
* The release date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#release.
*/
releaseDate?: string | null;
/**
* The scent of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#scent.
*/
scent?: string | null;
/**
* The size of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#size.
*/
size?: string | null;
/**
* The size system of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#sizesystem.
*/
sizeSystem?: string | null;
/**
* The size type of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#sizetype.
*/
sizeType?: string | null;
/**
* The suggested retail price (MSRP) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#price.
*/
suggestedRetailPrice?: Schema$Price;
/**
* The target client id. Should only be used in the accounts of the data partners.
*/
targetClientId?: string | null;
/**
* The theme of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#theme.
*/
theme?: string | null;
/**
* The title of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#title.
*/
title?: string | null;
/**
* The videos of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#video.
*/
videoLink?: string[] | null;
}
/**
* The capacity of a product. For more information, see https://support.google.com/manufacturers/answer/6124116#capacity.
*/
export interface Schema$Capacity {
/**
* The unit of the capacity, i.e., MB, GB, or TB.
*/
unit?: string | null;
/**
* The numeric value of the capacity.
*/
value?: string | null;
}
/**
* The number of products in a single package. For more information, see https://support.google.com/manufacturers/answer/6124116#count.
*/
export interface Schema$Count {
/**
* The unit in which these products are counted.
*/
unit?: string | null;
/**
* The numeric value of the number of products in a package.
*/
value?: string | null;
}
/**
* The destination status.
*/
export interface Schema$DestinationStatus {
/**
* The name of the destination.
*/
destination?: string | null;
/**
* The status of the destination.
*/
status?: string | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {
}
/**
* A feature description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#featuredesc.
*/
export interface Schema$FeatureDescription {
/**
* A short description of the feature.
*/
headline?: string | null;
/**
* An optional image describing the feature.
*/
image?: Schema$Image;
/**
* A detailed description of the feature.
*/
text?: string | null;
}
/**
* An image.
*/
export interface Schema$Image {
/**
* The URL of the image. For crawled images, this is the provided URL. For uploaded images, this is a serving URL from Google if the image has been processed successfully.
*/
imageUrl?: string | null;
/**
* The status of the image. @OutputOnly
*/
status?: string | null;
/**
* The type of the image, i.e., crawled or uploaded. @OutputOnly
*/
type?: string | null;
}
/**
* Product issue.
*/
export interface Schema$Issue {
/**
* If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116.
*/
attribute?: string | null;
/**
* Longer description of the issue focused on how to resolve it.
*/
description?: string | null;
/**
* The destination this issue applies to.
*/
destination?: string | null;
/**
* What needs to happen to resolve the issue.
*/
resolution?: string | null;
/**
* The severity of the issue.
*/
severity?: string | null;
/**
* The timestamp when this issue appeared.
*/
timestamp?: string | null;
/**
* Short title describing the nature of the issue.
*/
title?: string | null;
/**
* The server-generated type of the issue, for example, “INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.
*/
type?: string | null;
}
export interface Schema$ListProductsResponse {
/**
* The token for the retrieval of the next page of product statuses.
*/
nextPageToken?: string | null;
/**
* List of the products.
*/
products?: Schema$Product[];
}
/**
* A price.
*/
export interface Schema$Price {
/**
* The numeric value of the price.
*/
amount?: string | null;
/**
* The currency in which the price is denoted.
*/
currency?: string | null;
}
/**
* Product data.
*/
export interface Schema$Product {
/**
* Attributes of the product uploaded to the Manufacturer Center. Manually edited attributes are taken into account.
*/
attributes?: Schema$Attributes;
/**
* The content language of the product as a two-letter ISO 639-1 language code (for example, en).
*/
contentLanguage?: string | null;
/**
* The status of the destinations.
*/
destinationStatuses?: Schema$DestinationStatus[];
/**
* A server-generated list of issues associated with the product.
*/
issues?: Schema$Issue[];
/**
* 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.
*/
name?: string | null;
/**
* Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.
*/
parent?: string | null;
/**
* The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.
*/
productId?: string | null;
/**
* The target country of the product as a CLDR territory code (for example, US).
*/
targetCountry?: string | null;
}
/**
* A product detail of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail.
*/
export interface Schema$ProductDetail {
/**
* The name of the attribute.
*/
attributeName?: string | null;
/**
* The value of the attribute.
*/
attributeValue?: string | null;
/**
* A short section name that can be reused between multiple product details.
*/
sectionName?: string | null;
}
export class Resource$Accounts {
context: APIRequestContext;
products: Resource$Accounts$Products;
constructor(context: APIRequestContext);
}
export class Resource$Accounts$Products {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* manufacturers.accounts.products.delete
* @desc Deletes the product from a Manufacturer Center account.
* @alias manufacturers.accounts.products.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.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} params.parent Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Accounts$Products$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Accounts$Products$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Accounts$Products$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* manufacturers.accounts.products.get
* @desc 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.
* @alias manufacturers.accounts.products.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.include The information to be included in the response. Only sections listed here will be returned.
* @param {string} params.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} params.parent Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Accounts$Products$Get, options?: MethodOptions): GaxiosPromise<Schema$Product>;
get(params: Params$Resource$Accounts$Products$Get, options: MethodOptions | BodyResponseCallback<Schema$Product>, callback: BodyResponseCallback<Schema$Product>): void;
get(params: Params$Resource$Accounts$Products$Get, callback: BodyResponseCallback<Schema$Product>): void;
get(callback: BodyResponseCallback<Schema$Product>): void;
/**
* manufacturers.accounts.products.list
* @desc Lists all the products in a Manufacturer Center account.
* @alias manufacturers.accounts.products.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.include The information to be included in the response. Only sections listed here will be returned.
* @param {integer=} params.pageSize Maximum number of product statuses to return in the response, used for paging.
* @param {string=} params.pageToken The token returned by the previous request.
* @param {string} params.parent Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Accounts$Products$List, options?: MethodOptions): GaxiosPromise<Schema$ListProductsResponse>;
list(params: Params$Resource$Accounts$Products$List, options: MethodOptions | BodyResponseCallback<Schema$ListProductsResponse>, callback: BodyResponseCallback<Schema$ListProductsResponse>): void;
list(params: Params$Resource$Accounts$Products$List, callback: BodyResponseCallback<Schema$ListProductsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListProductsResponse>): void;
/**
* manufacturers.accounts.products.update
* @desc 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.
* @alias manufacturers.accounts.products.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.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} params.parent Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.
* @param {().Attributes} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Accounts$Products$Update, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
update(params: Params$Resource$Accounts$Products$Update, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
update(params: Params$Resource$Accounts$Products$Update, callback: BodyResponseCallback<Schema$Empty>): void;
update(callback: BodyResponseCallback<Schema$Empty>): void;
}
export interface Params$Resource$Accounts$Products$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* 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.
*/
name?: string;
/**
* Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.
*/
parent?: string;
}
export interface Params$Resource$Accounts$Products$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The information to be included in the response. Only sections listed here will be returned.
*/
include?: 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.
*/
name?: string;
/**
* Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.
*/
parent?: string;
}
export interface Params$Resource$Accounts$Products$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The information to be included in the response. Only sections listed here will be returned.
*/
include?: string[];
/**
* Maximum number of product statuses to return in the response, used for paging.
*/
pageSize?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
/**
* Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.
*/
parent?: string;
}
export interface Params$Resource$Accounts$Products$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* 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.
*/
name?: string;
/**
* Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Attributes;
}
export {};
}