PluginProbe
Authorizer / 2.6.10
Authorizer v2.6.10
3.15.3 3.15.2 3.15.1 3.15.0 3.14.3 3.14.4 3.14.2 3.14.1 2.8.1 2.8.2 2.8.3 2.8.4 2.8.5 2.8.6 2.8.7 2.8.8 2.9.0 2.9.1 2.9.10 2.9.11 2.9.12 2.9.13 2.9.2 2.9.3 2.9.6 All 126 releases
authorizer / vendor / google-api-php-client / src / Google / Service / YouTubeReporting.php

YouTubeReporting.php in Authorizer 2.6.10, at vendor/google-api-php-client/src/Google/Service/YouTubeReporting.php

679 lines 19.2 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /*
3 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 * use this file except in compliance with the License. You may obtain a copy of
5 * the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 * License for the specific language governing permissions and limitations under
13 * the License.
14 */
15
16 /**
17 * Service definition for YouTubeReporting (v1).
18 *
19 * <p>
20 * An API to schedule reporting jobs and download the resulting bulk data
21 * reports about YouTube channels, videos etc. in the form of CSV files.</p>
22 *
23 * <p>
24 * For more information about this service, see the API
25 * <a href="https://developers.google.com/youtube/reporting/v1/reports/" target="_blank">Documentation</a>
26 * </p>
27 *
28 * @author Google, Inc.
29 */
30 class Google_Service_YouTubeReporting extends Google_Service
31 {
32 /** View monetary and non-monetary YouTube Analytics reports for your YouTube content. */
33 const YT_ANALYTICS_MONETARY_READONLY =
34 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly";
35 /** View YouTube Analytics reports for your YouTube content. */
36 const YT_ANALYTICS_READONLY =
37 "https://www.googleapis.com/auth/yt-analytics.readonly";
38
39 public $jobs;
40 public $jobs_reports;
41 public $media;
42 public $reportTypes;
43
44
45 /**
46 * Constructs the internal representation of the YouTubeReporting service.
47 *
48 * @param Google_Client $client
49 */
50 public function __construct(Google_Client $client)
51 {
52 parent::__construct($client);
53 $this->rootUrl = 'https://youtubereporting.googleapis.com/';
54 $this->servicePath = '';
55 $this->version = 'v1';
56 $this->serviceName = 'youtubereporting';
57
58 $this->jobs = new Google_Service_YouTubeReporting_Jobs_Resource(
59 $this,
60 $this->serviceName,
61 'jobs',
62 array(
63 'methods' => array(
64 'create' => array(
65 'path' => 'v1/jobs',
66 'httpMethod' => 'POST',
67 'parameters' => array(
68 'onBehalfOfContentOwner' => array(
69 'location' => 'query',
70 'type' => 'string',
71 ),
72 ),
73 ),'delete' => array(
74 'path' => 'v1/jobs/{jobId}',
75 'httpMethod' => 'DELETE',
76 'parameters' => array(
77 'jobId' => array(
78 'location' => 'path',
79 'type' => 'string',
80 'required' => true,
81 ),
82 'onBehalfOfContentOwner' => array(
83 'location' => 'query',
84 'type' => 'string',
85 ),
86 ),
87 ),'get' => array(
88 'path' => 'v1/jobs/{jobId}',
89 'httpMethod' => 'GET',
90 'parameters' => array(
91 'jobId' => array(
92 'location' => 'path',
93 'type' => 'string',
94 'required' => true,
95 ),
96 'onBehalfOfContentOwner' => array(
97 'location' => 'query',
98 'type' => 'string',
99 ),
100 ),
101 ),'list' => array(
102 'path' => 'v1/jobs',
103 'httpMethod' => 'GET',
104 'parameters' => array(
105 'onBehalfOfContentOwner' => array(
106 'location' => 'query',
107 'type' => 'string',
108 ),
109 'pageSize' => array(
110 'location' => 'query',
111 'type' => 'integer',
112 ),
113 'pageToken' => array(
114 'location' => 'query',
115 'type' => 'string',
116 ),
117 ),
118 ),
119 )
120 )
121 );
122 $this->jobs_reports = new Google_Service_YouTubeReporting_JobsReports_Resource(
123 $this,
124 $this->serviceName,
125 'reports',
126 array(
127 'methods' => array(
128 'get' => array(
129 'path' => 'v1/jobs/{jobId}/reports/{reportId}',
130 'httpMethod' => 'GET',
131 'parameters' => array(
132 'jobId' => array(
133 'location' => 'path',
134 'type' => 'string',
135 'required' => true,
136 ),
137 'reportId' => array(
138 'location' => 'path',
139 'type' => 'string',
140 'required' => true,
141 ),
142 'onBehalfOfContentOwner' => array(
143 'location' => 'query',
144 'type' => 'string',
145 ),
146 ),
147 ),'list' => array(
148 'path' => 'v1/jobs/{jobId}/reports',
149 'httpMethod' => 'GET',
150 'parameters' => array(
151 'jobId' => array(
152 'location' => 'path',
153 'type' => 'string',
154 'required' => true,
155 ),
156 'onBehalfOfContentOwner' => array(
157 'location' => 'query',
158 'type' => 'string',
159 ),
160 'pageSize' => array(
161 'location' => 'query',
162 'type' => 'integer',
163 ),
164 'pageToken' => array(
165 'location' => 'query',
166 'type' => 'string',
167 ),
168 'createdAfter' => array(
169 'location' => 'query',
170 'type' => 'string',
171 ),
172 ),
173 ),
174 )
175 )
176 );
177 $this->media = new Google_Service_YouTubeReporting_Media_Resource(
178 $this,
179 $this->serviceName,
180 'media',
181 array(
182 'methods' => array(
183 'download' => array(
184 'path' => 'v1/media/{+resourceName}',
185 'httpMethod' => 'GET',
186 'parameters' => array(
187 'resourceName' => array(
188 'location' => 'path',
189 'type' => 'string',
190 'required' => true,
191 ),
192 ),
193 ),
194 )
195 )
196 );
197 $this->reportTypes = new Google_Service_YouTubeReporting_ReportTypes_Resource(
198 $this,
199 $this->serviceName,
200 'reportTypes',
201 array(
202 'methods' => array(
203 'list' => array(
204 'path' => 'v1/reportTypes',
205 'httpMethod' => 'GET',
206 'parameters' => array(
207 'onBehalfOfContentOwner' => array(
208 'location' => 'query',
209 'type' => 'string',
210 ),
211 'pageSize' => array(
212 'location' => 'query',
213 'type' => 'integer',
214 ),
215 'pageToken' => array(
216 'location' => 'query',
217 'type' => 'string',
218 ),
219 ),
220 ),
221 )
222 )
223 );
224 }
225 }
226
227
228 /**
229 * The "jobs" collection of methods.
230 * Typical usage is:
231 * <code>
232 * $youtubereportingService = new Google_Service_YouTubeReporting(...);
233 * $jobs = $youtubereportingService->jobs;
234 * </code>
235 */
236 class Google_Service_YouTubeReporting_Jobs_Resource extends Google_Service_Resource
237 {
238
239 /**
240 * Creates a job and returns it. (jobs.create)
241 *
242 * @param Google_Job $postBody
243 * @param array $optParams Optional parameters.
244 *
245 * @opt_param string onBehalfOfContentOwner The content owner's external ID on
246 * which behalf the user is acting on. If not set, the user is acting for
247 * himself (his own channel).
248 * @return Google_Service_YouTubeReporting_Job
249 */
250 public function create(Google_Service_YouTubeReporting_Job $postBody, $optParams = array())
251 {
252 $params = array('postBody' => $postBody);
253 $params = array_merge($params, $optParams);
254 return $this->call('create', array($params), "Google_Service_YouTubeReporting_Job");
255 }
256
257 /**
258 * Deletes a job. (jobs.delete)
259 *
260 * @param string $jobId The ID of the job to delete.
261 * @param array $optParams Optional parameters.
262 *
263 * @opt_param string onBehalfOfContentOwner The content owner's external ID on
264 * which behalf the user is acting on. If not set, the user is acting for
265 * himself (his own channel).
266 * @return Google_Service_YouTubeReporting_Empty
267 */
268 public function delete($jobId, $optParams = array())
269 {
270 $params = array('jobId' => $jobId);
271 $params = array_merge($params, $optParams);
272 return $this->call('delete', array($params), "Google_Service_YouTubeReporting_Empty");
273 }
274
275 /**
276 * Gets a job. (jobs.get)
277 *
278 * @param string $jobId The ID of the job to retrieve.
279 * @param array $optParams Optional parameters.
280 *
281 * @opt_param string onBehalfOfContentOwner The content owner's external ID on
282 * which behalf the user is acting on. If not set, the user is acting for
283 * himself (his own channel).
284 * @return Google_Service_YouTubeReporting_Job
285 */
286 public function get($jobId, $optParams = array())
287 {
288 $params = array('jobId' => $jobId);
289 $params = array_merge($params, $optParams);
290 return $this->call('get', array($params), "Google_Service_YouTubeReporting_Job");
291 }
292
293 /**
294 * Lists jobs. (jobs.listJobs)
295 *
296 * @param array $optParams Optional parameters.
297 *
298 * @opt_param string onBehalfOfContentOwner The content owner's external ID on
299 * which behalf the user is acting on. If not set, the user is acting for
300 * himself (his own channel).
301 * @opt_param int pageSize Requested page size. Server may return fewer jobs
302 * than requested. If unspecified, server will pick an appropriate default.
303 * @opt_param string pageToken A token identifying a page of results the server
304 * should return. Typically, this is the value of
305 * ListReportTypesResponse.next_page_token returned in response to the previous
306 * call to the `ListJobs` method.
307 * @return Google_Service_YouTubeReporting_ListJobsResponse
308 */
309 public function listJobs($optParams = array())
310 {
311 $params = array();
312 $params = array_merge($params, $optParams);
313 return $this->call('list', array($params), "Google_Service_YouTubeReporting_ListJobsResponse");
314 }
315 }
316
317 /**
318 * The "reports" collection of methods.
319 * Typical usage is:
320 * <code>
321 * $youtubereportingService = new Google_Service_YouTubeReporting(...);
322 * $reports = $youtubereportingService->reports;
323 * </code>
324 */
325 class Google_Service_YouTubeReporting_JobsReports_Resource extends Google_Service_Resource
326 {
327
328 /**
329 * Gets the metadata of a specific report. (reports.get)
330 *
331 * @param string $jobId The ID of the job.
332 * @param string $reportId The ID of the report to retrieve.
333 * @param array $optParams Optional parameters.
334 *
335 * @opt_param string onBehalfOfContentOwner The content owner's external ID on
336 * which behalf the user is acting on. If not set, the user is acting for
337 * himself (his own channel).
338 * @return Google_Service_YouTubeReporting_Report
339 */
340 public function get($jobId, $reportId, $optParams = array())
341 {
342 $params = array('jobId' => $jobId, 'reportId' => $reportId);
343 $params = array_merge($params, $optParams);
344 return $this->call('get', array($params), "Google_Service_YouTubeReporting_Report");
345 }
346
347 /**
348 * Lists reports created by a specific job. Returns NOT_FOUND if the job does
349 * not exist. (reports.listJobsReports)
350 *
351 * @param string $jobId The ID of the job.
352 * @param array $optParams Optional parameters.
353 *
354 * @opt_param string onBehalfOfContentOwner The content owner's external ID on
355 * which behalf the user is acting on. If not set, the user is acting for
356 * himself (his own channel).
357 * @opt_param int pageSize Requested page size. Server may return fewer report
358 * types than requested. If unspecified, server will pick an appropriate
359 * default.
360 * @opt_param string pageToken A token identifying a page of results the server
361 * should return. Typically, this is the value of
362 * ListReportsResponse.next_page_token returned in response to the previous call
363 * to the `ListReports` method.
364 * @opt_param string createdAfter If set, only reports created after the
365 * specified date/time are returned.
366 * @return Google_Service_YouTubeReporting_ListReportsResponse
367 */
368 public function listJobsReports($jobId, $optParams = array())
369 {
370 $params = array('jobId' => $jobId);
371 $params = array_merge($params, $optParams);
372 return $this->call('list', array($params), "Google_Service_YouTubeReporting_ListReportsResponse");
373 }
374 }
375
376 /**
377 * The "media" collection of methods.
378 * Typical usage is:
379 * <code>
380 * $youtubereportingService = new Google_Service_YouTubeReporting(...);
381 * $media = $youtubereportingService->media;
382 * </code>
383 */
384 class Google_Service_YouTubeReporting_Media_Resource extends Google_Service_Resource
385 {
386
387 /**
388 * Method for media download. Download is supported on the URI
389 * `/v1/media/{+name}?alt=media`. (media.download)
390 *
391 * @param string $resourceName Name of the media that is being downloaded. See
392 * [][ByteStream.ReadRequest.resource_name].
393 * @param array $optParams Optional parameters.
394 * @return Google_Service_YouTubeReporting_Media
395 */
396 public function download($resourceName, $optParams = array())
397 {
398 $params = array('resourceName' => $resourceName);
399 $params = array_merge($params, $optParams);
400 return $this->call('download', array($params), "Google_Service_YouTubeReporting_Media");
401 }
402 }
403
404 /**
405 * The "reportTypes" collection of methods.
406 * Typical usage is:
407 * <code>
408 * $youtubereportingService = new Google_Service_YouTubeReporting(...);
409 * $reportTypes = $youtubereportingService->reportTypes;
410 * </code>
411 */
412 class Google_Service_YouTubeReporting_ReportTypes_Resource extends Google_Service_Resource
413 {
414
415 /**
416 * Lists report types. (reportTypes.listReportTypes)
417 *
418 * @param array $optParams Optional parameters.
419 *
420 * @opt_param string onBehalfOfContentOwner The content owner's external ID on
421 * which behalf the user is acting on. If not set, the user is acting for
422 * himself (his own channel).
423 * @opt_param int pageSize Requested page size. Server may return fewer report
424 * types than requested. If unspecified, server will pick an appropriate
425 * default.
426 * @opt_param string pageToken A token identifying a page of results the server
427 * should return. Typically, this is the value of
428 * ListReportTypesResponse.next_page_token returned in response to the previous
429 * call to the `ListReportTypes` method.
430 * @return Google_Service_YouTubeReporting_ListReportTypesResponse
431 */
432 public function listReportTypes($optParams = array())
433 {
434 $params = array();
435 $params = array_merge($params, $optParams);
436 return $this->call('list', array($params), "Google_Service_YouTubeReporting_ListReportTypesResponse");
437 }
438 }
439
440
441
442
443 class Google_Service_YouTubeReporting_Empty extends Google_Model
444 {
445 }
446
447 class Google_Service_YouTubeReporting_Job extends Google_Model
448 {
449 protected $internal_gapi_mappings = array(
450 );
451 public $createTime;
452 public $id;
453 public $name;
454 public $reportTypeId;
455
456
457 public function setCreateTime($createTime)
458 {
459 $this->createTime = $createTime;
460 }
461 public function getCreateTime()
462 {
463 return $this->createTime;
464 }
465 public function setId($id)
466 {
467 $this->id = $id;
468 }
469 public function getId()
470 {
471 return $this->id;
472 }
473 public function setName($name)
474 {
475 $this->name = $name;
476 }
477 public function getName()
478 {
479 return $this->name;
480 }
481 public function setReportTypeId($reportTypeId)
482 {
483 $this->reportTypeId = $reportTypeId;
484 }
485 public function getReportTypeId()
486 {
487 return $this->reportTypeId;
488 }
489 }
490
491 class Google_Service_YouTubeReporting_ListJobsResponse extends Google_Collection
492 {
493 protected $collection_key = 'jobs';
494 protected $internal_gapi_mappings = array(
495 );
496 protected $jobsType = 'Google_Service_YouTubeReporting_Job';
497 protected $jobsDataType = 'array';
498 public $nextPageToken;
499
500
501 public function setJobs($jobs)
502 {
503 $this->jobs = $jobs;
504 }
505 public function getJobs()
506 {
507 return $this->jobs;
508 }
509 public function setNextPageToken($nextPageToken)
510 {
511 $this->nextPageToken = $nextPageToken;
512 }
513 public function getNextPageToken()
514 {
515 return $this->nextPageToken;
516 }
517 }
518
519 class Google_Service_YouTubeReporting_ListReportTypesResponse extends Google_Collection
520 {
521 protected $collection_key = 'reportTypes';
522 protected $internal_gapi_mappings = array(
523 );
524 public $nextPageToken;
525 protected $reportTypesType = 'Google_Service_YouTubeReporting_ReportType';
526 protected $reportTypesDataType = 'array';
527
528
529 public function setNextPageToken($nextPageToken)
530 {
531 $this->nextPageToken = $nextPageToken;
532 }
533 public function getNextPageToken()
534 {
535 return $this->nextPageToken;
536 }
537 public function setReportTypes($reportTypes)
538 {
539 $this->reportTypes = $reportTypes;
540 }
541 public function getReportTypes()
542 {
543 return $this->reportTypes;
544 }
545 }
546
547 class Google_Service_YouTubeReporting_ListReportsResponse extends Google_Collection
548 {
549 protected $collection_key = 'reports';
550 protected $internal_gapi_mappings = array(
551 );
552 public $nextPageToken;
553 protected $reportsType = 'Google_Service_YouTubeReporting_Report';
554 protected $reportsDataType = 'array';
555
556
557 public function setNextPageToken($nextPageToken)
558 {
559 $this->nextPageToken = $nextPageToken;
560 }
561 public function getNextPageToken()
562 {
563 return $this->nextPageToken;
564 }
565 public function setReports($reports)
566 {
567 $this->reports = $reports;
568 }
569 public function getReports()
570 {
571 return $this->reports;
572 }
573 }
574
575 class Google_Service_YouTubeReporting_Media extends Google_Model
576 {
577 protected $internal_gapi_mappings = array(
578 );
579 public $resourceName;
580
581
582 public function setResourceName($resourceName)
583 {
584 $this->resourceName = $resourceName;
585 }
586 public function getResourceName()
587 {
588 return $this->resourceName;
589 }
590 }
591
592 class Google_Service_YouTubeReporting_Report extends Google_Model
593 {
594 protected $internal_gapi_mappings = array(
595 );
596 public $createTime;
597 public $downloadUrl;
598 public $endTime;
599 public $id;
600 public $jobId;
601 public $startTime;
602
603
604 public function setCreateTime($createTime)
605 {
606 $this->createTime = $createTime;
607 }
608 public function getCreateTime()
609 {
610 return $this->createTime;
611 }
612 public function setDownloadUrl($downloadUrl)
613 {
614 $this->downloadUrl = $downloadUrl;
615 }
616 public function getDownloadUrl()
617 {
618 return $this->downloadUrl;
619 }
620 public function setEndTime($endTime)
621 {
622 $this->endTime = $endTime;
623 }
624 public function getEndTime()
625 {
626 return $this->endTime;
627 }
628 public function setId($id)
629 {
630 $this->id = $id;
631 }
632 public function getId()
633 {
634 return $this->id;
635 }
636 public function setJobId($jobId)
637 {
638 $this->jobId = $jobId;
639 }
640 public function getJobId()
641 {
642 return $this->jobId;
643 }
644 public function setStartTime($startTime)
645 {
646 $this->startTime = $startTime;
647 }
648 public function getStartTime()
649 {
650 return $this->startTime;
651 }
652 }
653
654 class Google_Service_YouTubeReporting_ReportType extends Google_Model
655 {
656 protected $internal_gapi_mappings = array(
657 );
658 public $id;
659 public $name;
660
661
662 public function setId($id)
663 {
664 $this->id = $id;
665 }
666 public function getId()
667 {
668 return $this->id;
669 }
670 public function setName($name)
671 {
672 $this->name = $name;
673 }
674 public function getName()
675 {
676 return $this->name;
677 }
678 }
679