1{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/sdm.service": {
6 "description": "See and/or control the devices that you selected"
7 }
8 }
9 }
10 },
11 "basePath": "",
12 "baseUrl": "https://smartdevicemanagement.googleapis.com/",
13 "batchPath": "batch",
14 "canonicalName": "Smart Device Management",
15 "description": "Allow select enterprise partners to access, control, and manage Google and Nest devices programmatically.",
16 "discoveryVersion": "v1",
17 "documentationLink": "https://developers.google.com/nest/device-access",
18 "fullyEncodeReservedExpansion": true,
19 "icons": {
20 "x16": "http://www.google.com/images/icons/product/search-16.gif",
21 "x32": "http://www.google.com/images/icons/product/search-32.gif"
22 },
23 "id": "smartdevicemanagement:v1",
24 "kind": "discovery#restDescription",
25 "mtlsRootUrl": "https://smartdevicemanagement.mtls.googleapis.com/",
26 "name": "smartdevicemanagement",
27 "ownerDomain": "google.com",
28 "ownerName": "Google",
29 "parameters": {
30 "$.xgafv": {
31 "description": "V1 error format.",
32 "enum": [
33 "1",
34 "2"
35 ],
36 "enumDescriptions": [
37 "v1 error format",
38 "v2 error format"
39 ],
40 "location": "query",
41 "type": "string"
42 },
43 "access_token": {
44 "description": "OAuth access token.",
45 "location": "query",
46 "type": "string"
47 },
48 "alt": {
49 "default": "json",
50 "description": "Data format for response.",
51 "enum": [
52 "json",
53 "media",
54 "proto"
55 ],
56 "enumDescriptions": [
57 "Responses with Content-Type of application/json",
58 "Media download with context-dependent Content-Type",
59 "Responses with Content-Type of application/x-protobuf"
60 ],
61 "location": "query",
62 "type": "string"
63 },
64 "callback": {
65 "description": "JSONP",
66 "location": "query",
67 "type": "string"
68 },
69 "fields": {
70 "description": "Selector specifying which fields to include in a partial response.",
71 "location": "query",
72 "type": "string"
73 },
74 "key": {
75 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
76 "location": "query",
77 "type": "string"
78 },
79 "oauth_token": {
80 "description": "OAuth 2.0 token for the current user.",
81 "location": "query",
82 "type": "string"
83 },
84 "prettyPrint": {
85 "default": "true",
86 "description": "Returns response with indentations and line breaks.",
87 "location": "query",
88 "type": "boolean"
89 },
90 "quotaUser": {
91 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
92 "location": "query",
93 "type": "string"
94 },
95 "uploadType": {
96 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
97 "location": "query",
98 "type": "string"
99 },
100 "upload_protocol": {
101 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
102 "location": "query",
103 "type": "string"
104 }
105 },
106 "protocol": "rest",
107 "resources": {
108 "enterprises": {
109 "resources": {
110 "devices": {
111 "methods": {
112 "executeCommand": {
113 "description": "Executes a command to device managed by the enterprise.",
114 "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}:executeCommand",
115 "httpMethod": "POST",
116 "id": "smartdevicemanagement.enterprises.devices.executeCommand",
117 "parameterOrder": [
118 "name"
119 ],
120 "parameters": {
121 "name": {
122 "description": "The name of the device requested. For example: \"enterprises/XYZ/devices/123\"",
123 "location": "path",
124 "pattern": "^enterprises/[^/]+/devices/[^/]+$",
125 "required": true,
126 "type": "string"
127 }
128 },
129 "path": "v1/{+name}:executeCommand",
130 "request": {
131 "$ref": "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest"
132 },
133 "response": {
134 "$ref": "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse"
135 },
136 "scopes": [
137 "https://www.googleapis.com/auth/sdm.service"
138 ]
139 },
140 "get": {
141 "description": "Gets a device managed by the enterprise.",
142 "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}",
143 "httpMethod": "GET",
144 "id": "smartdevicemanagement.enterprises.devices.get",
145 "parameterOrder": [
146 "name"
147 ],
148 "parameters": {
149 "name": {
150 "description": "The name of the device requested. For example: \"enterprises/XYZ/devices/123\"",
151 "location": "path",
152 "pattern": "^enterprises/[^/]+/devices/[^/]+$",
153 "required": true,
154 "type": "string"
155 }
156 },
157 "path": "v1/{+name}",
158 "response": {
159 "$ref": "GoogleHomeEnterpriseSdmV1Device"
160 },
161 "scopes": [
162 "https://www.googleapis.com/auth/sdm.service"
163 ]
164 },
165 "list": {
166 "description": "Lists devices managed by the enterprise.",
167 "flatPath": "v1/enterprises/{enterprisesId}/devices",
168 "httpMethod": "GET",
169 "id": "smartdevicemanagement.enterprises.devices.list",
170 "parameterOrder": [
171 "parent"
172 ],
173 "parameters": {
174 "filter": {
175 "description": "Optional filter to list devices. Filters can be done on: Device custom name (substring match): 'customName=wing'",
176 "location": "query",
177 "type": "string"
178 },
179 "parent": {
180 "description": "The parent enterprise to list devices under. E.g. \"enterprises/XYZ\".",
181 "location": "path",
182 "pattern": "^enterprises/[^/]+$",
183 "required": true,
184 "type": "string"
185 }
186 },
187 "path": "v1/{+parent}/devices",
188 "response": {
189 "$ref": "GoogleHomeEnterpriseSdmV1ListDevicesResponse"
190 },
191 "scopes": [
192 "https://www.googleapis.com/auth/sdm.service"
193 ]
194 }
195 }
196 },
197 "structures": {
198 "methods": {
199 "get": {
200 "description": "Gets a structure managed by the enterprise.",
201 "flatPath": "v1/enterprises/{enterprisesId}/structures/{structuresId}",
202 "httpMethod": "GET",
203 "id": "smartdevicemanagement.enterprises.structures.get",
204 "parameterOrder": [
205 "name"
206 ],
207 "parameters": {
208 "name": {
209 "description": "The name of the structure requested. For example: \"enterprises/XYZ/structures/ABC\".",
210 "location": "path",
211 "pattern": "^enterprises/[^/]+/structures/[^/]+$",
212 "required": true,
213 "type": "string"
214 }
215 },
216 "path": "v1/{+name}",
217 "response": {
218 "$ref": "GoogleHomeEnterpriseSdmV1Structure"
219 },
220 "scopes": [
221 "https://www.googleapis.com/auth/sdm.service"
222 ]
223 },
224 "list": {
225 "description": "Lists structures managed by the enterprise.",
226 "flatPath": "v1/enterprises/{enterprisesId}/structures",
227 "httpMethod": "GET",
228 "id": "smartdevicemanagement.enterprises.structures.list",
229 "parameterOrder": [
230 "parent"
231 ],
232 "parameters": {
233 "filter": {
234 "description": "Optional filter to list structures.",
235 "location": "query",
236 "type": "string"
237 },
238 "parent": {
239 "description": "The parent enterprise to list structures under. E.g. \"enterprises/XYZ\".",
240 "location": "path",
241 "pattern": "^enterprises/[^/]+$",
242 "required": true,
243 "type": "string"
244 }
245 },
246 "path": "v1/{+parent}/structures",
247 "response": {
248 "$ref": "GoogleHomeEnterpriseSdmV1ListStructuresResponse"
249 },
250 "scopes": [
251 "https://www.googleapis.com/auth/sdm.service"
252 ]
253 }
254 },
255 "resources": {
256 "rooms": {
257 "methods": {
258 "get": {
259 "description": "Gets a room managed by the enterprise.",
260 "flatPath": "v1/enterprises/{enterprisesId}/structures/{structuresId}/rooms/{roomsId}",
261 "httpMethod": "GET",
262 "id": "smartdevicemanagement.enterprises.structures.rooms.get",
263 "parameterOrder": [
264 "name"
265 ],
266 "parameters": {
267 "name": {
268 "description": "The name of the room requested. For example: \"enterprises/XYZ/structures/ABC/rooms/123\".",
269 "location": "path",
270 "pattern": "^enterprises/[^/]+/structures/[^/]+/rooms/[^/]+$",
271 "required": true,
272 "type": "string"
273 }
274 },
275 "path": "v1/{+name}",
276 "response": {
277 "$ref": "GoogleHomeEnterpriseSdmV1Room"
278 },
279 "scopes": [
280 "https://www.googleapis.com/auth/sdm.service"
281 ]
282 },
283 "list": {
284 "description": "Lists rooms managed by the enterprise.",
285 "flatPath": "v1/enterprises/{enterprisesId}/structures/{structuresId}/rooms",
286 "httpMethod": "GET",
287 "id": "smartdevicemanagement.enterprises.structures.rooms.list",
288 "parameterOrder": [
289 "parent"
290 ],
291 "parameters": {
292 "parent": {
293 "description": "The parent resource name of the rooms requested. For example: \"enterprises/XYZ/structures/ABC\".",
294 "location": "path",
295 "pattern": "^enterprises/[^/]+/structures/[^/]+$",
296 "required": true,
297 "type": "string"
298 }
299 },
300 "path": "v1/{+parent}/rooms",
301 "response": {
302 "$ref": "GoogleHomeEnterpriseSdmV1ListRoomsResponse"
303 },
304 "scopes": [
305 "https://www.googleapis.com/auth/sdm.service"
306 ]
307 }
308 }
309 }
310 }
311 }
312 }
313 }
314 },
315 "revision": "20231119",
316 "rootUrl": "https://smartdevicemanagement.googleapis.com/",
317 "schemas": {
318 "GoogleHomeEnterpriseSdmV1Device": {
319 "description": "Device resource represents an instance of enterprise managed device in the property.",
320 "id": "GoogleHomeEnterpriseSdmV1Device",
321 "properties": {
322 "name": {
323 "description": "Required. The resource name of the device. For example: \"enterprises/XYZ/devices/123\".",
324 "type": "string"
325 },
326 "parentRelations": {
327 "description": "Assignee details of the device.",
328 "items": {
329 "$ref": "GoogleHomeEnterpriseSdmV1ParentRelation"
330 },
331 "type": "array"
332 },
333 "traits": {
334 "additionalProperties": {
335 "description": "Properties of the object.",
336 "type": "any"
337 },
338 "description": "Output only. Device traits.",
339 "readOnly": true,
340 "type": "object"
341 },
342 "type": {
343 "description": "Output only. Type of the device for general display purposes. For example: \"THERMOSTAT\". The device type should not be used to deduce or infer functionality of the actual device it is assigned to. Instead, use the returned traits for the device.",
344 "readOnly": true,
345 "type": "string"
346 }
347 },
348 "type": "object"
349 },
350 "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest": {
351 "description": "Request message for SmartDeviceManagementService.ExecuteDeviceCommand",
352 "id": "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest",
353 "properties": {
354 "command": {
355 "description": "The command name to execute, represented by the fully qualified protobuf message name.",
356 "type": "string"
357 },
358 "params": {
359 "additionalProperties": {
360 "description": "Properties of the object.",
361 "type": "any"
362 },
363 "description": "The command message to execute, represented as a Struct.",
364 "type": "object"
365 }
366 },
367 "type": "object"
368 },
369 "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse": {
370 "description": "Response message for SmartDeviceManagementService.ExecuteDeviceCommand",
371 "id": "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse",
372 "properties": {
373 "results": {
374 "additionalProperties": {
375 "description": "Properties of the object.",
376 "type": "any"
377 },
378 "description": "The results of executing the command.",
379 "type": "object"
380 }
381 },
382 "type": "object"
383 },
384 "GoogleHomeEnterpriseSdmV1ListDevicesResponse": {
385 "description": "Response message for SmartDeviceManagementService.ListDevices",
386 "id": "GoogleHomeEnterpriseSdmV1ListDevicesResponse",
387 "properties": {
388 "devices": {
389 "description": "The list of devices.",
390 "items": {
391 "$ref": "GoogleHomeEnterpriseSdmV1Device"
392 },
393 "type": "array"
394 }
395 },
396 "type": "object"
397 },
398 "GoogleHomeEnterpriseSdmV1ListRoomsResponse": {
399 "description": "Response message for SmartDeviceManagementService.ListRooms",
400 "id": "GoogleHomeEnterpriseSdmV1ListRoomsResponse",
401 "properties": {
402 "rooms": {
403 "description": "The list of rooms.",
404 "items": {
405 "$ref": "GoogleHomeEnterpriseSdmV1Room"
406 },
407 "type": "array"
408 }
409 },
410 "type": "object"
411 },
412 "GoogleHomeEnterpriseSdmV1ListStructuresResponse": {
413 "description": "Response message for SmartDeviceManagementService.ListStructures",
414 "id": "GoogleHomeEnterpriseSdmV1ListStructuresResponse",
415 "properties": {
416 "structures": {
417 "description": "The list of structures.",
418 "items": {
419 "$ref": "GoogleHomeEnterpriseSdmV1Structure"
420 },
421 "type": "array"
422 }
423 },
424 "type": "object"
425 },
426 "GoogleHomeEnterpriseSdmV1ParentRelation": {
427 "description": "Represents device relationships, for instance, structure/room to which the device is assigned to.",
428 "id": "GoogleHomeEnterpriseSdmV1ParentRelation",
429 "properties": {
430 "displayName": {
431 "description": "Output only. The custom name of the relation -- e.g., structure/room where the device is assigned to.",
432 "readOnly": true,
433 "type": "string"
434 },
435 "parent": {
436 "description": "Output only. The name of the relation -- e.g., structure/room where the device is assigned to. For example: \"enterprises/XYZ/structures/ABC\" or \"enterprises/XYZ/structures/ABC/rooms/123\"",
437 "readOnly": true,
438 "type": "string"
439 }
440 },
441 "type": "object"
442 },
443 "GoogleHomeEnterpriseSdmV1Room": {
444 "description": "Room resource represents an instance of sub-space within a structure such as rooms in a hotel suite or rental apartment.",
445 "id": "GoogleHomeEnterpriseSdmV1Room",
446 "properties": {
447 "name": {
448 "description": "Output only. The resource name of the room. For example: \"enterprises/XYZ/structures/ABC/rooms/123\".",
449 "readOnly": true,
450 "type": "string"
451 },
452 "traits": {
453 "additionalProperties": {
454 "description": "Properties of the object.",
455 "type": "any"
456 },
457 "description": "Room traits.",
458 "type": "object"
459 }
460 },
461 "type": "object"
462 },
463 "GoogleHomeEnterpriseSdmV1Structure": {
464 "description": "Structure resource represents an instance of enterprise managed home or hotel room.",
465 "id": "GoogleHomeEnterpriseSdmV1Structure",
466 "properties": {
467 "name": {
468 "description": "Output only. The resource name of the structure. For example: \"enterprises/XYZ/structures/ABC\".",
469 "readOnly": true,
470 "type": "string"
471 },
472 "traits": {
473 "additionalProperties": {
474 "description": "Properties of the object.",
475 "type": "any"
476 },
477 "description": "Structure traits.",
478 "type": "object"
479 }
480 },
481 "type": "object"
482 }
483 },
484 "servicePath": "",
485 "title": "Smart Device Management API",
486 "version": "v1",
487 "version_module": true
488}View as plain text