ユーザー:コンテンツアクセス
users > get_cvr
ユーザーがアクセスを許可されていないコンテンツのリストをリクエストします。"CVR"はContent View Restriction=コンテンツビュー制限の略です。
ユーザーに動画、チャンネル、ギャラリーへのアクセスを許可する前に、そもそもユーザーがアクセスを許可されているかどうかを最初に確認する必要があります。このリクエストは、ユーザーがアクセスを許可されていないコンテンツを含むリストを返します。
重要
INTER-STREAM上のコンテンツ量によっては、このAPIコールによってサーバーに重負荷がかかる可能性があります。パフォーマンス向上の為にはこの結果をキャッシュし、INTER-STREAMの管理インターフェース[一般設定>設定>ユーザー]の「コンテンツビュー制限の更新時間」に従って更新することをお勧めします。
INTER-STREAM上のコンテンツ量によっては、このAPIコールによってサーバーに重負荷がかかる可能性があります。パフォーマンス向上の為にはこの結果をキャッシュし、INTER-STREAMの管理インターフェース[一般設定>設定>ユーザー]の「コンテンツビュー制限の更新時間」に従って更新することをお勧めします。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | users | APIセクション |
| do | get_cvr | APIアクション |
| iq | User ID | ユーザーID。 公開CVRが必要な場合は、"ID=0"を指定します(ログインしていないユーザーの場合)。 |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
https://....../api.php?go=users&do=get_cvr&iq={user_id}&{required information}
POST変数
このリクエストにはPOST変数は必要ありません。
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・cvr:IDと紐付くユーザーがアクセスを許可されていない3つのコンテンツの配列(動画、チャンネル/ページ、ギャラリー)
{
"cvr": {
"clip": [68, 9, 401, 43, 8],
"channel": [3, 41],
"gallery": [39]
}
}
リクエストにハッシュが指定されていない場合など、リクエストが失敗した場合のレスポンス
{
"error" : "REQUEST_ERROR",
"error_long" : "Missing signature"
}
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | Invalid User ID
ユーザーIDが1未満かもしくは数値ではありません。
・REQUEST_ERROR | User not found
ユーザーが見つかりません。
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数 $GET_VARS = array( "go" => "users", "do" => "get_cvr", "iq" => 3 ); // POST変数 $POST_VARS = array();