GOgoogle
devices

POST /v1/devices:query

Changed on

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.

Request

  • Base URL
    https://homegraph.googleapis.com
  • URL
    https://homegraph.googleapis.com/v1/devices:query
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/homegraph
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/homegraph

Request body

agentUserIdstring

Required. Third-party user ID.

deviceView'DEVICE_VIEW_UNSPECIFIED' | 'SMART_HOME_TRAIT_ONLY' | 'HOME_TRAIT_ONLY' | 'HOME_TRAIT_AND_SMART_HOME_TRAIT' | 'JSON_TRAIT_ONLY'

Optional. Specifies the type of device data to be returned in the response. This allows callers to request traditional Smart Home traits, Unified Device Data Model (UDDM) traits, or both. If unspecified, defaults to SMART_HOME_TRAIT_ONLY.

includeDeviceMetadataboolean

Optional. If true, the response will include device metadata in the device_metadata field.

requestIdstring

Request ID used for debugging.

Response

Successful response

requestIdstring

Request ID used for debugging. Copied from the request.

Changes

  • 45b370ee1ea0Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

  • 39e0dccc80afRevision changes
    • info

      added the optional property ////// to the response with the status