- Action ID
actions.intent.GET_EXERCISE_OBSERVATION
- Description
-
Present the calculated or observed value for a property of a physical activity the user has
performed (for example, the number of steps taken or the number of miles ran, biked, or hiked).
Determine the exercise observation using the
exerciseObservation.aboutExercise.name
intent parameter.
This built-in intent uses enumerated values for some parameters. Parameters that follow this
pattern are listed in
Supported text field values
below,
with the enumerated parameter values they support.
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
|
User invocation from Google Assistant
|
en-US, en-GB, en-CA, en-IN, en-BE, en-SG, en-AU
|
Example queries
en-US, en-GB, en-CA, en-IN, en-BE, en-SG, en-AU
- Ask ExampleProvider, "How many miles have I run today?"
- Ask ExampleProvider, "How many steps have I walked today?"
Recommended fields
The following fields represent essential information that users often
provide in queries that trigger this built-in intent:
exerciseObservation.aboutExercise.name
Other supported fields
The following fields represent information that users often provide to
disambiguate their needs or otherwise improve their results:
exerciseObservation.@type
exerciseObservation.aboutExercise.@type
exerciseObservation.endTime
exerciseObservation.measuredProperty.@type
exerciseObservation.measuredProperty.name
exerciseObservation.startTime
We recommend
implementing Android
widgets
for this built-in intent. A widget presents information or
interaction options from your app to improve user engagement in Google
Assistant. Widgets are available for App Actions implementations using
shortcuts.xml
.
If you have a legacy App Actions implementation using
actions.xml
, use
Android slices
instead. We recommend
migrating
your
implementation to
shortcuts.xml
to take advantage of widgets
fulfillment and other improvements.
Supported text values by field
exerciseObservation.@type
exerciseObservation.aboutExercise.@type
exerciseObservation.aboutExercise.name
- Aerobics
- Bench Press
- Biking
- Burpee
- Climbing
- Cross Fit
- Crunch
- Hiking
- Kayaking
- Lunge
- Other
- Plank
- Pull-up
- Push-up
- Rowing
- Running
- Sit-up
- Skiing
- Snow boarding
- Squat
- Stretching
- Surfing
- Swimming
- Walking
- Yoga
exerciseObservation.measuredProperty.@type
exerciseObservation.measuredProperty.name
- Calories
- Distance
- Elevation gain
- Floor
- Lap
- Pace
- Step
Inventory availability by field
exerciseObservation.aboutExercise.name
exerciseObservation.measuredProperty.name
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.GET_EXERCISE_OBSERVATION">
<intent
android:action="android.intent.action.VIEW"
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<!-- Eg. endTime = "2011-12-20T11:59:59" -->
<parameter
android:name="exerciseObservation.endTime"
android:key="endTime"/>
<!-- Eg. startTime = "2011-12-20T05:00:00" -->
<parameter
android:name="exerciseObservation.startTime"
android:key="startTime"/>
<!-- Eg. aboutExerciseName = "Climbing" -->
<parameter
android:name="exerciseObservation.aboutExercise.name"
android:key="aboutExerciseName"/>
<!-- Eg. measuredPropertyName = "Floor" -->
<parameter
android:name="exerciseObservation.measuredProperty.name"
android:key="measuredPropertyName"/>
</intent>
</capability>
</shortcuts>
actions.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.GET_EXERCISE_OBSERVATION">
<fulfillment urlTemplate="myapp://custom-deeplink{?endTime,startTime,aboutExerciseName,measuredPropertyName}">
<!-- e.g. endTime = "2011-12-20T11:59:59" -->
<!-- (Optional) Require a field eg.endTime for fulfillment with required="true" -->
<parameter-mapping urlParameter="endTime" intentParameter="exerciseObservation.endTime" required="true" />
<!-- e.g. startTime = "2011-12-20T05:00:00" -->
<parameter-mapping urlParameter="startTime" intentParameter="exerciseObservation.startTime" />
<!-- e.g. aboutExerciseName = "Climbing" -->
<parameter-mapping urlParameter="aboutExerciseName" intentParameter="exerciseObservation.aboutExercise.name" />
<!-- e.g. measuredPropertyName = "Floor" -->
<parameter-mapping urlParameter="measuredPropertyName" intentParameter="exerciseObservation.measuredProperty.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
exerciseObservation.aboutExercise.name
is an
intent parameter that supports
inline inventory
.
By defining a
<shortcut>
for
exerciseObservation.aboutExercise.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
aboutExerciseName_one
shortcut, Assistant provides the associated shorcut identifier,
ID_ONE
, as
the URL parameter
aboutExerciseName
to fulfillment.
If there is no inventory match, the text value received in the query for
exerciseObservation.aboutExercise.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_EXERCISE_OBSERVATION">
<intent
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<parameter
android:name="exerciseObservation.endTime"
android:key="endTime"/>
<parameter
android:name="exerciseObservation.startTime"
android:key="startTime"/>
<parameter
android:name="exerciseObservation.aboutExercise.name"
android:key="aboutExerciseName"/>
<parameter
android:name="exerciseObservation.measuredProperty.name"
android:key="measuredPropertyName"/>
</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_EXERCISE_OBSERVATION">
<parameter-binding
android:value="aboutExerciseName"
android:key="exerciseObservation.aboutExercise.name"/>
</capability-binding>
</shortcut>
</shortcuts>
actions.xml
exerciseObservation.aboutExercise.name
is an
intent parameter that supports
inline inventory
.
By defining an
<entity-set>
for
exerciseObservation.aboutExercise.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
aboutExerciseName_one
entity, Assistant provides the associated identifier,
ID_ONE
, as
the URL parameter
aboutExerciseName
to fulfillment.
If there is no inventory match, the text value received in the query for
exerciseObservation.aboutExercise.name
is passed
as-is.
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.GET_EXERCISE_OBSERVATION">
<fulfillment urlTemplate="myapp://deeplink{?aboutExerciseName}" >
<!-- aboutExerciseName = "ID_ONE" or "ID_TWO" -->
<!-- If no inventory match, aboutExerciseName is a text value, such as "Climbing" -->
<!-- (Optional) Use entityMatchRequired="true" to require inventory match for fulfillment -->
<parameter-mapping urlParameter="aboutExerciseName" intentParameter="exerciseObservation.aboutExercise.name" />
</fulfillment>
<!-- Define parameters with inventories here -->
<parameter name="exerciseObservation.aboutExercise.name">
<entity-set-reference entitySetId="aboutExerciseNameEntitySet"/>
</parameter>
</action>
<entity-set entitySetId="aboutExerciseNameEntitySet">
<!-- Provide an identifier per entity -->
<entity identifier="ID_ONE" name="aboutExerciseName_one" alternateName="@array/aboutExerciseName_one_synonyms"/>
<entity identifier="ID_TWO" name="aboutExerciseName_two" alternateName="@array/aboutExerciseName_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
aboutExerciseName_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_EXERCISE_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="exerciseObservation.aboutExercise.name">
<entity-set-reference entitySetId="aboutExerciseNameEntitySet"/>
</parameter>
</action>
<entity-set entitySetId="aboutExerciseNameEntitySet">
<!-- Provide a URL per entity -->
<entity url="myapp://deeplink/one" name="aboutExerciseName_one" alternateName="@array/aboutExerciseName_one_synonyms"/>
<entity url="myapp://deeplink/two" name="aboutExerciseName_two" alternateName="@array/aboutExerciseName_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": "ExerciseObservation",
"aboutExercise": {
"@type": "Exercise",
"name": "Climbing"
},
"endTime": "2011-12-20T11:59:59",
"measuredProperty": {
"@type": "Property",
"name": "Floor"
},
"startTime": "2011-12-20T05:00:00"
}