Documentation

Google_Service_YouTubeReporting_Resource_JobsReports extends Google_Service_Resource
in package

The "reports" collection of methods.

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

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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_YouTubeReporting_Report
Gets the metadata of a specific report. (reports.get)
listJobsReports()  : Google_Service_YouTubeReporting_ListReportsResponse
Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist. (reports.listJobsReports)
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 —

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

get()

Gets the metadata of a specific report. (reports.get)

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

The ID of the job.

$reportId : string

The ID of the report 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_Report —

listJobsReports()

Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist. (reports.listJobsReports)

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

The ID of the job.

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

Optional parameters.

Tags
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 startTimeBefore If set, only reports whose start time is smaller than the specified date/time are returned.

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.

opt_param

string startTimeAtOrAfter If set, only reports whose start time is greater than or equal the specified date/time are returned.

opt_param

string createdAfter If set, only reports created after the specified date/time are returned.

Return values
Google_Service_YouTubeReporting_ListReportsResponse —

convertToArrayAndStripNulls()

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

Search results