Video API, gRPC: PlaylistService.Get
Written by
Updated at November 26, 2024
Returns the specific playlist.
gRPC request
rpc Get (GetPlaylistRequest) returns (Playlist)
GetPlaylistRequest
{
"playlist_id": "string"
}
|
Field |
Description |
|
playlist_id |
string Required field. ID of the playlist. |
Playlist
{
"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"
}
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[] |
List of playlist items. |
|
created_at |
Time when playlist was created. |
|
updated_at |
Time of last playlist update. |
PlaylistItem
|
Field |
Description |
|
video_id |
string ID of the video. Includes only one of the fields |
|
episode_id |
string ID of the episode. Includes only one of the fields |
|
position |
int64 Item position (zero-indexed). |