@datafire/google_firebase
Advanced tools
Readme
Client library for Firebase Management API
npm install --save @datafire/google_firebase
let google_firebase = require('@datafire/google_firebase').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
The Firebase Management API enables programmatic setup and management of Firebase projects, including a project's Firebase resources and Firebase apps.
Exchange the code passed to your redirect URI for an access_token
google_firebase.oauthCallback({
"code": ""
}, context)
object
stringobject
stringstringstringstringstringExchange a refresh_token for an access_token
google_firebase.oauthRefresh(null, context)
This action has no parameters
object
stringstringstringstringstringLists each [Google Cloud Platform (GCP) Project] (https://cloud.google.com/resource-manager/reference/rest/v1/projects) that can have Firebase resources added to it. A Project will only be listed if: - The caller has sufficient Google 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.
google_firebase.firebase.availableProjects.list({}, context)
object
integer: The maximum number of Projects 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), the server will impose its own limit. This value cannot be negative.string: Token returned from a previous call to ListAvailableProjects indicating where in the set of Projects to resume listing.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_firebase.firebase.projects.list({}, context)
object
integer: The maximum number of Projects 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. This value cannot be negative.string: Token returned from a previous call to ListFirebaseProjects indicating where in the set of Projects to resume listing.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").Removes a ShaCertificate from the specified AndroidApp.
google_firebase.firebase.projects.androidApps.sha.delete({
"name": ""
}, context)
object
string: The resource name of the ShaCertificate to remove from the parent AndroidApp, in the format: projects/PROJECT_IDENTIFIER/androidApps/APP_ID /sha/SHA_HASH Refer to the ShaCertificate name field for details about PROJECT_IDENTIFIER, APP_ID, and SHA_HASH values. You can obtain the full resource name of the ShaCertificate from the response of ListShaCertificates or the original CreateShaCertificate.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").Gets the configuration artifact associated with the specified WebApp.
google_firebase.firebase.projects.webApps.getConfig({
"name": ""
}, context)
object
string: The resource name of the WebApp configuration to download, in the format: projects/PROJECT_IDENTIFIER/webApps/APP_ID/config Since 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 Refer to the WebApp name field for details about PROJECT_IDENTIFIER and APP_ID values.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").Updates the attributes of the specified WebApp.
google_firebase.firebase.projects.webApps.patch({
"name": ""
}, context)
object
string: The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. 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).string: Specifies which fields to update. Note that the fields name, appId, and projectId are all immutable.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_firebase.firebase.projects.androidApps.list({
"parent": ""
}, context)
object
string: The resource name of the parent FirebaseProject for which to list each associated AndroidApp, in the format: projects/PROJECT_IDENTIFIER /androidApps Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.integer: 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.string: Token returned from a previous call to ListAndroidApps indicating where in the set of Apps to resume listing.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_firebase.firebase.projects.androidApps.create({
"parent": ""
}, context)
object
string: The resource name of the parent FirebaseProject in which to create an AndroidApp, in the format: projects/PROJECT_IDENTIFIER/androidApps Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").Lists the 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, which is the geographical location where the Project's 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 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 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.
google_firebase.firebase.projects.availableLocations.list({
"parent": ""
}, context)
object
string: The FirebaseProject for which to list GCP resource locations, in the format: projects/PROJECT_IDENTIFIER Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values. If no unique project identifier is specified (that is, projects/-), the returned list does not take into account org-specific or project-specific location restrictions.integer: 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.string: Token returned from a previous call to ListAvailableLocations indicating where in the list of locations to resume listing.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject. This method creates an App Engine application with a default Cloud Storage bucket, located in the specified locationId. This location must be one of the available GCP resource locations. After the default GCP resource location is finalized, or if it was already set, it cannot be changed. The default GCP resource location for the specified FirebaseProject might already be set because either the underlying GCP Project already has an App Engine application or FinalizeDefaultLocation was previously called with a specified locationId. Any new calls to FinalizeDefaultLocation with a different specified locationId will return a 409 error. The result of this call is an Operation, which can be used to track the provisioning process. The 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 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 are required. To call FinalizeDefaultLocation, a member must be an Owner of the Project.
google_firebase.firebase.projects.defaultLocation.finalize({
"parent": ""
}, context)
object
string: The resource name of the FirebaseProject for which the default GCP resource location will be set, in the format: projects/PROJECT_IDENTIFIER Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_firebase.firebase.projects.iosApps.list({
"parent": ""
}, context)
object
string: The resource name of the parent FirebaseProject for which to list each associated IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.integer: 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.string: Token returned from a previous call to ListIosApps indicating where in the set of Apps to resume listing.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_firebase.firebase.projects.iosApps.create({
"parent": ""
}, context)
object
string: The resource name of the parent FirebaseProject in which to create an IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").Lists the SHA-1 and SHA-256 certificates for the specified AndroidApp.
google_firebase.firebase.projects.androidApps.sha.list({
"parent": ""
}, context)
object
string: The resource name of the parent AndroidApp for which to list each associated ShaCertificate, in the format: projects/PROJECT_IDENTIFIER /androidApps/APP_ID Since 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 Refer to the AndroidApp name field for details about PROJECT_IDENTIFIER and APP_ID values.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").Adds a ShaCertificate to the specified AndroidApp.
google_firebase.firebase.projects.androidApps.sha.create({
"parent": ""
}, context)
object
string: The resource name of the parent AndroidApp to which to add a ShaCertificate, in the format: projects/PROJECT_IDENTIFIER/androidApps/ APP_ID Since 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 Refer to the AndroidApp name field for details about PROJECT_IDENTIFIER and APP_ID values.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_firebase.firebase.projects.webApps.list({
"parent": ""
}, context)
object
string: The resource name of the parent FirebaseProject for which to list each associated WebApp, in the format: projects/PROJECT_IDENTIFIER/webApps Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.integer: 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.string: Token returned from a previous call to ListWebApps indicating where in the set of Apps to resume listing.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_firebase.firebase.projects.webApps.create({
"parent": ""
}, context)
object
string: The resource name of the parent FirebaseProject in which to create a WebApp, in the format: projects/PROJECT_IDENTIFIER/webApps Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").Links the specified FirebaseProject with an existing Google Analytics account. 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. The result of this call is an Operation. Poll the Operation to track the provisioning process by calling GetOperation until done is true. When done is true, the Operation has either succeeded or failed. If the Operation succeeded, its response is set to an AnalyticsDetails; if the Operation failed, its 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 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.
google_firebase.firebase.projects.addGoogleAnalytics({
"parent": ""
}, context)
object
string: The resource name of the FirebaseProject to link to an existing Google Analytics account, in the format: projects/PROJECT_IDENTIFIER Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").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 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.
google_firebase.firebase.projects.removeAnalytics({
"parent": ""
}, context)
object
string: The resource name of the FirebaseProject to unlink from its Google Analytics account, in the format: projects/PROJECT_IDENTIFIER Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").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).
google_firebase.firebase.projects.searchApps({
"parent": ""
}, context)
object
string: The parent FirebaseProject for which to list Apps, in the format: projects/ PROJECT_IDENTIFIER Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.string: A query string compatible with Google's AIP-160 standard. Use any of the following fields in a query: * app_id * namespace * platform We also support the following "virtual" fields (fields which are not actually part of the returned resource object, but can be queried as if they are pre-populated with specific values): * sha1_hash: This field is considered to be a repeated string field, populated with the list of all SHA-1 certificate fingerprints registered with the app. This list is empty if the app is not an Android app. * sha256_hash: This field is considered to be a repeated string field, populated with the list of all SHA-256 certificate fingerprints registered with the app. This list is empty if the app is not an Android app. * app_store_id: This field is considered to be a singular string field, populated with the Apple App Store ID registered with the app. This field is empty if the app is not an iOS app. * team_id: This field is considered to be a singular string field, populated with the Apple team ID registered with the app. This field is empty if the app is not an iOS app.integer: 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.string: Token returned from a previous call to SearchFirebaseApps indicating where in the set of Apps to resume listing.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").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 has the same underlying GCP identifiers (projectNumber and projectId). This allows for easy interop with Google APIs. The result of this call is an Operation. Poll the Operation to track the provisioning process by calling GetOperation until done is true. When done is true, the Operation has either succeeded or failed. If the Operation succeeded, its response is set to a FirebaseProject; if the Operation failed, its 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.
google_firebase.firebase.projects.addFirebase({
"project": ""
}, context)
object
string: The resource name of the GCP Project to which Firebase resources will be added, in the format: projects/PROJECT_IDENTIFIER Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values. After calling AddFirebase, the unique Project identifiers ( projectNumber and projectId) of the underlying GCP Project are also the identifiers of the FirebaseProject.string (values: 1, 2): V1 error format.string: OAuth access token.string (values: json, media, proto): Data format for response.string: JSONPstring: Selector specifying which fields to include in a partial response.string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string: OAuth 2.0 token for the current user.boolean: Returns response with indentations and line breaks.string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.string: Upload protocol for media (e.g. "raw", "multipart").string: Legacy upload protocol for media (e.g. "media", "multipart").object: All fields are required.
string: Deprecated. Instead, to set a Project's default GCP resource location, call FinalizeDefaultLocation after you add Firebase resources to the GCP Project. The ID of the Project's default GCP resource location. The location must be one of the available GCP resource locations.string: Deprecated. Instead, to link a Project with a Google Analytics account, call AddGoogleAnalytics after you add Firebase resources to the GCP Project. The region code (CLDR) that the account will use for Google Analytics data For example: US, GB, or DE In Java, use com.google.i18n.identifiers.RegionCode.string: Deprecated. Instead, to link a Project with a Google Analytics account, call AddGoogleAnalytics after you add Firebase resources to the GCP Project. The time zone that the account will use for Google Analytics data. For example: America/Los_Angeles or Africa/Abidjanobject
string: The ID for the existing Google Analytics account that you want to link with the FirebaseProject. Specifying this field will provision a new Google Analytics property in your Google Analytics account and associate the new property with the FirebaseProject.string: The ID for the existing Google Analytics property that you want to associate with the FirebaseProject.object
string: The default Firebase Realtime Database URL.string: The ID of the Project's default GCP resource location. The location is one of the available GCP resource locations. This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call FinalizeDefaultLocation after you add Firebase resources to the Project.string: Immutable. A user-assigned unique identifier for the FirebaseProject. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project.string: The default Cloud Storage for Firebase storage bucket name.object
array: - For AndroidApps and IosApps: a map of app to streamId for each Firebase App in the specified FirebaseProject. Each app and streamId appears only once. - For WebApps: a map of app to streamId and measurementId for each WebApp in the specified FirebaseProject. Each app, streamId, and measurementId appears only once.
object: Details of a Google Analytics property
string: The display name of the Google Analytics property associated with the specified FirebaseProject.string: The globally unique, Google-assigned identifier of the Google Analytics property associated with the specified FirebaseProject. If you called AddGoogleAnalytics to link the FirebaseProject with a Google Analytics account, the value in this id field is the same as the ID of the property either specified or provisioned with that call to AddGoogleAnalytics.object: Details of a Firebase App for Android.
string: Immutable. The globally unique, Firebase-assigned identifier for the AndroidApp. This identifier should be treated as an opaque token, as the data format is not specified.string: The user-assigned display name for the AndroidApp.string: The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. 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).string: Immutable. The canonical package name of the Android app as would appear in the Google Play Developer Console.string: Immutable. A user-assigned unique identifier of the parent FirebaseProject for the AndroidApp.object: Configuration metadata of a single Firebase App for Android.
string: The contents of the JSON configuration file.string: The filename that the configuration artifact for the AndroidApp is typically saved as. For example: google-services.jsonobject: The default resources associated with the Project.
string: The default Firebase Hosting site name, in the format: PROJECT_ID Though rare, your projectId might already be used as the name for an existing Hosting site in another project (learn more about creating non-default, additional sites). In these cases, your projectId is appended with a hyphen then five alphanumeric characters to create your default Hosting site name. For example, if your projectId is myproject123, your default Hosting site name might be: myproject123-a5c16string: The ID of the Project's default GCP resource location. The location is one of the available GCP resource locations. This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call FinalizeDefaultLocation after you add Firebase resources to the Project.string: The default Firebase Realtime Database instance name, in the format: PROJECT_ID Though rare, your projectId might already be used as the name for an existing Realtime Database instance in another project (learn more about database sharding). In these cases, your projectId is appended with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if your projectId is myproject123, your default database instance name might be: myproject123-a5c16string: The default Cloud Storage for Firebase storage bucket, in the format: PROJECT_ID.appspot.comobject: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.object
string: The ID of the Project's default GCP resource location. The location must be one of the available GCP resource locations.object: A high-level summary of an App.
string: Output only. Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.string: The user-assigned display name of the Firebase App.string: The resource name of the Firebase App, in the format: projects/PROJECT_ID /iosApps/APP_ID or projects/PROJECT_ID/androidApps/APP_ID or projects/ PROJECT_ID/webApps/APP_IDstring: 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.string (values: PLATFORM_UNSPECIFIED, IOS, ANDROID, WEB): The platform of the Firebase App.object: A FirebaseProject is the top-level Firebase entity. It is the container for Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets), and other Firebase and Google Cloud Platform (GCP) resources. You create a FirebaseProject by calling AddFirebase and specifying an existing GCP Project. This adds Firebase resources to the existing GCP Project. Since a FirebaseProject is actually also a GCP Project, a FirebaseProject has the same underlying GCP identifiers (projectNumber and projectId). This allows for easy interop with Google APIs.
string: The user-assigned display name of the Project.string: The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId.string: Immutable. A user-assigned unique identifier for the Project. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project.string: Immutable. The globally unique, Google-assigned canonical identifier for the Project. Use this identifier when configuring integrations and/or making API calls to Firebase or third-party services.string (values: STATE_UNSPECIFIED, ACTIVE, DELETED): Output only. The lifecycle state of the Project. Updates to the state must be performed via com.google.cloudresourcemanager.v1.Projects.DeleteProject and com.google.cloudresourcemanager.v1.Projects.UndeleteProjectobject: Details of a Firebase App for iOS.
string: Immutable. The globally unique, Firebase-assigned identifier for the IosApp. This identifier should be treated as an opaque token, as the data format is not specified.string: The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.string: Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.string: The user-assigned display name for the IosApp.string: The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. 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).string: Immutable. A user-assigned unique identifier of the parent FirebaseProject for the IosApp.object: Configuration metadata of a single Firebase App for iOS.
string: The content of the XML configuration file.string: The filename that the configuration artifact for the IosApp is typically saved as. For example: GoogleService-Info.plistobject
array: List of each AndroidApp associated with the specified FirebaseProject.
string: If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent call to ListAndroidApps to find the next group of Apps. Page tokens are short-lived and should not be persisted.object
array: One page of results from a call to ListAvailableLocations.
string: If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results and all available locations have been listed. This token can be used in a subsequent call to ListAvailableLocations to find more locations. Page tokens are short-lived and should not be persisted.object
string: If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent calls to ListAvailableProjects to find the next group of Projects. Page tokens are short-lived and should not be persisted.array: The list of GCP Projects which can have Firebase resources added to them.
object
string: If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent calls to ListFirebaseProjects to find the next group of Projects. Page tokens are short-lived and should not be persisted.array: One page of the list of Projects that are accessible to the caller.
object
array: List of each IosApp associated with the specified FirebaseProject.
string: If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent call to ListIosApps to find the next group of Apps. Page tokens are short-lived and should not be persisted.object
array: The list of each ShaCertificate associated with the AndroidApp.
object
array: List of each WebApp associated with the specified FirebaseProject.
string: If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent call to ListWebApps to find the next group of Apps. Page tokens are short-lived and should not be persisted.object: A GCP resource location that can be selected for a FirebaseProject.
array: Products and services that are available in the GCP resource location.
string (values: LOCATION_FEATURE_UNSPECIFIED, FIRESTORE, DEFAULT_STORAGE, FUNCTIONS)string: The ID of the GCP resource location. It will be one of the available GCP resource locations.string (values: LOCATION_TYPE_UNSPECIFIED, REGIONAL, MULTI_REGIONAL): Indicates whether the GCP resource location is a regional or multi-regional location for data replication.object: This is proto2's version of MessageSet.object: This resource represents a long-running operation that is the result of a network API call.
boolean: If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.object: Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.string: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.object: The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.object: A reference to a Google Cloud Platform (GCP) Project.
string: The user-assigned display name of the GCP Project, for example: My Appstring: The ID of the Project's default GCP resource location. The location is one of the available GCP resource locations. Not all Projects will have this field populated. If it is not populated, it means that the Project does not yet have a default GCP resource location. To set a Project's default GCP resource location, call FinalizeDefaultLocation after you add Firebase resources to the Project.string: The resource name of the GCP Project to which Firebase resources can be added, in the format: projects/PROJECT_IDENTIFIER Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.object
string: Optional. The ID of the Google Analytics property associated with the specified FirebaseProject. - If not set, then the Google Analytics property that is currently associated with the specified FirebaseProject is removed. - If set, and the specified FirebaseProject is currently associated with a different Google Analytics property, then the response is a 412 Precondition Failed error.object
array: One page of results from a call to SearchFirebaseApps.
string: If the result list is too large to fit in a single response, then a token is returned. This token can be used in a subsequent calls to SearchFirebaseApps to find the next group of Apps. Page tokens are short-lived and should not be persisted.object: A SHA-1 or SHA-256 certificate associated with the AndroidApp.
string (values: SHA_CERTIFICATE_TYPE_UNSPECIFIED, SHA_1, SHA_256): The type of SHA certificate encoded in the hash.string: 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 (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. 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). * SHA_HASH: the certificate hash for the App (see shaHash).string: The certificate hash for the AndroidApp.object: The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
integer: The status code, which should be an enum value of google.rpc.Code.array: A list of messages that carry the error details. There is a common set of message types for APIs to use.
objectstring: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.object: Wire-format for a Status object
integer: The canonical error code (see codes.proto) that most closely corresponds to this status. May be missing.integer: Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.protostring: Detail messagestring: The following are usually only present when code != 0 Space to which this status belongsobject: A mapping of a Firebase App to a Google Analytics data stream
string: The resource name of the Firebase App associated with the Google Analytics data stream, in the format: projects/PROJECT_IDENTIFIER/androidApps/APP_ID or projects/PROJECT_IDENTIFIER/iosApps/APP_ID or projects/PROJECT_IDENTIFIER /webApps/APP_ID Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.string: Applicable for Firebase Web Apps only. The unique Google-assigned identifier of the Google Analytics web stream associated with the Firebase Web App. Firebase SDKs use this ID to interact with Google Analytics APIs. Learn more about this ID and Google Analytics web streams in the Analytics documentation.string: The unique Google-assigned identifier of the Google Analytics data stream associated with the Firebase App. Learn more about Google Analytics data streams in the Analytics documentation.object: Details of a Firebase App for the web.
string: Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.array: The URLs where the WebApp is hosted.
stringstring: The user-assigned display name for the WebApp.string: The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. 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).string: Immutable. A user-assigned unique identifier of the parent FirebaseProject for the WebApp.string: 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.object: Configuration metadata of a single Firebase App for the web.
string: The API key associated with the WebApp.string: Immutable. The globally unique, Firebase-assigned identifier for the WebApp.string: The domain Firebase Auth configures for OAuth redirects, in the format: PROJECT_ID.firebaseapp.comstring: The default Firebase Realtime Database URL.string: The ID of the Project's default GCP resource location. The location is one of the available GCP resource locations. This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call FinalizeDefaultLocation after you add Firebase resources to the Project.string: The unique Google-assigned identifier of the Google Analytics web stream associated with the WebApp. Firebase SDKs use this ID to interact with Google Analytics APIs. This field is only present if the WebApp is linked to a web stream in a Google Analytics App + Web property. Learn more about this ID and Google Analytics web streams in the Analytics documentation. To generate a measurementId and link the WebApp with a Google Analytics web stream, call AddGoogleAnalytics. For apps using the Firebase JavaScript SDK v7.20.0 and later, Firebase dynamically fetches the measurementId when your app initializes Analytics. Having this ID in your config object is optional, but it does serve as a fallback in the rare case that the dynamic fetch fails.string: The sender ID for use with Firebase Cloud Messaging.string: Immutable. A user-assigned unique identifier for the FirebaseProject.string: The default Cloud Storage for Firebase storage bucket name.FAQs
DataFire integration for Firebase Management API
The npm package @datafire/google_firebase receives a total of 0 weekly downloads. As such, @datafire/google_firebase popularity was classified as not popular.
We found that @datafire/google_firebase demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.