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 プロパティは、取得できる他のページを識別します。

リクエストの本文

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

Response

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

{
  "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 リクエストとレスポンスを確認します。