Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / androidenterprise_v1.grouplicenses.html
blob: edd50dfa6f8d52f3ad0ac5d842bb627fa863f191 [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.grouplicenses.html">grouplicenses</a></h1>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(enterpriseId, groupLicenseId)</a></code></p>
79<p class="firstline">Retrieves details of an enterprise's group license for a product.</p>
80<p class="toc_element">
81 <code><a href="#list">list(enterpriseId)</a></code></p>
82<p class="firstline">Retrieves IDs of all products for which the enterprise has a group license.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="get">get(enterpriseId, groupLicenseId)</code>
86 <pre>Retrieves details of an enterprise's group license for a product.
87
88Args:
89 enterpriseId: string, The ID of the enterprise. (required)
90 groupLicenseId: string, The ID of the product the group license is for, e.g. "app:com.google.android.gm". (required)
91
92Returns:
93 An object of the form:
94
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]95 { # A group license object indicates a product that an enterprise admin has approved for use in the enterprise. The product may be free or paid. For free products, a group license object is created in these cases: if the enterprise admin approves a product in Google Play, if the product is added to a collection, or if an entitlement for the product is created for a user via the API. For paid products, a group license object is only created as part of the first bulk purchase of that product in Google Play by the enterprise admin.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]96 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]97 # The API can be used to query group licenses; the available information includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, that is, the total number of user entitlements in existence for the product.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]98 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]99 # Group license objects are never deleted. If, for example, a free app is added to a collection and then removed, the group license will remain, allowing the enterprise admin to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]100 "kind": "androidenterprise#groupLicense", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense".
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]101 "numPurchased": 42, # The number of purchased licenses (possibly in multiple purchases). If this field is omitted, then there is no limit on the number of licenses that can be provisioned (for example, if the acquisition kind is "free").
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]102 "numProvisioned": 42, # The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]103 "acquisitionKind": "A String", # How this group license was acquired. "bulkPurchase" means that this Grouplicenses resource was created because the enterprise purchased licenses for this product; otherwise, the value is "free" (for free products).
104 "approval": "A String", # Whether the product to which this group license relates is currently approved by the enterprise. Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections, and new entitlements to them should not normally be created.
105 "productId": "A String", # The ID of the product that the license is for. For example, "app:com.google.android.gm".
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]106 "permissions": "A String", # The permission approval status of the product. This field is only set if the product is approved. Possible states are:
107 # - "currentApproved", the current set of permissions is approved, but additional permissions will require the administrator to reapprove the product (If the product was approved without specifying the approved permissions setting, then this is the default behavior.),
108 # - "needsReapproval", the product has unapproved permissions. No additional product licenses can be assigned until the product is reapproved,
109 # - "allCurrentAndFutureApproved", the current permissions are approved and any future permission updates will be automatically approved without administrator review.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]110 }</pre>
111</div>
112
113<div class="method">
114 <code class="details" id="list">list(enterpriseId)</code>
115 <pre>Retrieves IDs of all products for which the enterprise has a group license.
116
117Args:
118 enterpriseId: string, The ID of the enterprise. (required)
119
120Returns:
121 An object of the form:
122
123 { # The grouplicense resources for the enterprise.
124 "groupLicense": [ # A group license for a product approved for use in the enterprise.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]125 { # A group license object indicates a product that an enterprise admin has approved for use in the enterprise. The product may be free or paid. For free products, a group license object is created in these cases: if the enterprise admin approves a product in Google Play, if the product is added to a collection, or if an entitlement for the product is created for a user via the API. For paid products, a group license object is only created as part of the first bulk purchase of that product in Google Play by the enterprise admin.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]126 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]127 # The API can be used to query group licenses; the available information includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, that is, the total number of user entitlements in existence for the product.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]128 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]129 # Group license objects are never deleted. If, for example, a free app is added to a collection and then removed, the group license will remain, allowing the enterprise admin to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]130 "kind": "androidenterprise#groupLicense", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense".
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]131 "numPurchased": 42, # The number of purchased licenses (possibly in multiple purchases). If this field is omitted, then there is no limit on the number of licenses that can be provisioned (for example, if the acquisition kind is "free").
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]132 "numProvisioned": 42, # The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]133 "acquisitionKind": "A String", # How this group license was acquired. "bulkPurchase" means that this Grouplicenses resource was created because the enterprise purchased licenses for this product; otherwise, the value is "free" (for free products).
134 "approval": "A String", # Whether the product to which this group license relates is currently approved by the enterprise. Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections, and new entitlements to them should not normally be created.
135 "productId": "A String", # The ID of the product that the license is for. For example, "app:com.google.android.gm".
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]136 "permissions": "A String", # The permission approval status of the product. This field is only set if the product is approved. Possible states are:
137 # - "currentApproved", the current set of permissions is approved, but additional permissions will require the administrator to reapprove the product (If the product was approved without specifying the approved permissions setting, then this is the default behavior.),
138 # - "needsReapproval", the product has unapproved permissions. No additional product licenses can be assigned until the product is reapproved,
139 # - "allCurrentAndFutureApproved", the current permissions are approved and any future permission updates will be automatically approved without administrator review.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]140 },
141 ],
142 "kind": "androidenterprise#groupLicensesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicensesListResponse".
143 }</pre>
144</div>
145
146</body></html>