Video API, REST: Playlist.Create

Field

Description

channelId

string

Required field. ID of the channel where the playlist will be created.

The maximum string length in characters is 50.

title

string

Required field. Title of the playlist to be displayed in interfaces and players.

The maximum string length in characters is 300.

description

string

Detailed description of the playlist content and context.
Optional field that can provide additional information about the playlist.

The maximum string length in characters is 5000.

items[]

PlaylistItem

List of items to include in the playlist.
Each item represents a video or episode to be played in sequence.
The order of items in this list determines the playback order.

The maximum number of elements is 100.

stylePresetId

string

ID of the style preset to be applied to the playlist player.
Style presets control the visual appearance of the player.

The maximum string length in characters is 50.

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 videoId, episodeId.

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 videoId, episodeId.

Specifies the content identifier type for this playlist item.

position

string (int64)

Position of this item in the playlist sequence (zero-indexed).
Determines the playback order of content in the playlist.

Acceptable values are 0 to 100, inclusive.

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
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).

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
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).

done

boolean

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

object

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

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

object

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.

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.