Method: projects.apps.releases.list

リリースを一覧表示します。デフォルトでは、createTime の降順で並べ替えられます。

HTTP リクエスト

GET https://firebaseappdistribution.googleapis.com/v1/{parent=projects/*/apps/*}/releases

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

パスパラメータ

パラメータ
parent

string

必須。リリース リソースの親であるアプリリソースの名前。

形式: projects/{projectNumber}/apps/{appId}

承認には、指定されたリソース parent を所有する Firebase プロジェクトに対する次の IAM 権限が必要です。

  • firebaseappdistro.releases.list

クエリ パラメータ

パラメータ
pageSize

integer

返されるリリースの最大数。サービスが返す値はこれよりも少ないことがあります。有効な範囲は [1 ~ 100] です。指定されていない場合(0)、最大で 25 個のリリースが返されます。100 を超える値は 100 に強制変換されます。

pageToken

string

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

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

orderBy

string

リリースを注文するために使用されるフィールド。

サポートされているフィールド:

  • createTime

フィールドの降順を指定するには、降順に「desc」を追加します接尾辞を付けます(例: createTime desc)。

このパラメータが設定されていない場合、リリースは createTime の降順で並べ替えられます。

filter

string

レスポンスにリストされているリリースをフィルタする式。フィルタリングについて詳しくは、Google の AIP-160 規格をご覧ください。

サポートされているフィールド:

  • releaseNotes.text= をサポートします(文字列の先頭または末尾にワイルドカード文字(*)を含めることができます)。
  • createTime<<=>>= をサポートしており、RFC-3339 形式の文字列を想定しています

例:

  • createTime <= "2021-09-08T00:00:00+04:00"
  • releaseNotes.text="fixes" AND createTime >= "2021-09-08T00:00:00.0Z"
  • releaseNotes.text="*v1.0.0-rc*"

リクエストの本文

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

レスポンスの本文

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

releases.list に対するレスポンス メッセージ。

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

object (Release)

リリース

nextPageToken

string

有効期間の短いトークン。次のページを取得するために pageToken として送信できます。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

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

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

詳しくは、OAuth 2.0 の概要をご覧ください。