List AODs
GET/bv/cms/v1/aods
Lists AOD
resources.
Request
Query Parameters
- AOD_STATUS_CREATED: AOD_STATUS_CREATED Indicates AOD job accepted.
- AOD_STATUS_INGESTED: AOD_STATUS_INGESTED Indicates source file has been ingested to BlendVision One Service.
- AOD_STATUS_QUEUED: AOD_STATUS_QUEUED Indicates AOD job is currently being encoded.
- AOD_STATUS_ENCODED: AOD_STATUS_ENCODED Indicates AOD job is encoded.
- AOD_STATUS_DEPLOYED: AOD_STATUS_DEPLOYED Indicates the streaming resource of AOD job has been public.
- AOD_STATUS_SUCCEEDED: AOD_STATUS_SUCCEEDED Indicates AOD job is finished.
- AOD_STATUS_FAILED: AOD_STATUS_FAILED Indicates AOD job is failed.
- AOD_STATUS_CANCELLED: AOD_STATUS_CANCELLED Indicates AOD job is cancelled.
- AOD_STATUS_DELETED: AOD_STATUS_DELETED Indicates AOD job is deleted.
Input only. Indicates the current page to show. Default: 1
Input only. Indicates the number of items to show per page. Default: 10.
Filter by the name of AOD
Possible values: [AOD_STATUS_CREATED
, AOD_STATUS_INGESTED
, AOD_STATUS_QUEUED
, AOD_STATUS_ENCODED
, AOD_STATUS_DEPLOYED
, AOD_STATUS_SUCCEEDED
, AOD_STATUS_FAILED
, AOD_STATUS_CANCELLED
, AOD_STATUS_DELETED
]
Filter by the status of AOD
Possible values: [SUBTITLE_FORMAT_SRT
, SUBTITLE_FORMAT_VTT
]
Filter by the subtitle type of AOD
Header Parameters
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.
Responses
- 200
- 400
- 401
- 403
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- Array [
- ]
- ]
- Array [
- Array [
- ]
- ]
- Array [
- Array [
- ]
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
- Array [
- ]
- PROTECTION_TYPE_DRM: The content will protected by DRM.
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
aods object[]
Output only. The unique id of AOD resource.
Output only. The name of AOD resource.
source object
Output only. Indicate the source file that you want to encode.
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.
The unique id of the library video file.
subtitles object[]
Indicates the subtitle source files.
The unique id of the library subtitle file.
The name of the subtitle file.
The language code of the subtitle. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
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.
The language code of the source subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
The target language code you want to translate into. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
The display name of the translated subtitle file.
stt_subtitles object[]
Indicates auto-gen subtitles.
The number of audio track.
The language code of the subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
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.
The language code of the source subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
The target language code you want to translate into. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
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.
Indicates the relative path of the video source file.
subtitles object[]
Indicates the subtitle source files.
The unique id of the library subtitle file.
The name of the subtitle file.
The language code of the subtitle. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
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.
The language code of the source subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
The target language code you want to translate into. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
The display name of the translated subtitle file.
stt_subtitles object[]
Indicates auto-gen subtitles.
The number of audio track.
The language code of the subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
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.
The language code of the source subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
The target language code you want to translate into. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
The display name of the translated subtitle file.
profile_set object
Output only. Indicate the profile set that defines the encoding settings.
Possible values: [PROTOCOL_HLS
, PROTOCOL_DASH
, PROTOCOL_WHEP
, PROTOCOL_PROGRESSIVE
]
profiles object[]
Possible values: [AUDIO_CODEC_AAC
, AUDIO_CODEC_AC3
, AUDIO_CODEC_MP3
]
Possible values: [AUDIO_CODEC_AAC
, AUDIO_CODEC_AC3
, AUDIO_CODEC_MP3
]
stream object[]
Output Only. Indicate the streaming resource of the AOD.
manifests object[]
Indicates the manifest resources.
Possible values: [PROTOCOL_HLS
, PROTOCOL_DASH
, PROTOCOL_WHEP
, PROTOCOL_PROGRESSIVE
]
Indicates the streaming protocol of manifest.
uris object[]
Indicates the uri array of manifest.
resolutions object[]
The resolution of the manifest.
The video resolution height.
The video resolution width.
The streaming uri of the manifest.
thumbnail object
Indicates the thumbnail resource.
Thumbnail seeking uri.
Possible values: [AOD_STATUS_CREATED
, AOD_STATUS_INGESTED
, AOD_STATUS_QUEUED
, AOD_STATUS_ENCODED
, AOD_STATUS_DEPLOYED
, AOD_STATUS_SUCCEEDED
, AOD_STATUS_FAILED
, AOD_STATUS_CANCELLED
, AOD_STATUS_DELETED
]
Output Only. Indicate the current status of the AOD.
Possible values: [AOD_STATUS_CREATED
, AOD_STATUS_INGESTED
, AOD_STATUS_QUEUED
, AOD_STATUS_ENCODED
, AOD_STATUS_DEPLOYED
, AOD_STATUS_SUCCEEDED
, AOD_STATUS_FAILED
, AOD_STATUS_CANCELLED
, AOD_STATUS_DELETED
]
Output only. Indicate the previous status of the AOD.
source_file_info object
Output only. Indicate the source file information of the AOD.
The file name of source file.
The size of source file.
The bitrate of source file.
The duration of source file.
video object
The video information of source file.
Possible values: [VIDEO_CODEC_H264
, VIDEO_CODEC_H265
]
The display height of video.
The display width of video.
The bitrate of video.
The frame rate of video.
The interlace of video.
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.
Possible values: [AUDIO_CODEC_AAC
, AUDIO_CODEC_AC3
, AUDIO_CODEC_MP3
]
security object
Output Only. Indicate the security setting of the AOD.
privacy objectrequired
Required. Specify the content visibility.
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
.
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.
Required. Enable watermark.
Possible values: [WATERMARK_TYPE_IMAGE
, WATERMARK_TYPE_USER_ID
]
Required. Indicates the type of watermark.
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
.
Required. The library id of the image.
Output only. The URL of the image.
Output only. The Name of the image.
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
.
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.
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.
Optional. Enable domain control.
Optional. The list of domains that will be allowed to embed the iframe.
protection object
Optional. Immutable. The content encryption.
Possible values: [PROTECTION_TYPE_DRM
]
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.
subtitles object[]
Output Only. The AOD subtitles.
The unique id of subtitle.
The number of audio track.
The language code of the subtitle. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
The display name of the subtitle.
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
Output only. The unique id of the file.
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.
Input only. The name of the file.
Input only. The size of the file in bytes.
Output only. The uri of the file.
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
subtitles object[]
The unique id of the subtitle.
The unique id of the library subtitle file.
The name of the subtitle file.
The language code of the subtitle file. Follow RFC 5646 (shortest ISO 639 code).
The display name of the subtitle file.
Possible values: [FILE_STATUS_SUCCEED
, FILE_STATUS_PROGRESSING
, FILE_STATUS_FAILED
]
Output Only. The file status.
permission object
Possible values: [ACCESS_ROLE_DENY
, ACCESS_ROLE_SUPER_EDITOR
, ACCESS_ROLE_EDITOR
, ACCESS_ROLE_VIEWER
]
assignments object[]
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.
Output Only. It will return if the assigned_type
matches ASSIGNED_TYPE_USER
.
Output Only. The name of user or group.
Possible values: [ASSIGNED_TYPE_USER
, ASSIGNED_TYPE_GROUP
]
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.
The content of summary.
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.
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.
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.
metadata object
Optional. The metadata of the file.
Optional. The short description of the file.
Optional. The long description of the file.
Optional. The labels of the file.
Output only.
Output only.
contents object[]
Possible values: [SUBTITLE_SOURCE_TYPE_LOCAL
, SUBTITLE_SOURCE_TYPE_STT
, SUBTITLE_SOURCE_TYPE_AI_TRANSLATE
]
The source type of subtitle.
The id of the source subtitle used for translation.
Output only.
Output only.
schedule object
Output Only. Indicate the schedule setting of the AOD.
Enable VOD viewing schedule or not.
VOD viewing start time. Users can only watch the VOD within the specified start time and end time.
VOD viewing end time. Users can only watch the VOD within the specified start time and end time.
cover_image object
Output Only. Indicate the cover image of the AOD.
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.
Output only. The URL of the cover image.
Output only. The name of the cover image.
Output only. The size of the cover image.
customize object
Optional. Required if type
is COVER_IMAGE_TYPE_CUSTOMIZE
.
Required. The library id of the cover image.
Output only. The URL of the cover image.
Output only. The name of the cover image.
Output only. The size of the cover image.
Output only. The timestamp of the cover image that was updated.
metadata object
The short description of the resource.
The long description of the resource.
labels object[]
Optional. The labels of the resource. The maximum length of labels is 20
.
Required. The label name. The maximum length of the name is 20
.
showroom object
Output Only. Indicate the showroom setting of the AOD.
Optional. The model of showroom preferences.
libraries object[]
Optional. The library assets that is used by the model.
Required. The library id of the asset.
Output only. The library name of the asset.
Output only. The URL of the asset.
Output Only. The organization ID that the encoding belongs to.
player_setting object
Optional. The setting of player.
Output Only. The model of player preferences.
Output only. The resource identifier of player setting.
Output only. The name of player setting.
Output Only. The decription of player setting.
libraries object[]
Output Only. The library assets that are used in the setting.
Output Only. The library id of the asset.
Output only. The library name of the asset.
Output only. The URL of the asset.
Output Only. Indicate the created time of the AOD.
Output Only. Indicate the latest update time of the AOD.
pagination object
Output only. The total numbers of the list in the current pagination.
Output only. The number of items per page in the current pagination.
Output only. The current page in the current pagination.
{
"aods": [
{
"id": "string",
"name": "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,
"profiles": [
{
"id": "string",
"name": "string",
"bitrate": "string",
"codec": "AUDIO_CODEC_AAC"
}
],
"codec": "AUDIO_CODEC_AAC"
},
"stream": [
{
"manifests": [
{
"protocol": "PROTOCOL_HLS",
"uris": [
{
"resolutions": [
{
"height": "string",
"width": "string"
}
],
"uri": "string"
}
]
}
],
"thumbnail": {
"uri": "string"
}
}
],
"status": "AOD_STATUS_CREATED",
"previous_status": "AOD_STATUS_CREATED",
"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"
}
]
},
"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"
]
},
"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"
}
],
"schedule": {
"enable": true,
"start_time": "2024-07-29T15:51:28.071Z",
"end_time": "2024-07-29T15:51:28.071Z"
},
"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"
},
"metadata": {
"short_description": "string",
"long_description": "string",
"labels": [
{
"name": "string"
}
]
},
"showroom": {
"model": {},
"libraries": [
{
"id": "string",
"name": "string",
"url": "string"
}
]
},
"org_id": "string",
"player_setting": {
"setting": {},
"id": "string",
"name": "string",
"description": "string",
"libraries": [
{
"id": "string",
"name": "string",
"url": "string"
}
]
},
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z"
}
],
"pagination": {
"total_items": 0,
"items_per_page": 0,
"current_page": 0
}
}
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
- Example (from schema)
Schema
- Array [
- 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.)
- ]
details object[]
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:
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.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A unauthenticated response.
The header authorization
was missing or unidentified.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- 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.)
- ]
details object[]
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:
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.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A forbidden response.
It means that the provided authorization
did not have enough permission to access the resource or the API.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- 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.)
- ]
details object[]
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:
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.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A server error response. There are more HTTP status code mappings listed on here.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- 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.)
- ]
details object[]
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:
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.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- 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.)
- ]
details object[]
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:
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.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}