@datafire/google_firebase
Client library for Firebase Management API
Installation and Usage
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);
});
Description
The Firebase Management API enables programmatic setup and management of Firebase projects, including a project's Firebase resources and Firebase apps.
Actions
oauthCallback
Exchange the code passed to your redirect URI for an access_token
google_firebase.oauthCallback({
"code": ""
}, context)
Input
- input
object
- code required
string
- code required
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
oauthRefresh
Exchange a refresh_token for an access_token
google_firebase.oauthRefresh(null, context)
Input
This action has no parameters
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
firebase.availableProjects.list
Lists 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)
Input
- input
object
- pageSize
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. - pageToken
string
: Token returned from a previous call toListAvailableProjects
indicating where in the set of Projects to resume listing. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- pageSize
Output
firebase.projects.list
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)
Input
- input
object
- pageSize
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. - pageToken
string
: Token returned from a previous call toListFirebaseProjects
indicating where in the set of Projects to resume listing. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- pageSize
Output
- output ListFirebaseProjectsResponse
firebase.projects.androidApps.sha.delete
Removes a ShaCertificate from the specified AndroidApp.
google_firebase.firebase.projects.androidApps.sha.delete({
"name": ""
}, context)
Input
- input
object
- name required
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 theShaCertificate
name
field for details about PROJECT_IDENTIFIER, APP_ID, and SHA_HASH values. You can obtain the full resource name of theShaCertificate
from the response ofListShaCertificates
or the originalCreateShaCertificate
. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output Empty
firebase.projects.webApps.getConfig
Gets the configuration artifact associated with the specified WebApp.
google_firebase.firebase.projects.webApps.getConfig({
"name": ""
}, context)
Input
- input
object
- name required
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 theWebApp
name
field for details about PROJECT_IDENTIFIER and APP_ID values. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output WebAppConfig
firebase.projects.webApps.patch
Updates the attributes of the specified WebApp.
google_firebase.firebase.projects.webApps.patch({
"name": ""
}, context)
Input
- input
object
- name required
string
: The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project'sProjectNumber
(recommended) or itsProjectId
. 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 theProjectId
. * APP_ID: the globally unique, Firebase-assigned identifier for the App (seeappId
). - updateMask
string
: Specifies which fields to update. Note that the fieldsname
,appId
, andprojectId
are all immutable. - body WebApp
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output WebApp
firebase.projects.androidApps.list
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)
Input
- input
object
- parent required
string
: The resource name of the parent FirebaseProject for which to list each associated AndroidApp, in the format: projects/PROJECT_IDENTIFIER /androidApps Refer to theFirebaseProject
name
field for details about PROJECT_IDENTIFIER values. - pageSize
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. - pageToken
string
: Token returned from a previous call toListAndroidApps
indicating where in the set of Apps to resume listing. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output ListAndroidAppsResponse
firebase.projects.androidApps.create
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)
Input
- input
object
- parent required
string
: The resource name of the parent FirebaseProject in which to create an AndroidApp, in the format: projects/PROJECT_IDENTIFIER/androidApps Refer to theFirebaseProject
name
field for details about PROJECT_IDENTIFIER values. - body AndroidApp
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output Operation
firebase.projects.availableLocations.list
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)
Input
- input
object
- parent required
string
: The FirebaseProject for which to list GCP resource locations, in the format: projects/PROJECT_IDENTIFIER Refer to theFirebaseProject
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. - pageSize
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. - pageToken
string
: Token returned from a previous call toListAvailableLocations
indicating where in the list of locations to resume listing. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
firebase.projects.defaultLocation.finalize
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)
Input
- input
object
- parent required
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 theFirebaseProject
name
field for details about PROJECT_IDENTIFIER values. - body FinalizeDefaultLocationRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output Operation
firebase.projects.iosApps.list
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)
Input
- input
object
- parent required
string
: The resource name of the parent FirebaseProject for which to list each associated IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to theFirebaseProject
name
field for details about PROJECT_IDENTIFIER values. - pageSize
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. - pageToken
string
: Token returned from a previous call toListIosApps
indicating where in the set of Apps to resume listing. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output ListIosAppsResponse
firebase.projects.iosApps.create
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)
Input
- input
object
- parent required
string
: The resource name of the parent FirebaseProject in which to create an IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to theFirebaseProject
name
field for details about PROJECT_IDENTIFIER values. - body IosApp
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output Operation
firebase.projects.androidApps.sha.list
Lists the SHA-1 and SHA-256 certificates for the specified AndroidApp.
google_firebase.firebase.projects.androidApps.sha.list({
"parent": ""
}, context)
Input
- input
object
- parent required
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 theAndroidApp
name
field for details about PROJECT_IDENTIFIER and APP_ID values. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output ListShaCertificatesResponse
firebase.projects.androidApps.sha.create
Adds a ShaCertificate to the specified AndroidApp.
google_firebase.firebase.projects.androidApps.sha.create({
"parent": ""
}, context)
Input
- input
object
- parent required
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 theAndroidApp
name
field for details about PROJECT_IDENTIFIER and APP_ID values. - body ShaCertificate
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output ShaCertificate
firebase.projects.webApps.list
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)
Input
- input
object
- parent required
string
: The resource name of the parent FirebaseProject for which to list each associated WebApp, in the format: projects/PROJECT_IDENTIFIER/webApps Refer to theFirebaseProject
name
field for details about PROJECT_IDENTIFIER values. - pageSize
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. - pageToken
string
: Token returned from a previous call toListWebApps
indicating where in the set of Apps to resume listing. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output ListWebAppsResponse
firebase.projects.webApps.create
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)
Input
- input
object
- parent required
string
: The resource name of the parent FirebaseProject in which to create a WebApp, in the format: projects/PROJECT_IDENTIFIER/webApps Refer to theFirebaseProject
name
field for details about PROJECT_IDENTIFIER values. - body WebApp
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output Operation
firebase.projects.addGoogleAnalytics
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)
Input
- input
object
- parent required
string
: The resource name of the FirebaseProject to link to an existing Google Analytics account, in the format: projects/PROJECT_IDENTIFIER Refer to theFirebaseProject
name
field for details about PROJECT_IDENTIFIER values. - body AddGoogleAnalyticsRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output Operation
firebase.projects.removeAnalytics
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)
Input
- input
object
- parent required
string
: The resource name of the FirebaseProject to unlink from its Google Analytics account, in the format: projects/PROJECT_IDENTIFIER Refer to theFirebaseProject
name
field for details about PROJECT_IDENTIFIER values. - body RemoveAnalyticsRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output Empty
firebase.projects.searchApps
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)
Input
- input
object
- parent required
string
: The parent FirebaseProject for which to list Apps, in the format: projects/ PROJECT_IDENTIFIER Refer to theFirebaseProject
name
field for details about PROJECT_IDENTIFIER values. - filter
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 repeatedstring
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 repeatedstring
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 singularstring
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 singularstring
field, populated with the Apple team ID registered with the app. This field is empty if the app is not an iOS app. - pageSize
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. - pageToken
string
: Token returned from a previous call toSearchFirebaseApps
indicating where in the set of Apps to resume listing. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- parent required
Output
- output SearchFirebaseAppsResponse
firebase.projects.addFirebase
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)
Input
- input
object
- project required
string
: The resource name of the GCPProject
to which Firebase resources will be added, in the format: projects/PROJECT_IDENTIFIER Refer to theFirebaseProject
name
field for details about PROJECT_IDENTIFIER values. After callingAddFirebase
, the unique Project identifiers (projectNumber
andprojectId
) of the underlying GCPProject
are also the identifiers of the FirebaseProject. - body AddFirebaseRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- project required
Output
- output Operation
Definitions
AddFirebaseRequest
- AddFirebaseRequest
object
: All fields are required.- locationId
string
: Deprecated. Instead, to set a Project's default GCP resource location, callFinalizeDefaultLocation
after you add Firebase resources to the GCPProject
. The ID of the Project's default GCP resource location. The location must be one of the available GCP resource locations. - regionCode
string
: Deprecated. Instead, to link a Project with a Google Analytics account, callAddGoogleAnalytics
after you add Firebase resources to the GCPProject
. The region code (CLDR) that the account will use for Google Analytics data For example: US, GB, or DE In Java, usecom.google.i18n.identifiers.RegionCode
. - timeZone
string
: Deprecated. Instead, to link a Project with a Google Analytics account, callAddGoogleAnalytics
after you add Firebase resources to the GCPProject
. The time zone that the account will use for Google Analytics data. For example: America/Los_Angeles or Africa/Abidjan
- locationId
AddGoogleAnalyticsRequest
- AddGoogleAnalyticsRequest
object
- analyticsAccountId
string
: The ID for the existing Google Analytics account that you want to link with theFirebaseProject
. Specifying this field will provision a new Google Analytics property in your Google Analytics account and associate the new property with theFirebaseProject
. - analyticsPropertyId
string
: The ID for the existing Google Analytics property that you want to associate with theFirebaseProject
.
- analyticsAccountId
AdminSdkConfig
- AdminSdkConfig
object
- databaseURL
string
: The default Firebase Realtime Database URL. - locationId
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, callFinalizeDefaultLocation
after you add Firebase resources to the Project. - projectId
string
: Immutable. A user-assigned unique identifier for theFirebaseProject
. 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. - storageBucket
string
: The default Cloud Storage for Firebase storage bucket name.
- databaseURL
AnalyticsDetails
- AnalyticsDetails
object
- analyticsProperty AnalyticsProperty
- streamMappings
array
: - ForAndroidApps
andIosApps
: a map ofapp
tostreamId
for each Firebase App in the specifiedFirebaseProject
. Eachapp
andstreamId
appears only once. - ForWebApps
: a map ofapp
tostreamId
andmeasurementId
for eachWebApp
in the specifiedFirebaseProject
. Eachapp
,streamId
, andmeasurementId
appears only once.- items StreamMapping
AnalyticsProperty
- AnalyticsProperty
object
: Details of a Google Analytics property- displayName
string
: The display name of the Google Analytics property associated with the specifiedFirebaseProject
. - id
string
: The globally unique, Google-assigned identifier of the Google Analytics property associated with the specifiedFirebaseProject
. If you calledAddGoogleAnalytics
to link theFirebaseProject
with a Google Analytics account, the value in thisid
field is the same as the ID of the property either specified or provisioned with that call toAddGoogleAnalytics
.
- displayName
AndroidApp
- AndroidApp
object
: Details of a Firebase App for Android.- appId
string
: Immutable. The globally unique, Firebase-assigned identifier for theAndroidApp
. This identifier should be treated as an opaque token, as the data format is not specified. - displayName
string
: The user-assigned display name for theAndroidApp
. - name
string
: The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the parent Project'sProjectNumber
(recommended) or itsProjectId
. 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 theProjectId
. * APP_ID: the globally unique, Firebase-assigned identifier for the App (seeappId
). - packageName
string
: Immutable. The canonical package name of the Android app as would appear in the Google Play Developer Console. - projectId
string
: Immutable. A user-assigned unique identifier of the parent FirebaseProject for theAndroidApp
.
- appId
AndroidAppConfig
- AndroidAppConfig
object
: Configuration metadata of a single Firebase App for Android.- configFileContents
string
: The contents of the JSON configuration file. - configFilename
string
: The filename that the configuration artifact for theAndroidApp
is typically saved as. For example:google-services.json
- configFileContents
DefaultResources
- DefaultResources
object
: The default resources associated with the Project.- hostingSite
string
: The default Firebase Hosting site name, in the format: PROJECT_ID Though rare, yourprojectId
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, yourprojectId
is appended with a hyphen then five alphanumeric characters to create your default Hosting site name. For example, if yourprojectId
ismyproject123
, your default Hosting site name might be:myproject123-a5c16
- locationId
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, callFinalizeDefaultLocation
after you add Firebase resources to the Project. - realtimeDatabaseInstance
string
: The default Firebase Realtime Database instance name, in the format: PROJECT_ID Though rare, yourprojectId
might already be used as the name for an existing Realtime Database instance in another project (learn more about database sharding). In these cases, yourprojectId
is appended with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if yourprojectId
ismyproject123
, your default database instance name might be:myproject123-a5c16
- storageBucket
string
: The default Cloud Storage for Firebase storage bucket, in the format: PROJECT_ID.appspot.com
- hostingSite
Empty
- Empty
object
: 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 forEmpty
is empty JSON object{}
.
FinalizeDefaultLocationRequest
- FinalizeDefaultLocationRequest
object
- locationId
string
: The ID of the Project's default GCP resource location. The location must be one of the available GCP resource locations.
- locationId
FirebaseAppInfo
- FirebaseAppInfo
object
: A high-level summary of an App.- appId
string
: Output only. Immutable. The globally unique, Firebase-assigned identifier for theWebApp
. This identifier should be treated as an opaque token, as the data format is not specified. - displayName
string
: The user-assigned display name of the Firebase App. - name
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_ID - namespace
string
: Output only. Immutable. The platform-specific identifier of the App. Note: For most use cases, useappId
, which is the canonical, globally unique identifier for referencing an App. This string is derived from a native identifier for each platform:packageName
for anAndroidApp
,bundleId
for anIosApp
, andwebId
for aWebApp
. Its contents should be treated as opaque, as the native identifier format may change as platforms evolve. This string is only unique within aFirebaseProject
and its associated Apps. - platform
string
(values: PLATFORM_UNSPECIFIED, IOS, ANDROID, WEB): The platform of the Firebase App.
- appId
FirebaseProject
- FirebaseProject
object
: AFirebaseProject
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 aFirebaseProject
by calling AddFirebase and specifying an existing GCPProject
. This adds Firebase resources to the existing GCPProject
. Since a FirebaseProject is actually also a GCPProject
, aFirebaseProject
has the same underlying GCP identifiers (projectNumber
andprojectId
). This allows for easy interop with Google APIs.- displayName
string
: The user-assigned display name of the Project. - name
string
: The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the Project'sProjectNumber
(recommended) or itsProjectId
. 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 theProjectId
. - 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. - projectNumber
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. - resources DefaultResources
- state
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.UndeleteProject
- displayName
IosApp
- IosApp
object
: Details of a Firebase App for iOS.- appId
string
: Immutable. The globally unique, Firebase-assigned identifier for theIosApp
. This identifier should be treated as an opaque token, as the data format is not specified. - appStoreId
string
: The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store. - bundleId
string
: Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore. - displayName
string
: The user-assigned display name for theIosApp
. - name
string
: The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project'sProjectNumber
(recommended) or itsProjectId
. 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 theProjectId
. * APP_ID: the globally unique, Firebase-assigned identifier for the App (seeappId
). - projectId
string
: Immutable. A user-assigned unique identifier of the parent FirebaseProject for theIosApp
.
- appId
IosAppConfig
- IosAppConfig
object
: Configuration metadata of a single Firebase App for iOS.- configFileContents
string
: The content of the XML configuration file. - configFilename
string
: The filename that the configuration artifact for theIosApp
is typically saved as. For example:GoogleService-Info.plist
- configFileContents
ListAndroidAppsResponse
- ListAndroidAppsResponse
object
- apps
array
: List of eachAndroidApp
associated with the specifiedFirebaseProject
.- items AndroidApp
- nextPageToken
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 toListAndroidApps
to find the next group of Apps. Page tokens are short-lived and should not be persisted.
- apps
ListAvailableLocationsResponse
- ListAvailableLocationsResponse
object
- locations
array
: One page of results from a call toListAvailableLocations
.- items Location
- nextPageToken
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 toListAvailableLocations
to find more locations. Page tokens are short-lived and should not be persisted.
- locations
ListAvailableProjectsResponse
- ListAvailableProjectsResponse
object
- nextPageToken
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 toListAvailableProjects
to find the next group of Projects. Page tokens are short-lived and should not be persisted. - projectInfo
array
: The list of GCPProjects
which can have Firebase resources added to them.- items ProjectInfo
- nextPageToken
ListFirebaseProjectsResponse
- ListFirebaseProjectsResponse
object
- nextPageToken
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 toListFirebaseProjects
to find the next group of Projects. Page tokens are short-lived and should not be persisted. - results
array
: One page of the list of Projects that are accessible to the caller.- items FirebaseProject
- nextPageToken
ListIosAppsResponse
- ListIosAppsResponse
object
- apps
array
: List of eachIosApp
associated with the specifiedFirebaseProject
.- items IosApp
- nextPageToken
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 toListIosApps
to find the next group of Apps. Page tokens are short-lived and should not be persisted.
- apps
ListShaCertificatesResponse
- ListShaCertificatesResponse
object
- certificates
array
: The list of eachShaCertificate
associated with theAndroidApp
.- items ShaCertificate
- certificates
ListWebAppsResponse
- ListWebAppsResponse
object
- apps
array
: List of eachWebApp
associated with the specifiedFirebaseProject
.- items WebApp
- nextPageToken
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 toListWebApps
to find the next group of Apps. Page tokens are short-lived and should not be persisted.
- apps
Location
- Location
object
: A GCP resource location that can be selected for a FirebaseProject.- features
array
: Products and services that are available in the GCP resource location.- items
string
(values: LOCATION_FEATURE_UNSPECIFIED, FIRESTORE, DEFAULT_STORAGE, FUNCTIONS)
- items
- locationId
string
: The ID of the GCP resource location. It will be one of the available GCP resource locations. - type
string
(values: LOCATION_TYPE_UNSPECIFIED, REGIONAL, MULTI_REGIONAL): Indicates whether the GCP resource location is a regional or multi-regional location for data replication.
- features
MessageSet
- MessageSet
object
: This is proto2's version of MessageSet.
Operation
- Operation
object
: This resource represents a long-running operation that is the result of a network API call.- done
boolean
: If the value isfalse
, it means the operation is still in progress. Iftrue
, the operation is completed, and eithererror
orresponse
is available. - error Status
- metadata
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. - name
string
: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, thename
should be a resource name ending withoperations/{unique_id}
. - response
object
: The normal response of the operation in case of success. If the original method returns no data on success, such asDelete
, the response isgoogle.protobuf.Empty
. If the original method is standardGet
/Create
/Update
, the response should be the resource. For other methods, the response should have the typeXxxResponse
, whereXxx
is the original method name. For example, if the original method name isTakeSnapshot()
, the inferred response type isTakeSnapshotResponse
.
- done
ProjectInfo
- ProjectInfo
object
: A reference to a Google Cloud Platform (GCP)Project
.- displayName
string
: The user-assigned display name of the GCPProject
, for example:My App
- locationId
string
: 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, callFinalizeDefaultLocation
after you add Firebase resources to the Project. - project
string
: The resource name of the GCPProject
to which Firebase resources can be added, in the format: projects/PROJECT_IDENTIFIER Refer to theFirebaseProject
name
field for details about PROJECT_IDENTIFIER values.
- displayName
RemoveAnalyticsRequest
- RemoveAnalyticsRequest
object
- analyticsPropertyId
string
: Optional. The ID of the Google Analytics property associated with the specifiedFirebaseProject
. - If not set, then the Google Analytics property that is currently associated with the specifiedFirebaseProject
is removed. - If set, and the specifiedFirebaseProject
is currently associated with a different Google Analytics property, then the response is a412 Precondition Failed
error.
- analyticsPropertyId
SearchFirebaseAppsResponse
- SearchFirebaseAppsResponse
object
- apps
array
: One page of results from a call toSearchFirebaseApps
.- items FirebaseAppInfo
- nextPageToken
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 toSearchFirebaseApps
to find the next group of Apps. Page tokens are short-lived and should not be persisted.
- apps
ShaCertificate
- ShaCertificate
object
: A SHA-1 or SHA-256 certificate associated with the AndroidApp.- certType
string
(values: SHA_CERTIFICATE_TYPE_UNSPECIFIED, SHA_1, SHA_256): The type of SHA certificate encoded in the hash. - name
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'sProjectNumber
(recommended) or itsProjectId
. 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 theProjectId
. * APP_ID: the globally unique, Firebase-assigned identifier for the App (seeappId
). * SHA_HASH: the certificate hash for the App (seeshaHash
). - shaHash
string
: The certificate hash for theAndroidApp
.
- certType
Status
- Status
object
: TheStatus
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. EachStatus
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.- code
integer
: The status code, which should be an enum value of google.rpc.Code. - details
array
: A list of messages that carry the error details. There is a common set of message types for APIs to use.- items
object
- items
- message
string
: 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.
- code
StatusProto
- StatusProto
object
: Wire-format for a Status object- canonicalCode
integer
: The canonical error code (see codes.proto) that most closely corresponds to this status. May be missing. - code
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.proto - message
string
: Detail message - messageSet MessageSet
- space
string
: The following are usually only present when code != 0 Space to which this status belongs
- canonicalCode
StreamMapping
- StreamMapping
object
: A mapping of a Firebase App to a Google Analytics data stream- app
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 theFirebaseProject
name
field for details about PROJECT_IDENTIFIER values. - measurementId
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. - streamId
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.
- app
WebApp
- WebApp
object
: Details of a Firebase App for the web.- appId
string
: Immutable. The globally unique, Firebase-assigned identifier for theWebApp
. This identifier should be treated as an opaque token, as the data format is not specified. - appUrls
array
: The URLs where theWebApp
is hosted.- items
string
- items
- displayName
string
: The user-assigned display name for theWebApp
. - name
string
: The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project'sProjectNumber
(recommended) or itsProjectId
. 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 theProjectId
. * APP_ID: the globally unique, Firebase-assigned identifier for the App (seeappId
). - projectId
string
: Immutable. A user-assigned unique identifier of the parent FirebaseProject for theWebApp
. - webId
string
: Output only. Immutable. A unique, Firebase-assigned identifier for theWebApp
. This identifier is only used to populate thenamespace
value for theWebApp
. For most use cases, useappId
to identify or reference the App. ThewebId
value is only unique within aFirebaseProject
and its associated Apps.
- appId
WebAppConfig
- WebAppConfig
object
: Configuration metadata of a single Firebase App for the web.- apiKey
string
: The API key associated with theWebApp
. - appId
string
: Immutable. The globally unique, Firebase-assigned identifier for theWebApp
. - authDomain
string
: The domain Firebase Auth configures for OAuth redirects, in the format: PROJECT_ID.firebaseapp.com - databaseURL
string
: The default Firebase Realtime Database URL. - locationId
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, callFinalizeDefaultLocation
after you add Firebase resources to the Project. - measurementId
string
: The unique Google-assigned identifier of the Google Analytics web stream associated with theWebApp
. Firebase SDKs use this ID to interact with Google Analytics APIs. This field is only present if theWebApp
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 ameasurementId
and link theWebApp
with a Google Analytics web stream, callAddGoogleAnalytics
. For apps using the Firebase JavaScript SDK v7.20.0 and later, Firebase dynamically fetches themeasurementId
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. - messagingSenderId
string
: The sender ID for use with Firebase Cloud Messaging. - projectId
string
: Immutable. A user-assigned unique identifier for theFirebaseProject
. - storageBucket
string
: The default Cloud Storage for Firebase storage bucket name.
- apiKey