- Action ID
actions.intent.START_GAME_EVENT
- Description
- Start an in-app game or specific level of a game. Determine the game by name using the
gameEvent.name
intent parameter. Determine the level using thegameEvent.disambiguatingDescription
parameter, if available. Assign name to additional players in the game using thegameEvent.competitor.name
parameter, if available.
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:
gameEvent.name
Other supported fields
The following fields represent information that users often provide to disambiguate their needs or otherwise improve their results:
gameEvent.@type
gameEvent.competitor.@type
gameEvent.competitor.name
gameEvent.disambiguatingDescription
Supported text values by field
Inventory availability by field
Sample XML files
For information about the shortcuts.xml
schema, see Create shortcuts.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.START_GAME_EVENT">
<intent
android:action="android.intent.action.VIEW"
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<!-- Eg. gameEventName = "Example game name" -->
<parameter
android:name="gameEvent.name"
android:key="gameEventName"/>
<!-- Eg. disambiguatingDescription = "Level 5" -->
<parameter
android:name="gameEvent.disambiguatingDescription"
android:key="disambiguatingDescription"/>
<!-- Eg. competitorName = "Example player name" -->
<parameter
android:name="gameEvent.competitor.name"
android:key="competitorName"/>
</intent>
</capability>
</shortcuts>
actions.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.START_GAME_EVENT">
<fulfillment urlTemplate="myapp://custom-deeplink{?gameEventName,disambiguatingDescription,competitorName}">
<!-- e.g. gameEventName = "Example game name" -->
<!-- (Optional) Require a field eg.gameEventName for fulfillment with required="true" -->
<parameter-mapping urlParameter="gameEventName" intentParameter="gameEvent.name" required="true" />
<!-- e.g. disambiguatingDescription = "Level 5" -->
<parameter-mapping urlParameter="disambiguatingDescription" intentParameter="gameEvent.disambiguatingDescription" />
<!-- e.g. competitorName = "Example player name" -->
<parameter-mapping urlParameter="competitorName" intentParameter="gameEvent.competitor.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
gameEvent.name
is an
intent parameter that supports inline inventory.
By defining a <shortcut>
for gameEvent.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
gameEventName_one
shortcut, Assistant provides the associated shorcut identifier, ID_ONE
, as
the URL parameter gameEventName
to fulfillment.
If there is no inventory match, the text value received in the query for
gameEvent.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.START_GAME_EVENT">
<intent
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<parameter
android:name="gameEvent.name"
android:key="gameEventName"/>
<parameter
android:name="gameEvent.disambiguatingDescription"
android:key="disambiguatingDescription"/>
<parameter
android:name="gameEvent.competitor.name"
android:key="competitorName"/>
</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.START_GAME_EVENT">
<parameter-binding
android:value="gameEventName"
android:key="gameEvent.name"/>
</capability-binding>
</shortcut>
</shortcuts>
actions.xml
gameEvent.name
is an
intent parameter that supports inline inventory.
By defining an <entity-set>
for gameEvent.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
gameEventName_one
entity, Assistant provides the associated identifier, ID_ONE
, as
the URL parameter gameEventName
to fulfillment.
If there is no inventory match, the text value received in the query for
gameEvent.name
is passed
as-is.
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.START_GAME_EVENT">
<fulfillment urlTemplate="myapp://deeplink{?gameEventName}" >
<!-- gameEventName = "ID_ONE" or "ID_TWO" -->
<!-- If no inventory match, gameEventName is a text value, such as "Example game name" -->
<!-- (Optional) Use entityMatchRequired="true" to require inventory match for fulfillment -->
<parameter-mapping urlParameter="gameEventName" intentParameter="gameEvent.name" />
</fulfillment>
<!-- Define parameters with inventories here -->
<parameter name="gameEvent.name">
<entity-set-reference entitySetId="gameEventNameEntitySet"/>
</parameter>
</action>
<entity-set entitySetId="gameEventNameEntitySet">
<!-- Provide an identifier per entity -->
<entity identifier="ID_ONE" name="gameEventName_one" alternateName="@array/gameEventName_one_synonyms"/>
<entity identifier="ID_TWO" name="gameEventName_two" alternateName="@array/gameEventName_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
gameEventName_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.START_GAME_EVENT">
<!-- 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="gameEvent.name">
<entity-set-reference entitySetId="gameEventNameEntitySet"/>
</parameter>
</action>
<entity-set entitySetId="gameEventNameEntitySet">
<!-- Provide a URL per entity -->
<entity url="myapp://deeplink/one" name="gameEventName_one" alternateName="@array/gameEventName_one_synonyms"/>
<entity url="myapp://deeplink/two" name="gameEventName_two" alternateName="@array/gameEventName_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": "GameEvent", "competitor": { "@type": "Person", "name": "Example player name" }, "disambiguatingDescription": "Level 5", "name": "Example game name" }