Class: Google::Apis::AndroidenterpriseV1::GroupLicense

Inherits:
Object
  • Object
show all
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

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. 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. 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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GroupLicense

Returns a new instance of GroupLicense.


875
876
877
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 875

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#acquisition_kindString

How this group license was acquired. "bulkPurchase" means that this group license object was created because the enterprise purchased licenses for this product; this is "free" otherwise (for free products). Corresponds to the JSON property acquisitionKind

Returns:

  • (String)

838
839
840
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 838

def acquisition_kind
  @acquisition_kind
end

#approvalString

Whether the product to which this group license relates is currently approved by the enterprise, as either "approved" or "unapproved". 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

Returns:

  • (String)

848
849
850
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 848

def approval
  @approval
end

#kindString

Identifies what kind of resource this is. Value: the fixed string " androidenterprise#groupLicense". Corresponds to the JSON property kind

Returns:

  • (String)

854
855
856
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 854

def kind
  @kind
end

#num_provisionedFixnum

The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations. Corresponds to the JSON property numProvisioned

Returns:

  • (Fixnum)

860
861
862
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 860

def num_provisioned
  @num_provisioned
end

#num_purchasedFixnum

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 (e.g. if the acquisition kind is "free"). Corresponds to the JSON property numPurchased

Returns:

  • (Fixnum)

867
868
869
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 867

def num_purchased
  @num_purchased
end

#product_idString

The ID of the product that the license is for, e.g. "app:com.google.android.gm" . Corresponds to the JSON property productId

Returns:

  • (String)

873
874
875
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 873

def product_id
  @product_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


880
881
882
883
884
885
886
887
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 880

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)
  @product_id = args[:product_id] if args.key?(:product_id)
end