Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / androidenterprise_v1.grouplicenses.html
blob: 9a115c4a7991249a4cc42c3a293e06b3770b1855 [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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]78 <code><a href="#get">get(enterpriseId, groupLicenseId, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]79<p class="firstline">Retrieves details of an enterprise's group license for a product.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#list">list(enterpriseId, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]85 <code class="details" id="get">get(enterpriseId, groupLicenseId, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86 <pre>Retrieves details of an enterprise&#x27;s group license for a product.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]87
88Args:
89 enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]90 groupLicenseId: string, The ID of the product the group license is for, e.g.
91&quot;app:com.google.android.gm&quot;. (required)
92 x__xgafv: string, V1 error format.
93 Allowed values
94 1 - v1 error format
95 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]96
97Returns:
98 An object of the form:
99
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]100 { # Group license objects allow you to keep track of licenses (called
101 # &lt;a href=&quot;/android/work/play/emm-api/v1/entitlements&quot;&gt;entitlements&lt;/a&gt;)
102 # for both free and paid apps. For a free app, a group license is created when
103 # an enterprise admin first approves the product in Google Play or when the
104 # first entitlement for the product is created for a user via the API. For a
105 # paid app, a group license object is only created when an enterprise admin
106 # purchases the product in Google Play for the first time.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]107 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]108 # Use the API to query group licenses. A &lt;code&gt;Grouplicenses&lt;/code&gt; resource
109 # includes the total number of licenses purchased (paid apps only) and the
110 # total number of licenses currently in use. In other words, the total number
111 # of &lt;code&gt;Entitlements&lt;/code&gt; that exist for the product.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]112 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]113 # Only one group license object is created per product and group license
114 # objects are never deleted. If a product is unapproved, its group license
115 # remains. This allows enterprise admins to keep track of any remaining
116 # entitlements for the product.
117 &quot;numProvisioned&quot;: 42, # The total number of provisioned licenses for this product.
118 # Returned by read operations, but ignored in write operations.
119 &quot;approval&quot;: &quot;A String&quot;, # Whether the product to which this group license relates is currently
120 # approved by the enterprise. Products are approved when a group license is
121 # first created, but this approval may be revoked by an enterprise admin via
122 # Google Play. Unapproved products will not be visible to end users in
123 # collections, and new entitlements to them should not normally be created.
124 &quot;numPurchased&quot;: 42, # The number of purchased licenses (possibly in multiple purchases).
125 # If this field is omitted, then there is no limit on the number of licenses
126 # that can be provisioned (for example, if the acquisition kind is
127 # &lt;code&gt;&amp;quot;free&amp;quot;&lt;/code&gt;).
128 &quot;acquisitionKind&quot;: &quot;A String&quot;, # How this group license was acquired. &lt;code&gt;&amp;quot;bulkPurchase&amp;quot;&lt;/code&gt;
129 # means that this Grouplicenses resource was created because the enterprise
130 # purchased licenses for this product; otherwise, the value is
131 # &lt;code&gt;&amp;quot;free&amp;quot;&lt;/code&gt; (for free products).
132 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the license is for. For example,
133 # &lt;code&gt;&amp;quot;app:com.google.android.gm&amp;quot;&lt;/code&gt;.
134 &quot;permissions&quot;: &quot;A String&quot;, # The permission approval status of the product. This field
135 # is only set if the product is approved. Possible states are:&lt;ul&gt;
136 # &lt;li&gt;&quot;&lt;code&gt;currentApproved&lt;/code&gt;&quot;, the current set
137 # of permissions is approved, but additional permissions will require the
138 # administrator to reapprove the product (If the product was approved
139 # without specifying the approved permissions setting, then this is the
140 # default behavior.),&lt;/li&gt;
141 # &lt;li&gt;&quot;&lt;code&gt;needsReapproval&lt;/code&gt;&quot;, the product has unapproved permissions.
142 # No additional product licenses can be assigned until the product is
143 # reapproved,&lt;/li&gt;
144 # &lt;li&gt;&quot;&lt;code&gt;allCurrentAndFutureApproved&lt;/code&gt;&quot;,
145 # the current permissions are approved and any future permission updates
146 # will be automatically approved without administrator review.&lt;/li&gt;&lt;/ul&gt;
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]147 }</pre>
148</div>
149
150<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]151 <code class="details" id="list">list(enterpriseId, x__xgafv=None)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]152 <pre>Retrieves IDs of all products for which the enterprise has a group license.
153
154Args:
155 enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]156 x__xgafv: string, V1 error format.
157 Allowed values
158 1 - v1 error format
159 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]160
161Returns:
162 An object of the form:
163
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]164 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]165 &quot;groupLicense&quot;: [ # A group license for a product approved for use in the enterprise.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]166 { # Group license objects allow you to keep track of licenses (called
167 # &lt;a href=&quot;/android/work/play/emm-api/v1/entitlements&quot;&gt;entitlements&lt;/a&gt;)
168 # for both free and paid apps. For a free app, a group license is created when
169 # an enterprise admin first approves the product in Google Play or when the
170 # first entitlement for the product is created for a user via the API. For a
171 # paid app, a group license object is only created when an enterprise admin
172 # purchases the product in Google Play for the first time.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]173 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]174 # Use the API to query group licenses. A &lt;code&gt;Grouplicenses&lt;/code&gt; resource
175 # includes the total number of licenses purchased (paid apps only) and the
176 # total number of licenses currently in use. In other words, the total number
177 # of &lt;code&gt;Entitlements&lt;/code&gt; that exist for the product.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]178 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]179 # Only one group license object is created per product and group license
180 # objects are never deleted. If a product is unapproved, its group license
181 # remains. This allows enterprise admins to keep track of any remaining
182 # entitlements for the product.
183 &quot;numProvisioned&quot;: 42, # The total number of provisioned licenses for this product.
184 # Returned by read operations, but ignored in write operations.
185 &quot;approval&quot;: &quot;A String&quot;, # Whether the product to which this group license relates is currently
186 # approved by the enterprise. Products are approved when a group license is
187 # first created, but this approval may be revoked by an enterprise admin via
188 # Google Play. Unapproved products will not be visible to end users in
189 # collections, and new entitlements to them should not normally be created.
190 &quot;numPurchased&quot;: 42, # The number of purchased licenses (possibly in multiple purchases).
191 # If this field is omitted, then there is no limit on the number of licenses
192 # that can be provisioned (for example, if the acquisition kind is
193 # &lt;code&gt;&amp;quot;free&amp;quot;&lt;/code&gt;).
194 &quot;acquisitionKind&quot;: &quot;A String&quot;, # How this group license was acquired. &lt;code&gt;&amp;quot;bulkPurchase&amp;quot;&lt;/code&gt;
195 # means that this Grouplicenses resource was created because the enterprise
196 # purchased licenses for this product; otherwise, the value is
197 # &lt;code&gt;&amp;quot;free&amp;quot;&lt;/code&gt; (for free products).
198 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the license is for. For example,
199 # &lt;code&gt;&amp;quot;app:com.google.android.gm&amp;quot;&lt;/code&gt;.
200 &quot;permissions&quot;: &quot;A String&quot;, # The permission approval status of the product. This field
201 # is only set if the product is approved. Possible states are:&lt;ul&gt;
202 # &lt;li&gt;&quot;&lt;code&gt;currentApproved&lt;/code&gt;&quot;, the current set
203 # of permissions is approved, but additional permissions will require the
204 # administrator to reapprove the product (If the product was approved
205 # without specifying the approved permissions setting, then this is the
206 # default behavior.),&lt;/li&gt;
207 # &lt;li&gt;&quot;&lt;code&gt;needsReapproval&lt;/code&gt;&quot;, the product has unapproved permissions.
208 # No additional product licenses can be assigned until the product is
209 # reapproved,&lt;/li&gt;
210 # &lt;li&gt;&quot;&lt;code&gt;allCurrentAndFutureApproved&lt;/code&gt;&quot;,
211 # the current permissions are approved and any future permission updates
212 # will be automatically approved without administrator review.&lt;/li&gt;&lt;/ul&gt;
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]213 },
214 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]215 }</pre>
216</div>
217
218</body></html>