From 635495658e8682d0d3a2e56e18e6d8bcca0617ea Mon Sep 17 00:00:00 2001 From: yoshi-automation Date: Fri, 10 Jul 2020 04:25:01 -0700 Subject: [PATCH] fix(firebase): update the API #### firebase:v1beta1 The following keys were changed: - resources.projects.methods.addFirebase.description - resources.projects.methods.addFirebase.parameters.project.description - resources.projects.methods.addGoogleAnalytics.parameters.parent.description - resources.projects.methods.get.parameters.name.description - resources.projects.methods.getAdminSdkConfig.parameters.name.description - resources.projects.methods.getAnalyticsDetails.parameters.name.description - resources.projects.methods.removeAnalytics.parameters.parent.description - resources.projects.methods.searchApps.parameters.parent.description - resources.projects.resources.androidApps.methods.create.parameters.parent.description - resources.projects.resources.androidApps.methods.get.parameters.name.description - resources.projects.resources.androidApps.methods.getConfig.parameters.name.description - resources.projects.resources.androidApps.methods.list.parameters.parent.description - resources.projects.resources.androidApps.methods.patch.parameters.updateMask.description - resources.projects.resources.androidApps.resources.sha.methods.create.parameters.parent.description - resources.projects.resources.androidApps.resources.sha.methods.delete.parameters.name.description - resources.projects.resources.androidApps.resources.sha.methods.list.parameters.parent.description - resources.projects.resources.availableLocations.methods.list.description - resources.projects.resources.availableLocations.methods.list.parameters.parent.description - resources.projects.resources.defaultLocation.methods.finalize.parameters.parent.description - resources.projects.resources.iosApps.methods.create.parameters.parent.description - resources.projects.resources.iosApps.methods.get.parameters.name.description - resources.projects.resources.iosApps.methods.getConfig.parameters.name.description - resources.projects.resources.iosApps.methods.list.parameters.parent.description - resources.projects.resources.webApps.methods.create.parameters.parent.description - resources.projects.resources.webApps.methods.get.parameters.name.description - resources.projects.resources.webApps.methods.getConfig.parameters.name.description - resources.projects.resources.webApps.methods.list.parameters.parent.description - schemas.ProjectInfo.properties.project.description - schemas.ShaCertificate.properties.name.description - schemas.StreamMapping.properties.app.description --- discovery/firebase-v1beta1.json | 62 +++++----- src/apis/firebase/v1beta1.ts | 196 ++++++++++++++++---------------- 2 files changed, 129 insertions(+), 129 deletions(-) diff --git a/discovery/firebase-v1beta1.json b/discovery/firebase-v1beta1.json index 3f969a71843..1fa16695e93 100644 --- a/discovery/firebase-v1beta1.json +++ b/discovery/firebase-v1beta1.json @@ -183,7 +183,7 @@ "projects": { "methods": { "addFirebase": { - "description": "Adds Firebase resources to the specified existing\n[Google Cloud Platform (GCP) `Project`]\n(https://cloud.google.com/resource-manager/reference/rest/v1/projects).\n
\n
Since a FirebaseProject is actually also a GCP `Project`, a\n`FirebaseProject` uses underlying GCP identifiers (most importantly,\nthe `projectId`) as its own for easy interop with GCP APIs.\n
\n
The result of this call is an [`Operation`](../../v1beta1/operations).\nPoll the `Operation` to track the provisioning process by calling\nGetOperation until\n[`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When\n`done` is `true`, the `Operation` has either succeeded or failed. If the\n`Operation` succeeded, its\n[`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to\na FirebaseProject; if the `Operation` failed, its\n[`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a\ngoogle.rpc.Status. The `Operation` is automatically deleted after\ncompletion, so there is no need to call\nDeleteOperation.\n
\n
This method does not modify any billing account information on the\nunderlying GCP `Project`.\n
\n
To call `AddFirebase`, a project member or service account must have\nthe following permissions (the IAM roles of Editor and Owner contain these\npermissions):\n`firebase.projects.update`, `resourcemanager.projects.get`,\n`serviceusage.services.enable`, and `serviceusage.services.get`.", + "description": "Adds Firebase resources to the specified existing\n[Google Cloud Platform (GCP) `Project`]\n(https://cloud.google.com/resource-manager/reference/rest/v1/projects).\n
\n
Since a FirebaseProject is actually also a GCP `Project`, a\n`FirebaseProject` uses underlying GCP identifiers (most importantly,\nthe `PROJECT_NUMBER`) as its own for easy interop with GCP APIs.\n
\n
The result of this call is an [`Operation`](../../v1beta1/operations).\nPoll the `Operation` to track the provisioning process by calling\nGetOperation until\n[`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When\n`done` is `true`, the `Operation` has either succeeded or failed. If the\n`Operation` succeeded, its\n[`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to\na FirebaseProject; if the `Operation` failed, its\n[`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a\ngoogle.rpc.Status. The `Operation` is automatically deleted after\ncompletion, so there is no need to call\nDeleteOperation.\n
\n
This method does not modify any billing account information on the\nunderlying GCP `Project`.\n
\n
To call `AddFirebase`, a project member or service account must have\nthe following permissions (the IAM roles of Editor and Owner contain these\npermissions):\n`firebase.projects.update`, `resourcemanager.projects.get`,\n`serviceusage.services.enable`, and `serviceusage.services.get`.", "flatPath": "v1beta1/projects/{projectsId}:addFirebase", "httpMethod": "POST", "id": "firebase.projects.addFirebase", @@ -192,7 +192,7 @@ ], "parameters": { "project": { - "description": "The resource name of the GCP `Project` to which Firebase resources will be\nadded, in the format:\n
projects/projectId\nAfter calling `AddFirebase`, the\n[`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id)\nof the GCP `Project` is also the `projectId` of the FirebaseProject.", + "description": "The resource name of the GCP `Project` to which Firebase resources will be\nadded, in the format:\n
projects/PROJECT_NUMBER\nAfter calling `AddFirebase`, the\n[`project_id`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id)\nof the GCP `Project` is also the `project_id` of the FirebaseProject.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -221,7 +221,7 @@ ], "parameters": { "parent": { - "description": "The parent `FirebaseProject` to link to an existing Google Analytics\naccount, in the format:\n
projects/projectId", + "description": "The parent `FirebaseProject` to link to an existing Google Analytics\naccount, in the format:\n
projects/PROJECT_NUMBER", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -250,7 +250,7 @@ ], "parameters": { "name": { - "description": "The fully qualified resource name of the Project, in the format:\n
projects/projectId", + "description": "The fully qualified resource name of the Project, in the format:\n
projects/PROJECT_NUMBER", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -278,7 +278,7 @@ ], "parameters": { "name": { - "description": "The fully qualified resource name of the Project, in the format:\n
projects/projectId/adminSdkConfig", + "description": "The fully qualified resource name of the Project, in the format:\n
projects/PROJECT_NUMBER/adminSdkConfig", "location": "path", "pattern": "^projects/[^/]+/adminSdkConfig$", "required": true, @@ -306,7 +306,7 @@ ], "parameters": { "name": { - "description": "The fully qualified resource name, in the format:\n
projects/projectId/analyticsDetails", + "description": "The fully qualified resource name, in the format:\n
projects/PROJECT_NUMBER/analyticsDetails", "location": "path", "pattern": "^projects/[^/]+/analyticsDetails$", "required": true, @@ -399,7 +399,7 @@ ], "parameters": { "parent": { - "description": "The parent `FirebaseProject` to unlink from its Google Analytics account,\nin the format:\n
projects/projectId", + "description": "The parent `FirebaseProject` to unlink from its Google Analytics account,\nin the format:\n
projects/PROJECT_NUMBER", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -439,7 +439,7 @@ "type": "string" }, "parent": { - "description": "The parent Project for which to list Apps, in the format:\n
projects/projectId", + "description": "The parent Project for which to list Apps, in the format:\n
projects/PROJECT_NUMBER", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -471,7 +471,7 @@ ], "parameters": { "parent": { - "description": "The parent Project in which to create an App, in the format:\n
projects/projectId", + "description": "The parent Project in which to create an App, in the format:\n
projects/PROJECT_NUMBER", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -500,7 +500,7 @@ ], "parameters": { "name": { - "description": "The fully qualified resource name of the App, in the format:\n
projects/projectId/androidApps/appId\n
As an appId is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/androidApps/appId", + "description": "The fully qualified resource name of the App, in the format:\n
projects/PROJECT_NUMBER/androidApps/APP_ID\n
As an APP_ID is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/androidApps/APP_ID", "location": "path", "pattern": "^projects/[^/]+/androidApps/[^/]+$", "required": true, @@ -528,7 +528,7 @@ ], "parameters": { "name": { - "description": "The resource name of the App configuration to download, in the format:\n
projects/projectId/androidApps/appId/config\n
As an appId is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/androidApps/appId", + "description": "The resource name of the App configuration to download, in the format:\n
projects/PROJECT_NUMBER/androidApps/APP_ID/config\n
As an APP_ID is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/androidApps/APP_ID", "location": "path", "pattern": "^projects/[^/]+/androidApps/[^/]+/config$", "required": true, @@ -567,7 +567,7 @@ "type": "string" }, "parent": { - "description": "The parent Project for which to list Apps, in the format:\n
projects/projectId", + "description": "The parent Project for which to list Apps, in the format:\n
projects/PROJECT_NUMBER", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -602,7 +602,7 @@ "type": "string" }, "updateMask": { - "description": "Specifies which fields to update.\n
Note that the fields `name`, `appId`, `projectId`, and `packageName`\nare all immutable.", + "description": "Specifies which fields to update.\n
Note that the fields `name`, `app_id`, `project_id`, and `package_name`\nare all immutable.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -634,7 +634,7 @@ ], "parameters": { "parent": { - "description": "The parent App to which a SHA certificate will be added, in the format:\n
projects/projectId/androidApps/appId\n
As an appId is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/androidApps/appId", + "description": "The parent App to which a SHA certificate will be added, in the format:\n
projects/PROJECT_NUMBER/androidApps/APP_ID\n
As an APP_ID is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/androidApps/APP_ID", "location": "path", "pattern": "^projects/[^/]+/androidApps/[^/]+$", "required": true, @@ -663,7 +663,7 @@ ], "parameters": { "name": { - "description": "The fully qualified resource name of the `sha-key`, in the format:\n
projects/projectId/androidApps/appId/sha/shaId\n
You can obtain the full name from the response of\n[`ListShaCertificates`](../projects.androidApps.sha/list) or the original\n[`CreateShaCertificate`](../projects.androidApps.sha/create).", + "description": "The fully qualified resource name of the `sha-key`, in the format:\n
projects/PROJECT_NUMBER/androidApps/APP_ID/sha/SHA_ID\n
You can obtain the full name from the response of\n[`ListShaCertificates`](../projects.androidApps.sha/list) or the original\n[`CreateShaCertificate`](../projects.androidApps.sha/create).", "location": "path", "pattern": "^projects/[^/]+/androidApps/[^/]+/sha/[^/]+$", "required": true, @@ -689,7 +689,7 @@ ], "parameters": { "parent": { - "description": "The parent App for which to list SHA certificates, in the format:\n
projects/projectId/androidApps/appId\n
As an appId is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/androidApps/appId", + "description": "The parent App for which to list SHA certificates, in the format:\n
projects/PROJECT_NUMBER/androidApps/APP_ID\n
As an APP_ID is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/androidApps/APP_ID", "location": "path", "pattern": "^projects/[^/]+/androidApps/[^/]+$", "required": true, @@ -714,7 +714,7 @@ "availableLocations": { "methods": { "list": { - "description": "Returns a list of valid Google Cloud Platform (GCP) resource locations for\nthe specified Project (including a FirebaseProject).\n
\n
One of these locations can be selected as the Project's [_default_ GCP\nresource location](https://firebase.google.com/docs/projects/locations),\nwhich is the geographical location where project resources, such as Cloud\nFirestore, will be provisioned by default. However, if the default GCP\nresource location has already been set for the Project, then this setting\ncannot be changed.\n
\n
This call checks for any possible\n[location\nrestrictions](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations)\nfor the specified Project and, thus, might return a subset of all possible\nGCP resource locations. To list all GCP resource locations (regardless of\nany restrictions), call the endpoint without specifying a `projectId` (that\nis, `/v1beta1/{parent=projects/-}/listAvailableLocations`).\n
\n
To call `ListAvailableLocations` with a specified project, a member\nmust be at minimum a Viewer of the project. Calls without a specified\nproject do not require any specific project permissions.", + "description": "Returns a list of valid Google Cloud Platform (GCP) resource locations for\nthe specified Project (including a FirebaseProject).\n
\n
One of these locations can be selected as the Project's [_default_ GCP\nresource location](https://firebase.google.com/docs/projects/locations),\nwhich is the geographical location where project resources, such as Cloud\nFirestore, will be provisioned by default. However, if the default GCP\nresource location has already been set for the Project, then this setting\ncannot be changed.\n
\n
This call checks for any possible\n[location\nrestrictions](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations)\nfor the specified Project and, thus, might return a subset of all possible\nGCP resource locations. To list all GCP resource locations (regardless of\nany restrictions), call the endpoint without specifying a `PROJECT_NUMBER`\n(that is, `/v1beta1/{parent=projects/-}/listAvailableLocations`).
\n
To call `ListAvailableLocations` with a specified project, a member\nmust be at minimum a Viewer of the project. Calls without a specified\nproject do not require any specific project permissions.", "flatPath": "v1beta1/projects/{projectsId}/availableLocations", "httpMethod": "GET", "id": "firebase.projects.availableLocations.list", @@ -734,7 +734,7 @@ "type": "string" }, "parent": { - "description": "The Project for which to list GCP resource locations, in the format:\n
projects/projectId\n
If no project is specified (that is, `projects/-`), the returned list\ndoes not take into account org-specific or project-specific location\nrestrictions.", + "description": "The Project for which to list GCP resource locations, in the format:\n
projects/PROJECT_NUMBER\n
If no project is specified (that is, `projects/-`), the returned list\ndoes not take into account org-specific or project-specific location\nrestrictions.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -766,7 +766,7 @@ ], "parameters": { "parent": { - "description": "The resource name of the Project for which the default GCP resource\nlocation will be set, in the format:\n
projects/projectId", + "description": "The resource name of the Project for which the default GCP resource\nlocation will be set, in the format:\n
projects/PROJECT_NUMBER", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -799,7 +799,7 @@ ], "parameters": { "parent": { - "description": "The parent Project in which to create an App, in the format:\n
projects/projectId", + "description": "The parent Project in which to create an App, in the format:\n
projects/PROJECT_NUMBER", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -828,7 +828,7 @@ ], "parameters": { "name": { - "description": "The fully qualified resource name of the App, in the format:\nprojects/projectId/iosApps/appId\n
As an appId is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/iosApps/appId", + "description": "The fully qualified resource name of the App, in the format:\nprojects/PROJECT_NUMBER/iosApps/APP_ID\n
As an APP_ID is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/iosApps/APP_ID", "location": "path", "pattern": "^projects/[^/]+/iosApps/[^/]+$", "required": true, @@ -856,7 +856,7 @@ ], "parameters": { "name": { - "description": "The resource name of the App configuration to download, in the format:\n
projects/projectId/iosApps/appId/config\n
As an appId is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/iosApps/appId", + "description": "The resource name of the App configuration to download, in the format:\n
projects/PROJECT_NUMBER/iosApps/APP_ID/config\n
As an APP_ID is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/iosApps/APP_ID", "location": "path", "pattern": "^projects/[^/]+/iosApps/[^/]+/config$", "required": true, @@ -895,7 +895,7 @@ "type": "string" }, "parent": { - "description": "The parent Project for which to list Apps, in the format:\n
projects/projectId", + "description": "The parent Project for which to list Apps, in the format:\n
projects/PROJECT_NUMBER", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -962,7 +962,7 @@ ], "parameters": { "parent": { - "description": "The parent Project in which to create an App, in the format:\n
projects/projectId", + "description": "The parent Project in which to create an App, in the format:\n
projects/PROJECT_NUMBER", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -991,7 +991,7 @@ ], "parameters": { "name": { - "description": "The fully qualified resource name of the App, in the format:\n
projects/projectId/webApps/appId\n
As an appId is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/webApps/appId", + "description": "The fully qualified resource name of the App, in the format:\n
projects/PROJECT_NUMBER/webApps/APP_ID\n
As an APP_ID is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/webApps/APP_ID", "location": "path", "pattern": "^projects/[^/]+/webApps/[^/]+$", "required": true, @@ -1019,7 +1019,7 @@ ], "parameters": { "name": { - "description": "The resource name of the App configuration to download, in the format:\n
projects/projectId/webApps/appId/config\n
As an appId is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/webApps/appId", + "description": "The resource name of the App configuration to download, in the format:\n
projects/PROJECT_NUMBER/webApps/APP_ID/config\n
As an APP_ID is a unique identifier, the Unique Resource\nfrom Sub-Collection access pattern may be used here, in the format:\n
projects/-/webApps/APP_ID", "location": "path", "pattern": "^projects/[^/]+/webApps/[^/]+/config$", "required": true, @@ -1058,7 +1058,7 @@ "type": "string" }, "parent": { - "description": "The parent Project for which to list Apps, in the format:\n
projects/projectId", + "description": "The parent Project for which to list Apps, in the format:\n
projects/PROJECT_NUMBER", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1116,7 +1116,7 @@ } } }, - "revision": "20200513", + "revision": "20200707", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": { @@ -1611,7 +1611,7 @@ "type": "string" }, "project": { - "description": "The resource name of the GCP `Project` to which Firebase resources can be\nadded, in the format:\n
projects/projectId", + "description": "The resource name of the GCP `Project` to which Firebase resources can be\nadded, in the format:\n
projects/PROJECT_NUMBER", "type": "string" } }, @@ -1663,7 +1663,7 @@ "type": "string" }, "name": { - "description": "The fully qualified resource name of the `sha-key`, in the format:\n
projects/projectId/androidApps/appId/sha/shaId", + "description": "The fully qualified resource name of the `sha-key`, in the format:\n
projects/PROJECT_NUMBER/androidApps/APP_ID/sha/SHA_ID", "type": "string" }, "shaHash": { @@ -1738,7 +1738,7 @@ "id": "StreamMapping", "properties": { "app": { - "description": "The fully qualified resource name of the Firebase App associated with the\nGoogle Analytics data stream, in the format:\n
projects/projectId/androidApps/appId\nor\nprojects/projectId/iosApps/appId\nor\nprojects/projectId/webApps/appId", + "description": "The fully qualified resource name of the Firebase App associated with the\nGoogle Analytics data stream, in the format:\n
projects/PROJECT_NUMBER/androidApps/APP_ID\nor\nprojects/PROJECT_NUMBER/iosApps/APP_ID\nor\nprojects/PROJECT_NUMBER/webApps/APP_ID", "type": "string" }, "measurementId": { diff --git a/src/apis/firebase/v1beta1.ts b/src/apis/firebase/v1beta1.ts index 8d39a8e768e..c5304d40502 100644 --- a/src/apis/firebase/v1beta1.ts +++ b/src/apis/firebase/v1beta1.ts @@ -481,7 +481,7 @@ export namespace firebase_v1beta1 { */ locationId?: string | null; /** - * The resource name of the GCP `Project` to which Firebase resources can be added, in the format: <br><code>projects/<var>projectId</var></code> + * The resource name of the GCP `Project` to which Firebase resources can be added, in the format: <br><code>projects/<var>PROJECT_NUMBER</var></code> */ project?: string | null; } @@ -510,7 +510,7 @@ export namespace firebase_v1beta1 { */ certType?: string | null; /** - * The fully qualified resource name of the `sha-key`, in the format: <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var>/sha/<var>shaId</var></code> + * The fully qualified resource name of the `sha-key`, in the format: <br><code>projects/<var>PROJECT_NUMBER</var>/androidApps/<var>APP_ID</var>/sha/<var>SHA_ID</var></code> */ name?: string | null; /** @@ -569,7 +569,7 @@ export namespace firebase_v1beta1 { */ export interface Schema$StreamMapping { /** - * The fully qualified resource name of the Firebase App associated with the Google Analytics data stream, in the format: <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code> or <code>projects/<var>projectId</var>/iosApps/<var>appId</var></code> or <code>projects/<var>projectId</var>/webApps/<var>appId</var></code> + * The fully qualified resource name of the Firebase App associated with the Google Analytics data stream, in the format: <br><code>projects/<var>PROJECT_NUMBER</var>/androidApps/<var>APP_ID</var></code> or <code>projects/<var>PROJECT_NUMBER</var>/iosApps/<var>APP_ID</var></code> or <code>projects/<var>PROJECT_NUMBER</var>/webApps/<var>APP_ID</var></code> */ app?: string | null; /** @@ -1008,7 +1008,7 @@ export namespace firebase_v1beta1 { /** * firebase.projects.addFirebase - * @desc Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects).

Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` uses underlying GCP identifiers (most importantly, the `projectId`) as its own for easy interop with GCP 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 GCP `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`. + * @desc Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects).

Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` uses underlying GCP identifiers (most importantly, the `PROJECT_NUMBER`) as its own for easy interop with GCP 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 GCP `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`. * @example * // Before running the sample: * // - Enable the API at: @@ -1038,10 +1038,10 @@ export namespace firebase_v1beta1 { * const res = await firebase.projects.addFirebase({ * // The resource name of the GCP `Project` to which Firebase resources will be * // added, in the format: - * //
projects/projectId + * //
projects/PROJECT_NUMBER * // After calling `AddFirebase`, the - * // [`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id) - * // of the GCP `Project` is also the `projectId` of the FirebaseProject. + * // [`project_id`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id) + * // of the GCP `Project` is also the `project_id` of the FirebaseProject. * project: 'projects/my-project', * * // Request body metadata @@ -1075,7 +1075,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.project The resource name of the GCP `Project` to which Firebase resources will be added, in the format:
projects/projectId After calling `AddFirebase`, the [`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id) of the GCP `Project` is also the `projectId` of the FirebaseProject. + * @param {string} params.project The resource name of the GCP `Project` to which Firebase resources will be added, in the format:
projects/PROJECT_NUMBER After calling `AddFirebase`, the [`project_id`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id) of the GCP `Project` is also the `project_id` of the FirebaseProject. * @param {().AddFirebaseRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1192,7 +1192,7 @@ export namespace firebase_v1beta1 { * const res = await firebase.projects.addGoogleAnalytics({ * // The parent `FirebaseProject` to link to an existing Google Analytics * // account, in the format: - * //
projects/projectId + * //
projects/PROJECT_NUMBER * parent: 'projects/my-project', * * // Request body metadata @@ -1225,7 +1225,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent `FirebaseProject` to link to an existing Google Analytics account, in the format:
projects/projectId + * @param {string} params.parent The parent `FirebaseProject` to link to an existing Google Analytics account, in the format:
projects/PROJECT_NUMBER * @param {().AddGoogleAnalyticsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1343,7 +1343,7 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.get({ * // The fully qualified resource name of the Project, in the format: - * //
projects/projectId + * //
projects/PROJECT_NUMBER * name: 'projects/my-project', * }); * console.log(res.data); @@ -1367,7 +1367,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The fully qualified resource name of the Project, in the format:
projects/projectId + * @param {string} params.name The fully qualified resource name of the Project, in the format:
projects/PROJECT_NUMBER * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1480,7 +1480,7 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.getAdminSdkConfig({ * // The fully qualified resource name of the Project, in the format: - * //
projects/projectId/adminSdkConfig + * //
projects/PROJECT_NUMBER/adminSdkConfig * name: 'projects/my-project/adminSdkConfig', * }); * console.log(res.data); @@ -1503,7 +1503,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The fully qualified resource name of the Project, in the format:
projects/projectId/adminSdkConfig + * @param {string} params.name The fully qualified resource name of the Project, in the format:
projects/PROJECT_NUMBER/adminSdkConfig * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1619,7 +1619,7 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.getAnalyticsDetails({ * // The fully qualified resource name, in the format: - * //
projects/projectId/analyticsDetails + * //
projects/PROJECT_NUMBER/analyticsDetails * name: 'projects/my-project/analyticsDetails', * }); * console.log(res.data); @@ -1640,7 +1640,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The fully qualified resource name, in the format:
projects/projectId/analyticsDetails + * @param {string} params.name The fully qualified resource name, in the format:
projects/PROJECT_NUMBER/analyticsDetails * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2062,7 +2062,7 @@ export namespace firebase_v1beta1 { * const res = await firebase.projects.removeAnalytics({ * // The parent `FirebaseProject` to unlink from its Google Analytics account, * // in the format: - * //
projects/projectId + * //
projects/PROJECT_NUMBER * parent: 'projects/my-project', * * // Request body metadata @@ -2088,7 +2088,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent `FirebaseProject` to unlink from its Google Analytics account, in the format:
projects/projectId + * @param {string} params.parent The parent `FirebaseProject` to unlink from its Google Analytics account, in the format:
projects/PROJECT_NUMBER * @param {().RemoveAnalyticsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2217,7 +2217,7 @@ export namespace firebase_v1beta1 { * // where in the set of Apps to resume listing. * pageToken: 'placeholder-value', * // The parent Project for which to list Apps, in the format: - * //
projects/projectId + * //
projects/PROJECT_NUMBER * parent: 'projects/my-project', * }); * console.log(res.data); @@ -2240,7 +2240,7 @@ export namespace firebase_v1beta1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of Apps to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.

This value cannot be negative. * @param {string=} params.pageToken Token returned from a previous call to `SearchFirebaseApps` indicating where in the set of Apps to resume listing. - * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/projectId + * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/PROJECT_NUMBER * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2335,7 +2335,7 @@ export namespace firebase_v1beta1 { export interface Params$Resource$Projects$Addfirebase extends StandardParameters { /** - * The resource name of the GCP `Project` to which Firebase resources will be added, in the format:
projects/projectId After calling `AddFirebase`, the [`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id) of the GCP `Project` is also the `projectId` of the FirebaseProject. + * The resource name of the GCP `Project` to which Firebase resources will be added, in the format:
projects/PROJECT_NUMBER After calling `AddFirebase`, the [`project_id`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id) of the GCP `Project` is also the `project_id` of the FirebaseProject. */ project?: string; @@ -2347,7 +2347,7 @@ export namespace firebase_v1beta1 { export interface Params$Resource$Projects$Addgoogleanalytics extends StandardParameters { /** - * The parent `FirebaseProject` to link to an existing Google Analytics account, in the format:
projects/projectId + * The parent `FirebaseProject` to link to an existing Google Analytics account, in the format:
projects/PROJECT_NUMBER */ parent?: string; @@ -2358,21 +2358,21 @@ export namespace firebase_v1beta1 { } export interface Params$Resource$Projects$Get extends StandardParameters { /** - * The fully qualified resource name of the Project, in the format:
projects/projectId + * The fully qualified resource name of the Project, in the format:
projects/PROJECT_NUMBER */ name?: string; } export interface Params$Resource$Projects$Getadminsdkconfig extends StandardParameters { /** - * The fully qualified resource name of the Project, in the format:
projects/projectId/adminSdkConfig + * The fully qualified resource name of the Project, in the format:
projects/PROJECT_NUMBER/adminSdkConfig */ name?: string; } export interface Params$Resource$Projects$Getanalyticsdetails extends StandardParameters { /** - * The fully qualified resource name, in the format:
projects/projectId/analyticsDetails + * The fully qualified resource name, in the format:
projects/PROJECT_NUMBER/analyticsDetails */ name?: string; } @@ -2404,7 +2404,7 @@ export namespace firebase_v1beta1 { export interface Params$Resource$Projects$Removeanalytics extends StandardParameters { /** - * The parent `FirebaseProject` to unlink from its Google Analytics account, in the format:
projects/projectId + * The parent `FirebaseProject` to unlink from its Google Analytics account, in the format:
projects/PROJECT_NUMBER */ parent?: string; @@ -2424,7 +2424,7 @@ export namespace firebase_v1beta1 { */ pageToken?: string; /** - * The parent Project for which to list Apps, in the format:
projects/projectId + * The parent Project for which to list Apps, in the format:
projects/PROJECT_NUMBER */ parent?: string; } @@ -2468,7 +2468,7 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.androidApps.create({ * // The parent Project in which to create an App, in the format: - * //
projects/projectId + * //
projects/PROJECT_NUMBER * parent: 'projects/my-project', * * // Request body metadata @@ -2504,7 +2504,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent Project in which to create an App, in the format:
projects/projectId + * @param {string} params.parent The parent Project in which to create an App, in the format:
projects/PROJECT_NUMBER * @param {().AndroidApp} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2622,10 +2622,10 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.androidApps.get({ * // The fully qualified resource name of the App, in the format: - * //
projects/projectId/androidApps/appId - * //
As an appId is a unique identifier, the Unique Resource + * //
projects/PROJECT_NUMBER/androidApps/APP_ID + * //
As an APP_ID is a unique identifier, the Unique Resource * // from Sub-Collection access pattern may be used here, in the format: - * //
projects/-/androidApps/appId + * //
projects/-/androidApps/APP_ID * name: 'projects/my-project/androidApps/my-androidApp', * }); * console.log(res.data); @@ -2649,7 +2649,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The fully qualified resource name of the App, in the format:
projects/projectId/androidApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + * @param {string} params.name The fully qualified resource name of the App, in the format:
projects/PROJECT_NUMBER/androidApps/APP_ID
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/APP_ID * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2763,10 +2763,10 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.androidApps.getConfig({ * // The resource name of the App configuration to download, in the format: - * //
projects/projectId/androidApps/appId/config - * //
As an appId is a unique identifier, the Unique Resource + * //
projects/PROJECT_NUMBER/androidApps/APP_ID/config + * //
As an APP_ID is a unique identifier, the Unique Resource * // from Sub-Collection access pattern may be used here, in the format: - * //
projects/-/androidApps/appId + * //
projects/-/androidApps/APP_ID * name: 'projects/my-project/androidApps/my-androidApp/config', * }); * console.log(res.data); @@ -2787,7 +2787,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the App configuration to download, in the format:
projects/projectId/androidApps/appId/config
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + * @param {string} params.name The resource name of the App configuration to download, in the format:
projects/PROJECT_NUMBER/androidApps/APP_ID/config
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/APP_ID * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2910,7 +2910,7 @@ export namespace firebase_v1beta1 { * // in the set of Apps to resume listing. * pageToken: 'placeholder-value', * // The parent Project for which to list Apps, in the format: - * //
projects/projectId + * //
projects/PROJECT_NUMBER * parent: 'projects/my-project', * }); * console.log(res.data); @@ -2933,7 +2933,7 @@ export namespace firebase_v1beta1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of Apps to return in the response.

The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit. * @param {string=} params.pageToken Token returned from a previous call to `ListAndroidApps` indicating where in the set of Apps to resume listing. - * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/projectId + * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/PROJECT_NUMBER * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3056,7 +3056,7 @@ export namespace firebase_v1beta1 { * //
projects/projectId/androidApps/appId * name: 'projects/my-project/androidApps/my-androidApp', * // Specifies which fields to update. - * //
Note that the fields `name`, `appId`, `projectId`, and `packageName` + * //
Note that the fields `name`, `app_id`, `project_id`, and `package_name` * // are all immutable. * updateMask: 'placeholder-value', * @@ -3094,7 +3094,7 @@ export namespace firebase_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.name The fully qualified resource name of the App, in the format:
projects/projectId/androidApps/appId - * @param {string=} params.updateMask Specifies which fields to update.
Note that the fields `name`, `appId`, `projectId`, and `packageName` are all immutable. + * @param {string=} params.updateMask Specifies which fields to update.
Note that the fields `name`, `app_id`, `project_id`, and `package_name` are all immutable. * @param {().AndroidApp} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3180,7 +3180,7 @@ export namespace firebase_v1beta1 { export interface Params$Resource$Projects$Androidapps$Create extends StandardParameters { /** - * The parent Project in which to create an App, in the format:
projects/projectId + * The parent Project in which to create an App, in the format:
projects/PROJECT_NUMBER */ parent?: string; @@ -3192,14 +3192,14 @@ export namespace firebase_v1beta1 { export interface Params$Resource$Projects$Androidapps$Get extends StandardParameters { /** - * The fully qualified resource name of the App, in the format:
projects/projectId/androidApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + * The fully qualified resource name of the App, in the format:
projects/PROJECT_NUMBER/androidApps/APP_ID
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/APP_ID */ name?: string; } export interface Params$Resource$Projects$Androidapps$Getconfig extends StandardParameters { /** - * The resource name of the App configuration to download, in the format:
projects/projectId/androidApps/appId/config
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + * The resource name of the App configuration to download, in the format:
projects/PROJECT_NUMBER/androidApps/APP_ID/config
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/APP_ID */ name?: string; } @@ -3214,7 +3214,7 @@ export namespace firebase_v1beta1 { */ pageToken?: string; /** - * The parent Project for which to list Apps, in the format:
projects/projectId + * The parent Project for which to list Apps, in the format:
projects/PROJECT_NUMBER */ parent?: string; } @@ -3225,7 +3225,7 @@ export namespace firebase_v1beta1 { */ name?: string; /** - * Specifies which fields to update.
Note that the fields `name`, `appId`, `projectId`, and `packageName` are all immutable. + * Specifies which fields to update.
Note that the fields `name`, `app_id`, `project_id`, and `package_name` are all immutable. */ updateMask?: string; @@ -3272,10 +3272,10 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.androidApps.sha.create({ * // The parent App to which a SHA certificate will be added, in the format: - * //
projects/projectId/androidApps/appId - * //
As an appId is a unique identifier, the Unique Resource + * //
projects/PROJECT_NUMBER/androidApps/APP_ID + * //
As an APP_ID is a unique identifier, the Unique Resource * // from Sub-Collection access pattern may be used here, in the format: - * //
projects/-/androidApps/appId + * //
projects/-/androidApps/APP_ID * parent: 'projects/my-project/androidApps/my-androidApp', * * // Request body metadata @@ -3307,7 +3307,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent App to which a SHA certificate will be added, in the format:
projects/projectId/androidApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + * @param {string} params.parent The parent App to which a SHA certificate will be added, in the format:
projects/PROJECT_NUMBER/androidApps/APP_ID
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/APP_ID * @param {().ShaCertificate} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3423,7 +3423,7 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.androidApps.sha.delete({ * // The fully qualified resource name of the `sha-key`, in the format: - * //
projects/projectId/androidApps/appId/sha/shaId + * //
projects/PROJECT_NUMBER/androidApps/APP_ID/sha/SHA_ID * //
You can obtain the full name from the response of * // [`ListShaCertificates`](../projects.androidApps.sha/list) or the original * // [`CreateShaCertificate`](../projects.androidApps.sha/create). @@ -3444,7 +3444,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The fully qualified resource name of the `sha-key`, in the format:
projects/projectId/androidApps/appId/sha/shaId
You can obtain the full name from the response of [`ListShaCertificates`](../projects.androidApps.sha/list) or the original [`CreateShaCertificate`](../projects.androidApps.sha/create). + * @param {string} params.name The fully qualified resource name of the `sha-key`, in the format:
projects/PROJECT_NUMBER/androidApps/APP_ID/sha/SHA_ID
You can obtain the full name from the response of [`ListShaCertificates`](../projects.androidApps.sha/list) or the original [`CreateShaCertificate`](../projects.androidApps.sha/create). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3558,10 +3558,10 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.androidApps.sha.list({ * // The parent App for which to list SHA certificates, in the format: - * //
projects/projectId/androidApps/appId - * //
As an appId is a unique identifier, the Unique Resource + * //
projects/PROJECT_NUMBER/androidApps/APP_ID + * //
As an APP_ID is a unique identifier, the Unique Resource * // from Sub-Collection access pattern may be used here, in the format: - * //
projects/-/androidApps/appId + * //
projects/-/androidApps/APP_ID * parent: 'projects/my-project/androidApps/my-androidApp', * }); * console.log(res.data); @@ -3581,7 +3581,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent App for which to list SHA certificates, in the format:
projects/projectId/androidApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + * @param {string} params.parent The parent App for which to list SHA certificates, in the format:
projects/PROJECT_NUMBER/androidApps/APP_ID
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/APP_ID * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3676,7 +3676,7 @@ export namespace firebase_v1beta1 { export interface Params$Resource$Projects$Androidapps$Sha$Create extends StandardParameters { /** - * The parent App to which a SHA certificate will be added, in the format:
projects/projectId/androidApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + * The parent App to which a SHA certificate will be added, in the format:
projects/PROJECT_NUMBER/androidApps/APP_ID
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/APP_ID */ parent?: string; @@ -3688,14 +3688,14 @@ export namespace firebase_v1beta1 { export interface Params$Resource$Projects$Androidapps$Sha$Delete extends StandardParameters { /** - * The fully qualified resource name of the `sha-key`, in the format:
projects/projectId/androidApps/appId/sha/shaId
You can obtain the full name from the response of [`ListShaCertificates`](../projects.androidApps.sha/list) or the original [`CreateShaCertificate`](../projects.androidApps.sha/create). + * The fully qualified resource name of the `sha-key`, in the format:
projects/PROJECT_NUMBER/androidApps/APP_ID/sha/SHA_ID
You can obtain the full name from the response of [`ListShaCertificates`](../projects.androidApps.sha/list) or the original [`CreateShaCertificate`](../projects.androidApps.sha/create). */ name?: string; } export interface Params$Resource$Projects$Androidapps$Sha$List extends StandardParameters { /** - * The parent App for which to list SHA certificates, in the format:
projects/projectId/androidApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + * The parent App for which to list SHA certificates, in the format:
projects/PROJECT_NUMBER/androidApps/APP_ID
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/APP_ID */ parent?: string; } @@ -3708,7 +3708,7 @@ export namespace firebase_v1beta1 { /** * firebase.projects.availableLocations.list - * @desc Returns a list of valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject).

One of these locations can be selected as the Project's [_default_ GCP resource location](https://firebase.google.com/docs/projects/locations), which is the geographical location where project resources, such as Cloud Firestore, will be provisioned by default. However, if the default GCP resource location 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 GCP resource locations. To list all GCP resource locations (regardless of any restrictions), call the endpoint without specifying a `projectId` (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. + * @desc Returns a list of valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject).

One of these locations can be selected as the Project's [_default_ GCP resource location](https://firebase.google.com/docs/projects/locations), which is the geographical location where project resources, such as Cloud Firestore, will be provisioned by default. However, if the default GCP resource location 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 GCP resource locations. To list all GCP resource locations (regardless of any restrictions), call the endpoint without specifying a `PROJECT_NUMBER` (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. * @example * // Before running the sample: * // - Enable the API at: @@ -3750,7 +3750,7 @@ export namespace firebase_v1beta1 { * // where in the list of locations to resume listing. * pageToken: 'placeholder-value', * // The Project for which to list GCP resource locations, in the format: - * //
projects/projectId + * //
projects/PROJECT_NUMBER * //
If no project is specified (that is, `projects/-`), the returned list * // does not take into account org-specific or project-specific location * // restrictions. @@ -3776,7 +3776,7 @@ export namespace firebase_v1beta1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of locations to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.

This value cannot be negative. * @param {string=} params.pageToken Token returned from a previous call to `ListAvailableLocations` indicating where in the list of locations to resume listing. - * @param {string} params.parent The Project for which to list GCP resource locations, in the format:
projects/projectId
If no project is specified (that is, `projects/-`), the returned list does not take into account org-specific or project-specific location restrictions. + * @param {string} params.parent The Project for which to list GCP resource locations, in the format:
projects/PROJECT_NUMBER
If no project is specified (that is, `projects/-`), the returned list does not take into account org-specific or project-specific location restrictions. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3881,7 +3881,7 @@ export namespace firebase_v1beta1 { */ pageToken?: string; /** - * The Project for which to list GCP resource locations, in the format:
projects/projectId
If no project is specified (that is, `projects/-`), the returned list does not take into account org-specific or project-specific location restrictions. + * The Project for which to list GCP resource locations, in the format:
projects/PROJECT_NUMBER
If no project is specified (that is, `projects/-`), the returned list does not take into account org-specific or project-specific location restrictions. */ parent?: string; } @@ -3924,7 +3924,7 @@ export namespace firebase_v1beta1 { * const res = await firebase.projects.defaultLocation.finalize({ * // The resource name of the Project for which the default GCP resource * // location will be set, in the format: - * //
projects/projectId + * //
projects/PROJECT_NUMBER * parent: 'projects/my-project', * * // Request body metadata @@ -3956,7 +3956,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The resource name of the Project for which the default GCP resource location will be set, in the format:
projects/projectId + * @param {string} params.parent The resource name of the Project for which the default GCP resource location will be set, in the format:
projects/PROJECT_NUMBER * @param {().FinalizeDefaultLocationRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4044,7 +4044,7 @@ export namespace firebase_v1beta1 { export interface Params$Resource$Projects$Defaultlocation$Finalize extends StandardParameters { /** - * The resource name of the Project for which the default GCP resource location will be set, in the format:
projects/projectId + * The resource name of the Project for which the default GCP resource location will be set, in the format:
projects/PROJECT_NUMBER */ parent?: string; @@ -4091,7 +4091,7 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.iosApps.create({ * // The parent Project in which to create an App, in the format: - * //
projects/projectId + * //
projects/PROJECT_NUMBER * parent: 'projects/my-project', * * // Request body metadata @@ -4128,7 +4128,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent Project in which to create an App, in the format:
projects/projectId + * @param {string} params.parent The parent Project in which to create an App, in the format:
projects/PROJECT_NUMBER * @param {().IosApp} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4246,10 +4246,10 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.iosApps.get({ * // The fully qualified resource name of the App, in the format: - * // projects/projectId/iosApps/appId - * //
As an appId is a unique identifier, the Unique Resource + * // projects/PROJECT_NUMBER/iosApps/APP_ID + * //
As an APP_ID is a unique identifier, the Unique Resource * // from Sub-Collection access pattern may be used here, in the format: - * //
projects/-/iosApps/appId + * //
projects/-/iosApps/APP_ID * name: 'projects/my-project/iosApps/my-iosApp', * }); * console.log(res.data); @@ -4274,7 +4274,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The fully qualified resource name of the App, in the format: projects/projectId/iosApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/iosApps/appId + * @param {string} params.name The fully qualified resource name of the App, in the format: projects/PROJECT_NUMBER/iosApps/APP_ID
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/iosApps/APP_ID * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4388,10 +4388,10 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.iosApps.getConfig({ * // The resource name of the App configuration to download, in the format: - * //
projects/projectId/iosApps/appId/config - * //
As an appId is a unique identifier, the Unique Resource + * //
projects/PROJECT_NUMBER/iosApps/APP_ID/config + * //
As an APP_ID is a unique identifier, the Unique Resource * // from Sub-Collection access pattern may be used here, in the format: - * //
projects/-/iosApps/appId + * //
projects/-/iosApps/APP_ID * name: 'projects/my-project/iosApps/my-iosApp/config', * }); * console.log(res.data); @@ -4412,7 +4412,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the App configuration to download, in the format:
projects/projectId/iosApps/appId/config
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/iosApps/appId + * @param {string} params.name The resource name of the App configuration to download, in the format:
projects/PROJECT_NUMBER/iosApps/APP_ID/config
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/iosApps/APP_ID * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4535,7 +4535,7 @@ export namespace firebase_v1beta1 { * // the set of Apps to resume listing. * pageToken: 'placeholder-value', * // The parent Project for which to list Apps, in the format: - * //
projects/projectId + * //
projects/PROJECT_NUMBER * parent: 'projects/my-project', * }); * console.log(res.data); @@ -4558,7 +4558,7 @@ export namespace firebase_v1beta1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of Apps to return in the response.

The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. * @param {string=} params.pageToken Token returned from a previous call to `ListIosApps` indicating where in the set of Apps to resume listing. - * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/projectId + * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/PROJECT_NUMBER * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4805,7 +4805,7 @@ export namespace firebase_v1beta1 { export interface Params$Resource$Projects$Iosapps$Create extends StandardParameters { /** - * The parent Project in which to create an App, in the format:
projects/projectId + * The parent Project in which to create an App, in the format:
projects/PROJECT_NUMBER */ parent?: string; @@ -4817,14 +4817,14 @@ export namespace firebase_v1beta1 { export interface Params$Resource$Projects$Iosapps$Get extends StandardParameters { /** - * The fully qualified resource name of the App, in the format: projects/projectId/iosApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/iosApps/appId + * The fully qualified resource name of the App, in the format: projects/PROJECT_NUMBER/iosApps/APP_ID
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/iosApps/APP_ID */ name?: string; } export interface Params$Resource$Projects$Iosapps$Getconfig extends StandardParameters { /** - * The resource name of the App configuration to download, in the format:
projects/projectId/iosApps/appId/config
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/iosApps/appId + * The resource name of the App configuration to download, in the format:
projects/PROJECT_NUMBER/iosApps/APP_ID/config
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/iosApps/APP_ID */ name?: string; } @@ -4839,7 +4839,7 @@ export namespace firebase_v1beta1 { */ pageToken?: string; /** - * The parent Project for which to list Apps, in the format:
projects/projectId + * The parent Project for which to list Apps, in the format:
projects/PROJECT_NUMBER */ parent?: string; } @@ -4897,7 +4897,7 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.webApps.create({ * // The parent Project in which to create an App, in the format: - * //
projects/projectId + * //
projects/PROJECT_NUMBER * parent: 'projects/my-project', * * // Request body metadata @@ -4933,7 +4933,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent Project in which to create an App, in the format:
projects/projectId + * @param {string} params.parent The parent Project in which to create an App, in the format:
projects/PROJECT_NUMBER * @param {().WebApp} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5051,10 +5051,10 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.webApps.get({ * // The fully qualified resource name of the App, in the format: - * //
projects/projectId/webApps/appId - * //
As an appId is a unique identifier, the Unique Resource + * //
projects/PROJECT_NUMBER/webApps/APP_ID + * //
As an APP_ID is a unique identifier, the Unique Resource * // from Sub-Collection access pattern may be used here, in the format: - * //
projects/-/webApps/appId + * //
projects/-/webApps/APP_ID * name: 'projects/my-project/webApps/my-webApp', * }); * console.log(res.data); @@ -5078,7 +5078,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The fully qualified resource name of the App, in the format:
projects/projectId/webApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/webApps/appId + * @param {string} params.name The fully qualified resource name of the App, in the format:
projects/PROJECT_NUMBER/webApps/APP_ID
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/webApps/APP_ID * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5192,10 +5192,10 @@ export namespace firebase_v1beta1 { * // Do the magic * const res = await firebase.projects.webApps.getConfig({ * // The resource name of the App configuration to download, in the format: - * //
projects/projectId/webApps/appId/config - * //
As an appId is a unique identifier, the Unique Resource + * //
projects/PROJECT_NUMBER/webApps/APP_ID/config + * //
As an APP_ID is a unique identifier, the Unique Resource * // from Sub-Collection access pattern may be used here, in the format: - * //
projects/-/webApps/appId + * //
projects/-/webApps/APP_ID * name: 'projects/my-project/webApps/my-webApp/config', * }); * console.log(res.data); @@ -5223,7 +5223,7 @@ export namespace firebase_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the App configuration to download, in the format:
projects/projectId/webApps/appId/config
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/webApps/appId + * @param {string} params.name The resource name of the App configuration to download, in the format:
projects/PROJECT_NUMBER/webApps/APP_ID/config
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/webApps/APP_ID * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5346,7 +5346,7 @@ export namespace firebase_v1beta1 { * // the set of Apps to resume listing. * pageToken: 'placeholder-value', * // The parent Project for which to list Apps, in the format: - * //
projects/projectId + * //
projects/PROJECT_NUMBER * parent: 'projects/my-project', * }); * console.log(res.data); @@ -5369,7 +5369,7 @@ export namespace firebase_v1beta1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of Apps to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit. * @param {string=} params.pageToken Token returned from a previous call to `ListWebApps` indicating where in the set of Apps to resume listing. - * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/projectId + * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/PROJECT_NUMBER * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5614,7 +5614,7 @@ export namespace firebase_v1beta1 { export interface Params$Resource$Projects$Webapps$Create extends StandardParameters { /** - * The parent Project in which to create an App, in the format:
projects/projectId + * The parent Project in which to create an App, in the format:
projects/PROJECT_NUMBER */ parent?: string; @@ -5626,14 +5626,14 @@ export namespace firebase_v1beta1 { export interface Params$Resource$Projects$Webapps$Get extends StandardParameters { /** - * The fully qualified resource name of the App, in the format:
projects/projectId/webApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/webApps/appId + * The fully qualified resource name of the App, in the format:
projects/PROJECT_NUMBER/webApps/APP_ID
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/webApps/APP_ID */ name?: string; } export interface Params$Resource$Projects$Webapps$Getconfig extends StandardParameters { /** - * The resource name of the App configuration to download, in the format:
projects/projectId/webApps/appId/config
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/webApps/appId + * The resource name of the App configuration to download, in the format:
projects/PROJECT_NUMBER/webApps/APP_ID/config
As an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/webApps/APP_ID */ name?: string; } @@ -5648,7 +5648,7 @@ export namespace firebase_v1beta1 { */ pageToken?: string; /** - * The parent Project for which to list Apps, in the format:
projects/projectId + * The parent Project for which to list Apps, in the format:
projects/PROJECT_NUMBER */ parent?: string; }