Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / cdf480e8145d58600a5224efc68ba2ace973ef62 / . / docs / dyn / androidenterprise_v1.installs.html
blob: d9734be841b93f3eb61788e0f444a7f72c40545d [file] [log] [blame]
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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 Manista4f877e52015-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 Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#delete">delete(enterpriseId, userId, deviceId, installId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<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>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#get">get(enterpriseId, userId, deviceId, installId, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]85<p class="firstline">Retrieves details of an installation of an app on a device.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#list">list(enterpriseId, userId, deviceId, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]88<p class="firstline">Retrieves the details of all apps installed on the specified device.</p>
89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]90 <code><a href="#update">update(enterpriseId, userId, deviceId, installId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]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>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]99 <code class="details" id="delete">delete(enterpriseId, userId, deviceId, installId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]101
102Args:
103 enterpriseId: string, The ID of the enterprise. (required)
104 userId: string, The ID of the user. (required)
105 deviceId: string, The Android ID of the device. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]106 installId: string, The ID of the product represented by the install, e.g. &quot;app:com.google.android.gm&quot;. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]107 x__xgafv: string, V1 error format.
108 Allowed values
109 1 - v1 error format
110 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]111</pre>
112</div>
113
114<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]115 <code class="details" id="get">get(enterpriseId, userId, deviceId, installId, x__xgafv=None)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]116 <pre>Retrieves details of an installation of an app on a device.
117
118Args:
119 enterpriseId: string, The ID of the enterprise. (required)
120 userId: string, The ID of the user. (required)
121 deviceId: string, The Android ID of the device. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]122 installId: string, The ID of the product represented by the install, e.g. &quot;app:com.google.android.gm&quot;. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]123 x__xgafv: string, V1 error format.
124 Allowed values
125 1 - v1 error format
126 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]127
128Returns:
129 An object of the form:
130
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]131 { # 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]132 &quot;installState&quot;: &quot;A String&quot;, # Install state. The state &quot;installPending&quot; means that an install request has recently been made and download to the device is in progress. The state &quot;installed&quot; means that the app has been installed. This field is read-only.
133 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the install is for. For example, &quot;app:com.google.android.gm&quot;.
134 &quot;versionCode&quot;: 42, # The version of the installed product. Guaranteed to be set only if the install state is &quot;installed&quot;.
135}</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]136</div>
137
138<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]139 <code class="details" id="list">list(enterpriseId, userId, deviceId, x__xgafv=None)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]140 <pre>Retrieves the details of all apps installed on the specified device.
141
142Args:
143 enterpriseId: string, The ID of the enterprise. (required)
144 userId: string, The ID of the user. (required)
145 deviceId: string, The Android ID of the device. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]146 x__xgafv: string, V1 error format.
147 Allowed values
148 1 - v1 error format
149 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]150
151Returns:
152 An object of the form:
153
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]154 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]155 &quot;install&quot;: [ # 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.
156 { # 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.
157 &quot;installState&quot;: &quot;A String&quot;, # Install state. The state &quot;installPending&quot; means that an install request has recently been made and download to the device is in progress. The state &quot;installed&quot; means that the app has been installed. This field is read-only.
158 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the install is for. For example, &quot;app:com.google.android.gm&quot;.
159 &quot;versionCode&quot;: 42, # The version of the installed product. Guaranteed to be set only if the install state is &quot;installed&quot;.
160 },
161 ],
162}</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]163</div>
164
165<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]166 <code class="details" id="update">update(enterpriseId, userId, deviceId, installId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]167 <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 Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]168
169Args:
170 enterpriseId: string, The ID of the enterprise. (required)
171 userId: string, The ID of the user. (required)
172 deviceId: string, The Android ID of the device. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]173 installId: string, The ID of the product represented by the install, e.g. &quot;app:com.google.android.gm&quot;. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]174 body: object, The request body.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]175 The object takes the form of:
176
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]177{ # 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]178 &quot;installState&quot;: &quot;A String&quot;, # Install state. The state &quot;installPending&quot; means that an install request has recently been made and download to the device is in progress. The state &quot;installed&quot; means that the app has been installed. This field is read-only.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]179 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the install is for. For example, &quot;app:com.google.android.gm&quot;.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]180 &quot;versionCode&quot;: 42, # The version of the installed product. Guaranteed to be set only if the install state is &quot;installed&quot;.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]181}
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]182
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]183 x__xgafv: string, V1 error format.
184 Allowed values
185 1 - v1 error format
186 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]187
188Returns:
189 An object of the form:
190
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]191 { # 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]192 &quot;installState&quot;: &quot;A String&quot;, # Install state. The state &quot;installPending&quot; means that an install request has recently been made and download to the device is in progress. The state &quot;installed&quot; means that the app has been installed. This field is read-only.
193 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the install is for. For example, &quot;app:com.google.android.gm&quot;.
194 &quot;versionCode&quot;: 42, # The version of the installed product. Guaranteed to be set only if the install state is &quot;installed&quot;.
195}</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]196</div>
197
198</body></html>