Update
|
|||||
|
|
||||
Modifies a playlist item. For example, you could update the item's position in the playlist
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 all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist item can specify a start time and end time, which identify the times portion of the video that should play when users watch the video in the playlist. If your request is updating a playlist item that sets these values, and the request's part parameter value includes the contentDetails part, the playlist item's start and end times will be updated to whatever value the request body specifies. If the request body does not specify values, the existing start and end times will be removed and replaced with the default settings |
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.endAt |
STRING |
The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video |
contentDetails.note |
STRING |
A user-generated note for this item |
contentDetails.startAt |
STRING |
The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0 |
contentDetails.videoId |
STRING |
The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request |
contentDetails.videoPublishedAt |
DATE_TIME |
The date and time that the video was published to YouTube. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
etag |
STRING |
Etag of this resource |
id |
STRING |
The ID that YouTube uses to uniquely identify the playlist item |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#playlistItem" |
snippet |
OBJECT |
Basic details about a playlist, including title, description and thumbnails |
snippet.channelId |
STRING |
The ID that YouTube uses to uniquely identify the user that added the item to the playlist |
snippet.channelTitle |
STRING |
Channel title for the channel that the playlist item belongs to |
snippet.description |
STRING |
The item's description |
snippet.playlistId |
STRING |
The ID that YouTube uses to uniquely identify the playlist that the playlist item is in |
snippet.position |
INTEGER |
The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth |
snippet.publishedAt |
DATE_TIME |
The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
snippet.resourceId |
OBJECT |
A resource id is a generic reference that points to another YouTube resource |
snippet.resourceId.channelId |
STRING |
The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel |
snippet.resourceId.kind |
STRING |
The type of the API resource |
snippet.resourceId.playlistId |
STRING |
The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist |
snippet.resourceId.videoId |
STRING |
The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video |
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 item's title |
status |
OBJECT |
Information about the playlist item's privacy status |
status.privacyStatus |
ENUMERATION |
This resource'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 all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist item can specify a start time and end time, which identify the times portion of the video that should play when users watch the video in the playlist. If your request is updating a playlist item that sets these values, and the request's part parameter value includes the contentDetails part, the playlist item's start and end times will be updated to whatever value the request body specifies. If the request body does not specify values, the existing start and end times will be removed and replaced with the default settings |
|
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.endAt STRING The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video |
|
contentDetails.note STRING A user-generated note for this item |
|
contentDetails.startAt STRING The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0 |
|
contentDetails.videoId STRING The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request |
|
contentDetails.videoPublishedAt DATE_TIME The date and time that the video was published to YouTube. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
|
etag STRING Etag of this resource |
|
id STRING The ID that YouTube uses to uniquely identify the playlist item |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#playlistItem" |
|
snippet OBJECT Basic details about a playlist, including title, description and thumbnails |
|
snippet.channelId STRING The ID that YouTube uses to uniquely identify the user that added the item to the playlist |
|
snippet.channelTitle STRING Channel title for the channel that the playlist item belongs to |
|
snippet.description STRING The item's description |
|
snippet.playlistId STRING The ID that YouTube uses to uniquely identify the playlist that the playlist item is in |
|
snippet.position INTEGER The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth |
|
snippet.publishedAt DATE_TIME The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
|
snippet.resourceId OBJECT A resource id is a generic reference that points to another YouTube resource |
|
snippet.resourceId.channelId STRING The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel |
|
snippet.resourceId.kind STRING The type of the API resource |
|
snippet.resourceId.playlistId STRING The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist |
|
snippet.resourceId.videoId STRING The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video |
|
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 item's title |
|
status OBJECT Information about the playlist item's privacy status |
|
status.privacyStatus ENUMERATION This resource's privacy status |
Output
This building block provides 45 output parameters
| Name | Format | Description |
|---|---|---|
contentDetails |
OBJECT |
|
contentDetails.endAt |
STRING |
The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video |
contentDetails.note |
STRING |
A user-generated note for this item |
contentDetails.startAt |
STRING |
The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0 |
contentDetails.videoId |
STRING |
The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request |
contentDetails.videoPublishedAt |
DATE_TIME |
The date and time that the video was published to YouTube. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
etag |
STRING |
Etag of this resource |
id |
STRING |
The ID that YouTube uses to uniquely identify the playlist item |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#playlistItem" |
snippet |
OBJECT |
Basic details about a playlist, including title, description and thumbnails |
snippet.channelId |
STRING |
The ID that YouTube uses to uniquely identify the user that added the item to the playlist |
snippet.channelTitle |
STRING |
Channel title for the channel that the playlist item belongs to |
snippet.description |
STRING |
The item's description |
snippet.playlistId |
STRING |
The ID that YouTube uses to uniquely identify the playlist that the playlist item is in |
snippet.position |
INTEGER |
The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth |
snippet.publishedAt |
DATE_TIME |
The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
snippet.resourceId |
OBJECT |
A resource id is a generic reference that points to another YouTube resource |
snippet.resourceId.channelId |
STRING |
The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel |
snippet.resourceId.kind |
STRING |
The type of the API resource |
snippet.resourceId.playlistId |
STRING |
The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist |
snippet.resourceId.videoId |
STRING |
The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video |
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 item's title |
status |
OBJECT |
Information about the playlist item's privacy status |
status.privacyStatus |
ENUMERATION |
This resource's privacy status |
= Parameter name
= Format
|
contentDetails OBJECT |
|
contentDetails.endAt STRING The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video |
|
contentDetails.note STRING A user-generated note for this item |
|
contentDetails.startAt STRING The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0 |
|
contentDetails.videoId STRING The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request |
|
contentDetails.videoPublishedAt DATE_TIME The date and time that the video was published to YouTube. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
|
etag STRING Etag of this resource |
|
id STRING The ID that YouTube uses to uniquely identify the playlist item |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#playlistItem" |
|
snippet OBJECT Basic details about a playlist, including title, description and thumbnails |
|
snippet.channelId STRING The ID that YouTube uses to uniquely identify the user that added the item to the playlist |
|
snippet.channelTitle STRING Channel title for the channel that the playlist item belongs to |
|
snippet.description STRING The item's description |
|
snippet.playlistId STRING The ID that YouTube uses to uniquely identify the playlist that the playlist item is in |
|
snippet.position INTEGER The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth |
|
snippet.publishedAt DATE_TIME The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
|
snippet.resourceId OBJECT A resource id is a generic reference that points to another YouTube resource |
|
snippet.resourceId.channelId STRING The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel |
|
snippet.resourceId.kind STRING The type of the API resource |
|
snippet.resourceId.playlistId STRING The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist |
|
snippet.resourceId.videoId STRING The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video |
|
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 item's title |
|
status OBJECT Information about the playlist item's privacy status |
|
status.privacyStatus ENUMERATION This resource's privacy status |