playlist
リソースは YouTube の再生リストを表します。再生リストとは、順序を付けて表示し、他のユーザーと共有できる動画のコレクションを指します。再生リストには最大 200 本の動画を登録できます。また、各ユーザーが作成する再生リストの数に制限はありません。デフォルトでは再生リストは他のユーザーに一般公開されますが、一般公開または非公開にすることができます。
また YouTube では再生リストを使って、次に示すようなチャンネルの動画の特殊なコレクションを識別します。
- アップロード動画
- お気に入りの動画
- 高く評価された動画
- 再生履歴
- 後で見る
channel resource
から取得できます。ID の取得後は、
playlistItems.list
メソッドを使って対応するリストを取得できます。playlistItems.insert
メソッドや playlistItems.delete
メソッドを呼び出すことで、これらのリストにアイテムを追加したり、削除したりできます。
メソッド
この API では、playlists
リソースについて以下のメソッドがサポートされています。
リソース表現
下記の JSON の構造体は、playlists
リソースの形式を示したものです。
{ "kind": "youtube#playlist", "etag": etag, "id": string, "snippet": { "publishedAt": datetime, "channelId": string, "title": string, "description": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "channelTitle": string, "tags": [ string ] }, "status": { "privacyStatus": string }, "contentDetails": { "itemCount": unsigned integer }, "player": { "embedHtml": string } }
プロパティ
次の表は、このリソースで使用されているプロパティの定義を示したものです。
プロパティ | |
---|---|
kind |
string API リソースのタイプ。値は youtube#playlist です。 |
etag |
etag このリソースの Etag。 |
id |
string 再生リストを一意に識別するために YouTube によって使用される値。 |
snippet |
object snippet オブジェクトには、再生リストに関する基本情報(タイトル、説明など)が格納されます。 |
snippet.publishedAt |
datetime 再生リストの作成日時。値は ISO 8601( YYYY-MM-DDThh:mm:ss.sZ )形式で指定します。 |
snippet.channelId |
string 再生リストを発行したチャンネルを一意に識別するために YouTube により使用される ID。 |
snippet.title |
string 再生リストのタイトル。 |
snippet.description |
string 再生リストの説明。 |
snippet.thumbnails |
object 再生リストと関連付けられているサムネイル画像のマップ。マップ内の各オブジェクトでは、キーはサムネイル画像の名前で、値はサムネイルに関するその他の情報を含むオブジェクトになります。 |
snippet.thumbnails.(key) |
object 有効なキー値は次のとおりです:
|
snippet.thumbnails.(key).url |
string 画像の URL。 |
snippet.thumbnails.(key).width |
unsigned integer 画像の幅。 |
snippet.thumbnails.(key).height |
unsigned integer 画像の高さ。 |
snippet.channelTitle |
string 動画が属するチャンネルのチャンネル タイトル。 |
snippet.tags[] |
list 再生リストに関連付けられているキーワード タグ。 |
status |
object status オブジェクトには再生リストのステータス情報が格納されます。 |
status.privacyStatus |
string 再生リストのプライバシー ステータス。 このプロパティの有効値は次のとおりです:
|
contentDetails |
object contentDetails オブジェクトには、再生リスト内の動画数など、再生リストのコンテンツに関する情報が格納されます。 |
contentDetails.itemCount |
unsigned integer 再生リスト内の動画数。 |
player |
object player オブジェクトには、埋め込みプレーヤーで動画の再生に使用される情報が格納されます。 |
player.embedHtml |
string 動画を再生するプレーヤーを埋め込むための <iframe> タグ。 |