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.androidApps.html">androidApps</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="firebase_v1beta1.projects.androidApps.sha.html">sha()</a></code> 79</p> 80<p class="firstline">Returns the sha Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Requests the creation of a new AndroidApp 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> 88<p class="toc_element"> 89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 90<p class="firstline">Gets the specified AndroidApp.</p> 91<p class="toc_element"> 92 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p> 93<p class="firstline">Gets the configuration artifact associated with the specified AndroidApp.</p> 94<p class="toc_element"> 95 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Lists each AndroidApp 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> 97<p class="toc_element"> 98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 99<p class="firstline">Retrieves the next page of results.</p> 100<p class="toc_element"> 101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Updates the attributes of the specified AndroidApp.</p> 103<h3>Method Details</h3> 104<div class="method"> 105 <code class="details" id="close">close()</code> 106 <pre>Close httplib2 connections.</pre> 107</div> 108 109<div class="method"> 110 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 111 <pre>Requests the creation of a new AndroidApp 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`. 112 113Args: 114 parent: string, The resource name of the parent FirebaseProject in which to create an AndroidApp, in the format: projects/PROJECT_IDENTIFIER/androidApps Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required) 115 body: object, The request body. 116 The object takes the form of: 117 118{ # Details of a Firebase App for Android. 119 "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier for the `AndroidApp`. This identifier should be treated as an opaque token, as the data format is not specified. 120 "displayName": "A String", # The user-assigned display name for the `AndroidApp`. 121 "name": "A String", # The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/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.androidApps#AndroidApp.FIELDS.app_id)). 122 "packageName": "A String", # Immutable. The canonical package name of the Android app as would appear in the Google Play Developer Console. 123 "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `AndroidApp`. 124} 125 126 x__xgafv: string, V1 error format. 127 Allowed values 128 1 - v1 error format 129 2 - v2 error format 130 131Returns: 132 An object of the form: 133 134 { # This resource represents a long-running operation that is the result of a network API call. 135 "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. 136 "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. 137 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 138 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 139 { 140 "a_key": "", # Properties of the object. Contains field @type with type URL. 141 }, 142 ], 143 "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. 144 }, 145 "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. 146 "a_key": "", # Properties of the object. Contains field @type with type URL. 147 }, 148 "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}`. 149 "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`. 150 "a_key": "", # Properties of the object. Contains field @type with type URL. 151 }, 152}</pre> 153</div> 154 155<div class="method"> 156 <code class="details" id="get">get(name, x__xgafv=None)</code> 157 <pre>Gets the specified AndroidApp. 158 159Args: 160 name: string, The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/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/-/androidApps/APP_ID Refer to the `AndroidApp` [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values. (required) 161 x__xgafv: string, V1 error format. 162 Allowed values 163 1 - v1 error format 164 2 - v2 error format 165 166Returns: 167 An object of the form: 168 169 { # Details of a Firebase App for Android. 170 "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier for the `AndroidApp`. This identifier should be treated as an opaque token, as the data format is not specified. 171 "displayName": "A String", # The user-assigned display name for the `AndroidApp`. 172 "name": "A String", # The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/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.androidApps#AndroidApp.FIELDS.app_id)). 173 "packageName": "A String", # Immutable. The canonical package name of the Android app as would appear in the Google Play Developer Console. 174 "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `AndroidApp`. 175}</pre> 176</div> 177 178<div class="method"> 179 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code> 180 <pre>Gets the configuration artifact associated with the specified AndroidApp. 181 182Args: 183 name: string, The resource name of the AndroidApp configuration to download, in the format: projects/PROJECT_IDENTIFIER/androidApps/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/-/androidApps/APP_ID Refer to the `AndroidApp` [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values. (required) 184 x__xgafv: string, V1 error format. 185 Allowed values 186 1 - v1 error format 187 2 - v2 error format 188 189Returns: 190 An object of the form: 191 192 { # Configuration metadata of a single Firebase App for Android. 193 "configFileContents": "A String", # The contents of the JSON configuration file. 194 "configFilename": "A String", # The filename that the configuration artifact for the `AndroidApp` is typically saved as. For example: `google-services.json` 195}</pre> 196</div> 197 198<div class="method"> 199 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 200 <pre>Lists each AndroidApp 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`. 201 202Args: 203 parent: string, The resource name of the parent FirebaseProject for which to list each associated AndroidApp, in the format: projects/PROJECT_IDENTIFIER /androidApps Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required) 204 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), then the server will impose its own limit. 205 pageToken: string, Token returned from a previous call to `ListAndroidApps` indicating where in the set of Apps to resume listing. 206 x__xgafv: string, V1 error format. 207 Allowed values 208 1 - v1 error format 209 2 - v2 error format 210 211Returns: 212 An object of the form: 213 214 { 215 "apps": [ # List of each `AndroidApp` associated with the specified `FirebaseProject`. 216 { # Details of a Firebase App for Android. 217 "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier for the `AndroidApp`. This identifier should be treated as an opaque token, as the data format is not specified. 218 "displayName": "A String", # The user-assigned display name for the `AndroidApp`. 219 "name": "A String", # The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/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.androidApps#AndroidApp.FIELDS.app_id)). 220 "packageName": "A String", # Immutable. The canonical package name of the Android app as would appear in the Google Play Developer Console. 221 "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `AndroidApp`. 222 }, 223 ], 224 "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 `ListAndroidApps` to find the next group of Apps. Page tokens are short-lived and should not be persisted. 225}</pre> 226</div> 227 228<div class="method"> 229 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 230 <pre>Retrieves the next page of results. 231 232Args: 233 previous_request: The request for the previous page. (required) 234 previous_response: The response from the request for the previous page. (required) 235 236Returns: 237 A request object that you can call 'execute()' on to request the next 238 page. Returns None if there are no more items in the collection. 239 </pre> 240</div> 241 242<div class="method"> 243 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 244 <pre>Updates the attributes of the specified AndroidApp. 245 246Args: 247 name: string, The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/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.androidApps#AndroidApp.FIELDS.app_id)). (required) 248 body: object, The request body. 249 The object takes the form of: 250 251{ # Details of a Firebase App for Android. 252 "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier for the `AndroidApp`. This identifier should be treated as an opaque token, as the data format is not specified. 253 "displayName": "A String", # The user-assigned display name for the `AndroidApp`. 254 "name": "A String", # The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/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.androidApps#AndroidApp.FIELDS.app_id)). 255 "packageName": "A String", # Immutable. The canonical package name of the Android app as would appear in the Google Play Developer Console. 256 "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `AndroidApp`. 257} 258 259 updateMask: string, Specifies which fields to update. Note that the fields `name`, `app_id`, `project_id`, and `package_name` are all immutable. 260 x__xgafv: string, V1 error format. 261 Allowed values 262 1 - v1 error format 263 2 - v2 error format 264 265Returns: 266 An object of the form: 267 268 { # Details of a Firebase App for Android. 269 "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier for the `AndroidApp`. This identifier should be treated as an opaque token, as the data format is not specified. 270 "displayName": "A String", # The user-assigned display name for the `AndroidApp`. 271 "name": "A String", # The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/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.androidApps#AndroidApp.FIELDS.app_id)). 272 "packageName": "A String", # Immutable. The canonical package name of the Android app as would appear in the Google Play Developer Console. 273 "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `AndroidApp`. 274}</pre> 275</div> 276 277</body></html>