印刷する

ユーザー:統計

users > list_who_viewed_content

現在までに動画やチャンネル等のコンテンツを閲覧したユーザーのリストを取得します。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数値説明
gousersAPIセクション
dolist_who_viewed_contentAPIアクション

リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。

https://....../api.php?go=users&do=list_who_viewed_content&{required information}
POST変数

以下のPOST変数は必須です。

変数値説明
contentType (string) Content Type 利用可能な値："clip", "channel" (動画チャンネル/ページ), "gallery", "news" (ニュース/イベント)
contentID (int) Content ID 動画、チャンネル/ページ、ニュース/イベント、ギャラリーのID

以下のPOST変数はオプションです。

変数値説明
includeUserData (int) 0|1 結果に沿って基本的なユーザーデータ（ログイン、ユーザー名、下の名前、姓）を取得するかどうか。
getHeatmapURL (int) 0|1 ヒートマップ画像のURLを含めるかどうか（'contentType="clip"'の場合のみ）
likeFavoriteFilter (string) option このリストを、コンテンツを「高評価した」もしくは「お気に入り」に指定したユーザーに制限します（'contentType="clip"'の場合のみ）
利用可能な値："liked", "favorited", "likedAndFavorited"

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・list：現在までにコンテンツを閲覧したユーザーのリストを含む配列（と統計）

特定の動画を閲覧したユーザー一覧の例）

{
  "list": [
    {
      "id_user": "22",
      "login": "mark",
      "alias": "Markus",
      "name": "Mark",
      "surname": "Johnson",
      "total_playbacks": "27",
      "complete_playbacks": "4",
      "last_played_second": "15",
      "duration": "15",
      "total_play_time": "98",
      "page_views": "11"
    },
    {
      "id_user": "39",
      "login": "david99",
      "alias": "DavidOn",
      "name": "David",
      "surname": "McDonald",
      "total_playbacks": "19",
      "complete_playbacks": "2",
      "last_played_second": "10",
      "duration": "15",
      "total_play_time": "50",
      "page_views": "0"
    },
    (...)
  ]
}

リクエストにハッシュが指定されていない場合など、リクエストが失敗した場合のレスポンス

{
	"error"		 : "REQUEST_ERROR",
	"error_long" : "Missing signature"
}

このリクエストは以下のエラーを返す可能性があります。

・REQUEST_ERROR | Invalid Content ID
コンテンツIDが1未満かもしくは数値ではありません。

・REQUEST_ERROR | Invalid Content Type [Must be 'clip', 'channel', 'news' or 'gallery']
contentType値が想定外です。

その他のエラー内容に関しては一般的なエラーメッセージを確認してください。

PHPサンプルコード

GETおよびPOSTデータを準備します。

// GET変数
$GET_VARS = array( 
					"go"        => "users",
					"do"        => "list_who_viewed_content"
					);

// POST変数
$POST_VARS = array(
					"contentType"		=> "clip",
					"contentID"			=> 2,
					"includeUserData"	=> 1
                    );

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)); 
}