Firebase App Distribution API . projects . apps . releases

batchDelete(parent, body=None, x__xgafv=None)

Deletes releases. A maximum of 100 releases can be deleted per request.

Args:
  parent: string, Required. The name of the app resource, which is the parent of the release resources. Format: `projects/{project_number}/apps/{app_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The request message for `BatchDeleteReleases`.
  "names": [ # Required. The names of the release resources to delete. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}` A maximum of 100 releases can be deleted per request.
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

close()

Close httplib2 connections.

distribute(name, body=None, x__xgafv=None)

Distributes a release to testers. This call does the following: 1. Creates testers for the specified emails, if none exist. 2. Adds the testers and groups to the release. 3. Sends new testers an invitation email. 4. Sends existing testers a new release email. The request will fail with a `INVALID_ARGUMENT` if it contains a group that doesn't exist.

Args:
  name: string, Required. The name of the release resource to distribute. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The request message for `DistributeRelease`.
  "groupAliases": [ # A list of group aliases (IDs) to be given access to this release. A combined maximum of 999 `testerEmails` and `groupAliases` can be specified in a single request.
    "A String",
  ],
  "testerEmails": [ # A list of tester email addresses to be given access to this release. A combined maximum of 999 `testerEmails` and `groupAliases` can be specified in a single request.
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for `DistributeRelease`.
}

get(name, x__xgafv=None)

Gets a release.

Args:
  name: string, Required. The name of the release resource to retrieve. Format: projects/{project_number}/apps/{app_id}/releases/{release_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A release of a Firebase app.
  "binaryDownloadUri": "A String", # Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file.
  "buildVersion": "A String", # Output only. Build version of the release. For an Android release, the build version is the `versionCode`. For an iOS release, the build version is the `CFBundleVersion`.
  "createTime": "A String", # Output only. The time the release was created.
  "displayVersion": "A String", # Output only. Display version of the release. For an Android release, the display version is the `versionName`. For an iOS release, the display version is the `CFBundleShortVersionString`.
  "firebaseConsoleUri": "A String", # Output only. A link to the Firebase console displaying a single release.
  "name": "A String", # The name of the release resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`
  "releaseNotes": { # Notes that belong to a release. # Notes of the release.
    "text": "A String", # The text of the release notes.
  },
  "testingUri": "A String", # Output only. A link to the release in the tester web clip or Android app that lets testers (which were granted access to the app) view release notes and install the app onto their devices.
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists releases. By default, sorts by `createTime` in descending order.

Args:
  parent: string, Required. The name of the app resource, which is the parent of the release resources. Format: `projects/{project_number}/apps/{app_id}` (required)
  filter: string, The expression to filter releases listed in the response. To learn more about filtering, refer to [Google's AIP-160 standard](http://aip.dev/160). Supported fields: - `releaseNotes.text` supports `=` (can contain a wildcard character (`*`) at the beginning or end of the string) - `createTime` supports `<`, `<=`, `>` and `>=`, and expects an RFC-3339 formatted string Examples: - `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*"`
  orderBy: string, The fields used to order releases. Supported fields: - `createTime` To specify descending order for a field, append a "desc" suffix, for example, `createTime desc`. If this parameter is not set, releases are ordered by `createTime` in descending order.
  pageSize: integer, The maximum number of releases to return. The service may return fewer than this value. The valid range is [1-100]; If unspecified (0), at most 25 releases are returned. Values above 100 are coerced to 100.
  pageToken: string, A page token, received from a previous `ListReleases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleases` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for `ListReleases`.
  "nextPageToken": "A String", # A short-lived token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "releases": [ # The releases
    { # A release of a Firebase app.
      "binaryDownloadUri": "A String", # Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file.
      "buildVersion": "A String", # Output only. Build version of the release. For an Android release, the build version is the `versionCode`. For an iOS release, the build version is the `CFBundleVersion`.
      "createTime": "A String", # Output only. The time the release was created.
      "displayVersion": "A String", # Output only. Display version of the release. For an Android release, the display version is the `versionName`. For an iOS release, the display version is the `CFBundleShortVersionString`.
      "firebaseConsoleUri": "A String", # Output only. A link to the Firebase console displaying a single release.
      "name": "A String", # The name of the release resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`
      "releaseNotes": { # Notes that belong to a release. # Notes of the release.
        "text": "A String", # The text of the release notes.
      },
      "testingUri": "A String", # Output only. A link to the release in the tester web clip or Android app that lets testers (which were granted access to the app) view release notes and install the app onto their devices.
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a release.

Args:
  name: string, The name of the release resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A release of a Firebase app.
  "binaryDownloadUri": "A String", # Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file.
  "buildVersion": "A String", # Output only. Build version of the release. For an Android release, the build version is the `versionCode`. For an iOS release, the build version is the `CFBundleVersion`.
  "createTime": "A String", # Output only. The time the release was created.
  "displayVersion": "A String", # Output only. Display version of the release. For an Android release, the display version is the `versionName`. For an iOS release, the display version is the `CFBundleShortVersionString`.
  "firebaseConsoleUri": "A String", # Output only. A link to the Firebase console displaying a single release.
  "name": "A String", # The name of the release resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`
  "releaseNotes": { # Notes that belong to a release. # Notes of the release.
    "text": "A String", # The text of the release notes.
  },
  "testingUri": "A String", # Output only. A link to the release in the tester web clip or Android app that lets testers (which were granted access to the app) view release notes and install the app onto their devices.
}

  updateMask: string, The list of fields to update.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A release of a Firebase app.
  "binaryDownloadUri": "A String", # Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file.
  "buildVersion": "A String", # Output only. Build version of the release. For an Android release, the build version is the `versionCode`. For an iOS release, the build version is the `CFBundleVersion`.
  "createTime": "A String", # Output only. The time the release was created.
  "displayVersion": "A String", # Output only. Display version of the release. For an Android release, the display version is the `versionName`. For an iOS release, the display version is the `CFBundleShortVersionString`.
  "firebaseConsoleUri": "A String", # Output only. A link to the Firebase console displaying a single release.
  "name": "A String", # The name of the release resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`
  "releaseNotes": { # Notes that belong to a release. # Notes of the release.
    "text": "A String", # The text of the release notes.
  },
  "testingUri": "A String", # Output only. A link to the release in the tester web clip or Android app that lets testers (which were granted access to the app) view release notes and install the app onto their devices.
}