Documentation

Google_Service_YouTube_Resource_Sponsors extends Google_Service_Resource
in package

The "sponsors" collection of methods.

Typical usage is: $youtubeService = new Google_Service_YouTube(...); $sponsors = $youtubeService->sponsors;

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.
listSponsors()  : Google_Service_YouTube_SponsorListResponse
Retrieves a list of sponsors that match the request criteria for a channel.
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

listSponsors()

Retrieves a list of sponsors that match the request criteria for a channel.

public listSponsors(string|array<string|int, mixed> $part[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_SponsorListResponse

(sponsors.listSponsors)

Parameters
$part : string|array<string|int, mixed>

The part parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet.

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

Optional parameters.

Tags
opt_param

string filter Parameter that specifies which channel sponsors to return.

opt_param

string maxResults The maxResults parameter specifies the maximum number of items that should be returned in the result set.

opt_param

string pageToken The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

Return values
Google_Service_YouTube_SponsorListResponse —

convertToArrayAndStripNulls()

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

Search results