blob: 2fd99f0514cf9f1ba30d3ea9f51c622822f2ba48 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -07001<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
Nathaniel Manista4f877e52015-06-15 16:44:50 +000075<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.apks.html">apks</a></h1>
Craig Citro065b5302014-08-14 00:47:23 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
Craig Citroe633be12015-03-02 13:40:36 -080078 <code><a href="#addexternallyhosted">addexternallyhosted(packageName, editId, body)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000079<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>
Craig Citroe633be12015-03-02 13:40:36 -080080<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -070081 <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">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080084 <code><a href="#upload">upload(packageName, editId, media_body=None, media_mime_type=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -070085<p class="firstline">A description of how to use this function</p>
86<h3>Method Details</h3>
87<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -080088 <code class="details" id="addexternallyhosted">addexternallyhosted(packageName, editId, body)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000089 <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.
Craig Citroe633be12015-03-02 13:40:36 -080090
91Args:
92 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
93 editId: string, Unique identifier for this edit. (required)
94 body: object, The request body. (required)
95 The object takes the form of:
96
97{
Nathaniel Manista4f877e52015-06-15 16:44:50 +000098 "externallyHostedApk": { # 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.
Craig Citroe633be12015-03-02 13:40:36 -080099 "iconBase64": "A String", # The icon image from the APK, as a base64 encoded byte array.
100 "certificateBase64s": [ # 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 "A String",
102 ],
103 "externallyHostedUrl": "A String", # The URL at which the APK is hosted. This must be an https URL.
104 "maximumSdk": 42, # The maximum SDK supported by this APK (optional).
105 "fileSha256Base64": "A String", # The SHA256 checksum of this APK, represented as a base64 encoded byte array.
106 "usesPermissions": [ # The permissions requested by this APK.
107 { # A permission used by this APK.
108 "maxSdkVersion": 42, # Optionally, the maximum SDK version for which the permission is required.
109 "name": "A String", # The name of the permission requested.
110 },
111 ],
112 "fileSha1Base64": "A String", # The SHA1 checksum of this APK, represented as a base64 encoded byte array.
113 "usesFeatures": [ # The features required by this APK (optional).
114 "A String",
115 ],
116 "fileSize": "A String", # The file size in bytes of this APK.
117 "versionName": "A String", # The version name of this APK.
118 "versionCode": 42, # The version code of this APK.
119 "packageName": "A String", # The package name.
120 "minimumSdk": 42, # The minimum SDK targeted by this APK.
121 "applicationLabel": "A String", # The application label.
122 "nativeCodes": [ # The native code environments supported by this APK (optional).
123 "A String",
124 ],
125 },
126 }
127
128
129Returns:
130 An object of the form:
131
132 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000133 "externallyHostedApk": { # 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.
Craig Citroe633be12015-03-02 13:40:36 -0800134 "iconBase64": "A String", # The icon image from the APK, as a base64 encoded byte array.
135 "certificateBase64s": [ # 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 "A String",
137 ],
138 "externallyHostedUrl": "A String", # The URL at which the APK is hosted. This must be an https URL.
139 "maximumSdk": 42, # The maximum SDK supported by this APK (optional).
140 "fileSha256Base64": "A String", # The SHA256 checksum of this APK, represented as a base64 encoded byte array.
141 "usesPermissions": [ # The permissions requested by this APK.
142 { # A permission used by this APK.
143 "maxSdkVersion": 42, # Optionally, the maximum SDK version for which the permission is required.
144 "name": "A String", # The name of the permission requested.
145 },
146 ],
147 "fileSha1Base64": "A String", # The SHA1 checksum of this APK, represented as a base64 encoded byte array.
148 "usesFeatures": [ # The features required by this APK (optional).
149 "A String",
150 ],
151 "fileSize": "A String", # The file size in bytes of this APK.
152 "versionName": "A String", # The version name of this APK.
153 "versionCode": 42, # The version code of this APK.
154 "packageName": "A String", # The package name.
155 "minimumSdk": 42, # The minimum SDK targeted by this APK.
156 "applicationLabel": "A String", # The application label.
157 "nativeCodes": [ # The native code environments supported by this APK (optional).
158 "A String",
159 ],
160 },
161 }</pre>
162</div>
163
164<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700165 <code class="details" id="list">list(packageName, editId)</code>
166 <pre>A description of how to use this function
167
168Args:
169 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
170 editId: string, Unique identifier for this edit. (required)
171
172Returns:
173 An object of the form:
174
175 {
176 "apks": [
177 {
178 "versionCode": 42, # The version code of the APK, as specified in the APK's manifest file.
179 "binary": { # Represents the binary payload of an APK. # Information about the binary payload of this APK.
180 "sha1": "A String", # A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command.
181 },
182 },
183 ],
184 "kind": "androidpublisher#apksListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidpublisher#apksListResponse".
185 }</pre>
186</div>
187
188<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800189 <code class="details" id="upload">upload(packageName, editId, media_body=None, media_mime_type=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700190 <pre>A description of how to use this function
191
192Args:
193 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
194 editId: string, Unique identifier for this edit. (required)
195 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800196 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Craig Citro065b5302014-08-14 00:47:23 -0700197
198Returns:
199 An object of the form:
200
201 {
202 "versionCode": 42, # The version code of the APK, as specified in the APK's manifest file.
203 "binary": { # Represents the binary payload of an APK. # Information about the binary payload of this APK.
204 "sha1": "A String", # A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command.
205 },
206 }</pre>
207</div>
208
209</body></html>