google_api_android_enterprise v0.8.0 API Reference
Modules
API calls for all endpoints tagged Devices
.
API calls for all endpoints tagged Enterprises
.
API calls for all endpoints tagged Entitlements
.
API calls for all endpoints tagged Grouplicenses
.
API calls for all endpoints tagged Grouplicenseusers
.
API calls for all endpoints tagged Installs
.
API calls for all endpoints tagged Managedconfigurationsfordevice
.
API calls for all endpoints tagged Managedconfigurationsforuser
.
API calls for all endpoints tagged Managedconfigurationssettings
.
API calls for all endpoints tagged Permissions
.
API calls for all endpoints tagged Products
.
API calls for all endpoints tagged Serviceaccountkeys
.
API calls for all endpoints tagged Storelayoutclusters
.
API calls for all endpoints tagged Storelayoutpages
.
API calls for all endpoints tagged Users
.
API calls for all endpoints tagged Webapps
.
Handle Tesla connections for GoogleApi.AndroidEnterprise.V1.
This represents an enterprise admin who can manage the enterprise in the managed Google Play store.
A token authorizing an admin to access an iframe.
Specification for a token used to generate iframes. The token specifies what data the admin is allowed to modify and the URI the iframe is allowed to communiate with.
Represents the list of app restrictions available to be pre-configured for the product.
An event generated when a new app version is uploaded to Google Play and its app restrictions schema changed. To fetch the app restrictions schema for an app, use Products.getAppRestrictionsSchema on the EMM API.
A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied.
A typed value for the restriction.
List of states set by the app.
An event generated when a new version of an app is uploaded to Google Play. Notifications are sent for new public versions only: alpha, beta, or canary versions do not generate this event. To fetch up-to-date version history for an app, use Products.Get on the EMM API.
This represents a single version of the app.
Information on an approval URL.
An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device.
The auto-install constraint. Defines a set of restrictions for installation. At least one of the fields must be set.
Attributes
autoInstallConstraint
(type:list(GoogleApi.AndroidEnterprise.V1.Model.AutoInstallConstraint.t)
, default:nil
) - The constraints for auto-installing the app. You can specify a maximum of one constraint.autoInstallMode
(type:String.t
, default:nil
) - The auto-install mode. If unset defaults to "doNotAutoInstall".autoInstallPriority
(type:integer()
, default:nil
) - The priority of the install, as an unsigned integer. A lower number means higher priority.minimumVersionCode
(type:integer()
, default:nil
) - The minimum version of the app. If a lower version of the app is installed, then the app will be auto-updated according to the auto-install constraints, instead of waiting for the regular auto-update.
A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings.
A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.
Device report updated with the latest app states for managed apps on the device.
An event generated when an updated device report is available.
The state of a user's device, as accessed by the getState and setState methods on device resources.
The device resources for the user.
An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows:
A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
The matching enterprise resources.
The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device.
The entitlement resources for the user.
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.
The user resources for the group license.
The grouplicense resources for the enterprise.
The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending).
An event generated when an app installation failed on a device
The install resources for the device.
Represents a keyed app state containing a key, timestamp, severity level, optional description, and optional data.
A localized string with its locale.
Maintenance window for managed Google Play Accounts. This allows Play store to update the apps on the foreground in the designated window.
A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user.
The managed configuration resources for the device.
The managed configuration resources for the user.
A managed configurations settings resource contains the set of managed properties that have been configured for an Android app to be applied to a set of users. The app's developer would have defined configurable properties in the managed configurations schema.
The managed configurations settings for a product.
A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
A bundle of managed properties.
An event generated when a new device is ready to be managed.
An event generated when new permissions are added to an app.
A notification of one event relating to an enterprise.
A resource returned by the PullNotificationSet API, which contains a collection of notifications for enterprises associated with the service account authenticated for the request.
A Permissions resource represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created.
The device policy for a given managed device.
A Products resource represents an app in the Google Play store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.)
An event generated when a product's approval status is changed.
An event generated whenever a product's availability changes.
A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin.
Information about the permissions required by a specific app and whether they have been accepted by the enterprise.
The policy for a product.
A set of products.
Attributes
certificateHashSha1
(type:String.t
, default:nil
) - The base64 urlsafe encoded SHA1 hash of the certificate. (This field is deprecated in favor of SHA2-256. It should not be used and may be removed at any time.)certificateHashSha256
(type:String.t
, default:nil
) - The base64 urlsafe encoded SHA2-256 hash of the certificate.
A product to be made visible to a user.
Attributes
approvalUrlInfo
(type:GoogleApi.AndroidEnterprise.V1.Model.ApprovalUrlInfo.t
, default:nil
) - The approval URL that was shown to the user. Only the permissions shown to the user with that URL will be accepted, which may not be the product's entire set of permissions. For example, the URL may only display new permissions from an update after the product was approved, or not include new permissions if the product was updated since the URL was generated.approvedPermissions
(type:String.t
, default:nil
) - Sets how new permission requests for the product are handled. "allPermissions" automatically approves all current and future permissions for the product. "currentPermissionsOnly" approves the current set of permissions for the product, but any future permissions added through updates will require manual reapproval. If not specified, only the current set of permissions will be approved.
Attributes
url
(type:String.t
, default:nil
) - A URL that can be rendered in an iframe to display the permissions (if any) of a product. This URL can be used to approve the product only once and only within 24 hours of being generated, using the Products.approve call. If the product is currently unapproved and has no permissions, this URL will point to an empty page. If the product is currently approved, a URL will only be generated if that product has added permissions since it was last approved, and the URL will only display those new permissions that have not yet been accepted.
The matching products.
A service account identity, including the name and credentials that can be used to authenticate as the service account.
Credentials that can be used to authenticate as a service account.
A resource returned by the GenerateSignupUrl API, which contains the Signup URL and Completion Token.
Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
General setting for the managed Google Play store layout, currently only specifying the page to display the first time the store is opened.
The store page resources for the enterprise.
The store page resources for the enterprise.
Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
Id to name association of a track.
A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
A UserToken is used by a user when setting up a managed device or profile with their managed Google Play account on a device. When the user enters their email address and token (activation code) the appropriate EMM app can be automatically downloaded.
The matching user resources.
A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a '$' sign and should be alphanumeric only.
A WebApps resource represents a web app created for an enterprise. Web apps are published to managed Google Play and can be distributed like other Android apps. On a user's device, a web app opens its specified URL.
Icon for a web app.
The web app details for an enterprise.