YouTubeReporting.php
19 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
<?php
/*
* Copyright 2010 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
/**
* Service definition for YouTubeReporting (v1).
*
* <p>
* An API to schedule reporting jobs and download the resulting bulk data
* reports about YouTube channels, videos etc. in the form of CSV files.</p>
*
* <p>
* For more information about this service, see the API
* <a href="https://developers.google.com/youtube/reporting/v1/reports/" target="_blank">Documentation</a>
* </p>
*
* @author Google, Inc.
*/
class Google_Service_YouTubeReporting extends Google_Service
{
/** View monetary and non-monetary YouTube Analytics reports for your YouTube content. */
const YT_ANALYTICS_MONETARY_READONLY =
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly";
/** View YouTube Analytics reports for your YouTube content. */
const YT_ANALYTICS_READONLY =
"https://www.googleapis.com/auth/yt-analytics.readonly";
public $jobs;
public $jobs_reports;
public $media;
public $reportTypes;
/**
* Constructs the internal representation of the YouTubeReporting service.
*
* @param Google_Client $client
*/
public function __construct(Google_Client $client)
{
parent::__construct($client);
$this->rootUrl = 'https://youtubereporting.googleapis.com/';
$this->servicePath = '';
$this->version = 'v1';
$this->serviceName = 'youtubereporting';
$this->jobs = new Google_Service_YouTubeReporting_Jobs_Resource(
$this,
$this->serviceName,
'jobs',
array(
'methods' => array(
'create' => array(
'path' => 'v1/jobs',
'httpMethod' => 'POST',
'parameters' => array(
'onBehalfOfContentOwner' => array(
'location' => 'query',
'type' => 'string',
),
),
),'delete' => array(
'path' => 'v1/jobs/{jobId}',
'httpMethod' => 'DELETE',
'parameters' => array(
'jobId' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
'onBehalfOfContentOwner' => array(
'location' => 'query',
'type' => 'string',
),
),
),'get' => array(
'path' => 'v1/jobs/{jobId}',
'httpMethod' => 'GET',
'parameters' => array(
'jobId' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
'onBehalfOfContentOwner' => array(
'location' => 'query',
'type' => 'string',
),
),
),'list' => array(
'path' => 'v1/jobs',
'httpMethod' => 'GET',
'parameters' => array(
'pageToken' => array(
'location' => 'query',
'type' => 'string',
),
'onBehalfOfContentOwner' => array(
'location' => 'query',
'type' => 'string',
),
'pageSize' => array(
'location' => 'query',
'type' => 'integer',
),
),
),
)
)
);
$this->jobs_reports = new Google_Service_YouTubeReporting_JobsReports_Resource(
$this,
$this->serviceName,
'reports',
array(
'methods' => array(
'get' => array(
'path' => 'v1/jobs/{jobId}/reports/{reportId}',
'httpMethod' => 'GET',
'parameters' => array(
'jobId' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
'reportId' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
'onBehalfOfContentOwner' => array(
'location' => 'query',
'type' => 'string',
),
),
),'list' => array(
'path' => 'v1/jobs/{jobId}/reports',
'httpMethod' => 'GET',
'parameters' => array(
'jobId' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
'pageToken' => array(
'location' => 'query',
'type' => 'string',
),
'onBehalfOfContentOwner' => array(
'location' => 'query',
'type' => 'string',
),
'pageSize' => array(
'location' => 'query',
'type' => 'integer',
),
),
),
)
)
);
$this->media = new Google_Service_YouTubeReporting_Media_Resource(
$this,
$this->serviceName,
'media',
array(
'methods' => array(
'download' => array(
'path' => 'v1/media/{+resourceName}',
'httpMethod' => 'GET',
'parameters' => array(
'resourceName' => array(
'location' => 'path',
'type' => 'string',
'required' => true,
),
),
),
)
)
);
$this->reportTypes = new Google_Service_YouTubeReporting_ReportTypes_Resource(
$this,
$this->serviceName,
'reportTypes',
array(
'methods' => array(
'list' => array(
'path' => 'v1/reportTypes',
'httpMethod' => 'GET',
'parameters' => array(
'pageToken' => array(
'location' => 'query',
'type' => 'string',
),
'onBehalfOfContentOwner' => array(
'location' => 'query',
'type' => 'string',
),
'pageSize' => array(
'location' => 'query',
'type' => 'integer',
),
),
),
)
)
);
}
}
/**
* The "jobs" collection of methods.
* Typical usage is:
* <code>
* $youtubereportingService = new Google_Service_YouTubeReporting(...);
* $jobs = $youtubereportingService->jobs;
* </code>
*/
class Google_Service_YouTubeReporting_Jobs_Resource extends Google_Service_Resource
{
/**
* Creates a job and returns it. (jobs.create)
*
* @param Google_Job $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string 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).
* @return Google_Service_YouTubeReporting_Job
*/
public function create(Google_Service_YouTubeReporting_Job $postBody, $optParams = array())
{
$params = array('postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('create', array($params), "Google_Service_YouTubeReporting_Job");
}
/**
* Deletes a job. (jobs.delete)
*
* @param string $jobId The ID of the job to delete.
* @param array $optParams Optional parameters.
*
* @opt_param string 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).
* @return Google_Service_YouTubeReporting_Empty
*/
public function delete($jobId, $optParams = array())
{
$params = array('jobId' => $jobId);
$params = array_merge($params, $optParams);
return $this->call('delete', array($params), "Google_Service_YouTubeReporting_Empty");
}
/**
* Gets a job. (jobs.get)
*
* @param string $jobId The ID of the job to retrieve.
* @param array $optParams Optional parameters.
*
* @opt_param string 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).
* @return Google_Service_YouTubeReporting_Job
*/
public function get($jobId, $optParams = array())
{
$params = array('jobId' => $jobId);
$params = array_merge($params, $optParams);
return $this->call('get', array($params), "Google_Service_YouTubeReporting_Job");
}
/**
* Lists jobs. (jobs.listJobs)
*
* @param array $optParams Optional parameters.
*
* @opt_param string 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.
* @opt_param string 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).
* @opt_param int pageSize Requested page size. Server may return fewer jobs
* than requested. If unspecified, server will pick an appropriate default.
* @return Google_Service_YouTubeReporting_ListJobsResponse
*/
public function listJobs($optParams = array())
{
$params = array();
$params = array_merge($params, $optParams);
return $this->call('list', array($params), "Google_Service_YouTubeReporting_ListJobsResponse");
}
}
/**
* The "reports" collection of methods.
* Typical usage is:
* <code>
* $youtubereportingService = new Google_Service_YouTubeReporting(...);
* $reports = $youtubereportingService->reports;
* </code>
*/
class Google_Service_YouTubeReporting_JobsReports_Resource extends Google_Service_Resource
{
/**
* Gets the metadata of a specific report. (reports.get)
*
* @param string $jobId The ID of the job.
* @param string $reportId The ID of the report to retrieve.
* @param array $optParams Optional parameters.
*
* @opt_param string 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).
* @return Google_Service_YouTubeReporting_Report
*/
public function get($jobId, $reportId, $optParams = array())
{
$params = array('jobId' => $jobId, 'reportId' => $reportId);
$params = array_merge($params, $optParams);
return $this->call('get', array($params), "Google_Service_YouTubeReporting_Report");
}
/**
* Lists reports created by a specific job. Returns NOT_FOUND if the job does
* not exist. (reports.listJobsReports)
*
* @param string $jobId The ID of the job.
* @param array $optParams Optional parameters.
*
* @opt_param string 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.
* @opt_param string 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).
* @opt_param int pageSize Requested page size. Server may return fewer report
* types than requested. If unspecified, server will pick an appropriate
* default.
* @return Google_Service_YouTubeReporting_ListReportsResponse
*/
public function listJobsReports($jobId, $optParams = array())
{
$params = array('jobId' => $jobId);
$params = array_merge($params, $optParams);
return $this->call('list', array($params), "Google_Service_YouTubeReporting_ListReportsResponse");
}
}
/**
* The "media" collection of methods.
* Typical usage is:
* <code>
* $youtubereportingService = new Google_Service_YouTubeReporting(...);
* $media = $youtubereportingService->media;
* </code>
*/
class Google_Service_YouTubeReporting_Media_Resource extends Google_Service_Resource
{
/**
* Method for media download. Download is supported on the URI
* `/v1/media/{+name}?alt=media`. (media.download)
*
* @param string $resourceName Name of the media that is being downloaded. See
* [][ByteStream.ReadRequest.resource_name].
* @param array $optParams Optional parameters.
* @return Google_Service_YouTubeReporting_Media
*/
public function download($resourceName, $optParams = array())
{
$params = array('resourceName' => $resourceName);
$params = array_merge($params, $optParams);
return $this->call('download', array($params), "Google_Service_YouTubeReporting_Media");
}
}
/**
* The "reportTypes" collection of methods.
* Typical usage is:
* <code>
* $youtubereportingService = new Google_Service_YouTubeReporting(...);
* $reportTypes = $youtubereportingService->reportTypes;
* </code>
*/
class Google_Service_YouTubeReporting_ReportTypes_Resource extends Google_Service_Resource
{
/**
* Lists report types. (reportTypes.listReportTypes)
*
* @param array $optParams Optional parameters.
*
* @opt_param string 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.
* @opt_param string 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).
* @opt_param int pageSize Requested page size. Server may return fewer report
* types than requested. If unspecified, server will pick an appropriate
* default.
* @return Google_Service_YouTubeReporting_ListReportTypesResponse
*/
public function listReportTypes($optParams = array())
{
$params = array();
$params = array_merge($params, $optParams);
return $this->call('list', array($params), "Google_Service_YouTubeReporting_ListReportTypesResponse");
}
}
class Google_Service_YouTubeReporting_Empty extends Google_Model
{
}
class Google_Service_YouTubeReporting_Job extends Google_Model
{
protected $internal_gapi_mappings = array(
);
public $createTime;
public $id;
public $name;
public $reportTypeId;
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
public function getCreateTime()
{
return $this->createTime;
}
public function setId($id)
{
$this->id = $id;
}
public function getId()
{
return $this->id;
}
public function setName($name)
{
$this->name = $name;
}
public function getName()
{
return $this->name;
}
public function setReportTypeId($reportTypeId)
{
$this->reportTypeId = $reportTypeId;
}
public function getReportTypeId()
{
return $this->reportTypeId;
}
}
class Google_Service_YouTubeReporting_ListJobsResponse extends Google_Collection
{
protected $collection_key = 'jobs';
protected $internal_gapi_mappings = array(
);
protected $jobsType = 'Google_Service_YouTubeReporting_Job';
protected $jobsDataType = 'array';
public $nextPageToken;
public function setJobs($jobs)
{
$this->jobs = $jobs;
}
public function getJobs()
{
return $this->jobs;
}
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
class Google_Service_YouTubeReporting_ListReportTypesResponse extends Google_Collection
{
protected $collection_key = 'reportTypes';
protected $internal_gapi_mappings = array(
);
public $nextPageToken;
protected $reportTypesType = 'Google_Service_YouTubeReporting_ReportType';
protected $reportTypesDataType = 'array';
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
public function getNextPageToken()
{
return $this->nextPageToken;
}
public function setReportTypes($reportTypes)
{
$this->reportTypes = $reportTypes;
}
public function getReportTypes()
{
return $this->reportTypes;
}
}
class Google_Service_YouTubeReporting_ListReportsResponse extends Google_Collection
{
protected $collection_key = 'reports';
protected $internal_gapi_mappings = array(
);
public $nextPageToken;
protected $reportsType = 'Google_Service_YouTubeReporting_Report';
protected $reportsDataType = 'array';
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
public function getNextPageToken()
{
return $this->nextPageToken;
}
public function setReports($reports)
{
$this->reports = $reports;
}
public function getReports()
{
return $this->reports;
}
}
class Google_Service_YouTubeReporting_Media extends Google_Model
{
protected $internal_gapi_mappings = array(
);
public $resourceName;
public function setResourceName($resourceName)
{
$this->resourceName = $resourceName;
}
public function getResourceName()
{
return $this->resourceName;
}
}
class Google_Service_YouTubeReporting_Report extends Google_Model
{
protected $internal_gapi_mappings = array(
);
public $createTime;
public $downloadUrl;
public $endTime;
public $id;
public $jobId;
public $startTime;
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
public function getCreateTime()
{
return $this->createTime;
}
public function setDownloadUrl($downloadUrl)
{
$this->downloadUrl = $downloadUrl;
}
public function getDownloadUrl()
{
return $this->downloadUrl;
}
public function setEndTime($endTime)
{
$this->endTime = $endTime;
}
public function getEndTime()
{
return $this->endTime;
}
public function setId($id)
{
$this->id = $id;
}
public function getId()
{
return $this->id;
}
public function setJobId($jobId)
{
$this->jobId = $jobId;
}
public function getJobId()
{
return $this->jobId;
}
public function setStartTime($startTime)
{
$this->startTime = $startTime;
}
public function getStartTime()
{
return $this->startTime;
}
}
class Google_Service_YouTubeReporting_ReportType extends Google_Model
{
protected $internal_gapi_mappings = array(
);
public $id;
public $name;
public function setId($id)
{
$this->id = $id;
}
public function getId()
{
return $this->id;
}
public function setName($name)
{
$this->name = $name;
}
public function getName()
{
return $this->name;
}
}