Get financial position

Action ID
actions.intent.GET_FINANCIAL_POSITION
Description
Present information about a particular financial position held by the user. Determine the financial position using the financialPosition.hasAsset.assetIssuedBy.name intent parameter. Determine the account holding the position using the financialPosition.heldInAccount.name intent parameter, if available.

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

The following fields represent essential information that users often provide in queries that trigger this built-in intent:

financialPosition.hasAsset.assetIssuedBy.name

Other supported fields

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

financialPosition.@type
financialPosition.hasAsset.@type
financialPosition.hasAsset.assetIssuedBy.@type
financialPosition.hasAsset.exchangeCode
financialPosition.hasAsset.tickerSymbol
financialPosition.heldInAccount.@type
financialPosition.heldInAccount.name
financialPosition.heldInAccount.provider.@type
financialPosition.heldInAccount.provider.name

Supported text values by field






Inventory availability by field





Sample actions.xml

For information about the actions schema, read Create actions.xml.

Handle intent parameters as URL parameters

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.GET_FINANCIAL_POSITION">
    <fulfillment urlTemplate="myapp://custom-deeplink{?heldInAccountName,exchangeCode,tickerSymbol,assetIssuedByName,providerName}">
      <!-- Eg. heldInAccountName = "401K" -->
      <!-- (Optional) Require a field eg.heldInAccountName for fulfillment with required="true" -->
      <parameter-mapping urlParameter="heldInAccountName" intentParameter="financialPosition.heldInAccount.name" required="true" />
      <!-- Eg. exchangeCode = "NASDAQ" -->
      <parameter-mapping urlParameter="exchangeCode" intentParameter="financialPosition.hasAsset.exchangeCode" />
      <!-- Eg. tickerSymbol = "GOOGL" -->
      <parameter-mapping urlParameter="tickerSymbol" intentParameter="financialPosition.hasAsset.tickerSymbol" />
      <!-- Eg. assetIssuedByName = "Alphabet" -->
      <parameter-mapping urlParameter="assetIssuedByName" intentParameter="financialPosition.hasAsset.assetIssuedBy.name" />
      <!-- Eg. providerName = "Example Provider" -->
      <parameter-mapping urlParameter="providerName" intentParameter="financialPosition.heldInAccount.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 to guide query matching

financialPosition.heldInAccount.name is a field that supports inline inventory. By defining an <entity-set> for financialPosition.heldInAccount.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 heldInAccountName_one entity, Assistant provides the associated identifier, ID_ONE, as the URL parameter heldInAccountName to fulfillment.

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

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

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

  <entity-set entitySetId="heldInAccountNameEntitySet">
    <!-- Provide an identifier per entity -->
    <entity identifier="ID_ONE" name="heldInAccountName_one" alternateName="@array/heldInAccountName_one_synonyms"/>
    <entity identifier="ID_TWO" name="heldInAccountName_two" alternateName="@array/heldInAccountName_two_synonyms"/>
  </entity-set>
</actions>

Derive fulfillment URL using inline inventory

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 heldInAccountName_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_FINANCIAL_POSITION">
      <!-- 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="financialPosition.heldInAccount.name">
        <entity-set-reference entitySetId="heldInAccountNameEntitySet"/>
      </parameter>
    </action>

    <entity-set entitySetId="heldInAccountNameEntitySet">
      <!-- Provide a URL per entity -->
      <entity url="myapp://deeplink/one" name="heldInAccountName_one" alternateName="@array/heldInAccountName_one_synonyms"/>
      <entity url="myapp://deeplink/two" name="heldInAccountName_two" alternateName="@array/heldInAccountName_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": "FinancialPosition",
  "hasAsset": {
    "@type": "TradableFinancialAsset",
    "assetIssuedBy": {
      "@type": "Corporation",
      "name": "Alphabet"
    },
    "exchangeCode": "NASDAQ",
    "tickerSymbol": "GOOGL"
  },
  "heldInAccount": {
    "@type": "BrokerageAccount",
    "name": "401K",
    "provider": {
      "@type": "Organization",
      "name": "Example Provider"
    }
  }
}