Video API, gRPC: ThumbnailService.List
Lists all thumbnails associated with a specific resource (channel, stream, video, etc.)
with pagination support.
gRPC request
rpc List (ListThumbnailRequest) returns (ListThumbnailResponse)
ListThumbnailRequest
{
"channel_id": "string",
// Includes only one of the fields `episode_id`, `video_id`
"episode_id": "string",
"video_id": "string",
// end of the list of possible fields
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
channel_id |
string [Deprecated] ID of the channel. The maximum string length in characters is 50. |
|
episode_id |
string ID of the episode containing the thumbnails to list. The maximum string length in characters is 50. Includes only one of the fields |
|
video_id |
string ID of the video containing the thumbnails to list. The maximum string length in characters is 50. Includes only one of the fields |
|
page_size |
int64 The maximum number of thumbnails to return per page. The maximum value is 100. |
|
page_token |
string Page token for retrieving the next page of results. The maximum string length in characters is 15000. |
ListThumbnailResponse
{
"thumbnails": [
{
"id": "string",
"channel_id": "string",
// Includes only one of the fields `episode_id`, `video_id`
"episode_id": "string",
"video_id": "string",
// end of the list of possible fields
"created_at": "google.protobuf.Timestamp"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
thumbnails[] |
List of thumbnails matching the request criteria. |
|
next_page_token |
string Token for retrieving the next page of results. |
Thumbnail
Entity representing an image used as a visual representation for various content entities.
Thumbnails provide preview images for channels, streams, episodes, videos, and stream lines.
|
Field |
Description |
|
id |
string Unique identifier of the thumbnail. |
|
channel_id |
string Identifier of the channel where the thumbnail is created and managed. |
|
episode_id |
string ID of the episode which the thumbnail is associated with. Includes only one of the fields |
|
video_id |
string ID of the video which the thumbnail is associated with. Includes only one of the fields |
|
created_at |
Timestamp when the thumbnail was initially created in the system. |