Method: projects.apps.releases.distribute
Stay organized with collections
Save and categorize content based on your preferences.
Distributes a release to testers. This call does the following:
- Creates testers for the specified emails, if none exist.
- Adds the testers and groups to the release.
- Sends new testers an invitation email.
- Sends existing testers a new release email.
The request will fail with a INVALID_ARGUMENT if it contains a group that doesn't exist.
HTTP request
POST https://firebaseappdistribution.googleapis.com/v1/{name=projects/*/apps/*/releases/*}:distribute
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the release resource to distribute. Format: projects/{projectNumber}/apps/{appId}/releases/{releaseId}
Authorization requires the following IAM permission on the Firebase project that owns the specified resource name:
firebaseappdistro.releases.update
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"testerEmails": [
string
],
"groupAliases": [
string
]
} |
| Fields |
testerEmails[] |
string
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.
|
groupAliases[] |
string
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.
|
Response body
If successful, the response body is empty.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-30 UTC.
[null,null,["Last updated 2024-12-30 UTC."],[],[],null,["# Method: projects.apps.releases.distribute\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nDistributes a release to testers. This call does the following:\n\n1. Creates testers for the specified emails, if none exist.\n2. Adds the testers and groups to the release.\n3. Sends new testers an invitation email.\n4. Sends existing testers a new release email.\n\nThe request will fail with a `INVALID_ARGUMENT` if it contains a group that doesn't exist.\n\n### HTTP request\n\n`POST https://firebaseappdistribution.googleapis.com/v1/{name=projects/*/apps/*/releases/*}:distribute`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the release resource to distribute. Format: `projects/{projectNumber}/apps/{appId}/releases/{releaseId}` Authorization requires the following [IAM](https://firebase.google.com/docs/projects/iam/overview/) permission on the Firebase project that owns the specified resource `name`: - `firebaseappdistro.releases.update` |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------|\n| ``` { \"testerEmails\": [ string ], \"groupAliases\": [ string ] } ``` |\n\n| Fields ||\n|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `tester``Emails[]` | `string` 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. |\n| `group``Aliases[]` | `string` 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. |\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
