Get game observation

Action ID
actions.intent.GET_GAME_OBSERVATION
Description
View game information, such as highest score or leaderboard. Determine the game statistic to view by game name using the gameObservation.game_observation.observedGame.name intent parameter. Then, show information by statistic name using the gameObservation.measuredProperty.name parameter, if available. Present statistics for the player name provided in the gameObservation.game_observation.players.name parameter.

Locale support

Functionality Locales
Preview creation using App Actions test tool en-US
User invocation from Google Assistant en-US

Example queries

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

gameObservation.about.name
gameObservation.measuredProperty.name

Other supported fields

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

gameObservation.@type
gameObservation.about.@type
gameObservation.about.competitor.@type
gameObservation.about.competitor.name
gameObservation.measuredProperty.@type

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_GAME_OBSERVATION">
    <intent
      android:action="android.intent.action.VIEW"
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <!-- Eg. aboutName = "Example Game Name" -->
      <parameter
        android:name="gameObservation.about.name"
        android:key="aboutName"/>
      <!-- Eg. measuredPropertyName = "Best score" -->
      <parameter
        android:name="gameObservation.measuredProperty.name"
        android:key="measuredPropertyName"/>
      <!-- Eg. competitorName = "Example player name" -->
      <parameter
        android:name="gameObservation.about.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.GET_GAME_OBSERVATION">
    <fulfillment urlTemplate="myapp://custom-deeplink{?aboutName,measuredPropertyName,competitorName}">
      <!-- e.g. aboutName = "Example Game Name" -->
      <!-- (Optional) Require a field eg.aboutName for fulfillment with required="true" -->
      <parameter-mapping urlParameter="aboutName" intentParameter="gameObservation.about.name" required="true" />
      <!-- e.g. measuredPropertyName = "Best score" -->
      <parameter-mapping urlParameter="measuredPropertyName" intentParameter="gameObservation.measuredProperty.name" />
      <!-- e.g. competitorName = "Example player name" -->
      <parameter-mapping urlParameter="competitorName" intentParameter="gameObservation.about.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

gameObservation.about.name is an intent parameter that supports inline inventory. By defining a <shortcut> for gameObservation.about.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 aboutName_one shortcut, Assistant provides the associated shorcut identifier, ID_ONE, as the URL parameter aboutName to fulfillment.

If there is no inventory match, the text value received in the query for gameObservation.about.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_GAME_OBSERVATION">
    <intent
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <parameter
        android:name="gameObservation.about.name"
        android:key="aboutName"/>
      <parameter
        android:name="gameObservation.measuredProperty.name"
        android:key="measuredPropertyName"/>
      <parameter
        android:name="gameObservation.about.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.GET_GAME_OBSERVATION">
        <parameter-binding
          android:value="aboutName"
          android:key="gameObservation.about.name"/>
      </capability-binding>
    </shortcut>
</shortcuts>
      

actions.xml

gameObservation.about.name is an intent parameter that supports inline inventory. By defining an <entity-set> for gameObservation.about.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 aboutName_one entity, Assistant provides the associated identifier, ID_ONE, as the URL parameter aboutName to fulfillment.

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

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

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

  <entity-set entitySetId="aboutNameEntitySet">
  <!-- Provide an identifier per entity -->
    <entity identifier="ID_ONE" name="aboutName_one" alternateName="@array/aboutName_one_synonyms"/>
    <entity identifier="ID_TWO" name="aboutName_two" alternateName="@array/aboutName_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 aboutName_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_GAME_OBSERVATION">
      <!-- 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="gameObservation.about.name">
        <entity-set-reference entitySetId="aboutNameEntitySet"/>
      </parameter>
    </action>

    <entity-set entitySetId="aboutNameEntitySet">
      <!-- Provide a URL per entity -->
      <entity url="myapp://deeplink/one" name="aboutName_one" alternateName="@array/aboutName_one_synonyms"/>
      <entity url="myapp://deeplink/two" name="aboutName_two" alternateName="@array/aboutName_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": "GameObservation",
  "about": {
    "@type": "GameEvent",
    "competitor": {
      "@type": "Person",
      "name": "Example player name"
    },
    "name": "Example Game Name"
  },
  "measuredProperty": {
    "@type": "Property",
    "name": "Best score"
  }
}