Video API, REST: Subtitle.Create

Field

Description

language

string

Subtitle language represented as a three-letter code according to ISO 639-2/T.

label

string

Contains the subtitle label (or title) that will be displayed on screen during video playback.
Should provide a concise and accurate representation of the spoken content.
If not provided, it will be auto-generated based on the specified language.

videoId

string

ID of the video.

Includes only one of the fields videoId.

upload

SubtitleUploadParams

Upload subtitle.

Includes only one of the fields upload.

Source type.

Field

Description

filename

string

Required field. Original filename of the subtitle file being uploaded.

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

CreateSubtitleMetadata

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

Subtitle

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

subtitleId

string

ID of the subtitle being created.

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 subtitle track.

language

string

Language of the subtitle content according to ISO 639-2/T.

label

string

Display label for the subtitle track shown in the video player's subtitle selection menu.

status

enum (SubtitleStatus)

Current processing status of the subtitle.

• SUBTITLE_STATUS_UNSPECIFIED: The subtitle status is not specified.
• WAIT_UPLOADING: The subtitle file upload is in progress, waiting for all bytes to be received.
• UPLOADED: The subtitle file has been fully uploaded and is ready for use.

sourceType

enum (SubtitleSourceType)

Indicates how the subtitle was created or obtained.

• SUBTITLE_SOURCE_TYPE_UNSPECIFIED: The subtitle source type is not specified.
• MANUAL: The subtitle was manually created and uploaded by a user.
• GENERATED: The subtitle was automatically generated through speech recognition.

filename

string

Original filename of the subtitle file.

createdAt

string (date-time)

Timestamp when the subtitle 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 subtitle 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).

videoId

string

Identifier of the video this subtitle belongs to.

Includes only one of the fields videoId.

Specifies the parent content this subtitle is associated with.