Documentation

Google_Service_YouTube_Resource_Subscriptions extends Google_Service_Resource
in package

The "subscriptions" collection of methods.

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

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.
delete()  : mixed
Deletes a resource. (subscriptions.delete)
insert()  : Google_Service_YouTube_Subscription
Inserts a new resource into this collection. (subscriptions.insert)
listSubscriptions()  : Google_Service_YouTube_SubscriptionListResponse
Retrieves a list of resources, possibly filtered.
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

delete()

Deletes a resource. (subscriptions.delete)

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

Optional parameters.

Return values
mixed —

insert()

Inserts a new resource into this collection. (subscriptions.insert)

public insert(string|array<string|int, mixed> $part, Google_Service_YouTube_Subscription $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_Subscription
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.

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

Optional parameters.

Return values
Google_Service_YouTube_Subscription —

listSubscriptions()

Retrieves a list of resources, possibly filtered.

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

(subscriptions.listSubscriptions)

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

The part parameter specifies a comma-separated list of one or more subscription 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 subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set part=snippet, the API response will also contain all of those nested properties.

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

Optional parameters.

Tags
opt_param

string channelId Return the subscriptions of the given channel owner.

opt_param

bool myRecentSubscribers

opt_param

string order The order of the returned subscriptions

opt_param

string onBehalfOfContentOwnerChannel This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

opt_param

string forChannelId Return the subscriptions to the subset of these channels that the authenticated user is subscribed to.

opt_param

bool mine Flag for returning the subscriptions of the authenticated user.

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 mySubscribers Return the subscribers of the given channel owner.

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 id Return the subscriptions with the given IDs for Stubby or Apiary.

opt_param

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

Return values
Google_Service_YouTube_SubscriptionListResponse —

convertToArrayAndStripNulls()

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

Search results