Get account

Action ID
actions.intent.GET_ACCOUNT
Description
Present a summary of the user's account in an app. Determine which account to view by name and description using the account.name and account.description intent parameters, if available. If an account cannot be identified using those parameters, ask the user to determine the account.

Locale support

Functionality Locales
Preview creation using App Actions test tool en-US, en-GB, en-CA, en-IN, en-BE, en-SG, en-AU, es-ES, pt-BR
User invocation from Google Assistant en-US, en-GB, en-CA, en-IN, en-BE, en-SG, en-AU, es-ES, pt-BR

Example queries

Other supported fields

The following fields represent information that users often provide to disambiguate their needs or otherwise improve their results:

account.@type
account.description
account.name
account.provider.@type
account.provider.name

Android Slices

We recommend implementing Android Slices for this built-in intent. An Android Slice presents information or interaction options from your app to improve user engagement in the Google Assistant.

Supported text values by field



Inventory availability by field


Sample XML files

For information about the actions.xml schema, see Create actions.xml. For information about the shortcuts.xml schema, see Create shorcuts.xml.

Handle BII parameters

shortcuts.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample shortcuts.xml -->
<shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
  <capability android:name="actions.intent.GET_ACCOUNT">
    <intent
      android:action="android.intent.action.VIEW"
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <!-- Eg. accountName = "utility" -->
      <parameter
        android:name="account.name"
        android:key="accountName"/>
      <!-- Eg. description = "Description of account" -->
      <parameter
        android:name="account.description"
        android:key="description"/>
      <!-- Eg. providerName = "Example Provider" -->
      <parameter
        android:name="account.provider.name"
        android:key="providerName"/>
    </intent>
  </capability>
</shortcuts>
      

actions.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.GET_ACCOUNT">
    <fulfillment urlTemplate="myapp://custom-deeplink{?accountName,description,providerName}">
      <!-- e.g. accountName = "utility" -->
      <!-- (Optional) Require a field eg.accountName for fulfillment with required="true" -->
      <parameter-mapping urlParameter="accountName" intentParameter="account.name" required="true" />
      <!-- e.g. description = "Description of account" -->
      <parameter-mapping urlParameter="description" intentParameter="account.description" />
      <!-- e.g. providerName = "Example Provider" -->
      <parameter-mapping urlParameter="providerName" intentParameter="account.provider.name" />
    </fulfillment>

    <!-- Provide a fallback fulfillment with no required parameters. For example, to your app search or router deeplink -->
    <fulfillment urlTemplate="myapp://deeplink" />
  </action>
</actions>

Use inline inventory

shortcuts.xml

account.name is an intent parameter that supports inline inventory. By defining a <shortcut> for account.name, you can uniquely identify entities that are of interest to your app or restrict fulfillment to the set of supported entities.

In the following example, when the user query matches the accountName_one shortcut, Assistant provides the associated shorcut identifier, ID_ONE, as the URL parameter accountName to fulfillment.

If there is no inventory match, the text value received in the query for account.name is passed as-is.

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample shortcuts.xml -->
<shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
  <capability android:name="actions.intent.GET_ACCOUNT">
    <intent
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <parameter
        android:name="account.name"
        android:key="accountName"/>
      <parameter
        android:name="account.description"
        android:key="description"/>
      <parameter
        android:name="account.provider.name"
        android:key="providerName"/>
    </intent>
    </capability>
    <!-- Short and long labels must be @string resource. -->
    <shortcut
      android:shortcutId="ID_ONE"
      android:shortcutShortLabel="@string/shortcut_short_label"
      android:shortcutLongLabel="@string/shortcut_long_label">
      <capability-binding android:key="actions.intent.GET_ACCOUNT">
        <parameter-binding
          android:value="accountName"
          android:key="account.name"/>
      </capability-binding>
    </shortcut>
</shortcuts>
      

actions.xml

account.name is an intent parameter that supports inline inventory. By defining an <entity-set> for account.name, you can uniquely identify entities that are of interest to your app or restrict fulfillment to the set of supported entities.

In the following example, when the user query matches the accountName_one entity, Assistant provides the associated identifier, ID_ONE, as the URL parameter accountName to fulfillment.

If there is no inventory match, the text value received in the query for account.name is passed as-is.

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.GET_ACCOUNT">
    <fulfillment urlTemplate="myapp://deeplink{?accountName}" >
      <!-- accountName = "ID_ONE" or "ID_TWO"  -->
      <!-- If no inventory match, accountName is a text value, such as "utility" -->
      <!-- (Optional) Use entityMatchRequired="true" to require inventory match for fulfillment -->
      <parameter-mapping urlParameter="accountName" intentParameter="account.name" />
    </fulfillment>

    <!-- Define parameters with inventories here -->
    <parameter name="account.name">
      <entity-set-reference entitySetId="accountNameEntitySet"/>
    </parameter>
  </action>

  <entity-set entitySetId="accountNameEntitySet">
  <!-- Provide an identifier per entity -->
    <entity identifier="ID_ONE" name="accountName_one" alternateName="@array/accountName_one_synonyms"/>
    <entity identifier="ID_TWO" name="accountName_two" alternateName="@array/accountName_two_synonyms"/>
  </entity-set>
</actions>

The url attribute associated with the entity can be used to determine the fulfillment URL if there is an inventory match. In the following example, when the user query matches the accountName_one entity, Assistant provides myapp://deeplink/one as the fulfillment URL.

  <?xml version="1.0" encoding="utf-8"?>
  <!-- This is a sample actions.xml -->
  <actions>
    <action intentName="actions.intent.GET_ACCOUNT">
      <!-- Use url from inventory match for deep link fulfillment -->
      <fulfillment urlTemplate="{@url}" />

      <!-- Provide a fallback fulfillment with no required parameters. For example, to your app search or router deeplink -->
      <fulfillment urlTemplate="myapp://deeplink" />

      <!-- Define parameters with inventories here -->
      <parameter name="account.name">
        <entity-set-reference entitySetId="accountNameEntitySet"/>
      </parameter>
    </action>

    <entity-set entitySetId="accountNameEntitySet">
      <!-- Provide a URL per entity -->
      <entity url="myapp://deeplink/one" name="accountName_one" alternateName="@array/accountName_one_synonyms"/>
      <entity url="myapp://deeplink/two" name="accountName_two" alternateName="@array/accountName_two_synonyms"/>
    </entity-set>
  </actions>
  

JSON-LD sample

The following JSON-LD sample provides some example values that you can use in the App Actions test tool:

{
  "@context": "http://schema.googleapis.com",
  "@type": "Account",
  "description": "Description of account",
  "name": "utility",
  "provider": {
    "@type": "Organization",
    "name": "Example Provider"
  }
}