AccountLinking

  • Account Linking enables users to sign in to your app's web services through Google.

  • For Google Sign-In and OAuth linking, a Client ID is generated by Google and displayed in the Actions Console.

  • For all other linking types, provide test account credentials for review purposes in Settings.testing_instructions.

  • You must configure account linking settings like enableAccountCreation, linkingType, and optional OAuth parameters in your action's YAML configuration.

  • When using OAuth, provide necessary information like authorization and token URLs, scopes, and optionally, a learnMoreUrl and basic authentication settings.

AccountLinking allows Google to guide the user to sign-in to the App's web services.

For Google Sign In and OAuth + Google Sign In linking types, Google generates a client ID identifying your App to Google ("Client ID issued by Google to your Actions" on Console UI). This field is read-only and can be checked by navigating to the Console UI's Account Linking page. See: https://developers.google.com/assistant/identity/google-sign-in

Note: For all account linking setting types (except for Google Sign In), you must provide a username and password for a test account in Settings.testing_instructions for the review team to review the app (they will not be visible to users).

YAML representation 
enableAccountCreation: boolean
linkingType: enum (LinkingType)
authGrantType: enum (AuthGrantType)
appClientId: string
authorizationUrl: string
tokenUrl: string
scopes: 
  - string
learnMoreUrl: string
useBasicAuthHeader: boolean
Fields
enableAccountCreation

boolean

Required. If true, users are allowed to sign up for new accounts via voice. If false, account creation is only allowed on your website. Select this option if you want to display your terms of service or obtain user consents during sign-up. linkingType cannot be GOOGLE_SIGN_IN when this is false. linkingType cannot be OAUTH when this is true.
linkingType

enum (LinkingType)

Required. The linking type to use. See https://developers.google.com/assistant/identity for further details on the linking types.
authGrantType

enum (AuthGrantType)

Optional. Indicates the type of authentication for OAUTH linkingType.
appClientId

string

Optional. Client ID issued by your App to Google. This is the OAuth2 Client ID identifying Google to your service. Only set when using OAuth.
authorizationUrl

string

Optional. Endpoint for your sign-in web page that supports OAuth2 code or implicit flows. URL must use HTTPS. Only set when using OAuth.
tokenUrl

string

Optional. OAuth2 endpoint for token exchange. URL must use HTTPS. This is not set when only using OAuth with IMPLICIT grant as the linking type. Only set when using OAuth.
scopes[]

string

Optional. List of permissions the user must consent to in order to use your service. Only set when using OAuth. Make sure to provide a Terms of Service in the directory information in LocalizedSettings.terms_of_service_url section if specifying this field.
learnMoreUrl

string

Optional. This is the web page on your service which describes the permissions the user is granting to Google. Only set if using OAuth and Google Sign In. Make sure to provide a Terms of Service in the directory information in LocalizedSettings.terms_of_service_url section if specifying this field.
useBasicAuthHeader

boolean

Optional. If true, allow Google to transmit client ID and secret via HTTP basic auth header. Otherwise, Google uses the client ID and secret inside the post body. Only set when using OAuth. Make sure to provide a Terms of Service in the directory information in LocalizedSettings.terms_of_service_url section if specifying this field.