Record food or nutrition consumption

Action ID
actions.intent.RECORD_FOOD_OBSERVATION
Description

Record a user's action of consuming food, beverage, or nutrients (such as protein).

We recommend that you specify entities for foodObservation.aboutNutrient.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

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

foodObservation.aboutFood.name
foodObservation.aboutNutrient.name

Other supported fields

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

foodObservation.@type
foodObservation.aboutFood.@type
foodObservation.aboutNutrient.@type
foodObservation.endTime
foodObservation.forMeal
foodObservation.startTime
foodObservation.value.@type
foodObservation.value.unitText
foodObservation.value.value

Supported text values by field







Inventory availability by field



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:

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.RECORD_FOOD_OBSERVATION">
    <intent
      android:action="android.intent.action.VIEW"
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <!-- Eg. endTime = "2011-12-20T23:59:59" -->
      <parameter
        android:name="foodObservation.endTime"
        android:key="endTime"/>
      <!-- Eg. forMeal = "http://schema.googleapis.com/MealTypeLunch" -->
      <parameter
        android:name="foodObservation.forMeal"
        android:key="forMeal"/>
      <!-- Eg. startTime = "2011-12-20T00:00:00" -->
      <parameter
        android:name="foodObservation.startTime"
        android:key="startTime"/>
      <!-- Eg. value = "6" -->
      <parameter
        android:name="foodObservation.value.value"
        android:key="value"/>
      <!-- Eg. aboutFoodName = "Rice" -->
      <parameter
        android:name="foodObservation.aboutFood.name"
        android:key="aboutFoodName"/>
      <!-- Eg. unitText = "Ounce" -->
      <parameter
        android:name="foodObservation.value.unitText"
        android:key="unitText"/>
      <!-- Eg. aboutNutrientName = "Calcium" -->
      <parameter
        android:name="foodObservation.aboutNutrient.name"
        android:key="aboutNutrientName"/>
    </intent>
  </capability>
</shortcuts>

actions.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.RECORD_FOOD_OBSERVATION">
    <fulfillment urlTemplate="myapp://custom-deeplink{?endTime,forMeal,startTime,value,aboutFoodName,unitText,aboutNutrientName}">
      <!-- e.g. endTime = "2011-12-20T23:59:59" -->
      <!-- (Optional) Require a field eg.endTime for fulfillment with required="true" -->
      <parameter-mapping urlParameter="endTime" intentParameter="foodObservation.endTime" required="true" />
      <!-- e.g. forMeal = "http://schema.googleapis.com/MealTypeLunch" -->
      <parameter-mapping urlParameter="forMeal" intentParameter="foodObservation.forMeal" />
      <!-- e.g. startTime = "2011-12-20T00:00:00" -->
      <parameter-mapping urlParameter="startTime" intentParameter="foodObservation.startTime" />
      <!-- e.g. value = "6" -->
      <parameter-mapping urlParameter="value" intentParameter="foodObservation.value.value" />
      <!-- e.g. aboutFoodName = "Rice" -->
      <parameter-mapping urlParameter="aboutFoodName" intentParameter="foodObservation.aboutFood.name" />
      <!-- e.g. unitText = "Ounce" -->
      <parameter-mapping urlParameter="unitText" intentParameter="foodObservation.value.unitText" />
      <!-- e.g. aboutNutrientName = "Calcium" -->
      <parameter-mapping urlParameter="aboutNutrientName" intentParameter="foodObservation.aboutNutrient.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

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

If there is no inventory match, the text value received in the query for foodObservation.aboutFood.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_FOOD_OBSERVATION">
    <intent
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <parameter
        android:name="foodObservation.endTime"
        android:key="endTime"/>
      <parameter
        android:name="foodObservation.forMeal"
        android:key="forMeal"/>
      <parameter
        android:name="foodObservation.startTime"
        android:key="startTime"/>
      <parameter
        android:name="foodObservation.value.value"
        android:key="value"/>
      <parameter
        android:name="foodObservation.aboutFood.name"
        android:key="aboutFoodName"/>
      <parameter
        android:name="foodObservation.value.unitText"
        android:key="unitText"/>
      <parameter
        android:name="foodObservation.aboutNutrient.name"
        android:key="aboutNutrientName"/>
    </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_FOOD_OBSERVATION">
        <parameter-binding
          android:value="aboutFoodName"
          android:key="foodObservation.aboutFood.name"/>
      </capability-binding>
    </shortcut>
</shortcuts>

actions.xml

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

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

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

    <!-- Define parameters with inventories here -->
    <parameter name="foodObservation.aboutFood.name">
      <entity-set-reference entitySetId="aboutFoodNameEntitySet"/>
    </parameter>
  </action>

  <entity-set entitySetId="aboutFoodNameEntitySet">
  <!-- Provide an identifier per entity -->
    <entity identifier="ID_ONE" name="aboutFoodName_one" alternateName="@array/aboutFoodName_one_synonyms"/>
    <entity identifier="ID_TWO" name="aboutFoodName_two" alternateName="@array/aboutFoodName_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 aboutFoodName_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_FOOD_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="foodObservation.aboutFood.name">
        <entity-set-reference entitySetId="aboutFoodNameEntitySet"/>
      </parameter>
    </action>

    <entity-set entitySetId="aboutFoodNameEntitySet">
      <!-- Provide a URL per entity -->
      <entity url="myapp://deeplink/one" name="aboutFoodName_one" alternateName="@array/aboutFoodName_one_synonyms"/>
      <entity url="myapp://deeplink/two" name="aboutFoodName_two" alternateName="@array/aboutFoodName_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": "FoodObservation",
  "aboutFood": {
    "@type": "Food",
    "name": "Rice"
  },
  "aboutNutrient": {
    "@type": "Nutrient",
    "name": "Calcium"
  },
  "endTime": "2011-12-20T23:59:59",
  "forMeal": "http://schema.googleapis.com/MealTypeLunch",
  "startTime": "2011-12-20T00:00:00",
  "value": {
    "@type": "QuantitativeValue",
    "unitText": "Ounce",
    "value": "6"
  }
}