Method: projects.rulesets.list

Ruleset メタデータのみを一覧表示し、必要に応じて Ruleset 名で結果をフィルタします。

Ruleset の Source コンテンツ全体は、rulesets.get で取得できます。

HTTP リクエスト

GET https://firebaserules.googleapis.com/v1/{name=projects/*}/rulesets

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

パスパラメータ

パラメータ
name

string

必須。プロジェクトのリソース名。

形式: projects/{project_id}

クエリ パラメータ

パラメータ
filter

string

Ruleset フィルタ。list メソッドは、Ruleset.name に制限のあるフィルタをサポートしています。

Ruleset.create_time のフィルタには、RFC 3339 の日付/時刻仕様に準拠する文字列を解析する date 関数を使用する必要があります。

例: createTime > date("2017-01-01T00:00:00Z") AND name=UUID-*
pageSize

integer

読み込むページサイズ。最大 100 個。デフォルトは 10 です。注: pageSize はヒントにすぎず、出力のサイズによっては、サービスで読み込まれる負荷が pageSize 未満になる場合があります。すべてのリリースを走査するには、呼び出し元は pageToken が空になるまで反復処理を行う必要があります。
pageToken

string

Ruleset インスタンスの次のバッチを読み込むための次のページトークン。

リクエストの本文

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

レスポンスの本文

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

FirebaseRulesService.ListRulesets に対するレスポンス。

JSON 表現 
{
  "rulesets": [
    {
      object (Ruleset)
    }
  ],
  "nextPageToken": string
}
フィールド
rulesets[]

object (Ruleset)

Ruleset インスタンスのリスト。
nextPageToken

string

結果の次のページを取得するためのページ設定トークン。値が空の場合、結果は残りません。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

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