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 theIosApp, 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'sAIP 2510 standard.
    Note that the value forPROJECT_IDENTIFIER in any response body will be theProjectId.
  • APP_ID: the globally unique, Firebase-assigned identifier for the App (seeappId).
appId

string

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

displayName

string

The user-assigned display name for theIosApp.

projectId

string

Output only. Immutable. A user-assigned unique identifier of the parentFirebaseProject for theIosApp.

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 theIosApp.

Be aware that this value is the UID of the API key,not thekeyString of the API key. ThekeyString is the value that can be found in the App'sconfiguration artifact.

IfapiKeyId is not set in requests toiosApps.Create, then Firebase automatically associates anapiKeyId with theIosApp. 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 associatedIosApp. We recommend using theGoogle 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 theDELETED 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 aboutetag in Google'sAIP-154 standard.

This etag is strongly validated.

Methods

create

 Requests the creation of a newIosApp in the specifiedFirebaseProject.

get

 Gets the specifiedIosApp.

getConfig

 Gets the configuration artifact associated with the specifiedIosApp.

list

 Lists eachIosApp associated with the specifiedFirebaseProject.

patch

 Updates the attributes of the specifiedIosApp.

remove

 Removes the specifiedIosApp from theFirebaseProject.

undelete

 Restores the specifiedIosApp to theFirebaseProject.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-10-24 UTC.