Class Google_Service_YouTube_Subscriptions_Resource
The "subscriptions" collection of methods. Typical usage is:
$youtubeService = new Google_Service_YouTube(...);
$subscriptions = $youtubeService->subscriptions;
-
Google_Service_Resource
-
Google_Service_YouTube_Subscriptions_Resource
Located at YouTube.php
Methods summary
public
|
#
delete( string $id, array $optParams = array() )
Deletes a subscription. (subscriptions.delete)
Deletes a subscription. (subscriptions.delete)
Parameters
- $id
- The id parameter specifies the YouTube subscription ID for the resource that is
being deleted. In a subscription resource, the id property specifies the YouTube
subscription ID.
- $optParams
- Optional parameters.
|
public
Google_Service_YouTube_Subscription
|
#
insert( string $part, Google_Service_YouTube_Subscription $postBody, array $optParams = array() )
Adds a subscription for the authenticated user's channel.
(subscriptions.insert)
Adds a subscription for the authenticated user's channel.
(subscriptions.insert)
Parameters
- $part
- 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
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_YouTube_SubscriptionListResponse
|
#
listSubscriptions( string $part, array $optParams = array() )
Returns subscription resources that match the API request criteria.
(subscriptions.listSubscriptions)
Returns subscription resources that match the API request criteria.
(subscriptions.listSubscriptions)
Parameters
- $part
- 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
- Optional parameters.
Returns
Opt_param
string channelId The channelId parameter specifies a YouTube channel ID. The API
will only return that channel's subscriptions.
string forChannelId The forChannelId parameter specifies a comma- separated list
of channel IDs. The API response will then only contain subscriptions matching
those channels.
string id The id parameter specifies a comma-separated list of the YouTube
subscription ID(s) for the resource(s) that are being retrieved. In a
subscription resource, the id property specifies the YouTube subscription ID.
string maxResults The maxResults parameter specifies the maximum number of items
that should be returned in the result set.
bool mine Set this parameter's value to true to retrieve a feed of the
authenticated user's subscriptions.
bool myRecentSubscribers Set this parameter's value to true to retrieve a feed
of the subscribers of the authenticated user in reverse chronological order
(newest first).
bool mySubscribers Set this parameter's value to true to retrieve a feed of the
subscribers of the authenticated user in no particular order.
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.
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.
string order The order parameter specifies the method that will be used to sort
resources in the API response.
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.
|