Video API, gRPC: VideoService.Update

Written by

Yandex Cloud

Updated at April 24, 2025

gRPC request
UpdateVideoRequest
VideoPublicAccessParams
VideoSignURLAccessParams
operation.Operation
UpdateVideoMetadata
Video
VideoFeatures
Summary
SummaryURL
VideoTUSDSource
VideoPublicAccessRights
VideoSignURLAccessRights

Update video.

gRPC request

rpc Update (UpdateVideoRequest) returns (operation.Operation)

UpdateVideoRequest

{
  "video_id": "string",
  "field_mask": "google.protobuf.FieldMask",
  "title": "string",
  "description": "string",
  "thumbnail_id": "string",
  "auto_transcode": "AutoTranscode",
  "enable_ad": "google.protobuf.BoolValue",
  "labels": "map<string, string>",
  // Includes only one of the fields `public_access`, `sign_url_access`
  "public_access": "VideoPublicAccessParams",
  "sign_url_access": "VideoSignURLAccessParams"
  // end of the list of possible fields
}

Field	Description
video_id	string Required field. ID of the video.
field_mask	google.protobuf.FieldMask Required field. Field mask that specifies which fields of the video are going to be updated.
title	string Video title.
description	string Video description.
thumbnail_id	string ID of the thumbnail.
auto_transcode	enum AutoTranscode Auto start transcoding. `AUTO_TRANSCODE_UNSPECIFIED`: Unspecified auto transcoding value. `ENABLE`: Enable auto transcoding. `DISABLE`: Disable auto transcoding.
enable_ad	google.protobuf.BoolValue Enable advertisement for this video. Default: true. Use this to disable advertisement for a specific video.
labels	object (map<string, string>) Custom labels as `key:value` pairs. Maximum 64 per resource.
public_access	VideoPublicAccessParams Publicly accessible video available for viewing by anyone with the direct link. No additional authorization or access control is applied. Includes only one of the fields `public_access`, `sign_url_access`. Video access permission settings.
sign_url_access	VideoSignURLAccessParams Checking access rights using url's signature. Includes only one of the fields `public_access`, `sign_url_access`. Video access permission settings.

VideoPublicAccessParams

Field	Description
Empty

VideoSignURLAccessParams

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": {
    "video_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "channel_id": "string",
    "title": "string",
    "description": "string",
    "thumbnail_id": "string",
    "status": "VideoStatus",
    "error_message": "string",
    "visibility_status": "VisibilityStatus",
    "duration": "google.protobuf.Duration",
    "auto_transcode": "AutoTranscode",
    "enable_ad": "google.protobuf.BoolValue",
    "subtitle_ids": [
      "string"
    ],
    "features": {
      "summary": {
        "result": "FeatureResult",
        "urls": [
          {
            "url": "string",
            "track_index": "int64",
            "src_lang": "string"
          }
        ]
      }
    },
    // Includes only one of the fields `tusd`
    "tusd": {
      "url": "string",
      "file_size": "int64"
    },
    // end of the list of possible fields
    // Includes only one of the fields `public_access`, `sign_url_access`
    "public_access": "VideoPublicAccessRights",
    "sign_url_access": "VideoSignURLAccessRights",
    // end of the list of possible fields
    "created_at": "google.protobuf.Timestamp",
    "updated_at": "google.protobuf.Timestamp",
    "labels": "map<string, string>"
  }
  // 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	UpdateVideoMetadata 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	Video 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.

UpdateVideoMetadata

Field

Description

video_id

string

ID of the video.

Video

Field	Description
id	string ID of the video.
channel_id	string ID of the channel where the video was created.
title	string Video title displayed to users.
description	string Detailed description of the video.
thumbnail_id	string ID of the video's thumbnail image.
status	enum VideoStatus Video status. `VIDEO_STATUS_UNSPECIFIED`: Video status unspecified. `WAIT_UPLOADING`: Waiting for all the bytes to be loaded. `UPLOADED`: Fully uploaded, ready to be transcoded. `PROCESSING`: Video is being processed. `READY`: Successfully processed and ready for use. `ERROR`: Video processing has failed.
error_message	string Error message describing the reason for video processing failure, if any.
visibility_status	enum VisibilityStatus Visibility status of the video. `VISIBILITY_STATUS_UNSPECIFIED`: Visibility status unspecified. `PUBLISHED`: Video published and available for public viewing. `UNPUBLISHED`: Video unpublished, available only to administrators.
duration	google.protobuf.Duration Video duration. Optional, may be empty until the transcoding result is ready.
auto_transcode	enum AutoTranscode Auto-transcoding setting. Set ENABLE to automatically initiate transcoding after upload, or DISABLE for manual initiation via the Transcode() method. `AUTO_TRANSCODE_UNSPECIFIED`: Unspecified auto transcoding value. `ENABLE`: Enable auto transcoding. `DISABLE`: Disable auto transcoding.
enable_ad	google.protobuf.BoolValue Enable advertisement for this video. Default: true. Set explicitly to false to disable advertisements for a specific video.
subtitle_ids[]	string List of IDs defining the active subtitles for the video.
features	VideoFeatures Additional video processing features and their results.
tusd	VideoTUSDSource Upload video using the tus protocol. Includes only one of the fields `tusd`. Video upload source definition (one source variant must be chosen).
public_access	VideoPublicAccessRights Publicly accessible video available for viewing by anyone with the direct link. No additional authorization or access control is applied. Includes only one of the fields `public_access`, `sign_url_access`. Video access permission settings.
sign_url_access	VideoSignURLAccessRights Checking access rights using url's signature. Includes only one of the fields `public_access`, `sign_url_access`. Video access permission settings.
created_at	google.protobuf.Timestamp Time when video was created.
updated_at	google.protobuf.Timestamp Time of last video update.
labels	object (map<string, string>) Custom labels as `key:value` pairs. Maximum 64 per resource.

VideoFeatures

Field

Description

summary

Summary

Summarization result.

Summary

Field

Description

result

enum FeatureResult

FEATURE_RESULT_UNSPECIFIED
NOT_REQUESTED: Feature has not been requested.
PROCESSING: Feature is being processed.
SUCCESS: Feature processing completed successfully.
FAILED: Feature processing has failed.

urls[]

SummaryURL

SummaryURL

Field	Description
url	string
track_index	int64 Input audio track index (one-based).
src_lang	string Source track language (three-letter code according to ISO 639-2/T, ISO 639-2/B, or ISO 639-3). Either provided in transcoding settings earlier or automatically deduced.

VideoTUSDSource

Video upload source via tus protocol.

Field

Description

url

string

URL for uploading video via the tus protocol.

file_size

int64

Size of the uploaded file, in bytes.

VideoPublicAccessRights

Field	Description
Empty

VideoSignURLAccessRights

Field	Description
Empty

Video API, gRPC: VideoService.Update

gRPC requestgRPC request

UpdateVideoRequestUpdateVideoRequest

VideoPublicAccessParamsVideoPublicAccessParams

VideoSignURLAccessParamsVideoSignURLAccessParams

operation.Operationoperation.Operation

UpdateVideoMetadataUpdateVideoMetadata

VideoVideo

VideoFeaturesVideoFeatures

SummarySummary

SummaryURLSummaryURL

VideoTUSDSourceVideoTUSDSource

VideoPublicAccessRightsVideoPublicAccessRights

VideoSignURLAccessRightsVideoSignURLAccessRights

Was the article helpful?

gRPC request

UpdateVideoRequest

VideoPublicAccessParams

VideoSignURLAccessParams

operation.Operation

UpdateVideoMetadata

Video

VideoFeatures

Summary

SummaryURL

VideoTUSDSource

VideoPublicAccessRights

VideoSignURLAccessRights