サポート サポート問い合わせ先 | システムステータス システムステータス

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

これは、返されたビデオフィールドへの参照です。 CMS API.

ビデオフィールド

カスタムフィールド
フィールド 種類 説明
account_id 文字列 挽き目 Video Cloud アカウントID
ad_keys 文字列 動画に割り当てられた広告キーと値のペアを表す文字列。 キー/値のペアは、key = valueとしてフォーマットされ、アンパサンドで区切られます。 例えば: "adKeys": "category=sports&live=true"
clip_source_video_id 文字列 この動画を制作するためにクリップされたソース動画のID null この動画が別の動画のクリップでない場合
complete ブーリアン 処理が完了したかどうか - 注:新しいビデオを作成すると、完全なプロパティが自動的に false。 動画のレンディションが1つだけになると、完全なプロパティが自動的に true
created_at エポックからのミリ秒数 動画が Video Cloud システム
created_by オブジェクト 利用可能な場合は、誰がビデオを作成したかに関する情報
cue_points マップの配列 キューポイントマップの配列
custom_fields フィールド値ペア(文字列)のマップ 動画に設定されたカスタムフィールド値 - Studio上ではサポートされていません。 このビデオの価値はこの地図には含まれていません。 カスタムフィールドの値の最大長は1024の1バイト文字です
dash_manifest_id 文字列 DASHマニフェストのシステムID
delivery_type 文字列 ビデオの配信タイプ:
  • dynamic_origin - 動的配送
  • live_origin -ブライトコーブからのライブストリーム Live
  • remote - 資産
  • static_origin - レガシーインジェストシステム
  • unknown - 決定できませんでした(ビデオに再生可能なレンディションがないことを意味する可能性があります)
description 文字列; 古いshortDescriptionに代わる 動画の簡単な説明(最大長:248の半角文字)
digital_master_id 文字列 デジタルマスタのシステムID
drm_disabled ブーリアン DRM対応アカウントの場合、これをtrueに設定すると、ビデオがDRMパッケージ化されなくなります。 アカウントがDRM対応でない場合、このフィールドは表示されません。
duration 数、ミリ秒 ビデオの所要時間(ミリ秒)
economics 文字列。有効な列挙値の1つである必要があります。 "AD_SUPPORTED"(デフォルト)または "FREE"
folder_id 文字列 ビデオが属するフォルダのID
geo [1-3] プロパティと値のペアのマップ ビデオの地理的制限のプロパティ
has_digital_master ブーリアン ビデオに再コーディングに使用できるアーカイブマスターがあるかどうか。 動画を再エンコードできるかどうかをテストするためにこのフィールドを使用している場合、共有動画については信頼できません。 動画がアカウントに共有されている場合は、両方の動画をテストする必要があります。 has_digital_master = truesharing.by_external_acct = false
id 文字列 ビデオID
images プロパティと値のペアのマップ ポスターとサムネイル画像に関する情報の地図
link プロパティと値のペアのマップ 関連リンクプロパティのマップ
long_description 文字列 長い説明(最大5000文字)
name 文字列 動画の名前(最大長:248の半角文字)
offline_enabled ブーリアン ビデオがオフライン再生に対応しているかどうか
original_filename 文字列 取り込んだ動画ファイルの名前。リモートアセット動画の場合はnullになります
projection 文字列 360°ビデオのマッピングプロジェクション、例えば "等角"
published_at 文字列 ISO-8601ビデオが公開された日時を示す文字列。このフィールドは書き込み可能であることに注意してください。 デフォルトでは、ビデオが最初にアクティブ化された日付に設定されます。
reference_id 文字列 ユーザー指定のID ビデオを一意に識別する150文字に制限されています。 referenceIdは、別のシステムでこのビデオを識別するための外部キーとして使用できます。 参照IDには、スペース、コンマ、または特殊文字を含めないでください。
schedule [1-1] プロパティと値のペアのマップ ビデオの可用性の開始日と終了日時のマップ
sharing プロパティと値のペアのマップ ビデオの共有プロパティのマップ
smooth_client_manifest_id 文字列 スムースマニフェストのシステムID
smooth_server_manifest_id 文字列 スムースマニフェストサーバのシステムID
state [1-4] 文字列 アクティブ、非アクティブ、保留中、削除済み
tags [1-5] タグの配列(文字列) ビデオに割り当てられたタグの配列
text_tracks HTML5スタイルのテキストトラックの配列 ビデオに割り当てられたテキストトラックの配列(WebVTTファイル)
updated_at 日時文字列 動画が最後に変更された日時 [1-2]
updated_by オブジェクト 利用可能であれば、ビデオを最後に更新した人に関する情報

ノート

  • [1-1] スケジュールされた動画は Studio上ではサポートされていません。 予定された利用可能期間外に非アクティブ
  • [1-2] 修正は、ユーザまたは Video Cloud システム
  • [1-3] 地理的制限は有料のアドオンです Video Cloud; 地域フィルタリング機能を購入する場合は、アカウントマネージャーにお問い合わせください
  • [1-4] state に設定することができます ACTIVE or INACTIVE、 だけど Studio上ではサポートされていません。 〜へ PENDING or DELETED.
  • [1-5] タグには次の制限事項があります。
    • タグは128文字まで可能です。 128文字以上のタグがある場合、変更を保存しようとするとエラーが表示されます
    • タグにカンマは使用できません。 例えば、 roof, attic + front yard サポートされていません。
    • 動画は1200個のタグの総数を超えることはできません
    • 大文字小文字(大文字小文字のみ)の異なるタグは同一のタグとして扱われ、大文字と小文字は自動的に元のタグのものと一致します。大文字と小文字の区別の問題は、外部から処理する必要があります Video Cloudたとえば、JavaScriptメソッドを使用して文字列を変更する

ビデオソースフィールド

下の表は、ソース(レンディション)のフィールドを示しています。

動的配信ソース

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

レガシー入荷元(レンディション)

フィールド 種類
src 文字列URL、 PDウェブ資産とHLS資産のみ
app_name 文字列、 ストリーミングWebアセット専用
stream_name 文字列、 ストリーミングWebアセット専用
codec 文字列
container 文字列
duration 長いです?
encoding_rate 長いです?
height 整数
id 文字列
size 長い
uploaded_at ISO-8601日付形式の文字列
width 整数

レガシー・インジェストHLSマニフェスト

フィールド 種類
src 文字列URL
type 文字列(application / x-mpegURL)
codec 文字列
container 文字列

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

フィールド 種類
asset_id 文字列
src 文字列URL
type 文字列(application / f4m)

レガシー・インジェスト・ダッシュ・マニフェスト

フィールド 種類
asset_id 文字列
SRC 文字列URL
type 文字列(アプリケーション/ダッシュ+ xml)

レガシーインジェストスムーズマニフェスト(サーバーとクライアント)

フィールド 種類
asset_id 文字列
src 文字列URL
type 文字列(application / vnd.ms-sstr + xml)

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

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

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

地理フィールド

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

ジオフィルタリングフィールド
フィールド 種類 説明
countries 国コード文字列の配列 動画の再生が許可されている国または許可されていない国の3166文字コードのリスト(https://www.iso.org/obp/ui/)のISO 2リストの配列
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 ブーリアン この動画が他のアカウントから共有されている場合は真です。
by_id 文字列 共有を開始したアカウントID
source_id 文字列 元の動画の動画ID(共有者のコピー)
to_external_acct ブーリアン この動画が他のアカウントと共有されている場合はTrue
by_reference ブーリアン この動画は参照によって共有されています true を介して共有される動画の場合 CMS API)

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

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

フィールド 種類 説明
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 ブーリアン トラックをデフォルトで有効にする必要があることを示します。 XNUMXつのトラックでのみtrueになります。

フィールドで作成

下の表は、 created_by オブジェクトフィールド。

フィールズで作成
フィールド 種類 説明
type 文字列 アップデータのタイプ - どちらか:
  • user - Studioのユーザー
  • api-key - API経由のユーザー
id 文字列 ユーザーIDは Video Cloud システム
email 文字列 ユーザーのメールアドレスは Video Cloud システム

フィールドで更新

下の表は、 updated_by オブジェクトフィールド。

フィールドによって更新
フィールド 種類 説明
type 文字列 アップデータのタイプ - どちらか:
  • user - Studioのユーザー
  • api-key - API経由のユーザー
id 文字列 ユーザーIDは Video Cloud システム
email 文字列 ユーザーのメールアドレスは Video Cloud システム

ページの最終更新日:12年2020月XNUMX日