- Action ID
actions.intent.UPDATE_ACCOUNT
- Description
-
Add, update, or remove a service (such as a premium subscription service) from a user's account. Determine the service by name and description using the
account.serviceType.name
intent parameter and (if available) theaccount.serviceType.description
parameter.Your app must confirm with the user before adding services to the account.
Locale support
Functionality | Locales |
---|---|
Preview creation using App Actions test tool | en-US |
User invocation from Google Assistant | en-US |
Example queries
Recommended fields
The following fields represent essential information that users often provide in queries that trigger this built-in intent:
account.serviceType.name
alteration
Other supported fields
The following fields represent information that users often provide to disambiguate their needs or otherwise improve their results:
account.@type
account.serviceType.@type
account.serviceType.description
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.UPDATE_ACCOUNT">
<fulfillment urlTemplate="myapp://custom-deeplink{?alterationParam,name,description}">
<!-- Eg. alterationParam = "Modify" -->
<!-- (Optional) Require a field eg.alterationParam for fulfillment with required="true" -->
<parameter-mapping urlParameter="alterationParam" intentParameter="alteration" required="true" />
<!-- Eg. name = "Examplify" -->
<parameter-mapping urlParameter="name" intentParameter="account.serviceType.name" />
<!-- Eg. description = "Music streaming service" -->
<parameter-mapping urlParameter="description" intentParameter="account.serviceType.description" />
</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
account.serviceType.name
is a
field that supports inline inventory.
By defining an <entity-set>
for account.serviceType.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
name_one
entity, Assistant provides the associated identifier, ID_ONE
, as
the URL parameter name
to fulfillment.
If there is no inventory match, the text value received in the query for
account.serviceType.name
is passed
as-is.
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.UPDATE_ACCOUNT">
<fulfillment urlTemplate="myapp://deeplink{?name}" >
<!-- name = "ID_ONE" or "ID_TWO" -->
<!-- If no inventory match, name is a text value, such as "Examplify" -->
<!-- (Optional) Use entityMatchRequired="true" to require inventory match for fulfillment -->
<parameter-mapping urlParameter="name" intentParameter="account.serviceType.name" />
</fulfillment>
<!-- Define parameters with inventories here -->
<parameter name="account.serviceType.name">
<entity-set-reference entitySetId="nameEntitySet"/>
</parameter>
</action>
<entity-set entitySetId="nameEntitySet">
<!-- Provide an identifier per entity -->
<entity identifier="ID_ONE" name="name_one" alternateName="@array/name_one_synonyms"/>
<entity identifier="ID_TWO" name="name_two" alternateName="@array/name_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
name_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.UPDATE_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.serviceType.name">
<entity-set-reference entitySetId="nameEntitySet"/>
</parameter>
</action>
<entity-set entitySetId="nameEntitySet">
<!-- Provide a URL per entity -->
<entity url="myapp://deeplink/one" name="name_one" alternateName="@array/name_one_synonyms"/>
<entity url="myapp://deeplink/two" name="name_two" alternateName="@array/name_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", "serviceType": { "@type": "ServiceCategory", "description": "Music streaming service", "name": "Examplify" } } "Modify"