Documentation

Google_Service_YouTube_Resource_Channels extends Google_Service_Resource
in package

The "channels" collection of methods.

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

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.
listChannels()  : Google_Service_YouTube_ChannelListResponse
Retrieves a list of resources, possibly filtered. (channels.listChannels)
update()  : Google_Service_YouTube_Channel
Updates an existing resource. (channels.update)
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

listChannels()

Retrieves a list of resources, possibly filtered. (channels.listChannels)

public listChannels(string|array<string|int, mixed> $part[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_ChannelListResponse
Parameters
$part : string|array<string|int, mixed>

The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested properties.

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

Optional parameters.

Tags
opt_param

bool managedByMe Return the channels managed by the authenticated user.

opt_param

string hl Stands for "host language". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).

opt_param

string onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

opt_param

bool mine Return the ids of channels owned by the authenticated user.

opt_param

string categoryId Return the channels within the specified guide category ID.

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.

opt_param

string forUsername Return the channel associated with a YouTube username.

opt_param

string id Return the channels with the specified IDs.

opt_param

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

opt_param

bool mySubscribers Return the channels subscribed to the authenticated user

Return values
Google_Service_YouTube_ChannelListResponse —

update()

Updates an existing resource. (channels.update)

public update(string|array<string|int, mixed> $part, Google_Service_YouTube_Channel $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_Channel
Parameters
$part : string|array<string|int, mixed>

The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The API currently only allows the parameter value to be set to either brandingSettings or invideoPromotion. (You cannot update both of those parts with a single request.) Note that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies.

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

Optional parameters.

Tags
opt_param

string onBehalfOfContentOwner The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.

Return values
Google_Service_YouTube_Channel —

convertToArrayAndStripNulls()

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

Search results