Documentation

Google_Service_YouTubeReporting_Resource_Jobs extends Google_Service_Resource
in package

The "jobs" collection of methods.

Typical usage is: $youtubereportingService = new Google_Service_YouTubeReporting(...); $jobs = $youtubereportingService->jobs;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_YouTubeReporting_Job
Creates a job and returns it. (jobs.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_YouTubeReporting_YoutubereportingEmpty
Deletes a job. (jobs.delete)
get()  : Google_Service_YouTubeReporting_Job
Gets a job. (jobs.get)
listJobs()  : Google_Service_YouTubeReporting_ListJobsResponse
Lists jobs. (jobs.listJobs)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

Creates a job and returns it. (jobs.create)

public create(Google_Service_YouTubeReporting_Job $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTubeReporting_Job
Parameters
$postBody : Google_Service_YouTubeReporting_Job
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 values
Google_Service_YouTubeReporting_Job —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes a job. (jobs.delete)

public delete(string $jobId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTubeReporting_YoutubereportingEmpty
Parameters
$jobId : string

The ID of the job to delete.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 values
Google_Service_YouTubeReporting_YoutubereportingEmpty —

get()

Gets a job. (jobs.get)

public get(string $jobId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTubeReporting_Job
Parameters
$jobId : string

The ID of the job to retrieve.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 values
Google_Service_YouTubeReporting_Job —

listJobs()

Lists jobs. (jobs.listJobs)

public listJobs([array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTubeReporting_ListJobsResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default.

opt_param

bool 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.

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).

Return values
Google_Service_YouTubeReporting_ListJobsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results