ULIZAヘルプセンター

ULIZAのPlayerAPIを使用する

対象サービス


  • ULIZA Player (Cloud) - PlayerAPIオプション(※)

 ※オプションのご契約でご利用いただけます。

 

概要


ULIZAPlayer(Cloud)のPlayerAPIオプションをご契約いただきますと、ULIZAPlayer(Cloud)のプレイヤーオブジェクト取得機能をご使用いただけます。

※本記事はPlayerAPIに関する内容です。WebAPIについてはこちらをご覧ください。

 

プレイヤーオブジェクト取得機能を使うと、ULIZAプレイヤーに備わるAPIの使用が可能になります。
当該APIを使うと、JavaScriptによりWebページ内に展開されたULIZAプレイヤーに対して動的に操作や設定変更などを指示したり、プレイヤーの状態やコンテンツの再生状況に応じたイベントをトリガーに処理を組む事が可能になります。

プレイヤーオブジェクト取得機能の仕様についてはこちらをご覧ください。
またULIZAプレイヤーのAPIの仕様についてはこちらをご覧ください。

 

プレイヤーオブジェクト取得機能を使うには、プレイヤーを埋め込む際にプレイヤーオブジェクト名を設定する必要があります。
下記手順はプレイヤータグをWebページに埋め込む方法でプレイヤーを実装する場合のプレイヤーオブジェクト名の設定方法です。

 

手順


[手順] プレイヤーオブジェクト名を設定したプレイヤータグを発行する

①左メニューから「コンテンツの管理」をクリックします
②対象コンテンツの「プレイヤータグ発行」ボタンをクリックします

20230302_02_01.png

 

③「設定」ボタンをクリックします

20230302_02_02.png

 

④プレイヤーオブジェクト名の項目に、プレイヤーオブジェクト名として使う文字列を入力します
⑤「プレイヤータグの発行に戻る」ボタンをクリックします

20230302_02_03.png

 

⑥プレイヤーオブジェクト名を設定したプレイヤータグが生成されます
プレイヤーオブジェクト名を設定した場合は、プレイヤータグに以下クエリパラメータが追加されます。

 playerobjectname=XXXXXX

(XXXXXXの部分にプレイヤーオブジェクト名として使う文字列が入ります)

20230302_02_04.png

このプレイヤータグを実装して展開されたプレイヤーは、JavaScriptのグローバルオブジェクトとして取得できます。

プレイヤーオブジェクトの使用方法についてはこちらをご覧ください。