メソッド: admin.projects.locations.topics.subscriptions.list

指定したトピックに関連付けられているサブスクリプションを列挙します。

HTTP リクエスト

GET https://{endpoint}/v1/admin/{name=projects/*/locations/*/topics/*}/subscriptions

ここで、{endpoint}サポートされているサービス エンドポイントのいずれかです。

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。サブスクリプションを列挙するトピックの名前。

クエリ パラメータ

パラメータ
pageSize

integer

返されるサブスクリプションの最大件数。サービスはこの値より少ない値を返すことがあります。未設定またはゼロの場合、指定したトピックのすべてのサブスクリプションが返されます。

pageToken

string

前回の subscriptions.list 呼び出しから受け取ったページトークン。これを指定して、後続のページを取得します。

ページ分割を行う場合、subscriptions.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

サブスクリプションリストに対するレスポンス。

JSON 表現

{
  "subscriptions": [
    string
  ],
  "nextPageToken": string
}
項目
subscriptions[]

string

トピックに関連付けられているサブスクリプションの名前。サブスクリプションの順序は指定されていません。

nextPageToken

string

結果の次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、それ以上結果は取得されません。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。