Create VOD encoding

POST 
/bv/cms/v1/vods/:vod_id/encodings

Create a new version of VOD Encoding Contents. The version of VOD Encoding Contents could be managed by VOD replacement mechanism.

---

Required field(s):

• vod_id
• profile_set_id
• source
• queue

---

Request

Path Parameters

vod_id stringrequired

Required. The unique id of the VOD resource.

Header Parameters

x-bv-org-id stringrequired

To invoke this API using api_token, you need to set the x-bv-org-id header to specify the organization for which you want to perform the action.

application/json

Body

required

profile_set_id stringrequired

Required. Indicate the profile set unique id that defines the encoding settings.

source objectrequired
Required. Indicate the source file that you want to encode.
type string
Possible values: [SOURCE_TYPE_LIBRARY, SOURCE_TYPE_CLOUD_STORAGE]
Indicates the Source type, should match the following library or cloud_storage setting.
library object
Indicates the source file is from BlendVision One library.
video object
Indicates the video source file.
id string
The unique id of the library video file.
subtitles object[]
Indicates the subtitle source files.
Array [
id stringrequired
The unique id of the library subtitle file.
name string
The name of the subtitle file.
code string
The language code of the subtitle. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
display stringrequired
The display name of the subtitle file.
translate_settings object[]
The translate settings of the subtitle. It's only supported in AddVODSubtitles, TranslateVODSubtitle and CreateVOD API.
Array [
source_lang_code stringrequired
The language code of the source subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
target_lang_code stringrequired
The target language code you want to translate into. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
display stringrequired
The display name of the translated subtitle file.
]
]
stt_subtitles object[]
Indicates auto-gen subtitles.
Array [
track_no string
The number of audio track.
lang_code string
The language code of the subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
display stringrequired
The display name of the subtitle file.
translate_settings object[]
The translate settings of the subtitle. It's only supported in AddVODSubtitles, TranslateVODSubtitle and CreateVOD API.
Array [
source_lang_code stringrequired
The language code of the source subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
target_lang_code stringrequired
The target language code you want to translate into. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
display stringrequired
The display name of the translated subtitle file.
]
]
cloud_storage object
Indicates the source file is from the customer's own configured cloud storage, it's not supported for AOD.
id Indicates the unique id of cloud storage (string)
file_path string
Indicates the relative path of the video source file.
subtitles object[]
Indicates the subtitle source files.
Array [
id stringrequired
The unique id of the library subtitle file.
name string
The name of the subtitle file.
code string
The language code of the subtitle. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
display stringrequired
The display name of the subtitle file.
translate_settings object[]
The translate settings of the subtitle. It's only supported in AddVODSubtitles, TranslateVODSubtitle and CreateVOD API.
Array [
source_lang_code stringrequired
The language code of the source subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
target_lang_code stringrequired
The target language code you want to translate into. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
display stringrequired
The display name of the translated subtitle file.
]
]
stt_subtitles object[]
Indicates auto-gen subtitles.
Array [
track_no string
The number of audio track.
lang_code string
The language code of the subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
display stringrequired
The display name of the subtitle file.
translate_settings object[]
The translate settings of the subtitle. It's only supported in AddVODSubtitles, TranslateVODSubtitle and CreateVOD API.
Array [
source_lang_code stringrequired
The language code of the source subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
target_lang_code stringrequired
The target language code you want to translate into. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
display stringrequired
The display name of the translated subtitle file.
]
]
queue stringrequired

Possible values: [QUEUE_STANDARD, QUEUE_PRIORITY]

Required. Indicates which queue this encoding job will be executed on.

pte object

profile The profile setting of Per-title encoding (string)

Possible values: [PTE_PROFILE_HIGH]

metadata object
short_description string
The short description of the resource.
long_description string
The long description of the resource.
labels object[]
Optional. The labels of the resource. The maximum length of labels is 20.
Array [
name stringrequired
Required. The label name. The maximum length of the name is 20.
]
security object

privacy objectrequired

Required. Specify the content visibility.

type stringrequired

Possible values: [SECURITY_PRIVACY_TYPE_PUBLIC, SECURITY_PRIVACY_TYPE_TOKEN]

Required. Indicates the security privacy type.

token object

Optional. Required if type is SECURITY_PRIVACY_TYPE_TOKEN.

device_limit int32

Optional. The limit of the concurrent devices for a token or a redeem code. Default: 0 (Unlimited). Maximum: 1000.

watermark object

Optional. Add watermarks to the player when playing the content, it's not supported for AOD.

enabled booleanrequired

Required. Enable watermark.

type stringrequired

Possible values: [WATERMARK_TYPE_IMAGE, WATERMARK_TYPE_USER_ID]

Required. Indicates the type of watermark.

position stringrequired

Possible values: [WATERMARK_POSITION_BOTTOM_RIGHT, WATERMARK_POSITION_BOTTOM_MIDDLE, WATERMARK_POSITION_BOTTOM_LEFT, WATERMARK_POSITION_CENTER_RIGHT, WATERMARK_POSITION_CENTER_LEFT, WATERMARK_POSITION_TOP_RIGHT, WATERMARK_POSITION_TOP_MIDDLE, WATERMARK_POSITION_TOP_LEFT, WATERMARK_POSITION_RANDOM, WATERMARK_POSITION_CUSTOM]

Required. The position of the watermark.

image object

Optional. Required if type is WATERMARK_TYPE_IMAGE.

library_id stringrequired

Required. The library id of the image.

size floatrequired

Required. The size of the watermark. The range of values that can be set is from 1 to 50.

offset object

Optional. Required if type is WATERMARK_POSITION_CUSTOM.

x int32required

Required. The x-axis position of the watermark. Represented as a percentage of the image width. The range of values that can be set is from 1 to 100.

y int32required

Required. The y-axis position of the watermark. Represented as a percentage of the image height. The range of values that can be set is from 1 to 100.

domain_control object

Optional. Specify the domains that will be allowed to embed the iframe.

enabled boolean

Optional. Enable domain control.

domains string[]

Optional. The list of domains that will be allowed to embed the iframe.

protection object

Optional. Immutable. The content encryption.

type Optional. Indicates the type of protection (string)

Possible values: [PROTECTION_TYPE_DRM]

• PROTECTION_TYPE_DRM: The content will protected by DRM.

geo_control string[]

Immutable. Specify the alpha-2 codes (See: https://www.iban.com/country-codes) to restrict access to the content by geo locations. Allow all regions when empty.

schedule object

enable booleanrequired

Enable VOD viewing schedule or not.

start_time date-timerequired

VOD viewing start time. Users can only watch the VOD within the specified start time and end time.

end_time date-timerequired

VOD viewing end time. Users can only watch the VOD within the specified start time and end time.

export object

cloud_storage object

Export encoded files to cloud storage.

id string

The unique id of cloud storage.

byo_cdn object

enabled boolean

Optional. Enable BYO(Bring-your-own) CDN or not.

byo_cdn_setting_id string

Optional. The id of BYO CDN host that you set in the general settings, it's necessary when byo cdn is enabled.

player object
player_setting_id string

Responses

200

A successful response.

application/json

Schema

Schema

vod_encoding object

id string

Output only. The unique id of VOD encoding resource.

vod_id string

Output only. The unique id of VOD resource.

name string

Output only. The name of VOD encoding resource.

description string

Output only. The description of VOD encoding resource.

source object

Output only. Indicate the source file that you want to encode.

type string

Possible values: [SOURCE_TYPE_LIBRARY, SOURCE_TYPE_CLOUD_STORAGE]

Indicates the Source type, should match the following library or cloud_storage setting.

library object

Indicates the source file is from BlendVision One library.

video object

Indicates the video source file.

id string

The unique id of the library video file.

subtitles object[]

Indicates the subtitle source files.

Array [

id stringrequired

The unique id of the library subtitle file.

name string

The name of the subtitle file.

code string

The language code of the subtitle. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

display stringrequired

The display name of the subtitle file.

translate_settings object[]

The translate settings of the subtitle. It's only supported in AddVODSubtitles, TranslateVODSubtitle and CreateVOD API.

Array [

source_lang_code stringrequired

The language code of the source subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

target_lang_code stringrequired

The target language code you want to translate into. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

display stringrequired

The display name of the translated subtitle file.

]

]

stt_subtitles object[]

Indicates auto-gen subtitles.

Array [

track_no string

The number of audio track.

lang_code string

The language code of the subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

display stringrequired

The display name of the subtitle file.

translate_settings object[]

The translate settings of the subtitle. It's only supported in AddVODSubtitles, TranslateVODSubtitle and CreateVOD API.

Array [

source_lang_code stringrequired

The language code of the source subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

target_lang_code stringrequired

The target language code you want to translate into. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

display stringrequired

The display name of the translated subtitle file.

]

]

cloud_storage object

Indicates the source file is from the customer's own configured cloud storage, it's not supported for AOD.

id Indicates the unique id of cloud storage (string)

file_path string

Indicates the relative path of the video source file.

subtitles object[]

Indicates the subtitle source files.

Array [

id stringrequired

The unique id of the library subtitle file.

name string

The name of the subtitle file.

code string

The language code of the subtitle. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

display stringrequired

The display name of the subtitle file.

translate_settings object[]

The translate settings of the subtitle. It's only supported in AddVODSubtitles, TranslateVODSubtitle and CreateVOD API.

Array [

source_lang_code stringrequired

The language code of the source subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

target_lang_code stringrequired

The target language code you want to translate into. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

display stringrequired

The display name of the translated subtitle file.

]

]

stt_subtitles object[]

Indicates auto-gen subtitles.

Array [

track_no string

The number of audio track.

lang_code string

The language code of the subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

display stringrequired

The display name of the subtitle file.

translate_settings object[]

The translate settings of the subtitle. It's only supported in AddVODSubtitles, TranslateVODSubtitle and CreateVOD API.

Array [

source_lang_code stringrequired

The language code of the source subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

target_lang_code stringrequired

The target language code you want to translate into. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

display stringrequired

The display name of the translated subtitle file.

]

]

profile_set object

Output only. Indicate the profile set that defines the encoding settings.

id string

Output only. The resource identifier of profile set.

name string

Input only. The name of profile set.

protocols - PROTOCOL_HLS: HTTP Live Streaming - PROTOCOL_DASH: Dynamic Adaptive Streaming over HTTP - PROTOCOL_WHEP: WebRTC-HTTP Egress Protocol - PROTOCOL_PROGRESSIVE: Progressive download (string)[]

Possible values: [PROTOCOL_HLS, PROTOCOL_DASH, PROTOCOL_WHEP, PROTOCOL_PROGRESSIVE]

Input only. The protocols.

smart_abr boolean

Input only. Smart abr.

multiple_audio_track object

Input only.

lang_from string

Possible values: [LANG_FROM_SOURCE, LANG_FROM_CUSTOMIZE, LANG_FROM_FIRST_TRACK]

lang_customizes object[]

Array [

code string

The language code of the audio track. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

display string

]

video_codec - VIDEO_CODEC_H264: VIDEO_CODEC_H264 Indicates video code H.264 - VIDEO_CODEC_H265: VIDEO_CODEC_H265 Indicates video code H.265 (string)

Possible values: [VIDEO_CODEC_H264, VIDEO_CODEC_H265]

Input only. The video codec.

profiles object[]

Output only.

Array [

id string

Output only. The resource identifier of profile.

name string

Input only. The name of profile.

video_codec - VIDEO_CODEC_H264: VIDEO_CODEC_H264 Indicates video code H.264 - VIDEO_CODEC_H265: VIDEO_CODEC_H265 Indicates video code H.265 (string)

Possible values: [VIDEO_CODEC_H264, VIDEO_CODEC_H265]

Input only. The video codec.

video_width int32

Input only. The video width in pixels.

video_height int32

Input only. The video height in pixels.

video_bitrate int64

Input only. The video bitrate.

audio_bitrate int64

Input only. The audio bitrate.

codec_profile string

Possible values: [CODEC_PROFILE_AUTO, CODEC_PROFILE_BASELINE, CODEC_PROFILE_MAIN, CODEC_PROFILE_HIGH, CODEC_PROFILE_MAIN10]

Input only. H.264/H.265 codec profile.

level string

Possible values: [CODEC_PROFILE_LEVEL_AUTO, CODEC_PROFILE_LEVEL_1, CODEC_PROFILE_LEVEL_1_1, CODEC_PROFILE_LEVEL_1_2, CODEC_PROFILE_LEVEL_1_3, CODEC_PROFILE_LEVEL_2, CODEC_PROFILE_LEVEL_2_1, CODEC_PROFILE_LEVEL_2_2, CODEC_PROFILE_LEVEL_3, CODEC_PROFILE_LEVEL_3_1, CODEC_PROFILE_LEVEL_3_2, CODEC_PROFILE_LEVEL_4, CODEC_PROFILE_LEVEL_4_1, CODEC_PROFILE_LEVEL_4_2, CODEC_PROFILE_LEVEL_5, CODEC_PROFILE_LEVEL_5_1, CODEC_PROFILE_LEVEL_5_2, CODEC_PROFILE_LEVEL_6]

Input only. Specify level for H.264/H.265.

b_frame boolean

Input only. Enable/Disable B-frame.

frame_rate string

Possible values: [FRAME_RATE_10, FRAME_RATE_15, FRAME_RATE_23_97, FRAME_RATE_24, FRAME_RATE_25, FRAME_RATE_29_97, FRAME_RATE_30, FRAME_RATE_50, FRAME_RATE_59_94, FRAME_RATE_60, FRAME_RATE_SOURCE]

Input only. The video frame rate.

gop_size int32

Input only. GOP size (keyframe interval) in seconds.

segment_duration int32

Input only. Length of video duration for each segment package in seconds.

preset Output only. Preset is system or custom (boolean)

standard Output only. Standard is sd|hd|fhd|4k (string)

Possible values: [RESOLUTION_TYPE_SD, RESOLUTION_TYPE_HD, RESOLUTION_TYPE_FHD, RESOLUTION_TYPE_4K]

]

preset boolean

Output only. The prest is system or custom. If preset is true, the profile set is created by system, otherwise the profile set is created by custom.

queue string

Possible values: [QUEUE_STANDARD, QUEUE_PRIORITY]

Output only. Indicates which queue this encoding job was executed on before.

pte object

Output only. Per-title encoding.

profile The profile setting of Per-title encoding (string)

Possible values: [PTE_PROFILE_HIGH]

stream object[]

Output Only. Indicate the streaming resource of the VOD encoding.

Array [

manifests object[]

Indicates the manifest resources.

Array [

protocol - PROTOCOL_HLS: HTTP Live Streaming - PROTOCOL_DASH: Dynamic Adaptive Streaming over HTTP - PROTOCOL_WHEP: WebRTC-HTTP Egress Protocol - PROTOCOL_PROGRESSIVE: Progressive download (string)

Possible values: [PROTOCOL_HLS, PROTOCOL_DASH, PROTOCOL_WHEP, PROTOCOL_PROGRESSIVE]

Indicates the streaming protocol of manifest.

uris object[]

Indicates the uri array of manifest.

Array [

resolutions object[]

The resolution of the manifest.

Array [

height int64

The video resolution height.

width int64

The video resolution width.

]

uri string

The streaming uri of the manifest.

]

]

thumbnail object

Indicates the thumbnail resource.

uri string

Thumbnail seeking uri.

]

labels object[]

Output Only. Indicate the label of the VOD encoding.

Array [

name stringrequired

Required. The label name. The maximum length of the name is 20.

]

status string

Possible values: [VOD_STATUS_CREATED, VOD_STATUS_INGESTED, VOD_STATUS_QUEUED, VOD_STATUS_ENCODED, VOD_STATUS_DEPLOYED, VOD_STATUS_SUCCEEDED, VOD_STATUS_FAILED, VOD_STATUS_CANCELLED, VOD_STATUS_DELETED]

Output Only. Indicate the current status of the VOD encoding.

previous_status string

Possible values: [VOD_STATUS_CREATED, VOD_STATUS_INGESTED, VOD_STATUS_QUEUED, VOD_STATUS_ENCODED, VOD_STATUS_DEPLOYED, VOD_STATUS_SUCCEEDED, VOD_STATUS_FAILED, VOD_STATUS_CANCELLED, VOD_STATUS_DELETED]

Output only. Indicate the previous status of the VOD encoding.

metadata object

Output only. Indicate the metadata of the VOD encoding.

short_description string

The short description of the resource.

long_description string

The long description of the resource.

labels object[]

Optional. The labels of the resource. The maximum length of labels is 20.

Array [

name stringrequired

Required. The label name. The maximum length of the name is 20.

]

source_file_info object

Output only. Indicate the source file information of the VOD encoding.

file_name string

The file name of source file.

size int64

The size of source file.

bitrate int64

The bitrate of source file.

duration float

The duration of source file.

video object

The video information of source file.

codec Video codec (string)

Possible values: [VIDEO_CODEC_H264, VIDEO_CODEC_H265]

height int32

The display height of video.

width int32

The display width of video.

bitrate int64

The bitrate of video.

frame_rate string

The frame rate of video.

interlace boolean

The interlace of video.

aspect_ratio - DISPLAY_ASPECT_RATIO_SOURCE: DISPLAY_ASPECT_RATIO_SOURCE Indicates follow source file. - DISPLAY_ASPECT_RATIO_1_1: DISPLAY_ASPECT_RATIO_1_1 Indicates 1:1 - DISPLAY_ASPECT_RATIO_3_2: DISPLAY_ASPECT_RATIO_3_2 Indicates 3:2 - DISPLAY_ASPECT_RATIO_4_3: DISPLAY_ASPECT_RATIO_4_3 Indicates 4:3 - DISPLAY_ASPECT_RATIO_5_4: DISPLAY_ASPECT_RATIO_5_4 Indicates 5:4 - DISPLAY_ASPECT_RATIO_16_9: DISPLAY_ASPECT_RATIO_16_9 Indicates 16:9 - DISPLAY_ASPECT_RATIO_16_10: DISPLAY_ASPECT_RATIO_16_10 Indicates 16:10 - DISPLAY_ASPECT_RATIO_17_9: DISPLAY_ASPECT_RATIO_17_9 Indicates 17:9 - DISPLAY_ASPECT_RATIO_21_9: DISPLAY_ASPECT_RATIO_21_9 Indicates 21:9 - DISPLAY_ASPECT_RATIO_32_9: DISPLAY_ASPECT_RATIO_32_9 Indicates 32:9 (string)

Possible values: [DISPLAY_ASPECT_RATIO_SOURCE, DISPLAY_ASPECT_RATIO_1_1, DISPLAY_ASPECT_RATIO_3_2, DISPLAY_ASPECT_RATIO_4_3, DISPLAY_ASPECT_RATIO_5_4, DISPLAY_ASPECT_RATIO_16_9, DISPLAY_ASPECT_RATIO_16_10, DISPLAY_ASPECT_RATIO_17_9, DISPLAY_ASPECT_RATIO_21_9, DISPLAY_ASPECT_RATIO_32_9]

The display aspect ratio of video.

audios object[]

The audio information of source file.

Array [

codec - AUDIO_CODEC_AAC: AUDIO_CODEC_AAC Indicates audio codec aac - AUDIO_CODEC_AC3: AUDIO_CODEC_AC3 Indicates audio codec ac3 - AUDIO_CODEC_MP3: AUDIO_CODEC_MP3 Indicates audio codec mp3 (string)

Possible values: [AUDIO_CODEC_AAC, AUDIO_CODEC_AC3, AUDIO_CODEC_MP3]

lang string

bitrate int64

sample_rate int64

]

schedule object

Output Only. Indicate the schedule setting of the VOD encoding.

enable booleanrequired

Enable VOD viewing schedule or not.

start_time date-timerequired

VOD viewing start time. Users can only watch the VOD within the specified start time and end time.

end_time date-timerequired

VOD viewing end time. Users can only watch the VOD within the specified start time and end time.

security object

Output Only. Indicate the security setting of the VOD encoding.

privacy objectrequired

Required. Specify the content visibility.

type stringrequired

Possible values: [SECURITY_PRIVACY_TYPE_PUBLIC, SECURITY_PRIVACY_TYPE_TOKEN]

Required. Indicates the security privacy type.

token object

Optional. Required if type is SECURITY_PRIVACY_TYPE_TOKEN.

device_limit int32

Optional. The limit of the concurrent devices for a token or a redeem code. Default: 0 (Unlimited). Maximum: 1000.

watermark object

Optional. Add watermarks to the player when playing the content, it's not supported for AOD.

enabled booleanrequired

Required. Enable watermark.

type stringrequired

Possible values: [WATERMARK_TYPE_IMAGE, WATERMARK_TYPE_USER_ID]

Required. Indicates the type of watermark.

position stringrequired

Possible values: [WATERMARK_POSITION_BOTTOM_RIGHT, WATERMARK_POSITION_BOTTOM_MIDDLE, WATERMARK_POSITION_BOTTOM_LEFT, WATERMARK_POSITION_CENTER_RIGHT, WATERMARK_POSITION_CENTER_LEFT, WATERMARK_POSITION_TOP_RIGHT, WATERMARK_POSITION_TOP_MIDDLE, WATERMARK_POSITION_TOP_LEFT, WATERMARK_POSITION_RANDOM, WATERMARK_POSITION_CUSTOM]

Required. The position of the watermark.

image object

Optional. Required if type is WATERMARK_TYPE_IMAGE.

library_id stringrequired

Required. The library id of the image.

url string

Output only. The URL of the image.

name string

Output only. The Name of the image.

size floatrequired

Required. The size of the watermark. The range of values that can be set is from 1 to 50.

offset object

Optional. Required if type is WATERMARK_POSITION_CUSTOM.

x int32required

Required. The x-axis position of the watermark. Represented as a percentage of the image width. The range of values that can be set is from 1 to 100.

y int32required

Required. The y-axis position of the watermark. Represented as a percentage of the image height. The range of values that can be set is from 1 to 100.

domain_control object

Optional. Specify the domains that will be allowed to embed the iframe.

enabled boolean

Optional. Enable domain control.

domains string[]

Optional. The list of domains that will be allowed to embed the iframe.

protection object

Optional. Immutable. The content encryption.

type Optional. Indicates the type of protection (string)

Possible values: [PROTECTION_TYPE_DRM]

• PROTECTION_TYPE_DRM: The content will protected by DRM.

geo_control string[]

Immutable. Specify the alpha-2 codes (See: https://www.iban.com/country-codes) to restrict access to the content by geo locations. Allow all regions when empty.

cover_image object

Output Only. Indicate the cover image of the VOD encoding.

type stringrequired

Possible values: [COVER_IMAGE_TYPE_AUTO, COVER_IMAGE_TYPE_CUSTOMIZE]

Required. Indicates the cover image type.

auto object

Output only. Indicates the cover images which are generated automatically. It will be empty which represents the black screen when the content type is live.

url string

Output only. The URL of the cover image.

name string

Output only. The name of the cover image.

size int64

Output only. The size of the cover image.

customize object

Optional. Required if type is COVER_IMAGE_TYPE_CUSTOMIZE.

library_id stringrequired

Required. The library id of the cover image.

url string

Output only. The URL of the cover image.

name string

Output only. The name of the cover image.

size int64

Output only. The size of the cover image.

updated_at date-time

Output only. The timestamp of the cover image that was updated.

export object

Output Only. Indicate the export setting of the VOD encoding.

cloud_storage object

Export encoded files to cloud storage.

id string

The unique id of cloud storage.

showroom object

Optional. Indicate the showroom setting of the VOD encoding.

model object

Optional. The model of showroom preferences.

libraries object[]

Optional. The library assets that is used by the model.

Array [

id stringrequired

Required. The library id of the asset.

name string

Output only. The library name of the asset.

url string

Output only. The URL of the asset.

]

byo_cdn object

Optional. The setting of bring-your-own cdn.

enabled boolean

Optional. Enable BYO(Bring-your-own) CDN or not.

byo_cdn_setting_id string

Optional. The id of BYO CDN host that you set in the general settings, it's necessary when byo cdn is enabled.

configs object[]

Output only. The preconfigured BYO CDN configurations for AWS distribution.

Array [

type Required. The type of cdn configuration (string)

Possible values: [CDN_CONFIG_TYPE_LIVE_HLS, CDN_CONFIG_TYPE_LIVE_DASH, CDN_CONFIG_TYPE_VOD]

origin Required. The origin user need to set in the distribution (string)

cache_behavior_prefix Required. The cache behavior prefix user need to set in the distribution (string)

]

player_setting object

Optional. The setting of player.

setting object

Output Only. The model of player preferences.

id string

Output only. The resource identifier of player setting.

name string

Output only. The name of player setting.

description string

Output Only. The decription of player setting.

libraries object[]

Output Only. The library assets that are used in the setting.

Array [

id string

Output Only. The library id of the asset.

name string

Output only. The library name of the asset.

url string

Output only. The URL of the asset.

]

chapter_setting object

Optional. The chapter of VOD encoding.

enable booleanrequired

chapters object[]required

The timestamp value of the first element in the chapters must be set to zero.

Array [

title stringrequired

timestamp int64required

]

subtitles object[]

Output Only. The VOD encoding subtitles.

Array [

id string

The unique id of subtitle.

track_no string

The number of audio track.

lang_code string

The language code of the subtitle. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

display string

The display name of the subtitle.

status string

Possible values: [SUBTITLE_STATUS_GENERATING, SUBTITLE_STATUS_SUCCEED, SUBTITLE_STATUS_FAILED, SUBTITLE_STATUS_NOT_FOUND]

The status of subtitle.

subtitle_file_info object

The information of subtitle.

file object

id string

Output only. The unique id of the file.

type string

Possible values: [FILE_TYPE_VIDEO, FILE_TYPE_IMAGE, FILE_TYPE_SUBTITLE, FILE_TYPE_DOCUMENT, FILE_TYPE_WEB_LINK, FILE_TYPE_AUDIO]

Input only. The type of the file.

name string

Input only. The name of the file.

size int64

Input only. The size of the file in bytes.

uri string

Output only. The uri of the file.

source stringrequired

Possible values: [FILE_SOURCE_LIVE_EVENT, FILE_SOURCE_UPLOAD_IN_LIBRARY, FILE_SOURCE_ADD_VOD, FILE_SOURCE_CLOUD_STORAGE_AWS, FILE_SOURCE_STT, FILE_SOURCE_ADD_AOD, FILE_SOURCE_AISK, FILE_SOURCE_GOOGLE_DRIVE, FILE_SOURCE_GOOGLE_CALENDAR, FILE_SOURCE_HIGHLIGHT, FILE_SOURCE_TRANSLATE, FILE_SOURCE_LIVE_CLIP]

Required. The source of the file, only for display.

attrs object

property name* string

has_subtitle Output Only. Indicate the video has subtitle or not when the file type is `FILE_TYPE_VIDEO` (boolean)

subtitles object[]

Array [

id string

The unique id of the subtitle.

library_id string

The unique id of the library subtitle file.

name string

The name of the subtitle file.

code string

The language code of the subtitle file. Follow RFC 5646 (shortest ISO 639 code).

display string

The display name of the subtitle file.

]

status string

Possible values: [FILE_STATUS_SUCCEED, FILE_STATUS_PROGRESSING, FILE_STATUS_FAILED]

Output Only. The file status.

permission object

default_access_role stringrequired

Possible values: [ACCESS_ROLE_DENY, ACCESS_ROLE_SUPER_EDITOR, ACCESS_ROLE_EDITOR, ACCESS_ROLE_VIEWER]

assignments object[]

Array [

id stringrequired

Required. Output Only. if the assigned_type is ASSIGNED_TYPE_USER, the id is user id. if the assigned_type is ASSIGNED_TYPE_GROUP, the id is group id.

email string

Output Only. It will return if the assigned_type matches ASSIGNED_TYPE_USER.

name string

Output Only. The name of user or group.

assigned_type Required. Output Only. It indicates the assigned type is user or group. It is not accept the `ASSIGNED_TYPE_OWNER` (string)required

Possible values: [ASSIGNED_TYPE_USER, ASSIGNED_TYPE_GROUP]

access_role Required. Output Only. It indicates access role. It is not accept the `ACCESS_ROLE_DENY` (string)required

Possible values: [ACCESS_ROLE_DENY, ACCESS_ROLE_SUPER_EDITOR, ACCESS_ROLE_EDITOR, ACCESS_ROLE_VIEWER]

]

summary object

Deprecated. Do not use. Use FetchSummary API instead.

content string

The content of summary.

status string

Possible values: [SUMMARY_STATUS_WAITING, SUMMARY_STATUS_PROCESSING, SUMMARY_STATUS_READY, SUMMARY_STATUS_FAILED]

The status of summary.

error_infos object[]

Output only. Optional. A list of messages that carry the error infos when vod encoding is failed.

Array [

reason string

The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

domain string

The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

metadata object

Additional structured details about this error.

Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.

property name* string

]

metadata object

Optional. The metadata of the file.

short_description string

Optional. The short description of the file.

long_description string

Optional. The long description of the file.

labels string[]

Optional. The labels of the file.

created_at date-time

Output only.

updated_at date-time

Output only.

contents object[]

Array [

index int32

start_at string

end_at string

words string[]

]

source_type string

Possible values: [SUBTITLE_SOURCE_TYPE_LOCAL, SUBTITLE_SOURCE_TYPE_STT, SUBTITLE_SOURCE_TYPE_AI_TRANSLATE]

The source type of subtitle.

source_subtitle_id string

The id of the source subtitle used for translation.

created_at date-time

Output only.

updated_at date-time

Output only.

]

end_screen object

Output Only. The end screen setting of the VOD encoding resource.

model object

Optional. The model of end screen preferences.

libraries object[]

Optional. The library assets that is used by the model.

Array [

id stringrequired

Required. The library id of the asset.

name string

Output only. The library name of the asset.

url string

Output only. The URL of the asset.

]

vods object[]

Optional. The vod assets that is used by the model.

Array [

id stringrequired

Required. The VOD id.

cover_image object

Output only. The vod cover image.

type stringrequired

Possible values: [COVER_IMAGE_TYPE_AUTO, COVER_IMAGE_TYPE_CUSTOMIZE]

Required. Indicates the cover image type.

auto object

Output only. Indicates the cover images which are generated automatically. It will be empty which represents the black screen when the content type is live.

url string

Output only. The URL of the cover image.

name string

Output only. The name of the cover image.

size int64

Output only. The size of the cover image.

customize object

Optional. Required if type is COVER_IMAGE_TYPE_CUSTOMIZE.

library_id stringrequired

Required. The library id of the cover image.

url string

Output only. The URL of the cover image.

name string

Output only. The name of the cover image.

size int64

Output only. The size of the cover image.

updated_at date-time

Output only. The timestamp of the cover image that was updated.

]

summary object

Output Only. The summary of the VOD encoding resource.

content string

The content of summary.

status string

Possible values: [SUMMARY_STATUS_WAITING, SUMMARY_STATUS_PROCESSING, SUMMARY_STATUS_READY, SUMMARY_STATUS_FAILED]

The status of summary.

error_infos object[]

Output only. Optional. A list of messages that carry the error infos when vod encoding is failed.

Array [

reason string

The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

domain string

The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

metadata object

Additional structured details about this error.

Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.

property name* string

]

type - VOD_TYPE_STT: video for stt, it represents the type of background vod - VOD_TYPE_AUDIO_FOR_STT: audio for stt, it represents the type of background aod (string)

Possible values: [VOD_TYPE_ENCODING, VOD_TYPE_CATCHUP, VOD_TYPE_AMS_VIDEO, VOD_TYPE_AMS_AUDIO, VOD_TYPE_STT, VOD_TYPE_AUDIO_ENCODING, VOD_TYPE_AUDIO_FOR_STT, VOD_TYPE_BACKGROUND]

Output Only. The VOD encoding type.

stages object[]

The status history of the VOD encoding resource.

Array [

status stringrequired

Possible values: [VOD_STATUS_CREATED, VOD_STATUS_INGESTED, VOD_STATUS_QUEUED, VOD_STATUS_ENCODED, VOD_STATUS_DEPLOYED, VOD_STATUS_SUCCEEDED, VOD_STATUS_FAILED, VOD_STATUS_CANCELLED, VOD_STATUS_DELETED]

The status of a VOD resource.

complete_time date-timerequired

message string

The message of the status. Deprecated: Use error_infos instead.

code string

The code of the status. Deprecated: Use error_infos instead.

error_infos object[]required

Output only. Optional. A list of messages that carry the error infos when vod encoding is failed.

Array [

reason string

The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

domain string

The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

metadata object

Additional structured details about this error.

Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.

property name* string

]

]

current boolean

Output Only. Setting this to true indicates that this resource is the current VOD encoding.

created_at date-time

Output Only. Indicate the create time of the VOD encoding.

updated_at date-time

Output Only. Indicate the latest update time of the VOD encoding.

Example (from schema)

{
  "vod_encoding": {
    "id": "string",
    "vod_id": "string",
    "name": "string",
    "description": "string",
    "source": {
      "type": "SOURCE_TYPE_LIBRARY",
      "library": {
        "video": {
          "id": "string"
        },
        "subtitles": [
          {
            "id": "string",
            "name": "string",
            "code": "string",
            "display": "string",
            "translate_settings": [
              {
                "source_lang_code": "string",
                "target_lang_code": "string",
                "display": "string"
              }
            ]
          }
        ],
        "stt_subtitles": [
          {
            "track_no": "string",
            "lang_code": "string",
            "display": "string",
            "translate_settings": [
              {
                "source_lang_code": "string",
                "target_lang_code": "string",
                "display": "string"
              }
            ]
          }
        ]
      },
      "cloud_storage": {
        "id": "string",
        "file_path": "string",
        "subtitles": [
          {
            "id": "string",
            "name": "string",
            "code": "string",
            "display": "string",
            "translate_settings": [
              {
                "source_lang_code": "string",
                "target_lang_code": "string",
                "display": "string"
              }
            ]
          }
        ],
        "stt_subtitles": [
          {
            "track_no": "string",
            "lang_code": "string",
            "display": "string",
            "translate_settings": [
              {
                "source_lang_code": "string",
                "target_lang_code": "string",
                "display": "string"
              }
            ]
          }
        ]
      }
    },
    "profile_set": {
      "id": "string",
      "name": "string",
      "protocols": [
        "PROTOCOL_HLS"
      ],
      "smart_abr": true,
      "multiple_audio_track": {
        "lang_from": "LANG_FROM_SOURCE",
        "lang_customizes": [
          {
            "code": "string",
            "display": "string"
          }
        ]
      },
      "video_codec": "VIDEO_CODEC_H264",
      "profiles": [
        {
          "id": "string",
          "name": "string",
          "video_codec": "VIDEO_CODEC_H264",
          "video_width": 0,
          "video_height": 0,
          "video_bitrate": "string",
          "audio_bitrate": "string",
          "codec_profile": "CODEC_PROFILE_AUTO",
          "level": "CODEC_PROFILE_LEVEL_AUTO",
          "b_frame": true,
          "frame_rate": "FRAME_RATE_10",
          "gop_size": 0,
          "segment_duration": 0,
          "preset": true,
          "standard": "RESOLUTION_TYPE_SD"
        }
      ],
      "preset": true
    },
    "queue": "QUEUE_STANDARD",
    "pte": {
      "profile": "PTE_PROFILE_HIGH"
    },
    "stream": [
      {
        "manifests": [
          {
            "protocol": "PROTOCOL_HLS",
            "uris": [
              {
                "resolutions": [
                  {
                    "height": "string",
                    "width": "string"
                  }
                ],
                "uri": "string"
              }
            ]
          }
        ],
        "thumbnail": {
          "uri": "string"
        }
      }
    ],
    "labels": [
      {
        "name": "string"
      }
    ],
    "status": "VOD_STATUS_CREATED",
    "previous_status": "VOD_STATUS_CREATED",
    "metadata": {
      "short_description": "string",
      "long_description": "string",
      "labels": [
        {
          "name": "string"
        }
      ]
    },
    "source_file_info": {
      "file_name": "string",
      "size": "string",
      "bitrate": "string",
      "duration": 0,
      "video": {
        "codec": "VIDEO_CODEC_H264",
        "height": 0,
        "width": 0,
        "bitrate": "string",
        "frame_rate": "string",
        "interlace": true,
        "aspect_ratio": "DISPLAY_ASPECT_RATIO_SOURCE"
      },
      "audios": [
        {
          "codec": "AUDIO_CODEC_AAC",
          "lang": "string",
          "bitrate": "string",
          "sample_rate": "string"
        }
      ]
    },
    "schedule": {
      "enable": true,
      "start_time": "2024-07-29T15:51:28.071Z",
      "end_time": "2024-07-29T15:51:28.071Z"
    },
    "security": {
      "privacy": {
        "type": "SECURITY_PRIVACY_TYPE_PUBLIC",
        "token": {
          "device_limit": 0
        }
      },
      "watermark": {
        "enabled": true,
        "type": "WATERMARK_TYPE_IMAGE",
        "position": "WATERMARK_POSITION_BOTTOM_RIGHT",
        "image": {
          "library_id": "string",
          "url": "string",
          "name": "string"
        },
        "size": 0,
        "offset": {
          "x": 0,
          "y": 0
        }
      },
      "domain_control": {
        "enabled": true,
        "domains": [
          "string"
        ]
      },
      "protection": {
        "type": "PROTECTION_TYPE_DRM"
      },
      "geo_control": [
        "string"
      ]
    },
    "cover_image": {
      "type": "COVER_IMAGE_TYPE_AUTO",
      "auto": {
        "url": "string",
        "name": "string",
        "size": "string"
      },
      "customize": {
        "library_id": "string",
        "url": "string",
        "name": "string",
        "size": "string"
      },
      "updated_at": "2024-07-29T15:51:28.071Z"
    },
    "export": {
      "cloud_storage": {
        "id": "string"
      }
    },
    "showroom": {
      "model": {},
      "libraries": [
        {
          "id": "string",
          "name": "string",
          "url": "string"
        }
      ]
    },
    "byo_cdn": {
      "enabled": true,
      "byo_cdn_setting_id": "string",
      "configs": [
        {
          "type": "CDN_CONFIG_TYPE_LIVE_HLS",
          "origin": "string",
          "cache_behavior_prefix": "string"
        }
      ]
    },
    "player_setting": {
      "setting": {},
      "id": "string",
      "name": "string",
      "description": "string",
      "libraries": [
        {
          "id": "string",
          "name": "string",
          "url": "string"
        }
      ]
    },
    "chapter_setting": {
      "enable": true,
      "chapters": [
        {
          "title": "string",
          "timestamp": "string"
        }
      ]
    },
    "subtitles": [
      {
        "id": "string",
        "track_no": "string",
        "lang_code": "string",
        "display": "string",
        "status": "SUBTITLE_STATUS_GENERATING",
        "subtitle_file_info": {
          "file": {
            "id": "string",
            "type": "FILE_TYPE_VIDEO",
            "name": "string",
            "size": "string",
            "uri": "string",
            "source": "FILE_SOURCE_LIVE_EVENT",
            "attrs": {},
            "has_subtitle": true,
            "subtitles": [
              {
                "id": "string",
                "library_id": "string",
                "name": "string",
                "code": "string",
                "display": "string"
              }
            ],
            "status": "FILE_STATUS_SUCCEED",
            "permission": {
              "assignments": [
                {
                  "access_role": "ACCESS_ROLE_SUPER_EDITOR",
                  "assigned_type": "ASSIGNED_TYPE_OWNER",
                  "email": "",
                  "id": "",
                  "name": ""
                }
              ],
              "default_access_role": "ACCESS_ROLE_DENY"
            },
            "summary": {
              "content": "string",
              "status": "SUMMARY_STATUS_WAITING",
              "error_infos": [
                {
                  "reason": "string",
                  "domain": "string",
                  "metadata": {}
                }
              ]
            },
            "metadata": {
              "short_description": "string",
              "long_description": "string",
              "labels": [
                "string"
              ]
            },
            "created_at": "2024-07-29T15:51:28.071Z",
            "updated_at": "2024-07-29T15:51:28.071Z"
          },
          "contents": [
            {
              "index": 0,
              "start_at": "string",
              "end_at": "string",
              "words": [
                "string"
              ]
            }
          ]
        },
        "source_type": "SUBTITLE_SOURCE_TYPE_LOCAL",
        "source_subtitle_id": "string",
        "created_at": "2024-07-29T15:51:28.071Z",
        "updated_at": "2024-07-29T15:51:28.071Z"
      }
    ],
    "end_screen": {
      "model": {},
      "libraries": [
        {
          "id": "string",
          "name": "string",
          "url": "string"
        }
      ],
      "vods": [
        {
          "id": "string",
          "cover_image": {
            "type": "COVER_IMAGE_TYPE_AUTO",
            "auto": {
              "url": "string",
              "name": "string",
              "size": "string"
            },
            "customize": {
              "library_id": "string",
              "url": "string",
              "name": "string",
              "size": "string"
            },
            "updated_at": "2024-07-29T15:51:28.071Z"
          }
        }
      ]
    },
    "summary": {
      "content": "string",
      "status": "SUMMARY_STATUS_WAITING",
      "error_infos": [
        {
          "reason": "string",
          "domain": "string",
          "metadata": {}
        }
      ]
    },
    "type": "VOD_TYPE_ENCODING",
    "stages": [
      {
        "status": "VOD_STATUS_CREATED",
        "complete_time": "2024-07-29T15:51:28.071Z",
        "message": "string",
        "code": "string",
        "error_infos": [
          {
            "reason": "string",
            "domain": "string",
            "metadata": {}
          }
        ]
      }
    ],
    "current": true,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
  }
}

400

A bad request response. The code is 3 means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

401

A unauthenticated response. The header authorization was missing or unidentified.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

403

A forbidden response. It means that the provided authorization did not have enough permission to access the resource or the API.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

500

A server error response. There are more HTTP status code mappings listed on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...