サポート サポートへのお問い合わせ | システムステータス システムステータス
ページコンテンツ

    概要: プレーヤー管理API

    プレイヤー管理(Player Management)とは、パブリッシャーへのリソースとしてのプレーヤーの作成、編集、管理を指します。Player Management は、コンシューマーがプレーヤーインスタンスを作成、設定、プレビュー、公開できるサーバー側の REST API によって実現されます。
     

    はじめに

    プレーヤーの作成と更新は、2段階のアプローチで行われます。すべての変更がプロダクションプレーヤーに自動的に適用されるのではなく、変更はプレビューに分割されて公開されます。これで、エンドユーザーに表示される内容に影響を与えることなく、プレビュープレーヤーに必要なすべての更新を行うことができます。いつでも変更を公開することを選択できます。

    Player Management APIを使用すると、ユーザーは次のことができます。

    1. プレーヤーを作成する
    2. プレーヤーの設定を表示する
    3. プレーヤーの設定を変更する
    4. パブリッシャーに関連付けられているすべてのプレーヤーを一覧表示します
    5. 消費者が利用できるようにプレーヤーを公開する

    API リファレンス」も参照してください。

    ベース URL

    API のベース URL は次のとおりです。

        https://players.api.brightcove.com/v2

    はじめに

    プレーヤー管理システムは、3つの主要なオブジェクトで構成されています。これらはデフォルトのテンプレート、プレーヤー、および子プレーヤーです。

    Brightcoveデフォルトテンプレート -テンプレートは、ユーザーに提示される視聴体験を作成するための基礎として使用されるファイルと設定のセットであり、作成されるすべてのプレーヤーの基礎です。これらのファイルは、最終的にカスタマイズされたプレーヤー設定でコンパイルされ、ブラウザー(プレーヤー)に実際のコードが読み込まれます。現在、システム全体で使用されているテンプレートは1つだけです。そのため、APIを介したテンプレートの可視性はありません。

    プレイヤー -プレーヤーは、テンプレートに適用される一般的な情報とカスタマイズをキャプチャする顧客固有の設定です。これらの設定はAPIに送信され、プレーヤーオブジェクトの結果が得られます。カスタマイズには、設定、スタイル、プラグインを含めることができます。カスタマイズの可能性の完全なリストについては、プレーヤー構成ガイド

    チャイルドプレイヤー -Embed APIを使用して作成された子プレーヤーは、プレーヤーの複数のインスタンスを作成した結果です。プレーヤーには、プレーヤーに持たせたいプロパティの大部分があり、子プレーヤーを使用して、さまざまなプレーヤーインスタンスのプロパティのサブセットをカスタマイズできます。子プレーヤーは、特定のプレーヤーに追加するメディアのみを定義できます。または、子プレーヤーが属する共通プレーヤーを変更する設定またはスタイルのオーバーライドを定義できます。親プレイヤー設定の変更は、親プレイヤーからスポーンされたすべての子プレイヤーに適用されます。チェックしてください埋め込みAPIガイド詳細については。

    この図は、デフォルトのテンプレート、プレーヤー、および子プレーヤーの間の関係を示しています。

    プレイヤーエンティティ階層
    プレイヤーエンティティ階層

    Player Management APIを初めて使用すると、Brightcove DefaultPlayerがアカウントに生成されます。そのプレイヤーオブジェクトは、あなたが選択したとおりに行うためのものです。そのまま使用したり、設定を変更したり、スタイルを変更したり、プラグインを追加したりできます。カスタマイズでBrightcoveDefault Playerのみを使用するか、他のプレーヤーを作成してWebサイトのさまざまな場所のさまざまな外観と設定をキャプチャするかを選択できます。

    公開の概要

    プレーヤー管理システムの機能の1つは、テストする変更を、公開されているプレーヤーのバージョンから分離する機能です。UIとAPIの両方で、プレーヤーの構成に変更を加えると、プレーヤーのプレビューバージョンを介して変更がすぐに利用可能になります。これらのプレビューバージョンは完全に使用可能でテスト可能です。プレビューURLを共有して承認するか、変更に満足するまでプレーヤープレビューで作業してから、プレーヤーを公開して公開することができます。

    滝を更新する

    プレーヤーの公開は、子プレーヤーに影響を与える可能性のある結果をもたらします。公開の詳細は次のとおりです。

    • プレーヤーの公開は、そのプレーヤーから作成されたすべての子プレーヤーインスタンスの再公開をトリガーします。
    • 子プレーヤーの公開は、その子プレーヤーにのみ影響します。
    • Brightcoveデフォルトテンプレートの更新(Brightcove制御)は、すべてのプレーヤーの再発行をトリガーし、プレーヤーの再発行は、各プレーヤーから作成されたすべての子プレーヤーの再発行をトリガーします。

    設定は、子が勝つ方法で適用されます。これは、子レベルでの設定が親レベルで行われた変更よりも優先されることを意味します。次のことを考慮してください。

    • デフォルトのテンプレートでは、CSS値を赤に定義しています。
    • プレーヤーは、同じCSS値を白と定義します。
    • 子プレーヤーは、同じCSS値を青と定義します。

    子供が勝つため、結果は次のようになります。

    • プレーヤーのCSS値は白です。
    • 子プレーヤーのCSS値は青です。

    プロパティのデータ型が配列の場合、この継承動作は変更できます。ザ・配列フィールド詳細については、EmbedAPIガイドのセクションで説明しています。

    構成オプション

    デフォルトのプレーヤーよりも高度なプレーヤーを作成するには、プレーヤーの構成。構成はJSONを使用して定義されます。

    レート制限

    Player Management APIには、有効になっている一意のIPごとにレート制限があります。レート制限は次のとおりです。

    リクエストの種類 リミット
    公開と作成(プレーヤーと埋め込み) 60リクエスト/分
    読む(GET) 600リクエスト/分
    書き込み(POST、PUT、PATCH、およびDELETE) 300リクエスト/分
    プレーヤーのプレビュー 100リクエスト/分

    応答ステータスコード

    応答およびエラーコード/メッセージはそれらに基づいていますW3で定義。最も一般的に見られるコードのいくつかは次のとおりです。

    • 200成功をリクエストする
    • 201作成済み(プレーヤー、構成)
    • 400不正なリクエスト-API呼び出しの構文が正しくない可能性があります
    • 401無効な認証-パスワードが正しく入力されているかどうか、またはパスワードが正しいかどうかを確認してくださいOAuthの手順正しく
    • 404見つかりません-リソースが存在し、API呼び出しで使用されたURLが正しいかどうかを確認してください
    • 429レート制限を超えました
    • 500内部サーバーエラー-リクエストを実行しようとしてエラーが発生しました