Show / Hide Table of Contents

Namespace Google.Apis.HomeGraphService.v1.Data

Classes

AgentDeviceId

Third-party device ID for one device.

AgentOtherDeviceId

Alternate third-party device ID.

CameraEventStreamTrait

This cluster defines the camera event stream used by GHP for their Cloud-to-Cloud eventing flow

CommonEventDataStruct

Common camera event data.

Component

Component of a provider device.

ComponentTraitUpdates

Contains the set of updates for a component.

Device

Third-party device definition.

DeviceBlameStruct

Contains metadata about the cause of presence state change attributed to a device.

DeviceInfo

Device information.

DeviceMetadata

Metadata for traits of a single device.

DeviceNames

Identifiers used to describe the device.

Empty

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); }

EveUtilityTrait

EventData

Contains the details for a single event.

Events

Contains a set of events for a specific component.

HomeEvents

Contains the set of events for an item.

HomeTraitPayload

Container for UDDM trait data associated with a device.

HomeTraitUpdates

Contains the set of updates for a device.

MediaUrlsStruct

MotionEvent

Represents a newly detected motion event.

PartnerPresenceSignalTrait

Provides attributes and events related to partner presence signals. See PartnerPresenceSignal trait:

PersonEvent

Represents a newly detected person event.

QueryRequest

Request type for the Query call.

QueryRequestInput

Device ID inputs to QueryRequest.

QueryRequestPayload

Payload containing device IDs.

QueryResponse

Response type for the Query call. This should follow the same format as the Google smart home action.devices.QUERY response. 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 } } } } }

QueryResponsePayload

Payload containing device states information.

ReportStateAndNotificationDevice

The states and notifications specific to a device.

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

ReportStateAndNotificationResponse

Response type for the ReportStateAndNotification call.

RequestSyncDevicesRequest

Request type for the RequestSyncDevices call.

RequestSyncDevicesResponse

Response type for the RequestSyncDevices call. Intentionally empty upon success. An HTTP response code is returned with more details upon failure.

Result

Result of reporting state and notifications for a single device.

StateAndNotificationPayload

Payload containing the state and notification information for devices.

StructurePresenceStateChangeEvent

Sent when the structure presence state changes.

StructurePresenceStateChangeReasonStruct

Contains the metadata about the cause of the structure presence state change.

SyncRequest

Request type for the Sync call.

SyncResponse

Response type for the Sync call. This should follow the same format as the Google smart home action.devices.SYNC response. 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" } }] } }

SyncResponsePayload

Payload containing device information.

ThermostatFanControlTrait

This cluster provides fan control capabilities for thermostats.

TraitData

Contains the trait payload for a single trait.

UserBlameStruct

Contains metadata about the cause of presence state change attributed to a user.

ZoneStruct

In this article
Back to top Generated by DocFX