プレイヤーDiscoveryプロファイル

プレイヤーに表示されるお勧めのためのOoyala Discovery設定を構築するDiscoveryプロファイルを作成することができます。

Discoveryプロファイルはないが、プレイヤーに対してOoyala Discoveryが有効になっている場合、 プレイヤーは同じOoyala Discovery設定をデフォルトプレイヤーとして使用します。

デフォルトDiscoveryプロファイルを作成

[PUT] /v2/players/player_id/discovery/profile
{ 
     properties
} 
   
Note: Discoveryプロファイルのコピーを作成する場合、ソースプレイヤーのDiscovery プロファイルに対して GETを実行して、結果本体からデータをコピーしてください。それから、 新しいプロファイルへの入力としてソースプレイヤーのDiscoveryプロファイルのボディを使用して、 新しいターゲットプレイヤーのDiscoveryプロファイルに対してPUTを実行してください。

作成済みのDiscoveryプロファイルを使用

Discovery APIリクエストでDiscoveryプロファイルを使用するには、 クエリー文字列パラメータ discovery_profile_id=profile_idを追加します。 profile_idは作成済みプロファイルの識別子です。このクエリー文字列パラメータはリクエスト内のほかのクエリー文字列パラメータに優先します。

次の例は、discovery_profileクエリー文字列パラメータで変更された パーソナライズされたお勧めのためのリクエストです。

[GET] /v2/discover/personal/device_id?discovery_profile_id=profile_id
   

Discoveryプロファイル情報の表示

[GET] /v2/players/player_id/discovery/profile
   

Discoveryプロファイルの削除

[DELETE] /v2/players/player_id/discovery/profile
   

ルート属性

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

ルート属性 説明
player_id

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

タイプ:文字列

デフォルト:なし

例:/players/b4f1a93b779145b4a9c8ef15f8502345

プロパティ

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

プロパティ 説明 必須?
default_countdown

次のビデオを自動スタートする前に、秒単位で長さを指定します。

タイプ:整数

例:"10"

いいえ
discovery_controls

Ooyala Discoveryコントロール設定を指定します。

タイプ:コンテナ

いいえ
discovery_interface

ユーザーインターフェイス設定を特定します。

タイプ:コンテナ

いいえ
exclude_content_types

Ooyala Discoveryのお勧めに含めないコンテンツタイプのコンマ区切りの一覧。

タイプ:文字列の一覧

有効値: ビデオ | live_stream

デフォルト:なし

例:"live_stream","video"

いいえ
exclude_labels

Ooyala Discoveryのお勧めから除外するラベルのコンマ区切りの一覧。このオプションを使うには、filter_byexclude_labelsを設定してください。

タイプ:文字列の一覧

デフォルト:なし

例:"126ac19f053e424ab41bfbab5526ec30","d5751b77a0c24972888bf906734d8c34"

いいえ
filter_by

使用するラベルフィルタリングのラベルタイプを指定します。ラベルを除外するには、exclude_labelsを指定して、exclude_labelsパラメータでラベルの一覧を指定してください。特定のラベルを含むには、from_labelsを指定して、from_labelsパラメータでラベルの一覧を指定してください。 ソースとお勧めビデオで共有されるラベルのみを使うには、shared_labelを指定してください。

タイプ:文字列

デフォルト:なし

有効値Valid Values: exclude_labels | from_labels | shared_label

例:"exclude_labels"

いいえ
from_content_types

Ooyala Discoveryのお勧めに含まれているコンテンツタイプのコンマ区切りの一覧。コンテンツタイプがサポートされていず、どのタイプも除外されていなければ、すべてのコンテンツタイプを返します。

タイプ:文字列の一覧

有効値: ビデオ | live_stream

デフォルト:なし

例:"video","live_stream"

いいえ
from_labels

Ooyala Discoveryのお勧めに使用するラベルのコンマ区切りの一覧ラベルが指定されていない場合、すべてのラベルが許可されます。

タイプ:文字列の一覧

デフォルト:なし

例:"126ac19f053e424ab41bfbab5526ec30","d5751b77a0c24972888bf906734d8c34"

いいえ
hide_thumbnail_title

お勧めビデオサムネイルのタイトルを非表示にします。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"true"

いいえ
include_sub_account_assets

Ooyala Discoveryのお勧めがサブアカウントからのコンテンツを含んでいるかどうかを指定してください。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"true"

いいえ
overrides

結果で特定のロケーションへコンテンツを挿入できるOoyala Discoveryへのオーバーライドを指定します。オーバーライドの位置、オーバーライドタイプ、追加情報を指定してください。

プロモ-ションコンテンツを挿入したいなら、"label"を指定して、プロモーションラベルのIDを入力してください。

各ビデオのメタデータから情報を取り出す場合、"relation"と使用するメタデータキーを指定してください。たとえば、シリーズで次のビデオを選ぶことができます。next_series_videoというメタデータエントリーを作成して、このメタデータをシリーズの各ビデオに追加してください(次のビデオのコンテンツIDを特定)。

ライブコンテンツを挿入したいなら、追加情報なしで"live"を指定してください。

タイプ:コンテナ

有効値: label | relation | live

デフォルト:なし

例:

“1”:{ “label”:“126ac19f053e424ab41bfbab5526ec30” }

“3”:{ “relation”:“next_series_video” }

“5”:"live"

いいえ
post_order

Ooyala Discoveryが結果のセットを作成した後、結果を再オーダーできます。"recency"を指定することで、最新から一番古いものの順番で結果を返すことができます。

Note: post_order設定は編集上のオーバーライドには影響しません。

タイプ:文字列

有効値: recency | <blank>

デフォルト:<blank>

例:"recency"

いいえ
recency_threshold_in_days

コンテンツ表示の最長期間を日数で指定します。たとえば、先週アップロードされたコンテンツのお勧めのみを表示するプレイヤーを作成できます。

タイプ:整数

例:"7"

いいえ
recommendation_scope

お勧め範囲を指定します。

タイプ:コンテナ

いいえ
shared_root_label

お勧めの生成に使用する基本ラベルのIDを指定します。たとえば、"sports"ラベルにIDを設定してください。

タイプ:文字列

デフォルト:なし

例:"126ac19f053e424ab41bfbab5526ec30"

いいえ
show_pause_screen

ユーザーがビデオを一時停止する時は、常に一時停止画面を有効にして、Ooyala Discoveryのお勧めを表示します。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例:"true"

いいえ
when_done

ビデオ終了時の動作を指定します。Ooyala Discovery画面の表示、次のビデオを画面に表示、次のビデオの自動再生および、何もしない(デフォルトの終了画面設定)などのオプション。

タイプ:文字列

有効値: discovery_tray | up_next | none

デフォルト:なし

例:"up_next"

いいえ

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

 [PUT] /v2/players/1fc11f8bc80e4a1a87303ee16fb8ad43/discovery/profile
{}
    

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

{
 "discovery_interface": {
  "default_countdown": "0",
  "show_pause_screen": "false",
  "hide_thumbnail_title": "false",
  "when_done": ""
 },
 "discovery_controls": {
  "compute_trending_labels": "false",
  "trending_min_granularity": "2",
  "include_sub_account_assets": "",
  "recommendation_scope": {
   "from_content_types": [    ],
   "exclude_content_types": [    ],
   "exclude_labels": [    ],
   "recency_threshold_in_days": "",
   "from_labels": [    ]
  },
  "fallback_rules": [   ],
  "optimization_goal": ""
 }
}
    

Sorting 試行する

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

この例がデフォルト設定のカウントダウンを10秒に変えます。

[PATCH] /v2/players/1fc11f8bc80e4a1a87303ee16fb8ad43/discovery/profile
{
 "discovery_interface": {
  "default_countdown": "10"
 }
}
    

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

{
 "discovery_interface": {
  "default_countdown": "10",
  "show_pause_screen": "false",
  "hide_thumbnail_title": "false",
  "when_done": ""
 },
 "discovery_controls": {
  "compute_trending_labels": "false",
  "trending_min_granularity": "2",
  "include_sub_account_assets": "",
  "recommendation_scope": {
   "from_content_types": [    ],
   "exclude_content_types": [    ],
   "exclude_labels": [    ],
   "recency_threshold_in_days": "",
   "from_labels": [    ]
  },
  "fallback_rules": [   ],
  "optimization_goal": ""
 }
}
    

Sorting 試行する

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