概要:ページ内エクスペリエンス API
はじめに
ページ内エクスペリエンスには 2 つの API が関連付けられていますが、それらは非常に異なる目的で使用されます。
- ページ内エクスペリエンス API (REST)
-
ページ内エクスペリエンス API は、ページ内エクスペリエンスをプログラムで管理できる REST API です。これは、主に、Video Cloud プラットフォームと CMS アプリケーションを統合するためのものです。
利用可能なリクエストの詳細については、 APIリファレンスの完全版も参照してください。
- ページ内エクスペリエンスクライアント API
-
インページエクスペリエンスクライアント API は、実行時にページ内エクスペリエンスの動作を管理できる JavaScript ライブラリです。これは、Brightcove Player API を使用してプレーヤーの動作を制御する方法に似ています。API は、1 つ以上の Brightcove 組み込みエクスペリエンスを実行する任意のページで使用できます。概要を参照してください。詳細については、ページ内エクスペリエンスクライアント API を参照してください。
この概要の残りの部分では、バックエンドでページ内エクスペリエンスを管理するための REST API について説明します。
ページ内エクスペリエンスの概要については、「概要:ページ内エクスペリエンスの作成、編集、公開。
以降のセクションでは、REST API リクエストの 4 つのグループの概要について説明します。
体験談
エクスペリエンスのリクエストは、次の 3 つのサブカテゴリに分類されます。
- エクスペリエンスの管理
- これらのリクエストにより、アカウントのすべてのエクスペリエンスのリストを取得できます。また、新しいエクスペリエンスを作成し、特定のエクスペリエンスを取得、更新、または削除することもできます。最後に、エクスペリエンスを複製して、新しいエクスペリエンスの開始点を作成できます。
- エクスペリエンスの公開/非公開
- これらはすべて、アカウントまたは特定のテンプレートのすべてのテンプレートのリストを取得するように要求します。
- ライブエクスペリエンスのステータスを管理する
- この 2 つのリクエストでは、ライブエクスペリエンスの現在のステータスを取得するか、
preEventそのステータスをからに変更できます（たとえばlive、から）。
[テンプレート]
テンプレートは、エクスペリエンスの全体的なルックアンドフィールを制御します。カスタムテンプレートを作成することはできませんが、いくつかの標準テンプレートがあり、時間の経過とともに追加される可能性があります。API を使用すると、アカウントで使用できるテンプレートのリストを取得したり、特定のテンプレートを取得したりできます。
テーマ
テーマを使用すると、テンプレートをカスタマイズして、エクスペリエンスに必要なルックアンドフィールを作成できます。API は、テーマの作成、取得、更新、削除を完全に管理するメソッドを提供します。
フォント
独自のフォントを使用できます。これらのメソッドでは、フォントの追加、更新、取得、削除を行うことができます。これらは、CSSを介してロードされたWebフォントです。