Get item list

Action ID
actions.intent.GET_ITEM_LIST
Description

Search and view personal lists and public collections. For example, you can get a collection of images from an album or get a list of to-do items. Filter the content to present the most relevant items to the user. Determine the name and topic (like food or animals) of the collection to view using the itemList.name and itemList.description intent parameters. Determine the type of collection (like album or shopping list) using the itemList.category intent parameter, if available.

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:

itemList.description
itemList.name

Other supported fields

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

itemList.@type
itemList.category

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 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_ITEM_LIST">
    <intent
      android:action="android.intent.action.VIEW"
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <!-- Eg. name = "Grocery List" -->
      <parameter
        android:name="itemList.name"
        android:key="name"/>
      <!-- Eg. category = "List" -->
      <parameter
        android:name="itemList.category"
        android:key="category"/>
      <!-- Eg. description = "For December" -->
      <parameter
        android:name="itemList.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_ITEM_LIST">
    <fulfillment urlTemplate="myapp://custom-deeplink{?name,category,description}">
      <!-- e.g. name = "Grocery List" -->
      <!-- (Optional) Require a field eg.name for fulfillment with required="true" -->
      <parameter-mapping urlParameter="name" intentParameter="itemList.name" required="true" />
      <!-- e.g. category = "List" -->
      <parameter-mapping urlParameter="category" intentParameter="itemList.category" />
      <!-- e.g. description = "For December" -->
      <parameter-mapping urlParameter="description" intentParameter="itemList.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 web inventory

itemList.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_ITEM_LIST">
    <intent
      android:action="android.intent.action.VIEW"
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <parameter android:name="itemList.name">
        <data android:pathPattern="https://www.mywebsite.com/link1/.*"/>
      </parameter>
      <parameter android:name="itemList.category">
        <data android:pathPattern="https://www.mywebsite.com/link2/.*"/>
      </parameter>
      <parameter android:name="itemList.description">
        <data android:pathPattern="https://www.mywebsite.com/link3/.*"/>
      </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_ITEM_LIST">
    <!-- 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="itemList.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": "ItemList",
  "category": "List",
  "description": "For December",
  "name": "Grocery List"
}
{
  "@context": "http://schema.googleapis.com",
  "@type": "ItemList",
  "category": "Album",
  "description": "food",
  "name": "Hawaii Trip"
}