Playlists

playlist リソースは YouTube の再生リストを表します。再生リストとは、順序を付けて表示し、他のユーザーと共有できる動画のコレクションを指します。デフォルトでは再生リストは他のユーザーに一般公開されますが、一般公開または非公開にすることができます。

また、YouTube は再生リストを使用して、チャンネルの動画の特別なコレクションも識別します。以下に例を示します。

• アップロード動画
• 高く評価された動画

具体的には、これらのリストはチャンネルと関連付けられています。チャンネルとは、個人、グループ、会社の動画、再生リスト、その他の YouTube 情報をまとめたものです。これらの各リストの再生リスト ID は、特定のチャンネルの channel resource から取得できます。

その後、playlistItems.list メソッドを使用して、これらのリストを取得できます。playlistItems.insert メソッドと playlistItems.delete メソッドを呼び出して、これらのリストにアイテムを追加したり、リストからアイテムを削除したりすることもできます。

Methods

API は、playlists リソースに対して次のメソッドをサポートしています。

list

API リクエストのパラメータに一致する再生リストのコレクションを返します。たとえば、認証されたユーザーが所有するすべての再生リストを取得することも、一意の ID で 1 つ以上の再生リストを取得することもできます。 今すぐ試す

insert

再生リストを作成します。今すぐ試す

update

再生リストを変更します。たとえば、再生リストのタイトル、説明、プライバシー ステータスを変更できます。 今すぐ試す

delete

再生リストを削除します。 今すぐ試す

リソース表現

次の 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
  },
  "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 有効なキー値は次のとおりです。 default – デフォルトのサムネイル画像。動画（または、再生リストのアイテムや検索結果など、動画を参照するリソース）のデフォルト サムネイルは幅 120px、高さ 90px です。チャンネルのデフォルト サムネイルは幅 88px、高さ 88px です。 medium – 高解像度バージョンのサムネイル画像。動画（または動画を参照するリソース）の場合、この画像は幅 320px、高さ 180px です。チャンネルの場合は、幅 240px、高さ 240px です。 high – サムネイル画像の高解像度バージョン。動画（または動画を参照するリソース）の場合、この画像は幅 480px、高さ 360px です。チャンネルの場合、幅 800px、高さ 800px です。 standard – high 解像度の画像よりも高解像度のサムネイル画像。この画像は、一部の動画や、動画を参照するその他のリソース（再生リストのアイテムや検索結果など）で使用できます。この画像は幅 640 ピクセル、高さ 480 ピクセルです。 maxres – サムネイル画像の最高解像度バージョン。この画像サイズは、一部の動画のほか、再生リストのアイテムや検索結果など、動画を参照するその他のリソースで使用できます。この画像は幅 1,280 ピクセル、高さ 720 ピクセルです。
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 オブジェクトには、再生リストのローカライズされたタイトルと説明、または再生リストのメタデータのデフォルトの言語でのタイトルが含まれます。 ローカライズされたテキストを返す言語を playlists.list リクエストで hl パラメータを使用して指定し、かつその言語でローカライズされたテキストを使用できる場合、ローカライズされたテキストはリソース スニペットで返されます。 hl パラメータ値が指定されていないか、値が指定されているが、指定された言語にローカライズされたメタデータがない場合は、デフォルト言語のメタデータが返されます。 このプロパティには読み取り専用の値が含まれます。ローカライズされたタイトルを追加、更新、削除するには、localizations オブジェクトを使用します。
snippet.localized.title	string ローカライズされた再生リストのタイトル。
snippet.localized.description	string ローカライズされた再生リストの説明。
status	object status オブジェクトには再生リストのステータス情報が格納されます。
status.privacyStatus	string 再生リストのプライバシー ステータス。 このプロパティの有効な値は次のとおりです。 private public unlisted
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 ローカライズされた再生リストの説明。