Get service observation

Action ID
actions.intent.GET_SERVICE_OBSERVATION
Description

Check usage information for a service provided to the user. Determine the service by its description using the serviceObservation.aboutService.description intent parameter. Then, determine the dimension or metric to report using the serviceObservation.measuredProperty.name parameter, if available. Finally, determine the time period in question for the metric using the serviceObservation.startTime and serviceObservation.endTime parameters, if available.

If a single service cannot be identified from parameters, ask the user to determine the service before proceeding.

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:

serviceObservation.measuredProperty.name

Other supported fields

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

serviceObservation.@type
serviceObservation.aboutService.@type
serviceObservation.aboutService.description
serviceObservation.startTime
serviceObservation.endTime
serviceObservation.measuredProperty.@type

Android widgets and slices

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





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_SERVICE_OBSERVATION">
    <intent
      android:action="android.intent.action.VIEW"
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <!-- Eg. endTime = "2011-12-20T05:00:00" -->
      <parameter
        android:name="serviceObservation.endTime"
        android:key="endTime"/>
      <!-- Eg. startTime = "2011-12-20T11:59:59" -->
      <parameter
        android:name="serviceObservation.startTime"
        android:key="startTime"/>
      <!-- Eg. name = "Phone usage." -->
      <parameter
        android:name="serviceObservation.measuredProperty.name"
        android:key="name"/>
      <!-- Eg. description = "Phone service line." -->
      <parameter
        android:name="serviceObservation.aboutService.description"
        android:key="description"/>
    </intent>
  </capability>
</shortcuts>
      

actions.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.GET_SERVICE_OBSERVATION">
    <fulfillment urlTemplate="myapp://custom-deeplink{?endTime,startTime,name,description}">
      <!-- e.g. endTime = "2011-12-20T05:00:00" -->
      <!-- (Optional) Require a field eg.endTime for fulfillment with required="true" -->
      <parameter-mapping urlParameter="endTime" intentParameter="serviceObservation.endTime" required="true" />
      <!-- e.g. startTime = "2011-12-20T11:59:59" -->
      <parameter-mapping urlParameter="startTime" intentParameter="serviceObservation.startTime" />
      <!-- e.g. name = "Phone usage." -->
      <parameter-mapping urlParameter="name" intentParameter="serviceObservation.measuredProperty.name" />
      <!-- e.g. description = "Phone service line." -->
      <parameter-mapping urlParameter="description" intentParameter="serviceObservation.aboutService.description" />
    </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

serviceObservation.measuredProperty.name is an intent parameter that supports inline inventory. By defining a <shortcut> for serviceObservation.measuredProperty.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 serviceObservation.measuredProperty.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_SERVICE_OBSERVATION">
    <intent
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <parameter
        android:name="serviceObservation.endTime"
        android:key="endTime"/>
      <parameter
        android:name="serviceObservation.startTime"
        android:key="startTime"/>
      <parameter
        android:name="serviceObservation.measuredProperty.name"
        android:key="name"/>
      <parameter
        android:name="serviceObservation.aboutService.description"
        android:key="description"/>
    </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_SERVICE_OBSERVATION">
        <parameter-binding
          android:value="name"
          android:key="serviceObservation.measuredProperty.name"/>
      </capability-binding>
    </shortcut>
</shortcuts>
      

actions.xml

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

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

    <!-- Define parameters with inventories here -->
    <parameter name="serviceObservation.measuredProperty.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.GET_SERVICE_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="serviceObservation.measuredProperty.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": "ServiceObservation",
  "aboutService": {
    "@type": "Service",
    "description": "Phone service line."
  },
  "endTime": "2011-12-20T05:00:00",
  "measuredProperty": {
    "@type": "Property",
    "name": "Phone usage."
  },
  "startTime": "2011-12-20T11:59:59"
}