1{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
7 }
8 }
9 }
10 },
11 "basePath": "",
12 "baseUrl": "https://firebaseappdistribution.googleapis.com/",
13 "batchPath": "batch",
14 "canonicalName": "Firebase App Distribution",
15 "description": "",
16 "discoveryVersion": "v1",
17 "documentationLink": "https://firebase.google.com/products/app-distribution",
18 "fullyEncodeReservedExpansion": true,
19 "icons": {
20 "x16": "http://www.google.com/images/icons/product/search-16.gif",
21 "x32": "http://www.google.com/images/icons/product/search-32.gif"
22 },
23 "id": "firebaseappdistribution:v1alpha",
24 "kind": "discovery#restDescription",
25 "mtlsRootUrl": "https://firebaseappdistribution.mtls.googleapis.com/",
26 "name": "firebaseappdistribution",
27 "ownerDomain": "google.com",
28 "ownerName": "Google",
29 "parameters": {
30 "$.xgafv": {
31 "description": "V1 error format.",
32 "enum": [
33 "1",
34 "2"
35 ],
36 "enumDescriptions": [
37 "v1 error format",
38 "v2 error format"
39 ],
40 "location": "query",
41 "type": "string"
42 },
43 "access_token": {
44 "description": "OAuth access token.",
45 "location": "query",
46 "type": "string"
47 },
48 "alt": {
49 "default": "json",
50 "description": "Data format for response.",
51 "enum": [
52 "json",
53 "media",
54 "proto"
55 ],
56 "enumDescriptions": [
57 "Responses with Content-Type of application/json",
58 "Media download with context-dependent Content-Type",
59 "Responses with Content-Type of application/x-protobuf"
60 ],
61 "location": "query",
62 "type": "string"
63 },
64 "callback": {
65 "description": "JSONP",
66 "location": "query",
67 "type": "string"
68 },
69 "fields": {
70 "description": "Selector specifying which fields to include in a partial response.",
71 "location": "query",
72 "type": "string"
73 },
74 "key": {
75 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
76 "location": "query",
77 "type": "string"
78 },
79 "oauth_token": {
80 "description": "OAuth 2.0 token for the current user.",
81 "location": "query",
82 "type": "string"
83 },
84 "prettyPrint": {
85 "default": "true",
86 "description": "Returns response with indentations and line breaks.",
87 "location": "query",
88 "type": "boolean"
89 },
90 "quotaUser": {
91 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
92 "location": "query",
93 "type": "string"
94 },
95 "uploadType": {
96 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
97 "location": "query",
98 "type": "string"
99 },
100 "upload_protocol": {
101 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
102 "location": "query",
103 "type": "string"
104 }
105 },
106 "protocol": "rest",
107 "resources": {
108 "apps": {
109 "methods": {
110 "get": {
111 "description": "Get the app, if it exists",
112 "flatPath": "v1alpha/apps/{mobilesdkAppId}",
113 "httpMethod": "GET",
114 "id": "firebaseappdistribution.apps.get",
115 "parameterOrder": [
116 "mobilesdkAppId"
117 ],
118 "parameters": {
119 "appView": {
120 "description": "App view. When unset or set to BASIC, returns an App with everything set except for aab_state. When set to FULL, returns an App with aab_state set.",
121 "enum": [
122 "APP_VIEW_UNSPECIFIED",
123 "BASIC",
124 "FULL"
125 ],
126 "enumDescriptions": [
127 "The default / unset value. The API will default to the BASIC view.",
128 "Include everything except aab_state.",
129 "Include everything."
130 ],
131 "location": "query",
132 "type": "string"
133 },
134 "mobilesdkAppId": {
135 "description": "Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289",
136 "location": "path",
137 "required": true,
138 "type": "string"
139 }
140 },
141 "path": "v1alpha/apps/{mobilesdkAppId}",
142 "response": {
143 "$ref": "GoogleFirebaseAppdistroV1alphaApp"
144 },
145 "scopes": [
146 "https://www.googleapis.com/auth/cloud-platform"
147 ]
148 },
149 "getJwt": {
150 "description": "Get a JWT token",
151 "flatPath": "v1alpha/apps/{mobilesdkAppId}/jwt",
152 "httpMethod": "GET",
153 "id": "firebaseappdistribution.apps.getJwt",
154 "parameterOrder": [
155 "mobilesdkAppId"
156 ],
157 "parameters": {
158 "mobilesdkAppId": {
159 "description": "Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289",
160 "location": "path",
161 "required": true,
162 "type": "string"
163 }
164 },
165 "path": "v1alpha/apps/{mobilesdkAppId}/jwt",
166 "response": {
167 "$ref": "GoogleFirebaseAppdistroV1alphaJwt"
168 },
169 "scopes": [
170 "https://www.googleapis.com/auth/cloud-platform"
171 ]
172 },
173 "provisionApp": {
174 "description": "Provision app distribution for an existing Firebase app, enabling it to subsequently be used by appdistro.",
175 "flatPath": "v1alpha/apps/{mobilesdkAppId}",
176 "httpMethod": "POST",
177 "id": "firebaseappdistribution.apps.provisionApp",
178 "parameterOrder": [
179 "mobilesdkAppId"
180 ],
181 "parameters": {
182 "mobilesdkAppId": {
183 "description": "Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289",
184 "location": "path",
185 "required": true,
186 "type": "string"
187 }
188 },
189 "path": "v1alpha/apps/{mobilesdkAppId}",
190 "response": {
191 "$ref": "GoogleFirebaseAppdistroV1alphaProvisionAppResponse"
192 },
193 "scopes": [
194 "https://www.googleapis.com/auth/cloud-platform"
195 ]
196 }
197 },
198 "resources": {
199 "release_by_hash": {
200 "methods": {
201 "get": {
202 "description": "GET Release by binary upload hash",
203 "flatPath": "v1alpha/apps/{mobilesdkAppId}/release_by_hash/{uploadHash}",
204 "httpMethod": "GET",
205 "id": "firebaseappdistribution.apps.release_by_hash.get",
206 "parameterOrder": [
207 "mobilesdkAppId",
208 "uploadHash"
209 ],
210 "parameters": {
211 "mobilesdkAppId": {
212 "description": "Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289",
213 "location": "path",
214 "required": true,
215 "type": "string"
216 },
217 "uploadHash": {
218 "description": "The hash for the upload",
219 "location": "path",
220 "required": true,
221 "type": "string"
222 }
223 },
224 "path": "v1alpha/apps/{mobilesdkAppId}/release_by_hash/{uploadHash}",
225 "response": {
226 "$ref": "GoogleFirebaseAppdistroV1alphaGetReleaseByUploadHashResponse"
227 },
228 "scopes": [
229 "https://www.googleapis.com/auth/cloud-platform"
230 ]
231 }
232 }
233 },
234 "releases": {
235 "methods": {
236 "enable_access": {
237 "description": "Enable access on a release for testers.",
238 "flatPath": "v1alpha/apps/{mobilesdkAppId}/releases/{releaseId}/enable_access",
239 "httpMethod": "POST",
240 "id": "firebaseappdistribution.apps.releases.enable_access",
241 "parameterOrder": [
242 "mobilesdkAppId",
243 "releaseId"
244 ],
245 "parameters": {
246 "mobilesdkAppId": {
247 "description": "Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289",
248 "location": "path",
249 "required": true,
250 "type": "string"
251 },
252 "releaseId": {
253 "description": "Release identifier",
254 "location": "path",
255 "required": true,
256 "type": "string"
257 }
258 },
259 "path": "v1alpha/apps/{mobilesdkAppId}/releases/{releaseId}/enable_access",
260 "request": {
261 "$ref": "GoogleFirebaseAppdistroV1alphaEnableAccessOnReleaseRequest"
262 },
263 "response": {
264 "$ref": "GoogleFirebaseAppdistroV1alphaEnableAccessOnReleaseResponse"
265 },
266 "scopes": [
267 "https://www.googleapis.com/auth/cloud-platform"
268 ]
269 }
270 },
271 "resources": {
272 "notes": {
273 "methods": {
274 "create": {
275 "description": "Create release notes on a release.",
276 "flatPath": "v1alpha/apps/{mobilesdkAppId}/releases/{releaseId}/notes",
277 "httpMethod": "POST",
278 "id": "firebaseappdistribution.apps.releases.notes.create",
279 "parameterOrder": [
280 "mobilesdkAppId",
281 "releaseId"
282 ],
283 "parameters": {
284 "mobilesdkAppId": {
285 "description": "Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289",
286 "location": "path",
287 "required": true,
288 "type": "string"
289 },
290 "releaseId": {
291 "description": "Release identifier",
292 "location": "path",
293 "required": true,
294 "type": "string"
295 }
296 },
297 "path": "v1alpha/apps/{mobilesdkAppId}/releases/{releaseId}/notes",
298 "request": {
299 "$ref": "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest"
300 },
301 "response": {
302 "$ref": "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesResponse"
303 },
304 "scopes": [
305 "https://www.googleapis.com/auth/cloud-platform"
306 ]
307 }
308 }
309 }
310 }
311 },
312 "testers": {
313 "methods": {
314 "getTesterUdids": {
315 "description": "Get UDIDs of tester iOS devices in a project",
316 "flatPath": "v1alpha/apps/{mobilesdkAppId}/testers:getTesterUdids",
317 "httpMethod": "GET",
318 "id": "firebaseappdistribution.apps.testers.getTesterUdids",
319 "parameterOrder": [
320 "mobilesdkAppId"
321 ],
322 "parameters": {
323 "mobilesdkAppId": {
324 "description": "Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289",
325 "location": "path",
326 "required": true,
327 "type": "string"
328 },
329 "project": {
330 "description": "The name of the project, which is the parent of testers Format: `projects/{project_number}`",
331 "location": "query",
332 "type": "string"
333 }
334 },
335 "path": "v1alpha/apps/{mobilesdkAppId}/testers:getTesterUdids",
336 "response": {
337 "$ref": "GoogleFirebaseAppdistroV1alphaGetTesterUdidsResponse"
338 },
339 "scopes": [
340 "https://www.googleapis.com/auth/cloud-platform"
341 ]
342 }
343 }
344 },
345 "upload_status": {
346 "methods": {
347 "get": {
348 "description": "GET Binary upload status by token",
349 "flatPath": "v1alpha/apps/{mobilesdkAppId}/upload_status/{uploadToken}",
350 "httpMethod": "GET",
351 "id": "firebaseappdistribution.apps.upload_status.get",
352 "parameterOrder": [
353 "mobilesdkAppId",
354 "uploadToken"
355 ],
356 "parameters": {
357 "mobilesdkAppId": {
358 "description": "Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289",
359 "location": "path",
360 "required": true,
361 "type": "string"
362 },
363 "uploadToken": {
364 "description": "The token for the upload",
365 "location": "path",
366 "required": true,
367 "type": "string"
368 }
369 },
370 "path": "v1alpha/apps/{mobilesdkAppId}/upload_status/{uploadToken}",
371 "response": {
372 "$ref": "GoogleFirebaseAppdistroV1alphaGetUploadStatusResponse"
373 },
374 "scopes": [
375 "https://www.googleapis.com/auth/cloud-platform"
376 ]
377 }
378 }
379 }
380 }
381 },
382 "projects": {
383 "resources": {
384 "apps": {
385 "methods": {
386 "getTestConfig": {
387 "description": "Gets configuration for automated tests.",
388 "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/testConfig",
389 "httpMethod": "GET",
390 "id": "firebaseappdistribution.projects.apps.getTestConfig",
391 "parameterOrder": [
392 "name"
393 ],
394 "parameters": {
395 "name": {
396 "description": "Required. The name of the `TestConfig` resource to retrieve. Format: `projects/{project_number}/apps/{app_id}/testConfig`",
397 "location": "path",
398 "pattern": "^projects/[^/]+/apps/[^/]+/testConfig$",
399 "required": true,
400 "type": "string"
401 }
402 },
403 "path": "v1alpha/{+name}",
404 "response": {
405 "$ref": "GoogleFirebaseAppdistroV1alphaTestConfig"
406 },
407 "scopes": [
408 "https://www.googleapis.com/auth/cloud-platform"
409 ]
410 },
411 "updateTestConfig": {
412 "description": "Updates a release.",
413 "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/testConfig",
414 "httpMethod": "PATCH",
415 "id": "firebaseappdistribution.projects.apps.updateTestConfig",
416 "parameterOrder": [
417 "name"
418 ],
419 "parameters": {
420 "name": {
421 "description": "Identifier. The name of the test configuration resource. Format: `projects/{project_number}/apps/{app_id}/testConfig`",
422 "location": "path",
423 "pattern": "^projects/[^/]+/apps/[^/]+/testConfig$",
424 "required": true,
425 "type": "string"
426 },
427 "updateMask": {
428 "description": "Optional. The list of fields to update.",
429 "format": "google-fieldmask",
430 "location": "query",
431 "type": "string"
432 }
433 },
434 "path": "v1alpha/{+name}",
435 "request": {
436 "$ref": "GoogleFirebaseAppdistroV1alphaTestConfig"
437 },
438 "response": {
439 "$ref": "GoogleFirebaseAppdistroV1alphaTestConfig"
440 },
441 "scopes": [
442 "https://www.googleapis.com/auth/cloud-platform"
443 ]
444 }
445 },
446 "resources": {
447 "releases": {
448 "resources": {
449 "tests": {
450 "methods": {
451 "create": {
452 "description": "Run automated test(s) on release.",
453 "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/tests",
454 "httpMethod": "POST",
455 "id": "firebaseappdistribution.projects.apps.releases.tests.create",
456 "parameterOrder": [
457 "parent"
458 ],
459 "parameters": {
460 "parent": {
461 "description": "Required. The name of the release resource, which is the parent of the test Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`",
462 "location": "path",
463 "pattern": "^projects/[^/]+/apps/[^/]+/releases/[^/]+$",
464 "required": true,
465 "type": "string"
466 },
467 "releaseTestId": {
468 "description": "Optional. The ID to use for the test, which will become the final component of the tests's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. If it is not provided one will be automatically generated.",
469 "location": "query",
470 "type": "string"
471 }
472 },
473 "path": "v1alpha/{+parent}/tests",
474 "request": {
475 "$ref": "GoogleFirebaseAppdistroV1alphaReleaseTest"
476 },
477 "response": {
478 "$ref": "GoogleFirebaseAppdistroV1alphaReleaseTest"
479 },
480 "scopes": [
481 "https://www.googleapis.com/auth/cloud-platform"
482 ]
483 },
484 "get": {
485 "description": "Get results for automated test run on release.",
486 "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/tests/{testsId}",
487 "httpMethod": "GET",
488 "id": "firebaseappdistribution.projects.apps.releases.tests.get",
489 "parameterOrder": [
490 "name"
491 ],
492 "parameters": {
493 "name": {
494 "description": "Required. The name of the release test resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}/tests/{test_id}`",
495 "location": "path",
496 "pattern": "^projects/[^/]+/apps/[^/]+/releases/[^/]+/tests/[^/]+$",
497 "required": true,
498 "type": "string"
499 }
500 },
501 "path": "v1alpha/{+name}",
502 "response": {
503 "$ref": "GoogleFirebaseAppdistroV1alphaReleaseTest"
504 },
505 "scopes": [
506 "https://www.googleapis.com/auth/cloud-platform"
507 ]
508 },
509 "list": {
510 "description": "List results for automated tests run on release.",
511 "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/tests",
512 "httpMethod": "GET",
513 "id": "firebaseappdistribution.projects.apps.releases.tests.list",
514 "parameterOrder": [
515 "parent"
516 ],
517 "parameters": {
518 "pageSize": {
519 "description": "Optional. The maximum number of tests to return. The service may return fewer than this value.",
520 "format": "int32",
521 "location": "query",
522 "type": "integer"
523 },
524 "pageToken": {
525 "description": "Optional. A page token, received from a previous `ListReleaseTests` call. Provide this to retrieve the subsequent page.",
526 "location": "query",
527 "type": "string"
528 },
529 "parent": {
530 "description": "Required. The name of the release resource, which is the parent of the tests Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`",
531 "location": "path",
532 "pattern": "^projects/[^/]+/apps/[^/]+/releases/[^/]+$",
533 "required": true,
534 "type": "string"
535 }
536 },
537 "path": "v1alpha/{+parent}/tests",
538 "response": {
539 "$ref": "GoogleFirebaseAppdistroV1alphaListReleaseTestsResponse"
540 },
541 "scopes": [
542 "https://www.googleapis.com/auth/cloud-platform"
543 ]
544 }
545 }
546 }
547 }
548 }
549 }
550 },
551 "testers": {
552 "methods": {
553 "getUdids": {
554 "description": "Get UDIDs of tester iOS devices in a project",
555 "flatPath": "v1alpha/projects/{projectsId}/testers:udids",
556 "httpMethod": "GET",
557 "id": "firebaseappdistribution.projects.testers.getUdids",
558 "parameterOrder": [
559 "project"
560 ],
561 "parameters": {
562 "mobilesdkAppId": {
563 "description": "Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289",
564 "location": "query",
565 "type": "string"
566 },
567 "project": {
568 "description": "The name of the project, which is the parent of testers Format: `projects/{project_number}`",
569 "location": "path",
570 "pattern": "^projects/[^/]+$",
571 "required": true,
572 "type": "string"
573 }
574 },
575 "path": "v1alpha/{+project}/testers:udids",
576 "response": {
577 "$ref": "GoogleFirebaseAppdistroV1alphaGetTesterUdidsResponse"
578 },
579 "scopes": [
580 "https://www.googleapis.com/auth/cloud-platform"
581 ]
582 }
583 }
584 }
585 }
586 }
587 },
588 "revision": "20231221",
589 "rootUrl": "https://firebaseappdistribution.googleapis.com/",
590 "schemas": {
591 "GoogleFirebaseAppdistroV1Release": {
592 "description": "A release of a Firebase app.",
593 "id": "GoogleFirebaseAppdistroV1Release",
594 "properties": {
595 "binaryDownloadUri": {
596 "description": "Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file.",
597 "readOnly": true,
598 "type": "string"
599 },
600 "buildVersion": {
601 "description": "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`.",
602 "readOnly": true,
603 "type": "string"
604 },
605 "createTime": {
606 "description": "Output only. The time the release was created.",
607 "format": "google-datetime",
608 "readOnly": true,
609 "type": "string"
610 },
611 "displayVersion": {
612 "description": "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`.",
613 "readOnly": true,
614 "type": "string"
615 },
616 "firebaseConsoleUri": {
617 "description": "Output only. A link to the Firebase console displaying a single release.",
618 "readOnly": true,
619 "type": "string"
620 },
621 "name": {
622 "description": "The name of the release resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`",
623 "type": "string"
624 },
625 "releaseNotes": {
626 "$ref": "GoogleFirebaseAppdistroV1ReleaseNotes",
627 "description": "Notes of the release."
628 },
629 "testingUri": {
630 "description": "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.",
631 "readOnly": true,
632 "type": "string"
633 }
634 },
635 "type": "object"
636 },
637 "GoogleFirebaseAppdistroV1ReleaseNotes": {
638 "description": "Notes that belong to a release.",
639 "id": "GoogleFirebaseAppdistroV1ReleaseNotes",
640 "properties": {
641 "text": {
642 "description": "The text of the release notes.",
643 "type": "string"
644 }
645 },
646 "type": "object"
647 },
648 "GoogleFirebaseAppdistroV1UploadReleaseMetadata": {
649 "description": "Operation metadata for `UploadRelease`.",
650 "id": "GoogleFirebaseAppdistroV1UploadReleaseMetadata",
651 "properties": {},
652 "type": "object"
653 },
654 "GoogleFirebaseAppdistroV1UploadReleaseResponse": {
655 "description": "Response message for `UploadRelease`.",
656 "id": "GoogleFirebaseAppdistroV1UploadReleaseResponse",
657 "properties": {
658 "release": {
659 "$ref": "GoogleFirebaseAppdistroV1Release",
660 "description": "Release associated with the uploaded binary."
661 },
662 "result": {
663 "description": "Result of upload release.",
664 "enum": [
665 "UPLOAD_RELEASE_RESULT_UNSPECIFIED",
666 "RELEASE_CREATED",
667 "RELEASE_UPDATED",
668 "RELEASE_UNMODIFIED"
669 ],
670 "enumDescriptions": [
671 "Upload binary result unspecified",
672 "Upload binary resulted in a new release",
673 "Upload binary updated an existing release",
674 "Upload binary resulted in a no-op. A release with the exact same binary already exists."
675 ],
676 "type": "string"
677 }
678 },
679 "type": "object"
680 },
681 "GoogleFirebaseAppdistroV1alphaAabCertificate": {
682 "description": "App bundle test certificate",
683 "id": "GoogleFirebaseAppdistroV1alphaAabCertificate",
684 "properties": {
685 "certificateHashMd5": {
686 "description": "MD5 hash of the certificate used to resign the AAB",
687 "type": "string"
688 },
689 "certificateHashSha1": {
690 "description": "SHA1 hash of the certificate used to resign the AAB",
691 "type": "string"
692 },
693 "certificateHashSha256": {
694 "description": "SHA256 hash of the certificate used to resign the AAB",
695 "type": "string"
696 }
697 },
698 "type": "object"
699 },
700 "GoogleFirebaseAppdistroV1alphaApp": {
701 "id": "GoogleFirebaseAppdistroV1alphaApp",
702 "properties": {
703 "aabCertificate": {
704 "$ref": "GoogleFirebaseAppdistroV1alphaAabCertificate",
705 "description": "App bundle test certificate generated for the app."
706 },
707 "aabState": {
708 "description": "App bundle state. Only valid for android apps. The app_view field in the request must be set to FULL in order for this to be populated.",
709 "enum": [
710 "AAB_STATE_UNSPECIFIED",
711 "ACTIVE",
712 "PLAY_ACCOUNT_NOT_LINKED",
713 "NO_APP_WITH_GIVEN_BUNDLE_ID_IN_PLAY_ACCOUNT",
714 "APP_NOT_PUBLISHED",
715 "AAB_STATE_UNAVAILABLE",
716 "PLAY_IAS_TERMS_NOT_ACCEPTED"
717 ],
718 "enumDescriptions": [
719 "Aab state unspecified",
720 "App can receive app bundle uploads",
721 "Firebase project is not linked to a Play developer account",
722 "There is no app in linked Play developer account with the same bundle id",
723 "The app in Play developer account is not in a published state",
724 "Play App status is unavailable",
725 "Play IAS terms not accepted"
726 ],
727 "type": "string"
728 },
729 "appId": {
730 "description": "Firebase gmp app id",
731 "type": "string"
732 },
733 "bundleId": {
734 "description": "Bundle identifier",
735 "type": "string"
736 },
737 "contactEmail": {
738 "description": "Developer contact email for testers to reach out to about privacy or support issues.",
739 "type": "string"
740 },
741 "platform": {
742 "description": "iOS or Android",
743 "type": "string"
744 },
745 "projectNumber": {
746 "description": "Project number of the Firebase project, for example 300830567303.",
747 "type": "string"
748 }
749 },
750 "type": "object"
751 },
752 "GoogleFirebaseAppdistroV1alphaAppCrash": {
753 "description": "An app crash that occurred during an automated test.",
754 "id": "GoogleFirebaseAppdistroV1alphaAppCrash",
755 "properties": {
756 "message": {
757 "description": "Output only. The message associated with the crash.",
758 "readOnly": true,
759 "type": "string"
760 },
761 "stackTrace": {
762 "description": "Output only. The raw stack trace.",
763 "readOnly": true,
764 "type": "string"
765 }
766 },
767 "type": "object"
768 },
769 "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest": {
770 "id": "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest",
771 "properties": {
772 "releaseNotes": {
773 "$ref": "GoogleFirebaseAppdistroV1alphaReleaseNotes",
774 "description": "The actual release notes body from the user"
775 }
776 },
777 "type": "object"
778 },
779 "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesResponse": {
780 "id": "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesResponse",
781 "properties": {},
782 "type": "object"
783 },
784 "GoogleFirebaseAppdistroV1alphaDeviceExecution": {
785 "description": "The results of running an automated test on a particular device.",
786 "id": "GoogleFirebaseAppdistroV1alphaDeviceExecution",
787 "properties": {
788 "appCrash": {
789 "$ref": "GoogleFirebaseAppdistroV1alphaAppCrash",
790 "description": "Output only. An app crash, if any occurred during the test.",
791 "readOnly": true
792 },
793 "crawlGraphUri": {
794 "description": "Output only. A URI to an image of the Robo crawl graph.",
795 "readOnly": true,
796 "type": "string"
797 },
798 "device": {
799 "$ref": "GoogleFirebaseAppdistroV1alphaTestDevice",
800 "description": "Required. The device that the test was run on."
801 },
802 "failedReason": {
803 "description": "Output only. The reason why the test failed.",
804 "enum": [
805 "FAILED_REASON_UNSPECIFIED",
806 "CRASHED",
807 "NOT_INSTALLED",
808 "UNABLE_TO_CRAWL",
809 "DEVICE_OUT_OF_MEMORY"
810 ],
811 "enumDescriptions": [
812 "Reason unspecified.",
813 "The app crashed during the test.",
814 "If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.",
815 "If the app could not be crawled (possibly because the app did not start).",
816 "If the device ran out of memory during the test."
817 ],
818 "readOnly": true,
819 "type": "string"
820 },
821 "inconclusiveReason": {
822 "description": "Output only. The reason why the test was inconclusive.",
823 "enum": [
824 "INCONCLUSIVE_REASON_UNSPECIFIED",
825 "QUOTA_EXCEEDED",
826 "INFRASTRUCTURE_FAILURE",
827 "SERVICE_NOT_ACTIVATED",
828 "NO_SIGNATURE",
829 "NO_LAUNCHER_ACTIVITY",
830 "FORBIDDEN_PERMISSIONS",
831 "DEVICE_ADMIN_RECEIVER",
832 "NO_CODE_APK",
833 "INVALID_APK_PREVIEW_SDK"
834 ],
835 "enumDescriptions": [
836 "Reason unspecified.",
837 "Not enough quota remained to run the test.",
838 "The outcome of the test could not be determined because of a failure in the test running infrastructure.",
839 "A required cloud service api is not activated (Google Cloud Testing API or Cloud Tool Results API).",
840 "The app was not signed.",
841 "A main launcher activity could not be found.",
842 "The app declares one or more permissions that are not allowed.",
843 "Device administrator applications are not allowed.",
844 "APK contains no code. See also https://developer.android.com/guide/topics/manifest/application-element.html#code",
845 "APK is built for a preview SDK which is unsupported."
846 ],
847 "readOnly": true,
848 "type": "string"
849 },
850 "resultsStoragePath": {
851 "description": "Output only. The path to a directory in Cloud Storage that will eventually contain the results for this execution. For example, gs://bucket/Nexus5-18-en-portrait.",
852 "readOnly": true,
853 "type": "string"
854 },
855 "roboStats": {
856 "$ref": "GoogleFirebaseAppdistroV1alphaRoboStats",
857 "description": "Output only. The statistics collected during the Robo test.",
858 "readOnly": true
859 },
860 "screenshotUris": {
861 "description": "Output only. A list of screenshot image URIs taken from the Robo crawl. The file names are numbered by the order in which they were taken.",
862 "items": {
863 "type": "string"
864 },
865 "readOnly": true,
866 "type": "array"
867 },
868 "state": {
869 "description": "Output only. The state of the test.",
870 "enum": [
871 "TEST_STATE_UNSPECIFIED",
872 "IN_PROGRESS",
873 "PASSED",
874 "FAILED",
875 "INCONCLUSIVE"
876 ],
877 "enumDescriptions": [
878 "Test state unspecified.",
879 "The test is in progress.",
880 "The test has passed.",
881 "The test has failed.",
882 "The test was inconclusive."
883 ],
884 "readOnly": true,
885 "type": "string"
886 },
887 "videoUri": {
888 "description": "Output only. A URI to a video of the test run.",
889 "readOnly": true,
890 "type": "string"
891 }
892 },
893 "type": "object"
894 },
895 "GoogleFirebaseAppdistroV1alphaEnableAccessOnReleaseRequest": {
896 "id": "GoogleFirebaseAppdistroV1alphaEnableAccessOnReleaseRequest",
897 "properties": {
898 "buildVersion": {
899 "deprecated": true,
900 "description": "Optional. Ignored. Used to be build version of the app release if an instance identifier was provided for the release_id.",
901 "type": "string"
902 },
903 "displayVersion": {
904 "deprecated": true,
905 "description": "Optional. Ignored. Used to be display version of the app release if an instance identifier was provided for the release_id.",
906 "type": "string"
907 },
908 "emails": {
909 "description": "Optional. An email address which should get access to this release, for example rebeccahe@google.com",
910 "items": {
911 "type": "string"
912 },
913 "type": "array"
914 },
915 "groupIds": {
916 "description": "Optional. A repeated list of group aliases to enable access to a release for Note: This field is misnamed, but can't be changed because we need to maintain compatibility with old build tools",
917 "items": {
918 "type": "string"
919 },
920 "type": "array"
921 }
922 },
923 "type": "object"
924 },
925 "GoogleFirebaseAppdistroV1alphaEnableAccessOnReleaseResponse": {
926 "id": "GoogleFirebaseAppdistroV1alphaEnableAccessOnReleaseResponse",
927 "properties": {},
928 "type": "object"
929 },
930 "GoogleFirebaseAppdistroV1alphaGetReleaseByUploadHashResponse": {
931 "description": "Response object to get the release given a upload hash",
932 "id": "GoogleFirebaseAppdistroV1alphaGetReleaseByUploadHashResponse",
933 "properties": {
934 "release": {
935 "$ref": "GoogleFirebaseAppdistroV1alphaRelease",
936 "description": "Release object"
937 }
938 },
939 "type": "object"
940 },
941 "GoogleFirebaseAppdistroV1alphaGetTesterUdidsResponse": {
942 "description": "Response containing the UDIDs of tester iOS devices in a project",
943 "id": "GoogleFirebaseAppdistroV1alphaGetTesterUdidsResponse",
944 "properties": {
945 "testerUdids": {
946 "description": "The UDIDs of tester iOS devices in a project",
947 "items": {
948 "$ref": "GoogleFirebaseAppdistroV1alphaTesterUdid"
949 },
950 "type": "array"
951 }
952 },
953 "type": "object"
954 },
955 "GoogleFirebaseAppdistroV1alphaGetUploadStatusResponse": {
956 "id": "GoogleFirebaseAppdistroV1alphaGetUploadStatusResponse",
957 "properties": {
958 "errorCode": {
959 "description": "The error code associated with (only set on \"FAILURE\")",
960 "enum": [
961 "ERROR_UNSPECIFIED",
962 "INVALID_ZIP",
963 "MISSING_PLIST",
964 "MISSING_PROFILE",
965 "VERSION_TOO_LONG",
966 "MISSING_UUIDS",
967 "MISSING_RESOURCES",
968 "MISSING_MANIFEST",
969 "IOS_METADATA_ERROR",
970 "ANDROID_METADATA_ERROR",
971 "UNSUPPORTED_PLATFORM_TYPE",
972 "BUNDLE_ID_MISMATCH",
973 "APK_NOT_ZIP_ALIGNED",
974 "INVALID_CERTIFICATE",
975 "APK_TOO_LARGE",
976 "AAB_NOT_PUBLISHED",
977 "INVALID_PLIST_DEVICE_FAMILIES",
978 "AAB_TOS_NOT_ACCEPTED",
979 "APP_NAME_TOO_LONG",
980 "AAB_DEVELOPER_ACCOUNT_NOT_LINKED",
981 "AAB_NO_APP_WITH_GIVEN_PACKAGE_NAME_IN_ACCOUNT",
982 "AAB_UPLOAD_ERROR"
983 ],
984 "enumDescriptions": [
985 "",
986 "",
987 "",
988 "",
989 "",
990 "",
991 "",
992 "",
993 "",
994 "",
995 "",
996 "",
997 "",
998 "",
999 "",
1000 "",
1001 "",
1002 "",
1003 "",
1004 "",
1005 "",
1006 ""
1007 ],
1008 "type": "string"
1009 },
1010 "message": {
1011 "description": "Any additional context for the given upload status (e.g. error message) Meant to be displayed to the client",
1012 "type": "string"
1013 },
1014 "release": {
1015 "$ref": "GoogleFirebaseAppdistroV1alphaRelease",
1016 "description": "The release that was created from the upload (only set on \"SUCCESS\")"
1017 },
1018 "status": {
1019 "description": "The status of the upload",
1020 "enum": [
1021 "STATUS_UNSPECIFIED",
1022 "IN_PROGRESS",
1023 "ALREADY_UPLOADED",
1024 "SUCCESS",
1025 "ERROR"
1026 ],
1027 "enumDescriptions": [
1028 "",
1029 "",
1030 "",
1031 "",
1032 ""
1033 ],
1034 "type": "string"
1035 }
1036 },
1037 "type": "object"
1038 },
1039 "GoogleFirebaseAppdistroV1alphaJwt": {
1040 "id": "GoogleFirebaseAppdistroV1alphaJwt",
1041 "properties": {
1042 "token": {
1043 "type": "string"
1044 }
1045 },
1046 "type": "object"
1047 },
1048 "GoogleFirebaseAppdistroV1alphaListReleaseTestsResponse": {
1049 "description": "The response message for `ListReleaseTests`.",
1050 "id": "GoogleFirebaseAppdistroV1alphaListReleaseTestsResponse",
1051 "properties": {
1052 "nextPageToken": {
1053 "description": "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.",
1054 "type": "string"
1055 },
1056 "releaseTests": {
1057 "description": "The tests listed.",
1058 "items": {
1059 "$ref": "GoogleFirebaseAppdistroV1alphaReleaseTest"
1060 },
1061 "type": "array"
1062 }
1063 },
1064 "type": "object"
1065 },
1066 "GoogleFirebaseAppdistroV1alphaLoginCredential": {
1067 "description": "Login credential for automated tests",
1068 "id": "GoogleFirebaseAppdistroV1alphaLoginCredential",
1069 "properties": {
1070 "fieldHints": {
1071 "$ref": "GoogleFirebaseAppdistroV1alphaLoginCredentialFieldHints",
1072 "description": "Optional. Hints to the crawler for identifying input fields"
1073 },
1074 "google": {
1075 "description": "Optional. Are these credentials for Google?",
1076 "type": "boolean"
1077 },
1078 "password": {
1079 "description": "Optional. Password for automated tests",
1080 "type": "string"
1081 },
1082 "username": {
1083 "description": "Optional. Username for automated tests",
1084 "type": "string"
1085 }
1086 },
1087 "type": "object"
1088 },
1089 "GoogleFirebaseAppdistroV1alphaLoginCredentialFieldHints": {
1090 "description": "Hints to the crawler for identifying input fields",
1091 "id": "GoogleFirebaseAppdistroV1alphaLoginCredentialFieldHints",
1092 "properties": {
1093 "passwordResourceName": {
1094 "description": "Required. The Android resource name of the password UI element. For example, in Java: R.string.foo in xml: @string/foo Only the \"foo\" part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html",
1095 "type": "string"
1096 },
1097 "usernameResourceName": {
1098 "description": "Required. The Android resource name of the username UI element. For example, in Java: R.string.foo in xml: @string/foo Only the \"foo\" part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html",
1099 "type": "string"
1100 }
1101 },
1102 "type": "object"
1103 },
1104 "GoogleFirebaseAppdistroV1alphaProvisionAppResponse": {
1105 "id": "GoogleFirebaseAppdistroV1alphaProvisionAppResponse",
1106 "properties": {},
1107 "type": "object"
1108 },
1109 "GoogleFirebaseAppdistroV1alphaRelease": {
1110 "description": "Proto defining a release object",
1111 "id": "GoogleFirebaseAppdistroV1alphaRelease",
1112 "properties": {
1113 "buildVersion": {
1114 "description": "Release build version",
1115 "type": "string"
1116 },
1117 "displayVersion": {
1118 "description": "Release version",
1119 "type": "string"
1120 },
1121 "distributedAt": {
1122 "description": "Timestamp when the release was created",
1123 "format": "google-datetime",
1124 "type": "string"
1125 },
1126 "id": {
1127 "description": "Release Id",
1128 "type": "string"
1129 },
1130 "instanceId": {
1131 "description": "Instance id of the release",
1132 "type": "string"
1133 },
1134 "lastActivityAt": {
1135 "description": "Last activity timestamp",
1136 "format": "google-datetime",
1137 "type": "string"
1138 },
1139 "openInvitationCount": {
1140 "description": "Number of testers who have open invitations for the release",
1141 "format": "int32",
1142 "type": "integer"
1143 },
1144 "receivedAt": {
1145 "deprecated": true,
1146 "description": "unused. ",
1147 "format": "google-datetime",
1148 "type": "string"
1149 },
1150 "releaseNotesSummary": {
1151 "description": "Release notes summary",
1152 "type": "string"
1153 },
1154 "testerCount": {
1155 "description": "Count of testers added to the release",
1156 "format": "int32",
1157 "type": "integer"
1158 },
1159 "testerWithInstallCount": {
1160 "description": "Number of testers who have installed the release",
1161 "format": "int32",
1162 "type": "integer"
1163 }
1164 },
1165 "type": "object"
1166 },
1167 "GoogleFirebaseAppdistroV1alphaReleaseNotes": {
1168 "id": "GoogleFirebaseAppdistroV1alphaReleaseNotes",
1169 "properties": {
1170 "releaseNotes": {
1171 "type": "string"
1172 }
1173 },
1174 "type": "object"
1175 },
1176 "GoogleFirebaseAppdistroV1alphaReleaseTest": {
1177 "description": "The results of running an automated test on a release.",
1178 "id": "GoogleFirebaseAppdistroV1alphaReleaseTest",
1179 "properties": {
1180 "createTime": {
1181 "description": "Output only. Timestamp when the test was run.",
1182 "format": "google-datetime",
1183 "readOnly": true,
1184 "type": "string"
1185 },
1186 "deviceExecutions": {
1187 "description": "Required. The results of the test on each device.",
1188 "items": {
1189 "$ref": "GoogleFirebaseAppdistroV1alphaDeviceExecution"
1190 },
1191 "type": "array"
1192 },
1193 "loginCredential": {
1194 "$ref": "GoogleFirebaseAppdistroV1alphaLoginCredential",
1195 "description": "Optional. Input only. Login credentials for the test. Input only."
1196 },
1197 "name": {
1198 "description": "The name of the release test resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}/tests/{test_id}`",
1199 "type": "string"
1200 }
1201 },
1202 "type": "object"
1203 },
1204 "GoogleFirebaseAppdistroV1alphaRoboCrawler": {
1205 "description": "Configuration for Robo crawler",
1206 "id": "GoogleFirebaseAppdistroV1alphaRoboCrawler",
1207 "properties": {
1208 "loginCredential": {
1209 "$ref": "GoogleFirebaseAppdistroV1alphaLoginCredential",
1210 "description": "Optional. Login credential for automated tests"
1211 }
1212 },
1213 "type": "object"
1214 },
1215 "GoogleFirebaseAppdistroV1alphaRoboStats": {
1216 "description": "Statistics collected during a Robo test.",
1217 "id": "GoogleFirebaseAppdistroV1alphaRoboStats",
1218 "properties": {
1219 "actionsPerformed": {
1220 "description": "Output only. Number of actions that crawler performed.",
1221 "format": "int32",
1222 "readOnly": true,
1223 "type": "integer"
1224 },
1225 "crawlDuration": {
1226 "description": "Output only. Duration of crawl.",
1227 "format": "google-duration",
1228 "readOnly": true,
1229 "type": "string"
1230 },
1231 "distinctVisitedScreens": {
1232 "description": "Output only. Number of distinct screens visited.",
1233 "format": "int32",
1234 "readOnly": true,
1235 "type": "integer"
1236 },
1237 "mainActivityCrawlTimedOut": {
1238 "description": "Output only. Whether the main activity crawl timed out.",
1239 "readOnly": true,
1240 "type": "boolean"
1241 }
1242 },
1243 "type": "object"
1244 },
1245 "GoogleFirebaseAppdistroV1alphaTestConfig": {
1246 "description": "Configuration for automated tests",
1247 "id": "GoogleFirebaseAppdistroV1alphaTestConfig",
1248 "properties": {
1249 "name": {
1250 "description": "Identifier. The name of the test configuration resource. Format: `projects/{project_number}/apps/{app_id}/testConfig`",
1251 "type": "string"
1252 },
1253 "roboCrawler": {
1254 "$ref": "GoogleFirebaseAppdistroV1alphaRoboCrawler",
1255 "description": "Optional. Configuration for Robo crawler"
1256 },
1257 "testDevices": {
1258 "description": "Optional. Tests will be run on this list of devices",
1259 "items": {
1260 "$ref": "GoogleFirebaseAppdistroV1alphaTestDevice"
1261 },
1262 "type": "array"
1263 }
1264 },
1265 "type": "object"
1266 },
1267 "GoogleFirebaseAppdistroV1alphaTestDevice": {
1268 "description": "A device on which automated tests can be run.",
1269 "id": "GoogleFirebaseAppdistroV1alphaTestDevice",
1270 "properties": {
1271 "locale": {
1272 "description": "Optional. The locale of the device (e.g. \"en_US\" for US English) during the test.",
1273 "type": "string"
1274 },
1275 "model": {
1276 "description": "Required. The device model.",
1277 "type": "string"
1278 },
1279 "orientation": {
1280 "description": "Optional. The orientation of the device during the test.",
1281 "type": "string"
1282 },
1283 "version": {
1284 "description": "Required. The version of the device (API level on Android).",
1285 "type": "string"
1286 }
1287 },
1288 "type": "object"
1289 },
1290 "GoogleFirebaseAppdistroV1alphaTesterUdid": {
1291 "description": "The UDIDs of a tester's iOS device",
1292 "id": "GoogleFirebaseAppdistroV1alphaTesterUdid",
1293 "properties": {
1294 "name": {
1295 "description": "The name of the tester's device",
1296 "type": "string"
1297 },
1298 "platform": {
1299 "description": "The platform of the tester's device",
1300 "type": "string"
1301 },
1302 "udid": {
1303 "description": "The UDID of the tester's device",
1304 "type": "string"
1305 }
1306 },
1307 "type": "object"
1308 }
1309 },
1310 "servicePath": "",
1311 "title": "Firebase App Distribution API",
1312 "version": "v1alpha",
1313 "version_module": true
1314}View as plain text