Skip to main content

testers

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

Overview

Nametesters
TypeResource
Idfirebase.appdistribution.testers

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringThe name of the tester resource. Format: projects/{project_number}/testers/{email_address}
displayNamestringThe name of the tester associated with the Google account used to accept the tester invitation.
groupsarrayThe resource names of the groups this tester belongs to.
lastActivityTimestring (google-datetime)Output only. The time the tester was last active. This is the most recent time the tester installed one of the apps. If they've never installed one or if the release no longer exists, this is the time the tester was added to the project.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectprojectsIdpageSize, pageToken, filterLists testers and their resource ids.
patchupdateprojectsId, testersIdupdateMaskUpdate a tester. If the testers joins a group they gain access to all releases that the group has access to.
batch_addexecprojectsIdBatch adds testers. This call adds testers for the specified emails if they don't already exist. Returns all testers specified in the request, including newly created and previously existing testers. This action is idempotent.
batch_removeexecprojectsIdBatch removes testers. If found, this call deletes testers for the specified emails. Returns all deleted testers.

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.

NameDatatypeDescription
projectsIdstring
testersIdstring
filterstring
pageSizeinteger (int32)
pageTokenstring
updateMaskstring (google-fieldmask)

SELECT examples

Lists testers and their resource ids.

SELECT
name,
displayName,
groups,
lastActivityTime
FROM firebase.appdistribution.testers
WHERE projectsId = '{{ projectsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

UPDATE examples

Update a tester. If the testers joins a group they gain access to all releases that the group has access to.

UPDATE firebase.appdistribution.testers
SET
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__groups = '{{ groups }}'
WHERE
projectsId = '{{ projectsId }}' --required
AND testersId = '{{ testersId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
displayName,
groups,
lastActivityTime;

Lifecycle Methods

Batch adds testers. This call adds testers for the specified emails if they don't already exist. Returns all testers specified in the request, including newly created and previously existing testers. This action is idempotent.

EXEC firebase.appdistribution.testers.batch_add 
@projectsId='{{ projectsId }}' --required
@@json=
'{
"emails": "{{ emails }}"
}';