The Firebase Management API enables programmatic setup and management of Firebase projects, including a project's Firebase resources and Firebase apps.
Returns a list of [Google Cloud Platform (GCP) Projects
]
(https://cloud.google.com/resource-manager/reference/rest/v1/projects)
that are available to have Firebase resources added to them.
A GCP Project
will only be returned if:
The caller has sufficient [Google IAM](https://cloud.google.com/iam) permissions to call AddFirebase.
The GCP `Project` is not already a FirebaseProject.
The GCP `Project` is not in an Organization which has policies that prevent Firebase resources from being added.
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
pageToken
|
string |
Token returned from a previous call to |
pageSize
|
integer |
The maximum number of GCP |
Name | Data Type | Description |
---|---|---|
ListAvailableProjectsResponse
|
object |
projectInfo
|
array [ProjectInfo] |
The list of GCP |
|||||||||||||
Properties
|
|||||||||||||||
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.
|
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the operation resource. |
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
Name | Data Type | Description |
---|---|---|
Operation
|
object |
This resource represents a long-running operation that is the result of a network API call. |
response
|
object |
The normal response of the operation in case of success. If the original
method returns no data on success, such as |
|||||||||||||
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, the
|
|||||||||||||
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. |
|||||||||||||
error
|
Status |
The error result of the operation in case of failure or cancellation. |
|||||||||||||
Properties
|
|||||||||||||||
done
|
boolean |
If the value is |
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.
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
pageToken
|
string |
Token returned from a previous call to |
pageSize
|
integer |
The maximum number of Projects to return in the response.
|
Name | Data Type | Description |
---|---|---|
ListFirebaseProjectsResponse
|
object |
results
|
array [FirebaseProject] |
One page of the list of Projects that are accessible to the caller. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
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.
|
Removes a SHA certificate from the specified AndroidApp.
Name | Data Type | Description |
---|---|---|
name
|
string |
The fully qualified resource name of the |
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
Name | Data Type | Description |
---|---|---|
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:
The JSON representation for |
Updates the attributes of the IosApp identified by the specified resource name.
Name | Data Type | Description |
---|---|---|
name
|
string |
The fully qualified resource name of the App, in the format:
|
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
updateMask
|
string |
Specifies which fields to update.
|
Name | Data Type | Description |
---|---|---|
IosApp
|
object |
Details of a Firebase App for iOS. |
projectId
|
string |
The globally unique, user-assigned ID of the parent Project for the App. |
name
|
string |
The fully qualified resource name of the App, in the format:
|
displayName
|
string |
The user-assigned display name of the App. |
bundleId
|
string |
The canonical bundle ID of the iOS App as it would appear in the iOS AppStore. |
appStoreId
|
string |
The automatically generated Apple ID assigned to the App by Apple in the iOS App Store. |
appId
|
string |
Immutable. The globally unique, Firebase-assigned identifier of the App.
|
Name | Data Type | Description |
---|---|---|
IosApp
|
object |
Details of a Firebase App for iOS. |
projectId
|
string |
The globally unique, user-assigned ID of the parent Project for the App. |
name
|
string |
The fully qualified resource name of the App, in the format:
|
displayName
|
string |
The user-assigned display name of the App. |
bundleId
|
string |
The canonical bundle ID of the iOS App as it would appear in the iOS AppStore. |
appStoreId
|
string |
The automatically generated Apple ID assigned to the App by Apple in the iOS App Store. |
appId
|
string |
Immutable. The globally unique, Firebase-assigned identifier of the App.
|
Lists each AndroidApp associated with the specified parent Project.
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
.
Name | Data Type | Description |
---|---|---|
parent
|
string |
The parent Project for which to list Apps, in the format:
|
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
pageToken
|
string |
Token returned from a previous call to |
pageSize
|
integer |
The maximum number of Apps to return in the response.
|
Name | Data Type | Description |
---|---|---|
ListAndroidAppsResponse
|
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.
|
|||||||||||||||||||
apps
|
array [AndroidApp] |
List of each AndroidApp that is in the parent Firebase Project. |
|||||||||||||||||||
Properties
|
Requests that a new AndroidApp be created.
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
.
Name | Data Type | Description |
---|---|---|
parent
|
string |
The parent Project for which to list Apps, in the format:
|
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
Name | Data Type | Description |
---|---|---|
AndroidApp
|
object |
Details of a Firebase App for Android. |
projectId
|
string |
The globally unique, user-assigned ID of the parent Project for the App. |
packageName
|
string |
The canonical package name of the Android App as would appear in the Google Play Developer Console. |
name
|
string |
The fully qualified resource name of the App, in the format:
|
displayName
|
string |
The user-assigned display name of the App. |
appId
|
string |
Immutable. The globally unique, Firebase-assigned identifier of the App.
|
Name | Data Type | Description |
---|---|---|
Operation
|
object |
This resource represents a long-running operation that is the result of a network API call. |
response
|
object |
The normal response of the operation in case of success. If the original
method returns no data on success, such as |
|||||||||||||
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, the
|
|||||||||||||
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. |
|||||||||||||
error
|
Status |
The error result of the operation in case of failure or cancellation. |
|||||||||||||
Properties
|
|||||||||||||||
done
|
boolean |
If the value is |
Returns a list of valid Google Cloud Platform (GCP) resource locations for
the specified Project (including a FirebaseProject).
The default GCP resource location of a project defines the geographical
location where project resources, such as Cloud Firestore, will be
provisioned by default.
The returned list are the available
GCP resource
locations.
This call checks for any 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 projectId
(that is,
/v1beta1/{parent=projects/-}/listAvailableLocations
).
To call ListAvailableLocations
with a specified project, a member
must be at minimum a Viewer of the project. Calls without a specified
project do not require any specific project permissions.
Name | Data Type | Description |
---|---|---|
parent
|
string |
The Project for which to list GCP resource locations, in the format:
|
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
pageToken
|
string |
Token returned from a previous call to |
pageSize
|
integer |
The maximum number of locations to return in the response.
|
Name | Data Type | Description |
---|---|---|
ListAvailableLocationsResponse
|
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 and all available locations have been listed.
|
|||||||
locations
|
array [Location] |
One page of results from a call to |
|||||||
Properties
|
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
location_id
.
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
GCP Project
already has an App Engine application or
FinalizeDefaultLocation
was previously called with a specified
location_id
. Any new calls to FinalizeDefaultLocation
with a
different specified location_id
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.
Name | Data Type | Description |
---|---|---|
parent
|
string |
The resource name of the Project for which the default GCP resource
location will be set, in the format:
|
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
Name | Data Type | Description |
---|---|---|
FinalizeDefaultLocationRequest
|
object |
locationId
|
string |
The ID of the default GCP resource location for the Project. The location must be one of the available GCP resource locations. |
Name | Data Type | Description |
---|---|---|
Operation
|
object |
This resource represents a long-running operation that is the result of a network API call. |
response
|
object |
The normal response of the operation in case of success. If the original
method returns no data on success, such as |
|||||||||||||
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, the
|
|||||||||||||
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. |
|||||||||||||
error
|
Status |
The error result of the operation in case of failure or cancellation. |
|||||||||||||
Properties
|
|||||||||||||||
done
|
boolean |
If the value is |
Lists each IosApp associated with the specified parent Project.
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
.
Name | Data Type | Description |
---|---|---|
parent
|
string |
The parent Project for which to list Apps, in the format:
|
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
pageToken
|
string |
Token returned from a previous call to |
pageSize
|
integer |
The maximum number of Apps to return in the response.
|
Name | Data Type | Description |
---|---|---|
ListIosAppsResponse
|
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.
|
||||||||||||||||||||||
apps
|
array [IosApp] |
List of each IosApp that is in the parent Firebase Project. |
||||||||||||||||||||||
Properties
|
Requests that a new IosApp be created.
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
.
Name | Data Type | Description |
---|---|---|
parent
|
string |
The parent Project for which to list Apps, in the format:
|
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
Name | Data Type | Description |
---|---|---|
IosApp
|
object |
Details of a Firebase App for iOS. |
projectId
|
string |
The globally unique, user-assigned ID of the parent Project for the App. |
name
|
string |
The fully qualified resource name of the App, in the format:
|
displayName
|
string |
The user-assigned display name of the App. |
bundleId
|
string |
The canonical bundle ID of the iOS App as it would appear in the iOS AppStore. |
appStoreId
|
string |
The automatically generated Apple ID assigned to the App by Apple in the iOS App Store. |
appId
|
string |
Immutable. The globally unique, Firebase-assigned identifier of the App.
|
Name | Data Type | Description |
---|---|---|
Operation
|
object |
This resource represents a long-running operation that is the result of a network API call. |
response
|
object |
The normal response of the operation in case of success. If the original
method returns no data on success, such as |
|||||||||||||
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, the
|
|||||||||||||
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. |
|||||||||||||
error
|
Status |
The error result of the operation in case of failure or cancellation. |
|||||||||||||
Properties
|
|||||||||||||||
done
|
boolean |
If the value is |
Returns the list of SHA-1 and SHA-256 certificates for the specified AndroidApp.
Name | Data Type | Description |
---|---|---|
parent
|
string |
The parent App for which to list SHA certificates, in the format:
|
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
Name | Data Type | Description |
---|---|---|
ListShaCertificatesResponse
|
object |
certificates
|
array [ShaCertificate] |
The list of SHA certificates associated with the App. |
|||||||||||||
Properties
|
Adds a SHA certificate to the specified AndroidApp.
Name | Data Type | Description |
---|---|---|
parent
|
string |
The parent App to which a SHA certificate will be added, in the format:
|
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
Name | Data Type | Description |
---|---|---|
ShaCertificate
|
object |
A SHA-1 or SHA-256 certificate associated with the AndroidApp. |
shaHash
|
string |
The certificate hash for the App. |
name
|
string |
The fully qualified resource name of the |
certType
|
string Allowed values: - SHA_CERTIFICATE_TYPE_UNSPECIFIED - SHA_1 - SHA_256 |
The SHA certificate type. |
Name | Data Type | Description |
---|---|---|
ShaCertificate
|
object |
A SHA-1 or SHA-256 certificate associated with the AndroidApp. |
shaHash
|
string |
The certificate hash for the App. |
name
|
string |
The fully qualified resource name of the |
certType
|
string Allowed values: - SHA_CERTIFICATE_TYPE_UNSPECIFIED - SHA_1 - SHA_256 |
The SHA certificate type. |
Lists each WebApp associated with the specified parent Project.
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
.
Name | Data Type | Description |
---|---|---|
parent
|
string |
The parent Project for which to list Apps, in the format:
|
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
pageToken
|
string |
Token returned from a previous call to |
pageSize
|
integer |
The maximum number of Apps to return in the response.
|
Name | Data Type | Description |
---|---|---|
ListWebAppsResponse
|
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.
|
|||||||||||||||||||
apps
|
array [WebApp] |
List of each WebApp that is in the parent Firebase Project. |
|||||||||||||||||||
Properties
|
Requests that a new WebApp be created.
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
.
Name | Data Type | Description |
---|---|---|
parent
|
string |
The parent Project for which to list Apps, in the format:
|
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
Name | Data Type | Description |
---|---|---|
WebApp
|
object |
Details of a Firebase App for the web. |
projectId
|
string |
The globally unique, user-assigned ID of the parent Project for the App. |
name
|
string |
The fully qualified resource name of the App, for example:
|
displayName
|
string |
The user-assigned display name of the App. |
appUrls
|
array [string] |
The fully qualified URLs where the App is hosted. |
appId
|
string |
Immutable. The globally unique, Firebase-assigned identifier of the App.
|
Name | Data Type | Description |
---|---|---|
Operation
|
object |
This resource represents a long-running operation that is the result of a network API call. |
response
|
object |
The normal response of the operation in case of success. If the original
method returns no data on success, such as |
|||||||||||||
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, the
|
|||||||||||||
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. |
|||||||||||||
error
|
Status |
The error result of the operation in case of failure or cancellation. |
|||||||||||||
Properties
|
|||||||||||||||
done
|
boolean |
If the value is |
Links a FirebaseProject with an existing
Google Analytics account.
Using this call, you can either:
Note that when you call AddGoogleAnalytics
:
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 member must be an Owner for
the existing FirebaseProject
and have the
Edit
permission
for the Google Analytics account.
If a 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
.
Name | Data Type | Description |
---|---|---|
parent
|
string |
The parent |
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
Name | Data Type | Description |
---|---|---|
AddGoogleAnalyticsRequest
|
object |
analyticsPropertyId
|
string |
The ID for the existing Google Analytics property that you want to
associate with your |
analyticsAccountId
|
string |
The ID for the existing
Google Analytics account that you
want to link with your |
Name | Data Type | Description |
---|---|---|
Operation
|
object |
This resource represents a long-running operation that is the result of a network API call. |
response
|
object |
The normal response of the operation in case of success. If the original
method returns no data on success, such as |
|||||||||||||
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, the
|
|||||||||||||
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. |
|||||||||||||
error
|
Status |
The error result of the operation in case of failure or cancellation. |
|||||||||||||
Properties
|
|||||||||||||||
done
|
boolean |
If the value is |
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 member must be an Owner for
the FirebaseProject
.
Name | Data Type | Description |
---|---|---|
parent
|
string |
The parent |
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
Name | Data Type | Description |
---|---|---|
RemoveAnalyticsRequest
|
object |
analyticsPropertyId
|
string |
Optional. The ID of the Google Analytics property associated with the
specified
|
Name | Data Type | Description |
---|---|---|
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:
The JSON representation for |
A convenience method that lists all available Apps for the specified
FirebaseProject.
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).
Name | Data Type | Description |
---|---|---|
parent
|
string |
The parent Project for which to list Apps, in the format:
|
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
pageToken
|
string |
Token returned from a previous call to |
pageSize
|
integer |
The maximum number of Apps to return in the response.
|
Name | Data Type | Description |
---|---|---|
SearchFirebaseAppsResponse
|
object |
nextPageToken
|
string |
If the result list is too large to fit in a single response, then a token
is returned.
|
||||||||||||||||
apps
|
array [FirebaseAppInfo] |
One page of results from a call to |
||||||||||||||||
Properties
|
Adds Firebase resources to the specified existing
[Google Cloud Platform (GCP) Project
]
(https://cloud.google.com/resource-manager/reference/rest/v1/projects).
Since a FirebaseProject is actually also a GCP Project
, a
FirebaseProject
uses underlying GCP identifiers (most importantly,
the projectId
) as its own for easy interop with GCP APIs.
The result of this call is an Operation
.
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 member must be an Editor or Owner for the
existing GCP Project
. Service accounts cannot call AddFirebase
.
Name | Data Type | Description |
---|---|---|
project
|
string |
The resource name of the GCP |
Name | Data Type | Description |
---|---|---|
upload_protocol
|
string |
Upload protocol for media (e.g. "raw", "multipart"). |
uploadType
|
string |
Legacy upload protocol for media (e.g. "media", "multipart"). |
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. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
callback
|
string |
JSONP |
alt
|
string Default value: json Allowed values: - json - media - proto |
Data format for response. |
access_token
|
string |
OAuth access token. |
$.xgafv
|
string Allowed values: - 1 - 2 |
V1 error format. |
Name | Data Type | Description |
---|---|---|
AddFirebaseRequest
|
object |
All fields are required. |
timeZone
|
string |
Deprecated. Instead, to link your Project with a Google Analytics account,
call |
regionCode
|
string |
Deprecated. Instead, to link your Project with a Google Analytics account,
call |
locationId
|
string |
Deprecated. Instead, to set your project's default GCP resource location,
call |
Name | Data Type | Description |
---|---|---|
Operation
|
object |
This resource represents a long-running operation that is the result of a network API call. |
response
|
object |
The normal response of the operation in case of success. If the original
method returns no data on success, such as |
|||||||||||||
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, the
|
|||||||||||||
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. |
|||||||||||||
error
|
Status |
The error result of the operation in case of failure or cancellation. |
|||||||||||||
Properties
|
|||||||||||||||
done
|
boolean |
If the value is |
All fields are required.
Name | Data Type | Description |
---|---|---|
timeZone
|
string |
Deprecated. Instead, to link your Project with a Google Analytics account,
call |
regionCode
|
string |
Deprecated. Instead, to link your Project with a Google Analytics account,
call |
locationId
|
string |
Deprecated. Instead, to set your project's default GCP resource location,
call |
Name | Data Type | Description |
---|---|---|
analyticsPropertyId
|
string |
The ID for the existing Google Analytics property that you want to
associate with your |
analyticsAccountId
|
string |
The ID for the existing
Google Analytics account that you
want to link with your |
Name | Data Type | Description |
---|---|---|
storageBucket
|
string |
The default Cloud Storage for Firebase storage bucket name. |
projectId
|
string |
Immutable. The globally unique, user-assigned project ID of the parent Project. |
locationId
|
string |
The ID of the project's default GCP resource location. The location is one
of the available
GCP resource
locations. |
databaseURL
|
string |
The default Firebase Realtime Database URL. |
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
streamMappings
|
array [StreamMapping] |
For Android Apps and iOS Apps: A map of |
|||||||||||||
Properties
|
|||||||||||||||
analyticsProperty
|
AnalyticsProperty |
The Analytics Property object associated with the specified
|
|||||||||||||
Properties
|
Details of a Google Analytics property
Name | Data Type | Description |
---|---|---|
id
|
string |
The globally unique, Google-assigned identifier of the Google Analytics
property associated with the specified |
displayName
|
string |
The display name of the Google Analytics property associated with the
specified |
Details of a Firebase App for Android.
Name | Data Type | Description |
---|---|---|
projectId
|
string |
The globally unique, user-assigned ID of the parent Project for the App. |
packageName
|
string |
The canonical package name of the Android App as would appear in the Google Play Developer Console. |
name
|
string |
The fully qualified resource name of the App, in the format:
|
displayName
|
string |
The user-assigned display name of the App. |
appId
|
string |
Immutable. The globally unique, Firebase-assigned identifier of the App.
|
Configuration metadata of a single Firebase App for Android.
Name | Data Type | Description |
---|---|---|
configFilename
|
string |
The filename that the configuration artifact is typically saved as.
|
configFileContents
|
byte |
The contents of the JSON configuration file. |
The default resources associated with a FirebaseProject
.
Name | Data Type | Description |
---|---|---|
storageBucket
|
string |
The default Cloud Storage for Firebase storage bucket, in the format:
|
realtimeDatabaseInstance
|
string |
The default Firebase Realtime Database instance name, in the format:
|
locationId
|
string |
The ID of the project's default GCP resource location. The location is one
of the available
GCP resource
locations. |
hostingSite
|
string |
The default Firebase Hosting site name, in the format:
|
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 {}
.
Name | Data Type | Description |
---|---|---|
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:
The JSON representation for |
Name | Data Type | Description |
---|---|---|
locationId
|
string |
The ID of the default GCP resource location for the Project. The location must be one of the available GCP resource locations. |
A high-level summary of an App.
Name | Data Type | Description |
---|---|---|
platform
|
string Allowed values: - PLATFORM_UNSPECIFIED - IOS - ANDROID - WEB |
The platform of the Firebase App. |
name
|
string |
The fully qualified resource name of the Firebase App, in the format:
|
displayName
|
string |
The user-assigned display name of the Firebase App. |
appId
|
string |
Immutable. The globally unique, Firebase-assigned identifier of the App.
|
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 can create a new FirebaseProject
in the
Firebase console,
or you can add Firebase resources to an existing
GCP
Project
by calling
AddFirebase.
A FirebaseProject
is actually also a GCP Project
, so a
FirebaseProject
uses underlying GCP identifiers (most importantly,
projectId
) as its own for easy interop with GCP APIs.
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
resources
|
DefaultResources |
The default Firebase resources associated with the Project. |
||||||||||||||||
Properties
|
||||||||||||||||||
projectNumber
|
string |
The globally unique, Google-assigned identifier of the Project. |
||||||||||||||||
projectId
|
string |
Immutable. The globally unique, user-assigned ID of the Project. |
||||||||||||||||
name
|
string |
The fully qualified resource name of the Project, in the format:
|
||||||||||||||||
displayName
|
string |
The user-assigned display name of the Project. |
Details of a Firebase App for iOS.
Name | Data Type | Description |
---|---|---|
projectId
|
string |
The globally unique, user-assigned ID of the parent Project for the App. |
name
|
string |
The fully qualified resource name of the App, in the format:
|
displayName
|
string |
The user-assigned display name of the App. |
bundleId
|
string |
The canonical bundle ID of the iOS App as it would appear in the iOS AppStore. |
appStoreId
|
string |
The automatically generated Apple ID assigned to the App by Apple in the iOS App Store. |
appId
|
string |
Immutable. The globally unique, Firebase-assigned identifier of the App.
|
Configuration metadata of a single Firebase App for iOS.
Name | Data Type | Description |
---|---|---|
configFilename
|
string |
The filename that the configuration artifact is typically saved as.
|
configFileContents
|
byte |
The content of the XML configuration file. |
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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.
|
|||||||||||||||||||
apps
|
array [AndroidApp] |
List of each AndroidApp that is in the parent Firebase Project. |
|||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
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.
|
|||||||
locations
|
array [Location] |
One page of results from a call to |
|||||||
Properties
|
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
projectInfo
|
array [ProjectInfo] |
The list of GCP |
|||||||||||||
Properties
|
|||||||||||||||
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.
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
results
|
array [FirebaseProject] |
One page of the list of Projects that are accessible to the caller. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
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.
|
Name | Data Type | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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.
|
||||||||||||||||||||||
apps
|
array [IosApp] |
List of each IosApp that is in the parent Firebase Project. |
||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
certificates
|
array [ShaCertificate] |
The list of SHA certificates associated with the App. |
|||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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.
|
|||||||||||||||||||
apps
|
array [WebApp] |
List of each WebApp that is in the parent Firebase Project. |
|||||||||||||||||||
Properties
|
A GCP resource location that can be selected for a Project.
Name | Data Type | Description |
---|---|---|
locationId
|
string |
The ID of the default GCP resource location. It must be one of the available GCP resource locations. |
This is proto2's version of MessageSet.
Name | Data Type | Description |
---|---|---|
MessageSet
|
object |
This is proto2's version of MessageSet. |
This resource represents a long-running operation that is the result of a network API call.
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
response
|
object |
The normal response of the operation in case of success. If the original
method returns no data on success, such as |
|||||||||||||
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, the
|
|||||||||||||
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. |
|||||||||||||
error
|
Status |
The error result of the operation in case of failure or cancellation. |
|||||||||||||
Properties
|
|||||||||||||||
done
|
boolean |
If the value is |
A reference to a Google Cloud Platform (GCP) Project
.
Name | Data Type | Description |
---|---|---|
project
|
string |
The resource name of the GCP |
locationId
|
string |
The ID of the project's default GCP resource location. The location is one
of the available
GCP resource
locations. |
displayName
|
string |
The user-assigned display name of the GCP |
Name | Data Type | Description |
---|---|---|
analyticsPropertyId
|
string |
Optional. The ID of the Google Analytics property associated with the
specified
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
If the result list is too large to fit in a single response, then a token
is returned.
|
||||||||||||||||
apps
|
array [FirebaseAppInfo] |
One page of results from a call to |
||||||||||||||||
Properties
|
A SHA-1 or SHA-256 certificate associated with the AndroidApp.
Name | Data Type | Description |
---|---|---|
shaHash
|
string |
The certificate hash for the App. |
name
|
string |
The fully qualified resource name of the |
certType
|
string Allowed values: - SHA_CERTIFICATE_TYPE_UNSPECIFIED - SHA_1 - SHA_256 |
The SHA certificate type. |
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.
Name | Data Type | Description |
---|---|---|
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. |
details
|
array [object] |
A list of messages that carry the error details. There is a common set of message types for APIs to use. |
code
|
integer |
The status code, which should be an enum value of google.rpc.Code. |
Wire-format for a Status object
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
space
|
string |
The following are usually only present when code != 0 Space to which this status belongs |
||||||||||
payload
|
TypedMessage |
DEPRECATED. This field was deprecated in 2011 with cl/20297133. Java support for the field was moved to a proto1 backward compatibility class in April 2017 with cl/142615857 and cl/154123203. There was never support for this field in Go; if set Go will ignore it. C++ stopped setting StatusProto::payload in October 2015 with cl/106347055, and stopped reading the field in October 2017 with cl/173324114. In general, newly written code should use only "message_set". If you need to maintain backward compatibility with code written before 3/25/2011, do the following:
|
||||||||||
Properties
|
||||||||||||
messageSet
|
MessageSet |
message_set associates an arbitrary proto message with the status. |
||||||||||
|
||||||||||||
message
|
string |
Detail message |
||||||||||
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 |
||||||||||
canonicalCode
|
integer |
The canonical error code (see codes.proto) that most closely corresponds to this status. May be missing. |
A mapping of a Firebase App to a Google Analytics data stream
Name | Data Type | Description |
---|---|---|
streamId
|
string |
The unique Google-assigned identifier of the Google Analytics data stream
associated with the Firebase App.
|
measurementId
|
string |
Applicable for Firebase Web Apps only. |
app
|
string |
The fully qualified resource name of the Firebase App associated with the
Google Analytics data stream, in the format:
|
Message that groups a protocol type_id (as defined by MessageSet), with an encoded message of that type. Its use is similar to MessageSet, except it represents a single (type, encoded message) instead of a set.
To fill for known protocol type: MyProtocolMsg proto; TypedMessage typed_msg; typed_msg.set_type_id(MyProtocolMsg::MESSAGE_TYPE_ID); proto.AppendToCord(typed_msg.mutable_message());
To fill for unknown protocol type: ProtocolMessage proto; TypedMessage typed_msg; typed_msg.set_type_id(proto.GetMapper()->type_id()); proto.AppendToCord(typed_msg.mutable_message());
Name | Data Type | Description |
---|---|---|
typeId
|
integer |
Identifier for the type. |
message
|
byte |
Message bytes. |
Details of a Firebase App for the web.
Name | Data Type | Description |
---|---|---|
projectId
|
string |
The globally unique, user-assigned ID of the parent Project for the App. |
name
|
string |
The fully qualified resource name of the App, for example:
|
displayName
|
string |
The user-assigned display name of the App. |
appUrls
|
array [string] |
The fully qualified URLs where the App is hosted. |
appId
|
string |
Immutable. The globally unique, Firebase-assigned identifier of the App.
|
Configuration metadata of a single Firebase App for the web.
Name | Data Type | Description |
---|---|---|
storageBucket
|
string |
The default Cloud Storage for Firebase storage bucket name. |
projectId
|
string |
Immutable. The globally unique, user-assigned project ID of the parent Project for the App. |
messagingSenderId
|
string |
The sender ID for use with Firebase Cloud Messaging. |
measurementId
|
string |
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.
|
locationId
|
string |
The ID of the project's default GCP resource location. The location is one
of the available
GCP resource
locations. |
databaseURL
|
string |
The default Firebase Realtime Database URL. |
authDomain
|
string |
The domain Firebase Auth configures for OAuth redirects, in the format:
|
appId
|
string |
Immutable. The globally unique, Firebase-assigned identifier of the App. |
apiKey
|
string |
The API key associated with the web App. |
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 accessCode authentication
Flow:authorizationCode
https://accounts.google.com/o/oauth2/auth
https://accounts.google.com/o/oauth2/token
https://www.googleapis.com/auth/firebase
: View and administer all your Firebase data and settingshttps://www.googleapis.com/auth/cloud-platform
: View and manage your data across Google Cloud Platform serviceshttps://www.googleapis.com/auth/firebase.readonly
: View all your Firebase data and settingshttps://www.googleapis.com/auth/cloud-platform.read-only
: View your data across Google Cloud Platform services
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 implicit authentication
Flow:implicit
https://accounts.google.com/o/oauth2/auth
https://www.googleapis.com/auth/firebase
: View and administer all your Firebase data and settingshttps://www.googleapis.com/auth/cloud-platform
: View and manage your data across Google Cloud Platform serviceshttps://www.googleapis.com/auth/firebase.readonly
: View all your Firebase data and settingshttps://www.googleapis.com/auth/cloud-platform.read-only
: View your data across Google Cloud Platform servicesName | Google |
External URL | https://google.com |
Api Client Registration | https://console.developers.google.com |
Preferred | Yes |
Provider Name | googleapis.com |
Service Name | firebase |
API Version | v1beta1 |