Video API, REST: StylePreset.List

Field

Description

channelId

string

Required field. ID of the channel containing the style presets to list.

The maximum string length in characters is 50.

pageSize

string (int64)

The maximum number of style presets to return per page.

The maximum value is 100.

pageToken

string

Page token for retrieving the next page of results.
This token is obtained from the next_page_token field in the previous ListStylePresetsResponse.

The maximum string length in characters is 15000.

orderBy

string

Specifies the ordering of results.
Format is "<field> <order>" (e.g., "createdAt desc").
Default: "id asc".
Supported fields: ["id", "title", "createdAt", "updatedAt"].
Both snake_case and camelCase field names are supported.

The maximum string length in characters is 50.

filter

string

Filter expression to narrow down the list of returned style presets.
Expressions consist of terms connected by logical operators.
Values containing spaces or quotes must be enclosed in quotes (' or ")
with inner quotes being backslash-escaped.

Supported logical operators: ["AND", "OR"].
Supported comparison operators: ["=", "!=", ":"] where ":" enables substring matching.
Parentheses can be used to group logical expressions.

Example: title:'dark' AND id='preset-1'

Filterable fields: ["id", "title"].
Both snake_case and camelCase field names are supported.

The maximum string length in characters is 1000.

Field

Description

stylePresets[]

StylePreset

List of style presets matching the request criteria.
May be empty if no style presets match the criteria or if the channel has no style presets.

nextPageToken

string

Token for retrieving the next page of results.
Empty if there are no more results available.

Field

Description

id

string

Unique identifier of the style preset.

channelId

string

Identifier of the channel where this style preset is created and managed.

title

string

Display name of the style preset shown in interfaces.

backgroundColor

string

Background color for the player page in hexadecimal format (e.g., "#FFFFFF").

widgetTextColorPrimary

string

Primary text color for widgets in hexadecimal format.

widgetTextColorSecondary

string

Secondary text color for widgets in hexadecimal format.

widgetAccentColor

string

Accent color for interactive elements in widgets in hexadecimal format.

widgetBlockGap

string (int64)

Vertical spacing between widget blocks in pixels.

widgetBlockSeparatorColor

string

Color of separator lines between widget blocks in hexadecimal format.

playerBorderRadius

string (int64)

Corner radius of the player container in pixels.

playerColor

string

Primary color for player controls in hexadecimal format.

playlistSelectedItemBackgroundColor

string

Background color for the currently selected item in playlists in hexadecimal format.

playlistItemBorderRadius

string (int64)

Corner radius of playlist items in pixels.

playlistItemGap

string (int64)

Spacing between playlist items in pixels.

playlistLocation

enum (WidgetLocation)

Position of the playlist widget relative to the player.

• WIDGET_LOCATION_UNSPECIFIED: The widget location is not specified.
• RIGHT: Position the widget to the right of the player.
• BOTTOM: Position the widget below the player.

rightWidgets[]

Widget

List of widgets to display to the right of the player.

bottomWidgets[]

Widget

List of widgets to display below the player.

createdAt

string (date-time)

Timestamp when the style preset was initially created in the system.

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)

Timestamp of the last modification to the style preset or its metadata.

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

Field

Description

summarization

object

Widget that displays video content summarization.

Includes only one of the fields summarization, description.

Specifies the type of widget to display.

description

object

Widget that displays detailed video description.

Includes only one of the fields summarization, description.

Specifies the type of widget to display.