Video API, REST: Episode.Update

Field

Description

episodeId

string

Required field. ID of the episode.

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

Episode title.

description

string

Episode description.

thumbnailId

string

ID of the thumbnail.

startTime

string (date-time)

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

finishTime

string (date-time)

Episode finish time.

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

dvrSeconds

string (int64)

Enables episode DVR mode.
Determines how many last seconds of the stream are available.

Possible values:

• 0: infinite dvr size, the full length of the stream allowed to display
• >0: size of dvr window in seconds, the minimum value is 30s

publicAccess

object

Episode is available to everyone.

Includes only one of the fields publicAccess, authSystemAccess, signUrlAccess.

Episode access rights.

authSystemAccess

object

Checking access rights using the authorization system.

Includes only one of the fields publicAccess, authSystemAccess, signUrlAccess.

Episode access rights.

signUrlAccess

object

Checking access rights using url's signature.

Includes only one of the fields publicAccess, authSystemAccess, signUrlAccess.

Episode access rights.

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

UpdateEpisodeMetadata

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

Episode

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

episodeId

string

ID of the episode.

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

ID of the episode.

streamId

string

ID of the stream. Optional, empty if the episode is linked to the line

lineId

string

ID of the line. Optional, empty if the episode is linked to the stream

title

string

Episode title.

description

string

Episode description.

thumbnailId

string

ID of the thumbnail.

startTime

string (date-time)

Episode start time.

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

finishTime

string (date-time)

Episode finish time.

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

dvrSeconds

string (int64)

Enables episode DVR mode.
Determines how many last seconds of the stream are available for watching.

Possible values:

• 0: infinite dvr size, the full length of the stream allowed to display
• >0: size of dvr window in seconds, the minimum value is 30s

visibilityStatus

enum (VisibilityStatus)

• VISIBILITY_STATUS_UNSPECIFIED
• PUBLISHED
• UNPUBLISHED

publicAccess

object

Episode is available to everyone.

Includes only one of the fields publicAccess, authSystemAccess, signUrlAccess.

Episode access rights.

authSystemAccess

object

Checking access rights using the authorization system.

Includes only one of the fields publicAccess, authSystemAccess, signUrlAccess.

Episode access rights.

signUrlAccess

object

Checking access rights using url's signature.

Includes only one of the fields publicAccess, authSystemAccess, signUrlAccess.

Episode access rights.

createdAt

string (date-time)

Time when episode was created.

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)

Time of last episode update.

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