v1.d.ts
32.2 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
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
/**
* 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 youtubereporting_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;
}
/**
* YouTube Reporting API
*
* Schedules reporting jobs containing your YouTube Analytics data and downloads the resulting bulk data reports in the form of CSV files.
*
* @example
* const {google} = require('googleapis');
* const youtubereporting = google.youtubereporting('v1');
*
* @namespace youtubereporting
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Youtubereporting
*/
export class Youtubereporting {
context: APIRequestContext;
jobs: Resource$Jobs;
media: Resource$Media;
reportTypes: Resource$Reporttypes;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* 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 {
}
/**
* gdata
*/
export interface Schema$GdataBlobstore2Info {
/**
* gdata
*/
blobGeneration?: string | null;
/**
* gdata
*/
blobId?: string | null;
/**
* gdata
*/
downloadReadHandle?: string | null;
/**
* gdata
*/
readToken?: string | null;
/**
* gdata
*/
uploadMetadataContainer?: string | null;
}
/**
* gdata
*/
export interface Schema$GdataCompositeMedia {
/**
* gdata
*/
blobRef?: string | null;
/**
* gdata
*/
blobstore2Info?: Schema$GdataBlobstore2Info;
/**
* gdata
*/
cosmoBinaryReference?: string | null;
/**
* gdata
*/
crc32cHash?: number | null;
/**
* gdata
*/
inline?: string | null;
/**
* gdata
*/
length?: string | null;
/**
* gdata
*/
md5Hash?: string | null;
/**
* gdata
*/
objectId?: Schema$GdataObjectId;
/**
* gdata
*/
path?: string | null;
/**
* gdata
*/
referenceType?: string | null;
/**
* gdata
*/
sha1Hash?: string | null;
}
/**
* gdata
*/
export interface Schema$GdataContentTypeInfo {
/**
* gdata
*/
bestGuess?: string | null;
/**
* gdata
*/
fromBytes?: string | null;
/**
* gdata
*/
fromFileName?: string | null;
/**
* gdata
*/
fromHeader?: string | null;
/**
* gdata
*/
fromUrlPath?: string | null;
}
/**
* gdata
*/
export interface Schema$GdataDiffChecksumsResponse {
/**
* gdata
*/
checksumsLocation?: Schema$GdataCompositeMedia;
/**
* gdata
*/
chunkSizeBytes?: string | null;
/**
* gdata
*/
objectLocation?: Schema$GdataCompositeMedia;
/**
* gdata
*/
objectSizeBytes?: string | null;
/**
* gdata
*/
objectVersion?: string | null;
}
/**
* gdata
*/
export interface Schema$GdataDiffDownloadResponse {
/**
* gdata
*/
objectLocation?: Schema$GdataCompositeMedia;
}
/**
* gdata
*/
export interface Schema$GdataDiffUploadRequest {
/**
* gdata
*/
checksumsInfo?: Schema$GdataCompositeMedia;
/**
* gdata
*/
objectInfo?: Schema$GdataCompositeMedia;
/**
* gdata
*/
objectVersion?: string | null;
}
/**
* gdata
*/
export interface Schema$GdataDiffUploadResponse {
/**
* gdata
*/
objectVersion?: string | null;
/**
* gdata
*/
originalObject?: Schema$GdataCompositeMedia;
}
/**
* gdata
*/
export interface Schema$GdataDiffVersionResponse {
/**
* gdata
*/
objectSizeBytes?: string | null;
/**
* gdata
*/
objectVersion?: string | null;
}
/**
* gdata
*/
export interface Schema$GdataDownloadParameters {
/**
* gdata
*/
allowGzipCompression?: boolean | null;
/**
* gdata
*/
ignoreRange?: boolean | null;
}
/**
* gdata
*/
export interface Schema$GdataMedia {
/**
* gdata
*/
algorithm?: string | null;
/**
* gdata
*/
bigstoreObjectRef?: string | null;
/**
* gdata
*/
blobRef?: string | null;
/**
* gdata
*/
blobstore2Info?: Schema$GdataBlobstore2Info;
/**
* gdata
*/
compositeMedia?: Schema$GdataCompositeMedia[];
/**
* gdata
*/
contentType?: string | null;
/**
* gdata
*/
contentTypeInfo?: Schema$GdataContentTypeInfo;
/**
* gdata
*/
cosmoBinaryReference?: string | null;
/**
* gdata
*/
crc32cHash?: number | null;
/**
* gdata
*/
diffChecksumsResponse?: Schema$GdataDiffChecksumsResponse;
/**
* gdata
*/
diffDownloadResponse?: Schema$GdataDiffDownloadResponse;
/**
* gdata
*/
diffUploadRequest?: Schema$GdataDiffUploadRequest;
/**
* gdata
*/
diffUploadResponse?: Schema$GdataDiffUploadResponse;
/**
* gdata
*/
diffVersionResponse?: Schema$GdataDiffVersionResponse;
/**
* gdata
*/
downloadParameters?: Schema$GdataDownloadParameters;
/**
* gdata
*/
filename?: string | null;
/**
* gdata
*/
hash?: string | null;
/**
* gdata
*/
hashVerified?: boolean | null;
/**
* gdata
*/
inline?: string | null;
/**
* gdata
*/
isPotentialRetry?: boolean | null;
/**
* gdata
*/
length?: string | null;
/**
* gdata
*/
md5Hash?: string | null;
/**
* gdata
*/
mediaId?: string | null;
/**
* gdata
*/
objectId?: Schema$GdataObjectId;
/**
* gdata
*/
path?: string | null;
/**
* gdata
*/
referenceType?: string | null;
/**
* gdata
*/
sha1Hash?: string | null;
/**
* gdata
*/
sha256Hash?: string | null;
/**
* gdata
*/
timestamp?: string | null;
/**
* gdata
*/
token?: string | null;
}
/**
* gdata
*/
export interface Schema$GdataObjectId {
/**
* gdata
*/
bucketName?: string | null;
/**
* gdata
*/
generation?: string | null;
/**
* gdata
*/
objectName?: string | null;
}
/**
* A job creating reports of a specific type.
*/
export interface Schema$Job {
/**
* The creation date/time of the job.
*/
createTime?: string | null;
/**
* The date/time when this job will expire/expired. After a job expired, no new reports are generated.
*/
expireTime?: string | null;
/**
* The server-generated ID of the job (max. 40 characters).
*/
id?: string | null;
/**
* The name of the job (max. 100 characters).
*/
name?: string | null;
/**
* The type of reports this job creates. Corresponds to the ID of a ReportType.
*/
reportTypeId?: string | null;
/**
* True if this a system-managed job that cannot be modified by the user; otherwise false.
*/
systemManaged?: boolean | null;
}
/**
* Response message for ReportingService.ListJobs.
*/
export interface Schema$ListJobsResponse {
/**
* The list of jobs.
*/
jobs?: Schema$Job[];
/**
* A token to retrieve next page of results. Pass this value in the ListJobsRequest.page_token field in the subsequent call to `ListJobs` method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for ReportingService.ListReports.
*/
export interface Schema$ListReportsResponse {
/**
* A token to retrieve next page of results. Pass this value in the ListReportsRequest.page_token field in the subsequent call to `ListReports` method to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* The list of report types.
*/
reports?: Schema$Report[];
}
/**
* Response message for ReportingService.ListReportTypes.
*/
export interface Schema$ListReportTypesResponse {
/**
* A token to retrieve next page of results. Pass this value in the ListReportTypesRequest.page_token field in the subsequent call to `ListReportTypes` method to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* The list of report types.
*/
reportTypes?: Schema$ReportType[];
}
/**
* A report's metadata including the URL from which the report itself can be downloaded.
*/
export interface Schema$Report {
/**
* The date/time when this report was created.
*/
createTime?: string | null;
/**
* The URL from which the report can be downloaded (max. 1000 characters).
*/
downloadUrl?: string | null;
/**
* The end of the time period that the report instance covers. The value is exclusive.
*/
endTime?: string | null;
/**
* The server-generated ID of the report.
*/
id?: string | null;
/**
* The date/time when the job this report belongs to will expire/expired.
*/
jobExpireTime?: string | null;
/**
* The ID of the job that created this report.
*/
jobId?: string | null;
/**
* The start of the time period that the report instance covers. The value is inclusive.
*/
startTime?: string | null;
}
/**
* A report type.
*/
export interface Schema$ReportType {
/**
* The date/time when this report type was/will be deprecated.
*/
deprecateTime?: string | null;
/**
* The ID of the report type (max. 100 characters).
*/
id?: string | null;
/**
* The name of the report type (max. 100 characters).
*/
name?: string | null;
/**
* True if this a system-managed report type; otherwise false. Reporting jobs for system-managed report types are created automatically and can thus not be used in the `CreateJob` method.
*/
systemManaged?: boolean | null;
}
export class Resource$Jobs {
context: APIRequestContext;
reports: Resource$Jobs$Reports;
constructor(context: APIRequestContext);
/**
* youtubereporting.jobs.create
* @desc Creates a job and returns it.
* @alias youtubereporting.jobs.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.onBehalfOfContentOwner The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
* @param {().Job} 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
*/
create(params?: Params$Resource$Jobs$Create, options?: MethodOptions): GaxiosPromise<Schema$Job>;
create(params: Params$Resource$Jobs$Create, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
create(params: Params$Resource$Jobs$Create, callback: BodyResponseCallback<Schema$Job>): void;
create(callback: BodyResponseCallback<Schema$Job>): void;
/**
* youtubereporting.jobs.delete
* @desc Deletes a job.
* @alias youtubereporting.jobs.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.jobId The ID of the job to delete.
* @param {string=} params.onBehalfOfContentOwner The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
* @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$Jobs$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Jobs$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Jobs$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* youtubereporting.jobs.get
* @desc Gets a job.
* @alias youtubereporting.jobs.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.jobId The ID of the job to retrieve.
* @param {string=} params.onBehalfOfContentOwner The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
* @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$Jobs$Get, options?: MethodOptions): GaxiosPromise<Schema$Job>;
get(params: Params$Resource$Jobs$Get, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
get(params: Params$Resource$Jobs$Get, callback: BodyResponseCallback<Schema$Job>): void;
get(callback: BodyResponseCallback<Schema$Job>): void;
/**
* youtubereporting.jobs.list
* @desc Lists jobs.
* @alias youtubereporting.jobs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.includeSystemManaged If set to true, also system-managed jobs will be returned; otherwise only user-created jobs will be returned. System-managed jobs can neither be modified nor deleted.
* @param {string=} params.onBehalfOfContentOwner The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
* @param {integer=} params.pageSize Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListJobs` method.
* @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$Jobs$List, options?: MethodOptions): GaxiosPromise<Schema$ListJobsResponse>;
list(params: Params$Resource$Jobs$List, options: MethodOptions | BodyResponseCallback<Schema$ListJobsResponse>, callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
list(params: Params$Resource$Jobs$List, callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
}
export interface Params$Resource$Jobs$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
*/
onBehalfOfContentOwner?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Job;
}
export interface Params$Resource$Jobs$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the job to delete.
*/
jobId?: string;
/**
* The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
*/
onBehalfOfContentOwner?: string;
}
export interface Params$Resource$Jobs$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the job to retrieve.
*/
jobId?: string;
/**
* The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
*/
onBehalfOfContentOwner?: string;
}
export interface Params$Resource$Jobs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If set to true, also system-managed jobs will be returned; otherwise only user-created jobs will be returned. System-managed jobs can neither be modified nor deleted.
*/
includeSystemManaged?: boolean;
/**
* The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
*/
onBehalfOfContentOwner?: string;
/**
* Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListJobs` method.
*/
pageToken?: string;
}
export class Resource$Jobs$Reports {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* youtubereporting.jobs.reports.get
* @desc Gets the metadata of a specific report.
* @alias youtubereporting.jobs.reports.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.jobId The ID of the job.
* @param {string=} params.onBehalfOfContentOwner The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
* @param {string} params.reportId The ID of the report to retrieve.
* @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$Jobs$Reports$Get, options?: MethodOptions): GaxiosPromise<Schema$Report>;
get(params: Params$Resource$Jobs$Reports$Get, options: MethodOptions | BodyResponseCallback<Schema$Report>, callback: BodyResponseCallback<Schema$Report>): void;
get(params: Params$Resource$Jobs$Reports$Get, callback: BodyResponseCallback<Schema$Report>): void;
get(callback: BodyResponseCallback<Schema$Report>): void;
/**
* youtubereporting.jobs.reports.list
* @desc Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist.
* @alias youtubereporting.jobs.reports.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.createdAfter If set, only reports created after the specified date/time are returned.
* @param {string} params.jobId The ID of the job.
* @param {string=} params.onBehalfOfContentOwner The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
* @param {integer=} params.pageSize Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListReportsResponse.next_page_token returned in response to the previous call to the `ListReports` method.
* @param {string=} params.startTimeAtOrAfter If set, only reports whose start time is greater than or equal the specified date/time are returned.
* @param {string=} params.startTimeBefore If set, only reports whose start time is smaller than the specified date/time are returned.
* @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$Jobs$Reports$List, options?: MethodOptions): GaxiosPromise<Schema$ListReportsResponse>;
list(params: Params$Resource$Jobs$Reports$List, options: MethodOptions | BodyResponseCallback<Schema$ListReportsResponse>, callback: BodyResponseCallback<Schema$ListReportsResponse>): void;
list(params: Params$Resource$Jobs$Reports$List, callback: BodyResponseCallback<Schema$ListReportsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListReportsResponse>): void;
}
export interface Params$Resource$Jobs$Reports$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the job.
*/
jobId?: string;
/**
* The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
*/
onBehalfOfContentOwner?: string;
/**
* The ID of the report to retrieve.
*/
reportId?: string;
}
export interface Params$Resource$Jobs$Reports$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If set, only reports created after the specified date/time are returned.
*/
createdAfter?: string;
/**
* The ID of the job.
*/
jobId?: string;
/**
* The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
*/
onBehalfOfContentOwner?: string;
/**
* Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListReportsResponse.next_page_token returned in response to the previous call to the `ListReports` method.
*/
pageToken?: string;
/**
* If set, only reports whose start time is greater than or equal the specified date/time are returned.
*/
startTimeAtOrAfter?: string;
/**
* If set, only reports whose start time is smaller than the specified date/time are returned.
*/
startTimeBefore?: string;
}
export class Resource$Media {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* youtubereporting.media.download
* @desc Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.
* @alias youtubereporting.media.download
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resourceName Name of the media that is being downloaded.
* @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
*/
download(params?: Params$Resource$Media$Download, options?: MethodOptions): GaxiosPromise<Schema$GdataMedia>;
download(params: Params$Resource$Media$Download, options: MethodOptions | BodyResponseCallback<Schema$GdataMedia>, callback: BodyResponseCallback<Schema$GdataMedia>): void;
download(params: Params$Resource$Media$Download, callback: BodyResponseCallback<Schema$GdataMedia>): void;
download(callback: BodyResponseCallback<Schema$GdataMedia>): void;
}
export interface Params$Resource$Media$Download extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the media that is being downloaded.
*/
resourceName?: string;
}
export class Resource$Reporttypes {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* youtubereporting.reportTypes.list
* @desc Lists report types.
* @alias youtubereporting.reportTypes.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.includeSystemManaged If set to true, also system-managed report types will be returned; otherwise only the report types that can be used to create new reporting jobs will be returned.
* @param {string=} params.onBehalfOfContentOwner The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
* @param {integer=} params.pageSize Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListReportTypes` method.
* @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$Reporttypes$List, options?: MethodOptions): GaxiosPromise<Schema$ListReportTypesResponse>;
list(params: Params$Resource$Reporttypes$List, options: MethodOptions | BodyResponseCallback<Schema$ListReportTypesResponse>, callback: BodyResponseCallback<Schema$ListReportTypesResponse>): void;
list(params: Params$Resource$Reporttypes$List, callback: BodyResponseCallback<Schema$ListReportTypesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListReportTypesResponse>): void;
}
export interface Params$Resource$Reporttypes$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If set to true, also system-managed report types will be returned; otherwise only the report types that can be used to create new reporting jobs will be returned.
*/
includeSystemManaged?: boolean;
/**
* The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
*/
onBehalfOfContentOwner?: string;
/**
* Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListReportTypes` method.
*/
pageToken?: string;
}
export {};
}