Skip to main content

ios_apps

Overview

Nameios_apps
TypeResource
Idfirebase.firebase.ios_apps

Fields

NameDatatypeDescription
namestringThe resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
apiKeyIdstringThe globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the IosApp. 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 iosApps.Create, then Firebase automatically associates an api_key_id with the IosApp. 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 IosApp. We recommend using the Google Cloud Console to manage API keys.
statestringOutput only. The lifecycle state of the App.
teamIdstringThe Apple Developer Team ID associated with the App in the App Store.
projectIdstringOutput only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the IosApp.
appIdstringOutput only. Immutable. The globally unique, Firebase-assigned identifier for the IosApp. This identifier should be treated as an opaque token, as the data format is not specified.
bundleIdstringImmutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
appStoreIdstringThe automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
displayNamestringThe user-assigned display name for the IosApp.
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.

Methods

NameAccessible byRequired ParamsDescription
projects_iosApps_getSELECTiosAppsId, projectsIdGets the specified IosApp.
projects_iosApps_listSELECTprojectsIdLists 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.
projects_iosApps_createINSERTprojectsIdRequests 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.
projects_iosApps_patchEXECiosAppsId, projectsIdUpdates the attributes of the specified IosApp.
projects_iosApps_removeEXECiosAppsId, projectsIdRemoves the specified IosApp from the FirebaseProject.
projects_iosApps_undeleteEXECiosAppsId, projectsIdRestores the specified IosApp to the FirebaseProject.