PlaylistItems

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

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

Methods

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

list

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

insert

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

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 有効なキー値は次のとおりです。 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、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 メソッドを使用してこの値を設定できます。