プレイヤー

プレイヤーを作成しアカウント内の複数のアセットに割り当てる時、再生オプションおよびコンテンツの見た目を定義します。

プレイヤーの作成

[POST] /v2/players 
{
     properties
} 
   

プレイヤー一覧

[GET] /v2/players
   

プレイヤー情報の表示

[GET] /v2/players/player_id
   

プレイヤーの削除

[DELETE] /v2/players/player_id
   

ルート属性

次の表はルートに表示されるすべて属性を示しています。

ルート属性 説明
player_id

プレイヤーのID。プレイヤー一覧を取得するために、/playersルートに対してGETを実行してください。

タイプ:文字列

デフォルト:なし

例:/players/b4f1a93b779145b4a9c8ef15f8502345

プロパティ

次の表はプレイヤーと関連付けることができるすべてのプロパティを示しています。

プロパティ 説明 必須?
accent_color

ウェブカラー形式でアクセントカラーを指定します。

タイプ:文字列

デフォルト: ffbb00

例:"66FF33"

親: ooyala_branding

いいえ
alpha

ウォーターマークの透明性を指定します。

タイプ:文字列

デフォルト:なし

例:1.0

有効値:0.0から1.0

親: watermark

いいえ
always_show

ビデオ再生時に常にシークバーを表示します。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"false"

親: シーク

いいえ
buffer_on_pause

一時停止時にビデオをバッファリングします。ネットワーク速度の遅いユーザーには有効です。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"false"

親: 再生

いいえ
click_behavior

サムネイルをクリックした時の関連ビデオの現れ方を指定します。

タイプ:文字列

有効値: same_player | same_page | new_page

デフォルト: same_player

条件:related_videosが指定された時必須。

例:"same_player"

親: related_videos

条件付き
click_url

ユーザーがウォーターマークをクリックした時に移動する先のURL。

タイプ:文字列

デフォルト:なし

例:"www.mywebsite.com"

親: watermark

いいえ
default_closed_caption_language

字幕のデフォルト言語を指定します。

タイプ:文字列

デフォルト:なし

例:"true"

いいえ
digg_sharing

Diggでの共有を有効にします。有効になっている場合、show_share_buttonがtrueに設定されている必要があります。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"true"

親: ooyala_branding

いいえ
email_sharing

ユーザーがメールでビデオを共有できるようにします。有効になっている場合、show_share_buttonがtrueに設定されている必要があります。

タイプ:ブーリアン

有効値: true | false

デフォルト: true

例:"true"

親: ooyala_branding

いいえ
enable_error_screen

再生エラー時にOoyalaエラー画面を表示します。

タイプ:ブーリアン

有効値: true | false

デフォルト: true

例:"true"

親: ooyala_branding

いいえ
facebook_sharing

Facebookでの共有を有効にします。有効になっている場合、show_share_buttonがtrueに設定されている必要があります。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"true"

親: ooyala_branding

いいえ
image_url

読み取り専用。ビデオをシーク中に表示されるプレイスホルダーサムネイルへのURL。新しい画像をアップロードするには、[シークバー](/v2/docs/players_scrubber)をご覧ください。

タイプ:文字列

デフォルト:なし

例:"http://ak.c.ooyala.com/ZnMmM6AO3C-iBubra3R2Xd6pXHgK/shelf123467931"

親: シーク

いいえ
image_url

読み取り専用。ビデオ再生時にウォーターマークが入ります。.PNG, .JPG, .GIFおよび.SWFのウォーターマークが利用できますが、透過背景の.PNGファイルを使用することを推奨します。 新しい画像をアップロードするには、[ウォーターマーク](/v2/docs/players_watermark)をご覧ください。

タイプ:文字列

デフォルト:なし

例:"http://ak.c.ooyala.com/ZnMmM6AO3C-iBubra3R2Xd6pXHgK/watermark123467943"

親: watermark

いいえ
is_default

このプレイヤーを新しいプレイヤーの作成時にデフォルトプレイヤーテンプレートとして設定します。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"true"

いいえ
labels

共有ビデオのために使用するラベルを指定します。

タイプ:文字列

デフォルト:なし

条件:sourceが指定された時必須。

例:"videos_of_kittens"

親: related_videos

条件付き
name

プレイヤーの名前。

タイプ:文字列

例:"My Player with Watermark"

はい
ooyala_branding

ブランディングオプションを指定します。 タイプ:コンテナ

いいえ
order

関連ビデオを昇順または降順でソートするかを指定します。

タイプ:文字列

有効値:"asc" | "desc"

デフォルト:"desc"

例:"desc"

親: related_videos

いいえ
playback

再生オプションを指定します。 タイプ:コンテナ

いいえ
provider_homepage_url

お客様のウェブサイトのホームページのURL。

タイプ:文字列

デフォルト:なし

条件:show_info_screen_homepage_linkがtrueに設定されている場合必須。

例:"http://myhomepage.com"

条件付き
related_videos

関連ビデオ設定を指定します。 タイプ:コンテナ

いいえ
scrubber

シークオプションを指定します。 タイプ:コンテナ

いいえ
show_ad_countdown

ユーザーがビデオの開始がわかるよう、広告表示時にカウントダウンタイマーを表示します。

タイプ:ブーリアン

有効値: true | false

デフォルト: true

例:"true"

親: ooyala_branding

いいえ
show_bitrate_button

利用可能なビットレートからユーザーが選択できるボタンを表示します。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"true"

親: ooyala_branding

いいえ
show_channel_button

ユーザーがチャンネル上のほかのコンテンツをクリックして視聴できるチャンネルボタンを表示します。

タイプ:ブーリアン

有効値: true | false

デフォルト: true

例:"true"

親: ooyala_branding

いいえ
show_embed_button

ユーザーがビデオをウェブサイトに埋め込むことができるよう、コードスニペットを含む埋め込みボタンを表示します。

タイプ:ブーリアン

有効値: true | false

デフォルト: true

例:"true"

親: ooyala_branding

いいえ
show_end_screen_replay_button

ビデオ完了時に、ユーザーがボタンを押してもう一度ビデオを視聴できるようにします。

タイプ:ブーリアン

有効値: true | false

デフォルト: true

例:"true"

親: ooyala_branding

いいえ
show_info_button

ユーザーがビデオの情報を表示することの出来る[情報]ボタンを有効にします。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"true"

親: ooyala_branding

いいえ
show_info_screen_description

ユーザーが[情報]ボタンを押した時にビデオの説明を表示します。有効になっている場合、show_info_buttonがtrueに設定されている必要があります。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"true"

親: ooyala_branding

いいえ
show_info_screen_homepage_link

ビデオプロバイダーへのリンクを表示します。有効になっている場合、show_info_screen_homepage_linkとshow_info_screen_homepage_nameが指定されている必要があります。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"true"

親: ooyala_branding

条件付き
show_info_screen_title

ユーザーが[情報]ボタンを押した時にビデオのタイトルを表示します。有効になっている場合、show_info_buttonがtrueに設定されている必要があります。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"true"

親: ooyala_branding

いいえ
show_share_button

ユーザーがソーシャルメディアでコンテンツを共有できるようになる共有ボタンを有効にします。他の共有オプション (twitter_sharingなど)を有効にせずにこのボタンを有効にした場合、一切のオプションなしにこのボタンが現れます。

タイプ:ブーリアン

有効値: true | false

デフォルト: true

条件:複数の共有オプションが指定されている場合必須。

例:"true"

親: ooyala_branding

条件付き
show_volume_button

音量ボタンを表示します。

タイプ:ブーリアン

有効値: true | false

デフォルト: true

例:"true"

親: ooyala_branding

いいえ
sort

どのように関連ビデオをソートするかを指定します。

タイプ:文字列

有効値:"upload_time"

デフォルト:"upload_time"

例:"upload_time"

親: related_videos

いいえ
source

どのタイプのビデオを関連ビデオをとして表示するかを指定します。

タイプ:文字列

有効値: shared_labels | specified_label

デフォルト:なし

条件:related_videosが指定された時必須。

例:"same_player"

親: related_videos

条件付き
stumbleupon_sharing

StumbleUponでの共有を有効にします。有効になっている場合、show_share_buttonがtrueに設定されている必要があります。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"true"

親: ooyala_branding

いいえ
twitter_sharing

Twitterでの共有を有効にします。有効になっている場合、show_share_buttonがtrueに設定されている必要があります。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"true"

親: ooyala_branding

いいえ
url_sharing

[URLをコピー]ボタンを表示します。有効になっている場合、show_share_buttonがtrueに設定されている必要があります。

タイプ:ブーリアン

有効値: true | false

デフォルト: true

例:"true"

親: ooyala_branding

いいえ
watermark

ウォーターマークオプションを指定します。 タイプ:コンテナ

いいえ

この例はすべてのデフォルト設定を使用している基本的なプレイヤーを作成します。

 [POST] /v2/players
{
  "name": "Basic Player"
}
    

Backlot は次のようなレスポンスを返します。

{
  "ooyala_branding": {
    "show_share_button": true,
    "twitter_sharing": false,
    "show_info_screen_homepage_link": true,
    "show_ad_countdown": true,
    "show_info_screen_title": true,
    "facebook_sharing": false,
    "show_info_button": true,
    "url_sharing": false,
    "email_sharing": true,
    "digg_sharing": false,
    "show_embed_button": true,
    "show_info_screen_description": false,
    "show_bitrate_button": false,
    "show_channel_button": true,
    "enable_error_screen": true,
    "show_end_screen_replay_button": true,
    "accent_color": "#ffbb00",
    "show_volume_button": true
  },
  "name": "Basic Player",
  "provider_homepage_url": null,
  "related_videos": {
    "click_behavior": "new_page",
    "order": "desc",
    "sort": "upload_time",
    "labels": [

    ],
    "source": "shared_labels"
  },
  "is_default": false,
  "scrubber": {
    "image_url": null,
    "always_show": false
  },
  "playback": {
    "buffer_on_pause": false
  },
  "id": "83fc33534581448eab446935baa6b1f0",
  "default_closed_caption_language": "",
  "watermark": {
    "image_url": null,
    "click_url": null,
    "alpha": 1.0
  }
}
    

Sorting 試行する

Note: プレイヤーID に対してGETリクエストを発行することで、いつでもこの情報を取得することができます(例, [GET] /v2/players/83fc33534581448eab446935baa6b1f0)。

この例はTwitterおよびFacebook共有を有効にし、アクセントカラーをピンクにします。

[PATCH] /v2/players/83fc33534581448eab446935baa6b1f0
{
  "ooyala_branding": {
    "twitter_sharing": true,
    "facebook_sharing": true,
    "accent_color": "#FF1493"
  }
}
    

Backlot は次のようなレスポンスを返します。

{
  "ooyala_branding": {
    "show_share_button": true,
    "twitter_sharing": true,
    "show_info_screen_homepage_link": true,
    "show_ad_countdown": true,
    "show_info_screen_title": true,
    "facebook_sharing": true,
    "show_info_button": true,
    "url_sharing": false,
    "email_sharing": true,
    "digg_sharing": false,
    "show_embed_button": true,
    "show_info_screen_description": false,
    "show_bitrate_button": false,
    "show_channel_button": true,
    "enable_error_screen": true,
    "show_end_screen_replay_button": true,
    "accent_color": "#FF1493",
    "show_volume_button": true
  },
  "name": "Basic Player",
  "provider_homepage_url": null,
  "related_videos": {
    "click_behavior": "new_page",
    "order": "desc",
    "sort": "upload_time",
    "labels": [

    ],
    "source": "shared_labels"
  },
  "is_default": false,
  "scrubber": {
    "image_url": null,
    "always_show": false
  },
  "playback": {
    "buffer_on_pause": false
  },
  "id": "83fc33534581448eab446935baa6b1f0",
  "default_closed_caption_language": "",
  "watermark": {
    "image_url": null,
    "click_url": null,
    "alpha": 1.0
  }
}
    

Sorting 試行する

この例はすべてのプレイヤーを一覧表示します。

[GET] /v2/players
    

Backlot プレイヤー一覧およびコンフィグレーション設定を返します。

Sorting 試行する

この例はプレイヤーを削除します。

[DELETE] /v2/players/83fc33534581448eab446935baa6b1f0
    

Backlot は200のレスポンスを返します。

Sorting 試行する

この記事はお役にたちましたか?