Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / firebase_v1beta1.projects.androidApps.html
blob: ac3de25bb3fabf13d6d0ba3c9fcd40b9373c691c [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
84<p class="firstline">Requests that a new AndroidApp be created.</p>
85<p class="toc_element">
86 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Gets the AndroidApp identified by the specified resource name.</p>
88<p class="toc_element">
89 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Gets the configuration artifact associated with the specified</p>
91<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]92 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]93<p class="firstline">Lists each AndroidApp associated with the specified parent Project.</p>
94<p class="toc_element">
95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
96<p class="firstline">Retrieves the next page of results.</p>
97<p class="toc_element">
98 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
99<p class="firstline">Updates the attributes of the AndroidApp identified by the specified</p>
100<h3>Method Details</h3>
101<div class="method">
102 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
103 <pre>Requests that a new AndroidApp be created.
104&lt;br&gt;
105&lt;br&gt;The result of this call is an `Operation` which can be used to track
106the provisioning process. The `Operation` is automatically deleted after
107completion, so there is no need to call `DeleteOperation`.
108
109Args:
110 parent: string, The parent Project in which to create an App, in the format:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]111&lt;br&gt;&lt;code&gt;projects/&lt;var&gt;PROJECT_NUMBER&lt;/var&gt;&lt;/code&gt; (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112 body: object, The request body.
113 The object takes the form of:
114
115{ # Details of a Firebase App for Android.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]116 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier of the App.
117 # &lt;br&gt;
118 # &lt;br&gt;This identifier should be treated as an opaque token, as the data
119 # format is not specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]120 &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the App, in the format:
121 # &lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;/androidApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt;
122 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the App.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 &quot;projectId&quot;: &quot;A String&quot;, # The globally unique, user-assigned ID of the parent Project for the App.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]124 &quot;packageName&quot;: &quot;A String&quot;, # The canonical package name of the Android App as would appear in the
125 # Google Play Developer Console.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]126}
127
128 x__xgafv: string, V1 error format.
129 Allowed values
130 1 - v1 error format
131 2 - v2 error format
132
133Returns:
134 An object of the form:
135
136 { # This resource represents a long-running operation that is the result of a
137 # network API call.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]138 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
139 # contains progress information and common metadata such as create time.
140 # Some services might not provide such metadata. Any method that returns a
141 # long-running operation should document the metadata type, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]142 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
143 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]144 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
145 # different programming environments, including REST APIs and RPC APIs. It is
146 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
147 # three pieces of data: error code, error message, and error details.
148 #
149 # You can find out more about this error model and how to work with it in the
150 # [API Design Guide](https://cloud.google.com/apis/design/errors).
151 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
152 # user-facing error message should be localized and sent in the
153 # google.rpc.Status.details field, or localized by the client.
154 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
155 # message types for APIs to use.
156 {
157 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
158 },
159 ],
160 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
161 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]162 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
163 # originally returns it. If you use the default HTTP mapping, the
164 # `name` should be a resource name ending with `operations/{unique_id}`.
165 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
166 # method returns no data on success, such as `Delete`, the response is
167 # `google.protobuf.Empty`. If the original method is standard
168 # `Get`/`Create`/`Update`, the response should be the resource. For other
169 # methods, the response should have the type `XxxResponse`, where `Xxx`
170 # is the original method name. For example, if the original method name
171 # is `TakeSnapshot()`, the inferred response type is
172 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]173 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
174 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]175 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
176 # If `true`, the operation is completed, and either `error` or `response` is
177 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]178 }</pre>
179</div>
180
181<div class="method">
182 <code class="details" id="get">get(name, x__xgafv=None)</code>
183 <pre>Gets the AndroidApp identified by the specified resource name.
184
185Args:
186 name: string, The fully qualified resource name of the App, in the format:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]187&lt;br&gt;&lt;code&gt;projects/&lt;var&gt;PROJECT_NUMBER&lt;/var&gt;/androidApps/&lt;var&gt;APP_ID&lt;/var&gt;&lt;/code&gt;
188&lt;br&gt;As an &lt;var&gt;APP_ID&lt;/var&gt; is a unique identifier, the Unique Resource
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]189from Sub-Collection access pattern may be used here, in the format:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]190&lt;br&gt;&lt;code&gt;projects/-/androidApps/&lt;var&gt;APP_ID&lt;/var&gt;&lt;/code&gt; (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]191 x__xgafv: string, V1 error format.
192 Allowed values
193 1 - v1 error format
194 2 - v2 error format
195
196Returns:
197 An object of the form:
198
199 { # Details of a Firebase App for Android.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]200 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier of the App.
201 # &lt;br&gt;
202 # &lt;br&gt;This identifier should be treated as an opaque token, as the data
203 # format is not specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]204 &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the App, in the format:
205 # &lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;/androidApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt;
206 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the App.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]207 &quot;projectId&quot;: &quot;A String&quot;, # The globally unique, user-assigned ID of the parent Project for the App.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]208 &quot;packageName&quot;: &quot;A String&quot;, # The canonical package name of the Android App as would appear in the
209 # Google Play Developer Console.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]210 }</pre>
211</div>
212
213<div class="method">
214 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
215 <pre>Gets the configuration artifact associated with the specified
216AndroidApp.
217
218Args:
219 name: string, The resource name of the App configuration to download, in the format:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]220&lt;br&gt;&lt;code&gt;projects/&lt;var&gt;PROJECT_NUMBER&lt;/var&gt;/androidApps/&lt;var&gt;APP_ID&lt;/var&gt;/config&lt;/code&gt;
221&lt;br&gt;As an &lt;var&gt;APP_ID&lt;/var&gt; is a unique identifier, the Unique Resource
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]222from Sub-Collection access pattern may be used here, in the format:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]223&lt;br&gt;&lt;code&gt;projects/-/androidApps/&lt;var&gt;APP_ID&lt;/var&gt;&lt;/code&gt; (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]224 x__xgafv: string, V1 error format.
225 Allowed values
226 1 - v1 error format
227 2 - v2 error format
228
229Returns:
230 An object of the form:
231
232 { # Configuration metadata of a single Firebase App for Android.
233 &quot;configFilename&quot;: &quot;A String&quot;, # The filename that the configuration artifact is typically saved as.
234 # &lt;br&gt;For example: `google-services.json`
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]235 &quot;configFileContents&quot;: &quot;A String&quot;, # The contents of the JSON configuration file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]236 }</pre>
237</div>
238
239<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]240 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]241 <pre>Lists each AndroidApp associated with the specified parent Project.
242&lt;br&gt;
243&lt;br&gt;The elements are returned in no particular order, but will be a
244consistent view of the Apps when additional requests are made with a
245`pageToken`.
246
247Args:
248 parent: string, The parent Project for which to list Apps, in the format:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]249&lt;br&gt;&lt;code&gt;projects/&lt;var&gt;PROJECT_NUMBER&lt;/var&gt;&lt;/code&gt; (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]250 pageSize: integer, The maximum number of Apps to return in the response.
251&lt;br&gt;
252&lt;br&gt;The server may return fewer than this at its discretion.
253If no value is specified (or too large a value is specified), then the
254server will impose its own limit.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]255 pageToken: string, Token returned from a previous call to `ListAndroidApps` indicating where
256in the set of Apps to resume listing.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]257 x__xgafv: string, V1 error format.
258 Allowed values
259 1 - v1 error format
260 2 - v2 error format
261
262Returns:
263 An object of the form:
264
265 {
266 &quot;apps&quot;: [ # List of each AndroidApp that is in the parent Firebase Project.
267 { # Details of a Firebase App for Android.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]268 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier of the App.
269 # &lt;br&gt;
270 # &lt;br&gt;This identifier should be treated as an opaque token, as the data
271 # format is not specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]272 &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the App, in the format:
273 # &lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;/androidApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt;
274 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the App.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]275 &quot;projectId&quot;: &quot;A String&quot;, # The globally unique, user-assigned ID of the parent Project for the App.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]276 &quot;packageName&quot;: &quot;A String&quot;, # The canonical package name of the Android App as would appear in the
277 # Google Play Developer Console.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]278 },
279 ],
280 &quot;nextPageToken&quot;: &quot;A String&quot;, # If the result list is too large to fit in a single response, then a token
281 # is returned. If the string is empty, then this response is the last page of
282 # results.
283 # &lt;br&gt;
284 # &lt;br&gt;This token can be used in a subsequent call to `ListAndroidApps` to
285 # find the next group of Apps.
286 # &lt;br&gt;
287 # &lt;br&gt;Page tokens are short-lived and should not be persisted.
288 }</pre>
289</div>
290
291<div class="method">
292 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
293 <pre>Retrieves the next page of results.
294
295Args:
296 previous_request: The request for the previous page. (required)
297 previous_response: The response from the request for the previous page. (required)
298
299Returns:
300 A request object that you can call &#x27;execute()&#x27; on to request the next
301 page. Returns None if there are no more items in the collection.
302 </pre>
303</div>
304
305<div class="method">
306 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
307 <pre>Updates the attributes of the AndroidApp identified by the specified
308resource name.
309
310Args:
311 name: string, The fully qualified resource name of the App, in the format:
312&lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;/androidApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt; (required)
313 body: object, The request body.
314 The object takes the form of:
315
316{ # Details of a Firebase App for Android.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]317 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier of the App.
318 # &lt;br&gt;
319 # &lt;br&gt;This identifier should be treated as an opaque token, as the data
320 # format is not specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]321 &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the App, in the format:
322 # &lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;/androidApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt;
323 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the App.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]324 &quot;projectId&quot;: &quot;A String&quot;, # The globally unique, user-assigned ID of the parent Project for the App.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]325 &quot;packageName&quot;: &quot;A String&quot;, # The canonical package name of the Android App as would appear in the
326 # Google Play Developer Console.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]327}
328
329 updateMask: string, Specifies which fields to update.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]330&lt;br&gt;Note that the fields `name`, `app_id`, `project_id`, and `package_name`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]331are all immutable.
332 x__xgafv: string, V1 error format.
333 Allowed values
334 1 - v1 error format
335 2 - v2 error format
336
337Returns:
338 An object of the form:
339
340 { # Details of a Firebase App for Android.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]341 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier of the App.
342 # &lt;br&gt;
343 # &lt;br&gt;This identifier should be treated as an opaque token, as the data
344 # format is not specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]345 &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the App, in the format:
346 # &lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;/androidApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt;
347 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the App.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]348 &quot;projectId&quot;: &quot;A String&quot;, # The globally unique, user-assigned ID of the parent Project for the App.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]349 &quot;packageName&quot;: &quot;A String&quot;, # The canonical package name of the Android App as would appear in the
350 # Google Play Developer Console.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]351 }</pre>
352</div>
353
354</body></html>