Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / androidpublisher_v3.edits.apks.html
blob: c226aca98036f323c448cc8701541c190f41b547 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]75<h1><a href="androidpublisher_v3.html">Google Play Android Developer API</a> . <a href="androidpublisher_v3.edits.html">edits</a> . <a href="androidpublisher_v3.edits.apks.html">apks</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]78 <code><a href="#addexternallyhosted">addexternallyhosted(packageName, editId, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a new APK without uploading the APK itself to Google Play, instead</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]81 <code><a href="#list">list(packageName, editId, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists all current APKs of the app and edit.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]84 <code><a href="#upload">upload(packageName, editId, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
85<p class="firstline">Uploads an APK and adds to the current edit.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<h3>Method Details</h3>
87<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]88 <code class="details" id="addexternallyhosted">addexternallyhosted(packageName, editId, body=None, x__xgafv=None)</code>
89 <pre>Creates a new APK without uploading the APK itself to Google Play, instead
90hosting the APK at a specified URL. This function is only available to
91organizations using Managed Play whose application is configured to
92restrict distribution to the organizations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93
94Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]95 packageName: string, Package name of the app. (required)
96 editId: string, Identifier of the edit. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 The object takes the form of:
99
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]100{ # Request to create a new externally hosted APK.
101 &quot;externallyHostedApk&quot;: { # Defines an APK available for this application that is hosted externally # The definition of the externally-hosted APK and where it is located.
102 # and not uploaded to Google Play.
103 # This function is only available to organizations using Managed Play whose
104 # application is configured to restrict distribution to the organizations.
105 &quot;certificateBase64s&quot;: [ # A certificate (or array of certificates if a certificate-chain is used)
106 # used to sign this APK, represented as a base64 encoded byte array.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 &quot;externallyHostedUrl&quot;: &quot;A String&quot;, # The URL at which the APK is hosted. This must be an https URL.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]110 &quot;versionName&quot;: &quot;A String&quot;, # The version name of this APK.
111 &quot;fileSha256Base64&quot;: &quot;A String&quot;, # The sha256 checksum of this APK, represented as a base64 encoded byte
112 # array.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &quot;iconBase64&quot;: &quot;A String&quot;, # The icon image from the APK, as a base64 encoded byte array.
114 &quot;maximumSdk&quot;: 42, # The maximum SDK supported by this APK (optional).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 &quot;usesFeatures&quot;: [ # The features required by this APK (optional).
116 &quot;A String&quot;,
117 ],
118 &quot;usesPermissions&quot;: [ # The permissions requested by this APK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 { # A permission used by this APK.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 &quot;name&quot;: &quot;A String&quot;, # The name of the permission requested.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]121 &quot;maxSdkVersion&quot;: 42, # Optionally, the maximum SDK version for which the permission is
122 # required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 },
124 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]125 &quot;fileSize&quot;: &quot;A String&quot;, # The file size in bytes of this APK.
126 &quot;packageName&quot;: &quot;A String&quot;, # The package name.
127 &quot;applicationLabel&quot;: &quot;A String&quot;, # The application label.
128 &quot;nativeCodes&quot;: [ # The native code environments supported by this APK (optional).
129 &quot;A String&quot;,
130 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]131 &quot;versionCode&quot;: 42, # The version code of this APK.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]132 &quot;fileSha1Base64&quot;: &quot;A String&quot;, # The sha1 checksum of this APK, represented as a base64 encoded byte
133 # array.
134 &quot;minimumSdk&quot;: 42, # The minimum SDK targeted by this APK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 },
136 }
137
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]138 x__xgafv: string, V1 error format.
139 Allowed values
140 1 - v1 error format
141 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142
143Returns:
144 An object of the form:
145
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]146 { # Response for creating a new externally hosted APK.
147 &quot;externallyHostedApk&quot;: { # Defines an APK available for this application that is hosted externally # The definition of the externally-hosted APK and where it is located.
148 # and not uploaded to Google Play.
149 # This function is only available to organizations using Managed Play whose
150 # application is configured to restrict distribution to the organizations.
151 &quot;certificateBase64s&quot;: [ # A certificate (or array of certificates if a certificate-chain is used)
152 # used to sign this APK, represented as a base64 encoded byte array.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]153 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]155 &quot;externallyHostedUrl&quot;: &quot;A String&quot;, # The URL at which the APK is hosted. This must be an https URL.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]156 &quot;versionName&quot;: &quot;A String&quot;, # The version name of this APK.
157 &quot;fileSha256Base64&quot;: &quot;A String&quot;, # The sha256 checksum of this APK, represented as a base64 encoded byte
158 # array.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]159 &quot;iconBase64&quot;: &quot;A String&quot;, # The icon image from the APK, as a base64 encoded byte array.
160 &quot;maximumSdk&quot;: 42, # The maximum SDK supported by this APK (optional).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 &quot;usesFeatures&quot;: [ # The features required by this APK (optional).
162 &quot;A String&quot;,
163 ],
164 &quot;usesPermissions&quot;: [ # The permissions requested by this APK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 { # A permission used by this APK.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]166 &quot;name&quot;: &quot;A String&quot;, # The name of the permission requested.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]167 &quot;maxSdkVersion&quot;: 42, # Optionally, the maximum SDK version for which the permission is
168 # required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169 },
170 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]171 &quot;fileSize&quot;: &quot;A String&quot;, # The file size in bytes of this APK.
172 &quot;packageName&quot;: &quot;A String&quot;, # The package name.
173 &quot;applicationLabel&quot;: &quot;A String&quot;, # The application label.
174 &quot;nativeCodes&quot;: [ # The native code environments supported by this APK (optional).
175 &quot;A String&quot;,
176 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]177 &quot;versionCode&quot;: 42, # The version code of this APK.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]178 &quot;fileSha1Base64&quot;: &quot;A String&quot;, # The sha1 checksum of this APK, represented as a base64 encoded byte
179 # array.
180 &quot;minimumSdk&quot;: 42, # The minimum SDK targeted by this APK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]181 },
182 }</pre>
183</div>
184
185<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]186 <code class="details" id="list">list(packageName, editId, x__xgafv=None)</code>
187 <pre>Lists all current APKs of the app and edit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188
189Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]190 packageName: string, Package name of the app. (required)
191 editId: string, Identifier of the edit. (required)
192 x__xgafv: string, V1 error format.
193 Allowed values
194 1 - v1 error format
195 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196
197Returns:
198 An object of the form:
199
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]200 { # Response listing all APKs.
201 &quot;kind&quot;: &quot;A String&quot;, # The kind of this response (&quot;androidpublisher#apksListResponse&quot;).
202 &quot;apks&quot;: [ # All APKs.
203 { # Information about an APK. The resource for ApksService.
204 &quot;versionCode&quot;: 42, # The version code of the APK, as specified in the manifest file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]205 &quot;binary&quot;: { # Represents the binary payload of an APK. # Information about the binary payload of this APK.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]206 &quot;sha1&quot;: &quot;A String&quot;, # A sha1 hash of the APK payload, encoded as a hex string and matching the
207 # output of the sha1sum command.
208 &quot;sha256&quot;: &quot;A String&quot;, # A sha256 hash of the APK payload, encoded as a hex string and matching
209 # the output of the sha256sum command.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210 },
211 },
212 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]213 }</pre>
214</div>
215
216<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]217 <code class="details" id="upload">upload(packageName, editId, x__xgafv=None, media_body=None, media_mime_type=None)</code>
218 <pre>Uploads an APK and adds to the current edit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219
220Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]221 packageName: string, Package name of the app. (required)
222 editId: string, Identifier of the edit. (required)
223 x__xgafv: string, V1 error format.
224 Allowed values
225 1 - v1 error format
226 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]227 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
228 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
229
230Returns:
231 An object of the form:
232
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]233 { # Information about an APK. The resource for ApksService.
234 &quot;versionCode&quot;: 42, # The version code of the APK, as specified in the manifest file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]235 &quot;binary&quot;: { # Represents the binary payload of an APK. # Information about the binary payload of this APK.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]236 &quot;sha1&quot;: &quot;A String&quot;, # A sha1 hash of the APK payload, encoded as a hex string and matching the
237 # output of the sha1sum command.
238 &quot;sha256&quot;: &quot;A String&quot;, # A sha256 hash of the APK payload, encoded as a hex string and matching
239 # the output of the sha256sum command.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 }</pre>
242</div>
243
244</body></html>