| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.grouplicenses.html">grouplicenses</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#get">get(enterpriseId, groupLicenseId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves details of an enterprise's group license for a product.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(enterpriseId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves IDs of all products for which the enterprise has a group license.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="get">get(enterpriseId, groupLicenseId, x__xgafv=None)</code> |
| <pre>Retrieves details of an enterprise's group license for a product. |
| |
| Args: |
| enterpriseId: string, The ID of the enterprise. (required) |
| groupLicenseId: string, The ID of the product the group license is for, e.g. |
| "app:com.google.android.gm". (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Group license objects allow you to keep track of licenses (called |
| # <a href="/android/work/play/emm-api/v1/entitlements">entitlements</a>) |
| # for both free and paid apps. For a free app, a group license is created when |
| # an enterprise admin first approves the product in Google Play or when the |
| # first entitlement for the product is created for a user via the API. For a |
| # paid app, a group license object is only created when an enterprise admin |
| # purchases the product in Google Play for the first time. |
| # |
| # Use the API to query group licenses. A <code>Grouplicenses</code> resource |
| # includes the total number of licenses purchased (paid apps only) and the |
| # total number of licenses currently in use. In other words, the total number |
| # of <code>Entitlements</code> that exist for the product. |
| # |
| # Only one group license object is created per product and group license |
| # objects are never deleted. If a product is unapproved, its group license |
| # remains. This allows enterprise admins to keep track of any remaining |
| # entitlements for the product. |
| "numProvisioned": 42, # The total number of provisioned licenses for this product. |
| # Returned by read operations, but ignored in write operations. |
| "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. |
| "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 |
| # <code>&quot;free&quot;</code>). |
| "acquisitionKind": "A String", # How this group license was acquired. <code>&quot;bulkPurchase&quot;</code> |
| # means that this Grouplicenses resource was created because the enterprise |
| # purchased licenses for this product; otherwise, the value is |
| # <code>&quot;free&quot;</code> (for free products). |
| "productId": "A String", # The ID of the product that the license is for. For example, |
| # <code>&quot;app:com.google.android.gm&quot;</code>. |
| "permissions": "A String", # The permission approval status of the product. This field |
| # is only set if the product is approved. Possible states are:<ul> |
| # <li>"<code>currentApproved</code>", 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.),</li> |
| # <li>"<code>needsReapproval</code>", the product has unapproved permissions. |
| # No additional product licenses can be assigned until the product is |
| # reapproved,</li> |
| # <li>"<code>allCurrentAndFutureApproved</code>", |
| # the current permissions are approved and any future permission updates |
| # will be automatically approved without administrator review.</li></ul> |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(enterpriseId, x__xgafv=None)</code> |
| <pre>Retrieves IDs of all products for which the enterprise has a group license. |
| |
| Args: |
| enterpriseId: string, The ID of the enterprise. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "groupLicense": [ # A group license for a product approved for use in the enterprise. |
| { # Group license objects allow you to keep track of licenses (called |
| # <a href="/android/work/play/emm-api/v1/entitlements">entitlements</a>) |
| # for both free and paid apps. For a free app, a group license is created when |
| # an enterprise admin first approves the product in Google Play or when the |
| # first entitlement for the product is created for a user via the API. For a |
| # paid app, a group license object is only created when an enterprise admin |
| # purchases the product in Google Play for the first time. |
| # |
| # Use the API to query group licenses. A <code>Grouplicenses</code> resource |
| # includes the total number of licenses purchased (paid apps only) and the |
| # total number of licenses currently in use. In other words, the total number |
| # of <code>Entitlements</code> that exist for the product. |
| # |
| # Only one group license object is created per product and group license |
| # objects are never deleted. If a product is unapproved, its group license |
| # remains. This allows enterprise admins to keep track of any remaining |
| # entitlements for the product. |
| "numProvisioned": 42, # The total number of provisioned licenses for this product. |
| # Returned by read operations, but ignored in write operations. |
| "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. |
| "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 |
| # <code>&quot;free&quot;</code>). |
| "acquisitionKind": "A String", # How this group license was acquired. <code>&quot;bulkPurchase&quot;</code> |
| # means that this Grouplicenses resource was created because the enterprise |
| # purchased licenses for this product; otherwise, the value is |
| # <code>&quot;free&quot;</code> (for free products). |
| "productId": "A String", # The ID of the product that the license is for. For example, |
| # <code>&quot;app:com.google.android.gm&quot;</code>. |
| "permissions": "A String", # The permission approval status of the product. This field |
| # is only set if the product is approved. Possible states are:<ul> |
| # <li>"<code>currentApproved</code>", 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.),</li> |
| # <li>"<code>needsReapproval</code>", the product has unapproved permissions. |
| # No additional product licenses can be assigned until the product is |
| # reapproved,</li> |
| # <li>"<code>allCurrentAndFutureApproved</code>", |
| # the current permissions are approved and any future permission updates |
| # will be automatically approved without administrator review.</li></ul> |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
