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
|
<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.apps.html">apps</a> . <a href="firebaseappdistribution_v1.projects.apps.releases.html">releases</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="firebaseappdistribution_v1.projects.apps.releases.feedbackReports.html">feedbackReports()</a></code>
</p>
<p class="firstline">Returns the feedbackReports Resource.</p>
<p class="toc_element">
<code><a href="firebaseappdistribution_v1.projects.apps.releases.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
<code><a href="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes releases. A maximum of 100 releases can be deleted per request.</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="#distribute">distribute(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a release.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists releases. By default, sorts by `createTime` in descending order.</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">Updates a release.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>
<pre>Deletes releases. A maximum of 100 releases can be deleted per request.
Args:
parent: string, Required. The name of the app resource, which is the parent of the release resources. Format: `projects/{project_number}/apps/{app_id}` (required)
body: object, The request body.
The object takes the form of:
{ # The request message for `BatchDeleteReleases`.
"names": [ # Required. The names of the release resources to delete. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}` A maximum of 100 releases can be deleted per request.
"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="distribute">distribute(name, body=None, x__xgafv=None)</code>
<pre>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.
Args:
name: string, Required. The name of the release resource to distribute. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}` (required)
body: object, The request body.
The object takes the form of:
{ # The request message for `DistributeRelease`.
"groupAliases": [ # Optional. 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.
"A String",
],
"testerEmails": [ # Optional. 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.
"A String",
],
}
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 `DistributeRelease`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a release.
Args:
name: string, Required. The name of the release resource to retrieve. Format: projects/{project_number}/apps/{app_id}/releases/{release_id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A release of a Firebase app.
"binaryDownloadUri": "A String", # Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file.
"buildVersion": "A 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": "A String", # Output only. The time the release was created.
"displayVersion": "A 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": "A String", # Output only. The time the release will expire.
"firebaseConsoleUri": "A String", # Output only. A link to the Firebase console displaying a single release.
"name": "A String", # The name of the release resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`
"releaseNotes": { # Notes that belong to a release. # Notes of the release.
"text": "A String", # The text of the release notes.
},
"testingUri": "A 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": "A String", # Output only. The time the release was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists releases. By default, sorts by `createTime` in descending order.
Args:
parent: string, Required. The name of the app resource, which is the parent of the release resources. Format: `projects/{project_number}/apps/{app_id}` (required)
filter: string, Optional. The expression to filter releases listed in the response. To learn more about filtering, refer to [Google's AIP-160 standard](http://aip.dev/160). Supported fields: - `releaseNotes.text` supports `=` (can contain a wildcard character (`*`) at the beginning or end of the string) - `createTime` supports `<`, `<=`, `>` and `>=`, and expects an RFC-3339 formatted string Examples: - `createTime <= "2021-09-08T00:00:00+04:00"` - `releaseNotes.text="fixes" AND createTime >= "2021-09-08T00:00:00.0Z"` - `releaseNotes.text="*v1.0.0-rc*"`
orderBy: string, Optional. The fields used to order releases. Supported fields: - `createTime` To specify descending order for a field, append a "desc" suffix, for example, `createTime desc`. If this parameter is not set, releases are ordered by `createTime` in descending order.
pageSize: integer, Optional. The maximum number of releases to return. The service may return fewer than this value. The valid range is [1-100]; If unspecified (0), at most 25 releases are returned. Values above 100 are coerced to 100.
pageToken: string, Optional. A page token, received from a previous `ListReleases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleases` 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 `ListReleases`.
"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.
"releases": [ # The releases
{ # A release of a Firebase app.
"binaryDownloadUri": "A String", # Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file.
"buildVersion": "A 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": "A String", # Output only. The time the release was created.
"displayVersion": "A 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": "A String", # Output only. The time the release will expire.
"firebaseConsoleUri": "A String", # Output only. A link to the Firebase console displaying a single release.
"name": "A String", # The name of the release resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`
"releaseNotes": { # Notes that belong to a release. # Notes of the release.
"text": "A String", # The text of the release notes.
},
"testingUri": "A 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": "A String", # Output only. The time the release was last updated.
},
],
}</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>Updates a release.
Args:
name: string, The name of the release resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}` (required)
body: object, The request body.
The object takes the form of:
{ # A release of a Firebase app.
"binaryDownloadUri": "A String", # Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file.
"buildVersion": "A 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": "A String", # Output only. The time the release was created.
"displayVersion": "A 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": "A String", # Output only. The time the release will expire.
"firebaseConsoleUri": "A String", # Output only. A link to the Firebase console displaying a single release.
"name": "A String", # The name of the release resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`
"releaseNotes": { # Notes that belong to a release. # Notes of the release.
"text": "A String", # The text of the release notes.
},
"testingUri": "A 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": "A String", # Output only. The time the release was last updated.
}
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 release of a Firebase app.
"binaryDownloadUri": "A String", # Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file.
"buildVersion": "A 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": "A String", # Output only. The time the release was created.
"displayVersion": "A 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": "A String", # Output only. The time the release will expire.
"firebaseConsoleUri": "A String", # Output only. A link to the Firebase console displaying a single release.
"name": "A String", # The name of the release resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`
"releaseNotes": { # Notes that belong to a release. # Notes of the release.
"text": "A String", # The text of the release notes.
},
"testingUri": "A 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": "A String", # Output only. The time the release was last updated.
}</pre>
</div>
</body></html>
|
