PlaylistItems

playlistItem リソースは、再生リストに含まれる動画などの別のリソースを識別します。また、playlistItem リソースには、含まれるリソースがその再生リストでどのように使用されるかに関するリソースの詳細が含まれます。

また、YouTube は再生リストを使用して、チャンネルのアップロードした動画のリストを指定します。リスト内の各 playlistItem は 1 つのアップロード動画を表します。このリストの再生リスト ID は、特定のチャンネルの channel resource から取得できます。その後、playlistItems.list メソッドを使用してリストを作成できます。

Methods

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

list

API リクエスト パラメータに一致するプレイリスト アイテムのコレクションを返します。指定した再生リスト内の再生リストのすべてのアイテムを取得したり、一意の ID で 1 つ以上の再生リスト アイテムを取得したりできます。 今すぐ試す

挿入

リソースを再生リストに追加します。今すぐ試す

update

プレイリスト アイテムを変更します。たとえば、プレイリスト内のアイテムの位置を更新できます。今すぐ試す

delete

プレイリスト アイテムを削除します。 今すぐ試す

リソース表現

次の JSON 構造は、playlistItems リソースの形式を示しています。

{
  "kind": "youtube#playlistItem",
  "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,
    "videoOwnerChannelTitle": string,
    "videoOwnerChannelId": string,
    "playlistId": string,
    "position": unsigned integer,
    "resourceId": {
      "kind": string,
      "videoId": string,
    }
  },
  "contentDetails": {
    "videoId": string,
    "startAt": string,
    "endAt": string,
    "note": string,
    "videoPublishedAt": datetime
  },
  "status": {
    "privacyStatus": string
  }
}

プロパティ

次の表は、このリソースで使用されているプロパティの定義を示したものです。

プロパティ
kind	string API リソースのタイプを識別します。値は youtube#playlistItem です。
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 は次のとおりです。 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.videoOwnerChannelTitle	string この動画をアップロードしたチャンネルのタイトル。
snippet.videoOwnerChannelId	string この動画をアップロードしたチャンネルのチャンネル ID。
snippet.playlistId	string 再生リスト アイテムが含まれる再生リストを一意に識別するために YouTube によって使用される ID。
snippet.position	unsigned integer 再生リストでのアイテムの表示順序。この値は 0 から始まるインデックスを使用しているため、最初のアイテムの位置は 0、2 番目のアイテムの位置は 1 のようになります。
snippet.resourceId	object id オブジェクトには、プレイリスト アイテムとしてプレイリストに含まれるリソースを一意に識別するために使用できる情報が含まれています。
snippet.resourceId.kind	string 参照されるリソースの種類（タイプ）。
snippet.resourceId.videoId	string snippet.resourceId.kind プロパティの値が youtube#video の場合は、このプロパティが存在し、その値には、再生リスト内の動画を一意に識別するために YouTube によって使用される ID が含まれます。
contentDetails	object 含まれるアイテムが YouTube 動画の場合、contentDetails オブジェクトはリソースに含まれます。このオブジェクトには、動画に関するその他の情報が格納されます。
contentDetails.videoId	string YouTube が動画を一意に識別するために使用する ID。video リソースを取得するには、API リクエストで id クエリ パラメータをこの値に設定します。
contentDetails.startAt	string 注: このプロパティはサポートが終了しており、値は無視されます。 動画の再生開始時点からの秒数です。（再生リストを使って動画が再生されている場合は、再生リストの所有者が開始位置と停止位置を指定できます）。デフォルト値は 0 です。
contentDetails.endAt	string 注: このプロパティはサポートが終了しました。設定されている場合、値は無視されます。 動画の再生開始時点からの秒数です。（再生リストを使って動画が再生されている場合は、再生リストの所有者が開始位置と停止位置を指定できます）。デフォルトでは、video.endTime が動画の最後だとします。
contentDetails.note	string このアイテムに関するユーザー作成のメモ。プロパティ値の最大長は 280 文字です。
contentDetails.videoPublishedAt	datetime 動画が YouTube に公開された日時。値は ISO 8601 形式で指定します。
status	object status オブジェクトには、プレイリスト アイテムのプライバシー ステータスに関する情報が格納されます。
status.privacyStatus	string 再生リスト アイテムのプライバシー ステータス。再生リストのアイテムが表す動画をアップロードしたチャンネルは、videos.insert メソッドまたは videos.update メソッドを使用してこの値を設定できます。