Class Google_Service_YouTube_Channels_Resource
The "channels" collection of methods. Typical usage is:
$youtubeService = new Google_Service_YouTube(...);
$channels = $youtubeService->channels;
-
Google_Service_Resource
-
Google_Service_YouTube_Channels_Resource
Located at YouTube.php
Methods summary
public
Google_Service_YouTube_ChannelListResponse
|
#
listChannels( string $part, array $optParams = array() )
Returns a collection of zero or more channel resources that match the request
criteria. (channels.listChannels)
Returns a collection of zero or more channel resources that match the request
criteria. (channels.listChannels)
Parameters
- $part
- 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
- Optional parameters.
Returns
Opt_param
string categoryId The categoryId parameter specifies a YouTube guide category,
thereby requesting YouTube channels associated with that category.
string forUsername The forUsername parameter specifies a YouTube username,
thereby requesting the channel associated with that username.
string hl The hl parameter should be used for filter out the properties that are
not in the given language. Used for the brandingSettings part.
string id The id parameter specifies a comma-separated list of the YouTube
channel ID(s) for the resource(s) that are being retrieved. In a channel
resource, the id property specifies the channel's YouTube channel ID.
bool managedByMe Note: This parameter is intended exclusively for YouTube
content partners. Set this parameter's value to true to instruct the API to only
return channels managed by the content owner that the onBehalfOfContentOwner
parameter specifies. The user must be authenticated as a CMS account linked to
the specified content owner and onBehalfOfContentOwner must be provided.
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 instruct the API to only return
channels owned by the authenticated user.
bool mySubscribers Use the subscriptions.list method and its mySubscribers
parameter to retrieve a list of subscribers to the authenticated user's channel.
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 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.
|
public
Google_Service_YouTube_Channel
|
#
update( string $part, Google_Service_YouTube_Channel $postBody, array $optParams = array() )
Updates a channel's metadata. Note that this method currently only supports
updates to the channel resource's brandingSettings and invideoPromotion objects
and their child properties. (channels.update)
Updates a channel's metadata. Note that this method currently only supports
updates to the channel resource's brandingSettings and invideoPromotion objects
and their child properties. (channels.update)
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. 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
- $optParams
- Optional parameters.
Returns
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.
|