The "playlists" collection of methods. Typical usage is:
$youtubeService = new Google_Service_YouTube(...);
$playlists = $youtubeService->playlists;
Methods summary
public
|
#
delete( string $id, array $optParams = array() )
Deletes a playlist. (playlists.delete)
Deletes a playlist. (playlists.delete)
Parameters
- $id
- The id parameter specifies the YouTube playlist ID for the playlist that is
being deleted. In a playlist resource, the id property specifies the playlist's
ID.
- $optParams
- Optional parameters.
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.
|
public
Google_Service_YouTube_Playlist
|
#
insert( string $part, Google_Service_YouTube_Playlist $postBody, array $optParams = array() )
Creates a playlist. (playlists.insert)
Creates a playlist. (playlists.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
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.
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.
|
public
Google_Service_YouTube_PlaylistListResponse
|
#
listPlaylists( string $part, array $optParams = array() )
Returns a collection of playlists that match the API request parameters. For
example, you can retrieve all playlists that the authenticated user owns, or you
can retrieve one or more playlists by their unique IDs.
(playlists.listPlaylists)
Returns a collection of playlists that match the API request parameters. For
example, you can retrieve all playlists that the authenticated user owns, or you
can retrieve one or more playlists by their unique IDs.
(playlists.listPlaylists)
Parameters
- $part
- The part parameter specifies a comma-separated list of one or more playlist
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 playlist resource, the snippet
property contains properties like author, title, description, tags, and
timeCreated. As such, if you set part=snippet, the API response will contain all
of those properties.
- $optParams
- Optional parameters.
Returns
Opt_param
string channelId This value indicates that the API should only return the
specified channel's playlists.
string hl The hl parameter should be used for filter out the properties that are
not in the given language. Used for the snippet part.
string id The id parameter specifies a comma-separated list of the YouTube
playlist ID(s) for the resource(s) that are being retrieved. In a playlist
resource, the id property specifies the playlist's YouTube playlist 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 instruct the API to only return
playlists owned by the authenticated user.
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 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_Playlist
|
#
update( string $part, Google_Service_YouTube_Playlist $postBody, array $optParams = array() )
Modifies a playlist. For example, you could change a playlist's title,
description, or privacy status. (playlists.update)
Modifies a playlist. For example, you could change a playlist's title,
description, or privacy status. (playlists.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. Note that this method will override the existing
values for mutable properties that are contained in any parts that the request
body specifies. For example, a playlist's description is contained in the
snippet part, which must be included in the request body. If the request does
not specify a value for the snippet.description property, the playlist's
existing description will be deleted.
- $postBody
- $optParams
- Optional parameters.
Returns
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.
|
Google_Service_YouTube_Playlists_Resource