ユーザー:ファイル/ストレージ
users > list_uploaded_files
ユーザーによってアップロードされたファイル(と各々のサイズ)のリストを取得します。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | users | APIセクション |
| do | list_uploaded_files | APIアクション |
| iq | User ID | ユーザーID 全ユーザがアップロードしたファイルリストが必要な場合は"ID=0"を指定します(コンテンツ量とユーザ数によっては時間がかかる場合があります)。 |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
https://....../api.php?go=users&do=list_uploaded_files&iq={user_id}&{required information}
POST変数
以下のPOST変数はオプションです。
| 変数 | 値 | 説明 |
|---|---|---|
| typeFilter | (string) type | アップロードされたファイルの種類を保存場所でフィルタリングするかどうか。 利用可能な値: "any" (デフォルト), "movies", "images", "gallery_images", "docs", "assorted" |
| includeSizes | (int) 0|1 | リストにファイルサイズ(byte)を含めるかどうか。 利用可能な値:0 (いいえ/デフォルト), 1(はい) |
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・list:ファイルリストを含む配列。
{
"list": [{
"file_name": "my_movie.mp4",
"size": "15284010"
}, {
"file_name": "clip_2536_1528796097_hq.mp4",
"size": "1761528"
}, {
"file_name": "clip_2536_1528796097_normal.jpg",
"size": "1043396"
}, {
"file_name": "clip_2536_1528796097_sprite.jpg",
"size": "42534"
}, {
"file_name": "clip_2536_1528796097_sprite.vtt",
"size": "851"
}, {
"file_name": "clip_2536_1528796098_icon.jpg",
"size": "779"
}, {
"file_name": "clip_2536_1528796098_poster.jpg",
"size": "47833"
}, {
"file_name": "clip_2536_1528796098_social.jpg",
"size": "50884"
}, {
"file_name": "clip_2536_1528796098_thumb.mp4",
"size": "14814"
}]
}
リクエストにハッシュが指定されていない場合など、リクエストが失敗した場合のレスポンス
{
"error" : "REQUEST_ERROR",
"error_long" : "Missing signature"
}
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | Invalid User ID
ユーザーIDが1未満かもしくは数値ではありません。
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数
$GET_VARS = array(
"go" => "users",
"do" => "list_uploaded_files",
"iq" => 1
);
// POST変数
$POST_VARS = array(
"typeFilter" => "any",
"includeSizes" => 1
);