Playlists: list

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

割り当てへの影響: このメソッドを呼び出すと、割り当てコストは 1 単位になります。

一般的なユースケース

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/youtube/v3/playlists

パラメータ

次の表に、このクエリがサポートするパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
part string
part パラメータでは、API レスポンスに含める 1 つ以上の playlist リソース プロパティのカンマ区切りリストを指定します。

このパラメータで子プロパティを含むプロパティを指定すると、その子プロパティがレスポンスに含まれます。たとえば、playlist リソースでは、snippet プロパティに author、title、description、timeCreated などのプロパティが含まれます。そのため、part=snippet を設定すると、API レスポンスにはこれらのプロパティがすべて含まれます。

次のリストには、パラメータ値に含めることができる part 名が含まれます。
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
フィルタ（次のパラメータのいずれか 1 つのみを指定）
channelId string
この値は、API が指定したチャンネルの再生リストのみを返すことを示します。
id string
id パラメータでは、取得するリソースの YouTube 再生リスト ID をカンマ区切りのリストで指定します。playlist リソースでは、id プロパティに再生リストの YouTube 再生リスト ID を指定します。
mine boolean
このパラメータは、適切に承認されたリクエストでのみ使用できます。このパラメータの値を true に設定すると、認証されたユーザーが所有する再生リストのみを返すように API に指示できます。
オプション パラメータ
hl string
hl パラメータは、YouTube ウェブサイトがサポートするアプリケーション言語のローカライズされたリソース メタデータを取得するように API に指示します。パラメータ値は、i18nLanguages.list メソッドによって返されるリストに含まれる言語コードである必要があります。

ローカライズされたリソースの詳細がその言語で取得できる場合、リソースの snippet.localized オブジェクトにはローカライズされた値が含まれます。ただし、ローカライズされた詳細を利用できない場合、snippet.localized オブジェクトには、リソースのデフォルトの言語によるリソースの詳細が含まれます。
maxResults unsigned integer
maxResults パラメータでは、結果セットで返される商品アイテムの最大数を指定します。有効な値は 0～50（指定した値を含む）です。デフォルト値は 5 です。
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは、YouTube コンテンツ パートナー専用です。

onBehalfOfContentOwner パラメータは、パラメータ値で指定されたコンテンツ所有者に代わって行動する YouTube CMS ユーザーを識別するリクエストの認証情報です。このパラメータは、複数の YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象にしています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザー認証に使用する CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。
onBehalfOfContentOwnerChannel string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは、YouTube コンテンツ パートナー専用です。

onBehalfOfContentOwnerChannel パラメータは、動画を追加するチャンネルの YouTube チャンネル ID を指定します。このパラメータは、リクエストで onBehalfOfContentOwner パラメータの値を指定するときに必要です。このパラメータとの組み合わせでのみ使用できます。また、このリクエストは onBehalfOfContentOwner パラメータで指定されたコンテンツ所有者にリンクされている CMS アカウントを使用して承認される必要があります。最後に、onBehalfOfContentOwnerChannel パラメータの値で指定するチャンネルは、onBehalfOfContentOwner で指定するコンテンツ所有者にリンクする必要があります。

このパラメータは、さまざまな YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象としています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、パラメータ値で指定されたチャンネルの代わりにアクションを実行できるようになります。チャンネルごとに認証情報を指定する必要はありません。
pageToken string
pageToken パラメータは、返す必要がある結果セット内の特定のページを識別します。API レスポンスでは、nextPageToken プロパティと prevPageToken プロパティを使用して他のページを取得できます。

リクエスト本文

このメソッドを呼び出す場合は、リクエストの本文を指定しないでください。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "kind": "youtube#playlistListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    playlist Resource
  ]
}

プロパティ

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

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#playlistListResponse です。
etag etag
このリソースの Etag。
nextPageToken string
結果セットの次のページを取得するために pageToken パラメータの値として使用できるトークン。
prevPageToken string
結果セットの前のページを取得するために、pageToken パラメータの値として使用できるトークン。
pageInfo object
pageInfo オブジェクトは、結果セットのページ情報をカプセル化します。
pageInfo.totalResults integer
結果セット内の結果の合計数。
pageInfo.resultsPerPage integer
API レスポンスに含まれる結果の数。
items[] list
リクエスト条件に一致する再生リストのリスト。

エラー

次の表に、このメソッドの呼び出しに応じて API から返される可能性のあるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。

エラーのタイプ エラーの詳細 説明
forbidden (403) channelClosed channelId パラメータで指定されたチャンネルが閉じられています。
forbidden (403) channelSuspended channelId パラメータで指定されたチャンネルが一時停止されました。
forbidden (403) playlistForbidden リクエストの id パラメータで特定された再生リストがリクエストをサポートしていないか、リクエストが適切に承認されていません。
notFound (404) channelNotFound channelId パラメータで指定されたチャンネルが見つかりません。
notFound (404) playlistNotFound リクエストの id パラメータで識別されるプレイリストが見つかりません。
invalidValue (400) playlistOperationUnsupported API は、指定したプレイリストを一覧表示する機能をサポートしていません。たとえば、[後で見る] 再生リストの一覧は表示できません。

実習

APIs Explorer を使用してこの API を呼び出し、API のリクエストとレスポンスを確認します。