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