AutorÃa | Ultima modificación | Ver Log |
<?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.*/#[AllowDynamicProperties]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>*/#[AllowDynamicProperties]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>*/#[AllowDynamicProperties]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>*/#[AllowDynamicProperties]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>*/#[AllowDynamicProperties]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");}}#[AllowDynamicProperties]class Google_Service_YouTubeReporting_Empty extends Google_Model{}#[AllowDynamicProperties]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;}}#[AllowDynamicProperties]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;}}#[AllowDynamicProperties]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;}}#[AllowDynamicProperties]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;}}#[AllowDynamicProperties]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;}}#[AllowDynamicProperties]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;}}#[AllowDynamicProperties]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;}}