{ "servicePath": "", "rootUrl": "https://smartdevicemanagement.googleapis.com/", "title": "Smart Device Management API", "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "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.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "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.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "mtlsRootUrl": "https://smartdevicemanagement.mtls.googleapis.com/", "schemas": { "GoogleHomeEnterpriseSdmV1Device": { "id": "GoogleHomeEnterpriseSdmV1Device", "description": "Device resource represents an instance of enterprise managed device in the property.", "type": "object", "properties": { "name": { "description": "Required. The resource name of the device. For example: \"enterprises/XYZ/devices/123\".", "type": "string" }, "type": { "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.", "readOnly": true, "type": "string" }, "traits": { "description": "Output only. Device traits.", "readOnly": true, "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "parentRelations": { "description": "Assignee details of the device.", "type": "array", "items": { "$ref": "GoogleHomeEnterpriseSdmV1ParentRelation" } }, "ghpName": { "description": "Output only. The GHP device ID of the device.", "readOnly": true, "type": "string" } } }, "GoogleHomeEnterpriseSdmV1ParentRelation": { "id": "GoogleHomeEnterpriseSdmV1ParentRelation", "description": "Represents device relationships, for instance, structure/room to which the device is assigned to.", "type": "object", "properties": { "parent": { "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\"", "readOnly": true, "type": "string" }, "displayName": { "description": "Output only. The custom name of the relation -- e.g., structure/room where the device is assigned to.", "readOnly": true, "type": "string" }, "ghpParent": { "description": "Output only. The GHP name of the relation -- e.g., structure/room where the device is assigned to. For example: \"homegraph.googleapis.com/Structure/ABC\" or \"homegraph.googleapis.com/Room/ABC\"", "readOnly": true, "type": "string" } } }, "GoogleHomeEnterpriseSdmV1ListDevicesResponse": { "id": "GoogleHomeEnterpriseSdmV1ListDevicesResponse", "description": "Response message for SmartDeviceManagementService.ListDevices", "type": "object", "properties": { "devices": { "description": "The list of devices.", "type": "array", "items": { "$ref": "GoogleHomeEnterpriseSdmV1Device" } } } }, "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest": { "id": "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest", "description": "Request message for SmartDeviceManagementService.ExecuteDeviceCommand", "type": "object", "properties": { "command": { "description": "The command name to execute, represented by the fully qualified protobuf message name.", "type": "string" }, "params": { "description": "The command message to execute, represented as a Struct.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse": { "id": "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse", "description": "Response message for SmartDeviceManagementService.ExecuteDeviceCommand", "type": "object", "properties": { "results": { "description": "The results of executing the command.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleHomeEnterpriseSdmV1Structure": { "id": "GoogleHomeEnterpriseSdmV1Structure", "description": "Structure resource represents an instance of enterprise managed home or hotel room.", "type": "object", "properties": { "name": { "description": "Output only. The resource name of the structure. For example: \"enterprises/XYZ/structures/ABC\".", "readOnly": true, "type": "string" }, "traits": { "description": "Structure traits.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "ghpName": { "description": "Output only. The unique identifier for the structure in Google Home Platform. Format: homegraph.googleapis.com/Structure/{structure_id}", "readOnly": true, "type": "string" } } }, "GoogleHomeEnterpriseSdmV1ListStructuresResponse": { "id": "GoogleHomeEnterpriseSdmV1ListStructuresResponse", "description": "Response message for SmartDeviceManagementService.ListStructures", "type": "object", "properties": { "structures": { "description": "The list of structures.", "type": "array", "items": { "$ref": "GoogleHomeEnterpriseSdmV1Structure" } } } }, "GoogleHomeEnterpriseSdmV1Room": { "id": "GoogleHomeEnterpriseSdmV1Room", "description": "Room resource represents an instance of sub-space within a structure such as rooms in a hotel suite or rental apartment.", "type": "object", "properties": { "name": { "description": "Output only. The resource name of the room. For example: \"enterprises/XYZ/structures/ABC/rooms/123\".", "readOnly": true, "type": "string" }, "traits": { "description": "Room traits.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleHomeEnterpriseSdmV1ListRoomsResponse": { "id": "GoogleHomeEnterpriseSdmV1ListRoomsResponse", "description": "Response message for SmartDeviceManagementService.ListRooms", "type": "object", "properties": { "rooms": { "description": "The list of rooms.", "type": "array", "items": { "$ref": "GoogleHomeEnterpriseSdmV1Room" } } } } }, "ownerName": "Google", "basePath": "", "discoveryVersion": "v1", "batchPath": "batch", "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/sdm.service": { "description": "See and/or control the devices that you selected" } } } }, "baseUrl": "https://smartdevicemanagement.googleapis.com/", "description": "Allow select enterprise partners to access, control, and manage Google and Nest devices programmatically.", "version_module": true, "fullyEncodeReservedExpansion": true, "canonicalName": "Smart Device Management", "ownerDomain": "google.com", "name": "smartdevicemanagement", "kind": "discovery#restDescription", "revision": "20260301", "version": "v1", "resources": { "enterprises": { "resources": { "devices": { "methods": { "get": { "id": "smartdevicemanagement.enterprises.devices.get", "path": "v1/{+name}", "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the device requested. For example: \"enterprises/XYZ/devices/123\"", "pattern": "^enterprises/[^/]+/devices/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleHomeEnterpriseSdmV1Device" }, "scopes": [ "https://www.googleapis.com/auth/sdm.service" ], "description": "Gets a device managed by the enterprise." }, "list": { "id": "smartdevicemanagement.enterprises.devices.list", "path": "v1/{+parent}/devices", "flatPath": "v1/enterprises/{enterprisesId}/devices", "httpMethod": "GET", "parameters": { "parent": { "description": "The parent enterprise to list devices under. E.g. \"enterprises/XYZ\".", "pattern": "^enterprises/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "Optional filter to list devices. Filters can be done on: Device custom name (substring match): 'customName=wing'", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleHomeEnterpriseSdmV1ListDevicesResponse" }, "scopes": [ "https://www.googleapis.com/auth/sdm.service" ], "description": "Lists devices managed by the enterprise." }, "executeCommand": { "id": "smartdevicemanagement.enterprises.devices.executeCommand", "path": "v1/{+name}:executeCommand", "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}:executeCommand", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the device requested. For example: \"enterprises/XYZ/devices/123\"", "pattern": "^enterprises/[^/]+/devices/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest" }, "response": { "$ref": "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse" }, "scopes": [ "https://www.googleapis.com/auth/sdm.service" ], "description": "Executes a command to device managed by the enterprise." } } }, "structures": { "methods": { "get": { "id": "smartdevicemanagement.enterprises.structures.get", "path": "v1/{+name}", "flatPath": "v1/enterprises/{enterprisesId}/structures/{structuresId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the structure requested. For example: \"enterprises/XYZ/structures/ABC\".", "pattern": "^enterprises/[^/]+/structures/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleHomeEnterpriseSdmV1Structure" }, "scopes": [ "https://www.googleapis.com/auth/sdm.service" ], "description": "Gets a structure managed by the enterprise." }, "list": { "id": "smartdevicemanagement.enterprises.structures.list", "path": "v1/{+parent}/structures", "flatPath": "v1/enterprises/{enterprisesId}/structures", "httpMethod": "GET", "parameters": { "parent": { "description": "The parent enterprise to list structures under. E.g. \"enterprises/XYZ\".", "pattern": "^enterprises/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "Optional filter to list structures.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleHomeEnterpriseSdmV1ListStructuresResponse" }, "scopes": [ "https://www.googleapis.com/auth/sdm.service" ], "description": "Lists structures managed by the enterprise." } }, "resources": { "rooms": { "methods": { "get": { "id": "smartdevicemanagement.enterprises.structures.rooms.get", "path": "v1/{+name}", "flatPath": "v1/enterprises/{enterprisesId}/structures/{structuresId}/rooms/{roomsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the room requested. For example: \"enterprises/XYZ/structures/ABC/rooms/123\".", "pattern": "^enterprises/[^/]+/structures/[^/]+/rooms/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleHomeEnterpriseSdmV1Room" }, "scopes": [ "https://www.googleapis.com/auth/sdm.service" ], "description": "Gets a room managed by the enterprise." }, "list": { "id": "smartdevicemanagement.enterprises.structures.rooms.list", "path": "v1/{+parent}/rooms", "flatPath": "v1/enterprises/{enterprisesId}/structures/{structuresId}/rooms", "httpMethod": "GET", "parameters": { "parent": { "description": "The parent resource name of the rooms requested. For example: \"enterprises/XYZ/structures/ABC\".", "pattern": "^enterprises/[^/]+/structures/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleHomeEnterpriseSdmV1ListRoomsResponse" }, "scopes": [ "https://www.googleapis.com/auth/sdm.service" ], "description": "Lists rooms managed by the enterprise." } } } } } } } }, "id": "smartdevicemanagement:v1", "documentationLink": "https://developers.google.com/nest/device-access" }