List
|
|||||
|
|
||||
Retrieves the details of all apps installed on the specified device
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage corporate Android devices
Input
This building block consumes 3 input parameters
| Name | Format | Description |
|---|---|---|
enterpriseId Required |
STRING |
The ID of the enterprise |
userId Required |
STRING |
The ID of the user |
deviceId Required |
STRING |
The Android ID of the device |
= Parameter name
= Format
|
enterpriseId STRING Required The ID of the enterprise |
|
userId STRING Required The ID of the user |
|
deviceId STRING Required The Android ID of the device |
Output
This building block provides 6 output parameters
| Name | Format | Description |
|---|---|---|
install[] |
OBJECT |
The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app, then an attempt is made to create one. If this fails (for example, because the app is not free and there is no available license), then the creation of the install fails. The API can also be used to update an installed app. If the update method is used on an existing install, then the app will be updated to the latest available version. Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created. The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves |
install[].installState |
STRING |
Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only |
install[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install" |
install[].productId |
STRING |
The ID of the product that the install is for. For example, "app:com.google.android.gm" |
install[].versionCode |
INTEGER |
The version of the installed product. Guaranteed to be set only if the install state is "installed" |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#installsListResponse" |
= Parameter name
= Format
|
install[] OBJECT The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app, then an attempt is made to create one. If this fails (for example, because the app is not free and there is no available license), then the creation of the install fails. The API can also be used to update an installed app. If the update method is used on an existing install, then the app will be updated to the latest available version. Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created. The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves |
|
install[].installState STRING Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only |
|
install[].kind STRING Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install" |
|
install[].productId STRING The ID of the product that the install is for. For example, "app:com.google.android.gm" |
|
install[].versionCode INTEGER The version of the installed product. Guaranteed to be set only if the install state is "installed" |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "androidenterprise#installsListResponse" |