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 パラメータは、 1 つ以上の playlistImage リソースのカンマ区切りリスト API レスポンスに含まれるプロパティを指定します。

パラメータに は、子プロパティを含むプロパティを識別します。 含まれるようになります。

フィルタ(次のパラメータのいずれか 1 つのみを指定)
id string
id パラメータには、一意の再生リスト画像 ID を 1 つ以上指定し、カンマ区切りのリストを指定します。
playlistId string
playlistId パラメータは、再生リストの画像を取得する再生リストの一意の ID を指定します。これは省略可能なパラメータですが、再生リストの画像を取得するリクエストでは、必ず id パラメータまたは playlistId パラメータの値を指定する必要があります。
オプション パラメータ
maxResults unsigned integer
maxResults パラメータは、結果セットで返される画像の最大数を指定します。有効な値は 050 です。デフォルト値は 5 です。
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは YouTube コンテンツ パートナー専用です。

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

onBehalfOfContentOwnerChannel パラメータ 動画が送信されるチャンネルの YouTube チャンネル ID を指定します。 追加されました。このパラメータは、リクエストで値が onBehalfOfContentOwner パラメータです。このパラメータは、 そのパラメータを指定しますまた、リクエストは コンテンツの権利を所有しているコンテンツ所有者にリンクされた CMS アカウントを使用して、 onBehalfOfContentOwner パラメータで指定します。最後に、 onBehalfOfContentOwnerChannel パラメータ値が は、 onBehalfOfContentOwner パラメータを指定します。

これは、 このパラメータは、数多く所有、管理する YouTube コンテンツ パートナー向けです。 おすすめしますコンテンツ所有者は一度認証されると パラメータで指定されたチャンネルに代わってアクションを実行します。 認証情報を提供する必要はありません。 できます。
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
リクエスト条件に一致する再生リスト画像のリスト。