1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="firebaseappdistribution_v1.html">Firebase App Distribution API</a> . <a href="firebaseappdistribution_v1.projects.html">projects</a> . <a href="firebaseappdistribution_v1.projects.groups.html">groups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchJoin">batchJoin(group, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Batch adds members to a group. The testers will gain access to all releases that the groups have access to.</p>
<p class="toc_element">
<code><a href="#batchLeave">batchLeave(group, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Batch removed members from a group. The testers will lose access to all releases that the groups have access to.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, groupId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a group.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a group.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a group.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List groups.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update a group.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchJoin">batchJoin(group, body=None, x__xgafv=None)</code>
<pre>Batch adds members to a group. The testers will gain access to all releases that the groups have access to.
Args:
group: string, Required. The name of the group resource to which testers are added. Format: `projects/{project_number}/groups/{group_alias}` (required)
body: object, The request body.
The object takes the form of:
{ # The request message for `BatchJoinGroup`
"createMissingTesters": True or False, # Indicates whether to create tester resources based on `emails` if they don't exist yet.
"emails": [ # Required. The emails of the testers to be added to the group. A maximum of 999 and a minimum of 1 tester can be created in a batch.
"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); }
}</pre>
</div>
<div class="method">
<code class="details" id="batchLeave">batchLeave(group, body=None, x__xgafv=None)</code>
<pre>Batch removed members from a group. The testers will lose access to all releases that the groups have access to.
Args:
group: string, Required. The name of the group resource from which testers are removed. Format: `projects/{project_number}/groups/{group_alias}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `BatchLeaveGroup`
"emails": [ # Required. The email addresses of the testers to be removed from the group. A maximum of 999 and a minimum of 1 testers can be removed in a batch.
"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); }
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, groupId=None, x__xgafv=None)</code>
<pre>Create a group.
Args:
parent: string, Required. The name of the project resource, which is the parent of the group resource. Format: `projects/{project_number}` (required)
body: object, The request body.
The object takes the form of:
{ # A group which can contain testers. A group can be invited to test apps in a Firebase project.
"displayName": "A String", # Required. The display name of the group.
"inviteLinkCount": 42, # Output only. The number of invite links for this group.
"name": "A String", # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
"releaseCount": 42, # Output only. The number of releases this group is permitted to access.
"testerCount": 42, # Output only. The number of testers who are members of this group.
}
groupId: string, Optional. The "alias" to use for the group, which will become the final component of the group's resource name. This value must be unique per project. The field is named `groupId` to comply with AIP guidance for user-specified IDs. This value should be 4-63 characters, and valid characters are `/a-z-/`. If not set, it will be generated based on the display name.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A group which can contain testers. A group can be invited to test apps in a Firebase project.
"displayName": "A String", # Required. The display name of the group.
"inviteLinkCount": 42, # Output only. The number of invite links for this group.
"name": "A String", # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
"releaseCount": 42, # Output only. The number of releases this group is permitted to access.
"testerCount": 42, # Output only. The number of testers who are members of this group.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Delete a group.
Args:
name: string, Required. The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}` (required)
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); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get a group.
Args:
name: string, Required. The name of the group resource to retrieve. Format: `projects/{project_number}/groups/{group_alias}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A group which can contain testers. A group can be invited to test apps in a Firebase project.
"displayName": "A String", # Required. The display name of the group.
"inviteLinkCount": 42, # Output only. The number of invite links for this group.
"name": "A String", # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
"releaseCount": 42, # Output only. The number of releases this group is permitted to access.
"testerCount": 42, # Output only. The number of testers who are members of this group.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List groups.
Args:
parent: string, Required. The name of the project resource, which is the parent of the group resources. Format: `projects/{project_number}` (required)
pageSize: integer, Optional. The maximum number of groups to return. The service may return fewer than this value. The valid range is [1-1000]; If unspecified (0), at most 25 groups are returned. Values above 1000 are coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGroups` 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 `ListGroups`.
"groups": [ # The groups listed.
{ # A group which can contain testers. A group can be invited to test apps in a Firebase project.
"displayName": "A String", # Required. The display name of the group.
"inviteLinkCount": 42, # Output only. The number of invite links for this group.
"name": "A String", # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
"releaseCount": 42, # Output only. The number of releases this group is permitted to access.
"testerCount": 42, # Output only. The number of testers who are members of this group.
},
],
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>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.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Update a group.
Args:
name: string, The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}` (required)
body: object, The request body.
The object takes the form of:
{ # A group which can contain testers. A group can be invited to test apps in a Firebase project.
"displayName": "A String", # Required. The display name of the group.
"inviteLinkCount": 42, # Output only. The number of invite links for this group.
"name": "A String", # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
"releaseCount": 42, # Output only. The number of releases this group is permitted to access.
"testerCount": 42, # Output only. The number of testers who are members of this group.
}
updateMask: string, Optional. 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 group which can contain testers. A group can be invited to test apps in a Firebase project.
"displayName": "A String", # Required. The display name of the group.
"inviteLinkCount": 42, # Output only. The number of invite links for this group.
"name": "A String", # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
"releaseCount": 42, # Output only. The number of releases this group is permitted to access.
"testerCount": 42, # Output only. The number of testers who are members of this group.
}</pre>
</div>
</body></html>
|
