Skip to main content

web_apps

Overview

Nameweb_apps
TypeResource
Idfirebase.firebase.web_apps

Fields

NameDatatypeDescription
namestringThe resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
displayNamestringThe user-assigned display name for the WebApp.
projectIdstringOutput only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the WebApp.
webIdstringOutput only. Immutable. A unique, Firebase-assigned identifier for the WebApp. This identifier is only used to populate the namespace value for the WebApp. For most use cases, use appId to identify or reference the App. The webId value is only unique within a FirebaseProject and its associated Apps.
apiKeyIdstringThe globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to webApps.Create, then Firebase automatically associates an api_key_id with the WebApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated WebApp. We recommend using the Google Cloud Console to manage API keys.
appUrlsarrayThe URLs where the WebApp is hosted.
appIdstringOutput only. Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.
etagstringThis checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.
statestringOutput only. The lifecycle state of the App.

Methods

NameAccessible byRequired ParamsDescription
projects_webApps_getSELECTprojectsId, webAppsIdGets the specified WebApp.
projects_webApps_listSELECTprojectsIdLists 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.
projects_webApps_createINSERTprojectsIdRequests 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.
projects_webApps_patchEXECprojectsId, webAppsIdUpdates the attributes of the specified WebApp.
projects_webApps_removeEXECprojectsId, webAppsIdRemoves the specified WebApp from the FirebaseProject.
projects_webApps_undeleteEXECprojectsId, webAppsIdRestores the specified WebApp to the FirebaseProject.