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

概要: Player Management API

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

概要

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

挽き目 Player Management API ユーザーは以下を行うことができます。

  1. 作る player
  2. の設定を表示する player
  3. の設定を変更する player
  4. すべてのリスト playerパブリッシャーに関連付けられた
  5. 公開する player 消費者が利用できるようにする

また、 APIリファレンス.

ベースURL

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

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

概要

挽き目 player 管理システムは、XNUMXつの主要なオブジェクトで構成されています。 これらはデフォルトのテンプレートです playersと子 players.

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

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

子 Players - 子 playersは、Embed APIを使用して作成され、複数のインスタンスを作成した結果です。 player player あなたが望むプロパティの大部分を持っています player 持っていると、あなたは子供を使うことができます player 別のプロパティのサブセットをカスタマイズする player インスタンス。 子供 player 特定のメディアに追加するメディアのみを定義できます player、または共通を変更する設定またはスタイルのオーバーライドを定義できます player それが属している。 親への変更 player 設定はすべての子に適用されます player親から生成された player。 チェックアウトする 埋め込みAPIガイド をご参照下さい。

この図は、デフォルトテンプレート間の関係を示しています。 playersと子 players.

Player エンティティ階層
Player エンティティ階層

あなたが使用している場合 Player Management API 初めて、Brightcoveデフォルト Player アカウントで生成されます。 それ player オブジェクトは、選択したとおりに処理することです。 そのまま使用したり、設定を変更したり、スタイルを変更したり、プラグインを追加したりできます。 Brightcoveのデフォルトのみを使用するように選択できます Player あなたのカスタマイズで、またはあなたは他を作成することを選択できます player■Webサイトのさまざまな場所のさまざまな外観と設定をキャプチャする。

公開の概要

の特徴の一つ Player 管理システムとは、テストする変更をバージョンから分離する機能です。 player これは公開されています。 UIとAPIの両方で、 playerの設定では、変更はプレビューバージョンを介してすぐに利用可能になります。 player。 これらのプレビューバージョンは完全に使用可能で、テスト可能です。 プレビューURLを共有して承認を得たり、 player 変更に満足するまでプレビューし、公開する前にすべて player 公開するため。

滝を更新する

公開する player 子供に影響を与える可能性のある結果があります players。 公開の詳細は次のとおりです。

  • A player publishはすべての子の再発行をトリガーします player それから作成されたインスタンス player.
  • 子供 player 公開はその子にのみ影響します player.
  • Brightcoveデフォルトテンプレートの更新(Brightcove制御)は、すべての再発行をトリガーします players、そして player 再発行すると、すべての子の再発行がトリガーされます playerそれぞれから作成された player.

設定は、子供の勝利方法で適用されます。 つまり、子レベルの設定が親レベルの変更よりも優先されます。 次の点を考慮してください。

  • デフォルトのテンプレートでは、CSSの値が赤であると定義されています。
  • A player 同じCSS値を白に定義します。
  • 子供 player 同じCSS値を青に定義します。

子供が勝ってから、結果は次のようになります:

  • 挽き目 playerのCSS値は白です。
  • 子供 playerのCSS値は青です。

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

設定オプション

を作成するために player デフォルトよりも高度 player、提供する必要があります Player 設定。 設定はJSONを使用して定義されます。

レート制限

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

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

応答ステータスコード

レスポンスとエラーコード/メッセージは、それらに基づいています W3によって定義される。 最もよく見られるコードのいくつかは次のとおりです。

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

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