チャンネル/ページ
channels > get
チャンネル/ページ情報をリクエストします。
ハッシュ付きリクエストを使用する場合、それはアプリケーションの責任になります。
1. チャンネル/ページをユーザーに表示するかどうかを決定します（APIは制限の有無にかかわらずチャンネル/ページ情報を返します）。アプリケーションは、はじめにAPIコールの"users > get_cvr"を用いてユーザーが各コンテンツにアクセスする権限があるかどうかを確認し、次に何をするかを決定する必要があります。
2. チャンネル/ページがアクティブかどうかを確認します（APIはステータスに関係なく動画情報を返します）。
可能なステータス値：0 (非アクティブ), 1 (アクティブ), 2 (保留中のモデレーション)
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | channels | APIセクション |
| do | get | APIアクション |
| iq | Channel ID | チャンネル/ページID |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
POST変数
以下のPOST変数はオプションです。
| 変数 | 値 | 説明 |
|---|---|---|
| generateEmbedCode | (int) 0|1 | "1"の場合、対応する埋め込みコードが生成されます（チャンネルのみ）。 |
| embedWidth | (int) width | 埋め込みコードの幅(px) |
| embedHeight | (int) height | 埋め込みコードの高さ(px) |
| embedURLVars | (string) "&var1=value1..." | 埋め込みコードの動画プレーヤーURL変数。 可能なURL変数はこちらでご確認ください。 |
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・data：チャンネル/ページ情報
・playlists：チャンネルのプレイリスト一覧（チャンネルのみ）
・categories：チャンネル/ページに関連付けられているカテゴリのリスト
{
"data": {
"ad_policy": "0",
"admin_template": "",
"allow_comments": "1",
"banner_mobile": "",
"banner_player": "",
"banner_sidebar": "",
"banner_top": "",
"date": "1348912509",
"date_formatted": "29\/09\/2012 11:55:09 AM",
"date_lastmod": "1426679760",
"date_lastmod_formatted": "18\/03\/2015 12:56:00 PM",
"description": ">p>Channel 1 description...>\/p>",
"description_seo": "Channel 1 description...",
"display_info": "1",
"id": "1",
"id_import": null,
"id_user": "1",
"img_bkg": "",
"img_bkg_attachment": "scroll",
"img_bkg_color": "#ADDCFF",
"img_bkg_position_x": "center",
"img_bkg_position_y": "top",
"img_bkg_repeat": "repeat",
"img_bkg_use": "0",
"img_icon": "http:\/\/......\/uploads\/images\/channel_1_1348912530_icon.jpg",
"img_poster": "http:\/\/......\/uploads\/images\/channel_1_1348912530_poster.jpg",
"img_social": "http:\/\/......\/uploads\/images\/channel_1_1348912530_social.jpg",
"img_thumbnail": "http:\/\/......\/uploads\/images\/channel_1_1348912530_thumb.jpg",
"menu_group": "",
"menu_inclusion": "main",
"menu_position": "2",
"page_endbody_code": "",
"page_head_code": "",
"privacy": "0",
"privacy_access_level": "5",
"socialize": "1",
"status": "1",
"status_moderation": "1",
"store_on_sale": "0",
"tags": "video, channel, 1, various",
"template": "default",
"title": "Video Channel 1",
"title_url": "video-channel-1",
"type": "0",
"type_name": "video",
"url": "http:\/\/......\/index.php\/channel\/1\/video-channel-1\/",
"user_alias": "InterStream",
"user_url": "http:\/\/......\/index.php\/portal\/user\/1\/inter-stream\/",
"views_embed": "3",
"views_embed_formatted": "3",
"views_page": "7134",
"views_page_formatted": "7,134"
},
"playlists": [{
"clips": "6",
"id": "36",
"is_current": "0",
"sorting": "0",
"sync_time": "0",
"time_synced": "0",
"title": "Ch1 Monday"
}, {
"clips": "9",
"id": "37",
"is_current": "0",
"sorting": "0",
"sync_time": "0",
"time_synced": "0",
"title": "Ch1 Tuesday"
}, {
"clips": "27",
"id": "43",
"is_current": "1",
"sorting": "0",
"sync_time": "0",
"time_synced": "1",
"title": "Ch1 Wednesday"
}],
"categories": [{
"id": 18,
"title": "Pixar",
"breadcrumb": [{
"id": "1",
"title": "Movies"
}, {
"id": "7",
"title": "Animation"
}, {
"id": 18,
"title": "Pixar"
}]
}, {
"id": 1,
"title": "Movies",
"breadcrumb": [{
"id": 1,
"title": "Movies"
}]
}]
}
認証情報にGETの許可がない場合など、リクエストが失敗した場合のレスポンス
{
"error" : "REQUEST_ERROR",
"error_long" : "Permission error: GET"
}
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | Invalid Channel/Page ID
チャンネル/ページIDが1未満かもしくは数値ではありません。
・REQUEST_ERROR | Channel/Page not found, inactive or restricted
チャンネル/ページが見つからない、非アクティブ、もしくは公開制限されています。
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数 $GET_VARS = array( "go" => "channels", "do" => "get", "iq" => 1 ); // POST変数 $POST_VARS = array();