CMS APIビデオフィールドリファレンス

ビデオフィールド

動画フィールド
フィールド	タイプ	説明
`account_id`	文字列	ビデオクラウドアカウント ID
`ad_keys`	文字列	動画に割り当てられた広告キーと値のペアを表す文字列。キーと値のペアは、キー=値としてフォーマットされ、アンパサンドで区切られます。例: `"adKeys": "category=sports&live=true"`
`clip_source_video_id`	文字列	このビデオを生成するためにクリップされたソースビデオの ID、`null`またはこのビデオが別のビデオのクリップでない場合。
`complete`	ブール値	処理が完了しているかどうか — 注:新しいビデオを作成すると、complete プロパティは自動的にに設定されます`false`。ビデオのレンディションが 1 つ存在するとすぐに、complete プロパティは自動的に`true`
`created_at`	数値、エポックからのミリ秒	Video Cloud システムでビデオが作成されたとき
`created_by`	オブジェクト	動画の作成者に関する情報（該当する場合）
`cue_points`	マップの配列	キューポイントマップの配列
`custom_fields`	フィールドと値のペアのマップ (文字列)	ビデオに設定されたカスタムフィールド値-このビデオの値を持たないカスタムフィールドはこのマップに含まれないことに注意してください。カスタムフィールド値の最大長は 1024 シングルバイト文字です。
`dash_manifest_id`	文字列	ダッシュマニフェストのシステム ID
`delivery_type`	文字列	動画の配信の種類: `dynamic_origin` -動的配信 `live_origin` -Brightcoveライブからのライブストリーム `remote` -資産 `static_origin` -レガシー取り込みシステム `unknown` -決定できませんでした（ビデオに再生可能なレンディションがない可能性があります）
`description`	文字列。古い shortDescription の代わりになります	ビデオの簡単な説明 (最大長:248 バイト文字)
`digital_master_id`	文字列	デジタルマスターのシステム ID
`drm_disabled`	ブール値	DRM が有効なアカウントの場合、これを true に設定すると、ビデオが DRM パッケージ化されなくなります。アカウントが DRM 対応でない場合、このフィールドは表示されません。
`duration`	数値、ミリ秒	ビデオの再生時間（ミリ秒）
`economics`	文字列。有効な列挙値の 1 つでなければなりません	「AD_SUPPOPTED」（デフォルト）または「無料」
`folder_id`	文字列	動画が属するフォルダの ID
`forensic_watermarking`	文字列	`ACTIVE`ビデオにフォレンジック透かしがあることを示します。`UNAVAILBLE`フォレンジック透かしが追加されなかったことを意味します。`null`アカウントでフォレンジック透かしが有効になっていないことを示します。
`ジオ` ^[1-3]	プロパティと値のペアのマップ	動画の地上制限プロパティ
`has_digital_master`	ブール値	再変換に使用できるアーカイブマスターがビデオにあるかどうか。このフィールドを使用してビデオを再トランスコードできるかどうかをテストする場合、共有動画では信頼できないことに注意してください。動画がアカウントで共有されている場合は、`has_digital_master = true`との両方をテストする必要があります`sharing.by_external_acct = false`
`id`	文字列	動画ID
`画像`	プロパティと値のペアのマップ	ポスターとサムネイル画像に関する情報マップ
`リンク`	プロパティと値のペアのマップ	関連リンクプロパティのマップ
`long_description`	文字列	長い説明 (5000 文字まで)
`name`	文字列	ビデオの名前（最大長：248 シングルバイト文字）
`offline_enabled`	ブール値	ビデオがオフライン再生可能かどうか
`original_filename`	文字列	取り込まれたビデオファイルの名前-リモートアセットビデオの場合は null になります
`projection`	文字列	360°動画のマッピング投影（例：「エクイレクタングラーン」）
`published_at`	文字列	ビデオがいつ公開されたかを示す ISO-8601 日時文字列-このフィールドは書き込み可能です。デフォルトでは、ビデオが最初にアクティブ化された日付に設定されます。
`reference_id`	文字列	動画を一意に識別するユーザー指定の ID。150 文字に制限されています。referenceId は、他のシステムでこの動画を識別するために、外部キーとして使用できます。参照 ID には、スペース、カンマ、特殊文字を含めることはできません。
`スケジュール` ^[1-1]	プロパティと値のペアのマップ	ビデオの空室状況のための開始日と終了日のマップ
`sharing`	プロパティと値のペアのマップ	ビデオの共有プロパティの地図
`smooth_client_manifest_id`	文字列	スムーズマニフェストのシステム ID
`smooth_server_manifest_id`	文字列	スムーズマニフェストサーバーのシステム ID
`state` ^[1-4]	文字列	アクティブ、非アクティブ、保留中、削除
`tags` ^[1-5]	タグの配列 (文字列)	動画に割り当てられたタグの配列
`tracks`	HTML5スタイルのテキストトラックの配列	ビデオに割り当てられたテキストトラック（WebVTT ファイル）の配列
`updated_at`	日付時刻文字列	ビデオが最後に変更された日時 ^[1-2]
`updated_by`	オブジェクト	動画の最終更新者に関する情報（該当する場合）
`バリアント`	の配列`variant`メタデータオブジェクト	さまざまな言語のメタデータバリアント

注

^[1-1] スケジュールされたビデオはいいえスケジュールされた可用性の期間外は非アクティブ
^[1-2] 変更は、ユーザーまたはVideoCloudシステムによって行われた可能性があります
^[1-3] Geo-restrictionは、VideoCloudへの有料アドオンです。ジオフィルタリング機能を購入する場合は、アカウントマネージャーに連絡してください
^[1-4] stateに設定することができますACTIVEまたINACTIVE、しかしいいえにPENDINGまたDELETED。
^[1-5] タグには次の制限があることに注意してください。
- タグは最大 128 文字です。128文字を超えるタグがある場合は、変更を保存しようとするとエラーが表示されます
- タグにはカンマを含めることはできません。たとえば、roof, attic + front yardのタグはサポートされていません
- 1本の動画に割り当て可能なタグは最大1,200個です
- 大文字と小文字のみが異なるタグ（小文字、大文字）は同じタグとして扱われ、大文字と小文字は自動的に元のタグと一致します。たとえば、JavaScript メソッドを使用して文字列を変更するなど、大文字と小文字を区別する問題は Video Cloud の外部で処理する必要があります。

ビデオソースフィールド

次の表に、ソース (レンディション) のフィールドを示します。

動的配信ソース

フィールド	タイプ	説明
`src`	文字列	ソースの URL
`type`	文字列	セグメント化されたビデオタイプ。通常は`application/x-mpegURL` (HLS の場合) または`application/dash+xml` (ダッシュの場合)
`ext_x_version`	文字列	HLS バージョン-HLS ソースのみ
`profiles`	文字列	プロファイル-ダッシュソースのみ
`codec`	文字列	ビデオコーデック-MP4 ソースのみ
`container`	文字列	ビデオコンテナ-MP4 ソースのみ
`duration`	整数	時間 (ミリ秒)-MP4 ソースのみ
`encoding_rate`	整数	BPS でのエンコードレート-MP4 ソースのみ
`height`	整数	フレームの高さ (ピクセル単位)-MP4 ソースのみ
`size`	整数	ファイルサイズ（バイト単位）-MP4ソースのみ
`uploaded_at`	文字列	動画がISO-8601の日付形式でアップロードされた日付
`width`	整数	フレーム幅 (ピクセル単位)-MP4 ソースのみ

レガシーインジェストソース (レンディション)

フィールド	タイプ
`src`	文字列URL、 PDWebアセットおよびHLSアセットのみ
`app_name`	弦、 Webアセットのストリーミングのみ
`stream_name`	弦、 Webアセットのストリーミングのみ
`codec`	文字列
`container`	文字列
`duration`	長い？
`encoding_rate`	長い？
`height`	整数
`id`	文字列
`size`	Long
`uploaded_at`	ISO-8601 日付形式の文字列
`width`	整数

レガシー取り込み HLS マニフェスト

フィールド	タイプ
`src`	文字列 URL
`type`	文字列 (アプリケーション/X-mpegURL)
`codec`	文字列
`container`	文字列

従来の取り込みHITACHIマニフェスト

フィールド	タイプ
`asset_id`	文字列
`src`	文字列 URL
`type`	文字列 (アプリケーション/f4m)

レガシー取り込みダッシュマニフェスト

フィールド	タイプ
`asset_id`	文字列
src	文字列 URL
`type`	文字列 (アプリケーション/ダッシュ+xml)

従来の取り込みスムーズマニフェスト (サーバーとクライアント)

フィールド	タイプ
`asset_id`	文字列
`src`	文字列 URL
`type`	文字列 (アプリケーション/vnd.ms-ssr+xml)

キューポイントフィールド

次の表に、キューポイントのフィールドを示します。

キューポイントフィールド
フィールド	タイプ	説明
`id`	文字列	キューポイントのシステム ID
`force_stop`	ブール値	ビデオがキューポイントで停止するかどうか
`metadata`	文字列; コードポイントのみ	キューポイントに関連付けられたメタデータ文字列
`name`	文字列	キューポイント名
`time`	フロート	ビデオの開始位置から測定されたキューポイントの時間（秒）
`type`	文字列	キューポイントタイプ ( `AD`または`DATA` )

地理フィールド

次の表に、地理オブジェクトのフィールドを示します。

地理フィルタリングフィールド
フィールド	タイプ	説明
`countries`	国コード文字列の配列	ISO 3166 の配列動画の再生が許可されている国または禁止国の 2 文字コードリスト (https://www.iso.org/obp/ui/)
`exclude_countries`	ブール値	trueの場合、国配列は表示から除外された国のリストとして扱われます
`restricted`	ブール値	この動画で地理フィルタリングが有効になっているかどうか

画像フィールド

下の表は、画像オブジェクトのフィールドを示しています

ポスターフィールド

フィールド	タイプ	説明
`images.thumbnail`	地図	サムネイル画像のプロパティをマップする
`poster`	オブジェクト	ビデオポスター（ビデオスチル）のプロパティ
`poster.asset_id`	文字列	デフォルトのポスターのシステムID
`poster.src`	文字列 URL	デフォルトのポスターの URL
`poster.sources`	マップの配列	ポスター用マップの配列
`poster.sources.asset_id`	文字列	ポスターのシステムID
`poster.sources.src`	文字列 URL	ポスターのURL
`poster.sources.height`	数値	ポスターの高さ（ピクセル単位）
`poster.sources.width`	数値	ポスターの幅 (ピクセル単位)

サムネイルフィールド

フィールド	タイプ	説明
`thumbnail`	オブジェクト	ビデオサムネイルのプロパティ
`thumbnail.asset_id`	文字列	デフォルトのサムネイル画像のシステム ID
`thumbnail.src`	文字列 URL	デフォルトのサムネイルのソース URL
`thumbnail.sources`	マップの配列	サムネイル画像用のマップの配列
`thumbnail.sources.asset_id`	文字列	サムネイルのシステムID
`thumbnail.sources.src`	文字列 URL	サムネイルの URL
`thumbnail.sources.height`	数値	画像の高さ (ピクセル単位)
`thumbnail.sources.width`	数値	画像の幅 (ピクセル単位)

リンクフィールド

次の表に、リンクオブジェクトフィールドを示します。

リンクフィールド
フィールド	タイプ	説明
`url`	文字列	関連リンク URL
`text`	文字列	関連リンクテキスト

[集計フィールド]

次の表に、集計表オブジェクトのフィールドを示します。

[集計フィールド]
フィールド	タイプ	説明
`ends_at`	ISO-8601 日付形式の文字列	ビデオが視聴できなくなる日時
`starts_at`	ISO-8601 日付形式の文字列	ビデオが視聴可能になる日時です。

次の表に、共有オブジェクトのフィールドを示します。

フィールドの共有
フィールド	タイプ	説明
`by_external_acct`	ブール値	True を指定すると、この動画が他のアカウントから共有されます。
`by_id`	文字列	共有元となったアカウント ID
`source_id`	文字列	元の動画の動画 ID（共有者のコピー）
`to_external_acct`	ブール値	この動画が別のアカウントと共有されている場合は True
`by_reference`	ブール値	本当、この動画は参照によって共有されているですか（CMS API経由で共有された動画には常に表示されます）`true`

テキストトラックフィールド

次の表は、テキストトラックフィールドを示しています。

フィールド	タイプ	説明
`id`	文字列	テキストトラックアイテムのシステム ID
`src`	文字列	トラックファイルのアドレス (URL)
`srclang`	文字列	トラックの言語、例:「en」
`label`	文字列	テキストトラックセットのユーザーが読めるタイトル
`kind`	文字列	トラックの使用方法:「字幕」、「キャプション」、「説明」、「章」、「メタデータ」
`mime_type`	文字列	テキストトラックのMIMEタイプ、例えば「text/VTT」
`asset_id`	文字列	トラックファイルのシステム ID。アセットがリモートの場合は null
`in_band_metadata_track_dispatch_type`	文字列	トラックファイルのシステム ID。アセットがリモートの場合は null
`sources`	配列	読み取り専用
`src`	文字列	トラックファイルのアドレス (URL)
`default`	ブール値	トラックをデフォルトで有効にする必要があることを示します。1つのトラックにのみ当てはまるはずです。

フィールドによって作成されました

次の表に、created_byオブジェクトフィールドを示します。

フィールドによって作成
フィールド	タイプ	説明
`type`	文字列	アップデーターの種類です。 `user` -スタジオのユーザー `api-key` -APIを介したユーザー
`id`	文字列	ビデオクラウドシステムのユーザー ID
`email`	文字列	Video Cloud システム内のユーザーのメールアドレス

フィールドによって更新されました

次の表に、updated_byオブジェクトフィールドを示します。

フィールドごとに更新
フィールド	タイプ	説明
`type`	文字列	アップデーターの種類です。 `user` -スタジオのユーザー `api-key` -APIを介したユーザー
`id`	文字列	ビデオクラウドシステムのユーザー ID
`email`	文字列	Video Cloud システム内のユーザーのメールアドレス

バリアントフィールド

次の表に、variantオブジェクトフィールドを示します。

フィールドごとに更新
フィールド	タイプ	説明
`language`	文字列	言語-国コード形式のこのバリアントの言語（例：en-US、es-ES）。ご了承ください`language`バリアントを作成するときにのみ含まれます-バリアントを更新するときに含めることはできません
`name`	文字列	この言語でのビデオのタイトル
`description`	文字列	この言語でのビデオのタイトル
`long_description`	文字列	この言語でのビデオのタイトル
`custom_fields`	オブジェクト	の地図`fieldname: value` ペア。値はこの言語のものです。値の最大長は1024シングルバイト文字です。注：必ず内部表示名/ tdではなく、フィールドの名前>