1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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, 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(previous_request, previous_response)</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<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 106 <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`. 107 108Args: 109 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) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # Details of a Firebase App for iOS. 114 "appId": "A String", # 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. 115 "appStoreId": "A String", # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store. 116 "bundleId": "A String", # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore. 117 "displayName": "A String", # The user-assigned display name for the `IosApp`. 118 "name": "A String", # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google'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)). 119 "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`. 120 "teamId": "A String", # The Apple Developer Team ID associated with the App in the App Store. 121} 122 123 x__xgafv: string, V1 error format. 124 Allowed values 125 1 - v1 error format 126 2 - v2 error format 127 128Returns: 129 An object of the form: 130 131 { # This resource represents a long-running operation that is the result of a network API call. 132 "done": 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. 133 "error": { # 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. 134 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 135 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 136 { 137 "a_key": "", # Properties of the object. Contains field @type with type URL. 138 }, 139 ], 140 "message": "A String", # 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. 141 }, 142 "metadata": { # 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. 143 "a_key": "", # Properties of the object. Contains field @type with type URL. 144 }, 145 "name": "A String", # 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}`. 146 "response": { # The normal response of the operation in case of success. 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`. 147 "a_key": "", # Properties of the object. Contains field @type with type URL. 148 }, 149}</pre> 150</div> 151 152<div class="method"> 153 <code class="details" id="get">get(name, x__xgafv=None)</code> 154 <pre>Gets the specified IosApp. 155 156Args: 157 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) 158 x__xgafv: string, V1 error format. 159 Allowed values 160 1 - v1 error format 161 2 - v2 error format 162 163Returns: 164 An object of the form: 165 166 { # Details of a Firebase App for iOS. 167 "appId": "A String", # 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. 168 "appStoreId": "A String", # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store. 169 "bundleId": "A String", # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore. 170 "displayName": "A String", # The user-assigned display name for the `IosApp`. 171 "name": "A String", # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google'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)). 172 "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`. 173 "teamId": "A String", # The Apple Developer Team ID associated with the App in the App Store. 174}</pre> 175</div> 176 177<div class="method"> 178 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code> 179 <pre>Gets the configuration artifact associated with the specified IosApp. 180 181Args: 182 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) 183 x__xgafv: string, V1 error format. 184 Allowed values 185 1 - v1 error format 186 2 - v2 error format 187 188Returns: 189 An object of the form: 190 191 { # Configuration metadata of a single Firebase App for iOS. 192 "configFileContents": "A String", # The content of the XML configuration file. 193 "configFilename": "A String", # The filename that the configuration artifact for the `IosApp` is typically saved as. For example: `GoogleService-Info.plist` 194}</pre> 195</div> 196 197<div class="method"> 198 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 199 <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`. 200 201Args: 202 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) 203 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. 204 pageToken: string, Token returned from a previous call to `ListIosApps` indicating where in the set of Apps to resume listing. 205 x__xgafv: string, V1 error format. 206 Allowed values 207 1 - v1 error format 208 2 - v2 error format 209 210Returns: 211 An object of the form: 212 213 { 214 "apps": [ # List of each `IosApp` associated with the specified `FirebaseProject`. 215 { # Details of a Firebase App for iOS. 216 "appId": "A String", # 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. 217 "appStoreId": "A String", # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store. 218 "bundleId": "A String", # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore. 219 "displayName": "A String", # The user-assigned display name for the `IosApp`. 220 "name": "A String", # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google'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)). 221 "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`. 222 "teamId": "A String", # The Apple Developer Team ID associated with the App in the App Store. 223 }, 224 ], 225 "nextPageToken": "A String", # 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. 226}</pre> 227</div> 228 229<div class="method"> 230 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 231 <pre>Retrieves the next page of results. 232 233Args: 234 previous_request: The request for the previous page. (required) 235 previous_response: The response from the request for the previous page. (required) 236 237Returns: 238 A request object that you can call 'execute()' on to request the next 239 page. Returns None if there are no more items in the collection. 240 </pre> 241</div> 242 243<div class="method"> 244 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 245 <pre>Updates the attributes of the specified IosApp. 246 247Args: 248 name: string, The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google'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) 249 body: object, The request body. 250 The object takes the form of: 251 252{ # Details of a Firebase App for iOS. 253 "appId": "A String", # 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. 254 "appStoreId": "A String", # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store. 255 "bundleId": "A String", # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore. 256 "displayName": "A String", # The user-assigned display name for the `IosApp`. 257 "name": "A String", # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google'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)). 258 "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`. 259 "teamId": "A String", # The Apple Developer Team ID associated with the App in the App Store. 260} 261 262 updateMask: string, Specifies which fields to update. Note that the fields `name`, `appId`, `projectId`, and `bundleId` are all immutable. 263 x__xgafv: string, V1 error format. 264 Allowed values 265 1 - v1 error format 266 2 - v2 error format 267 268Returns: 269 An object of the form: 270 271 { # Details of a Firebase App for iOS. 272 "appId": "A String", # 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. 273 "appStoreId": "A String", # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store. 274 "bundleId": "A String", # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore. 275 "displayName": "A String", # The user-assigned display name for the `IosApp`. 276 "name": "A String", # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google'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)). 277 "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`. 278 "teamId": "A String", # The Apple Developer Team ID associated with the App in the App Store. 279}</pre> 280</div> 281 282</body></html>