Video API, gRPC: StylePresetService.Create

Статья создана

Обновлена 25 ноября 2025 г.

gRPC request
CreateStylePresetRequest
Widget
Summarization
Description
operation.Operation
CreateStylePresetMetadata
StylePreset
Widget
Summarization
Description

Creates a new style preset in the specified channel with the provided visual settings.
Style presets define the appearance of players, including colors, spacing, borders, and widgets.

gRPC request

rpc Create (CreateStylePresetRequest) returns (operation.Operation)

CreateStylePresetRequest

{
  "channel_id": "string",
  "title": "string",
  "background_color": "string",
  "widget_text_color_primary": "string",
  "widget_text_color_secondary": "string",
  "widget_accent_color": "string",
  "widget_block_gap": "int64",
  "widget_block_separator_color": "string",
  "player_border_radius": "int64",
  "player_color": "string",
  "playlist_selected_item_background_color": "string",
  "playlist_item_border_radius": "int64",
  "playlist_item_gap": "int64",
  "playlist_location": "WidgetLocation",
  "right_widgets": [
    {
      // Includes only one of the fields `summarization`, `description`
      "summarization": "Summarization",
      "description": "Description"
      // end of the list of possible fields
    }
  ],
  "bottom_widgets": [
    {
      // Includes only one of the fields `summarization`, `description`
      "summarization": "Summarization",
      "description": "Description"
      // end of the list of possible fields
    }
  ]
}

Field	Description
channel_id	string Required field. ID of the channel. The maximum string length in characters is 50.
title	string Required field. Style preset title. The maximum string length in characters is 50.
background_color	string Required field. Background color. Value must match the regular expression `[#a-zA-Z0-9]+`. The maximum string length in characters is 50.
widget_text_color_primary	string Required field. Widget primary text color. Value must match the regular expression `[#a-zA-Z0-9]+`. The maximum string length in characters is 50.
widget_text_color_secondary	string Required field. Widget secondary text color. Value must match the regular expression `[#a-zA-Z0-9]+`. The maximum string length in characters is 50.
widget_accent_color	string Required field. Widget accent color. Value must match the regular expression `[#a-zA-Z0-9]+`. The maximum string length in characters is 50.
widget_block_gap	int64 Gap between widget blocks. Acceptable values are 0 to 50, inclusive.
widget_block_separator_color	string Required field. Line color between widget blocks. Value must match the regular expression `[#a-zA-Z0-9]+`. The maximum string length in characters is 50.
player_border_radius	int64 Player border radius. The minimum value is 0.
player_color	string Required field. Player color. Value must match the regular expression `[#a-zA-Z0-9]+`. The maximum string length in characters is 50.
playlist_selected_item_background_color	string Required field. 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.
playlist_item_border_radius	int64 Playlist item border radius. The minimum value is 0.
playlist_item_gap	int64 Gap between videos in playlist. Acceptable values are 0 to 50, inclusive.
playlist_location	enum WidgetLocation Required field. 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.
right_widgets[]	Widget List of widgets to display to the right of the player.
bottom_widgets[]	Widget List of widgets to display below the player.

Represents a UI component that displays additional content or functionality.
Widgets can be positioned in different locations around the player.

Field

Description

summarization

Summarization

Widget that displays video content summarization.

Includes only one of the fields summarization, description.

Specifies the type of widget to display.

description

Description

Widget that displays detailed video description.

Includes only one of the fields summarization, description.

Specifies the type of widget to display.

Widget that presents an automatically generated summary of the video content.
This helps viewers quickly understand the main points without watching the entire video.

Field	Description
Empty

Widget that displays the full description text for the video.
This can include details about the content, creators, and other relevant information.

Field	Description
Empty

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "style_preset_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "channel_id": "string",
    "title": "string",
    "background_color": "string",
    "widget_text_color_primary": "string",
    "widget_text_color_secondary": "string",
    "widget_accent_color": "string",
    "widget_block_gap": "int64",
    "widget_block_separator_color": "string",
    "player_border_radius": "int64",
    "player_color": "string",
    "playlist_selected_item_background_color": "string",
    "playlist_item_border_radius": "int64",
    "playlist_item_gap": "int64",
    "playlist_location": "WidgetLocation",
    "right_widgets": [
      {
        // Includes only one of the fields `summarization`, `description`
        "summarization": "Summarization",
        "description": "Description"
        // end of the list of possible fields
      }
    ],
    "bottom_widgets": [
      {
        // Includes only one of the fields `summarization`, `description`
        "summarization": "Summarization",
        "description": "Description"
        // end of the list of possible fields
      }
    ],
    "created_at": "google.protobuf.Timestamp",
    "updated_at": "google.protobuf.Timestamp"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	CreateStylePresetMetadata 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	google.rpc.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.

CreateStylePresetMetadata

Field

Description

style_preset_id

string

ID of the style preset being created.

Entity representing a collection of visual styling settings for content presentation.
Style presets define the appearance of players, widgets, and other UI elements
to ensure consistent branding and user experience.

Field	Description
id	string Unique identifier of the style preset.
channel_id	string Identifier of the channel where this style preset is created and managed.
title	string Display name of the style preset shown in interfaces.
background_color	string Background color for the player page in hexadecimal format (e.g., "#FFFFFF").
widget_text_color_primary	string Primary text color for widgets in hexadecimal format.
widget_text_color_secondary	string Secondary text color for widgets in hexadecimal format.
widget_accent_color	string Accent color for interactive elements in widgets in hexadecimal format.
widget_block_gap	int64 Vertical spacing between widget blocks in pixels.
widget_block_separator_color	string Color of separator lines between widget blocks in hexadecimal format.
player_border_radius	int64 Corner radius of the player container in pixels.
player_color	string Primary color for player controls in hexadecimal format.
playlist_selected_item_background_color	string Background color for the currently selected item in playlists in hexadecimal format.
playlist_item_border_radius	int64 Corner radius of playlist items in pixels.
playlist_item_gap	int64 Spacing between playlist items in pixels.
playlist_location	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.
right_widgets[]	Widget List of widgets to display to the right of the player.
bottom_widgets[]	Widget List of widgets to display below the player.
created_at	google.protobuf.Timestamp Timestamp when the style preset was initially created in the system.
updated_at	google.protobuf.Timestamp Timestamp of the last modification to the style preset or its metadata.

Widget

Represents a UI component that displays additional content or functionality.
Widgets can be positioned in different locations around the player.

Field

Description

summarization

Summarization

Widget that displays video content summarization.

Includes only one of the fields summarization, description.

Specifies the type of widget to display.

description

Description

Widget that displays detailed video description.

Includes only one of the fields summarization, description.

Specifies the type of widget to display.

Widget that presents an automatically generated summary of the video content.
This helps viewers quickly understand the main points without watching the entire video.

Field	Description
Empty

Widget that displays the full description text for the video.
This can include details about the content, creators, and other relevant information.

Field	Description
Empty

Video API, gRPC: StylePresetService.Create

gRPC requestgRPC request

CreateStylePresetRequestCreateStylePresetRequest

WidgetWidget

SummarizationSummarization

DescriptionDescription

operation.Operationoperation.Operation

CreateStylePresetMetadataCreateStylePresetMetadata

StylePresetStylePreset

WidgetWidget

SummarizationSummarization

DescriptionDescription

Была ли статья полезна?

gRPC request

CreateStylePresetRequest

Widget

Summarization

Description

operation.Operation

CreateStylePresetMetadata

StylePreset

Widget

Summarization

Description