Video API, gRPC: VideoService.PerformAction
Performs a specific action on a video, such as publishing or unpublishing.
gRPC request
rpc PerformAction (PerformVideoActionRequest) returns (operation.Operation)
PerformVideoActionRequest
{
"video_id": "string",
// Includes only one of the fields `publish`, `unpublish`
"publish": "PublishVideoAction",
"unpublish": "UnpublishVideoAction"
// end of the list of possible fields
}
|
Field |
Description |
|
video_id |
string Required field. ID of the video on which to perform the action. The maximum string length in characters is 50. |
|
publish |
Publish the video, making it available for watching. Includes only one of the fields Specifies the action to perform on the video (exactly one must be chosen). |
|
unpublish |
Unpublish the video, making it unavailable for watching. Includes only one of the fields Specifies the action to perform on the video (exactly one must be chosen). |
PublishVideoAction
Parameters for the publish action.
|
Field |
Description |
|
Empty |
|
UnpublishVideoAction
Parameters for the unpublish action.
|
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": "google.protobuf.Any",
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": "google.protobuf.Any"
// 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 |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |