The Google Home app (GHA) is the primary way users connect smart devices to Google Assistant and assign them to structures and rooms in Google Home Graph. To perform setup, users typically click through multiple screens to find your Cloud-to-cloud integration from a list of available options. By making it easier for users to begin the setup process, you can help onboard them more quickly and reduce user setup frustration.
Deep Linking allows you to embed a deep link in your app or product website for users to easily connect their smart home device to Assistant. Clicking on the link prompts users to download the GHA (if not already installed), and launches the account linking and room assignment setup flow.
Deep link to Google Home
Deep links enable you to take users directly to a specific destination within the GHA from your Android or iOS app, simplifying the device setup process with Assistant.
The syntax for the GHA deep links is as follows:
https://madeby.google.com/home-app/?deeplink=destination
Your Android or iOS app can currently link to the following destinations within the GHA:
| Destination | Description |
|---|---|
setup/ha_linking?agent_id=agent-id
|
Initiate the
OAuth account linking flow for the given Cloud-to-cloud
integration's agent-id.
|
The destination path must be properly URL-encoded before you apply it to the deep link. For example:
https://madeby.google.com/home-app/?deeplink=setup%2Fha_linking%3Fagent_id%3Dagent-idFor more details on triggering deep links from within your app, see the relevant Android documentation and iOS documentation.