Update
|
|||||
|
|
Modifies a playlist. For example, you could change a playlist's title, description, or privacy status
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage your YouTube account
- See, edit, and permanently delete your YouTube videos, ratings, comments and captions
- View and manage your assets and associated content on YouTube
Input
This building block consumes 47 input parameters
Name | Format | Description |
---|---|---|
part Required |
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 |
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 |
contentDetails |
OBJECT |
|
contentDetails.itemCount |
INTEGER |
The number of videos in the playlist |
etag |
STRING |
Etag of this resource |
id |
STRING |
The ID that YouTube uses to uniquely identify the playlist |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#playlist" |
localizations |
OBJECT |
Localizations for different languages |
localizations.customKey |
OBJECT |
Add additional named properties |
localizations.customKey.description |
STRING |
The localized strings for playlist's description |
localizations.customKey.title |
STRING |
The localized strings for playlist's title |
player |
OBJECT |
|
player.embedHtml |
STRING |
An |
snippet |
OBJECT |
Basic details about a playlist, including title, description and thumbnails |
snippet.channelId |
STRING |
The ID that YouTube uses to uniquely identify the channel that published the playlist |
snippet.channelTitle |
STRING |
The channel title of the channel that the video belongs to |
snippet.defaultLanguage |
STRING |
The language of the playlist's default title and description |
snippet.description |
STRING |
The playlist's description |
snippet.localized |
OBJECT |
Playlist localization setting |
snippet.localized.description |
STRING |
The localized strings for playlist's description |
snippet.localized.title |
STRING |
The localized strings for playlist's title |
snippet.publishedAt |
DATE_TIME |
The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
snippet.tags[] |
STRING |
|
snippet.thumbnails |
OBJECT |
Internal representation of thumbnails for a YouTube resource |
snippet.thumbnails.default |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.default.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.default.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.default.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.high |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.high.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.high.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.high.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.maxres |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.maxres.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.maxres.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.maxres.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.medium |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.medium.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.medium.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.medium.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.standard |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.standard.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.standard.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.standard.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.title |
STRING |
The playlist's title |
status |
OBJECT |
|
status.privacyStatus |
ENUMERATION |
The playlist's privacy status |
= Parameter name
= Format
part STRING Required 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 |
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 |
contentDetails OBJECT |
contentDetails.itemCount INTEGER The number of videos in the playlist |
etag STRING Etag of this resource |
id STRING The ID that YouTube uses to uniquely identify the playlist |
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#playlist" |
localizations OBJECT Localizations for different languages |
localizations.customKey OBJECT Add additional named properties |
localizations.customKey.description STRING The localized strings for playlist's description |
localizations.customKey.title STRING The localized strings for playlist's title |
player OBJECT |
player.embedHtml STRING An |
snippet OBJECT Basic details about a playlist, including title, description and thumbnails |
snippet.channelId STRING The ID that YouTube uses to uniquely identify the channel that published the playlist |
snippet.channelTitle STRING The channel title of the channel that the video belongs to |
snippet.defaultLanguage STRING The language of the playlist's default title and description |
snippet.description STRING The playlist's description |
snippet.localized OBJECT Playlist localization setting |
snippet.localized.description STRING The localized strings for playlist's description |
snippet.localized.title STRING The localized strings for playlist's title |
snippet.publishedAt DATE_TIME The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
snippet.tags[] STRING |
snippet.thumbnails OBJECT Internal representation of thumbnails for a YouTube resource |
snippet.thumbnails.default OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.default.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.default.url STRING The thumbnail image's URL |
snippet.thumbnails.default.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.high OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.high.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.high.url STRING The thumbnail image's URL |
snippet.thumbnails.high.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.maxres OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.maxres.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.maxres.url STRING The thumbnail image's URL |
snippet.thumbnails.maxres.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.medium OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.medium.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.medium.url STRING The thumbnail image's URL |
snippet.thumbnails.medium.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.standard OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.standard.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.standard.url STRING The thumbnail image's URL |
snippet.thumbnails.standard.width INTEGER (Optional) Width of the thumbnail image |
snippet.title STRING The playlist's title |
status OBJECT |
status.privacyStatus ENUMERATION The playlist's privacy status |
Output
This building block provides 45 output parameters
Name | Format | Description |
---|---|---|
contentDetails |
OBJECT |
|
contentDetails.itemCount |
INTEGER |
The number of videos in the playlist |
etag |
STRING |
Etag of this resource |
id |
STRING |
The ID that YouTube uses to uniquely identify the playlist |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#playlist" |
localizations |
OBJECT |
Localizations for different languages |
localizations.customKey |
OBJECT |
Add additional named properties |
localizations.customKey.description |
STRING |
The localized strings for playlist's description |
localizations.customKey.title |
STRING |
The localized strings for playlist's title |
player |
OBJECT |
|
player.embedHtml |
STRING |
An |
snippet |
OBJECT |
Basic details about a playlist, including title, description and thumbnails |
snippet.channelId |
STRING |
The ID that YouTube uses to uniquely identify the channel that published the playlist |
snippet.channelTitle |
STRING |
The channel title of the channel that the video belongs to |
snippet.defaultLanguage |
STRING |
The language of the playlist's default title and description |
snippet.description |
STRING |
The playlist's description |
snippet.localized |
OBJECT |
Playlist localization setting |
snippet.localized.description |
STRING |
The localized strings for playlist's description |
snippet.localized.title |
STRING |
The localized strings for playlist's title |
snippet.publishedAt |
DATE_TIME |
The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
snippet.tags[] |
STRING |
|
snippet.thumbnails |
OBJECT |
Internal representation of thumbnails for a YouTube resource |
snippet.thumbnails.default |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.default.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.default.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.default.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.high |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.high.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.high.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.high.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.maxres |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.maxres.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.maxres.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.maxres.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.medium |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.medium.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.medium.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.medium.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.standard |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.standard.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.standard.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.standard.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.title |
STRING |
The playlist's title |
status |
OBJECT |
|
status.privacyStatus |
ENUMERATION |
The playlist's privacy status |
= Parameter name
= Format
contentDetails OBJECT |
contentDetails.itemCount INTEGER The number of videos in the playlist |
etag STRING Etag of this resource |
id STRING The ID that YouTube uses to uniquely identify the playlist |
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#playlist" |
localizations OBJECT Localizations for different languages |
localizations.customKey OBJECT Add additional named properties |
localizations.customKey.description STRING The localized strings for playlist's description |
localizations.customKey.title STRING The localized strings for playlist's title |
player OBJECT |
player.embedHtml STRING An |
snippet OBJECT Basic details about a playlist, including title, description and thumbnails |
snippet.channelId STRING The ID that YouTube uses to uniquely identify the channel that published the playlist |
snippet.channelTitle STRING The channel title of the channel that the video belongs to |
snippet.defaultLanguage STRING The language of the playlist's default title and description |
snippet.description STRING The playlist's description |
snippet.localized OBJECT Playlist localization setting |
snippet.localized.description STRING The localized strings for playlist's description |
snippet.localized.title STRING The localized strings for playlist's title |
snippet.publishedAt DATE_TIME The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
snippet.tags[] STRING |
snippet.thumbnails OBJECT Internal representation of thumbnails for a YouTube resource |
snippet.thumbnails.default OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.default.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.default.url STRING The thumbnail image's URL |
snippet.thumbnails.default.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.high OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.high.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.high.url STRING The thumbnail image's URL |
snippet.thumbnails.high.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.maxres OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.maxres.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.maxres.url STRING The thumbnail image's URL |
snippet.thumbnails.maxres.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.medium OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.medium.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.medium.url STRING The thumbnail image's URL |
snippet.thumbnails.medium.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.standard OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.standard.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.standard.url STRING The thumbnail image's URL |
snippet.thumbnails.standard.width INTEGER (Optional) Width of the thumbnail image |
snippet.title STRING The playlist's title |
status OBJECT |
status.privacyStatus ENUMERATION The playlist's privacy status |