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 75 <h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.installs.html">installs</a></h1> 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"> 87 <code><a href="#patch">patch(enterpriseId, userId, deviceId, installId, body)</a></code></p> 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. This method supports patch semantics.</p> 89 <p class="toc_element"> 90 <code><a href="#update">update(enterpriseId, userId, deviceId, installId, body)</a></code></p> 91 <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> 92 <h3>Method Details</h3> 93 <div class="method"> 94 <code class="details" id="delete">delete(enterpriseId, userId, deviceId, installId)</code> 95 <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. 96 97 Args: 98 enterpriseId: string, The ID of the enterprise. (required) 99 userId: string, The ID of the user. (required) 100 deviceId: string, The Android ID of the device. (required) 101 installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required) 102 </pre> 103 </div> 104 105 <div class="method"> 106 <code class="details" id="get">get(enterpriseId, userId, deviceId, installId)</code> 107 <pre>Retrieves details of an installation of an app on a device. 108 109 Args: 110 enterpriseId: string, The ID of the enterprise. (required) 111 userId: string, The ID of the user. (required) 112 deviceId: string, The Android ID of the device. (required) 113 installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required) 114 115 Returns: 116 An object of the form: 117 118 { # The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). 119 # 120 # 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. 121 # 122 # The API can also be used to update an installed app. If theupdatemethod is used on an existing install, then the app will be updated to the latest available version. 123 # 124 # Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. 125 # 126 # 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. 127 # 128 # 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. 129 "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. 130 "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed". 131 "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install". 132 "productId": "A String", # The ID of the product that the install is for. For example, "app:com.google.android.gm". 133 }</pre> 134 </div> 135 136 <div class="method"> 137 <code class="details" id="list">list(enterpriseId, userId, deviceId)</code> 138 <pre>Retrieves the details of all apps installed on the specified device. 139 140 Args: 141 enterpriseId: string, The ID of the enterprise. (required) 142 userId: string, The ID of the user. (required) 143 deviceId: string, The Android ID of the device. (required) 144 145 Returns: 146 An object of the form: 147 148 { # The install resources for the device. 149 "kind": "androidenterprise#installsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#installsListResponse". 150 "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. 151 { # The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). 152 # 153 # 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. 154 # 155 # The API can also be used to update an installed app. If theupdatemethod is used on an existing install, then the app will be updated to the latest available version. 156 # 157 # Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. 158 # 159 # 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. 160 # 161 # 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. 162 "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. 163 "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed". 164 "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install". 165 "productId": "A String", # The ID of the product that the install is for. For example, "app:com.google.android.gm". 166 }, 167 ], 168 }</pre> 169 </div> 170 171 <div class="method"> 172 <code class="details" id="patch">patch(enterpriseId, userId, deviceId, installId, body)</code> 173 <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. This method supports patch semantics. 174 175 Args: 176 enterpriseId: string, The ID of the enterprise. (required) 177 userId: string, The ID of the user. (required) 178 deviceId: string, The Android ID of the device. (required) 179 installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required) 180 body: object, The request body. (required) 181 The object takes the form of: 182 183 { # The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). 184 # 185 # 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. 186 # 187 # The API can also be used to update an installed app. If theupdatemethod is used on an existing install, then the app will be updated to the latest available version. 188 # 189 # Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. 190 # 191 # 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. 192 # 193 # 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. 194 "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. 195 "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed". 196 "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install". 197 "productId": "A String", # The ID of the product that the install is for. For example, "app:com.google.android.gm". 198 } 199 200 201 Returns: 202 An object of the form: 203 204 { # The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). 205 # 206 # 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. 207 # 208 # The API can also be used to update an installed app. If theupdatemethod is used on an existing install, then the app will be updated to the latest available version. 209 # 210 # Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. 211 # 212 # 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. 213 # 214 # 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. 215 "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. 216 "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed". 217 "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install". 218 "productId": "A String", # The ID of the product that the install is for. For example, "app:com.google.android.gm". 219 }</pre> 220 </div> 221 222 <div class="method"> 223 <code class="details" id="update">update(enterpriseId, userId, deviceId, installId, body)</code> 224 <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. 225 226 Args: 227 enterpriseId: string, The ID of the enterprise. (required) 228 userId: string, The ID of the user. (required) 229 deviceId: string, The Android ID of the device. (required) 230 installId: string, The ID of the product represented by the install, e.g. "app:com.google.android.gm". (required) 231 body: object, The request body. (required) 232 The object takes the form of: 233 234 { # The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). 235 # 236 # 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. 237 # 238 # The API can also be used to update an installed app. If theupdatemethod is used on an existing install, then the app will be updated to the latest available version. 239 # 240 # Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. 241 # 242 # 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. 243 # 244 # 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. 245 "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. 246 "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed". 247 "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install". 248 "productId": "A String", # The ID of the product that the install is for. For example, "app:com.google.android.gm". 249 } 250 251 252 Returns: 253 An object of the form: 254 255 { # The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). 256 # 257 # 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. 258 # 259 # The API can also be used to update an installed app. If theupdatemethod is used on an existing install, then the app will be updated to the latest available version. 260 # 261 # Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. 262 # 263 # 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. 264 # 265 # 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. 266 "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. 267 "versionCode": 42, # The version of the installed product. Guaranteed to be set only if the install state is "installed". 268 "kind": "androidenterprise#install", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install". 269 "productId": "A String", # The ID of the product that the install is for. For example, "app:com.google.android.gm". 270 }</pre> 271 </div> 272 273 </body></html>
