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

yoshi-code-bot

6970659

2021-03-03 03:54:02 -0800

[diff] [blame]

87

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

88

<p class="firstline">Sends an account linking suggestion to users associated with any potential Cast devices detected by third-party devices. This request must be authorized using service account credentials from your Actions console project.</p>

89

Bu Sun Kim

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

[diff] [blame]

90

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

Dmitry Frenkel

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

[diff] [blame]

91

<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]

92

93

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

Dmitry Frenkel

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

[diff] [blame]

94

<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]

95

<h3>Method Details</h3>

96

Dmitry Frenkel

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

[diff] [blame]

97

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

98

<pre>Close httplib2 connections.</pre>

99

</div>

Bu Sun Kim

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

[diff] [blame]

100

Dmitry Frenkel

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

[diff] [blame]

101

102

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

103

<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]

104

105

Args:

106

body: object, The request body.

107

The object takes the form of:

108

Dmitry Frenkel

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

[diff] [blame]

109

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

110

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

111

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

112

{ # Device ID inputs to QueryRequest.

113

"payload": { # Payload containing device IDs. # Payload containing third-party device IDs.

114

"devices": [ # Third-party device IDs for which to get the device states.

115

{ # Third-party device ID for one device.

116

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

117

},

118

],

Bu Sun Kim

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

[diff] [blame]

119

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

120

},

121

],

122

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

123

}

Bu Sun Kim

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

[diff] [blame]

124

125

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

132

Dmitry Frenkel

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

[diff] [blame]

133

{ # 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 } } } } } ```

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

134

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

135

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

136

"a_key": {

137

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

Bu Sun Kim

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

[diff] [blame]

138

},

139

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

140

},

141

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

142

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

Dmitry Frenkel

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

[diff] [blame]

147

<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]

148

149

Args:

150

body: object, The request body.

151

The object takes the form of:

152

Dmitry Frenkel

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

[diff] [blame]

153

{ # 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 } }, } } } ```

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

154

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

155

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

156

"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.

157

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

158

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

159

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

160

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

161

},

162

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

163

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

Bu Sun Kim

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

[diff] [blame]

164

},

165

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

166

},

167

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

168

}

Bu Sun Kim

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

[diff] [blame]

169

170

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

177

Dmitry Frenkel

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

[diff] [blame]

178

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

179

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

180

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

184

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

185

<pre>Sends an account linking suggestion to users associated with any potential Cast devices detected by third-party devices. This request must be authorized using service account credentials from your Actions console project.

186

187

Args:

188

body: object, The request body.

189

The object takes the form of:

190

191

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

192

"payload": { # Payload containing potential devices detected and when they were detected. # Required. ID(s) and detection time of potential Cast devices.

193

"detectionTime": "A String", # Required. Time at which devices represented in `potential_cast_device_ids` were detected.

194

"potentialCastDeviceIds": [ # Required. List of device IDs detected that may potentially be for Cast devices.

"A String",

],

},

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

199

}

200

201

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

208

209

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

214

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

Dmitry Frenkel

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

[diff] [blame]

215

<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]

216

217

Args:

218

body: object, The request body.

219

The object takes the form of:

220

Dmitry Frenkel

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

[diff] [blame]

221

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

222

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

223

"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.

224

}

Bu Sun Kim

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

[diff] [blame]

225

226

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

233

Dmitry Frenkel

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

[diff] [blame]

234

{ # 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

235

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

Dmitry Frenkel

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

[diff] [blame]

240

<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]

241

242

Args:

243

body: object, The request body.

244

The object takes the form of:

245

Dmitry Frenkel

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

[diff] [blame]

246

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

247

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

248

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

249

}

Bu Sun Kim

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

[diff] [blame]

250

251

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

258

Dmitry Frenkel

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

[diff] [blame]

259

{ # 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" } }] } } ```

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

260

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

261

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

262

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

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

263

{ # Third-party device definition. Next ID = 14

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

264

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

265

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

266

},

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

267

"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. Data in this object has a few constraints: No sensitive information, including but not limited to Personally Identifiable Information.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

268

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

269

},

270

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

271

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

272

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

273

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

274

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

275

},

276

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

277

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

278

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

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

279

"A String",

280

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

281

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

282

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

283

"A String",

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

284

],

Bu Sun Kim

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

[diff] [blame]

285

},

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

286

"nonLocalTraits": [ # See description for "traits". For Smart Home Entertainment Devices (SHED) devices, some traits can only be executed on 3P cloud, e.g. "non_local_traits": [ { "trait": "action.devices.traits.MediaInitiation" }, { "trait": "action.devices.traits.Channel" } ] go/shed-per-trait-routing.

287

{ # LINT.IfChange go/shed-per-trait-routing. Making it object to allow for extendible design, where we can add attributes in future.

288

"trait": "A String", # Trait name, e.g., "action.devices.traits.MediaInitiation". See [device traits](https://developers.google.com/assistant/smarthome/traits).

289

},

290

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

291

"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.

292

"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).

293

{ # Alternate third-party device ID.

294

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

295

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

296

},

297

],

298

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

299

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

300

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

301

"A String",

302

],

303

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

304

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

},

],

},

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

309

}</pre>

Bu Sun Kim