v2.d.ts
44.4 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
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
/**
* 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 { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace youtubeAnalytics_v2 {
interface Options extends GlobalOptions {
version: 'v2';
}
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;
}
/**
* YouTube Analytics API
*
* Retrieves your YouTube Analytics data.
*
* @example
* const {google} = require('googleapis');
* const youtubeAnalytics = google.youtubeAnalytics('v2');
*
* @namespace youtubeAnalytics
* @type {Function}
* @version v2
* @variation v2
* @param {object=} options Options for Youtubeanalytics
*/
class Youtubeanalytics {
context: APIRequestContext;
groupItems: Resource$Groupitems;
groups: Resource$Groups;
reports: Resource$Reports;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Empty response.
*/
interface Schema$EmptyResponse {
/**
* Apiary error details
*/
errors?: Schema$Errors;
}
/**
* Describes one specific error.
*/
interface Schema$ErrorProto {
/**
* Error arguments, to be used when building user-friendly error messages
* given the error domain and code. Different error codes require different
* arguments.
*/
argument?: string[];
/**
* Error code in the error domain. This should correspond to a value of the
* enum type whose name is in domain. See the core error domain in
* error_domain.proto.
*/
code?: string;
/**
* Debugging information, which should not be shared externally.
*/
debugInfo?: string;
/**
* Error domain. RoSy services can define their own domain and error codes.
* This should normally be the name of an enum type, such as:
* gdata.CoreErrorDomain
*/
domain?: string;
/**
* A short explanation for the error, which can be shared outside Google.
* Please set domain, code and arguments whenever possible instead of this
* error message so that external APIs can build safe error messages
* themselves. External messages built in a RoSy interface will most likely
* refer to information and concepts that are not available externally and
* should not be exposed. It is safer if external APIs can understand the
* errors and decide what the error message should look like.
*/
externalErrorMessage?: string;
/**
* Location of the error, as specified by the location type. If
* location_type is PATH, this should be a path to a field that's
* relative to the request, using FieldPath notation
* (net/proto2/util/public/field_path.h). Examples:
* authenticated_user.gaia_id resource.address[2].country
*/
location?: string;
locationType?: string;
}
/**
* Request Error information. The presence of an error field signals that the
* operation has failed.
*/
interface Schema$Errors {
/**
* Global error code. Deprecated and ignored. Set custom error codes in
* ErrorProto.domain and ErrorProto.code instead.
*/
code?: string;
/**
* Specific error description and codes
*/
error?: Schema$ErrorProto[];
/**
* Request identifier generated by the service, which can be used to
* identify the error in the logs
*/
requestId?: string;
}
/**
* A group.
*/
interface Schema$Group {
/**
* The `contentDetails` object contains additional information about the
* group, such as the number and type of items that it contains.
*/
contentDetails?: Schema$GroupContentDetails;
/**
* Apiary error details
*/
errors?: Schema$Errors;
/**
* The Etag of this resource.
*/
etag?: string;
/**
* The ID that YouTube uses to uniquely identify the group.
*/
id?: string;
/**
* Identifies the API resource's type. The value will be
* `youtube#group`.
*/
kind?: string;
/**
* The `snippet` object contains basic information about the group,
* including its creation date and name.
*/
snippet?: Schema$GroupSnippet;
}
/**
* A group's content details.
*/
interface Schema$GroupContentDetails {
/**
* The number of items in the group.
*/
itemCount?: string;
/**
* The type of resources that the group contains. Valid values for this
* property are: * `youtube#channel` * `youtube#playlist` *
* `youtube#video` * `youtubePartner#asset`
*/
itemType?: string;
}
/**
* A group item.
*/
interface Schema$GroupItem {
/**
* Apiary error details
*/
errors?: Schema$Errors;
/**
* The Etag of this resource.
*/
etag?: string;
/**
* The ID that YouTube uses to uniquely identify the group that contains the
* item.
*/
groupId?: string;
/**
* The ID that YouTube uses to uniquely identify the `channel`, `video`,
* `playlist`, or `asset` resource that is included in the group. Note that
* this ID refers specifically to the inclusion of that resource in a
* particular group and is different than the channel ID, video ID, playlist
* ID, or asset ID that uniquely identifies the resource itself. The
* `resource.id` property's value specifies the unique channel, video,
* playlist, or asset ID.
*/
id?: string;
/**
* Identifies the API resource's type. The value will be
* `youtube#groupItem`.
*/
kind?: string;
/**
* The `resource` object contains information that identifies the item being
* added to the group.
*/
resource?: Schema$GroupItemResource;
}
interface Schema$GroupItemResource {
/**
* The channel, video, playlist, or asset ID that YouTube uses to uniquely
* identify the item that is being added to the group.
*/
id?: string;
/**
* Identifies the type of resource being added to the group. Valid values
* for this property are: * `youtube#channel` * `youtube#playlist` *
* `youtube#video` * `youtubePartner#asset`
*/
kind?: string;
}
/**
* A group snippet.
*/
interface Schema$GroupSnippet {
/**
* The date and time that the group was created. The value is specified in
* ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
*/
publishedAt?: string;
/**
* The group name. The value must be a non-empty string.
*/
title?: string;
}
/**
* Response message for GroupsService.ListGroupItems.
*/
interface Schema$ListGroupItemsResponse {
/**
* Apiary error details
*/
errors?: Schema$Errors;
/**
* The Etag of this resource.
*/
etag?: string;
/**
* A list of groups that match the API request parameters. Each item in the
* list represents a `groupItem` resource.
*/
items?: Schema$GroupItem[];
/**
* Identifies the API resource's type. The value will be
* `youtube#groupItemListResponse`.
*/
kind?: string;
}
/**
* Response message for GroupsService.ListGroups.
*/
interface Schema$ListGroupsResponse {
/**
* Apiary error details
*/
errors?: Schema$Errors;
/**
* The Etag of this resource.
*/
etag?: string;
/**
* A list of groups that match the API request parameters. Each item in the
* list represents a `group` resource.
*/
items?: Schema$Group[];
/**
* Identifies the API resource's type. The value will be
* `youtube#groupListResponse`.
*/
kind?: string;
/**
* The token that can be used as the value of the `pageToken` parameter to
* retrieve the next page in the result set.
*/
nextPageToken?: string;
}
/**
* Response message for TargetedQueriesService.Query.
*/
interface Schema$QueryResponse {
/**
* This value specifies information about the data returned in the `rows`
* fields. Each item in the `columnHeaders` list identifies a field returned
* in the `rows` value, which contains a list of comma-delimited data. The
* `columnHeaders` list will begin with the dimensions specified in the API
* request, which will be followed by the metrics specified in the API
* request. The order of both dimensions and metrics will match the ordering
* in the API request. For example, if the API request contains the
* parameters `dimensions=ageGroup,gender&metrics=viewerPercentage`, the
* API response will return columns in this order: `ageGroup`, `gender`,
* `viewerPercentage`.
*/
columnHeaders?: Schema$ResultTableColumnHeader[];
/**
* When set, indicates that the operation failed.
*/
errors?: Schema$Errors;
/**
* This value specifies the type of data included in the API response. For
* the query method, the kind property value will be
* `youtubeAnalytics#resultTable`.
*/
kind?: string;
/**
* The list contains all rows of the result table. Each item in the list is
* an array that contains comma-delimited data corresponding to a single row
* of data. The order of the comma-delimited data fields will match the
* order of the columns listed in the `columnHeaders` field. If no data is
* available for the given query, the `rows` element will be omitted from
* the response. The response for a query with the `day` dimension will not
* contain rows for the most recent days.
*/
rows?: any[][];
}
/**
* The description of a column of the result table.
*/
interface Schema$ResultTableColumnHeader {
/**
* The type of the column (`DIMENSION` or `METRIC`).
*/
columnType?: string;
/**
* The type of the data in the column (`STRING`, `INTEGER`, `FLOAT`, etc.).
*/
dataType?: string;
/**
* The name of the dimension or metric.
*/
name?: string;
}
class Resource$Groupitems {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* youtubeAnalytics.groupItems.delete
* @desc Removes an item from a group.
* @alias youtubeAnalytics.groupItems.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.id The `id` parameter specifies the YouTube group item ID of the group item that is being deleted.
* @param {string=} params.onBehalfOfContentOwner This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.
* @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$Groupitems$Delete, options?: MethodOptions): GaxiosPromise<Schema$EmptyResponse>;
delete(params: Params$Resource$Groupitems$Delete, options: MethodOptions | BodyResponseCallback<Schema$EmptyResponse>, callback: BodyResponseCallback<Schema$EmptyResponse>): void;
delete(params: Params$Resource$Groupitems$Delete, callback: BodyResponseCallback<Schema$EmptyResponse>): void;
delete(callback: BodyResponseCallback<Schema$EmptyResponse>): void;
/**
* youtubeAnalytics.groupItems.insert
* @desc Creates a group item.
* @alias youtubeAnalytics.groupItems.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.onBehalfOfContentOwner This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.
* @param {().GroupItem} 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
*/
insert(params?: Params$Resource$Groupitems$Insert, options?: MethodOptions): GaxiosPromise<Schema$GroupItem>;
insert(params: Params$Resource$Groupitems$Insert, options: MethodOptions | BodyResponseCallback<Schema$GroupItem>, callback: BodyResponseCallback<Schema$GroupItem>): void;
insert(params: Params$Resource$Groupitems$Insert, callback: BodyResponseCallback<Schema$GroupItem>): void;
insert(callback: BodyResponseCallback<Schema$GroupItem>): void;
/**
* youtubeAnalytics.groupItems.list
* @desc Returns a collection of group items that match the API request
* parameters.
* @alias youtubeAnalytics.groupItems.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.groupId The `groupId` parameter specifies the unique ID of the group for which you want to retrieve group items.
* @param {string=} params.onBehalfOfContentOwner This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.
* @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$Groupitems$List, options?: MethodOptions): GaxiosPromise<Schema$ListGroupItemsResponse>;
list(params: Params$Resource$Groupitems$List, options: MethodOptions | BodyResponseCallback<Schema$ListGroupItemsResponse>, callback: BodyResponseCallback<Schema$ListGroupItemsResponse>): void;
list(params: Params$Resource$Groupitems$List, callback: BodyResponseCallback<Schema$ListGroupItemsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListGroupItemsResponse>): void;
}
interface Params$Resource$Groupitems$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The `id` parameter specifies the YouTube group item ID of the group item
* that is being deleted.
*/
id?: string;
/**
* This parameter can only be used in a properly authorized request.
* **Note:** This parameter is intended exclusively for YouTube content
* partners that own and manage many different YouTube channels. The
* `onBehalfOfContentOwner` parameter indicates that the request's
* authorization credentials identify a YouTube user who is acting on behalf
* of the content owner specified in the parameter value. It allows content
* owners to authenticate once and get access to all their video and channel
* data, without having to provide authentication credentials for each
* individual channel. The account that the user authenticates with must be
* linked to the specified YouTube content owner.
*/
onBehalfOfContentOwner?: string;
}
interface Params$Resource$Groupitems$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* This parameter can only be used in a properly authorized request.
* **Note:** This parameter is intended exclusively for YouTube content
* partners that own and manage many different YouTube channels. The
* `onBehalfOfContentOwner` parameter indicates that the request's
* authorization credentials identify a YouTube user who is acting on behalf
* of the content owner specified in the parameter value. It allows content
* owners to authenticate once and get access to all their video and channel
* data, without having to provide authentication credentials for each
* individual channel. The account that the user authenticates with must be
* linked to the specified YouTube content owner.
*/
onBehalfOfContentOwner?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GroupItem;
}
interface Params$Resource$Groupitems$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The `groupId` parameter specifies the unique ID of the group for which
* you want to retrieve group items.
*/
groupId?: string;
/**
* This parameter can only be used in a properly authorized request.
* **Note:** This parameter is intended exclusively for YouTube content
* partners that own and manage many different YouTube channels. The
* `onBehalfOfContentOwner` parameter indicates that the request's
* authorization credentials identify a YouTube user who is acting on behalf
* of the content owner specified in the parameter value. It allows content
* owners to authenticate once and get access to all their video and channel
* data, without having to provide authentication credentials for each
* individual channel. The account that the user authenticates with must be
* linked to the specified YouTube content owner.
*/
onBehalfOfContentOwner?: string;
}
class Resource$Groups {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* youtubeAnalytics.groups.delete
* @desc Deletes a group.
* @alias youtubeAnalytics.groups.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.id The `id` parameter specifies the YouTube group ID of the group that is being deleted.
* @param {string=} params.onBehalfOfContentOwner This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.
* @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$Groups$Delete, options?: MethodOptions): GaxiosPromise<Schema$EmptyResponse>;
delete(params: Params$Resource$Groups$Delete, options: MethodOptions | BodyResponseCallback<Schema$EmptyResponse>, callback: BodyResponseCallback<Schema$EmptyResponse>): void;
delete(params: Params$Resource$Groups$Delete, callback: BodyResponseCallback<Schema$EmptyResponse>): void;
delete(callback: BodyResponseCallback<Schema$EmptyResponse>): void;
/**
* youtubeAnalytics.groups.insert
* @desc Creates a group.
* @alias youtubeAnalytics.groups.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.onBehalfOfContentOwner This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.
* @param {().Group} 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
*/
insert(params?: Params$Resource$Groups$Insert, options?: MethodOptions): GaxiosPromise<Schema$Group>;
insert(params: Params$Resource$Groups$Insert, options: MethodOptions | BodyResponseCallback<Schema$Group>, callback: BodyResponseCallback<Schema$Group>): void;
insert(params: Params$Resource$Groups$Insert, callback: BodyResponseCallback<Schema$Group>): void;
insert(callback: BodyResponseCallback<Schema$Group>): void;
/**
* youtubeAnalytics.groups.list
* @desc Returns a collection of groups that match the API request
* parameters. For example, you can retrieve all groups that the
* authenticated user owns, or you can retrieve one or more groups by their
* unique IDs.
* @alias youtubeAnalytics.groups.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.id The `id` parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. Each group must be owned by the authenticated user. In a `group` resource, the `id` property specifies the group's YouTube group ID. Note that if you do not specify a value for the `id` parameter, then you must set the `mine` parameter to `true`.
* @param {boolean=} params.mine This parameter can only be used in a properly authorized request. Set this parameter's value to true to retrieve all groups owned by the authenticated user.
* @param {string=} params.onBehalfOfContentOwner This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.
* @param {string=} params.pageToken The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies the next page that can be retrieved.
* @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$Groups$List, options?: MethodOptions): GaxiosPromise<Schema$ListGroupsResponse>;
list(params: Params$Resource$Groups$List, options: MethodOptions | BodyResponseCallback<Schema$ListGroupsResponse>, callback: BodyResponseCallback<Schema$ListGroupsResponse>): void;
list(params: Params$Resource$Groups$List, callback: BodyResponseCallback<Schema$ListGroupsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListGroupsResponse>): void;
/**
* youtubeAnalytics.groups.update
* @desc Modifies a group. For example, you could change a group's title.
* @alias youtubeAnalytics.groups.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.onBehalfOfContentOwner This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.
* @param {().Group} 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$Groups$Update, options?: MethodOptions): GaxiosPromise<Schema$Group>;
update(params: Params$Resource$Groups$Update, options: MethodOptions | BodyResponseCallback<Schema$Group>, callback: BodyResponseCallback<Schema$Group>): void;
update(params: Params$Resource$Groups$Update, callback: BodyResponseCallback<Schema$Group>): void;
update(callback: BodyResponseCallback<Schema$Group>): void;
}
interface Params$Resource$Groups$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The `id` parameter specifies the YouTube group ID of the group that is
* being deleted.
*/
id?: string;
/**
* This parameter can only be used in a properly authorized request.
* **Note:** This parameter is intended exclusively for YouTube content
* partners that own and manage many different YouTube channels. The
* `onBehalfOfContentOwner` parameter indicates that the request's
* authorization credentials identify a YouTube user who is acting on behalf
* of the content owner specified in the parameter value. It allows content
* owners to authenticate once and get access to all their video and channel
* data, without having to provide authentication credentials for each
* individual channel. The account that the user authenticates with must be
* linked to the specified YouTube content owner.
*/
onBehalfOfContentOwner?: string;
}
interface Params$Resource$Groups$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* This parameter can only be used in a properly authorized request.
* **Note:** This parameter is intended exclusively for YouTube content
* partners that own and manage many different YouTube channels. The
* `onBehalfOfContentOwner` parameter indicates that the request's
* authorization credentials identify a YouTube user who is acting on behalf
* of the content owner specified in the parameter value. It allows content
* owners to authenticate once and get access to all their video and channel
* data, without having to provide authentication credentials for each
* individual channel. The account that the user authenticates with must be
* linked to the specified YouTube content owner.
*/
onBehalfOfContentOwner?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Group;
}
interface Params$Resource$Groups$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The `id` parameter specifies a comma-separated list of the YouTube group
* ID(s) for the resource(s) that are being retrieved. Each group must be
* owned by the authenticated user. In a `group` resource, the `id` property
* specifies the group's YouTube group ID. Note that if you do not specify
* a value for the `id` parameter, then you must set the `mine` parameter to
* `true`.
*/
id?: string;
/**
* This parameter can only be used in a properly authorized request. Set
* this parameter's value to true to retrieve all groups owned by the
* authenticated user.
*/
mine?: boolean;
/**
* This parameter can only be used in a properly authorized request.
* **Note:** This parameter is intended exclusively for YouTube content
* partners that own and manage many different YouTube channels. The
* `onBehalfOfContentOwner` parameter indicates that the request's
* authorization credentials identify a YouTube user who is acting on behalf
* of the content owner specified in the parameter value. It allows content
* owners to authenticate once and get access to all their video and channel
* data, without having to provide authentication credentials for each
* individual channel. The account that the user authenticates with must be
* linked to the specified YouTube content owner.
*/
onBehalfOfContentOwner?: string;
/**
* The `pageToken` parameter identifies a specific page in the result set
* that should be returned. In an API response, the `nextPageToken` property
* identifies the next page that can be retrieved.
*/
pageToken?: string;
}
interface Params$Resource$Groups$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* This parameter can only be used in a properly authorized request.
* **Note:** This parameter is intended exclusively for YouTube content
* partners that own and manage many different YouTube channels. The
* `onBehalfOfContentOwner` parameter indicates that the request's
* authorization credentials identify a YouTube user who is acting on behalf
* of the content owner specified in the parameter value. It allows content
* owners to authenticate once and get access to all their video and channel
* data, without having to provide authentication credentials for each
* individual channel. The account that the user authenticates with must be
* linked to the specified YouTube content owner.
*/
onBehalfOfContentOwner?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Group;
}
class Resource$Reports {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* youtubeAnalytics.reports.query
* @desc Retrieve your YouTube Analytics reports.
* @alias youtubeAnalytics.reports.query
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.currency The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized.", pattern: [A-Z]{3}
* @param {string=} params.dimensions A comma-separated list of YouTube Analytics dimensions, such as `views` or `ageGroup,gender`. See the [Available Reports](/youtube/analytics/v2/available_reports) document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the [Dimensions](/youtube/analytics/v2/dimsmets/dims) document for definitions of those dimensions." pattern: [0-9a-zA-Z,]+
* @param {string=} params.endDate The end date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. required: true, pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}
* @param {string=} params.filters A list of filters that should be applied when retrieving YouTube Analytics data. The [Available Reports](/youtube/analytics/v2/available_reports) document identifies the dimensions that can be used to filter each report, and the [Dimensions](/youtube/analytics/v2/dimsmets/dims) document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (`;`), and the returned result table will satisfy both filters. For example, a filters parameter value of `video==dMH0bHeiRNg;country==IT` restricts the result set to include data for the given video in Italy.",
* @param {string=} params.ids Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the `ids` parameter value to `channel==CHANNEL_ID`, where `CHANNEL_ID` specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the `ids` parameter value to `contentOwner==OWNER_NAME`, where `OWNER_NAME` is the CMS name of the content owner. required: true, pattern: [a-zA-Z]+==[a-zA-Z0-9_+-]+
* @param {boolean=} params.includeHistoricalChannelData If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved.",
* @param {integer=} params.maxResults The maximum number of rows to include in the response.", minValue: 1
* @param {string=} params.metrics A comma-separated list of YouTube Analytics metrics, such as `views` or `likes,dislikes`. See the [Available Reports](/youtube/analytics/v2/available_reports) document for a list of the reports that you can retrieve and the metrics available in each report, and see the [Metrics](/youtube/analytics/v2/dimsmets/mets) document for definitions of those metrics. required: true, pattern: [0-9a-zA-Z,]+
* @param {string=} params.sort A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '`-`' prefix causes descending sort order.", pattern: [-0-9a-zA-Z,]+
* @param {string=} params.startDate The start date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. required: true, pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2}
* @param {integer=} params.startIndex An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).", minValue: 1
* @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
*/
query(params?: Params$Resource$Reports$Query, options?: MethodOptions): GaxiosPromise<Schema$QueryResponse>;
query(params: Params$Resource$Reports$Query, options: MethodOptions | BodyResponseCallback<Schema$QueryResponse>, callback: BodyResponseCallback<Schema$QueryResponse>): void;
query(params: Params$Resource$Reports$Query, callback: BodyResponseCallback<Schema$QueryResponse>): void;
query(callback: BodyResponseCallback<Schema$QueryResponse>): void;
}
interface Params$Resource$Reports$Query extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The currency to which financial metrics should be converted. The default
* is US Dollar (USD). If the result contains no financial metrics, this
* flag will be ignored. Responds with an error if the specified currency is
* not recognized.", pattern: [A-Z]{3}
*/
currency?: string;
/**
* A comma-separated list of YouTube Analytics dimensions, such as `views`
* or `ageGroup,gender`. See the [Available
* Reports](/youtube/analytics/v2/available_reports) document for a list of
* the reports that you can retrieve and the dimensions used for those
* reports. Also see the [Dimensions](/youtube/analytics/v2/dimsmets/dims)
* document for definitions of those dimensions." pattern: [0-9a-zA-Z,]+
*/
dimensions?: string;
/**
* The end date for fetching YouTube Analytics data. The value should be in
* `YYYY-MM-DD` format. required: true, pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}
*/
endDate?: string;
/**
* A list of filters that should be applied when retrieving YouTube
* Analytics data. The [Available
* Reports](/youtube/analytics/v2/available_reports) document identifies the
* dimensions that can be used to filter each report, and the
* [Dimensions](/youtube/analytics/v2/dimsmets/dims) document defines those
* dimensions. If a request uses multiple filters, join them together with a
* semicolon (`;`), and the returned result table will satisfy both filters.
* For example, a filters parameter value of
* `video==dMH0bHeiRNg;country==IT` restricts the result set to include data
* for the given video in Italy.",
*/
filters?: string;
/**
* Identifies the YouTube channel or content owner for which you are
* retrieving YouTube Analytics data. - To request data for a YouTube user,
* set the `ids` parameter value to `channel==CHANNEL_ID`, where
* `CHANNEL_ID` specifies the unique YouTube channel ID. - To request data
* for a YouTube CMS content owner, set the `ids` parameter value to
* `contentOwner==OWNER_NAME`, where `OWNER_NAME` is the CMS name of the
* content owner. required: true, pattern: [a-zA-Z]+==[a-zA-Z0-9_+-]+
*/
ids?: string;
/**
* If set to true historical data (i.e. channel data from before the linking
* of the channel to the content owner) will be retrieved.",
*/
includeHistoricalChannelData?: boolean;
/**
* The maximum number of rows to include in the response.", minValue: 1
*/
maxResults?: number;
/**
* A comma-separated list of YouTube Analytics metrics, such as `views` or
* `likes,dislikes`. See the [Available
* Reports](/youtube/analytics/v2/available_reports) document for a list of
* the reports that you can retrieve and the metrics available in each
* report, and see the [Metrics](/youtube/analytics/v2/dimsmets/mets)
* document for definitions of those metrics. required: true, pattern:
* [0-9a-zA-Z,]+
*/
metrics?: string;
/**
* A comma-separated list of dimensions or metrics that determine the sort
* order for YouTube Analytics data. By default the sort order is ascending.
* The '`-`' prefix causes descending sort order.", pattern: [-0-9a-zA-Z,]+
*/
sort?: string;
/**
* The start date for fetching YouTube Analytics data. The value should be
* in `YYYY-MM-DD` format. required: true, pattern:
* "[0-9]{4}-[0-9]{2}-[0-9]{2}
*/
startDate?: string;
/**
* An index of the first entity to retrieve. Use this parameter as a
* pagination mechanism along with the max-results parameter (one-based,
* inclusive).", minValue: 1
*/
startIndex?: number;
}
}