Blame - docs/dyn/homegraph_v1.devices.html - platform/external/python/google-api-python-client

2020-05-20 12:08:20 -0700

[diff] [blame]

83

84

<code><a href="#reportStateAndNotification">reportStateAndNotification(body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

85

<p class="firstline">Reports device state and optionally sends device notifications. Called by your smart home Action when the state of a third-party device changes or you need to send a notification about the device. See [Implement Report State](https://developers.google.com/assistant/smarthome/develop/report-state) for more information. This method updates the device state according to its declared [traits](https://developers.google.com/assistant/smarthome/concepts/devices-traits). Publishing a new state value outside of these traits will result in an `INVALID_ARGUMENT` error response. The third-party user's identity is passed in via the `agent_user_id` (see ReportStateAndNotificationRequest). This request must be authorized using service account credentials from your Actions console project.</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

86

87

<code><a href="#requestSync">requestSync(body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

88

<p class="firstline">Requests Google to send an `action.devices.SYNC` [intent](https://developers.google.com/assistant/smarthome/reference/intent/sync) to your smart home Action to update device metadata for the given user. The third-party user's identity is passed via the `agent_user_id` (see RequestSyncDevicesRequest). This request must be authorized using service account credentials from your Actions console project.</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

89

90

<code><a href="#sync">sync(body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

91

<p class="firstline">Gets all the devices associated with the given third-party user. The third-party user's identity is passed in via the `agent_user_id` (see SyncRequest). This request must be authorized using service account credentials from your Actions console project.</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

92

<h3>Method Details</h3>

93

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

94

<code class="details" id="close">close()</code>

95

<pre>Close httplib2 connections.</pre>

96

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

97

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

98

99

<code class="details" id="query">query(body=None, x__xgafv=None)</code>

100

<pre>Gets the current states in Home Graph for the given set of the third-party user's devices. The third-party user's identity is passed in via the `agent_user_id` (see QueryRequest). This request must be authorized using service account credentials from your Actions console project.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

101

102

Args:

103

body: object, The request body.

104

The object takes the form of:

105

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

106

{ # Request type for the [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

107

"agentUserId": "A String", # Required. Third-party user ID.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

108

"requestId": "A String", # Request ID used for debugging.

109

"inputs": [ # Required. Inputs containing third-party device IDs for which to get the device states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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.

},

],

},

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

120

}

121

122

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

129

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

130

{ # Response type for the [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. This should follow the same format as the Google smart home `action.devices.QUERY` [response](https://developers.google.com/assistant/smarthome/reference/intent/query). # Example ```json { "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "devices": { "123": { "on": true, "online": true }, "456": { "on": true, "online": true, "brightness": 80, "color": { "name": "cerulean", "spectrumRGB": 31655 } } } } } ```

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

131

"payload": { # Payload containing device states information. # Device states for the devices given in the request.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

132

"devices": { # States of the devices. Map of third-party device ID to struct of device states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

133

"a_key": {

134

"a_key": "", # Properties of the object.

135

},

136

},

137

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

138

"requestId": "A String", # Request ID used for debugging. Copied from the request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="reportStateAndNotification">reportStateAndNotification(body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

144

<pre>Reports device state and optionally sends device notifications. Called by your smart home Action when the state of a third-party device changes or you need to send a notification about the device. See [Implement Report State](https://developers.google.com/assistant/smarthome/develop/report-state) for more information. This method updates the device state according to its declared [traits](https://developers.google.com/assistant/smarthome/concepts/devices-traits). Publishing a new state value outside of these traits will result in an `INVALID_ARGUMENT` error response. The third-party user's identity is passed in via the `agent_user_id` (see ReportStateAndNotificationRequest). This request must be authorized using service account credentials from your Actions console project.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

145

146

Args:

147

body: object, The request body.

148

The object takes the form of:

149

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

150

{ # Request type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call. It may include states, notifications, or both. States and notifications are defined per `device_id` (for example, "123" and "456" in the following example). # Example ```json { "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "agentUserId": "1234", "payload": { "devices": { "states": { "123": { "on": true }, "456": { "on": true, "brightness": 10 } }, } } } ```

151

"requestId": "A String", # Request ID used for debugging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

152

"payload": { # Payload containing the state and notification information for devices. # Required. State of devices to update and notification metadata for devices.

153

"devices": { # The states and notifications specific to a device. # The devices for updating state and sending notifications.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

154

"notifications": { # Notifications metadata for devices. See the **Device NOTIFICATIONS** section of the individual trait [reference guides](https://developers.google.com/assistant/smarthome/traits).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

155

"a_key": "", # Properties of the object.

156

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

157

"states": { # States of devices to update. See the **Device STATES** section of the individual trait [reference guides](https://developers.google.com/assistant/smarthome/traits).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

158

"a_key": "", # Properties of the object.

159

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

160

},

161

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

162

"agentUserId": "A String", # Required. Third-party user ID.

163

"followUpToken": "A String", # Token to maintain state in the follow up notification response. Deprecated. See the [notifications guide](https://developers.google.com/assistant/smarthome/develop/notifications) for details on implementing follow up notifications.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

164

"eventId": "A String", # Unique identifier per event (for example, a doorbell press).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

165

}

166

167

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

174

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

175

{ # Response type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

176

"requestId": "A String", # Request ID copied from ReportStateAndNotificationRequest.

}</pre>

</div>

<code class="details" id="requestSync">requestSync(body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

182

<pre>Requests Google to send an `action.devices.SYNC` [intent](https://developers.google.com/assistant/smarthome/reference/intent/sync) to your smart home Action to update device metadata for the given user. The third-party user's identity is passed via the `agent_user_id` (see RequestSyncDevicesRequest). This request must be authorized using service account credentials from your Actions console project.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

183

184

Args:

185

body: object, The request body.

186

The object takes the form of:

187

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

188

{ # Request type for the [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService.RequestSyncDevices) call.

189

"async": True or False, # Optional. If set, the request will be added to a queue and a response will be returned immediately. This enables concurrent requests for the given `agent_user_id`, but the caller will not receive any error responses.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

190

"agentUserId": "A String", # Required. Third-party user ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

191

}

192

193

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

200

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

201

{ # Response type for the [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService.RequestSyncDevices) call. Intentionally empty upon success. An HTTP response code is returned with more details upon failure.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="sync">sync(body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

207

<pre>Gets all the devices associated with the given third-party user. The third-party user's identity is passed in via the `agent_user_id` (see SyncRequest). This request must be authorized using service account credentials from your Actions console project.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

208

209

Args:

210

body: object, The request body.

211

The object takes the form of:

212

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

213

{ # Request type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

214

"requestId": "A String", # Request ID used for debugging.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

215

"agentUserId": "A String", # Required. Third-party user ID.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

216

}

217

218

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

225

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

226

{ # Response type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call. This should follow the same format as the Google smart home `action.devices.SYNC` [response](https://developers.google.com/assistant/smarthome/reference/intent/sync). # Example ```json { "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "agentUserId": "1836.15267389", "devices": [{ "id": "123", "type": "action.devices.types.OUTLET", "traits": [ "action.devices.traits.OnOff" ], "name": { "defaultNames": ["My Outlet 1234"], "name": "Night light", "nicknames": ["wall plug"] }, "willReportState": false, "deviceInfo": { "manufacturer": "lights-out-inc", "model": "hs1234", "hwVersion": "3.2", "swVersion": "11.4" }, "customData": { "fooValue": 74, "barValue": true, "bazValue": "foo" } }] } } ```

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

227

"payload": { # Payload containing device information. # Devices associated with the third-party user.

228

"devices": [ # Devices associated with the third-party user.

229

{ # Third-party device definition.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

230

"id": "A String", # Third-party device ID.

231

"otherDeviceIds": [ # Alternate IDs associated with this device. This is used to identify cloud synced devices enabled for [local fulfillment](https://developers.google.com/assistant/smarthome/concepts/local).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

232

{ # Alternate third-party device ID.

233

"agentId": "A String", # Project ID for your smart home Action.

234

"deviceId": "A String", # Unique third-party device ID.

235

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

236

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

237

"name": { # Identifiers used to describe the device. # Names given to this device by your smart home Action.

238

"nicknames": [ # Additional names provided by the user for the device.

239

"A String",

240

],

241

"name": "A String", # Primary name of the device, generally provided by the user.

242

"defaultNames": [ # List of names provided by the manufacturer rather than the user, such as serial numbers, SKUs, etc.

243

"A String",

244

],

245

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

246

"attributes": { # Attributes for the traits supported by the device.

247

"a_key": "", # Properties of the object.

248

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

249

"roomHint": "A String", # Suggested name for the room where this device is installed. Google attempts to use this value during user setup.

250

"notificationSupportedByAgent": True or False, # Indicates whether your smart home Action will report notifications to Google for this device via ReportStateAndNotification. If your smart home Action enables users to control device notifications, you should update this field and call RequestSyncDevices.

251

"structureHint": "A String", # Suggested name for the structure where this device is installed. Google attempts to use this value during user setup.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

252

"deviceInfo": { # Device information. # Device manufacturer, model, hardware version, and software version.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

253

"manufacturer": "A String", # Device manufacturer.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

254

"hwVersion": "A String", # Device hardware version.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

255

"model": "A String", # Device model.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

256

"swVersion": "A String", # Device software version.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

257

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

258

"customData": { # Custom device attributes stored in Home Graph and provided to your smart home Action in each [QUERY](https://developers.google.com/assistant/smarthome/reference/intent/query) and [EXECUTE](https://developers.google.com/assistant/smarthome/reference/intent/execute) intent.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

259

"a_key": "", # Properties of the object.

260

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

261

"type": "A String", # Hardware type of the device. See [device types](https://developers.google.com/assistant/smarthome/guides).

262

"traits": [ # Traits supported by the device. See [device traits](https://developers.google.com/assistant/smarthome/traits).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

263

"A String",

264

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

265

"willReportState": True or False, # Indicates whether your smart home Action will report state of this device to Google via ReportStateAndNotification.

Bu Sun Kim