Video API, gRPC: PlaylistService.Update

Written by

Yandex Cloud

Updated at April 24, 2025

gRPC request
UpdatePlaylistRequest
PlaylistItem
operation.Operation
UpdatePlaylistMetadata
Playlist
PlaylistItem

Update playlist.

gRPC request

rpc Update (UpdatePlaylistRequest) returns (operation.Operation)

UpdatePlaylistRequest

{
  "playlist_id": "string",
  "field_mask": "google.protobuf.FieldMask",
  "title": "string",
  "description": "string",
  "items": [
    {
      // Includes only one of the fields `video_id`, `episode_id`
      "video_id": "string",
      "episode_id": "string",
      // end of the list of possible fields
      "position": "int64"
    }
  ]
}

Field	Description
playlist_id	string Required field. ID of the playlist.
field_mask	google.protobuf.FieldMask Required field. Field mask that specifies which fields of the playlist are going to be updated.
title	string Playlist title.
description	string Playlist description.
items[]	PlaylistItem List of playlist items.

PlaylistItem

Field	Description
video_id	string ID of the video. Includes only one of the fields `video_id`, `episode_id`.
episode_id	string ID of the episode. Includes only one of the fields `video_id`, `episode_id`.
position	int64 Item position (zero-indexed).

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "playlist_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "channel_id": "string",
    "title": "string",
    "description": "string",
    "items": [
      {
        // Includes only one of the fields `video_id`, `episode_id`
        "video_id": "string",
        "episode_id": "string",
        // end of the list of possible fields
        "position": "int64"
      }
    ],
    "created_at": "google.protobuf.Timestamp",
    "updated_at": "google.protobuf.Timestamp"
  }
  // 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.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	UpdatePlaylistMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Playlist The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

UpdatePlaylistMetadata

Field

Description

playlist_id

string

ID of the playlist.

Playlist

Entity representing an ordered list of videos or episodes.

Field	Description
id	string ID of the playlist.
channel_id	string ID of the channel to create the playlist in.
title	string Playlist title.
description	string Playlist description.
items[]	PlaylistItem List of playlist items.
created_at	google.protobuf.Timestamp Time when playlist was created.
updated_at	google.protobuf.Timestamp Time of last playlist update.

PlaylistItem

Field	Description
video_id	string ID of the video. Includes only one of the fields `video_id`, `episode_id`.
episode_id	string ID of the episode. Includes only one of the fields `video_id`, `episode_id`.
position	int64 Item position (zero-indexed).

Video API, gRPC: PlaylistService.Update

gRPC request

UpdatePlaylistRequest

PlaylistItem

operation.Operation

UpdatePlaylistMetadata

Playlist

PlaylistItem

Was the article helpful?