v1.d.ts
35.3 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
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace poly_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* 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;
}
/**
* Poly API
*
* The Poly API provides read access to assets hosted on poly.google.com to all, and upload access to poly.google.com for whitelisted accounts.
*
* @example
* ```js
* const {google} = require('googleapis');
* const poly = google.poly('v1');
* ```
*/
export class Poly {
context: APIRequestContext;
assets: Resource$Assets;
users: Resource$Users;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Represents and describes an asset in the Poly library. An asset is a 3D model or scene created using [Tilt Brush](//www.tiltbrush.com), [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file that can be upload to Poly.
*/
export interface Schema$Asset {
/**
* The author's publicly visible name. Use this name when giving credit to the author. For more information, see [Licensing](/poly/discover/licensing).
*/
authorName?: string | null;
/**
* For published assets, the time when the asset was published. For unpublished assets, the time when the asset was created.
*/
createTime?: string | null;
/**
* The human-readable description, set by the asset's author.
*/
description?: string | null;
/**
* The human-readable name, set by the asset's author.
*/
displayName?: string | null;
/**
* A list of Formats where each format describes one representation of the asset.
*/
formats?: Schema$Format[];
/**
* Whether this asset has been curated by the Poly team.
*/
isCurated?: boolean | null;
/**
* The license under which the author has made the asset available for use, if any.
*/
license?: string | null;
/**
* Application-defined opaque metadata for this asset. This field is only returned when querying for the signed-in user's own assets, not for public assets. This string is limited to 1K chars. It is up to the creator of the asset to define the format for this string (for example, JSON).
*/
metadata?: string | null;
/**
* The unique identifier for the asset in the form: `assets/{ASSET_ID\}`.
*/
name?: string | null;
/**
* Hints for displaying the asset. Note that these parameters are not immutable; the author of an asset may change them post-publication.
*/
presentationParams?: Schema$PresentationParams;
/**
* The remix info for the asset.
*/
remixInfo?: Schema$RemixInfo;
/**
* The thumbnail image for the asset.
*/
thumbnail?: Schema$File;
/**
* The time when the asset was last modified. For published assets, whose contents are immutable, the update time changes only when metadata properties, such as visibility, are updated.
*/
updateTime?: string | null;
/**
* The visibility of the asset and who can access it.
*/
visibility?: string | null;
}
/**
* A message generated by the asset import process.
*/
export interface Schema$AssetImportMessage {
/**
* The code associated with this message.
*/
code?: string | null;
/**
* An optional file path. Only present for those error codes that specify it.
*/
filePath?: string | null;
/**
* An optional image error. Only present for INVALID_IMAGE_FILE.
*/
imageError?: Schema$ImageError;
/**
* An optional OBJ parse error. Only present for OBJ_PARSE_ERROR.
*/
objParseError?: Schema$ObjParseError;
}
/**
* Represents a file in Poly, which can be a root, resource, or thumbnail file.
*/
export interface Schema$File {
/**
* The MIME content-type, such as `image/png`. For more information, see [MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
*/
contentType?: string | null;
/**
* The path of the resource file relative to the root file. For root or thumbnail files, this is just the filename.
*/
relativePath?: string | null;
/**
* The URL where the file data can be retrieved.
*/
url?: string | null;
}
/**
* The same asset can be represented in different formats, for example, a [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its corresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file with its corresponding .glb binary data. A format refers to a specific representation of an asset and contains all information needed to retrieve and describe this representation.
*/
export interface Schema$Format {
/**
* Complexity stats about this representation of the asset.
*/
formatComplexity?: Schema$FormatComplexity;
/**
* A short string that identifies the format type of this representation. Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.
*/
formatType?: string | null;
/**
* A list of dependencies of the root element. May include, but is not limited to, materials, textures, and shader programs.
*/
resources?: Schema$File[];
/**
* The root of the file hierarchy. This will always be populated. For some format_types - such as `TILT`, which are self-contained - this is all of the data. Other types - such as `OBJ` - often reference other data elements. These are contained in the resources field.
*/
root?: Schema$File;
}
/**
* Information on the complexity of this Format.
*/
export interface Schema$FormatComplexity {
/**
* A non-negative integer that represents the level of detail (LOD) of this format relative to other formats of the same asset with the same format_type. This hint allows you to sort formats from the most-detailed (0) to least-detailed (integers greater than 0).
*/
lodHint?: number | null;
/**
* The estimated number of triangles.
*/
triangleCount?: string | null;
}
/**
* A message resulting from reading an image file.
*/
export interface Schema$ImageError {
/**
* The type of image error encountered. Optional for older image errors.
*/
code?: string | null;
/**
* The file path in the import of the image that was rejected.
*/
filePath?: string | null;
}
/**
* A response message from a request to list.
*/
export interface Schema$ListAssetsResponse {
/**
* A list of assets that match the criteria specified in the request.
*/
assets?: Schema$Asset[];
/**
* The continuation token for retrieving the next page. If empty, indicates that there are no more pages. To get the next page, submit the same request specifying this value as the page_token.
*/
nextPageToken?: string | null;
/**
* The total number of assets in the list, without pagination.
*/
totalSize?: number | null;
}
/**
* A response message from a request to list.
*/
export interface Schema$ListLikedAssetsResponse {
/**
* A list of assets that match the criteria specified in the request.
*/
assets?: Schema$Asset[];
/**
* The continuation token for retrieving the next page. If empty, indicates that there are no more pages. To get the next page, submit the same request specifying this value as the page_token.
*/
nextPageToken?: string | null;
/**
* The total number of assets in the list, without pagination.
*/
totalSize?: number | null;
}
/**
* A response message from a request to list.
*/
export interface Schema$ListUserAssetsResponse {
/**
* The continuation token for retrieving the next page. If empty, indicates that there are no more pages. To get the next page, submit the same request specifying this value as the page_token.
*/
nextPageToken?: string | null;
/**
* The total number of assets in the list, without pagination.
*/
totalSize?: number | null;
/**
* A list of UserAssets matching the request.
*/
userAssets?: Schema$UserAsset[];
}
/**
* Details of an error resulting from parsing an OBJ file
*/
export interface Schema$ObjParseError {
/**
* The type of problem found (required).
*/
code?: string | null;
/**
* The ending character index at which the problem was found.
*/
endIndex?: number | null;
/**
* The file path in which the problem was found.
*/
filePath?: string | null;
/**
* The text of the line. Note that this may be truncated if the line was very long. This may not include the error if it occurs after line truncation.
*/
line?: string | null;
/**
* Line number at which the problem was found.
*/
lineNumber?: number | null;
/**
* The starting character index at which the problem was found.
*/
startIndex?: number | null;
}
/**
* Hints for displaying the asset, based on information available when the asset was uploaded.
*/
export interface Schema$PresentationParams {
/**
* A background color which could be used for displaying the 3D asset in a 'thumbnail' or 'palette' style view. Authors have the option to set this background color when publishing or editing their asset. This is represented as a six-digit hexademical triplet specifying the RGB components of the background color, e.g. #FF0000 for Red.
*/
backgroundColor?: string | null;
/**
* The materials' diffuse/albedo color. This does not apply to vertex colors or texture maps.
*/
colorSpace?: string | null;
/**
* A rotation that should be applied to the object root to make it upright. More precisely, this quaternion transforms from "object space" (the space in which the object is defined) to "presentation space", a coordinate system where +Y is up, +X is right, -Z is forward. For example, if the object is the Eiffel Tower, in its local coordinate system the object might be laid out such that the base of the tower is on the YZ plane and the tip of the tower is towards positive X. In this case this quaternion would specify a rotation (of 90 degrees about the Z axis) such that in the presentation space the base of the tower is aligned with the XZ plane, and the tip of the tower lies towards +Y. This rotation is unrelated to the object's pose in the web preview, which is just a camera position setting and is *not* reflected in this rotation. Please note: this is applicable only to the gLTF.
*/
orientingRotation?: Schema$Quaternion;
}
/**
* A [Quaternion](//en.wikipedia.org/wiki/Quaternion). Please note: if in the response you see "w: 1" and nothing else this is the default value of [0, 0, 0, 1] where x,y, and z are 0.
*/
export interface Schema$Quaternion {
/**
* The scalar component.
*/
w?: number | null;
/**
* The x component.
*/
x?: number | null;
/**
* The y component.
*/
y?: number | null;
/**
* The z component.
*/
z?: number | null;
}
/**
* Info about the sources of this asset (i.e. assets that were remixed to create this asset).
*/
export interface Schema$RemixInfo {
/**
* Resource ids for the sources of this remix, of the form: `assets/{ASSET_ID\}`
*/
sourceAsset?: string[] | null;
}
/**
* A response message from a request to startImport. This is returned in the response field of the Operation.
*/
export interface Schema$StartAssetImportResponse {
/**
* The id of newly created asset. If this is empty when the operation is complete it means the import failed. Please refer to the assetImportMessages field to understand what went wrong.
*/
assetId?: string | null;
/**
* The id of the asset import.
*/
assetImportId?: string | null;
/**
* The message from the asset import. This will contain any warnings (or - in the case of failure - errors) that occurred during import.
*/
assetImportMessages?: Schema$AssetImportMessage[];
/**
* The publish URL for the asset.
*/
publishUrl?: string | null;
}
/**
* Data about the user's asset.
*/
export interface Schema$UserAsset {
/**
* An Asset.
*/
asset?: Schema$Asset;
}
export class Resource$Assets {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Returns detailed information about an asset given its name. PRIVATE assets are returned only if the currently authenticated user (via OAuth token) is the author of the asset.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/poly.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const poly = google.poly('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await poly.assets.get({
* // Required. An asset's name in the form `assets/{ASSET_ID\}`.
* name: 'assets/my-asset',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "authorName": "my_authorName",
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "formats": [],
* // "isCurated": false,
* // "license": "my_license",
* // "metadata": "my_metadata",
* // "name": "my_name",
* // "presentationParams": {},
* // "remixInfo": {},
* // "thumbnail": {},
* // "updateTime": "my_updateTime",
* // "visibility": "my_visibility"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Assets$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Assets$Get, options?: MethodOptions): GaxiosPromise<Schema$Asset>;
get(params: Params$Resource$Assets$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Assets$Get, options: MethodOptions | BodyResponseCallback<Schema$Asset>, callback: BodyResponseCallback<Schema$Asset>): void;
get(params: Params$Resource$Assets$Get, callback: BodyResponseCallback<Schema$Asset>): void;
get(callback: BodyResponseCallback<Schema$Asset>): void;
/**
* Lists all public, remixable assets. These are assets with an access level of PUBLIC and published under the CC-By license.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/poly.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const poly = google.poly('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await poly.assets.list({
* // Filter assets based on the specified category. Supported values are: `animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, `scenes`, `technology`, and `transport`.
* category: 'placeholder-value',
* // Return only assets that have been curated by the Poly team.
* curated: 'placeholder-value',
* // Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.
* format: 'placeholder-value',
* // One or more search terms to be matched against all text that Poly has indexed for assets, which includes display_name, description, and tags. Multiple keywords should be separated by spaces.
* keywords: 'placeholder-value',
* // Returns assets that are of the specified complexity or less. Defaults to COMPLEX. For example, a request for MEDIUM assets also includes SIMPLE assets.
* maxComplexity: 'placeholder-value',
* // Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets based on a combination of popularity and other features.
* orderBy: 'placeholder-value',
* // The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`.
* pageSize: 'placeholder-value',
* // Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "assets": [],
* // "nextPageToken": "my_nextPageToken",
* // "totalSize": 0
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Assets$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Assets$List, options?: MethodOptions): GaxiosPromise<Schema$ListAssetsResponse>;
list(params: Params$Resource$Assets$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Assets$List, options: MethodOptions | BodyResponseCallback<Schema$ListAssetsResponse>, callback: BodyResponseCallback<Schema$ListAssetsResponse>): void;
list(params: Params$Resource$Assets$List, callback: BodyResponseCallback<Schema$ListAssetsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAssetsResponse>): void;
}
export interface Params$Resource$Assets$Get extends StandardParameters {
/**
* Required. An asset's name in the form `assets/{ASSET_ID\}`.
*/
name?: string;
}
export interface Params$Resource$Assets$List extends StandardParameters {
/**
* Filter assets based on the specified category. Supported values are: `animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, `scenes`, `technology`, and `transport`.
*/
category?: string;
/**
* Return only assets that have been curated by the Poly team.
*/
curated?: boolean;
/**
* Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.
*/
format?: string;
/**
* One or more search terms to be matched against all text that Poly has indexed for assets, which includes display_name, description, and tags. Multiple keywords should be separated by spaces.
*/
keywords?: string;
/**
* Returns assets that are of the specified complexity or less. Defaults to COMPLEX. For example, a request for MEDIUM assets also includes SIMPLE assets.
*/
maxComplexity?: string;
/**
* Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets based on a combination of popularity and other features.
*/
orderBy?: string;
/**
* The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`.
*/
pageSize?: number;
/**
* Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token.
*/
pageToken?: string;
}
export class Resource$Users {
context: APIRequestContext;
assets: Resource$Users$Assets;
likedassets: Resource$Users$Likedassets;
constructor(context: APIRequestContext);
}
export class Resource$Users$Assets {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Lists assets authored by the given user. Only the value 'me', representing the currently-authenticated user, is supported. May include assets with an access level of PRIVATE or UNLISTED and assets which are All Rights Reserved for the currently-authenticated user.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/poly.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const poly = google.poly('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await poly.users.assets.list({
* // Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.
* format: 'placeholder-value',
* // A valid user id. Currently, only the special value 'me', representing the currently-authenticated user is supported. To use 'me', you must pass an OAuth token with the request.
* name: 'users/my-user',
* // Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets based on a combination of popularity and other features.
* orderBy: 'placeholder-value',
* // The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`.
* pageSize: 'placeholder-value',
* // Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token.
* pageToken: 'placeholder-value',
* // The visibility of the assets to be returned. Defaults to VISIBILITY_UNSPECIFIED which returns all assets.
* visibility: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "totalSize": 0,
* // "userAssets": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Users$Assets$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Users$Assets$List, options?: MethodOptions): GaxiosPromise<Schema$ListUserAssetsResponse>;
list(params: Params$Resource$Users$Assets$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Users$Assets$List, options: MethodOptions | BodyResponseCallback<Schema$ListUserAssetsResponse>, callback: BodyResponseCallback<Schema$ListUserAssetsResponse>): void;
list(params: Params$Resource$Users$Assets$List, callback: BodyResponseCallback<Schema$ListUserAssetsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListUserAssetsResponse>): void;
}
export interface Params$Resource$Users$Assets$List extends StandardParameters {
/**
* Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.
*/
format?: string;
/**
* A valid user id. Currently, only the special value 'me', representing the currently-authenticated user is supported. To use 'me', you must pass an OAuth token with the request.
*/
name?: string;
/**
* Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets based on a combination of popularity and other features.
*/
orderBy?: string;
/**
* The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`.
*/
pageSize?: number;
/**
* Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token.
*/
pageToken?: string;
/**
* The visibility of the assets to be returned. Defaults to VISIBILITY_UNSPECIFIED which returns all assets.
*/
visibility?: string;
}
export class Resource$Users$Likedassets {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Lists assets that the user has liked. Only the value 'me', representing the currently-authenticated user, is supported. May include assets with an access level of UNLISTED.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/poly.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const poly = google.poly('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await poly.users.likedassets.list({
* // Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.
* format: 'placeholder-value',
* // A valid user id. Currently, only the special value 'me', representing the currently-authenticated user is supported. To use 'me', you must pass an OAuth token with the request.
* name: 'users/my-user',
* // Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`, 'LIKED_TIME'. Defaults to `LIKED_TIME`, which ranks assets based on how recently they were liked.
* orderBy: 'placeholder-value',
* // The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`.
* pageSize: 'placeholder-value',
* // Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "assets": [],
* // "nextPageToken": "my_nextPageToken",
* // "totalSize": 0
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Users$Likedassets$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Users$Likedassets$List, options?: MethodOptions): GaxiosPromise<Schema$ListLikedAssetsResponse>;
list(params: Params$Resource$Users$Likedassets$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Users$Likedassets$List, options: MethodOptions | BodyResponseCallback<Schema$ListLikedAssetsResponse>, callback: BodyResponseCallback<Schema$ListLikedAssetsResponse>): void;
list(params: Params$Resource$Users$Likedassets$List, callback: BodyResponseCallback<Schema$ListLikedAssetsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListLikedAssetsResponse>): void;
}
export interface Params$Resource$Users$Likedassets$List extends StandardParameters {
/**
* Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.
*/
format?: string;
/**
* A valid user id. Currently, only the special value 'me', representing the currently-authenticated user is supported. To use 'me', you must pass an OAuth token with the request.
*/
name?: string;
/**
* Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`, 'LIKED_TIME'. Defaults to `LIKED_TIME`, which ranks assets based on how recently they were liked.
*/
orderBy?: string;
/**
* The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`.
*/
pageSize?: number;
/**
* Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token.
*/
pageToken?: string;
}
export {};
}