ユーザー:お気に入り
users > is_favorited_content
ユーザーが動画コンテンツを「お気に入り」に登録しているかどうかを検証します。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | users | APIセクション |
| do | is_favorited_content | APIアクション |
| iq | User ID | ユーザーID |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
https://....../api.php?go=users&do=is_favorited_content&iq={user_id}&{required information}
POST変数
以下のPOST変数は必須です。
| 変数 | 値 | 説明 |
|---|---|---|
| contentID | (int) Clip ID | 検証する動画のID |
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・is_favorited:[0|1] 1=「お気に入り」, 0=「お気に入り」ではない
{
"is_favorited": 1
}
ユーザーIDが無効な場合など、リクエストが失敗した場合のレスポンス
{
"error": "REQUEST_ERROR",
"error_long": "Invalid User ID"
}
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | Invalid User ID
ユーザーIDが1未満かもしくは数値ではありません。
・REQUEST_ERROR | Invalid Content ID
コンテンツIDが1未満かもしくは数値ではありません。
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数
$GET_VARS = array(
"go" => "users",
"do" => "is_favorited_content",
"iq" => 2
);
// POST変数
$POST_VARS = array(
"contentID" => 73
);