Class: Google::Apis::AndroidenterpriseV1::GroupLicense
- Inherits:
-
Object
- Object
- Google::Apis::AndroidenterpriseV1::GroupLicense
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/androidenterprise_v1/classes.rb,
generated/google/apis/androidenterprise_v1/representations.rb,
generated/google/apis/androidenterprise_v1/representations.rb
Overview
Group license objects allow you to keep track of licenses (called entitlements) 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 Grouplicenses 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 Entitlements 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.
Instance Attribute Summary collapse
-
#acquisition_kind ⇒ String
How this group license was acquired.
-
#approval ⇒ String
Whether the product to which this group license relates is currently approved by the enterprise.
-
#kind ⇒ String
Corresponds to the JSON property
kind
. -
#num_provisioned ⇒ Fixnum
The total number of provisioned licenses for this product.
-
#num_purchased ⇒ Fixnum
The number of purchased licenses (possibly in multiple purchases).
-
#permissions ⇒ String
The permission approval status of the product.
-
#product_id ⇒ String
The ID of the product that the license is for.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GroupLicense
constructor
A new instance of GroupLicense.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GroupLicense
Returns a new instance of GroupLicense.
1119 1120 1121 |
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 1119 def initialize(**args) update!(**args) end |
Instance Attribute Details
#acquisition_kind ⇒ 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).
Corresponds to the JSON property acquisitionKind
1069 1070 1071 |
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 1069 def acquisition_kind @acquisition_kind end |
#approval ⇒ 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.
Corresponds to the JSON property approval
1078 1079 1080 |
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 1078 def approval @approval end |
#kind ⇒ String
Corresponds to the JSON property kind
1083 1084 1085 |
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 1083 def kind @kind end |
#num_provisioned ⇒ Fixnum
The total number of provisioned licenses for this product. Returned by read
operations, but ignored in write operations.
Corresponds to the JSON property numProvisioned
1089 1090 1091 |
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 1089 def num_provisioned @num_provisioned end |
#num_purchased ⇒ Fixnum
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").
Corresponds to the JSON property numPurchased
1096 1097 1098 |
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 1096 def num_purchased @num_purchased end |
#permissions ⇒ String
The permission approval status of the product. This field is only set if the product is approved. Possible states are:
- "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.),
- "needsReapproval", the product has unapproved permissions. No additional product licenses can be assigned until the product is reapproved,
- "allCurrentAndFutureApproved", the current permissions are approved and any
future permission updates will be automatically approved without administrator
review.
Corresponds to the JSON property
permissions
1111 1112 1113 |
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 1111 def @permissions end |
#product_id ⇒ String
The ID of the product that the license is for. For example, "app:com.google.
android.gm".
Corresponds to the JSON property productId
1117 1118 1119 |
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 1117 def product_id @product_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1124 1125 1126 1127 1128 1129 1130 1131 1132 |
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 1124 def update!(**args) @acquisition_kind = args[:acquisition_kind] if args.key?(:acquisition_kind) @approval = args[:approval] if args.key?(:approval) @kind = args[:kind] if args.key?(:kind) @num_provisioned = args[:num_provisioned] if args.key?(:num_provisioned) @num_purchased = args[:num_purchased] if args.key?(:num_purchased) @permissions = args[:permissions] if args.key?(:permissions) @product_id = args[:product_id] if args.key?(:product_id) end |