API:channels > list｜INTER-STREAMサポート

チャンネル/ページ

channels > list

チャンネル/ページ一覧をリクエストします。

重要
ハッシュされたリクエストをステータスフィルタが指定されていない状態で使用する場合、APIは任意のステータスのチャンネル/ページを返し、アクセス制限を無視します。
意図に応じて適切なフィルタリングを使用してください。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数	値	説明
go	channels	APIセクション
do	list	APIアクション

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

https://....../api.php?go=channels&do=list&{required information}

POST変数

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

変数	値	説明
fields	(string) "field1,field2,..."	結果に含めるフィールドを指定します。 "*" = すべてのフィールド（デフォルト） "field1, field2, field3" = フィールドのサブセット（推奨/カンマ区切り）可能なフィールド： id, id_user, status, status_moderation, type, privacy, privacy_access_level, title, title_url, description, description_seo, tags, img_poster, img_social, img_thumbnail, img_icon, date, views_page, views_embed, display_info, menu_position, menu_group, menu_inclusion, socialize, template, allow_comments, banner_top, banner_player, banner_sidebar, banner_mobile, page_head_code, page_endbody_code, img_bkg_use, img_bkg, img_bkg_color, img_bkg_position_x, img_bkg_position_y, img_bkg_repeat, img_bkg_attachment, id_import, date_lastmod, store_on_sale
埋め込みコード生成
generateEmbedCode	(int) 1	各チャンネルの埋め込みコードを生成します（チャンネルのみ）
embedWidth	(int) width	埋め込みコードの幅(px)
embedHeight	(int) height	埋め込みコードの高さ(px)
embedURLVars	(string) "&var1=value1..."	埋め込みコードの動画プレーヤーURL変数。可能なURL変数はこちらでご確認ください。
ページングオプション
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 (アクティブ), 2 (保留中のモデレーション),"any", "onsale", "pending" (moderation), "disapproved", "activeAndApproved", "onsaleActiveAndApproved", "upcomingInactiveAndApproved" 注：ハッシュなしのリクエストではアクティブで承認済のチャンネル/ページのみを返します。
sortByFilter	(string) "option"	リストを並べ替えます。利用可能な値："menu_position" (デフォルト), "date" (日付の新しい順), "date2" (日付の古い順), "title", "views_page", "id", "random", "randomSeed"
typeFilter	(mixed) type	指定したタイプのチャンネル/ページの一覧表示利用可能な値："any", 0 (動画プレイリスト), 1 (HTML/テキストページ), 2 (ポータル)
excludeTypeFilter	(string) "type1,type2..."	指定したタイプと異なるタイプのチャンネル/ページの一覧表示（カンマ区切り）利用可能な値：0 (動画プレイリスト), 1 (HTML/テキストページ), 2 (ポータル)
tagsFilter	(string) "tag1,tag2,..."	タグに従ってチャンネル/ページを一覧表示します（カンマ区切り）。利用可能な値："any", "clips", "ads"
idFilter	(string) "ID1,ID2,..."	IDが指定されたものと一致するチャンネル/ページを一覧表示します（カンマ区切り）。
idImportFilter	(string) "ID1,ID2,..."	インポートIDが指定されたものと一致するチャンネル/ページを一覧表示します（コンマ区切り）。
menuInclusionFilter	(string) "menu"	メニューの表示位置設定に従ってチャンネル/ページを一覧表示します。利用可能な値："included", "main", "footer", "none"
日付フィルター
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"変数と連携しています。
excludeForbiddenOnSaleContent	(int) 0\|1	("excludeForbiddenContent=1"の場合のみ)リストからユーザーがアクセス許可されていない「販売中」のチャンネルを除外するかどうか。
cvr	(string) "ID1,ID2,..."	CVR =コンテンツビュー制限現在のユーザーがアクセスを許可されていないチャンネルIDのリスト（カンマ区切り）です。 "excludeForbiddenContent=1"の場合、"cvr"で指定したIDと一致する全てのチャンネルがリストから除外されます。 "cvr"が空白値の場合、"excludeForbiddenContent"の値に関係なく、チャンネルはリストから除外されません。

応答例

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

{
    "list_total_found": "42",
    "list_total": 5,
    "list": [{
        "description": "",
        "id": "42",
        "img_poster": "http:\/\/......\/public\/common\/images\/_default_channel_portal_poster.gif",
        "title": "Portal",
        "type": "2",
        "type_name": "portal",
        "user_alias": "InterStream"
    }, {
        "description": "<p>Channel 1 description</p>",
        "id": "1",
        "img_poster": "http:\/\/......\/uploads\/images\/channel_1_1348912530_poster.jpg",
        "title": "Video Channel 1",
        "type": "0",
        "type_name": "video",
        "user_alias": "InterStream"
    }, {
        "description": "<p>Channel 6 description</p>",
        "id": "6",
        "img_poster": "http:\/\/......\/public\/common\/images\/_default_channel_poster.gif",
        "title": "Channel 6",
        "type": "0",
        "type_name": "video",
        "user_alias": "InterStream"
    }, {
        "description": "<p>Channel 9 description</p>",
        "id": "9",
        "img_poster": "http:\/\/......\/public\/common\/images\/_default_channel_poster.gif",
        "title": "Channel 9",
        "type": "0",
        "type_name": "video",
        "user_alias": "InterStream"
    }, {
        "description": "<p>Channel 5 description</p>",
        "id": "5",
        "img_poster": "http:\/\/......\/public\/common\/images\/_default_channel_poster.gif",
        "title": "Another Channel",
        "type": "0",
        "type_name": "video",
        "user_alias": "John"
    }]
}

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

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

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

・REQUEST_ERROR | No Clips were found
チャンネル/ページが見つかりません。

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

PHPサンプルコード

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

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

// POST変数
$POST_VARS = array(
					"fields"				=> "id,title,description,img_poster", 	// ID、タイトル、説明、ポスター画像のみ
					"paging"				=> 1, 			// ページング有効
					"resultsPerPageFilter"	=> 5, 			// 1ページにつき5件表示
					"current_page"			=> 1,			// 1ページ目に戻る
					"statusFilter"			=> "any"		// 全てのステータスのチャンネル/ページを表示
                    );

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