Video API, REST: Video.List

Field

Description

channelId

string

Required field. ID of the channel.

pageSize

string (int64)

The maximum number of the results per page to return. Default value: 100.

pageToken

string

Page token for getting the next page of the result.

orderBy

string

By which column the listing should be ordered and in which direction,
format is "createdAt desc". "id asc" if omitted.
Possible fields: ["id", "createdAt", "updatedAt"]
Both snake_case and camelCase are supported for fields.

filter

string

Filter expression that filters resources listed in the response.
Expressions are composed of terms connected by logic operators.
Value in quotes: ' or "
Example: "key1='value' AND key2='value'"
Supported operators: ["AND"].
Supported fields: ["title", "status", "visibility_status"]
Both snake_case and camelCase are supported for fields.

Field

Description

videos[]

Video

nextPageToken

string

Token for getting the next page.

Field

Description

id

string

ID of the video.

channelId

string

ID of the channel where the video was created.

title

string

Video title.

description

string

Video description.

thumbnailId

string

ID of the thumbnail.

status

enum (VideoStatus)

Video status.

• VIDEO_STATUS_UNSPECIFIED: Video status unspecified.
• WAIT_UPLOADING: Waiting for the whole number of bytes to be loaded.
• PROCESSING: Video processing.
• READY: Video is ready, processing is completed.
• ERROR: An error occurred during video processing.

duration

string (duration)

Video duration. Optional, may be empty until the transcoding result is ready.

visibilityStatus

enum (VisibilityStatus)

Video visibility status.

• VISIBILITY_STATUS_UNSPECIFIED: Visibility status unspecified.
• PUBLISHED: Video is published and available for viewing.
• UNPUBLISHED: Video is unpublished, only admin can watch.

autoTranscode

enum (AutoTranscode)

Auto start transcoding.
If set to ENABLE, transcoding process is initiated automatically after video upload.
If set to DISABLE, manual "Transcode()" call is required instead.

• AUTO_TRANSCODE_UNSPECIFIED: Unspecified auto transcoding value.
• ENABLE: Enable auto transcoding.
• DISABLE: Disable auto transcoding.

subtitleIds[]

string

IDs of active video subtitles.

tusd

VideoTUSDSource

Upload video using the tus protocol.

Includes only one of the fields tusd.

Source type.

publicAccess

object

Video is available to everyone.

Includes only one of the fields publicAccess, authSystemAccess, signUrlAccess.

Video access rights.

authSystemAccess

object

Checking access rights using the authorization system.

Includes only one of the fields publicAccess, authSystemAccess, signUrlAccess.

Video access rights.

signUrlAccess

object

Checking access rights using url's signature.

Includes only one of the fields publicAccess, authSystemAccess, signUrlAccess.

Video access rights.

createdAt

string (date-time)

Time when video was created.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

updatedAt

string (date-time)

Time of last video update.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

labels

object (map<string, string>)

Custom labels as key:value pairs. Maximum 64 per resource.

Field

Description

url

string

URL for uploading video via the tus protocol.