Stay organized with collections
Save and categorize content based on your preferences.
RoomInfo Schema
sdm.structures.traits.RoomInfo
This trait belongs to any room for room-related information.
Fields
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-25 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-25 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eRoomInfo\u003c/code\u003e trait provides room-related information like custom name, which corresponds to the name in the Google Home App.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ecustomName\u003c/code\u003e field is a string representing the user-defined name of the room, for example, "Master Bedroom".\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve room information, including the \u003ccode\u003ecustomName\u003c/code\u003e, via the GET request using the provided URL structure.\u003c/p\u003e\n"],["\u003cp\u003eThis trait currently does not support any commands for interaction.\u003c/p\u003e\n"]]],[],null,["\u003cbr /\u003e\n\nRoomInfo Schema\n===============\n\n\u003cbr /\u003e\n\n`sdm.structures.traits.RoomInfo`\n\nThis trait belongs to any room for room-related information.\n\n\u003cbr /\u003e\n\nFields\n------\n\n\n| Field | Description | Data Type |\n|--------------|--------------------------------------------------------------------------|------------------------------------|\n| `customName` | Custom name of the room. Corresponds to the name in the Google Home App. | `string` Example: \"Master Bedroom\" |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n#### Sample GET request and response\n\n### Request\n\n```\nGET /enterprises/project-id/structures/structure-id/rooms/room-id\n```\n\n### Response\n\n {\n \"name\" : \"enterprises/project-id/structures/structure-id/rooms/room-id\",\n \"traits\" : {\n \"sdm.structures.traits.RoomInfo\" : {\n \"customName\" : \"Master Bedroom\"\n }\n }\n }\n\n\u003cbr /\u003e\n\nCommands\n--------\n\nThere are no commands available for this trait.\n\n\nErrors\n------\n\nSee the [API Error Code Reference](/nest/device-access/reference/errors/api) for\nthe full list of API error codes.\n\n\u003cbr /\u003e"]]
