印刷する

ギャラリー

galleries > list

ギャラリーー覧をリクエストします。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数値説明
gogalleriesAPIセクション
dolistAPIアクション

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

https://....../api.phpgo=galleries&do=list&{required information}
POST変数

以下のリストフィルターはPOST変数を使って利用できます。フィルターは複数同時に使用可能です。

変数値説明
fields (string) "field1,field2,..." 結果に含めるフィールドを指定します。
"*" = すべてのフィールド（デフォルト）
"field1, field2, field3" = フィールドのサブセット（推奨/カンマ区切り）
可能なフィールド：
id, id_user, id_channel, id_news, status, status_moderation, privacy, privacy_access_level, title, title_url, description, description_seo, tags, img_poster, img_social, img_thumbnail, img_icon, date, views_page, socialize, allow_comments, date_lastmod
ページングオプション
resultsPerPageFilter (int) n 1ページあたりの結果の数（何件表示か）
current_page (int) n 現在のページ数（何ページ目か）
paging (int) 0|1 ページングを有効/無効にする
limit (int) n 結果制限
※"resultsPerPageFilter"が未設定かつ"paging=0"の場合のみ
よく使われるフィルター
idUserFilter (int) author ID 指定したユーザーからのギャラリーを一覧表示します。
statusFilter (mixed) status 指定したステータスに一致するギャラリーを一覧表示します。
利用可能な値：0 (非アクティブ), 1 (アクティブ), "any"
注：ハッシュなしのリクエストではアクティブで承認済のギャラリーのみを返します。
sortByFilter (string) "option" リストを並べ替えます。
利用可能な値："date" (デフォルト、日付の新しい順), "title","views_page","id","random","randomSeed", "date2" (日付の古い順)
tagsFilter (string) "tag1,tag2,..." タグに従ってギャラリーを一覧表示します（カンマ区切り）。
利用可能な値："any", "clips", "ads"
idFilter string) "ID1,ID2,..." IDが指定されたものと一致するギャラリーを一覧表示します（カンマ区切り）。
日付フィルター
dateFilter (int) timestamp 日付がタイムスタンプの日付と一致するギャラリーを一覧表示します（00：00：00〜23：59：59）。
dateStartFilter (int) timestamp 日付がタイムスタンプの日付と同じかそれより後であるギャラリーを一覧表示します（00:00:00から）。
dateEndFilter (int) timestamp 日付がタイムスタンプの日付と同じかそれより前であるギャラリーを一覧表示します（23：59：59まで）。
カテゴリーフィルター
categoriesFilter (int) n カテゴリーに含まれるギャラリーを一覧表示します。
カテゴリーIDを指定するか、カテゴリーに関連付けられていないギャラリーに"-1"を指定します。
categoriesFilterStrict (int) 0|1 "categoriesFilter"により指定されたカテゴリーに直接関連付けられたギャラリーを一覧表示します。
カテゴリーの継承は無視されます。
検索フィルター
search (string) "term" 検索する用語
searchMode (string) "mode" システムが用語を検索する方法
利用可能な値：
標準モード（高速）：完全に一致するものを探します。
"std1" = タイトル+タグで検索
"std2" = タイトル+タグ+短い説明で検索
"std3" (デフォルト) = タイトル検索+タグ+詳細説明で検索
単語モード（低速、より多く一致）：用語を単語に分割し、それらの可能な組み合わせ全てを探して検索します。
"words1" = タイトル+タグで検索
"words2" = タイトル+タグ+短い説明で検索
"words3" = タイトル検索+タグ+詳細説明で検索
禁止コンテンツ除外フィルター
excludeForbiddenContent (int) 0|1 リストからユーザーがアクセス許可されていないギャラリーを除外するかどうか。
下記にある"cvr"変数と連携しています。
cvr (string) "ID1,ID2,..." CVR =コンテンツビュー制限
現在のユーザーがアクセスを許可されていないギャラリーIDのリスト（カンマ区切り）です。
"excludeForbiddenContent=1"の場合、"cvr"で指定したIDと一致する全てのギャラリーがリストから除外されます。
"cvr"が空白値の場合、"excludeForbiddenContent"の値に関係なく、ギャラリーはリストから除外されません。

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・list_total_found：（ページングの目的で）基準に一致した、見つかったアイテムの合計数。
・list_total：返されたリストの項目数。これは通常"limit"もしくは"resultsPerPageFilter"の値と一致します。
・list：アイテムリスト

{
    "list_total_found": "4",
    "list_total": 3,
    "list": [{
        "id": "49",
        "img_poster": "http:\/\/......\/public\/common\/images\/_default_gallery_poster.gif",
        "title": "Gallery 1",
        "user_alias": "InterStream"
    }, {
        "id": "40",
        "img_poster": "http:\/\/......\/uploads\/images\/gallery_40_1409303260_poster.jpg",
        "title": "Gallery 2",
        "user_alias": "InterStream"
    }, {
        "id": "37",
        "img_poster": "http:\/\/......\/uploads\/images\/gallery_37_1382608290_poster.jpg",
        "title": "Gallery 3",
        "user_alias": "InterStream"
    }]
}

認証情報にGETの許可がない場合など、リクエストが失敗した場合のレスポンス

{
	"error"		 : "REQUEST_ERROR",
	"error_long" : "Permission error: GET"
}

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

・REQUEST_ERROR | No Galleriess were found
ギャラリーが見つかりません。

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

PHPサンプルコード

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

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

// POST変数
$POST_VARS = array(					
					"fields"				=> "id,title,img_poster", // ID,タイトル,ポスター画像の各フィールド
					"paging"				=> 1, // ページング有効
					"resultsPerPageFilter"	=> 3, // 1ページにつき3件表示
					"current_page"			=> 1, // 1ページ目に戻る
					"sortByFilter"			=> "date", // 日付で並べ替え
					"statusFilter"			=> "any" // 全てのステータスを表示
                    );