Video API, REST: Playlist.Update
Updates an existing playlist's metadata and items.
Only fields specified in the field_mask will be updated.
HTTP request
PATCH https://video.api.yandexcloud.kz/video/v1/playlists/{playlistId}
Path parameters
|
Field |
Description |
|
playlistId |
string Required field. ID of the playlist to update. The maximum string length in characters is 50. |
Body parameters
{
"fieldMask": "string",
"title": "string",
"description": "string",
"items": [
{
// Includes only one of the fields `videoId`, `episodeId`
"videoId": "string",
"episodeId": "string",
// end of the list of possible fields
"position": "string"
}
],
"stylePresetId": "string"
}
|
Field |
Description |
|
fieldMask |
string (field-mask) Required field. A comma-separated names off ALL fields to be updated. If |
|
title |
string New title for the playlist. The maximum string length in characters is 300. |
|
description |
string New description for the playlist. The maximum string length in characters is 4000. |
|
items[] |
New list of items to include in the playlist. The maximum number of elements is 100. |
|
stylePresetId |
string New ID of the style preset to be applied to the playlist player. The maximum string length in characters is 50. |
PlaylistItem
Represents a single item in a playlist.
Each item references either a video or an episode and specifies its position in the sequence.
|
Field |
Description |
|
videoId |
string Identifier of a video included in the playlist. The maximum string length in characters is 50. Includes only one of the fields Specifies the content identifier type for this playlist item. |
|
episodeId |
string Identifier of an episode included in the playlist. The maximum string length in characters is 50. Includes only one of the fields Specifies the content identifier type for this playlist item. |
|
position |
string (int64) Position of this item in the playlist sequence (zero-indexed). Acceptable values are 0 to 100, inclusive. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"playlistId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"channelId": "string",
"title": "string",
"description": "string",
"items": [
{
// Includes only one of the fields `videoId`, `episodeId`
"videoId": "string",
"episodeId": "string",
// end of the list of possible fields
"position": "string"
}
],
"stylePresetId": "string",
"createdAt": "string",
"updatedAt": "string"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
createdBy |
string ID of the user or service account who initiated the operation. |
|
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
done |
boolean If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdatePlaylistMetadata
|
Field |
Description |
|
playlistId |
string ID of the playlist being updated. |
Status
The error result of the operation in case of failure or cancellation.
|
Field |
Description |
|
code |
integer (int32) Error code. An enum value of google.rpc.Code. |
|
message |
string An error message. |
|
details[] |
object A list of messages that carry the error details. |
Playlist
Entity representing an ordered collection of videos or episodes.
Playlists allow organizing content into sequences for improved user experience.
|
Field |
Description |
|
id |
string Unique identifier of the playlist. |
|
channelId |
string Identifier of the channel where this playlist is created and managed. |
|
title |
string Title of the playlist displayed in interfaces and players. |
|
description |
string Detailed description of the playlist's content and purpose. |
|
items[] |
Ordered list of content items included in this playlist. |
|
stylePresetId |
string Identifier of the style preset used in the player during playlist playback. |
|
createdAt |
string (date-time) Timestamp when the playlist was initially created in the system. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
updatedAt |
string (date-time) Timestamp of the last modification to the playlist or its metadata. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
PlaylistItem
Represents a single item in a playlist.
Each item references either a video or an episode and specifies its position in the sequence.
|
Field |
Description |
|
videoId |
string Identifier of a video included in the playlist. The maximum string length in characters is 50. Includes only one of the fields Specifies the content identifier type for this playlist item. |
|
episodeId |
string Identifier of an episode included in the playlist. The maximum string length in characters is 50. Includes only one of the fields Specifies the content identifier type for this playlist item. |
|
position |
string (int64) Position of this item in the playlist sequence (zero-indexed). Acceptable values are 0 to 100, inclusive. |