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