releases

Creates, updates, deletes, gets or lists a releases resource.

Overview

Name	releases
Type	Resource
Id	firebase.appdistribution.releases

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	The name of the release resource. Format: projects/{project_number}/apps/{app_id}/releases/{release_id}
binaryDownloadUri	string	Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file.
buildVersion	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	string (google-datetime)	Output only. The time the release was created.
displayVersion	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.
expireTime	string (google-datetime)	Output only. The time the release will expire.
firebaseConsoleUri	string	Output only. A link to the Firebase console displaying a single release.
releaseNotes	object	Notes of the release. (id: GoogleFirebaseAppdistroV1ReleaseNotes)
testingUri	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.
updateTime	string (google-datetime)	Output only. The time the release was last updated.

list

Successful response

Name	Datatype	Description
name	string	The name of the release resource. Format: projects/{project_number}/apps/{app_id}/releases/{release_id}
binaryDownloadUri	string	Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file.
buildVersion	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	string (google-datetime)	Output only. The time the release was created.
displayVersion	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.
expireTime	string (google-datetime)	Output only. The time the release will expire.
firebaseConsoleUri	string	Output only. A link to the Firebase console displaying a single release.
releaseNotes	object	Notes of the release. (id: GoogleFirebaseAppdistroV1ReleaseNotes)
testingUri	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.
updateTime	string (google-datetime)	Output only. The time the release was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, appsId, releasesId		Gets a release.
list	select	projectsId, appsId	pageSize, pageToken, orderBy, filter	Lists releases. By default, sorts by createTime in descending order.
patch	update	projectsId, appsId, releasesId	updateMask	Updates a release.
batch_delete	delete	projectsId, appsId		Deletes releases. A maximum of 100 releases can be deleted per request.
distribute	exec	projectsId, appsId, releasesId		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
appsId	string
projectsId	string
releasesId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets a release.

SELECT
name,
binaryDownloadUri,
buildVersion,
createTime,
displayVersion,
expireTime,
firebaseConsoleUri,
releaseNotes,
testingUri,
updateTime
FROM firebase.appdistribution.releases
WHERE projectsId = '{{ projectsId }}' -- required
AND appsId = '{{ appsId }}' -- required
AND releasesId = '{{ releasesId }}' -- required;

list

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

SELECT
name,
binaryDownloadUri,
buildVersion,
createTime,
displayVersion,
expireTime,
firebaseConsoleUri,
releaseNotes,
testingUri,
updateTime
FROM firebase.appdistribution.releases
WHERE projectsId = '{{ projectsId }}' -- required
AND appsId = '{{ appsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}';

UPDATE examples

patch

Updates a release.

UPDATE firebase.appdistribution.releases
SET 
data__name = '{{ name }}',
data__releaseNotes = '{{ releaseNotes }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND appsId = '{{ appsId }}' --required
AND releasesId = '{{ releasesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
binaryDownloadUri,
buildVersion,
createTime,
displayVersion,
expireTime,
firebaseConsoleUri,
releaseNotes,
testingUri,
updateTime;

DELETE examples

batch_delete

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

DELETE FROM firebase.appdistribution.releases
WHERE projectsId = '{{ projectsId }}' --required
AND appsId = '{{ appsId }}' --required;

Lifecycle Methods

distribute

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.

EXEC firebase.appdistribution.releases.distribute 
@projectsId='{{ projectsId }}' --required, 
@appsId='{{ appsId }}' --required, 
@releasesId='{{ releasesId }}' --required 
@@json=
'{
"testerEmails": "{{ testerEmails }}", 
"groupAliases": "{{ groupAliases }}"
}';