Stay organized with collections
Save and categorize content based on your preferences.
Info Schema
sdm.structures.traits.Info
This trait belongs to any structure for structure-related information.
Fields
Sample GET request and response
Request
GET /enterprises/ project-id
/structures/ structure-id
Response
{
"name" : "enterprises/ project-id
/structures/ structure-id
",
"traits" : {
" sdm.structures.traits.Info
" : {
"customName" : "Hotel Room 101"
}
}
}
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\u003esdm.structures.traits.Info\u003c/code\u003e trait provides structure-related information, including a custom name.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ecustomName\u003c/code\u003e field within this trait allows setting a user-friendly name for a structure, as seen in the Google Home App.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve structure information, including the custom name, using a GET request to the structure's endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThis trait does not offer any specific commands for interaction.\u003c/p\u003e\n"]]],["The `sdm.structures.traits.Info` trait provides structure-related information, specifically the `customName`. This field, a string, represents the structure's name as it appears in the Google Home App, like \"Hotel Room 101\". A GET request to retrieve structure details includes this trait within the response's `traits` object. No commands are associated with this trait, and error details are available in the API Error Code Reference.\n"],null,["\u003cbr /\u003e\n\nInfo Schema\n===========\n\n\u003cbr /\u003e\n\n`sdm.structures.traits.Info`\n\nThis trait belongs to any structure for structure-related information.\n\n\u003cbr /\u003e\n\nFields\n------\n\n\n| Field | Description | Data Type |\n|--------------|-------------------------------------------------------------------------------|------------------------------------|\n| `customName` | Custom name of the structure. Corresponds to the name in the Google Home App. | `string` Example: \"Hotel Room 101\" |\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\n```\n\n### Response\n\n {\n \"name\" : \"enterprises/project-id/structures/structure-id\",\n \"traits\" : {\n \"sdm.structures.traits.Info\" : {\n \"customName\" : \"Hotel Room 101\"\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"]]
