PlaylistImages: list

API リクエスト パラメータに一致するプレイリスト画像のコレクションを返します。指定したプレイリストのプレイリスト画像を取得したり、一意の ID で 1 つ以上のプレイリスト画像を取得したりできます。

割り当てへの影響: このメソッドの呼び出しには、1 ユニットの割り当て費用が発生します。

リクエスト

HTTP リクエスト

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

承認

このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です（認証と承認の詳細をご確認ください）。

スコープ
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

パラメータ

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

パラメータ
必須パラメータ
part string

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

パラメータで子プロパティを含むプロパティが指定されている場合、子プロパティがレスポンスに含まれます。
フィルタ （次のパラメータのいずれか 1 つを正確に指定）
id string
id パラメータには、1 つ以上のユニークなプレイリスト画像 ID のカンマ区切りリストを指定します。
playlistId string
playlistId パラメータは、再生リストの画像を取得する再生リストの一意の ID を指定します。これは省略可能なパラメータですが、プレイリストの画像を取得するリクエストでは、id パラメータまたは playlistId パラメータのいずれかの値を指定する必要があります。
オプション パラメータ
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 パラメータと組み合わせてのみ使用できます。また、onBehalfOfContentOwner パラメータで指定されたコンテンツ所有者にリンクされている CMS アカウントを使用して、リクエストを承認する必要があります。最後に、onBehalfOfContentOwnerChannel パラメータ値で指定されたチャンネルは、onBehalfOfContentOwner パラメータで指定されたコンテンツ所有者にリンクされている必要があります。

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

リクエストの本文

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

Response

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

{
          "kind": "youtube#playlistImageListResponse",
          "nextPageToken": string,
          "prevPageToken": string,
          "pageInfo": {
            "totalResults": integer,
            "resultsPerPage": integer
          },
          "items": [
            playlistImages Resource
          ]
        }

プロパティ

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

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