@maxim_mazurok/gapi.client.firebase-v1beta1 0.1.20260317 → 0.2.20260317
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +123 -119
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -84,7 +84,7 @@ declare namespace gapi.client {
|
|
|
84
84
|
/** The SHA256 certificate hashes for the AndroidApp. */
|
|
85
85
|
sha256Hashes?: string[];
|
|
86
86
|
/** Output only. The lifecycle state of the App. */
|
|
87
|
-
state?:
|
|
87
|
+
state?: 'STATE_UNSPECIFIED' | 'ACTIVE' | 'DELETED';
|
|
88
88
|
}
|
|
89
89
|
interface AndroidAppConfig {
|
|
90
90
|
/** The contents of the JSON configuration file. */
|
|
@@ -121,9 +121,9 @@ declare namespace gapi.client {
|
|
|
121
121
|
/** Output only. Immutable. The platform-specific identifier of the App. *Note:* For most use cases, use `appId`, which is the canonical, globally unique identifier for referencing an App. This string is derived from a native identifier for each platform: `packageName` for an `AndroidApp`, `bundleId` for an `IosApp`, and `webId` for a `WebApp`. Its contents should be treated as opaque, as the native identifier format may change as platforms evolve. This string is only unique within a `FirebaseProject` and its associated Apps. */
|
|
122
122
|
namespace?: string;
|
|
123
123
|
/** The platform of the Firebase App. */
|
|
124
|
-
platform?:
|
|
124
|
+
platform?: 'PLATFORM_UNSPECIFIED' | 'IOS' | 'ANDROID' | 'WEB';
|
|
125
125
|
/** Output only. The lifecycle state of the App. */
|
|
126
|
-
state?:
|
|
126
|
+
state?: 'STATE_UNSPECIFIED' | 'ACTIVE' | 'DELETED';
|
|
127
127
|
}
|
|
128
128
|
interface FirebaseProject {
|
|
129
129
|
/** A set of user-defined annotations for the FirebaseProject. Learn more about annotations in Google's [AIP-128 standard](https://google.aip.dev/128#annotations). These annotations are intended solely for developers and client-side tools. Firebase services will not mutate this annotations set. */
|
|
@@ -141,7 +141,7 @@ declare namespace gapi.client {
|
|
|
141
141
|
/** Output only. **DEPRECATED.** _Auto-provisioning of these resources is changing, so this object no longer reliably provides information about the Project. Instead, retrieve information about each resource directly from its resource-specific API._ The default Firebase resources associated with the Project. */
|
|
142
142
|
resources?: DefaultResources;
|
|
143
143
|
/** Output only. The lifecycle state of the Project. */
|
|
144
|
-
state?:
|
|
144
|
+
state?: 'STATE_UNSPECIFIED' | 'ACTIVE' | 'DELETED';
|
|
145
145
|
}
|
|
146
146
|
interface IosApp {
|
|
147
147
|
/** The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the `IosApp`. Be aware that this value is the UID of the API key, _not_ the [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App's [configuration artifact](../../rest/v1beta1/projects.iosApps/getConfig). If `api_key_id` is not set in requests to [`iosApps.Create`](../../rest/v1beta1/projects.iosApps/create), then Firebase automatically associates an `api_key_id` with the `IosApp`. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, `api_key_id` cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated `IosApp`. We recommend using the [Google Cloud Console](https://console.cloud.google.com/apis/credentials) to manage API keys. */
|
|
@@ -163,7 +163,7 @@ declare namespace gapi.client {
|
|
|
163
163
|
/** Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`. */
|
|
164
164
|
projectId?: string;
|
|
165
165
|
/** Output only. The lifecycle state of the App. */
|
|
166
|
-
state?:
|
|
166
|
+
state?: 'STATE_UNSPECIFIED' | 'ACTIVE' | 'DELETED';
|
|
167
167
|
/** The Apple Developer Team ID associated with the App in the App Store. */
|
|
168
168
|
teamId?: string;
|
|
169
169
|
}
|
|
@@ -215,11 +215,15 @@ declare namespace gapi.client {
|
|
|
215
215
|
}
|
|
216
216
|
interface Location {
|
|
217
217
|
/** Products and services that are available in the location for default Google Cloud resources. */
|
|
218
|
-
features?:
|
|
218
|
+
features?:
|
|
219
|
+
| 'LOCATION_FEATURE_UNSPECIFIED'
|
|
220
|
+
| 'FIRESTORE'
|
|
221
|
+
| 'DEFAULT_STORAGE'
|
|
222
|
+
| 'FUNCTIONS'[];
|
|
219
223
|
/** The ID of the Project's location for default Google Cloud resources. It will be one of the available [Google App Engine locations](https://cloud.google.com/about/locations#region). */
|
|
220
224
|
locationId?: string;
|
|
221
225
|
/** Indicates whether the location for default Google Cloud resources is a [regional or multi-regional location](https://firebase.google.com/docs/projects/locations#types) for data replication. */
|
|
222
|
-
type?:
|
|
226
|
+
type?: 'LOCATION_TYPE_UNSPECIFIED' | 'REGIONAL' | 'MULTI_REGIONAL';
|
|
223
227
|
}
|
|
224
228
|
interface MessageSet {}
|
|
225
229
|
interface Operation {
|
|
@@ -289,7 +293,7 @@ declare namespace gapi.client {
|
|
|
289
293
|
}
|
|
290
294
|
interface ShaCertificate {
|
|
291
295
|
/** The type of SHA certificate encoded in the hash. */
|
|
292
|
-
certType?:
|
|
296
|
+
certType?: 'SHA_CERTIFICATE_TYPE_UNSPECIFIED' | 'SHA_1' | 'SHA_256';
|
|
293
297
|
/** The resource name of the ShaCertificate for the AndroidApp, in the format: projects/PROJECT_IDENTIFIER/androidApps/APP_ID/sha/SHA_HASH * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)). * SHA_HASH: the certificate hash for the App (see [`shaHash`](../projects.androidApps.sha#ShaCertificate.FIELDS.sha_hash)). */
|
|
294
298
|
name?: string;
|
|
295
299
|
/** The certificate hash for the `AndroidApp`. */
|
|
@@ -359,7 +363,7 @@ declare namespace gapi.client {
|
|
|
359
363
|
/** Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `WebApp`. */
|
|
360
364
|
projectId?: string;
|
|
361
365
|
/** Output only. The lifecycle state of the App. */
|
|
362
|
-
state?:
|
|
366
|
+
state?: 'STATE_UNSPECIFIED' | 'ACTIVE' | 'DELETED';
|
|
363
367
|
/** Output only. Immutable. A unique, Firebase-assigned identifier for the `WebApp`. This identifier is only used to populate the `namespace` value for the `WebApp`. For most use cases, use `appId` to identify or reference the App. The `webId` value is only unique within a `FirebaseProject` and its associated Apps. */
|
|
364
368
|
webId?: string;
|
|
365
369
|
}
|
|
@@ -393,11 +397,11 @@ declare namespace gapi.client {
|
|
|
393
397
|
/** Lists each [Google Cloud `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects) that can have Firebase resources added and Firebase services enabled. A Project will only be listed if: - The caller has sufficient [Google IAM](https://cloud.google.com/iam) permissions to call AddFirebase. - The Project is not already a FirebaseProject. - The Project is not in an Organization which has policies that prevent Firebase resources from being added. */
|
|
394
398
|
list(request?: {
|
|
395
399
|
/** V1 error format. */
|
|
396
|
-
'$.xgafv'?:
|
|
400
|
+
'$.xgafv'?: '1' | '2';
|
|
397
401
|
/** OAuth access token. */
|
|
398
402
|
access_token?: string;
|
|
399
403
|
/** Data format for response. */
|
|
400
|
-
alt?:
|
|
404
|
+
alt?: 'json' | 'media' | 'proto';
|
|
401
405
|
/** JSONP */
|
|
402
406
|
callback?: string;
|
|
403
407
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -424,11 +428,11 @@ declare namespace gapi.client {
|
|
|
424
428
|
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
425
429
|
get(request?: {
|
|
426
430
|
/** V1 error format. */
|
|
427
|
-
'$.xgafv'?:
|
|
431
|
+
'$.xgafv'?: '1' | '2';
|
|
428
432
|
/** OAuth access token. */
|
|
429
433
|
access_token?: string;
|
|
430
434
|
/** Data format for response. */
|
|
431
|
-
alt?:
|
|
435
|
+
alt?: 'json' | 'media' | 'proto';
|
|
432
436
|
/** JSONP */
|
|
433
437
|
callback?: string;
|
|
434
438
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -453,11 +457,11 @@ declare namespace gapi.client {
|
|
|
453
457
|
/** Adds a ShaCertificate to the specified AndroidApp. */
|
|
454
458
|
create(request: {
|
|
455
459
|
/** V1 error format. */
|
|
456
|
-
'$.xgafv'?:
|
|
460
|
+
'$.xgafv'?: '1' | '2';
|
|
457
461
|
/** OAuth access token. */
|
|
458
462
|
access_token?: string;
|
|
459
463
|
/** Data format for response. */
|
|
460
|
-
alt?:
|
|
464
|
+
alt?: 'json' | 'media' | 'proto';
|
|
461
465
|
/** JSONP */
|
|
462
466
|
callback?: string;
|
|
463
467
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -482,11 +486,11 @@ declare namespace gapi.client {
|
|
|
482
486
|
create(
|
|
483
487
|
request: {
|
|
484
488
|
/** V1 error format. */
|
|
485
|
-
'$.xgafv'?:
|
|
489
|
+
'$.xgafv'?: '1' | '2';
|
|
486
490
|
/** OAuth access token. */
|
|
487
491
|
access_token?: string;
|
|
488
492
|
/** Data format for response. */
|
|
489
|
-
alt?:
|
|
493
|
+
alt?: 'json' | 'media' | 'proto';
|
|
490
494
|
/** JSONP */
|
|
491
495
|
callback?: string;
|
|
492
496
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -511,11 +515,11 @@ declare namespace gapi.client {
|
|
|
511
515
|
/** Removes a ShaCertificate from the specified AndroidApp. */
|
|
512
516
|
delete(request?: {
|
|
513
517
|
/** V1 error format. */
|
|
514
|
-
'$.xgafv'?:
|
|
518
|
+
'$.xgafv'?: '1' | '2';
|
|
515
519
|
/** OAuth access token. */
|
|
516
520
|
access_token?: string;
|
|
517
521
|
/** Data format for response. */
|
|
518
|
-
alt?:
|
|
522
|
+
alt?: 'json' | 'media' | 'proto';
|
|
519
523
|
/** JSONP */
|
|
520
524
|
callback?: string;
|
|
521
525
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -538,11 +542,11 @@ declare namespace gapi.client {
|
|
|
538
542
|
/** Lists the SHA-1 and SHA-256 certificates for the specified AndroidApp. */
|
|
539
543
|
list(request?: {
|
|
540
544
|
/** V1 error format. */
|
|
541
|
-
'$.xgafv'?:
|
|
545
|
+
'$.xgafv'?: '1' | '2';
|
|
542
546
|
/** OAuth access token. */
|
|
543
547
|
access_token?: string;
|
|
544
548
|
/** Data format for response. */
|
|
545
|
-
alt?:
|
|
549
|
+
alt?: 'json' | 'media' | 'proto';
|
|
546
550
|
/** JSONP */
|
|
547
551
|
callback?: string;
|
|
548
552
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -567,11 +571,11 @@ declare namespace gapi.client {
|
|
|
567
571
|
/** Requests the creation of a new AndroidApp in the specified FirebaseProject. The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`. */
|
|
568
572
|
create(request: {
|
|
569
573
|
/** V1 error format. */
|
|
570
|
-
'$.xgafv'?:
|
|
574
|
+
'$.xgafv'?: '1' | '2';
|
|
571
575
|
/** OAuth access token. */
|
|
572
576
|
access_token?: string;
|
|
573
577
|
/** Data format for response. */
|
|
574
|
-
alt?:
|
|
578
|
+
alt?: 'json' | 'media' | 'proto';
|
|
575
579
|
/** JSONP */
|
|
576
580
|
callback?: string;
|
|
577
581
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -596,11 +600,11 @@ declare namespace gapi.client {
|
|
|
596
600
|
create(
|
|
597
601
|
request: {
|
|
598
602
|
/** V1 error format. */
|
|
599
|
-
'$.xgafv'?:
|
|
603
|
+
'$.xgafv'?: '1' | '2';
|
|
600
604
|
/** OAuth access token. */
|
|
601
605
|
access_token?: string;
|
|
602
606
|
/** Data format for response. */
|
|
603
|
-
alt?:
|
|
607
|
+
alt?: 'json' | 'media' | 'proto';
|
|
604
608
|
/** JSONP */
|
|
605
609
|
callback?: string;
|
|
606
610
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -625,11 +629,11 @@ declare namespace gapi.client {
|
|
|
625
629
|
/** Gets the specified AndroidApp. */
|
|
626
630
|
get(request?: {
|
|
627
631
|
/** V1 error format. */
|
|
628
|
-
'$.xgafv'?:
|
|
632
|
+
'$.xgafv'?: '1' | '2';
|
|
629
633
|
/** OAuth access token. */
|
|
630
634
|
access_token?: string;
|
|
631
635
|
/** Data format for response. */
|
|
632
|
-
alt?:
|
|
636
|
+
alt?: 'json' | 'media' | 'proto';
|
|
633
637
|
/** JSONP */
|
|
634
638
|
callback?: string;
|
|
635
639
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -652,11 +656,11 @@ declare namespace gapi.client {
|
|
|
652
656
|
/** Gets the configuration artifact associated with the specified AndroidApp. */
|
|
653
657
|
getConfig(request?: {
|
|
654
658
|
/** V1 error format. */
|
|
655
|
-
'$.xgafv'?:
|
|
659
|
+
'$.xgafv'?: '1' | '2';
|
|
656
660
|
/** OAuth access token. */
|
|
657
661
|
access_token?: string;
|
|
658
662
|
/** Data format for response. */
|
|
659
|
-
alt?:
|
|
663
|
+
alt?: 'json' | 'media' | 'proto';
|
|
660
664
|
/** JSONP */
|
|
661
665
|
callback?: string;
|
|
662
666
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -679,11 +683,11 @@ declare namespace gapi.client {
|
|
|
679
683
|
/** Lists each AndroidApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`. */
|
|
680
684
|
list(request?: {
|
|
681
685
|
/** V1 error format. */
|
|
682
|
-
'$.xgafv'?:
|
|
686
|
+
'$.xgafv'?: '1' | '2';
|
|
683
687
|
/** OAuth access token. */
|
|
684
688
|
access_token?: string;
|
|
685
689
|
/** Data format for response. */
|
|
686
|
-
alt?:
|
|
690
|
+
alt?: 'json' | 'media' | 'proto';
|
|
687
691
|
/** JSONP */
|
|
688
692
|
callback?: string;
|
|
689
693
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -712,11 +716,11 @@ declare namespace gapi.client {
|
|
|
712
716
|
/** Updates the attributes of the specified AndroidApp. */
|
|
713
717
|
patch(request: {
|
|
714
718
|
/** V1 error format. */
|
|
715
|
-
'$.xgafv'?:
|
|
719
|
+
'$.xgafv'?: '1' | '2';
|
|
716
720
|
/** OAuth access token. */
|
|
717
721
|
access_token?: string;
|
|
718
722
|
/** Data format for response. */
|
|
719
|
-
alt?:
|
|
723
|
+
alt?: 'json' | 'media' | 'proto';
|
|
720
724
|
/** JSONP */
|
|
721
725
|
callback?: string;
|
|
722
726
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -743,11 +747,11 @@ declare namespace gapi.client {
|
|
|
743
747
|
patch(
|
|
744
748
|
request: {
|
|
745
749
|
/** V1 error format. */
|
|
746
|
-
'$.xgafv'?:
|
|
750
|
+
'$.xgafv'?: '1' | '2';
|
|
747
751
|
/** OAuth access token. */
|
|
748
752
|
access_token?: string;
|
|
749
753
|
/** Data format for response. */
|
|
750
|
-
alt?:
|
|
754
|
+
alt?: 'json' | 'media' | 'proto';
|
|
751
755
|
/** JSONP */
|
|
752
756
|
callback?: string;
|
|
753
757
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -774,11 +778,11 @@ declare namespace gapi.client {
|
|
|
774
778
|
/** Removes the specified AndroidApp from the FirebaseProject. */
|
|
775
779
|
remove(request: {
|
|
776
780
|
/** V1 error format. */
|
|
777
|
-
'$.xgafv'?:
|
|
781
|
+
'$.xgafv'?: '1' | '2';
|
|
778
782
|
/** OAuth access token. */
|
|
779
783
|
access_token?: string;
|
|
780
784
|
/** Data format for response. */
|
|
781
|
-
alt?:
|
|
785
|
+
alt?: 'json' | 'media' | 'proto';
|
|
782
786
|
/** JSONP */
|
|
783
787
|
callback?: string;
|
|
784
788
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -803,11 +807,11 @@ declare namespace gapi.client {
|
|
|
803
807
|
remove(
|
|
804
808
|
request: {
|
|
805
809
|
/** V1 error format. */
|
|
806
|
-
'$.xgafv'?:
|
|
810
|
+
'$.xgafv'?: '1' | '2';
|
|
807
811
|
/** OAuth access token. */
|
|
808
812
|
access_token?: string;
|
|
809
813
|
/** Data format for response. */
|
|
810
|
-
alt?:
|
|
814
|
+
alt?: 'json' | 'media' | 'proto';
|
|
811
815
|
/** JSONP */
|
|
812
816
|
callback?: string;
|
|
813
817
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -832,11 +836,11 @@ declare namespace gapi.client {
|
|
|
832
836
|
/** Restores the specified AndroidApp to the FirebaseProject. */
|
|
833
837
|
undelete(request: {
|
|
834
838
|
/** V1 error format. */
|
|
835
|
-
'$.xgafv'?:
|
|
839
|
+
'$.xgafv'?: '1' | '2';
|
|
836
840
|
/** OAuth access token. */
|
|
837
841
|
access_token?: string;
|
|
838
842
|
/** Data format for response. */
|
|
839
|
-
alt?:
|
|
843
|
+
alt?: 'json' | 'media' | 'proto';
|
|
840
844
|
/** JSONP */
|
|
841
845
|
callback?: string;
|
|
842
846
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -861,11 +865,11 @@ declare namespace gapi.client {
|
|
|
861
865
|
undelete(
|
|
862
866
|
request: {
|
|
863
867
|
/** V1 error format. */
|
|
864
|
-
'$.xgafv'?:
|
|
868
|
+
'$.xgafv'?: '1' | '2';
|
|
865
869
|
/** OAuth access token. */
|
|
866
870
|
access_token?: string;
|
|
867
871
|
/** Data format for response. */
|
|
868
|
-
alt?:
|
|
872
|
+
alt?: 'json' | 'media' | 'proto';
|
|
869
873
|
/** JSONP */
|
|
870
874
|
callback?: string;
|
|
871
875
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -893,11 +897,11 @@ declare namespace gapi.client {
|
|
|
893
897
|
/** **DECOMMISSIONED.** **If called, this endpoint will return a 404 error.** _Instead, use the applicable resource-specific REST API (or associated documentation, as needed) to determine valid locations for each resource used in your Project._ Lists the valid ["locations for default Google Cloud resources"](https://firebase.google.com/docs/projects/locations#default-cloud-location) for the specified Project (including a FirebaseProject). One of these locations can be selected as the Project's location for default Google Cloud resources, which is the geographical location where the Project's resources associated with Google App Engine (such as the default Cloud Firestore instance) will be provisioned by default. However, if the location for default Google Cloud resources has already been set for the Project, then this setting cannot be changed. This call checks for any possible [location restrictions](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations) for the specified Project and, thus, might return a subset of all possible locations. To list all locations (regardless of any restrictions), call the endpoint without specifying a unique project identifier (that is, `/v1beta1/{parent=projects/-}/listAvailableLocations`). To call `ListAvailableLocations` with a specified project, a member must be at minimum a Viewer of the Project. Calls without a specified project do not require any specific project permissions. */
|
|
894
898
|
list(request?: {
|
|
895
899
|
/** V1 error format. */
|
|
896
|
-
'$.xgafv'?:
|
|
900
|
+
'$.xgafv'?: '1' | '2';
|
|
897
901
|
/** OAuth access token. */
|
|
898
902
|
access_token?: string;
|
|
899
903
|
/** Data format for response. */
|
|
900
|
-
alt?:
|
|
904
|
+
alt?: 'json' | 'media' | 'proto';
|
|
901
905
|
/** JSONP */
|
|
902
906
|
callback?: string;
|
|
903
907
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -926,11 +930,11 @@ declare namespace gapi.client {
|
|
|
926
930
|
/** **DECOMMISSIONED.** **If called, this endpoint will return a 404 error.** _Instead, use the applicable resource-specific REST API to set the location for each resource used in your Project._ Sets the ["location for default Google Cloud resources"](https://firebase.google.com/docs/projects/locations#default-cloud-location) for the specified FirebaseProject. This method creates a Google App Engine application with a [default Cloud Storage bucket](https://cloud.google.com/appengine/docs/standard/python/googlecloudstorageclient/setting-up-cloud-storage#activating_a_cloud_storage_bucket), located in the specified [`locationId`](#body.request_body.FIELDS.location_id). This location must be one of the available [App Engine locations](https://cloud.google.com/about/locations#region). After the location for default Google Cloud resources is finalized, or if it was already set, it cannot be changed. The location for default Google Cloud resources for the specified `FirebaseProject` might already be set because either the underlying Google Cloud `Project` already has an App Engine application or `FinalizeDefaultLocation` was previously called with a specified `locationId`. The result of this call is an [`Operation`](../../v1beta1/operations), which can be used to track the provisioning process. The [`response`](../../v1beta1/operations#Operation.FIELDS.response) type of the `Operation` is google.protobuf.Empty. The `Operation` can be polled by its `name` using GetOperation until `done` is true. When `done` is true, the `Operation` has either succeeded or failed. If the `Operation` has succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) will be set to a google.protobuf.Empty; if the `Operation` has failed, its `error` will be set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation. All fields listed in the [request body](#request-body) are required. To call `FinalizeDefaultLocation`, a member must be an Owner of the Project. */
|
|
927
931
|
finalize(request: {
|
|
928
932
|
/** V1 error format. */
|
|
929
|
-
'$.xgafv'?:
|
|
933
|
+
'$.xgafv'?: '1' | '2';
|
|
930
934
|
/** OAuth access token. */
|
|
931
935
|
access_token?: string;
|
|
932
936
|
/** Data format for response. */
|
|
933
|
-
alt?:
|
|
937
|
+
alt?: 'json' | 'media' | 'proto';
|
|
934
938
|
/** JSONP */
|
|
935
939
|
callback?: string;
|
|
936
940
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -955,11 +959,11 @@ declare namespace gapi.client {
|
|
|
955
959
|
finalize(
|
|
956
960
|
request: {
|
|
957
961
|
/** V1 error format. */
|
|
958
|
-
'$.xgafv'?:
|
|
962
|
+
'$.xgafv'?: '1' | '2';
|
|
959
963
|
/** OAuth access token. */
|
|
960
964
|
access_token?: string;
|
|
961
965
|
/** Data format for response. */
|
|
962
|
-
alt?:
|
|
966
|
+
alt?: 'json' | 'media' | 'proto';
|
|
963
967
|
/** JSONP */
|
|
964
968
|
callback?: string;
|
|
965
969
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -986,11 +990,11 @@ declare namespace gapi.client {
|
|
|
986
990
|
/** Requests the creation of a new IosApp in the specified FirebaseProject. The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`. */
|
|
987
991
|
create(request: {
|
|
988
992
|
/** V1 error format. */
|
|
989
|
-
'$.xgafv'?:
|
|
993
|
+
'$.xgafv'?: '1' | '2';
|
|
990
994
|
/** OAuth access token. */
|
|
991
995
|
access_token?: string;
|
|
992
996
|
/** Data format for response. */
|
|
993
|
-
alt?:
|
|
997
|
+
alt?: 'json' | 'media' | 'proto';
|
|
994
998
|
/** JSONP */
|
|
995
999
|
callback?: string;
|
|
996
1000
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1015,11 +1019,11 @@ declare namespace gapi.client {
|
|
|
1015
1019
|
create(
|
|
1016
1020
|
request: {
|
|
1017
1021
|
/** V1 error format. */
|
|
1018
|
-
'$.xgafv'?:
|
|
1022
|
+
'$.xgafv'?: '1' | '2';
|
|
1019
1023
|
/** OAuth access token. */
|
|
1020
1024
|
access_token?: string;
|
|
1021
1025
|
/** Data format for response. */
|
|
1022
|
-
alt?:
|
|
1026
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1023
1027
|
/** JSONP */
|
|
1024
1028
|
callback?: string;
|
|
1025
1029
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1044,11 +1048,11 @@ declare namespace gapi.client {
|
|
|
1044
1048
|
/** Gets the specified IosApp. */
|
|
1045
1049
|
get(request?: {
|
|
1046
1050
|
/** V1 error format. */
|
|
1047
|
-
'$.xgafv'?:
|
|
1051
|
+
'$.xgafv'?: '1' | '2';
|
|
1048
1052
|
/** OAuth access token. */
|
|
1049
1053
|
access_token?: string;
|
|
1050
1054
|
/** Data format for response. */
|
|
1051
|
-
alt?:
|
|
1055
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1052
1056
|
/** JSONP */
|
|
1053
1057
|
callback?: string;
|
|
1054
1058
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1071,11 +1075,11 @@ declare namespace gapi.client {
|
|
|
1071
1075
|
/** Gets the configuration artifact associated with the specified IosApp. */
|
|
1072
1076
|
getConfig(request?: {
|
|
1073
1077
|
/** V1 error format. */
|
|
1074
|
-
'$.xgafv'?:
|
|
1078
|
+
'$.xgafv'?: '1' | '2';
|
|
1075
1079
|
/** OAuth access token. */
|
|
1076
1080
|
access_token?: string;
|
|
1077
1081
|
/** Data format for response. */
|
|
1078
|
-
alt?:
|
|
1082
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1079
1083
|
/** JSONP */
|
|
1080
1084
|
callback?: string;
|
|
1081
1085
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1098,11 +1102,11 @@ declare namespace gapi.client {
|
|
|
1098
1102
|
/** Lists each IosApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`. */
|
|
1099
1103
|
list(request?: {
|
|
1100
1104
|
/** V1 error format. */
|
|
1101
|
-
'$.xgafv'?:
|
|
1105
|
+
'$.xgafv'?: '1' | '2';
|
|
1102
1106
|
/** OAuth access token. */
|
|
1103
1107
|
access_token?: string;
|
|
1104
1108
|
/** Data format for response. */
|
|
1105
|
-
alt?:
|
|
1109
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1106
1110
|
/** JSONP */
|
|
1107
1111
|
callback?: string;
|
|
1108
1112
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1131,11 +1135,11 @@ declare namespace gapi.client {
|
|
|
1131
1135
|
/** Updates the attributes of the specified IosApp. */
|
|
1132
1136
|
patch(request: {
|
|
1133
1137
|
/** V1 error format. */
|
|
1134
|
-
'$.xgafv'?:
|
|
1138
|
+
'$.xgafv'?: '1' | '2';
|
|
1135
1139
|
/** OAuth access token. */
|
|
1136
1140
|
access_token?: string;
|
|
1137
1141
|
/** Data format for response. */
|
|
1138
|
-
alt?:
|
|
1142
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1139
1143
|
/** JSONP */
|
|
1140
1144
|
callback?: string;
|
|
1141
1145
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1162,11 +1166,11 @@ declare namespace gapi.client {
|
|
|
1162
1166
|
patch(
|
|
1163
1167
|
request: {
|
|
1164
1168
|
/** V1 error format. */
|
|
1165
|
-
'$.xgafv'?:
|
|
1169
|
+
'$.xgafv'?: '1' | '2';
|
|
1166
1170
|
/** OAuth access token. */
|
|
1167
1171
|
access_token?: string;
|
|
1168
1172
|
/** Data format for response. */
|
|
1169
|
-
alt?:
|
|
1173
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1170
1174
|
/** JSONP */
|
|
1171
1175
|
callback?: string;
|
|
1172
1176
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1193,11 +1197,11 @@ declare namespace gapi.client {
|
|
|
1193
1197
|
/** Removes the specified IosApp from the FirebaseProject. */
|
|
1194
1198
|
remove(request: {
|
|
1195
1199
|
/** V1 error format. */
|
|
1196
|
-
'$.xgafv'?:
|
|
1200
|
+
'$.xgafv'?: '1' | '2';
|
|
1197
1201
|
/** OAuth access token. */
|
|
1198
1202
|
access_token?: string;
|
|
1199
1203
|
/** Data format for response. */
|
|
1200
|
-
alt?:
|
|
1204
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1201
1205
|
/** JSONP */
|
|
1202
1206
|
callback?: string;
|
|
1203
1207
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1222,11 +1226,11 @@ declare namespace gapi.client {
|
|
|
1222
1226
|
remove(
|
|
1223
1227
|
request: {
|
|
1224
1228
|
/** V1 error format. */
|
|
1225
|
-
'$.xgafv'?:
|
|
1229
|
+
'$.xgafv'?: '1' | '2';
|
|
1226
1230
|
/** OAuth access token. */
|
|
1227
1231
|
access_token?: string;
|
|
1228
1232
|
/** Data format for response. */
|
|
1229
|
-
alt?:
|
|
1233
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1230
1234
|
/** JSONP */
|
|
1231
1235
|
callback?: string;
|
|
1232
1236
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1251,11 +1255,11 @@ declare namespace gapi.client {
|
|
|
1251
1255
|
/** Restores the specified IosApp to the FirebaseProject. */
|
|
1252
1256
|
undelete(request: {
|
|
1253
1257
|
/** V1 error format. */
|
|
1254
|
-
'$.xgafv'?:
|
|
1258
|
+
'$.xgafv'?: '1' | '2';
|
|
1255
1259
|
/** OAuth access token. */
|
|
1256
1260
|
access_token?: string;
|
|
1257
1261
|
/** Data format for response. */
|
|
1258
|
-
alt?:
|
|
1262
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1259
1263
|
/** JSONP */
|
|
1260
1264
|
callback?: string;
|
|
1261
1265
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1280,11 +1284,11 @@ declare namespace gapi.client {
|
|
|
1280
1284
|
undelete(
|
|
1281
1285
|
request: {
|
|
1282
1286
|
/** V1 error format. */
|
|
1283
|
-
'$.xgafv'?:
|
|
1287
|
+
'$.xgafv'?: '1' | '2';
|
|
1284
1288
|
/** OAuth access token. */
|
|
1285
1289
|
access_token?: string;
|
|
1286
1290
|
/** Data format for response. */
|
|
1287
|
-
alt?:
|
|
1291
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1288
1292
|
/** JSONP */
|
|
1289
1293
|
callback?: string;
|
|
1290
1294
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1311,11 +1315,11 @@ declare namespace gapi.client {
|
|
|
1311
1315
|
/** Requests the creation of a new WebApp in the specified FirebaseProject. The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`. */
|
|
1312
1316
|
create(request: {
|
|
1313
1317
|
/** V1 error format. */
|
|
1314
|
-
'$.xgafv'?:
|
|
1318
|
+
'$.xgafv'?: '1' | '2';
|
|
1315
1319
|
/** OAuth access token. */
|
|
1316
1320
|
access_token?: string;
|
|
1317
1321
|
/** Data format for response. */
|
|
1318
|
-
alt?:
|
|
1322
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1319
1323
|
/** JSONP */
|
|
1320
1324
|
callback?: string;
|
|
1321
1325
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1340,11 +1344,11 @@ declare namespace gapi.client {
|
|
|
1340
1344
|
create(
|
|
1341
1345
|
request: {
|
|
1342
1346
|
/** V1 error format. */
|
|
1343
|
-
'$.xgafv'?:
|
|
1347
|
+
'$.xgafv'?: '1' | '2';
|
|
1344
1348
|
/** OAuth access token. */
|
|
1345
1349
|
access_token?: string;
|
|
1346
1350
|
/** Data format for response. */
|
|
1347
|
-
alt?:
|
|
1351
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1348
1352
|
/** JSONP */
|
|
1349
1353
|
callback?: string;
|
|
1350
1354
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1369,11 +1373,11 @@ declare namespace gapi.client {
|
|
|
1369
1373
|
/** Gets the specified WebApp. */
|
|
1370
1374
|
get(request?: {
|
|
1371
1375
|
/** V1 error format. */
|
|
1372
|
-
'$.xgafv'?:
|
|
1376
|
+
'$.xgafv'?: '1' | '2';
|
|
1373
1377
|
/** OAuth access token. */
|
|
1374
1378
|
access_token?: string;
|
|
1375
1379
|
/** Data format for response. */
|
|
1376
|
-
alt?:
|
|
1380
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1377
1381
|
/** JSONP */
|
|
1378
1382
|
callback?: string;
|
|
1379
1383
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1396,11 +1400,11 @@ declare namespace gapi.client {
|
|
|
1396
1400
|
/** Gets the configuration artifact associated with the specified WebApp. */
|
|
1397
1401
|
getConfig(request?: {
|
|
1398
1402
|
/** V1 error format. */
|
|
1399
|
-
'$.xgafv'?:
|
|
1403
|
+
'$.xgafv'?: '1' | '2';
|
|
1400
1404
|
/** OAuth access token. */
|
|
1401
1405
|
access_token?: string;
|
|
1402
1406
|
/** Data format for response. */
|
|
1403
|
-
alt?:
|
|
1407
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1404
1408
|
/** JSONP */
|
|
1405
1409
|
callback?: string;
|
|
1406
1410
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1423,11 +1427,11 @@ declare namespace gapi.client {
|
|
|
1423
1427
|
/** Lists each WebApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`. */
|
|
1424
1428
|
list(request?: {
|
|
1425
1429
|
/** V1 error format. */
|
|
1426
|
-
'$.xgafv'?:
|
|
1430
|
+
'$.xgafv'?: '1' | '2';
|
|
1427
1431
|
/** OAuth access token. */
|
|
1428
1432
|
access_token?: string;
|
|
1429
1433
|
/** Data format for response. */
|
|
1430
|
-
alt?:
|
|
1434
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1431
1435
|
/** JSONP */
|
|
1432
1436
|
callback?: string;
|
|
1433
1437
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1456,11 +1460,11 @@ declare namespace gapi.client {
|
|
|
1456
1460
|
/** Updates the attributes of the specified WebApp. */
|
|
1457
1461
|
patch(request: {
|
|
1458
1462
|
/** V1 error format. */
|
|
1459
|
-
'$.xgafv'?:
|
|
1463
|
+
'$.xgafv'?: '1' | '2';
|
|
1460
1464
|
/** OAuth access token. */
|
|
1461
1465
|
access_token?: string;
|
|
1462
1466
|
/** Data format for response. */
|
|
1463
|
-
alt?:
|
|
1467
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1464
1468
|
/** JSONP */
|
|
1465
1469
|
callback?: string;
|
|
1466
1470
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1487,11 +1491,11 @@ declare namespace gapi.client {
|
|
|
1487
1491
|
patch(
|
|
1488
1492
|
request: {
|
|
1489
1493
|
/** V1 error format. */
|
|
1490
|
-
'$.xgafv'?:
|
|
1494
|
+
'$.xgafv'?: '1' | '2';
|
|
1491
1495
|
/** OAuth access token. */
|
|
1492
1496
|
access_token?: string;
|
|
1493
1497
|
/** Data format for response. */
|
|
1494
|
-
alt?:
|
|
1498
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1495
1499
|
/** JSONP */
|
|
1496
1500
|
callback?: string;
|
|
1497
1501
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1518,11 +1522,11 @@ declare namespace gapi.client {
|
|
|
1518
1522
|
/** Removes the specified WebApp from the FirebaseProject. */
|
|
1519
1523
|
remove(request: {
|
|
1520
1524
|
/** V1 error format. */
|
|
1521
|
-
'$.xgafv'?:
|
|
1525
|
+
'$.xgafv'?: '1' | '2';
|
|
1522
1526
|
/** OAuth access token. */
|
|
1523
1527
|
access_token?: string;
|
|
1524
1528
|
/** Data format for response. */
|
|
1525
|
-
alt?:
|
|
1529
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1526
1530
|
/** JSONP */
|
|
1527
1531
|
callback?: string;
|
|
1528
1532
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1547,11 +1551,11 @@ declare namespace gapi.client {
|
|
|
1547
1551
|
remove(
|
|
1548
1552
|
request: {
|
|
1549
1553
|
/** V1 error format. */
|
|
1550
|
-
'$.xgafv'?:
|
|
1554
|
+
'$.xgafv'?: '1' | '2';
|
|
1551
1555
|
/** OAuth access token. */
|
|
1552
1556
|
access_token?: string;
|
|
1553
1557
|
/** Data format for response. */
|
|
1554
|
-
alt?:
|
|
1558
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1555
1559
|
/** JSONP */
|
|
1556
1560
|
callback?: string;
|
|
1557
1561
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1576,11 +1580,11 @@ declare namespace gapi.client {
|
|
|
1576
1580
|
/** Restores the specified WebApp to the FirebaseProject. */
|
|
1577
1581
|
undelete(request: {
|
|
1578
1582
|
/** V1 error format. */
|
|
1579
|
-
'$.xgafv'?:
|
|
1583
|
+
'$.xgafv'?: '1' | '2';
|
|
1580
1584
|
/** OAuth access token. */
|
|
1581
1585
|
access_token?: string;
|
|
1582
1586
|
/** Data format for response. */
|
|
1583
|
-
alt?:
|
|
1587
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1584
1588
|
/** JSONP */
|
|
1585
1589
|
callback?: string;
|
|
1586
1590
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1605,11 +1609,11 @@ declare namespace gapi.client {
|
|
|
1605
1609
|
undelete(
|
|
1606
1610
|
request: {
|
|
1607
1611
|
/** V1 error format. */
|
|
1608
|
-
'$.xgafv'?:
|
|
1612
|
+
'$.xgafv'?: '1' | '2';
|
|
1609
1613
|
/** OAuth access token. */
|
|
1610
1614
|
access_token?: string;
|
|
1611
1615
|
/** Data format for response. */
|
|
1612
|
-
alt?:
|
|
1616
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1613
1617
|
/** JSONP */
|
|
1614
1618
|
callback?: string;
|
|
1615
1619
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1636,11 +1640,11 @@ declare namespace gapi.client {
|
|
|
1636
1640
|
/** Adds Firebase resources and enables Firebase services in the specified existing [Google Cloud `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects). Since a FirebaseProject is actually also a Google Cloud `Project`, a `FirebaseProject` has the same underlying Google Cloud identifiers (`projectNumber` and `projectId`). This allows for easy interop with Google APIs. The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to a FirebaseProject; if the `Operation` failed, its [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation. This method does not modify any billing account information on the underlying Google Cloud `Project`. To call `AddFirebase`, a project member or service account must have the following permissions (the IAM roles of Editor and Owner contain these permissions): `firebase.projects.update`, `resourcemanager.projects.get`, `serviceusage.services.enable`, and `serviceusage.services.get`. */
|
|
1637
1641
|
addFirebase(request: {
|
|
1638
1642
|
/** V1 error format. */
|
|
1639
|
-
'$.xgafv'?:
|
|
1643
|
+
'$.xgafv'?: '1' | '2';
|
|
1640
1644
|
/** OAuth access token. */
|
|
1641
1645
|
access_token?: string;
|
|
1642
1646
|
/** Data format for response. */
|
|
1643
|
-
alt?:
|
|
1647
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1644
1648
|
/** JSONP */
|
|
1645
1649
|
callback?: string;
|
|
1646
1650
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1665,11 +1669,11 @@ declare namespace gapi.client {
|
|
|
1665
1669
|
addFirebase(
|
|
1666
1670
|
request: {
|
|
1667
1671
|
/** V1 error format. */
|
|
1668
|
-
'$.xgafv'?:
|
|
1672
|
+
'$.xgafv'?: '1' | '2';
|
|
1669
1673
|
/** OAuth access token. */
|
|
1670
1674
|
access_token?: string;
|
|
1671
1675
|
/** Data format for response. */
|
|
1672
|
-
alt?:
|
|
1676
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1673
1677
|
/** JSONP */
|
|
1674
1678
|
callback?: string;
|
|
1675
1679
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1694,11 +1698,11 @@ declare namespace gapi.client {
|
|
|
1694
1698
|
/** Links the specified FirebaseProject with an existing [Google Analytics account](http://www.google.com/analytics/). Using this call, you can either: - Specify an `analyticsAccountId` to provision a new Google Analytics property within the specified account and associate the new property with the `FirebaseProject`. - Specify an existing `analyticsPropertyId` to associate the property with the `FirebaseProject`. Note that when you call `AddGoogleAnalytics`: 1. The first check determines if any existing data streams in the Google Analytics property correspond to any existing Firebase Apps in the `FirebaseProject` (based on the `packageName` or `bundleId` associated with the data stream). Then, as applicable, the data streams and apps are linked. Note that this auto-linking only applies to `AndroidApps` and `IosApps`. 2. If no corresponding data streams are found for the Firebase Apps, new data streams are provisioned in the Google Analytics property for each of the Firebase Apps. Note that a new data stream is always provisioned for a Web App even if it was previously associated with a data stream in the Analytics property. Learn more about the hierarchy and structure of Google Analytics accounts in the [Analytics documentation](https://support.google.com/analytics/answer/9303323). The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to an AnalyticsDetails; if the `Operation` failed, its [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a google.rpc.Status. To call `AddGoogleAnalytics`, a project member must be an Owner for the existing `FirebaseProject` and have the [`Edit` permission](https://support.google.com/analytics/answer/2884495) for the Google Analytics account. If the `FirebaseProject` already has Google Analytics enabled, and you call `AddGoogleAnalytics` using an `analyticsPropertyId` that's different from the currently associated property, then the call will fail. Analytics may have already been enabled in the Firebase console or by specifying `timeZone` and `regionCode` in the call to [`AddFirebase`](../../v1beta1/projects/addFirebase). */
|
|
1695
1699
|
addGoogleAnalytics(request: {
|
|
1696
1700
|
/** V1 error format. */
|
|
1697
|
-
'$.xgafv'?:
|
|
1701
|
+
'$.xgafv'?: '1' | '2';
|
|
1698
1702
|
/** OAuth access token. */
|
|
1699
1703
|
access_token?: string;
|
|
1700
1704
|
/** Data format for response. */
|
|
1701
|
-
alt?:
|
|
1705
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1702
1706
|
/** JSONP */
|
|
1703
1707
|
callback?: string;
|
|
1704
1708
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1723,11 +1727,11 @@ declare namespace gapi.client {
|
|
|
1723
1727
|
addGoogleAnalytics(
|
|
1724
1728
|
request: {
|
|
1725
1729
|
/** V1 error format. */
|
|
1726
|
-
'$.xgafv'?:
|
|
1730
|
+
'$.xgafv'?: '1' | '2';
|
|
1727
1731
|
/** OAuth access token. */
|
|
1728
1732
|
access_token?: string;
|
|
1729
1733
|
/** Data format for response. */
|
|
1730
|
-
alt?:
|
|
1734
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1731
1735
|
/** JSONP */
|
|
1732
1736
|
callback?: string;
|
|
1733
1737
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1752,11 +1756,11 @@ declare namespace gapi.client {
|
|
|
1752
1756
|
/** Gets the specified FirebaseProject. */
|
|
1753
1757
|
get(request?: {
|
|
1754
1758
|
/** V1 error format. */
|
|
1755
|
-
'$.xgafv'?:
|
|
1759
|
+
'$.xgafv'?: '1' | '2';
|
|
1756
1760
|
/** OAuth access token. */
|
|
1757
1761
|
access_token?: string;
|
|
1758
1762
|
/** Data format for response. */
|
|
1759
|
-
alt?:
|
|
1763
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1760
1764
|
/** JSONP */
|
|
1761
1765
|
callback?: string;
|
|
1762
1766
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1779,11 +1783,11 @@ declare namespace gapi.client {
|
|
|
1779
1783
|
/** Gets the configuration artifact associated with the specified FirebaseProject, which can be used by servers to simplify initialization. Typically, this configuration is used with the Firebase Admin SDK [initializeApp](https://firebase.google.com/docs/admin/setup#initialize_the_sdk) command. */
|
|
1780
1784
|
getAdminSdkConfig(request?: {
|
|
1781
1785
|
/** V1 error format. */
|
|
1782
|
-
'$.xgafv'?:
|
|
1786
|
+
'$.xgafv'?: '1' | '2';
|
|
1783
1787
|
/** OAuth access token. */
|
|
1784
1788
|
access_token?: string;
|
|
1785
1789
|
/** Data format for response. */
|
|
1786
|
-
alt?:
|
|
1790
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1787
1791
|
/** JSONP */
|
|
1788
1792
|
callback?: string;
|
|
1789
1793
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1806,11 +1810,11 @@ declare namespace gapi.client {
|
|
|
1806
1810
|
/** Gets the Google Analytics details currently associated with the specified FirebaseProject. If the `FirebaseProject` is not yet linked to Google Analytics, then the response to `GetAnalyticsDetails` is `NOT_FOUND`. */
|
|
1807
1811
|
getAnalyticsDetails(request?: {
|
|
1808
1812
|
/** V1 error format. */
|
|
1809
|
-
'$.xgafv'?:
|
|
1813
|
+
'$.xgafv'?: '1' | '2';
|
|
1810
1814
|
/** OAuth access token. */
|
|
1811
1815
|
access_token?: string;
|
|
1812
1816
|
/** Data format for response. */
|
|
1813
|
-
alt?:
|
|
1817
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1814
1818
|
/** JSONP */
|
|
1815
1819
|
callback?: string;
|
|
1816
1820
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1833,11 +1837,11 @@ declare namespace gapi.client {
|
|
|
1833
1837
|
/** Lists each FirebaseProject accessible to the caller. The elements are returned in no particular order, but they will be a consistent view of the Projects when additional requests are made with a `pageToken`. This method is eventually consistent with Project mutations, which means newly provisioned Projects and recent modifications to existing Projects might not be reflected in the set of Projects. The list will include only ACTIVE Projects. Use GetFirebaseProject for consistent reads as well as for additional Project details. */
|
|
1834
1838
|
list(request?: {
|
|
1835
1839
|
/** V1 error format. */
|
|
1836
|
-
'$.xgafv'?:
|
|
1840
|
+
'$.xgafv'?: '1' | '2';
|
|
1837
1841
|
/** OAuth access token. */
|
|
1838
1842
|
access_token?: string;
|
|
1839
1843
|
/** Data format for response. */
|
|
1840
|
-
alt?:
|
|
1844
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1841
1845
|
/** JSONP */
|
|
1842
1846
|
callback?: string;
|
|
1843
1847
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1864,11 +1868,11 @@ declare namespace gapi.client {
|
|
|
1864
1868
|
/** Updates the attributes of the specified FirebaseProject. All [query parameters](#query-parameters) are required. */
|
|
1865
1869
|
patch(request: {
|
|
1866
1870
|
/** V1 error format. */
|
|
1867
|
-
'$.xgafv'?:
|
|
1871
|
+
'$.xgafv'?: '1' | '2';
|
|
1868
1872
|
/** OAuth access token. */
|
|
1869
1873
|
access_token?: string;
|
|
1870
1874
|
/** Data format for response. */
|
|
1871
|
-
alt?:
|
|
1875
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1872
1876
|
/** JSONP */
|
|
1873
1877
|
callback?: string;
|
|
1874
1878
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1895,11 +1899,11 @@ declare namespace gapi.client {
|
|
|
1895
1899
|
patch(
|
|
1896
1900
|
request: {
|
|
1897
1901
|
/** V1 error format. */
|
|
1898
|
-
'$.xgafv'?:
|
|
1902
|
+
'$.xgafv'?: '1' | '2';
|
|
1899
1903
|
/** OAuth access token. */
|
|
1900
1904
|
access_token?: string;
|
|
1901
1905
|
/** Data format for response. */
|
|
1902
|
-
alt?:
|
|
1906
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1903
1907
|
/** JSONP */
|
|
1904
1908
|
callback?: string;
|
|
1905
1909
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1926,11 +1930,11 @@ declare namespace gapi.client {
|
|
|
1926
1930
|
/** Unlinks the specified FirebaseProject from its Google Analytics account. This call removes the association of the specified `FirebaseProject` with its current Google Analytics property. However, this call does not delete the Google Analytics resources, such as the Google Analytics property or any data streams. These resources may be re-associated later to the `FirebaseProject` by calling [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) and specifying the same `analyticsPropertyId`. For Android Apps and iOS Apps, this call re-links data streams with their corresponding apps. However, for Web Apps, this call provisions a *new* data stream for each Web App. To call `RemoveAnalytics`, a project member must be an Owner for the `FirebaseProject`. */
|
|
1927
1931
|
removeAnalytics(request: {
|
|
1928
1932
|
/** V1 error format. */
|
|
1929
|
-
'$.xgafv'?:
|
|
1933
|
+
'$.xgafv'?: '1' | '2';
|
|
1930
1934
|
/** OAuth access token. */
|
|
1931
1935
|
access_token?: string;
|
|
1932
1936
|
/** Data format for response. */
|
|
1933
|
-
alt?:
|
|
1937
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1934
1938
|
/** JSONP */
|
|
1935
1939
|
callback?: string;
|
|
1936
1940
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1955,11 +1959,11 @@ declare namespace gapi.client {
|
|
|
1955
1959
|
removeAnalytics(
|
|
1956
1960
|
request: {
|
|
1957
1961
|
/** V1 error format. */
|
|
1958
|
-
'$.xgafv'?:
|
|
1962
|
+
'$.xgafv'?: '1' | '2';
|
|
1959
1963
|
/** OAuth access token. */
|
|
1960
1964
|
access_token?: string;
|
|
1961
1965
|
/** Data format for response. */
|
|
1962
|
-
alt?:
|
|
1966
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1963
1967
|
/** JSONP */
|
|
1964
1968
|
callback?: string;
|
|
1965
1969
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1984,11 +1988,11 @@ declare namespace gapi.client {
|
|
|
1984
1988
|
/** Lists all available Apps for the specified FirebaseProject. This is a convenience method. Typically, interaction with an App should be done using the platform-specific service, but some tool use-cases require a summary of all known Apps (such as for App selector interfaces). */
|
|
1985
1989
|
searchApps(request?: {
|
|
1986
1990
|
/** V1 error format. */
|
|
1987
|
-
'$.xgafv'?:
|
|
1991
|
+
'$.xgafv'?: '1' | '2';
|
|
1988
1992
|
/** OAuth access token. */
|
|
1989
1993
|
access_token?: string;
|
|
1990
1994
|
/** Data format for response. */
|
|
1991
|
-
alt?:
|
|
1995
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1992
1996
|
/** JSONP */
|
|
1993
1997
|
callback?: string;
|
|
1994
1998
|
/** Selector specifying which fields to include in a partial response. */
|