Get exercise plan

Action ID
actions.intent.GET_EXERCISE_PLAN
Description

Present a requested exercise plan to the user. Determine the name of the exercise plan and exercise type using the exercisePlan.name and exercisePlan.forExercise.name intent parameters.

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

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

exercisePlan.forExercise.name
exercisePlan.name

Other supported fields

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

exercisePlan.@type
exercisePlan.forExercise.@type

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.GET_EXERCISE_PLAN">
    <intent
      android:action="android.intent.action.VIEW"
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <!-- Eg. exercisePlanName = "ab" -->
      <parameter
        android:name="exercisePlan.name"
        android:key="exercisePlanName"/>
      <!-- Eg. forExerciseName = "Yoga" -->
      <parameter
        android:name="exercisePlan.forExercise.name"
        android:key="forExerciseName"/>
    </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_PLAN">
    <fulfillment urlTemplate="myapp://custom-deeplink{?exercisePlanName,forExerciseName}">
      <!-- e.g. exercisePlanName = "ab" -->
      <!-- (Optional) Require a field eg.exercisePlanName for fulfillment with required="true" -->
      <parameter-mapping urlParameter="exercisePlanName" intentParameter="exercisePlan.name" required="true" />
      <!-- e.g. forExerciseName = "Yoga" -->
      <parameter-mapping urlParameter="forExerciseName" intentParameter="exercisePlan.forExercise.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

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

If there is no inventory match, the text value received in the query for exercisePlan.forExercise.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_PLAN">
    <intent
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <parameter
        android:name="exercisePlan.name"
        android:key="exercisePlanName"/>
      <parameter
        android:name="exercisePlan.forExercise.name"
        android:key="forExerciseName"/>
    </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_PLAN">
      <parameter-binding
        android:value="forExerciseName"
        android:key="exercisePlan.forExercise.name"/>
    </capability-binding>
  </shortcut>
</shortcuts>

actions.xml

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

If there is no inventory match, the text value received in the query for exercisePlan.forExercise.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_PLAN">
    <fulfillment urlTemplate="myapp://deeplink{?forExerciseName}" >
      <!-- forExerciseName = "ID_ONE" or "ID_TWO"  -->
      <!-- If no inventory match, forExerciseName is a text value, such as "Yoga" -->
      <!-- (Optional) Use entityMatchRequired="true" to require inventory match for fulfillment -->
      <parameter-mapping urlParameter="forExerciseName" intentParameter="exercisePlan.forExercise.name" />
    </fulfillment>

    <!-- Define parameters with inventories here -->
    <parameter name="exercisePlan.forExercise.name">
      <entity-set-reference entitySetId="forExerciseNameEntitySet"/>
    </parameter>
  </action>

  <entity-set entitySetId="forExerciseNameEntitySet">
  <!-- Provide an identifier per entity -->
    <entity identifier="ID_ONE" name="forExerciseName_one" alternateName="@array/forExerciseName_one_synonyms"/>
    <entity identifier="ID_TWO" name="forExerciseName_two" alternateName="@array/forExerciseName_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 forExerciseName_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_PLAN">
      <!-- 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="exercisePlan.forExercise.name">
        <entity-set-reference entitySetId="forExerciseNameEntitySet"/>
      </parameter>
    </action>

    <entity-set entitySetId="forExerciseNameEntitySet">
      <!-- Provide a URL per entity -->
      <entity url="myapp://deeplink/one" name="forExerciseName_one" alternateName="@array/forExerciseName_one_synonyms"/>
      <entity url="myapp://deeplink/two" name="forExerciseName_two" alternateName="@array/forExerciseName_two_synonyms"/>
    </entity-set>
  </actions>

Use web inventory

exercisePlan.name is a field that supports web inventory. In the following example, Google Assistant performs a web search for the user query and determines the fulfillment URL. Assistant filters for search results that match the provided urlFilter value of https://www.mywebsite.com/link1/.*.

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_PLAN">
    <intent
      android:action="android.intent.action.VIEW"
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <parameter android:name="exercisePlan.name">
        <data android:pathPattern="https://www.mywebsite.com/link1/.*"/>
      </parameter>
      <parameter android:name="exercisePlan.forExercise.name">
        <data android:pathPattern="https://www.mywebsite.com/link2/.*"/>
      </parameter>
    </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_PLAN">
    <!-- Use URL from entity match for deep link fulfillment -->
    <!-- Example: url = 'https://www.mywebsite.com/link1/item1' -->
    <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 web inventories using urlFilter -->
    <parameter name="exercisePlan.name">
      <entity-set-reference urlFilter="https://www.mywebsite.com/link1/.*" />"/>
    </parameter>
  </action>
</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": "ExercisePlan",
  "forExercise": {
    "@type": "Exercise",
    "name": "Yoga"
  },
  "name": "ab"
}