| Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 75 | <h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.installs.html">installs</a></h1> |
| Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#delete">delete(enterpriseId, userId, deviceId, installId)</a></code></p> |
| 79 | <p class="firstline">Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#get">get(enterpriseId, userId, deviceId, installId)</a></code></p> |
| 82 | <p class="firstline">Retrieves details of an installation of an app on a device.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list">list(enterpriseId, userId, deviceId)</a></code></p> |
| 85 | <p class="firstline">Retrieves the details of all apps installed on the specified device.</p> |
| 86 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 87 | <code><a href="#update">update(enterpriseId, userId, deviceId, installId, body=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 88 | <p class="firstline">Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary.</p> |
| Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="delete">delete(enterpriseId, userId, deviceId, installId)</code> |
| 92 | <pre>Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed. |
| 93 | |
| 94 | Args: |
| 95 | enterpriseId: string, The ID of the enterprise. (required) |
| 96 | userId: string, The ID of the user. (required) |
| 97 | deviceId: string, The Android ID of the device. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 98 | installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required) |
| Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 99 | </pre> |
| 100 | </div> |
| 101 | |
| 102 | <div class="method"> |
| 103 | <code class="details" id="get">get(enterpriseId, userId, deviceId, installId)</code> |
| 104 | <pre>Retrieves details of an installation of an app on a device. |
| 105 | |
| 106 | Args: |
| 107 | enterpriseId: string, The ID of the enterprise. (required) |
| 108 | userId: string, The ID of the user. (required) |
| 109 | deviceId: string, The Android ID of the device. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 110 | installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required) |
| Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 111 | |
| 112 | Returns: |
| 113 | An object of the form: |
| 114 | |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 115 | { # The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 116 | # |
| 117 | # 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. |
| 118 | # |
| 119 | # 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. |
| 120 | # |
| 121 | # Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. |
| 122 | # |
| 123 | # 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. |
| 124 | # |
| 125 | # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 126 | "installState": "A 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. |
| 127 | "kind": "androidenterprise#install", |
| 128 | "productId": "A String", # The ID of the product that the install is for. For example, "app:com.google.android.gm". |
| 129 | "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed". |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 130 | }</pre> |
| Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 131 | </div> |
| 132 | |
| 133 | <div class="method"> |
| 134 | <code class="details" id="list">list(enterpriseId, userId, deviceId)</code> |
| 135 | <pre>Retrieves the details of all apps installed on the specified device. |
| 136 | |
| 137 | Args: |
| 138 | enterpriseId: string, The ID of the enterprise. (required) |
| 139 | userId: string, The ID of the user. (required) |
| 140 | deviceId: string, The Android ID of the device. (required) |
| 141 | |
| 142 | Returns: |
| 143 | An object of the form: |
| 144 | |
| 145 | { # The install resources for the device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 146 | "install": [ # An installation of an app for a user on a specific device. The existence of an install implies that the user must have an entitlement to the app. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 147 | { # The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 148 | # |
| 149 | # 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. |
| 150 | # |
| 151 | # 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. |
| 152 | # |
| 153 | # Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. |
| 154 | # |
| 155 | # 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. |
| 156 | # |
| 157 | # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 158 | "installState": "A 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. |
| 159 | "kind": "androidenterprise#install", |
| 160 | "productId": "A String", # The ID of the product that the install is for. For example, "app:com.google.android.gm". |
| 161 | "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed". |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 162 | }, |
| Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 163 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 164 | "kind": "androidenterprise#installsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#installsListResponse". |
| Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 165 | }</pre> |
| 166 | </div> |
| 167 | |
| 168 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 169 | <code class="details" id="update">update(enterpriseId, userId, deviceId, installId, body=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 170 | <pre>Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary. |
| Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 171 | |
| 172 | Args: |
| 173 | enterpriseId: string, The ID of the enterprise. (required) |
| 174 | userId: string, The ID of the user. (required) |
| 175 | deviceId: string, The Android ID of the device. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 176 | installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 177 | body: object, The request body. |
| Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 178 | The object takes the form of: |
| 179 | |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 180 | { # The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 181 | # |
| 182 | # 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. |
| 183 | # |
| 184 | # 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. |
| 185 | # |
| 186 | # Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. |
| 187 | # |
| 188 | # 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. |
| 189 | # |
| 190 | # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 191 | "installState": "A 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. |
| 192 | "kind": "androidenterprise#install", |
| 193 | "productId": "A String", # The ID of the product that the install is for. For example, "app:com.google.android.gm". |
| 194 | "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed". |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 195 | } |
| Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 196 | |
| 197 | |
| 198 | Returns: |
| 199 | An object of the form: |
| 200 | |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 201 | { # The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 202 | # |
| 203 | # 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. |
| 204 | # |
| 205 | # 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. |
| 206 | # |
| 207 | # Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. |
| 208 | # |
| 209 | # 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. |
| 210 | # |
| 211 | # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 212 | "installState": "A 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. |
| 213 | "kind": "androidenterprise#install", |
| 214 | "productId": "A String", # The ID of the product that the install is for. For example, "app:com.google.android.gm". |
| 215 | "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed". |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 216 | }</pre> |
| Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 217 | </div> |
| 218 | |
| 219 | </body></html> |