SubscriptionsApi
extends AbstractApi
in package
This file is generated from spec/discovery.json (YouTube Data API v3, revision 20260924) by tools/generate.php. Do not edit it by hand - run `composer spec:build` instead.
Subscriptions between channels.
Reach it as $youtube->subscriptions. Every method takes the parameters Google
documents, by the same names: use named arguments for the optional ones.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- delete() : PromiseInterface<string|int, null>
- Deletes a resource.
- insert() : PromiseInterface<string|int, Subscription>
- Inserts a new resource into this collection.
- list() : PromiseInterface<string|int, SubscriptionListResponse>
- Retrieves a list of resources, possibly filtered.
- call() : PromiseInterface<string|int, mixed>
- streamed() : PromiseInterface<string|int, ResponseStream>
- Opens a server-streamed call and reads its body as it arrives.
Properties
$youtube read-only
protected
YouTube
$youtube
Methods
__construct()
public
__construct(YouTube $youtube) : mixed
Parameters
- $youtube : YouTube
delete()
Deletes a resource.
public
delete(string $id) : PromiseInterface<string|int, null>
Costs 50 units of quota.
Parameters
- $id : string
Tags
Return values
PromiseInterface<string|int, null>insert()
Inserts a new resource into this collection.
public
insert(array<int, string>|string $part, Subscription|array<string, mixed> $body) : PromiseInterface<string|int, Subscription>
Costs 50 units of quota.
Parameters
- $part : array<int, string>|string
-
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.
- $body : Subscription|array<string, mixed>
-
The Subscription to send.
Tags
Return values
PromiseInterface<string|int, Subscription>list()
Retrieves a list of resources, possibly filtered.
public
list(array<int, string>|string $part[, string|null $channelId = null ][, string|null $forChannelId = null ][, array<int, string>|string|null $id = null ][, int|null $maxResults = null ][, bool|null $mine = null ][, bool|null $myRecentSubscribers = null ][, bool|null $mySubscribers = null ][, string|null $onBehalfOfContentOwner = null ][, string|null $onBehalfOfContentOwnerChannel = null ][, string|null $order = null ][, string|null $pageToken = null ]) : PromiseInterface<string|int, SubscriptionListResponse>
Costs 1 unit of quota.
Parameters
- $part : array<int, string>|string
-
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.
- $channelId : string|null = null
-
Return the subscriptions of the given channel owner.
- $forChannelId : string|null = null
-
Return the subscriptions to the subset of these channels that the authenticated user is subscribed to.
- $id : array<int, string>|string|null = null
-
Return the subscriptions with the given IDs for Stubby or Apiary.
- $maxResults : int|null = null
-
The maxResults parameter specifies the maximum number of items that should be returned in the result set. From 0 to 50. YouTube assumes
5when it is left out. - $mine : bool|null = null
-
Flag for returning the subscriptions of the authenticated user.
- $myRecentSubscribers : bool|null = null
- $mySubscribers : bool|null = null
-
Return the subscribers of the given channel owner.
- $onBehalfOfContentOwner : string|null = null
-
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.
- $onBehalfOfContentOwnerChannel : string|null = null
-
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.
- $order : string|null = null
-
The order of the returned subscriptions One of
subscriptionOrderUnspecified,relevance,unread,alphabetical. YouTube assumesrelevancewhen it is left out. - $pageToken : string|null = null
-
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.
Tags
Return values
PromiseInterface<string|int, SubscriptionListResponse>call()
protected
call(string $endpoint, string $method, string $path[, array<string, mixed> $query = [] ][, array<string, mixed>|JsonSerializable|null $body = null ][, string|null $returns = null ][, ?Media $media = null ][, ?string $uploadPath = null ][, bool $download = false ]) : PromiseInterface<string|int, mixed>
Parameters
- $endpoint : string
-
The API method, e.g.
liveChatMessages.list. - $method : string
- $path : string
- $query : array<string, mixed> = []
- $body : array<string, mixed>|JsonSerializable|null = null
- $returns : string|null = null
-
The type token the result hydrates as; null leaves it raw.
- $media : ?Media = null
- $uploadPath : ?string = null
- $download : bool = false
Return values
PromiseInterface<string|int, mixed>streamed()
Opens a server-streamed call and reads its body as it arrives.
protected
streamed(string $endpoint, string $path, array<string, mixed> $query, string $returns) : PromiseInterface<string|int, ResponseStream>
Parameters
- $endpoint : string
- $path : string
- $query : array<string, mixed>
- $returns : string
-
The type token each element hydrates as.