Class: Google::Apis::AndroidenterpriseV1::Collection

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 collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user. Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.

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) ⇒ Collection

Returns a new instance of Collection.


423
424
425
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 423

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

Instance Attribute Details

#collection_idString

Arbitrary unique ID, allocated by the API on creation. Corresponds to the JSON property collectionId

Returns:

  • (String)

393
394
395
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 393

def collection_id
  @collection_id
end

#kindString

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

Returns:

  • (String)

399
400
401
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 399

def kind
  @kind
end

#nameString

A user-friendly name for the collection (should be unique), e.g. "Accounting apps". Corresponds to the JSON property name

Returns:

  • (String)

405
406
407
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 405

def name
  @name
end

#product_idArray<String>

The IDs of the products in the collection, in the order in which they should be displayed. Corresponds to the JSON property productId

Returns:

  • (Array<String>)

411
412
413
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 411

def product_id
  @product_id
end

#visibilityString

Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to " viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain. The "allUsers" setting is deprecated, and will be removed. Corresponds to the JSON property visibility

Returns:

  • (String)

421
422
423
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 421

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


428
429
430
431
432
433
434
# File 'generated/google/apis/androidenterprise_v1/classes.rb', line 428

def update!(**args)
  @collection_id = args[:collection_id] if args.key?(:collection_id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @product_id = args[:product_id] if args.key?(:product_id)
  @visibility = args[:visibility] if args.key?(:visibility)
end