Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / androidenterprise_v1.products.html
blob: 8d7f2d0a66a890bd86048f7fc91c2149cfb16fa6 [file] [log] [blame]
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[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
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]75<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.products.html">products</a></h1>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[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="#approve">approve(enterpriseId, productId, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline"><p>Approves the specified product and the relevant app permissions, if any.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]81 <code><a href="#generateApprovalUrl">generateApprovalUrl(enterpriseId, productId, languageCode=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Generates a URL that can be rendered in an iframe to display the</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]84 <code><a href="#get">get(enterpriseId, productId, language=None, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]85<p class="firstline">Retrieves details of a product for display to an enterprise admin.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]87 <code><a href="#getAppRestrictionsSchema">getAppRestrictionsSchema(enterpriseId, productId, language=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Retrieves the schema that defines the configurable properties for this</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]90 <code><a href="#getPermissions">getPermissions(enterpriseId, productId, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]91<p class="firstline">Retrieves the Android app permissions required by this app.</p>
92<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]93 <code><a href="#list">list(enterpriseId, maxResults=None, language=None, approved=None, token=None, query=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Finds approved products that match a query, or all approved products</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]95<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]96 <code><a href="#unapprove">unapprove(enterpriseId, productId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]97<p class="firstline">Unapproves the specified product (and the relevant app permissions, if any)</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]100 <code class="details" id="approve">approve(enterpriseId, productId, body=None, x__xgafv=None)</code>
101 <pre>&lt;p&gt;Approves the specified product and the relevant app permissions, if any.
102The maximum number of products that you can approve per enterprise customer
103is 1,000.&lt;/p&gt;
104&lt;p&gt;To learn how to use managed Google Play to design and create a store
105layout to display approved products to your users,
106see &lt;a href=&quot;/android/work/play/emm-api/store-layout&quot;&gt;Store Layout
107Design&lt;/a&gt;.&lt;/p&gt;
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]108
109Args:
110 enterpriseId: string, The ID of the enterprise. (required)
111 productId: string, The ID of the product. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]112 body: object, The request body.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]113 The object takes the form of:
114
115{
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]116 &quot;approvalUrlInfo&quot;: { # Information on an approval URL. # The approval URL that was shown to the user. Only the permissions shown
117 # to the user with that URL will be accepted, which may not be
118 # the product&#x27;s entire set of permissions. For example, the URL may only
119 # display new permissions from an update after the product was approved,
120 # or not include new permissions if the product was updated since the URL
121 # was generated.
122 &quot;approvalUrl&quot;: &quot;A String&quot;, # A URL that displays a product&#x27;s permissions and that can also be used to
123 # approve the product with the &lt;code&gt;Products.approve&lt;/code&gt; call.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]124 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]125 &quot;approvedPermissions&quot;: &quot;A String&quot;, # Sets how new permission requests for the product are handled.
126 # &quot;allPermissions&quot; automatically approves all current and future
127 # permissions for the product. &quot;currentPermissionsOnly&quot; approves the
128 # current set of permissions for the product, but any future permissions
129 # added through updates will require manual reapproval. If not specified,
130 # only the current set of permissions will be approved.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]131 }
132
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]133 x__xgafv: string, V1 error format.
134 Allowed values
135 1 - v1 error format
136 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]137</pre>
138</div>
139
140<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]141 <code class="details" id="generateApprovalUrl">generateApprovalUrl(enterpriseId, productId, languageCode=None, x__xgafv=None)</code>
142 <pre>Generates a URL that can be rendered in an iframe to display the
143permissions (if any) of a product. An enterprise admin must view these
144permissions and accept them on behalf of their organization in order to
145approve that product. &lt;br&gt;&lt;br&gt;
146Admins should accept the displayed permissions by
147interacting with a separate UI element in the EMM console, which in turn
148should trigger the use of this URL as the
149&lt;code&gt;approvalUrlInfo.approvalUrl&lt;/code&gt; property in a
150&lt;code&gt;Products.approve&lt;/code&gt; call to approve the product.
151This URL can only be used to display permissions for up to 1 day.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]152
153Args:
154 enterpriseId: string, The ID of the enterprise. (required)
155 productId: string, The ID of the product. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]156 languageCode: string, The BCP 47 language code used for permission names and descriptions in
157the returned iframe, for instance &quot;en-US&quot;.
158 x__xgafv: string, V1 error format.
159 Allowed values
160 1 - v1 error format
161 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]162
163Returns:
164 An object of the form:
165
166 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]167 &quot;url&quot;: &quot;A String&quot;, # A URL that can be rendered in an iframe to display the permissions (if
168 # any) of a product.
169 # This URL can be used to approve the product only once and only within 24
170 # hours of being generated, using the &lt;code&gt;Products.approve&lt;/code&gt; call.
171 # If the product is currently unapproved and has no permissions, this
172 # URL will point to an empty page.
173 # If the product is currently approved, a URL will only be generated if
174 # that product has added permissions since it was last approved, and the
175 # URL will only display those new permissions that have not yet been
176 # accepted.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]177 }</pre>
178</div>
179
180<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]181 <code class="details" id="get">get(enterpriseId, productId, language=None, x__xgafv=None)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]182 <pre>Retrieves details of a product for display to an enterprise admin.
183
184Args:
185 enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]186 productId: string, The ID of the product, e.g. &quot;app:com.google.android.gm&quot;. (required)
187 language: string, The BCP47 tag for the user&#x27;s preferred language (e.g. &quot;en-US&quot;, &quot;de&quot;).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]188 x__xgafv: string, V1 error format.
189 Allowed values
190 1 - v1 error format
191 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]192
193Returns:
194 An object of the form:
195
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]196 { # A Products resource represents an app in the Google Play store that is
197 # available to at least some users in the enterprise. (Some apps are restricted
198 # to a single enterprise, and no information about them is made available
199 # outside that enterprise.)
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]200 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]201 # The information provided for each product (localized name, icon, link
202 # to the full Google Play details page) is intended to allow a basic
203 # representation of the product within an EMM user interface.
204 &quot;smallIconUrl&quot;: &quot;A String&quot;, # A link to a smaller image that can be used as an icon for the product.
205 # This image is suitable for use at up to 128px x 128px.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]206 &quot;category&quot;: &quot;A String&quot;, # The app category (e.g. RACING, SOCIAL, etc.)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]207 &quot;distributionChannel&quot;: &quot;A String&quot;, # How and to whom the package is made available.
208 # The value &lt;code&gt;publicGoogleHosted&lt;/code&gt; means that the package is
209 # available through the Play store and not restricted to a specific
210 # enterprise. The value &lt;code&gt;privateGoogleHosted&lt;/code&gt; means that the
211 # package is a private app (restricted to an enterprise) but hosted by
212 # Google. The value &lt;code&gt;privateSelfHosted&lt;/code&gt; means that the package is
213 # a private app (restricted to an enterprise) and is privately hosted.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]214 &quot;permissions&quot;: [ # A list of permissions required by the app.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]215 { # A product permissions resource represents the set of permissions
216 # required by a specific app and whether or not they have been accepted
217 # by an enterprise admin.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]218 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]219 # The API can be used to read the set of permissions, and also to update
220 # the set to indicate that permissions have been accepted.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221 &quot;permissionId&quot;: &quot;A String&quot;, # An opaque string uniquely identifying the permission.
222 &quot;state&quot;: &quot;A String&quot;, # Whether the permission has been accepted or not.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 },
224 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]225 &quot;recentChanges&quot;: &quot;A String&quot;, # A description of the recent changes made to the app.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]226 &quot;minAndroidSdkVersion&quot;: 42, # The minimum Android SDK necessary to run the app.
227 &quot;availableCountries&quot;: [ # The countries which this app is available in.
228 &quot;A String&quot;,
229 ],
230 &quot;title&quot;: &quot;A String&quot;, # The name of the product.
231 &quot;appVersion&quot;: [ # App versions currently available for this product.
232 { # This represents a single version of the app.
233 &quot;track&quot;: &quot;A String&quot;, # Deprecated, use &lt;code&gt;trackId&lt;/code&gt; instead.
234 &quot;versionString&quot;: &quot;A String&quot;, # The string used in the Play store by the app developer to identify
235 # the version.
236 # The string is not necessarily unique or localized (for example, the string
237 # could be &quot;1.4&quot;).
238 &quot;versionCode&quot;: 42, # Unique increasing identifier for the app version.
239 &quot;trackId&quot;: [ # Track ids that the app version is published in. Replaces the
240 # &lt;code&gt;track&lt;/code&gt; field (deprecated), but doesn&#x27;t include the production
241 # track (see &lt;code&gt;isProduction&lt;/code&gt; instead).
242 &quot;A String&quot;,
243 ],
244 &quot;isProduction&quot;: True or False, # True if this version is a production APK.
245 },
246 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]247 &quot;screenshotUrls&quot;: [ # A list of screenshot links representing the app.
248 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]250 &quot;features&quot;: [ # Noteworthy features (if any) of this product.
251 &quot;A String&quot;,
252 ],
253 &quot;authorName&quot;: &quot;A String&quot;, # The name of the author of the product (for example, the app developer).
254 &quot;appTracks&quot;: [ # The tracks visible to the enterprise.
255 { # Id to name association of a track.
256 &quot;trackId&quot;: &quot;A String&quot;, # Unmodifiable, unique track identifier. This identifier is the
257 # releaseTrackId in the url of the play developer console page that displays
258 # the track information.
259 &quot;trackAlias&quot;: &quot;A String&quot;, # A modifiable name for a track. This is the visible name in the play
260 # developer console.
261 },
262 ],
263 &quot;lastUpdatedTimestampMillis&quot;: &quot;A String&quot;, # The approximate time (within 7 days) the app was last published, expressed
264 # in milliseconds since epoch.
265 &quot;availableTracks&quot;: [ # Deprecated, use &lt;code&gt;appTracks&lt;/code&gt; instead.
266 &quot;A String&quot;,
267 ],
268 &quot;detailsUrl&quot;: &quot;A String&quot;, # A link to the (consumer) Google Play details page for the product.
269 &quot;iconUrl&quot;: &quot;A String&quot;, # A link to an image that can be used as an icon for the product.
270 # This image is suitable for use at up to 512px x 512px.
271 &quot;requiresContainerApp&quot;: True or False, # Deprecated.
272 &quot;productPricing&quot;: &quot;A String&quot;, # Whether this product is free, free with in-app purchases, or paid.
273 # If the pricing is unknown, this means the product is not generally
274 # available anymore (even though it might still be available to
275 # people who own it).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]276 &quot;signingCertificate&quot;: { # The certificate used to sign this product.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]277 &quot;certificateHashSha256&quot;: &quot;A String&quot;, # The base64 urlsafe encoded SHA2-256 hash of the certificate.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]278 &quot;certificateHashSha1&quot;: &quot;A String&quot;, # The base64 urlsafe encoded SHA1 hash of the certificate. (This field is
279 # deprecated in favor of SHA2-256. It should not be used and may be
280 # removed at any time.)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]281 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]282 &quot;contentRating&quot;: &quot;A String&quot;, # The content rating for this app.
283 &quot;workDetailsUrl&quot;: &quot;A String&quot;, # A link to the managed Google Play details page for the product,
284 # for use by an Enterprise admin.
285 &quot;productId&quot;: &quot;A String&quot;, # A string of the form &lt;code&gt;&lt;em&gt;app:&amp;lt;package name&amp;gt;&lt;/em&gt;&lt;/code&gt;. For
286 # example, &lt;code&gt;app:com.google.android.gm&lt;/code&gt; represents the Gmail app.
287 &quot;description&quot;: &quot;A String&quot;, # The localized promotional description, if available.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]288 }</pre>
289</div>
290
291<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]292 <code class="details" id="getAppRestrictionsSchema">getAppRestrictionsSchema(enterpriseId, productId, language=None, x__xgafv=None)</code>
293 <pre>Retrieves the schema that defines the configurable properties for this
294product. All products have a schema, but this schema may be empty if no
295managed configurations have been defined. This schema can be used to
296populate a UI that allows an admin to configure the product.
297To apply a managed configuration based on the schema obtained using this
298API, see
299&lt;a href=&quot;/android/work/play/emm-api/managed-configurations&quot;&gt;Managed
300Configurations through Play&lt;/a&gt;.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]301
302Args:
303 enterpriseId: string, The ID of the enterprise. (required)
304 productId: string, The ID of the product. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]305 language: string, The BCP47 tag for the user&#x27;s preferred language (e.g. &quot;en-US&quot;, &quot;de&quot;).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]306 x__xgafv: string, V1 error format.
307 Allowed values
308 1 - v1 error format
309 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]310
311Returns:
312 An object of the form:
313
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]314 { # Represents the list of app restrictions available to be pre-configured for
315 # the product.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]316 &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
317 &quot;restrictions&quot;: [ # The set of restrictions that make up this schema.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]318 { # A restriction in the App Restriction Schema represents a piece of
319 # configuration that may be pre-applied.
320 &quot;key&quot;: &quot;A String&quot;, # The unique key that the product uses to identify the restriction,
321 # e.g. &quot;com.google.android.gm.fieldname&quot;.
322 &quot;nestedRestriction&quot;: [ # For &lt;code&gt;bundle&lt;/code&gt; or &lt;code&gt;bundleArray&lt;/code&gt; restrictions, the list
323 # of nested restrictions. A &lt;code&gt;bundle&lt;/code&gt; restriction is always nested
324 # within a &lt;code&gt;bundleArray&lt;/code&gt; restriction, and a
325 # &lt;code&gt;bundleArray&lt;/code&gt; restriction is at most two levels deep.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]326 # Object with schema name: AppRestrictionsSchemaRestriction
327 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]328 &quot;restrictionType&quot;: &quot;A String&quot;, # The type of the restriction.
329 &quot;title&quot;: &quot;A String&quot;, # The name of the restriction.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]330 &quot;description&quot;: &quot;A String&quot;, # A longer description of the restriction, giving more detail of what it
331 # affects.
332 &quot;defaultValue&quot;: { # A typed value for the restriction. # The default value of the restriction. &lt;code&gt;bundle&lt;/code&gt; and
333 # &lt;code&gt;bundleArray&lt;/code&gt; restrictions never have a default value.
334 &quot;valueString&quot;: &quot;A String&quot;, # The string value - this will be present for types string, choice and
335 # hidden.
336 &quot;valueInteger&quot;: 42, # The integer value - this will only be present if type is integer.
337 &quot;valueMultiselect&quot;: [ # The list of string values - this will only be present if type is
338 # multiselect.
339 &quot;A String&quot;,
340 ],
341 &quot;valueBool&quot;: True or False, # The boolean value - this will only be present if type is bool.
342 &quot;type&quot;: &quot;A String&quot;, # The type of the value being provided.
343 },
344 &quot;entryValue&quot;: [ # For &lt;code&gt;choice&lt;/code&gt; or &lt;code&gt;multiselect&lt;/code&gt; restrictions, the list
345 # of possible entries&#x27; machine-readable values. These values should be used
346 # in the configuration, either as a single &lt;code&gt;string&lt;/code&gt; value for a
347 # &lt;code&gt;choice&lt;/code&gt; restriction or in a &lt;code&gt;stringArray&lt;/code&gt; for a
348 # &lt;code&gt;multiselect&lt;/code&gt; restriction.
349 &quot;A String&quot;,
350 ],
351 &quot;entry&quot;: [ # For &lt;code&gt;choice&lt;/code&gt; or &lt;code&gt;multiselect&lt;/code&gt; restrictions, the list
352 # of possible entries&#x27; human-readable names.
353 &quot;A String&quot;,
354 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]355 },
356 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]357 }</pre>
358</div>
359
360<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]361 <code class="details" id="getPermissions">getPermissions(enterpriseId, productId, x__xgafv=None)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]362 <pre>Retrieves the Android app permissions required by this app.
363
364Args:
365 enterpriseId: string, The ID of the enterprise. (required)
366 productId: string, The ID of the product. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]367 x__xgafv: string, V1 error format.
368 Allowed values
369 1 - v1 error format
370 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]371
372Returns:
373 An object of the form:
374
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]375 { # Information about the permissions required by a specific app and
376 # whether they have been accepted by the enterprise.
377 &quot;productId&quot;: &quot;A String&quot;, # The ID of the app that the permissions relate to, e.g.
378 # &quot;app:com.google.android.gm&quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]379 &quot;permission&quot;: [ # The permissions required by the app.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]380 { # A product permissions resource represents the set of permissions
381 # required by a specific app and whether or not they have been accepted
382 # by an enterprise admin.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]383 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]384 # The API can be used to read the set of permissions, and also to update
385 # the set to indicate that permissions have been accepted.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]386 &quot;permissionId&quot;: &quot;A String&quot;, # An opaque string uniquely identifying the permission.
387 &quot;state&quot;: &quot;A String&quot;, # Whether the permission has been accepted or not.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]388 },
389 ],
390 }</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]391</div>
392
393<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]394 <code class="details" id="list">list(enterpriseId, maxResults=None, language=None, approved=None, token=None, query=None, x__xgafv=None)</code>
395 <pre>Finds approved products that match a query, or all approved products
396if there is no query.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]397
398Args:
399 enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]400 maxResults: integer, Defines how many results the list operation should return.
401The default number depends on the resource collection.
402 language: string, The BCP47 tag for the user&#x27;s preferred language (e.g. &quot;en-US&quot;, &quot;de&quot;).
403Results are returned in the language best matching the preferred
404language.
405 approved: boolean, Specifies whether to search among all products (false) or among
406only products that have been approved (true). Only &quot;true&quot; is
407supported, and should be specified.
408 token: string, Defines the token of the page to return, usually taken from
409TokenPagination.
410This can only be used if token paging is enabled.
411 query: string, The search query as typed in the Google Play store search box.
412If omitted, all approved apps will be returned (using the pagination
413parameters), including apps that are not available in the store
414(e.g. unpublished apps).
415 x__xgafv: string, V1 error format.
416 Allowed values
417 1 - v1 error format
418 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]419
420Returns:
421 An object of the form:
422
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]423 {
424 &quot;pageInfo&quot;: { # Information about the current page. # General pagination information.
425 #
426 # List operations that supports paging return only one &quot;page&quot; of results. This
427 # protocol buffer message describes the page that has been returned.
428 &quot;totalResults&quot;: 42, # Total number of results available on the backend
429 # ! The total number of results in the result set.
430 &quot;startIndex&quot;: 42, # Index of the first result returned in the current page.
431 &quot;resultPerPage&quot;: 42, # Maximum number of results returned in one page.
432 # ! The number of results included in the API response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]433 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]434 &quot;product&quot;: [ # Information about a product (e.g. an app) in the Google Play store, for
435 # display to an enterprise admin.
436 { # A Products resource represents an app in the Google Play store that is
437 # available to at least some users in the enterprise. (Some apps are restricted
438 # to a single enterprise, and no information about them is made available
439 # outside that enterprise.)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]440 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]441 # The information provided for each product (localized name, icon, link
442 # to the full Google Play details page) is intended to allow a basic
443 # representation of the product within an EMM user interface.
444 &quot;smallIconUrl&quot;: &quot;A String&quot;, # A link to a smaller image that can be used as an icon for the product.
445 # This image is suitable for use at up to 128px x 128px.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]446 &quot;category&quot;: &quot;A String&quot;, # The app category (e.g. RACING, SOCIAL, etc.)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]447 &quot;distributionChannel&quot;: &quot;A String&quot;, # How and to whom the package is made available.
448 # The value &lt;code&gt;publicGoogleHosted&lt;/code&gt; means that the package is
449 # available through the Play store and not restricted to a specific
450 # enterprise. The value &lt;code&gt;privateGoogleHosted&lt;/code&gt; means that the
451 # package is a private app (restricted to an enterprise) but hosted by
452 # Google. The value &lt;code&gt;privateSelfHosted&lt;/code&gt; means that the package is
453 # a private app (restricted to an enterprise) and is privately hosted.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]454 &quot;permissions&quot;: [ # A list of permissions required by the app.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]455 { # A product permissions resource represents the set of permissions
456 # required by a specific app and whether or not they have been accepted
457 # by an enterprise admin.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]458 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]459 # The API can be used to read the set of permissions, and also to update
460 # the set to indicate that permissions have been accepted.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]461 &quot;permissionId&quot;: &quot;A String&quot;, # An opaque string uniquely identifying the permission.
462 &quot;state&quot;: &quot;A String&quot;, # Whether the permission has been accepted or not.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]463 },
464 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]465 &quot;recentChanges&quot;: &quot;A String&quot;, # A description of the recent changes made to the app.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]466 &quot;minAndroidSdkVersion&quot;: 42, # The minimum Android SDK necessary to run the app.
467 &quot;availableCountries&quot;: [ # The countries which this app is available in.
468 &quot;A String&quot;,
469 ],
470 &quot;title&quot;: &quot;A String&quot;, # The name of the product.
471 &quot;appVersion&quot;: [ # App versions currently available for this product.
472 { # This represents a single version of the app.
473 &quot;track&quot;: &quot;A String&quot;, # Deprecated, use &lt;code&gt;trackId&lt;/code&gt; instead.
474 &quot;versionString&quot;: &quot;A String&quot;, # The string used in the Play store by the app developer to identify
475 # the version.
476 # The string is not necessarily unique or localized (for example, the string
477 # could be &quot;1.4&quot;).
478 &quot;versionCode&quot;: 42, # Unique increasing identifier for the app version.
479 &quot;trackId&quot;: [ # Track ids that the app version is published in. Replaces the
480 # &lt;code&gt;track&lt;/code&gt; field (deprecated), but doesn&#x27;t include the production
481 # track (see &lt;code&gt;isProduction&lt;/code&gt; instead).
482 &quot;A String&quot;,
483 ],
484 &quot;isProduction&quot;: True or False, # True if this version is a production APK.
485 },
486 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]487 &quot;screenshotUrls&quot;: [ # A list of screenshot links representing the app.
488 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]489 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]490 &quot;features&quot;: [ # Noteworthy features (if any) of this product.
491 &quot;A String&quot;,
492 ],
493 &quot;authorName&quot;: &quot;A String&quot;, # The name of the author of the product (for example, the app developer).
494 &quot;appTracks&quot;: [ # The tracks visible to the enterprise.
495 { # Id to name association of a track.
496 &quot;trackId&quot;: &quot;A String&quot;, # Unmodifiable, unique track identifier. This identifier is the
497 # releaseTrackId in the url of the play developer console page that displays
498 # the track information.
499 &quot;trackAlias&quot;: &quot;A String&quot;, # A modifiable name for a track. This is the visible name in the play
500 # developer console.
501 },
502 ],
503 &quot;lastUpdatedTimestampMillis&quot;: &quot;A String&quot;, # The approximate time (within 7 days) the app was last published, expressed
504 # in milliseconds since epoch.
505 &quot;availableTracks&quot;: [ # Deprecated, use &lt;code&gt;appTracks&lt;/code&gt; instead.
506 &quot;A String&quot;,
507 ],
508 &quot;detailsUrl&quot;: &quot;A String&quot;, # A link to the (consumer) Google Play details page for the product.
509 &quot;iconUrl&quot;: &quot;A String&quot;, # A link to an image that can be used as an icon for the product.
510 # This image is suitable for use at up to 512px x 512px.
511 &quot;requiresContainerApp&quot;: True or False, # Deprecated.
512 &quot;productPricing&quot;: &quot;A String&quot;, # Whether this product is free, free with in-app purchases, or paid.
513 # If the pricing is unknown, this means the product is not generally
514 # available anymore (even though it might still be available to
515 # people who own it).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]516 &quot;signingCertificate&quot;: { # The certificate used to sign this product.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]517 &quot;certificateHashSha256&quot;: &quot;A String&quot;, # The base64 urlsafe encoded SHA2-256 hash of the certificate.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]518 &quot;certificateHashSha1&quot;: &quot;A String&quot;, # The base64 urlsafe encoded SHA1 hash of the certificate. (This field is
519 # deprecated in favor of SHA2-256. It should not be used and may be
520 # removed at any time.)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]521 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]522 &quot;contentRating&quot;: &quot;A String&quot;, # The content rating for this app.
523 &quot;workDetailsUrl&quot;: &quot;A String&quot;, # A link to the managed Google Play details page for the product,
524 # for use by an Enterprise admin.
525 &quot;productId&quot;: &quot;A String&quot;, # A string of the form &lt;code&gt;&lt;em&gt;app:&amp;lt;package name&amp;gt;&lt;/em&gt;&lt;/code&gt;. For
526 # example, &lt;code&gt;app:com.google.android.gm&lt;/code&gt; represents the Gmail app.
527 &quot;description&quot;: &quot;A String&quot;, # The localized promotional description, if available.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]528 },
529 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]530 &quot;tokenPagination&quot;: { # Pagination information returned by a List operation when token pagination # Pagination information for token pagination.
531 # is enabled.
532 #
533 # List operations that supports paging return only one &quot;page&quot; of results. This
534 # protocol buffer message describes the page that has been returned.
535 #
536 # When using token pagination, clients should use the next/previous token
537 # to get another page of the result. The presence or absence of next/previous
538 # token indicates whether a next/previous page is available and provides a
539 # mean of accessing this page. ListRequest.page_token should be set to either
540 # next_page_token or previous_page_token to access another page.
541 &quot;nextPageToken&quot;: &quot;A String&quot;, # Tokens to pass to the standard list field &#x27;page_token&#x27;. Whenever available,
542 # tokens are preferred over manipulating start_index.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]543 &quot;previousPageToken&quot;: &quot;A String&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]544 },
545 }</pre>
546</div>
547
548<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]549 <code class="details" id="unapprove">unapprove(enterpriseId, productId, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]550 <pre>Unapproves the specified product (and the relevant app permissions, if any)
551
552Args:
553 enterpriseId: string, The ID of the enterprise. (required)
554 productId: string, The ID of the product. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]555 x__xgafv: string, V1 error format.
556 Allowed values
557 1 - v1 error format
558 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]559</pre>
560</div>
561
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]562</body></html>