• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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
75<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.managedconfigurationsfordevice.html">managedconfigurationsfordevice</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(enterpriseId, userId, deviceId, managedConfigurationForDeviceId)</a></code></p>
79<p class="firstline">Removes a per-device managed configuration for an app for the specified device.</p>
80<p class="toc_element">
81  <code><a href="#get">get(enterpriseId, userId, deviceId, managedConfigurationForDeviceId)</a></code></p>
82<p class="firstline">Retrieves details of a per-device managed configuration.</p>
83<p class="toc_element">
84  <code><a href="#list">list(enterpriseId, userId, deviceId)</a></code></p>
85<p class="firstline">Lists all the per-device managed configurations for the specified device. Only the ID is set.</p>
86<p class="toc_element">
87  <code><a href="#patch">patch(enterpriseId, userId, deviceId, managedConfigurationForDeviceId, body)</a></code></p>
88<p class="firstline">Adds or updates a per-device managed configuration for an app for the specified device. This method supports patch semantics.</p>
89<p class="toc_element">
90  <code><a href="#update">update(enterpriseId, userId, deviceId, managedConfigurationForDeviceId, body)</a></code></p>
91<p class="firstline">Adds or updates a per-device managed configuration for an app for the specified device.</p>
92<h3>Method Details</h3>
93<div class="method">
94    <code class="details" id="delete">delete(enterpriseId, userId, deviceId, managedConfigurationForDeviceId)</code>
95  <pre>Removes a per-device managed configuration for an app for the specified device.
96
97Args:
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  managedConfigurationForDeviceId: string, The ID of the managed configuration (a product ID), 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, managedConfigurationForDeviceId)</code>
107  <pre>Retrieves details of a per-device managed configuration.
108
109Args:
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  managedConfigurationForDeviceId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)
114
115Returns:
116  An object of the form:
117
118    { # 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.
119    "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
120    "configurationVariables": { # 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. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
121      "kind": "androidenterprise#configurationVariables", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables".
122      "variableSet": [ # The variable set that is attributed to the user.
123        { # 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.
124          "userValue": "A String", # The value of the placeholder, specific to the user.
125          "kind": "androidenterprise#variableSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet".
126          "placeholder": "A String", # The placeholder string; defined by EMM.
127        },
128      ],
129      "mcmId": "A String", # The ID of the managed configurations settings.
130    },
131    "managedProperty": [ # The set of managed properties for this configuration.
132      { # 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.
133        "key": "A String", # The unique key that identifies the property.
134        "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
135        "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
136          "A String",
137        ],
138        "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
139        "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
140          { # A bundle of managed properties.
141            "managedProperty": [ # The list of managed properties.
142              # Object with schema name: ManagedProperty
143            ],
144          },
145        ],
146        "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
147          "managedProperty": [ # The list of managed properties.
148            # Object with schema name: ManagedProperty
149          ],
150        },
151        "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
152      },
153    ],
154    "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
155  }</pre>
156</div>
157
158<div class="method">
159    <code class="details" id="list">list(enterpriseId, userId, deviceId)</code>
160  <pre>Lists all the per-device managed configurations for the specified device. Only the ID is set.
161
162Args:
163  enterpriseId: string, The ID of the enterprise. (required)
164  userId: string, The ID of the user. (required)
165  deviceId: string, The Android ID of the device. (required)
166
167Returns:
168  An object of the form:
169
170    { # The managed configuration resources for the device.
171    "kind": "androidenterprise#managedConfigurationsForDeviceListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsForDeviceListResponse".
172    "managedConfigurationForDevice": [ # A managed configuration for an app on a specific device.
173      { # 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.
174        "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
175        "configurationVariables": { # 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. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
176          "kind": "androidenterprise#configurationVariables", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables".
177          "variableSet": [ # The variable set that is attributed to the user.
178            { # 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.
179              "userValue": "A String", # The value of the placeholder, specific to the user.
180              "kind": "androidenterprise#variableSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet".
181              "placeholder": "A String", # The placeholder string; defined by EMM.
182            },
183          ],
184          "mcmId": "A String", # The ID of the managed configurations settings.
185        },
186        "managedProperty": [ # The set of managed properties for this configuration.
187          { # 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.
188            "key": "A String", # The unique key that identifies the property.
189            "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
190            "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
191              "A String",
192            ],
193            "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
194            "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
195              { # A bundle of managed properties.
196                "managedProperty": [ # The list of managed properties.
197                  # Object with schema name: ManagedProperty
198                ],
199              },
200            ],
201            "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
202              "managedProperty": [ # The list of managed properties.
203                # Object with schema name: ManagedProperty
204              ],
205            },
206            "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
207          },
208        ],
209        "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
210      },
211    ],
212  }</pre>
213</div>
214
215<div class="method">
216    <code class="details" id="patch">patch(enterpriseId, userId, deviceId, managedConfigurationForDeviceId, body)</code>
217  <pre>Adds or updates a per-device managed configuration for an app for the specified device. This method supports patch semantics.
218
219Args:
220  enterpriseId: string, The ID of the enterprise. (required)
221  userId: string, The ID of the user. (required)
222  deviceId: string, The Android ID of the device. (required)
223  managedConfigurationForDeviceId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)
224  body: object, The request body. (required)
225    The object takes the form of:
226
227{ # 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.
228  "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
229  "configurationVariables": { # 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. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
230    "kind": "androidenterprise#configurationVariables", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables".
231    "variableSet": [ # The variable set that is attributed to the user.
232      { # 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.
233        "userValue": "A String", # The value of the placeholder, specific to the user.
234        "kind": "androidenterprise#variableSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet".
235        "placeholder": "A String", # The placeholder string; defined by EMM.
236      },
237    ],
238    "mcmId": "A String", # The ID of the managed configurations settings.
239  },
240  "managedProperty": [ # The set of managed properties for this configuration.
241    { # 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.
242      "key": "A String", # The unique key that identifies the property.
243      "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
244      "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
245        "A String",
246      ],
247      "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
248      "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
249        { # A bundle of managed properties.
250          "managedProperty": [ # The list of managed properties.
251            # Object with schema name: ManagedProperty
252          ],
253        },
254      ],
255      "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
256        "managedProperty": [ # The list of managed properties.
257          # Object with schema name: ManagedProperty
258        ],
259      },
260      "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
261    },
262  ],
263  "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
264}
265
266
267Returns:
268  An object of the form:
269
270    { # 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.
271    "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
272    "configurationVariables": { # 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. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
273      "kind": "androidenterprise#configurationVariables", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables".
274      "variableSet": [ # The variable set that is attributed to the user.
275        { # 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.
276          "userValue": "A String", # The value of the placeholder, specific to the user.
277          "kind": "androidenterprise#variableSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet".
278          "placeholder": "A String", # The placeholder string; defined by EMM.
279        },
280      ],
281      "mcmId": "A String", # The ID of the managed configurations settings.
282    },
283    "managedProperty": [ # The set of managed properties for this configuration.
284      { # 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.
285        "key": "A String", # The unique key that identifies the property.
286        "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
287        "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
288          "A String",
289        ],
290        "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
291        "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
292          { # A bundle of managed properties.
293            "managedProperty": [ # The list of managed properties.
294              # Object with schema name: ManagedProperty
295            ],
296          },
297        ],
298        "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
299          "managedProperty": [ # The list of managed properties.
300            # Object with schema name: ManagedProperty
301          ],
302        },
303        "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
304      },
305    ],
306    "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
307  }</pre>
308</div>
309
310<div class="method">
311    <code class="details" id="update">update(enterpriseId, userId, deviceId, managedConfigurationForDeviceId, body)</code>
312  <pre>Adds or updates a per-device managed configuration for an app for the specified device.
313
314Args:
315  enterpriseId: string, The ID of the enterprise. (required)
316  userId: string, The ID of the user. (required)
317  deviceId: string, The Android ID of the device. (required)
318  managedConfigurationForDeviceId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)
319  body: object, The request body. (required)
320    The object takes the form of:
321
322{ # 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.
323  "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
324  "configurationVariables": { # 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. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
325    "kind": "androidenterprise#configurationVariables", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables".
326    "variableSet": [ # The variable set that is attributed to the user.
327      { # 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.
328        "userValue": "A String", # The value of the placeholder, specific to the user.
329        "kind": "androidenterprise#variableSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet".
330        "placeholder": "A String", # The placeholder string; defined by EMM.
331      },
332    ],
333    "mcmId": "A String", # The ID of the managed configurations settings.
334  },
335  "managedProperty": [ # The set of managed properties for this configuration.
336    { # 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.
337      "key": "A String", # The unique key that identifies the property.
338      "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
339      "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
340        "A String",
341      ],
342      "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
343      "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
344        { # A bundle of managed properties.
345          "managedProperty": [ # The list of managed properties.
346            # Object with schema name: ManagedProperty
347          ],
348        },
349      ],
350      "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
351        "managedProperty": [ # The list of managed properties.
352          # Object with schema name: ManagedProperty
353        ],
354      },
355      "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
356    },
357  ],
358  "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
359}
360
361
362Returns:
363  An object of the form:
364
365    { # 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.
366    "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
367    "configurationVariables": { # 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. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
368      "kind": "androidenterprise#configurationVariables", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables".
369      "variableSet": [ # The variable set that is attributed to the user.
370        { # 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.
371          "userValue": "A String", # The value of the placeholder, specific to the user.
372          "kind": "androidenterprise#variableSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet".
373          "placeholder": "A String", # The placeholder string; defined by EMM.
374        },
375      ],
376      "mcmId": "A String", # The ID of the managed configurations settings.
377    },
378    "managedProperty": [ # The set of managed properties for this configuration.
379      { # 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.
380        "key": "A String", # The unique key that identifies the property.
381        "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
382        "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
383          "A String",
384        ],
385        "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
386        "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
387          { # A bundle of managed properties.
388            "managedProperty": [ # The list of managed properties.
389              # Object with schema name: ManagedProperty
390            ],
391          },
392        ],
393        "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
394          "managedProperty": [ # The list of managed properties.
395            # Object with schema name: ManagedProperty
396          ],
397        },
398        "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
399      },
400    ],
401    "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
402  }</pre>
403</div>
404
405</body></html>