| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="homegraph_v1.html">HomeGraph API</a> . <a href="homegraph_v1.devices.html">devices</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#query">query(body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Gets the current states in Home Graph for the given set of the third-party</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#reportStateAndNotification">reportStateAndNotification(body=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Reports device state and optionally sends device notifications.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#requestSync">requestSync(body=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Requests Google to send an `action.devices.SYNC`</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#sync">sync(body=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Gets all the devices associated with the given third-party user.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="query">query(body=None, x__xgafv=None)</code> |
| 92 | <pre>Gets the current states in Home Graph for the given set of the third-party |
| 93 | user's devices. |
| 94 | |
| 95 | The third-party user's identity is passed in via the `agent_user_id` |
| 96 | (see QueryRequest). |
| 97 | This request must be authorized using service account credentials from your |
| 98 | Actions console project. |
| 99 | |
| 100 | Args: |
| 101 | body: object, The request body. |
| 102 | The object takes the form of: |
| 103 | |
| 104 | { # Request type for the |
| 105 | # [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 106 | "requestId": "A String", # Request ID used for debugging. |
| 107 | "agentUserId": "A String", # Required. Third-party user ID. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 108 | "inputs": [ # Required. Inputs containing third-party device IDs for which to |
| 109 | # get the device states. |
| 110 | { # Device ID inputs to QueryRequest. |
| 111 | "payload": { # Payload containing device IDs. # Payload containing third-party device IDs. |
| 112 | "devices": [ # Third-party device IDs for which to get the device states. |
| 113 | { # Third-party device ID for one device. |
| 114 | "id": "A String", # Third-party device ID. |
| 115 | }, |
| 116 | ], |
| 117 | }, |
| 118 | }, |
| 119 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 120 | } |
| 121 | |
| 122 | x__xgafv: string, V1 error format. |
| 123 | Allowed values |
| 124 | 1 - v1 error format |
| 125 | 2 - v2 error format |
| 126 | |
| 127 | Returns: |
| 128 | An object of the form: |
| 129 | |
| 130 | { # Response type for the |
| 131 | # [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. |
| 132 | # This should follow the same format as the Google smart home |
| 133 | # `action.devices.QUERY` |
| 134 | # [response](https://developers.google.com/assistant/smarthome/reference/intent/query). |
| 135 | # # Example |
| 136 | # |
| 137 | # ```json |
| 138 | # { |
| 139 | # "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", |
| 140 | # "payload": { |
| 141 | # "devices": { |
| 142 | # "123": { |
| 143 | # "on": true, |
| 144 | # "online": true |
| 145 | # }, |
| 146 | # "456": { |
| 147 | # "on": true, |
| 148 | # "online": true, |
| 149 | # "brightness": 80, |
| 150 | # "color": { |
| 151 | # "name": "cerulean", |
| 152 | # "spectrumRGB": 31655 |
| 153 | # } |
| 154 | # } |
| 155 | # } |
| 156 | # } |
| 157 | # } |
| 158 | # ``` |
| 159 | "payload": { # Payload containing device states information. # Device states for the devices given in the request. |
| 160 | "devices": { # States of the devices. Map of third-party device ID to struct of device |
| 161 | # states. |
| 162 | "a_key": { |
| 163 | "a_key": "", # Properties of the object. |
| 164 | }, |
| 165 | }, |
| 166 | }, |
| 167 | "requestId": "A String", # Request ID used for debugging. Copied from the request. |
| 168 | }</pre> |
| 169 | </div> |
| 170 | |
| 171 | <div class="method"> |
| 172 | <code class="details" id="reportStateAndNotification">reportStateAndNotification(body=None, x__xgafv=None)</code> |
| 173 | <pre>Reports device state and optionally sends device notifications. |
| 174 | Called by your smart home Action when the state of a third-party device |
| 175 | changes or you need to send a notification about the device. |
| 176 | See [Implement Report |
| 177 | State](https://developers.google.com/assistant/smarthome/develop/report-state) |
| 178 | for more information. |
| 179 | |
| 180 | This method updates the device state according to its declared |
| 181 | [traits](https://developers.google.com/assistant/smarthome/concepts/devices-traits). |
| 182 | Publishing a new state value outside of these traits will result in an |
| 183 | `INVALID_ARGUMENT` error response. |
| 184 | |
| 185 | The third-party user's identity is passed in via the `agent_user_id` |
| 186 | (see ReportStateAndNotificationRequest). |
| 187 | This request must be authorized using service account credentials from your |
| 188 | Actions console project. |
| 189 | |
| 190 | Args: |
| 191 | body: object, The request body. |
| 192 | The object takes the form of: |
| 193 | |
| 194 | { # Request type for the |
| 195 | # [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) |
| 196 | # call. It may include states, notifications, or both. States and notifications |
| 197 | # are defined per `device_id` (for example, "123" and "456" in the following |
| 198 | # example). |
| 199 | # # Example |
| 200 | # |
| 201 | # ```json |
| 202 | # { |
| 203 | # "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", |
| 204 | # "agentUserId": "1234", |
| 205 | # "payload": { |
| 206 | # "devices": { |
| 207 | # "states": { |
| 208 | # "123": { |
| 209 | # "on": true |
| 210 | # }, |
| 211 | # "456": { |
| 212 | # "on": true, |
| 213 | # "brightness": 10 |
| 214 | # } |
| 215 | # }, |
| 216 | # } |
| 217 | # } |
| 218 | # } |
| 219 | # ``` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 220 | "eventId": "A String", # Unique identifier per event (for example, a doorbell press). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 221 | "requestId": "A String", # Request ID used for debugging. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 222 | "payload": { # Payload containing the state and notification information for devices. # Required. State of devices to update and notification metadata for devices. |
| 223 | "devices": { # The states and notifications specific to a device. # The devices for updating state and sending notifications. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 224 | "states": { # States of devices to update. See the **Device STATES** section |
| 225 | # of the individual trait [reference |
| 226 | # guides](https://developers.google.com/assistant/smarthome/traits). |
| 227 | "a_key": "", # Properties of the object. |
| 228 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 229 | "notifications": { # Notifications metadata for devices. See the **Device NOTIFICATIONS** |
| 230 | # section of the individual trait [reference |
| 231 | # guides](https://developers.google.com/assistant/smarthome/traits). |
| 232 | "a_key": "", # Properties of the object. |
| 233 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 234 | }, |
| 235 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 236 | "followUpToken": "A String", # Token to maintain state in the follow up notification response. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 237 | # Deprecated. See the [notifications |
| 238 | # guide](https://developers.google.com/assistant/smarthome/develop/notifications) |
| 239 | # for details on implementing follow up notifications. |
| 240 | "agentUserId": "A String", # Required. Third-party user ID. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 241 | } |
| 242 | |
| 243 | x__xgafv: string, V1 error format. |
| 244 | Allowed values |
| 245 | 1 - v1 error format |
| 246 | 2 - v2 error format |
| 247 | |
| 248 | Returns: |
| 249 | An object of the form: |
| 250 | |
| 251 | { # Response type for the |
| 252 | # [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) |
| 253 | # call. |
| 254 | "requestId": "A String", # Request ID copied from ReportStateAndNotificationRequest. |
| 255 | }</pre> |
| 256 | </div> |
| 257 | |
| 258 | <div class="method"> |
| 259 | <code class="details" id="requestSync">requestSync(body=None, x__xgafv=None)</code> |
| 260 | <pre>Requests Google to send an `action.devices.SYNC` |
| 261 | [intent](https://developers.google.com/assistant/smarthome/reference/intent/sync) |
| 262 | to your smart home Action to update device metadata for the given user. |
| 263 | |
| 264 | |
| 265 | The third-party user's identity is passed via the `agent_user_id` |
| 266 | (see RequestSyncDevicesRequest). |
| 267 | This request must be authorized using service account credentials from your |
| 268 | Actions console project. |
| 269 | |
| 270 | Args: |
| 271 | body: object, The request body. |
| 272 | The object takes the form of: |
| 273 | |
| 274 | { # Request type for the |
| 275 | # [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService.RequestSyncDevices) |
| 276 | # call. |
| 277 | "agentUserId": "A String", # Required. Third-party user ID. |
| 278 | "async": True or False, # Optional. If set, the request will be added to a queue and a response will |
| 279 | # be returned immediately. This enables concurrent requests for the given |
| 280 | # `agent_user_id`, but the caller will not receive any error responses. |
| 281 | } |
| 282 | |
| 283 | x__xgafv: string, V1 error format. |
| 284 | Allowed values |
| 285 | 1 - v1 error format |
| 286 | 2 - v2 error format |
| 287 | |
| 288 | Returns: |
| 289 | An object of the form: |
| 290 | |
| 291 | { # Response type for the |
| 292 | # [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService.RequestSyncDevices) |
| 293 | # call. |
| 294 | # |
| 295 | # Intentionally empty upon success. An HTTP response code is returned |
| 296 | # with more details upon failure. |
| 297 | }</pre> |
| 298 | </div> |
| 299 | |
| 300 | <div class="method"> |
| 301 | <code class="details" id="sync">sync(body=None, x__xgafv=None)</code> |
| 302 | <pre>Gets all the devices associated with the given third-party user. |
| 303 | |
| 304 | The third-party user's identity is passed in via the `agent_user_id` |
| 305 | (see SyncRequest). |
| 306 | This request must be authorized using service account credentials from your |
| 307 | Actions console project. |
| 308 | |
| 309 | Args: |
| 310 | body: object, The request body. |
| 311 | The object takes the form of: |
| 312 | |
| 313 | { # Request type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) |
| 314 | # call. |
| 315 | "requestId": "A String", # Request ID used for debugging. |
| 316 | "agentUserId": "A String", # Required. Third-party user ID. |
| 317 | } |
| 318 | |
| 319 | x__xgafv: string, V1 error format. |
| 320 | Allowed values |
| 321 | 1 - v1 error format |
| 322 | 2 - v2 error format |
| 323 | |
| 324 | Returns: |
| 325 | An object of the form: |
| 326 | |
| 327 | { # Response type for the |
| 328 | # [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call. |
| 329 | # This should follow the same format as the Google smart home |
| 330 | # `action.devices.SYNC` |
| 331 | # [response](https://developers.google.com/assistant/smarthome/reference/intent/sync). |
| 332 | # # Example |
| 333 | # |
| 334 | # ```json |
| 335 | # { |
| 336 | # "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", |
| 337 | # "payload": { |
| 338 | # "agentUserId": "1836.15267389", |
| 339 | # "devices": [{ |
| 340 | # "id": "123", |
| 341 | # "type": "action.devices.types.OUTLET", |
| 342 | # "traits": [ |
| 343 | # "action.devices.traits.OnOff" |
| 344 | # ], |
| 345 | # "name": { |
| 346 | # "defaultNames": ["My Outlet 1234"], |
| 347 | # "name": "Night light", |
| 348 | # "nicknames": ["wall plug"] |
| 349 | # }, |
| 350 | # "willReportState": false, |
| 351 | # "deviceInfo": { |
| 352 | # "manufacturer": "lights-out-inc", |
| 353 | # "model": "hs1234", |
| 354 | # "hwVersion": "3.2", |
| 355 | # "swVersion": "11.4" |
| 356 | # }, |
| 357 | # "customData": { |
| 358 | # "fooValue": 74, |
| 359 | # "barValue": true, |
| 360 | # "bazValue": "foo" |
| 361 | # } |
| 362 | # }] |
| 363 | # } |
| 364 | # } |
| 365 | # ``` |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 366 | "requestId": "A String", # Request ID used for debugging. Copied from the request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 367 | "payload": { # Payload containing device information. # Devices associated with the third-party user. |
| 368 | "devices": [ # Devices associated with the third-party user. |
| 369 | { # Third-party device definition. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 370 | "roomHint": "A String", # Suggested name for the room where this device is installed. |
| 371 | # Google attempts to use this value during user setup. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 372 | "deviceInfo": { # Device information. # Device manufacturer, model, hardware version, and software version. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 373 | "swVersion": "A String", # Device software version. |
| 374 | "model": "A String", # Device model. |
| 375 | "manufacturer": "A String", # Device manufacturer. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 376 | "hwVersion": "A String", # Device hardware version. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 377 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 378 | "id": "A String", # Third-party device ID. |
| 379 | "otherDeviceIds": [ # Alternate IDs associated with this device. |
| 380 | # This is used to identify cloud synced devices enabled for [local |
| 381 | # fulfillment](https://developers.google.com/assistant/smarthome/concepts/local). |
| 382 | { # Alternate third-party device ID. |
| 383 | "agentId": "A String", # Project ID for your smart home Action. |
| 384 | "deviceId": "A String", # Unique third-party device ID. |
| 385 | }, |
| 386 | ], |
| 387 | "willReportState": True or False, # Indicates whether your smart home Action will report state of this device |
| 388 | # to Google via |
| 389 | # ReportStateAndNotification. |
| 390 | "name": { # Identifiers used to describe the device. # Names given to this device by your smart home Action. |
| 391 | "defaultNames": [ # List of names provided by the manufacturer rather than the user, such as |
| 392 | # serial numbers, SKUs, etc. |
| 393 | "A String", |
| 394 | ], |
| 395 | "name": "A String", # Primary name of the device, generally provided by the user. |
| 396 | "nicknames": [ # Additional names provided by the user for the device. |
| 397 | "A String", |
| 398 | ], |
| 399 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 400 | "customData": { # Custom device attributes stored in Home Graph and provided to your |
| 401 | # smart home Action in each |
| 402 | # [QUERY](https://developers.google.com/assistant/smarthome/reference/intent/query) |
| 403 | # and |
| 404 | # [EXECUTE](https://developers.google.com/assistant/smarthome/reference/intent/execute) |
| 405 | # intent. |
| 406 | "a_key": "", # Properties of the object. |
| 407 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 408 | "notificationSupportedByAgent": True or False, # Indicates whether your smart home Action will report notifications |
| 409 | # to Google for this device via |
| 410 | # ReportStateAndNotification. |
| 411 | # |
| 412 | # If your smart home Action enables users to control device notifications, |
| 413 | # you should update this field and call |
| 414 | # RequestSyncDevices. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 415 | "traits": [ # Traits supported by the device. |
| 416 | # See [device |
| 417 | # traits](https://developers.google.com/assistant/smarthome/traits). |
| 418 | "A String", |
| 419 | ], |
| 420 | "structureHint": "A String", # Suggested name for the structure where this device is installed. |
| 421 | # Google attempts to use this value during user setup. |
| 422 | "type": "A String", # Hardware type of the device. |
| 423 | # See [device |
| 424 | # types](https://developers.google.com/assistant/smarthome/guides). |
| 425 | "attributes": { # Attributes for the traits supported by the device. |
| 426 | "a_key": "", # Properties of the object. |
| 427 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 428 | }, |
| 429 | ], |
| 430 | "agentUserId": "A String", # Third-party user ID |
| 431 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 432 | }</pre> |
| 433 | </div> |
| 434 | |
| 435 | </body></html> |