動画
clips > list
動画或いは広告の一覧をリクエストします。
重要
ハッシュされたリクエストを使用するとき(そしてステータスフィルタが指定されていないとき)、APIは任意のステータスの動画を返し、アクセス制限を無視します。
意図に応じて適切なフィルタリングを使用してください。
ハッシュされたリクエストを使用するとき(そしてステータスフィルタが指定されていないとき)、APIは任意のステータスの動画を返し、アクセス制限を無視します。
意図に応じて適切なフィルタリングを使用してください。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | clips | APIセクション |
| do | list | APIアクション |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
https://....../api.php?go=clips&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, aspect, duration, date, views, views_complete, views_page, views_embed, clicks, likes, dislikes, is_featured, is_skippable, is_skippable_after, is_3d, socialize, is_ad, ad_link, interactivity_timing, interactivity_spacing, interactivity_start_delay, interactivity_randomization, allow_comments, downloadable, downloadable_xfiles, id_import, date_lastmod, downloadable_condition, store_on_sale, store_play_trailer, is_deletable_only_by_admin |
| 埋め込みコード生成 | ||
| 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", "active", "activeAndApproved", "featured", "featuredActiveAndApproved", "pending", "disapproved", "upcomingInactiveAndApproved", "onsale", "onsaleActiveAndApproved" 注:ハッシュなしのリクエストではアクティブで承認済の動画のみを返します。 |
| sortByFilter | (string) "option" | リストを並べ替えます。 利用可能な値:"date" (デフォルト、日付の新しい順), "date2" (日付の古い順), "title", "views_page", "views", "likes", "duration" (再生時間の短い順), "duration2" (再生時間の長い順), "id", "random", "randomSeed", "playlist" |
| typeFilter | (mixed) type | 指定したタイプの動画を一覧表示 利用可能な値:"any", 0 (標準), 1 (Stream VOD), 2 (Stream Live), 3 (埋め込み), 4 (オートエンコーディング) |
| clipAdFilter | (string) "option" | 動画、広告などを表示するかどうか。 利用可能な値:"any", "clips", "ads" |
| tagsFilter | (string) "tag1,tag2,..." | タグに従って動画を一覧表示します(カンマ区切り)。 利用可能な値:"any", "clips", "ads" |
| idFilter | (string) "ID1,ID2,..." | IDが指定されたものと一致する動画を一覧表示します(カンマ区切り)。 |
| idImportFilter | (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まで)。 |
| チャンネルフィルター | ||
| channelsFilter | (int) n | チャンネルプレイリストに含まれる動画を一覧表示します。 チャンネルIDを指定するか、チャンネルに関連付けられていない動画に"-1"を指定します。 |
| channelsFilterActivePlaylist | (int) 0|1 | "channelsFilter"により指定したチャンネルのアクティブなプレイリストにのみ含まれる動画を一覧表示します。 |
| channelsFilterPlaylist | (int) playlist ID | "channelsFilterActivePlaylist"の代わりに指定されたプレイリストに含まれる動画を一覧表示します。 |
| allowRepeated | (int) 0|1 | プレイリストには繰り返し動画を含めることができるので、このオプションを使用してこれを許可するかどうかを制御します。 |
| カテゴリーフィルター | ||
| 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"の値に関係なく、動画はリストから除外されません。 |
| カスタムフィルター(詳細) | ||
| filterName | (mixed) filter value | 各カスタムフィルタはPOST変数として渡す必要があります。 |
| 高評価/低評価、お気に入り、履歴フィルター(一回につきに1つのみ使用) | ||
| idUserLikedFilter | (int) User ID | 指定したユーザーが「高評価」をクリックした動画を一覧表示します。 |
| idUserDislikedFilter | (int) User ID | 指定したユーザーが「低評価」をクリックした動画を一覧表示します。 |
| idUserFavoritedFilter | (int) User ID | 指定したユーザーが「お気に入り」に追加した動画を一覧表示します。 |
| idUserWatchedFilter | (int) User ID | 指定されたユーザーによって視聴された動画を一覧表示します。 |
| その他のフィルター | ||
| searchableFilter | (int) 0/1 | "searchable"プロパティが値と一致する動画を一覧表示します。 |
| indexableFilter | (int) 0/1 | "indexable"プロパティが値と一致する動画を一覧表示します。 |
| visitableFilter | (int) 0/1 | "visitable"プロパティが値と一致する動画を一覧表示します。 |
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・list_total_found:(ページングの目的で)基準に一致した、見つかったアイテムの合計数。
・list_total:返されたリストの項目数。これは通常"limit"もしくは"resultsPerPageFilter"の値と一致します。
・list:アイテムリスト
{
"list_total_found": "157",
"list_total": 5,
"list": [{
"id": "586",
"title": "My Clip",
"type": "1",
"type_name": "streamclip_vod",
"user_alias": "InterStream"
}, {
"id": "585",
"title": "My Live Video",
"type": "0",
"type_name": "streamclip_live",
"user_alias": "InterStream"
}]
}
認証情報にGETの許可がない場合など、リクエストが失敗した場合のレスポンス
{
"error" : "REQUEST_ERROR",
"error_long" : "Permission error: GET"
}
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | No Clips were found
動画が見つかりません。
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数
$GET_VARS = array(
"go" => "clips",
"do" => "list"
);
// POST変数
$POST_VARS = array(
"fields" => "id,title", // IDとタイトルのみを含める
"paging" => 1, // ページングを許可
"resultsPerPageFilter" => 5, // 1ページにつき5件の結果を返す
"current_page" => 1, // ページ1に戻る
"statusFilter" => "any", // ステータス制限なし
"sortByFilter" => "date", // 日付の新しい順にソート
"generateEmbedCode" => 1, // 各動画の埋め込みコードを生成する
"embedWidth" => 400, // 埋め込みコードを幅400pxに設定
"embedHeight" => 225, // 埋め込みコードを高さ225pxに設定
"embedURLVars" => "&autoplay=1" // 埋め込みコードに動画プレーヤーの変数を含める
);
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));
}