OAuth2 scopes used by this API.
const (
// Private Service: https://www.googleapis.com/auth/homegraph
HomegraphScope = "https://www.googleapis.com/auth/homegraph"
)
AgentDeviceId: Third-party device ID for one device.
type AgentDeviceId struct {
// Id: Third-party device ID.
Id string `json:"id,omitempty"`
// ForceSendFields is a list of field names (e.g. "Id") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Id") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AgentDeviceId) MarshalJSON() ([]byte, error)
AgentOtherDeviceId: Alternate third-party device ID.
type AgentOtherDeviceId struct {
// AgentId: Project ID for your smart home Action.
AgentId string `json:"agentId,omitempty"`
// DeviceId: Unique third-party device ID.
DeviceId string `json:"deviceId,omitempty"`
// ForceSendFields is a list of field names (e.g. "AgentId") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AgentId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AgentOtherDeviceId) MarshalJSON() ([]byte, error)
type AgentUsersDeleteCall struct {
// contains filtered or unexported fields
}
func (c *AgentUsersDeleteCall) Context(ctx context.Context) *AgentUsersDeleteCall
Context sets the context to be used in this call's Do method.
func (c *AgentUsersDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "homegraph.agentUsers.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AgentUsersDeleteCall) Fields(s ...googleapi.Field) *AgentUsersDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AgentUsersDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *AgentUsersDeleteCall) RequestId(requestId string) *AgentUsersDeleteCall
RequestId sets the optional parameter "requestId": Request ID used for debugging.
type AgentUsersService struct {
// contains filtered or unexported fields
}
func NewAgentUsersService(s *Service) *AgentUsersService
func (r *AgentUsersService) Delete(agentUserId string) *AgentUsersDeleteCall
Delete: Unlinks the given third-party user from your smart home Action. All data related to this user will be deleted. For more details on how users link their accounts, see fulfillment and authentication (https://developers.home.google.com/cloud-to-cloud/primer/fulfillment). The third-party user's identity is passed in via the `agent_user_id` (see DeleteAgentUserRequest). This request must be authorized using service account credentials from your Actions console project.
- agentUserId: Third-party user ID.
Device: Third-party device definition.
type Device struct {
// Attributes: Attributes for the traits supported by the device.
Attributes googleapi.RawMessage `json:"attributes,omitempty"`
// CustomData: Custom device attributes stored in Home Graph and provided to
// your smart home Action in each QUERY
// (https://developers.home.google.com/cloud-to-cloud/intents/query) and
// EXECUTE (https://developers.home.google.com/cloud-to-cloud/intents/execute)
// intent. Data in this object has a few constraints: No sensitive information,
// including but not limited to Personally Identifiable Information.
CustomData googleapi.RawMessage `json:"customData,omitempty"`
// DeviceInfo: Device manufacturer, model, hardware version, and software
// version.
DeviceInfo *DeviceInfo `json:"deviceInfo,omitempty"`
// Id: Third-party device ID.
Id string `json:"id,omitempty"`
// Name: Names given to this device by your smart home Action.
Name *DeviceNames `json:"name,omitempty"`
// NotificationSupportedByAgent: 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.
NotificationSupportedByAgent bool `json:"notificationSupportedByAgent,omitempty"`
// OtherDeviceIds: Alternate IDs associated with this device. This is used to
// identify cloud synced devices enabled for local fulfillment
// (https://developers.home.google.com/local-home/overview).
OtherDeviceIds []*AgentOtherDeviceId `json:"otherDeviceIds,omitempty"`
// RoomHint: Suggested name for the room where this device is installed. Google
// attempts to use this value during user setup.
RoomHint string `json:"roomHint,omitempty"`
// StructureHint: Suggested name for the structure where this device is
// installed. Google attempts to use this value during user setup.
StructureHint string `json:"structureHint,omitempty"`
// Traits: Traits supported by the device. See device traits
// (https://developers.home.google.com/cloud-to-cloud/traits).
Traits []string `json:"traits,omitempty"`
// Type: Hardware type of the device. See device types
// (https://developers.home.google.com/cloud-to-cloud/guides).
Type string `json:"type,omitempty"`
// WillReportState: Indicates whether your smart home Action will report state
// of this device to Google via ReportStateAndNotification.
WillReportState bool `json:"willReportState,omitempty"`
// ForceSendFields is a list of field names (e.g. "Attributes") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Attributes") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Device) MarshalJSON() ([]byte, error)
DeviceInfo: Device information.
type DeviceInfo struct {
// HwVersion: Device hardware version.
HwVersion string `json:"hwVersion,omitempty"`
// Manufacturer: Device manufacturer.
Manufacturer string `json:"manufacturer,omitempty"`
// Model: Device model.
Model string `json:"model,omitempty"`
// SwVersion: Device software version.
SwVersion string `json:"swVersion,omitempty"`
// ForceSendFields is a list of field names (e.g. "HwVersion") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "HwVersion") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeviceInfo) MarshalJSON() ([]byte, error)
DeviceNames: Identifiers used to describe the device.
type DeviceNames struct {
// DefaultNames: List of names provided by the manufacturer rather than the
// user, such as serial numbers, SKUs, etc.
DefaultNames []string `json:"defaultNames,omitempty"`
// Name: Primary name of the device, generally provided by the user.
Name string `json:"name,omitempty"`
// Nicknames: Additional names provided by the user for the device.
Nicknames []string `json:"nicknames,omitempty"`
// ForceSendFields is a list of field names (e.g. "DefaultNames") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DefaultNames") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeviceNames) MarshalJSON() ([]byte, error)
type DevicesQueryCall struct {
// contains filtered or unexported fields
}
func (c *DevicesQueryCall) Context(ctx context.Context) *DevicesQueryCall
Context sets the context to be used in this call's Do method.
func (c *DevicesQueryCall) Do(opts ...googleapi.CallOption) (*QueryResponse, error)
Do executes the "homegraph.devices.query" call. Any non-2xx status code is an error. Response headers are in either *QueryResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DevicesQueryCall) Fields(s ...googleapi.Field) *DevicesQueryCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DevicesQueryCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type DevicesReportStateAndNotificationCall struct {
// contains filtered or unexported fields
}
func (c *DevicesReportStateAndNotificationCall) Context(ctx context.Context) *DevicesReportStateAndNotificationCall
Context sets the context to be used in this call's Do method.
func (c *DevicesReportStateAndNotificationCall) Do(opts ...googleapi.CallOption) (*ReportStateAndNotificationResponse, error)
Do executes the "homegraph.devices.reportStateAndNotification" call. Any non-2xx status code is an error. Response headers are in either *ReportStateAndNotificationResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DevicesReportStateAndNotificationCall) Fields(s ...googleapi.Field) *DevicesReportStateAndNotificationCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DevicesReportStateAndNotificationCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type DevicesRequestSyncCall struct {
// contains filtered or unexported fields
}
func (c *DevicesRequestSyncCall) Context(ctx context.Context) *DevicesRequestSyncCall
Context sets the context to be used in this call's Do method.
func (c *DevicesRequestSyncCall) Do(opts ...googleapi.CallOption) (*RequestSyncDevicesResponse, error)
Do executes the "homegraph.devices.requestSync" call. Any non-2xx status code is an error. Response headers are in either *RequestSyncDevicesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DevicesRequestSyncCall) Fields(s ...googleapi.Field) *DevicesRequestSyncCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DevicesRequestSyncCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type DevicesService struct {
// contains filtered or unexported fields
}
func NewDevicesService(s *Service) *DevicesService
func (r *DevicesService) Query(queryrequest *QueryRequest) *DevicesQueryCall
Query: 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.
func (r *DevicesService) ReportStateAndNotification(reportstateandnotificationrequest *ReportStateAndNotificationRequest) *DevicesReportStateAndNotificationCall
ReportStateAndNotification: 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.home.google.com/cloud-to-cloud/integration/report-state) for more information. This method updates the device state according to its declared traits (https://developers.home.google.com/cloud-to-cloud/primer/device-types-and-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.
func (r *DevicesService) RequestSync(requestsyncdevicesrequest *RequestSyncDevicesRequest) *DevicesRequestSyncCall
RequestSync: Requests Google to send an `action.devices.SYNC` intent (https://developers.home.google.com/cloud-to-cloud/intents/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.
func (r *DevicesService) Sync(syncrequest *SyncRequest) *DevicesSyncCall
Sync: 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.
type DevicesSyncCall struct {
// contains filtered or unexported fields
}
func (c *DevicesSyncCall) Context(ctx context.Context) *DevicesSyncCall
Context sets the context to be used in this call's Do method.
func (c *DevicesSyncCall) Do(opts ...googleapi.CallOption) (*SyncResponse, error)
Do executes the "homegraph.devices.sync" call. Any non-2xx status code is an error. Response headers are in either *SyncResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DevicesSyncCall) Fields(s ...googleapi.Field) *DevicesSyncCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DevicesSyncCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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); }
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
QueryRequest: Request type for the `Query` (#google.home.graph.v1.HomeGraphApiService.Query) call.
type QueryRequest struct {
// AgentUserId: Required. Third-party user ID.
AgentUserId string `json:"agentUserId,omitempty"`
// Inputs: Required. Inputs containing third-party device IDs for which to get
// the device states.
Inputs []*QueryRequestInput `json:"inputs,omitempty"`
// RequestId: Request ID used for debugging.
RequestId string `json:"requestId,omitempty"`
// ForceSendFields is a list of field names (e.g. "AgentUserId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AgentUserId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *QueryRequest) MarshalJSON() ([]byte, error)
QueryRequestInput: Device ID inputs to QueryRequest.
type QueryRequestInput struct {
// Payload: Payload containing third-party device IDs.
Payload *QueryRequestPayload `json:"payload,omitempty"`
// ForceSendFields is a list of field names (e.g. "Payload") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Payload") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *QueryRequestInput) MarshalJSON() ([]byte, error)
QueryRequestPayload: Payload containing device IDs.
type QueryRequestPayload struct {
// Devices: Third-party device IDs for which to get the device states.
Devices []*AgentDeviceId `json:"devices,omitempty"`
// ForceSendFields is a list of field names (e.g. "Devices") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Devices") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *QueryRequestPayload) MarshalJSON() ([]byte, error)
QueryResponse: 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.home.google.com/cloud-to-cloud/intents/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 } } } } } ```
type QueryResponse struct {
// Payload: Device states for the devices given in the request.
Payload *QueryResponsePayload `json:"payload,omitempty"`
// RequestId: Request ID used for debugging. Copied from the request.
RequestId string `json:"requestId,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Payload") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Payload") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *QueryResponse) MarshalJSON() ([]byte, error)
QueryResponsePayload: Payload containing device states information.
type QueryResponsePayload struct {
// Devices: States of the devices. Map of third-party device ID to struct of
// device states.
Devices map[string]googleapi.RawMessage `json:"devices,omitempty"`
// ForceSendFields is a list of field names (e.g. "Devices") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Devices") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *QueryResponsePayload) MarshalJSON() ([]byte, error)
ReportStateAndNotificationDevice: The states and notifications specific to a device.
type ReportStateAndNotificationDevice struct {
// Notifications: Notifications metadata for devices. See the **Device
// NOTIFICATIONS** section of the individual trait reference guides
// (https://developers.home.google.com/cloud-to-cloud/traits).
Notifications googleapi.RawMessage `json:"notifications,omitempty"`
// States: States of devices to update. See the **Device STATES** section of
// the individual trait reference guides
// (https://developers.home.google.com/cloud-to-cloud/traits).
States googleapi.RawMessage `json:"states,omitempty"`
// ForceSendFields is a list of field names (e.g. "Notifications") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Notifications") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ReportStateAndNotificationDevice) MarshalJSON() ([]byte, error)
ReportStateAndNotificationRequest: 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 } }, } } } ```
type ReportStateAndNotificationRequest struct {
// AgentUserId: Required. Third-party user ID.
AgentUserId string `json:"agentUserId,omitempty"`
// EventId: Unique identifier per event (for example, a doorbell press).
EventId string `json:"eventId,omitempty"`
// FollowUpToken: Deprecated.
FollowUpToken string `json:"followUpToken,omitempty"`
// Payload: Required. State of devices to update and notification metadata for
// devices.
Payload *StateAndNotificationPayload `json:"payload,omitempty"`
// RequestId: Request ID used for debugging.
RequestId string `json:"requestId,omitempty"`
// ForceSendFields is a list of field names (e.g. "AgentUserId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AgentUserId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ReportStateAndNotificationRequest) MarshalJSON() ([]byte, error)
ReportStateAndNotificationResponse: Response type for the `ReportStateAndNotification` (#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call.
type ReportStateAndNotificationResponse struct {
// RequestId: Request ID copied from ReportStateAndNotificationRequest.
RequestId string `json:"requestId,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "RequestId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "RequestId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ReportStateAndNotificationResponse) MarshalJSON() ([]byte, error)
RequestSyncDevicesRequest: Request type for the `RequestSyncDevices` (#google.home.graph.v1.HomeGraphApiService.RequestSyncDevices) call.
type RequestSyncDevicesRequest struct {
// AgentUserId: Required. Third-party user ID.
AgentUserId string `json:"agentUserId,omitempty"`
// Async: 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.
Async bool `json:"async,omitempty"`
// ForceSendFields is a list of field names (e.g. "AgentUserId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AgentUserId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *RequestSyncDevicesRequest) MarshalJSON() ([]byte, error)
RequestSyncDevicesResponse: 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.
type RequestSyncDevicesResponse struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
AgentUsers *AgentUsersService
Devices *DevicesService
// contains filtered or unexported fields
}
func New(client *http.Client) (*Service, error)
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
StateAndNotificationPayload: Payload containing the state and notification information for devices.
type StateAndNotificationPayload struct {
// Devices: The devices for updating state and sending notifications.
Devices *ReportStateAndNotificationDevice `json:"devices,omitempty"`
// ForceSendFields is a list of field names (e.g. "Devices") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Devices") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *StateAndNotificationPayload) MarshalJSON() ([]byte, error)
SyncRequest: Request type for the `Sync` (#google.home.graph.v1.HomeGraphApiService.Sync) call.
type SyncRequest struct {
// AgentUserId: Required. Third-party user ID.
AgentUserId string `json:"agentUserId,omitempty"`
// RequestId: Request ID used for debugging.
RequestId string `json:"requestId,omitempty"`
// ForceSendFields is a list of field names (e.g. "AgentUserId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AgentUserId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SyncRequest) MarshalJSON() ([]byte, error)
SyncResponse: 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.home.google.com/cloud-to-cloud/intents/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" } }] } } ```
type SyncResponse struct {
// Payload: Devices associated with the third-party user.
Payload *SyncResponsePayload `json:"payload,omitempty"`
// RequestId: Request ID used for debugging. Copied from the request.
RequestId string `json:"requestId,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Payload") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Payload") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SyncResponse) MarshalJSON() ([]byte, error)
SyncResponsePayload: Payload containing device information.
type SyncResponsePayload struct {
// AgentUserId: Third-party user ID
AgentUserId string `json:"agentUserId,omitempty"`
// Devices: Devices associated with the third-party user.
Devices []*Device `json:"devices,omitempty"`
// ForceSendFields is a list of field names (e.g. "AgentUserId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AgentUserId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SyncResponsePayload) MarshalJSON() ([]byte, error)