Track exercise

Action ID

actions.intent.RECORD_EXERCISE

Description

Record a user's already completed fitness-related physical activity.

We recommend that you specify entities for exercise.name.

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

• Tell ExampleProvider to record that I ran for 30 minutes.
• Tell ExampleProvider to record that I did 10 push ups.
• Tell ExampleProvider to record that I hiked 10 miles.

Recommended fields

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

exercise.name

Other supported fields

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

exercise.@type
exercise.distance.@type
exercise.distance.unitText
exercise.distance.value
exercise.duration
exercise.repetitions

Supported text values by field

exercise.@type

• Exercise

exercise.distance.@type

• QuantitativeValue

exercise.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

Inventory availability by field

exercise.name

• Inline inventory

Foreground app invocation

This built-in intent supports foreground app invocation.

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

The following example queries are specific to intent matching for foreground app invocation:

en-US, en-GB, en-CA, en-IN, en-BE, en-SG, en-AU

• Record that I ran for 20 minutes.
• Record that I hiked 10 miles.

Sample XML files

For information about the shortcuts.xml schema, see Create shortcuts.xml.

Deprecation notice: Google is ending support for App Actions implemented using the actions.xml resource file. Please use the Actions.xml migration guide to update your actions to use the fully supported Android Shortcuts framework. For details on the Shortcuts framework, see App Actions overview.

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.RECORD_EXERCISE">
    <intent
      android:action="android.intent.action.VIEW"
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <!-- Eg. name = "Running" -->
      <parameter
        android:name="exercise.name"
        android:key="name"/>
      <!-- Eg. duration = "PT45M" -->
      <parameter
        android:name="exercise.duration"
        android:key="duration"/>
      <!-- Eg. repetitions = "20" -->
      <parameter
        android:name="exercise.repetitions"
        android:key="repetitions"/>
      <!-- Eg. value = "30" -->
      <parameter
        android:name="exercise.distance.value"
        android:key="value"/>
      <!-- Eg. unitText = "Mile" -->
      <parameter
        android:name="exercise.distance.unitText"
        android:key="unitText"/>
    </intent>
  </capability>
</shortcuts>
      

actions.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.RECORD_EXERCISE">
    <fulfillment urlTemplate="myapp://custom-deeplink{?name,duration,repetitions,value,unitText}">
      <!-- e.g. name = "Running" -->
      <!-- (Optional) Require a field eg.name for fulfillment with required="true" -->
      <parameter-mapping urlParameter="name" intentParameter="exercise.name" required="true" />
      <!-- e.g. duration = "PT45M" -->
      <parameter-mapping urlParameter="duration" intentParameter="exercise.duration" />
      <!-- e.g. repetitions = "20" -->
      <parameter-mapping urlParameter="repetitions" intentParameter="exercise.repetitions" />
      <!-- e.g. value = "30" -->
      <parameter-mapping urlParameter="value" intentParameter="exercise.distance.value" />
      <!-- e.g. unitText = "Mile" -->
      <parameter-mapping urlParameter="unitText" intentParameter="exercise.distance.unitText" />
    </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

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

If there is no inventory match, the text value received in the query for exercise.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.RECORD_EXERCISE">
    <intent
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <parameter
        android:name="exercise.name"
        android:key="name"/>
      <parameter
        android:name="exercise.duration"
        android:key="duration"/>
      <parameter
        android:name="exercise.repetitions"
        android:key="repetitions"/>
      <parameter
        android:name="exercise.distance.value"
        android:key="value"/>
      <parameter
        android:name="exercise.distance.unitText"
        android:key="unitText"/>
    </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.RECORD_EXERCISE">
        <parameter-binding
          android:value="name"
          android:key="exercise.name"/>
      </capability-binding>
    </shortcut>
</shortcuts>
      

actions.xml

exercise.name is an intent parameter that supports inline inventory. By defining an <entity-set> for exercise.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 exercise.name is passed as-is.

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

    <!-- Define parameters with inventories here -->
    <parameter name="exercise.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>

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.RECORD_EXERCISE">
      <!-- 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="exercise.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": "Exercise",
  "distance": {
    "@type": "QuantitativeValue",
    "unitText": "Mile",
    "value": "30"
  },
  "duration": "PT45M",
  "name": "Running",
  "repetitions": "20"
}