REST Resource: projects.iosApps

Resource: IosApp

Details of a Firebase App for iOS.

JSON representation 
{
  "name": string,
  "appId": string,
  "displayName": string,
  "projectId": string,
  "bundleId": string,
  "appStoreId": string,
  "teamId": string,
  "apiKeyId": string,
  "state": enum (State),
  "expireTime": string,
  "etag": string
}
Fields
name

string

The resource name of the IosApp, in the format:

projects/PROJECT_IDENTIFIER/iosApps/APP_ID

  • PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard.
    Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId.
  • APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
appId

string

Output 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.
displayName

string

The user-assigned display name for the IosApp.
projectId

string

Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the IosApp.
bundleId

string

Immutable. 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 iOS app by Apple in the iOS App Store.
teamId

string

The Apple Developer Team ID associated with the App in the App Store.
apiKeyId

string

The 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 apiKeyId is not set in requests to iosApps.Create, then Firebase automatically associates an apiKeyId 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, apiKeyId 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.
state

enum (State)

Output only. The lifecycle state of the App.
expireTime

string (Timestamp format)

Output only. If the App has been removed from the Project, this is the timestamp of when the App is considered expired and will be permanently deleted. After this time, the App cannot be undeleted (that is, restored to the Project).

This value is only provided if the App is in the DELETED state.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
etag

string

This 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

create

 Requests the creation of a new IosApp in the specified FirebaseProject.

get

 Gets the specified IosApp.

getConfig

 Gets the configuration artifact associated with the specified IosApp.

list

 Lists each IosApp associated with the specified FirebaseProject.

patch

 Updates the attributes of the specified IosApp.

remove

 Removes the specified IosApp from the FirebaseProject.

undelete

 Restores the specified IosApp to the FirebaseProject.