groups

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

Overview

Name	groups
Type	Resource
Id	firebase.appdistribution.groups

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	The name of the group resource. Format: projects/{project_number}/groups/{group_alias}
displayName	string	Required. The display name of the group.
inviteLinkCount	integer (int32)	Output only. The number of invite links for this group.
releaseCount	integer (int32)	Output only. The number of releases this group is permitted to access.
testerCount	integer (int32)	Output only. The number of testers who are members of this group.

list

Successful response

Name	Datatype	Description
name	string	The name of the group resource. Format: projects/{project_number}/groups/{group_alias}
displayName	string	Required. The display name of the group.
inviteLinkCount	integer (int32)	Output only. The number of invite links for this group.
releaseCount	integer (int32)	Output only. The number of releases this group is permitted to access.
testerCount	integer (int32)	Output only. The number of testers who are members of this group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, groupsId		Get a group.
list	select	projectsId	pageSize, pageToken	List groups.
create	insert	projectsId	groupId	Create a group.
patch	update	projectsId, groupsId	updateMask	Update a group.
delete	delete	projectsId, groupsId		Delete a group.
batch_join	exec	projectsId, groupsId		Batch adds members to a group. The testers will gain access to all releases that the groups have access to.
batch_leave	exec	projectsId, groupsId		Batch removed members from a group. The testers will lose access to all releases that the groups have access to.

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
groupsId	string
projectsId	string
groupId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Get a group.

SELECT
name,
displayName,
inviteLinkCount,
releaseCount,
testerCount
FROM firebase.appdistribution.groups
WHERE projectsId = '{{ projectsId }}' -- required
AND groupsId = '{{ groupsId }}' -- required;

list

List groups.

SELECT
name,
displayName,
inviteLinkCount,
releaseCount,
testerCount
FROM firebase.appdistribution.groups
WHERE projectsId = '{{ projectsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Create a group.

INSERT INTO firebase.appdistribution.groups (
data__name,
data__displayName,
projectsId,
groupId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ projectsId }}',
'{{ groupId }}'
RETURNING
name,
displayName,
inviteLinkCount,
releaseCount,
testerCount
;

Manifest

# Description fields are for documentation purposes
- name: groups
  props:
    - name: projectsId
      value: string
      description: Required parameter for the groups resource.
    - name: name
      value: string
      description: >
        The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
        
    - name: displayName
      value: string
      description: >
        Required. The display name of the group.
        
    - name: groupId
      value: string

UPDATE examples

patch

Update a group.

UPDATE firebase.appdistribution.groups
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND groupsId = '{{ groupsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
displayName,
inviteLinkCount,
releaseCount,
testerCount;

DELETE examples

delete

Delete a group.

DELETE FROM firebase.appdistribution.groups
WHERE projectsId = '{{ projectsId }}' --required
AND groupsId = '{{ groupsId }}' --required;

Lifecycle Methods

batch_join

Batch adds members to a group. The testers will gain access to all releases that the groups have access to.

EXEC firebase.appdistribution.groups.batch_join 
@projectsId='{{ projectsId }}' --required, 
@groupsId='{{ groupsId }}' --required 
@@json=
'{
"emails": "{{ emails }}", 
"createMissingTesters": {{ createMissingTesters }}
}';

batch_leave

Batch removed members from a group. The testers will lose access to all releases that the groups have access to.

EXEC firebase.appdistribution.groups.batch_leave 
@projectsId='{{ projectsId }}' --required, 
@groupsId='{{ groupsId }}' --required 
@@json=
'{
"emails": "{{ emails }}"
}';