home-assistant.io/source/_integrations/google_assistant_sdk.markdown

title, description, ha_category, ha_iot_class, ha_release, ha_config_flow, ha_domain, ha_codeowners, ha_integration_type, ha_platforms, ha_quality_scale, google_dev_console_link, api, api_link

title	description	ha_category	ha_iot_class	ha_release	ha_config_flow	ha_domain	ha_codeowners	ha_integration_type	ha_platforms	ha_quality_scale	google_dev_console_link	api	api_link
Google Assistant SDK	Instructions on how to use Google Assistant SDK in Home Assistant.	Voice	Cloud Polling	2023.1	true	google_assistant_sdk	@tronikos	service	notify	platinum	https://console.developers.google.com/apis/api/embeddedassistant.googleapis.com/overview	Google Assistant API	https://console.developers.google.com/apis/api/embeddedassistant.googleapis.com/overview

The Google Assistant SDK integration allows Home Assistant to interact with Google Assistant. If you want to use Google Assistant (for example, from your phone or Google Home device) to interact with your Home Assistant managed devices, then you want the Google Assistant integration.

This integration allows:

• Sending text commands to Google Assistant to control devices supported by Google Assistant but not by Home Assistant. Examples:
  • Set Nest Guard to home and guarding
  • Start vacuuming
  • Stream front door on living room TV
  • Turn off kitchen TV
  • Play rain sounds on bedroom speaker
• Broadcast messages to Google Assistant speakers and displays without interrupting music/video playback. Examples:
  • Coffee is ready
  • Someone is at the front door
  • Smoke detected in the master bedroom
  • Water leak detected in the master bathroom
• Playback Google Assistant audio response for any query on any media player. Examples:
  • Tell me a joke
  • Say the ABC
  • Sing happy birthday
  • What does the elephant say?
• Having a conversation with Google Assistant using the conversation integration via text or voice.

Prerequisites

You need to configure developer credentials to allow Home Assistant to access your Google Account. These credentials are the same as the ones for Nest or Google Sheets, YouTube, and Google Mail.

{% include integrations/google_client_secret.md %}

{% include integrations/config_flow.md %}

The integration setup will next give you instructions to enter the Application Credentials (OAuth Client ID and Client Secret) and authorize Home Assistant to access your Google Assistant API.

{% details "Authorization steps" %}

1. Continue through the steps of selecting the account you want to authorize.

2. If your Google account settings are set to a language not supported by the SDK -- which can be noticed by the authentication screen of Google being localized in that language -- the authorization will fail without a clear error. Changing the language at the bottom of the error page to one that is supported by the SDK will allow you to continue to the link page of Home Assistant.

3. NOTE: You may get a message telling you that the app has not been verified and you will need to acknowledge that in order to proceed.

4. You can now see the details of what you are authorizing Home Assistant to access with two options at the bottom. Click Continue.

5. The page will now display Link account to Home Assistant?, note Your instance URL. If this is not correct, please refer to My Home Assistant. If everything looks good, click Link Account.

6. You may close the window, and return back to Home Assistant where you should see a Success! message from Home Assistant.

{% enddetails %}

Troubleshooting

If you have an error with your credentials you can delete them in the Application Credentials user interface.

If commands don't work try removing superfluous words such as "the". E.g. "play rain sounds on bedroom speaker" instead of "play rain sounds on the bedroom speaker".

If broadcasting doesn't work, make sure: the speakers aren't in do not disturb mode, the Home Assistant server is in the same network as the speakers, and IPv6 is disabled in the router.

The easiest way to check if the integration is working is to check My Google Activity for the issued commands and their responses.

Limitations/known issues

• Multiple Google accounts are not supported.
• Personal results are not supported yet since that requires creating an OAuth client ID of the Desktop app.
• If you see the issued commands in My Google Activity, the integration is working fine. If the commands don't have the expected outcome, don't open an issue in the Home Assistant Core project or the underlying library. You should instead report the issue directly to Google here. Examples of known Google Assistant API issues:
  • Media playback commands (other than play news, play podcast, play white noise, or play rain sounds) don't work.
  • Routines don't work.
  • Broadcast doesn't work with IPv6.
  • Broadcast to specific rooms often doesn't work for non-English languages.
  • Commands that need to verify your identity through voice match do not work.

Configuration

On the configure page, you can set the language code of the interactions with Google Assistant. If not configured, the integration picks one based on Home Assistant's configured language and country. Supported languages are listed here.

Services

Service google_assistant_sdk.send_text_command

You can use the service google_assistant_sdk.send_text_command to send commands to Google Assistant.

Service data attribute	Optional	Description	Example
command	no	Command(s) to send to Google Assistant.	turn off kitchen TV
media_player	yes	Name(s) of media player entities to play response on	media_player.living_room_speaker

Examples:

service: google_assistant_sdk.send_text_command
data:
  command: "turn off kitchen TV"

# Say a joke on the living room speaker
service: google_assistant_sdk.send_text_command
data:
  command: "tell me a joke"
  media_player: media_player.living_room_speaker

You can send multiple commands in the same conversation context which is useful to unlock doors or open covers that need a PIN. Example:

service: google_assistant_sdk.send_text_command
data:
  command:
    - "open the garage door"
    - "1234"

You can get responses. Example:

service: google_assistant_sdk.send_text_command
data:
  command:
    - "tell me a joke"
    - "tell me another one"

returns:

responses:
  - text: |-
      What do you call a belt made of watches?
      A waist of time 👖 🕝
  - text: |-
      What's the most musical part of the turkey?
      The drumsticks 🍗

Service notify.google_assistant_sdk

You can use the service notify.google_assistant_sdk to broadcast messages to Google Assistant speakers and displays without interrupting music/video playback.

Service data attribute	Optional	Description	Example
message	no	Message to broadcast.	someone is at the front door
target	yes	Rooms (in Google Assistant)	bedroom

Example to broadcast to all speakers:

service: notify.google_assistant_sdk
data:
  message: time for dinner

Example to broadcast to speakers in selected rooms:

service: notify.google_assistant_sdk
data:
  message: time for dinner
  target:
    - bedroom
    - basement

Conversation agent

You can add an assistant with the conversation agent set to "Google Assistant SDK". See setup your assistant section here. Then you can converse with Google Assistant by tapping the Assist icon at the top right of your dashboard:

Or by calling the conversation.process service.

Note: due to a bug in the Google Assistant API, not all responses contain text, especially for home control commands, like turn on the lights. These will be shown as <empty response>. For those, Google Assistant responds with HTML and Home Assistant integrations are not allowed to parse HTML.