印刷する

動画

clips > set_channel_inclusion

このAPI関数を使用すると、動画をチャンネルに含めたり、チャンネルから除外したりできます。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数値説明
goclipsAPIセクション
doset_channel_inclusionAPIアクション
iqClip ID動画ID

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

https://....../api.php?go=clips&do=set_channel_inclusion&iq={clip_id}&{required information}
POST変数

以下のPOST変数は必須です。

変数値説明
inclusion (string) include | exclude 動画をチャンネルに追加するか、もしくは除外するか
channel_ids (string) Channel IDs 1つ以上のチャンネルのID（カンマ区切り）。
注：動画はチャンネルのアクティブプレイリストに追加/除外されます。

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・ok：動画をチャンネルに追加/除外された場合

{
    "ok": "The operation was performed"
}

チャンネルに追加する際の値が無効な場合など、リクエストが失敗した場合のレスポンス

{
    "error": "REQUEST_ERROR",
    "error_long": "Invalid inclusion"
}

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

・REQUEST_ERROR | Invalid Clip ID
動画IDが無効です。

・CLIP_NOT_FOUND | It was not possible to find a Clip with the supplied ID
動画が見つかりません。

・REQUEST_ERROR | Invalid inclusion
"inclusion"値が"include"または"exclude"と等しくありません（またはデータがありません）。

・REQUEST_ERROR | Channel IDs: not provided or invalid
チャンネルIDを入力していないか、入力したIDが無効です。

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

PHPサンプルコード

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

// GET変数
$GET_VARS = array( 
					"go"        => "clips",
					"do"        => "set_channel_inclusion",
					"iq"        => 700
					);

// POST変数
$POST_VARS = array(
                    "inclusion"		=> "include",
                    "channel_ids"	=> "1,2,3"
                    );