RoomInfo Schema

sdm.structures.traits.RoomInfo

This trait belongs to any room for room-related information.

Fields

Field Description Data Type
customName Custom name of the room.

Corresponds to the name in the Google Home App.

 string
Example: "Master Bedroom"

Sample GET request and response

Request

GET /enterprises/project-id/structures/structure-id/rooms/room-id

Response

{
  "name" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "traits" : {
    "sdm.structures.traits.RoomInfo" : {
      "customName" : "Master Bedroom"
    }
  }
}

Commands

There are no commands available for this trait.

Errors

See the API Error Code Reference for the full list of API error codes.