Subscriptions: list

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

リクエスト

HTTP リクエスト

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

パラメータ

下記の表は、このクエリでサポートされているパラメータの一覧です。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
part string
part パラメータには、API レスポンスに含める 1 つまたは複数の subscription リソース プロパティをカンマ区切りリストの形式で指定します。このパラメータ値として指定できる part 名は、idsnippetcontentDetails です。

このパラメータに子プロパティを持つプロパティが指定されている場合、その子プロパティもレスポンスに含まれます。たとえば、subscription リソースの snippet プロパティに、登録チャンネルの表示タイトルなど、他のプロパティが含まれているとします。この場合、part=snippet と設定すると、API レスポンスには、ネストされているプロパティもすべて含まれることになります。
フィルタ(以下のパラメータのいずれか 1 つのみを指定します)
channelId string
channelId パラメータには YouTube チャンネル ID を指定します。API は登録チャンネルのみを返します。
id string
id パラメータには、取得するリソースの YouTube 登録チャンネル ID をカンマ区切りリストの形式で指定します。subscription リソースの場合、id プロパティには YouTube 登録チャンネル ID を指定します。
mine boolean
このパラメータは、適切に承認されたリクエストでのみ使用できます。認証されたユーザーの購読チャンネルのフィードを取得するには、このパラメータの値を true に設定します。
mySubscribers boolean
このパラメータは、適切に承認されたリクエストでのみ使用できます。認証されたユーザーのチャンネル登録者のフィードを取得するには、このパラメータの値を true に設定します。
省略可能なパラメータ
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 レスポンスでは、nextPageTokenprevPageToken プロパティは取得可能な他のページを表します。

リクエストの本文

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

レスポンス

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

{
  "kind": "youtube#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    登録チャンネルのリソース
  ]
}

プロパティ

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

プロパティ
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 accountClosed チャンネル登録者のアカウントが閉じられているため、チャンネル登録を取得できませんでした。
forbidden accountSuspended チャンネル登録者のアカウントが一時停止されているため、チャンネル登録を取得できませんでした。
forbidden subscriptionForbidden リクエスト送信者は、リクエストしたチャンネル登録へのアクセスを許可されていません。
notFound subscriberNotFound リクエストで特定されているチャンネル登録者が見つかりません。

実際に試してみる

API Explorer を使用し、ライブ データに対してこのメソッドを呼び出して、API リクエストとレスポンスを確認してください。