Subscriptions: list

API リクエスト条件に一致する登録チャンネルのリソースを返します。

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

一般的なユースケース

リクエスト

HTTP リクエスト

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

パラメータ

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

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

このパラメータで子プロパティを含むプロパティを指定すると、その子プロパティがレスポンスに含まれます。たとえば、subscription リソースでは、snippet プロパティに、サブスクリプションの表示タイトルなど、他のプロパティが含まれています。part=snippet を設定すると、API レスポンスには、そのネストされたプロパティがすべて含まれます。

次のリストには、パラメータ値に指定できる part 名が含まれています。
  • contentDetails
  • id
  • snippet
  • subscriberSnippet
フィルタ（次のパラメータのいずれか 1 つのみを指定）
channelId string
channelId パラメータでは YouTube チャンネル ID を指定します。API は、そのチャンネルの登録のみを返します。
id string
id パラメータでは、取得するリソースの YouTube 定期購入 ID のカンマ区切りのリストを指定します。subscription リソースで、id プロパティに YouTube 定期購入 ID を指定します。
mine boolean
このパラメータは、適切に承認されたリクエストでのみ使用できます。このパラメータの値を true に設定すると、認証済みユーザーの登録チャンネルのフィードを取得できます。
myRecentSubscribers boolean
このパラメータは、適切に承認されたリクエストでのみ使用できます。このパラメータを true に設定すると、認証済みユーザーの購読者のフィードが新しい順（新しい順）に取得されます。

この API で返される購読者の最大数は制限される場合があります。
mySubscribers boolean
このパラメータは、適切に承認されたリクエストでのみ使用できます。このパラメータの値を true に設定すると、認証済みユーザーのサブスクライバーのフィードが特定の順序で取得されます。この API から返されるサブスクライバーの最大数は制限される可能性があります。
オプション パラメータ
forChannelId string
forChannelId パラメータでは、チャンネル ID をカンマ区切りのリストで指定します。API レスポンスには、これらのチャンネルに一致する登録チャンネルのみ含まれます。
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 コンテンツ パートナーを対象としています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、パラメータ値で指定されたチャンネルの代わりにアクションを実行できるようになります。チャンネルごとに認証情報を指定する必要はありません。
order string
order パラメータでは、API レスポンス内のリソースの並べ替えに使用するメソッドを指定します。デフォルト値は SUBSCRIPTION_ORDER_RELEVANCE です。

有効な値は次のとおりです。
  • alphabetical - アルファベット順に並べ替えます。
  • relevance - 関連度順。
  • unread - アクティビティ順に並べ替えます。
pageToken string
pageToken パラメータは、返す必要がある結果セット内の特定のページを識別します。API レスポンスでは、nextPageToken プロパティと prevPageToken プロパティを使用して他のページを取得できます。

リクエスト本文

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

レスポンス

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

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

プロパティ

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

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

エラー

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

エラーのタイプ エラーの詳細 説明
forbidden (403) accountClosed チャンネル登録者のアカウントが閉じられているため、チャンネル登録を取得できませんでした。
forbidden (403) accountSuspended チャンネル登録者のアカウントが一時停止されているため、チャンネル登録を取得できませんでした。
forbidden (403) subscriptionForbidden リクエスト送信者は、リクエストしたチャンネル登録へのアクセスを許可されていません。
notFound (404) subscriberNotFound リクエストで特定されているチャンネル登録者が見つかりません。

実習

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