Video API, REST: StylePreset.Update

Field

Description

stylePresetId

string

Required field. ID of the style preset.

The maximum string length in characters is 50.

Field

Description

fieldMask

string (field-mask)

Required field. A comma-separated names off ALL fields to be updated.
Only the specified fields will be changed. The others will be left untouched.
If the field is specified in updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default.

title

string

Style preset title.

The maximum string length in characters is 50.

backgroundColor

string

Background color.

Value must match the regular expression [#a-zA-Z0-9-]*. The maximum string length in characters is 50.

widgetTextColorPrimary

string

Widget primary text color.

Value must match the regular expression [#a-zA-Z0-9-]*. The maximum string length in characters is 50.

widgetTextColorSecondary

string

Widget secondary text color.

Value must match the regular expression [#a-zA-Z0-9-]*. The maximum string length in characters is 50.

widgetAccentColor

string

Widget accent color.

Value must match the regular expression [#a-zA-Z0-9-]*. The maximum string length in characters is 50.

widgetBlockGap

string (int64)

Gap between widget blocks.

Acceptable values are 0 to 50, inclusive.

widgetBlockSeparatorColor

string

Line color between widget blocks.

Value must match the regular expression [#a-zA-Z0-9-]*. The maximum string length in characters is 50.

playerBorderRadius

string (int64)

Player border radius.

The minimum value is 0.

playerColor

string

Player color.

Value must match the regular expression [#a-zA-Z0-9]*. The maximum string length in characters is 50.

playlistSelectedItemBackgroundColor

string

Background color of selected video in playlist.

Value must match the regular expression [#a-zA-Z0-9]*. The maximum string length in characters is 50.

playlistItemBorderRadius

string (int64)

Playlist item border radius.

The minimum value is 0.

playlistItemGap

string (int64)

Gap between videos in playlist.

Acceptable values are 0 to 50, inclusive.

playlistLocation

enum (WidgetLocation)

Playlist widget location.

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

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.

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

UpdateStylePresetMetadata

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

StylePreset

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

stylePresetId

string

ID of the style preset being updated.

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.

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.