動画
clips > get_views_heatmap
ユーザーのために動画のヒートマップビューをリクエストします。
「ヒートマップ」ビューでは、動画のどの部分がユーザーによって見られているかを調べることができます。
ヒートマップの長さは、動画の再生時間（秒）と同じです。動画の長さが15分（900秒）の場合、ヒートマップの長さは900文字になります。
ヒートマップの値は0〜9の範囲です。これらの値は、特定の秒が見られた回数を示します。閲覧回数が9回以上の場合は全て"9"になります。
10秒の動画の例：3333320000
解釈：最初の5秒は3回、6秒は2回、残りのクリップはまったく見ていません。
注：動画がユーザーの「ヒートマップ」ビューを所有するためには、ユーザーはログイン中に少なくとも1回はその動画を再生していなければなりません。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | clips | APIセクション |
| do | get_views_heatmap | APIアクション |
| iq | Clip ID | 動画のID |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
POST変数
以下のPOST変数は必須です。
| 変数 | 値 | 説明 |
|---|---|---|
| id_user | (int) User ID | ユーザーのID |
以下のPOST変数はオプションです。
| 変数 | 値 | 説明 |
|---|---|---|
| getHeatmapURL | (int) 0|1 | ヒートマップイメージのURLを含めるかどうか |
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・heatmap：動画の「ヒートマップ」ビュー
・duration：動画の再生時間（秒）
{
"heatmap": "5444444444443333222222222211111111000000000000000000000000000000000000000000000000000000000001111110000000000000000000000000000000000000000000",
"duration": "142"
}
リクエストにハッシュが指定されていない場合など、リクエストが失敗した場合のレスポンス
{
"error" : "REQUEST_ERROR",
"error_long" : "Missing signature"
}
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | Invalid Clip ID
動画IDが1未満かもしくは数値ではありません。
・REQUEST_ERROR | Invalid User ID
ユーザーIDが1未満かもしくは数値ではありません。。
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数
$GET_VARS = array(
"go" => "clips",
"do" => "get_views_heatmap",
"iq" => 401
);
// POST変数
$POST_VARS = array(
"id_user" =>13
);
salt, timestamp, signatureを生成してリクエストを送信します。
// APIベースURLと認証情報の収集
$API_URL = "https://www.interstreamdomain.tv/api.php";
$API_KEY_ID = "1b323a1cb879fd4e66530fbad07a32ee";
$API_SHARED_SECRET = "MWIzMjNhMWNiODc5ZmQ0ZTY2NTMwZmJhZDA3YTMyZWViOTQ3MDJiOGM2ZTU2NjE3"; // 公開しないでください
// salt, timestamp, signatureの生成
$salt = md5(mt_rand());
$timestamp = time();
$signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true));
// key, salt, timestamp, signatureをGET変数に追加
$GET_VARS["timestamp"] = $timestamp; // UTCタイムスタンプ
$GET_VARS["salt"] = $salt;
$GET_VARS["key"] = $API_KEY_ID ; // APIキーID:これは公開されており、アプリケーションを識別するためにAPIによって使用されます
$GET_VARS["signature"] = $signature;
// リクエストURLを作成します。HTTPクエリを作成するためにPHPの組み込み関数を使用しない場合は、値をURLエンコードすることを忘れないでください。
$REQUEST_URL = $API_URL."?".http_build_query($GET_VARS);
// ".../api.php?go=api_subject&do=api_action&etc..."のようにURLを構築
// 新しいcURLリソースを作成して適切なオプションを設定
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $REQUEST_URL);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, $POST_VARS);
// PHPホストに有効なSSL証明書がない場合は、SSL証明書の検証を無効にする必要があります。これは危険であり、有効な証明書がインストールされるまで一時的に行われるべきです。
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // Turns off verification of the SSL certificate.
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Turns off verification of the SSL certificate.
// APIにリクエストを送信
$response = curl_exec($ch);
// レスポンス処理
if (!$response) {
echo 'API call failed';
}
else
{
print_r(json_decode($response,true));
}