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
このパラメータは、適切に承認されたリクエストでのみ使用できます。認証されたユーザーが所有する再生リストのみを返すように API に指示するには、このパラメータの値を true に設定します。
オプション パラメータ
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 のリクエストとレスポンスを確認します。