playlist リソースは YouTube の再生リストを表します。再生リストとは、順序を付けて表示し、他のユーザーと共有できる動画のコレクションを指します。デフォルトでは再生リストは他のユーザーに一般公開されますが、一般公開または非公開にすることができます。
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 |
stringAPI リソースのタイプを識別します。値は youtube#playlist になります。 |
etag |
etagこのリソースの Etag。 |
id |
stringYouTube がプレイリストを一意に識別するために使用する ID。 |
snippet |
objectsnippet オブジェクトには、再生リストのタイトルや説明などの基本情報が含まれます。 |
snippet.publishedAt |
datetimeプレイリストが作成された日時。値は ISO 8601 形式で指定します。 |
snippet.channelId |
stringYouTube がプレイリストを公開したチャンネルを一意に識別するために使用する 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このプロパティは非推奨になりました。 プレイリストに関連付けられたキーワード タグ。 |
snippet.defaultLanguage |
stringplaylist リソースの snippet.title プロパティと snippet.description プロパティのテキストの言語。 |
snippet.localized |
objectsnippet.localized オブジェクトには、再生リストのローカライズされたタイトルと説明、または再生リストのメタデータのデフォルトの言語のタイトルが含まれます。
localizations オブジェクトを使用して、ローカライズされたタイトルを追加、更新、削除します。 |
snippet.localized.title |
stringローカライズされた再生リストのタイトル。 |
snippet.localized.description |
stringローカライズされた再生リストの説明。 |
status |
objectstatus オブジェクトには、再生リストのステータス情報が含まれます。 |
status.privacyStatus |
string再生リストのプライバシー ステータス。 このプロパティの有効な値は次のとおりです。
|
status.podcastStatus |
string再生リストのポッドキャスト ステータス。値が enabled の場合、再生リストはポッドキャスト番組としてマークされます。再生リストのポッドキャスト ステータスを enabled に設定するには、再生リストに再生リストの画像が必要です。このプロパティの有効な値は次のとおりです。
|
contentDetails |
objectcontentDetails オブジェクトには、再生リスト内の動画数など、再生リストのコンテンツに関する情報が含まれます。 |
contentDetails.itemCount |
unsigned integer再生リスト内の動画の数。 |
player |
objectplayer オブジェクトには、埋め込みプレーヤーで再生リストを再生するために使用する情報が含まれています。 |
player.embedHtml |
string再生リストを再生するプレーヤーを埋め込む <iframe> タグ。 |
localizations |
objectlocalizations オブジェクトは、再生リストのメタデータの翻訳をカプセル化します。 |
localizations.(key) |
objectキー値に関連付けられたローカライズ テキストの言語。値は BCP-47 言語コードを含む文字列です。 |
localizations.(key).title |
stringローカライズされた再生リストのタイトル。 |
localizations.(key).description |
stringローカライズされた再生リストの説明。 |