playlist
リソースは YouTube の再生リストを表します。再生リストとは、順序を付けて表示し、他のユーザーと共有できる動画のコレクションを指します。デフォルトでは再生リストは他のユーザーに一般公開されますが、一般公開または非公開にすることができます。
また、再生リストはチャンネル内の動画の特別なコレクションを識別するために使用されています。
- アップロード動画
- 高く評価された動画
channel resource
から取得できます。次に、
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, "defaultLanguage": string, "localized": { "title": string, "description": string } }, "status": { "privacyStatus": string, "podcastStatus": enum }, "contentDetails": { "itemCount": unsigned integer }, "player": { "embedHtml": string }, "localizations": { (key): { "title": string, "description": string } } }
プロパティ
次の表は、このリソースで使用されているプロパティの定義を示したものです。
プロパティ | |
---|---|
kind |
string API リソースのタイプを指定します。値は youtube#playlist です。 |
etag |
etag このリソースの ETag。 |
id |
string 再生リストを一意に識別するために YouTube によって使用される ID。 |
snippet |
object snippet オブジェクトには、再生リストの基本的な情報(タイトル、説明など)が格納されます。 |
snippet.publishedAt |
datetime 再生リストが作成された日時。値は ISO 8601 形式で指定します。 |
snippet.channelId |
string 再生リストを公開したチャンネルを一意に識別するために YouTube によって使用される ID。 |
snippet.title |
string 再生リストのタイトル。 |
snippet.description |
string 再生リストの説明。 |
snippet.thumbnails |
object 再生リストに関連付けられたサムネイル画像のマップ。マップ内の各オブジェクトでは、キーはサムネイル画像の名前で、値はサムネイルに関するその他の情報を含むオブジェクトになります。 |
snippet.thumbnails.(key) |
object 有効な Key-Value は次のとおりです。
|
snippet.thumbnails.(key).url |
string 画像の URL。 |
snippet.thumbnails.(key).width |
unsigned integer 画像の幅。 |
snippet.thumbnails.(key).height |
unsigned integer 画像の高さ。 |
snippet.channelTitle |
string 動画が属するチャンネルのチャンネル タイトル。 |
snippet.tags[] |
list このプロパティのサポートは終了しました。 再生リストに関連付けられたキーワード タグ。 |
snippet.defaultLanguage |
string playlist リソースの snippet.title プロパティと snippet.description プロパティ内のテキストの言語。 |
snippet.localized |
object snippet.localized オブジェクトには、ローカライズされた再生リストのタイトルと説明、または再生リストのメタデータのデフォルトの言語のタイトルが含まれます。
localizations オブジェクトを使用します。 |
snippet.localized.title |
string ローカライズされた再生リストのタイトル。 |
snippet.localized.description |
string ローカライズされた再生リストの説明。 |
status |
object status オブジェクトには、再生リストのステータス情報が格納されます。 |
status.privacyStatus |
string 再生リストのプライバシー ステータス。 このプロパティで有効な値は次のとおりです。 <ph type="x-smartling-placeholder">
|
status.podcastStatus |
string 再生リストのポッドキャストのステータス。値が enabled の場合、再生リストはポッドキャスト番組としてマークされています。再生リストのポッドキャストのステータスを enabled に設定するには、再生リストに再生リストの画像が必要です。このプロパティの有効な値は次のとおりです。
|
contentDetails |
object contentDetails オブジェクトには、再生リスト内の動画数など、再生リストのコンテンツに関する情報が格納されます。 |
contentDetails.itemCount |
unsigned integer 再生リスト内の動画の数。 |
player |
object player オブジェクトには、埋め込みプレーヤーで再生リストを再生するために使用する情報が含まれています。 |
player.embedHtml |
string 再生リストを再生するプレーヤーを埋め込む <iframe> タグ。 |
localizations |
object localizations オブジェクトは、再生リストのメタデータの翻訳をカプセル化します。 |
localizations.(key) |
object Key-Value に関連付けられたローカライズされたテキストの言語。値は BCP-47 言語コードを含む文字列です。 |
localizations.(key).title |
string ローカライズされた再生リストのタイトル。 |
localizations.(key).description |
string ローカライズされた再生リストの説明。 |