Show / Hide Table of Contents

Class ReportStateAndNotificationRequest

Request type for the ReportStateAndNotification call. It may include states, notifications, home_traits, home_events, or any combination thereof. Smart Home Device Traits (SHDT) states and notifications are defined per device_id (for example, "123" and "456" in the following example). Google Home Traits home_traits and home_events are lists of updates or events, each associated with a device_id (for example, "789" 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 }, }, "homeTraits": [ { "deviceId": "789", "components": [ {
"componentId": "main", "traitData": [ { "trait": { "@type": "type.googleapis.com/home.graph.v1.OnOffTrait",
"onOff": true } } ] } ] } ], "homeEvents": [ { "deviceId": "789", "events": [ { "componentId": "main", "events":
[ { "eventId": "event-123", "eventTime": "2026-01-01T00:00:00Z", "event": { "@type":
"type.googleapis.com/home.graph.v1.DoorbellPressTrait.DoorbellPressedEvent" } } ] } ] } ] } } }
Inheritance
object
ReportStateAndNotificationRequest
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.HomeGraphService.v1.Data
Assembly: Google.Apis.HomeGraphService.v1.dll
Syntax
public class ReportStateAndNotificationRequest : IDirectResponseSchema

Properties

AgentUserId

Required. Third-party user ID.

Declaration
[JsonProperty("agentUserId")]
public virtual string AgentUserId { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EventId

Unique identifier per event (for example, a doorbell press).

Declaration
[JsonProperty("eventId")]
public virtual string EventId { get; set; }
Property Value
Type Description
string

FollowUpToken

Deprecated.

Declaration
[JsonProperty("followUpToken")]
public virtual string FollowUpToken { get; set; }
Property Value
Type Description
string

Payload

Required. State of devices to update and notification metadata for devices.

Declaration
[JsonProperty("payload")]
public virtual StateAndNotificationPayload Payload { get; set; }
Property Value
Type Description
StateAndNotificationPayload

RequestId

Request ID used for debugging.

Declaration
[JsonProperty("requestId")]
public virtual string RequestId { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX