Debian Codegraph @

docs/dyn/firebase_v1beta1.projects.iosApps.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="firebase_v1beta1.html">Firebase Management API</a> . <a href="firebase_v1beta1.projects.html">projects</a> . <a href="firebase_v1beta1.projects.iosApps.html">iosApps</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Requests 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`.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets the specified IosApp.</p>
86 <p class="toc_element">
87 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets the configuration artifact associated with the specified IosApp.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists 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`.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates the attributes of the specified IosApp.</p>
98 <p class="toc_element">
99 <code><a href="#remove">remove(name, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Removes the specified IosApp from the FirebaseProject.</p>
101 <p class="toc_element">
102 <code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Restores the specified IosApp to the FirebaseProject.</p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108 </div>
109
110 <div class="method">
111 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
112 <pre>Requests 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`.
113
114 Args:
115 parent: string, The resource name of the parent FirebaseProject in which to create an IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required)
116 body: object, The request body.
117 The object takes the form of:
118
119 { # Details of a Firebase App for iOS.
120 &quot;apiKeyId&quot;: &quot;A String&quot;, # 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`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App&#x27;s [configuration artifact](../../rest/v1beta1/projects.iosApps/getConfig). If `api_key_id` is not set in requests to [`iosApps.Create`](../../rest/v1beta1/projects.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](https://console.cloud.google.com/apis/credentials) to manage API keys.
121 &quot;appId&quot;: &quot;A String&quot;, # 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.
122 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
123 &quot;bundleId&quot;: &quot;A String&quot;, # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
124 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `IosApp`.
125 &quot;etag&quot;: &quot;A String&quot;, # 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&#x27;s [AIP-154 standard](https://google.aip.dev/154#declarative-friendly-resources). This etag is strongly validated.
126 &quot;expireTime&quot;: &quot;A String&quot;, # 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.
127 &quot;name&quot;: &quot;A String&quot;, # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). 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`](../projects.iosApps#IosApp.FIELDS.app_id)).
128 &quot;projectId&quot;: &quot;A String&quot;, # Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
129 &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the App.
130 &quot;teamId&quot;: &quot;A String&quot;, # The Apple Developer Team ID associated with the App in the App Store.
131 }
132
133 x__xgafv: string, V1 error format.
134 Allowed values
135 1 - v1 error format
136 2 - v2 error format
137
138 Returns:
139 An object of the form:
140
141 { # This resource represents a long-running operation that is the result of a network API call.
142 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
143 &quot;error&quot;: { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
144 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
145 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
146 {
147 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
148 },
149 ],
150 &quot;message&quot;: &quot;A String&quot;, # 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.
151 },
152 &quot;metadata&quot;: { # 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.
153 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
154 },
155 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
156 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
157 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
158 },
159 }</pre>
160 </div>
161
162 <div class="method">
163 <code class="details" id="get">get(name, x__xgafv=None)</code>
164 <pre>Gets the specified IosApp.
165
166 Args:
167 name: string, The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/iosApps/APP_ID Refer to the `IosApp` [`name`](../projects.iosApps#IosApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values. (required)
168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
172
173 Returns:
174 An object of the form:
175
176 { # Details of a Firebase App for iOS.
177 &quot;apiKeyId&quot;: &quot;A String&quot;, # 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`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App&#x27;s [configuration artifact](../../rest/v1beta1/projects.iosApps/getConfig). If `api_key_id` is not set in requests to [`iosApps.Create`](../../rest/v1beta1/projects.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](https://console.cloud.google.com/apis/credentials) to manage API keys.
178 &quot;appId&quot;: &quot;A String&quot;, # 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.
179 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
180 &quot;bundleId&quot;: &quot;A String&quot;, # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
181 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `IosApp`.
182 &quot;etag&quot;: &quot;A String&quot;, # 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&#x27;s [AIP-154 standard](https://google.aip.dev/154#declarative-friendly-resources). This etag is strongly validated.
183 &quot;expireTime&quot;: &quot;A String&quot;, # 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.
184 &quot;name&quot;: &quot;A String&quot;, # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). 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`](../projects.iosApps#IosApp.FIELDS.app_id)).
185 &quot;projectId&quot;: &quot;A String&quot;, # Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
186 &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the App.
187 &quot;teamId&quot;: &quot;A String&quot;, # The Apple Developer Team ID associated with the App in the App Store.
188 }</pre>
189 </div>
190
191 <div class="method">
192 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
193 <pre>Gets the configuration artifact associated with the specified IosApp.
194
195 Args:
196 name: string, The resource name of the App configuration to download, in the format: projects/PROJECT_IDENTIFIER/iosApps/APP_ID/config Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/iosApps/APP_ID Refer to the `IosApp` [`name`](../projects.iosApps#IosApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values. (required)
197 x__xgafv: string, V1 error format.
198 Allowed values
199 1 - v1 error format
200 2 - v2 error format
201
202 Returns:
203 An object of the form:
204
205 { # Configuration metadata of a single Firebase App for iOS.
206 &quot;configFileContents&quot;: &quot;A String&quot;, # The content of the XML configuration file.
207 &quot;configFilename&quot;: &quot;A String&quot;, # The filename that the configuration artifact for the `IosApp` is typically saved as. For example: `GoogleService-Info.plist`
208 }</pre>
209 </div>
210
211 <div class="method">
212 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</code>
213 <pre>Lists 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`.
214
215 Args:
216 parent: string, The resource name of the parent FirebaseProject for which to list each associated IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required)
217 pageSize: integer, The maximum number of Apps to return in the response. The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.
218 pageToken: string, Token returned from a previous call to `ListIosApps` indicating where in the set of Apps to resume listing.
219 showDeleted: boolean, Controls whether Apps in the DELETED state should be returned in the response. If not specified, only `ACTIVE` Apps will be returned.
220 x__xgafv: string, V1 error format.
221 Allowed values
222 1 - v1 error format
223 2 - v2 error format
224
225 Returns:
226 An object of the form:
227
228 {
229 &quot;apps&quot;: [ # List of each `IosApp` associated with the specified `FirebaseProject`.
230 { # Details of a Firebase App for iOS.
231 &quot;apiKeyId&quot;: &quot;A String&quot;, # 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`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App&#x27;s [configuration artifact](../../rest/v1beta1/projects.iosApps/getConfig). If `api_key_id` is not set in requests to [`iosApps.Create`](../../rest/v1beta1/projects.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](https://console.cloud.google.com/apis/credentials) to manage API keys.
232 &quot;appId&quot;: &quot;A String&quot;, # 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.
233 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
234 &quot;bundleId&quot;: &quot;A String&quot;, # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
235 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `IosApp`.
236 &quot;etag&quot;: &quot;A String&quot;, # 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&#x27;s [AIP-154 standard](https://google.aip.dev/154#declarative-friendly-resources). This etag is strongly validated.
237 &quot;expireTime&quot;: &quot;A String&quot;, # 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.
238 &quot;name&quot;: &quot;A String&quot;, # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). 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`](../projects.iosApps#IosApp.FIELDS.app_id)).
239 &quot;projectId&quot;: &quot;A String&quot;, # Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
240 &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the App.
241 &quot;teamId&quot;: &quot;A String&quot;, # The Apple Developer Team ID associated with the App in the App Store.
242 },
243 ],
244 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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. This token can be used in a subsequent call to `ListIosApps` to find the next group of Apps. Page tokens are short-lived and should not be persisted.
245 }</pre>
246 </div>
247
248 <div class="method">
249 <code class="details" id="list_next">list_next()</code>
250 <pre>Retrieves the next page of results.
251
252 Args:
253 previous_request: The request for the previous page. (required)
254 previous_response: The response from the request for the previous page. (required)
255
256 Returns:
257 A request object that you can call &#x27;execute()&#x27; on to request the next
258 page. Returns None if there are no more items in the collection.
259 </pre>
260 </div>
261
262 <div class="method">
263 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
264 <pre>Updates the attributes of the specified IosApp.
265
266 Args:
267 name: string, The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). 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`](../projects.iosApps#IosApp.FIELDS.app_id)). (required)
268 body: object, The request body.
269 The object takes the form of:
270
271 { # Details of a Firebase App for iOS.
272 &quot;apiKeyId&quot;: &quot;A String&quot;, # 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`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App&#x27;s [configuration artifact](../../rest/v1beta1/projects.iosApps/getConfig). If `api_key_id` is not set in requests to [`iosApps.Create`](../../rest/v1beta1/projects.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](https://console.cloud.google.com/apis/credentials) to manage API keys.
273 &quot;appId&quot;: &quot;A String&quot;, # 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.
274 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
275 &quot;bundleId&quot;: &quot;A String&quot;, # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
276 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `IosApp`.
277 &quot;etag&quot;: &quot;A String&quot;, # 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&#x27;s [AIP-154 standard](https://google.aip.dev/154#declarative-friendly-resources). This etag is strongly validated.
278 &quot;expireTime&quot;: &quot;A String&quot;, # 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.
279 &quot;name&quot;: &quot;A String&quot;, # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). 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`](../projects.iosApps#IosApp.FIELDS.app_id)).
280 &quot;projectId&quot;: &quot;A String&quot;, # Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
281 &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the App.
282 &quot;teamId&quot;: &quot;A String&quot;, # The Apple Developer Team ID associated with the App in the App Store.
283 }
284
285 updateMask: string, Specifies which fields of the IosApp to update. Note that the following fields are immutable: `name`, `app_id`, `project_id`, and `bundle_id`. To update `state`, use any of the following endpoints: RemoveIosApp or UndeleteIosApp.
286 x__xgafv: string, V1 error format.
287 Allowed values
288 1 - v1 error format
289 2 - v2 error format
290
291 Returns:
292 An object of the form:
293
294 { # Details of a Firebase App for iOS.
295 &quot;apiKeyId&quot;: &quot;A String&quot;, # 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`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App&#x27;s [configuration artifact](../../rest/v1beta1/projects.iosApps/getConfig). If `api_key_id` is not set in requests to [`iosApps.Create`](../../rest/v1beta1/projects.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](https://console.cloud.google.com/apis/credentials) to manage API keys.
296 &quot;appId&quot;: &quot;A String&quot;, # 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.
297 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
298 &quot;bundleId&quot;: &quot;A String&quot;, # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
299 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `IosApp`.
300 &quot;etag&quot;: &quot;A String&quot;, # 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&#x27;s [AIP-154 standard](https://google.aip.dev/154#declarative-friendly-resources). This etag is strongly validated.
301 &quot;expireTime&quot;: &quot;A String&quot;, # 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.
302 &quot;name&quot;: &quot;A String&quot;, # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). 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`](../projects.iosApps#IosApp.FIELDS.app_id)).
303 &quot;projectId&quot;: &quot;A String&quot;, # Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
304 &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the App.
305 &quot;teamId&quot;: &quot;A String&quot;, # The Apple Developer Team ID associated with the App in the App Store.
306 }</pre>
307 </div>
308
309 <div class="method">
310 <code class="details" id="remove">remove(name, body=None, x__xgafv=None)</code>
311 <pre>Removes the specified IosApp from the FirebaseProject.
312
313 Args:
314 name: string, Required. The resource name of the IosApp, in the format: projects/ PROJECT_IDENTIFIER/iosApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/iosApps/APP_ID Refer to the IosApp [name](../projects.iosApps#IosApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values. (required)
315 body: object, The request body.
316 The object takes the form of:
317
318 {
319 &quot;allowMissing&quot;: True or False, # If set to true, and the App is not found, the request will succeed but no action will be taken on the server.
320 &quot;etag&quot;: &quot;A String&quot;, # Checksum provided in the IosApp resource. If provided, this checksum ensures that the client has an up-to-date value before proceeding.
321 &quot;immediate&quot;: True or False, # Determines whether to _immediately_ delete the IosApp. If set to true, the App is immediately deleted from the Project and cannot be undeleted (that is, restored to the Project). If not set, defaults to false, which means the App will be set to expire in 30 days. Within the 30 days, the App may be restored to the Project using UndeleteIosApp
322 &quot;validateOnly&quot;: True or False, # If set to true, the request is only validated. The App will _not_ be removed.
323 }
324
325 x__xgafv: string, V1 error format.
326 Allowed values
327 1 - v1 error format
328 2 - v2 error format
329
330 Returns:
331 An object of the form:
332
333 { # This resource represents a long-running operation that is the result of a network API call.
334 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
335 &quot;error&quot;: { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
336 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
337 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
338 {
339 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
340 },
341 ],
342 &quot;message&quot;: &quot;A String&quot;, # 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.
343 },
344 &quot;metadata&quot;: { # 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.
345 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
346 },
347 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
348 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
349 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
350 },
351 }</pre>
352 </div>
353
354 <div class="method">
355 <code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
356 <pre>Restores the specified IosApp to the FirebaseProject.
357
358 Args:
359 name: string, Required. The resource name of the IosApp, in the format: projects/ PROJECT_IDENTIFIER/iosApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/iosApps/APP_ID Refer to the IosApp [name](../projects.iosApps#IosApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values. (required)
360 body: object, The request body.
361 The object takes the form of:
362
363 {
364 &quot;etag&quot;: &quot;A String&quot;, # Checksum provided in the IosApp resource. If provided, this checksum ensures that the client has an up-to-date value before proceeding.
365 &quot;validateOnly&quot;: True or False, # If set to true, the request is only validated. The App will _not_ be undeleted.
366 }
367
368 x__xgafv: string, V1 error format.
369 Allowed values
370 1 - v1 error format
371 2 - v2 error format
372
373 Returns:
374 An object of the form:
375
376 { # This resource represents a long-running operation that is the result of a network API call.
377 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
378 &quot;error&quot;: { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
379 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
380 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
381 {
382 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
383 },
384 ],
385 &quot;message&quot;: &quot;A String&quot;, # 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.
386 },
387 &quot;metadata&quot;: { # 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.
388 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
389 },
390 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
391 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
392 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
393 },
394 }</pre>
395 </div>
396
397 </body></html>