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.
Modifies a playlist. For example, you could change a playlist's title, description, or privacy status.
Method Details
delete(id, onBehalfOfContentOwner=None)
Deletes a playlist.
Args:
id: string, 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. (required)
onBehalfOfContentOwner: string, 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.
Creates a playlist.
Args:
part: 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. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private.
#
# YouTube also uses playlists to identify special collections of videos for a channel, such as:
# - uploaded videos
# - favorite videos
# - positively rated (liked) videos
# - watch history
# - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel.
#
# You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.
"status": { # The status object contains status information for the playlist.
"privacyStatus": "A String", # The playlist's privacy status.
},
"kind": "youtube#playlist", # Identifies what kind of resource this is. Value: the fixed string "youtube#playlist".
"contentDetails": { # The contentDetails object contains information like video count.
"itemCount": 42, # The number of videos in the playlist.
},
"snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
"description": "A String", # The playlist's description.
"tags": [ # Keyword tags associated with the playlist.
"A String",
],
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
"publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"channelTitle": "A String", # The channel title of the channel that the video belongs to.
"title": "A String", # The playlist's title.
"defaultLanguage": "A String", # The language of the playlist's default title and description.
"localized": { # Playlist localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
},
},
"player": { # The player object contains information that you would use to play the playlist in an embedded player.
"embedHtml": "A String", # An
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.
Args:
part: string, 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. (required)
onBehalfOfContentOwner: string, 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.
pageToken: string, 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.
onBehalfOfContentOwnerChannel: string, 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.
hl: string, The hl parameter should be used for filter out the properties that are not in the given language. Used for the snippet part.
channelId: string, This value indicates that the API should only return the specified channel's playlists.
mine: boolean, Set this parameter's value to true to instruct the API to only return playlists owned by the authenticated user.
maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
id: string, 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.
Returns:
An object of the form:
{
"eventId": "A String", # Serialized EventId of the request which produced this response.
"nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
"kind": "youtube#playlistListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#playlistListResponse".
"visitorId": "A String", # The visitorId identifies the visitor.
"items": [ # A list of playlists that match the request criteria.
{ # A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private.
#
# YouTube also uses playlists to identify special collections of videos for a channel, such as:
# - uploaded videos
# - favorite videos
# - positively rated (liked) videos
# - watch history
# - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel.
#
# You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.
"status": { # The status object contains status information for the playlist.
"privacyStatus": "A String", # The playlist's privacy status.
},
"kind": "youtube#playlist", # Identifies what kind of resource this is. Value: the fixed string "youtube#playlist".
"contentDetails": { # The contentDetails object contains information like video count.
"itemCount": 42, # The number of videos in the playlist.
},
"snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
"description": "A String", # The playlist's description.
"tags": [ # Keyword tags associated with the playlist.
"A String",
],
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
"publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"channelTitle": "A String", # The channel title of the channel that the video belongs to.
"title": "A String", # The playlist's title.
"defaultLanguage": "A String", # The language of the playlist's default title and description.
"localized": { # Playlist localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
},
},
"player": { # The player object contains information that you would use to play the playlist in an embedded player.
"embedHtml": "A String", # An tag that embeds a player that will play the playlist.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the playlist.
"localizations": { # Localizations for different languages
"a_key": { # Playlist localization setting # The language tag, using string since map_key require simple types.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
},
},
],
"tokenPagination": { # Stub token pagination template to suppress results.
},
"etag": "A String", # Etag of this resource.
"prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
"pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
"totalResults": 42, # The total number of results in the result set.
"resultsPerPage": 42, # The number of results included in the API response.
},
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
update(part, body, onBehalfOfContentOwner=None)
Modifies a playlist. For example, you could change a playlist's title, description, or privacy status.
Args:
part: 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.
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. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private.
#
# YouTube also uses playlists to identify special collections of videos for a channel, such as:
# - uploaded videos
# - favorite videos
# - positively rated (liked) videos
# - watch history
# - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel.
#
# You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.
"status": { # The status object contains status information for the playlist.
"privacyStatus": "A String", # The playlist's privacy status.
},
"kind": "youtube#playlist", # Identifies what kind of resource this is. Value: the fixed string "youtube#playlist".
"contentDetails": { # The contentDetails object contains information like video count.
"itemCount": 42, # The number of videos in the playlist.
},
"snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
"description": "A String", # The playlist's description.
"tags": [ # Keyword tags associated with the playlist.
"A String",
],
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
"publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"channelTitle": "A String", # The channel title of the channel that the video belongs to.
"title": "A String", # The playlist's title.
"defaultLanguage": "A String", # The language of the playlist's default title and description.
"localized": { # Playlist localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
},
},
"player": { # The player object contains information that you would use to play the playlist in an embedded player.
"embedHtml": "A String", # An tag that embeds a player that will play the playlist.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the playlist.
"localizations": { # Localizations for different languages
"a_key": { # Playlist localization setting # The language tag, using string since map_key require simple types.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
},
}
onBehalfOfContentOwner: string, 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.
Returns:
An object of the form:
{ # A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private.
#
# YouTube also uses playlists to identify special collections of videos for a channel, such as:
# - uploaded videos
# - favorite videos
# - positively rated (liked) videos
# - watch history
# - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel.
#
# You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.
"status": { # The status object contains status information for the playlist.
"privacyStatus": "A String", # The playlist's privacy status.
},
"kind": "youtube#playlist", # Identifies what kind of resource this is. Value: the fixed string "youtube#playlist".
"contentDetails": { # The contentDetails object contains information like video count.
"itemCount": 42, # The number of videos in the playlist.
},
"snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
"description": "A String", # The playlist's description.
"tags": [ # Keyword tags associated with the playlist.
"A String",
],
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
"publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"channelTitle": "A String", # The channel title of the channel that the video belongs to.
"title": "A String", # The playlist's title.
"defaultLanguage": "A String", # The language of the playlist's default title and description.
"localized": { # Playlist localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
},
},
"player": { # The player object contains information that you would use to play the playlist in an embedded player.
"embedHtml": "A String", # An tag that embeds a player that will play the playlist.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the playlist.
"localizations": { # Localizations for different languages
"a_key": { # Playlist localization setting # The language tag, using string since map_key require simple types.
"description": "A String", # The localized strings for playlist's description.
"title": "A String", # The localized strings for playlist's title.
},
},
}