- Action ID
actions.intent.GET_DIGITAL_DOCUMENT
- Description
-
Search and view existing documents or notes. Populate the search criteria using the details that best match your app's search functionality. For example, you can populate the document's description and creation date using the
digitalDocument.description
anddigitalDocument.dateCreated
intent parameters. Determine which document to return with the disambiguating description using thedigitalDocument.disambiguatingDescription
intent parameter.We also recommend integrating our partner solution enabling notes and list access through a native Assistant experience that works across a variety of Assistant-enabled devices.
Locale support
Functionality | Locales |
---|---|
Preview creation using App Actions test tool | en-US |
User invocation from Google Assistant | en-US |
Example queries
Recommended fields
The following fields represent essential information that users often provide in queries that trigger this built-in intent:
digitalDocument.author.name
digitalDocument.dateCreated
digitalDocument.description
digitalDocument.disambiguatingDescription
Other supported fields
The following fields represent information that users often provide to disambiguate their needs or otherwise improve their results:
digitalDocument.@type
digitalDocument.author.@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 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_DIGITAL_DOCUMENT">
<intent
android:action="android.intent.action.VIEW"
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<!-- Eg. dateCreated = "2011-12-20T23:59:59" -->
<parameter
android:name="digitalDocument.dateCreated"
android:key="dateCreated"/>
<!-- Eg. description = "New Document" -->
<parameter
android:name="digitalDocument.description"
android:key="description"/>
<!-- Eg. disambiguatingDescription = "Document" -->
<parameter
android:name="digitalDocument.disambiguatingDescription"
android:key="disambiguatingDescription"/>
<!-- Eg. name = "John Doe" -->
<parameter
android:name="digitalDocument.author.name"
android:key="name"/>
</intent>
</capability>
</shortcuts>
actions.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.GET_DIGITAL_DOCUMENT">
<fulfillment urlTemplate="myapp://custom-deeplink{?dateCreated,description,disambiguatingDescription,name}">
<!-- e.g. dateCreated = "2011-12-20T23:59:59" -->
<!-- (Optional) Require a field eg.dateCreated for fulfillment with required="true" -->
<parameter-mapping urlParameter="dateCreated" intentParameter="digitalDocument.dateCreated" required="true" />
<!-- e.g. description = "New Document" -->
<parameter-mapping urlParameter="description" intentParameter="digitalDocument.description" />
<!-- e.g. disambiguatingDescription = "Document" -->
<parameter-mapping urlParameter="disambiguatingDescription" intentParameter="digitalDocument.disambiguatingDescription" />
<!-- e.g. name = "John Doe" -->
<parameter-mapping urlParameter="name" intentParameter="digitalDocument.author.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
digitalDocument.disambiguatingDescription
is an
intent parameter that supports inline inventory.
By defining a <shortcut>
for digitalDocument.disambiguatingDescription
,
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
disambiguatingDescription_one
shortcut, Assistant provides the associated shorcut identifier, ID_ONE
, as
the URL parameter disambiguatingDescription
to fulfillment.
If there is no inventory match, the text value received in the query for
digitalDocument.disambiguatingDescription
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_DIGITAL_DOCUMENT">
<intent
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<parameter
android:name="digitalDocument.dateCreated"
android:key="dateCreated"/>
<parameter
android:name="digitalDocument.description"
android:key="description"/>
<parameter
android:name="digitalDocument.disambiguatingDescription"
android:key="disambiguatingDescription"/>
<parameter
android:name="digitalDocument.author.name"
android:key="name"/>
</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_DIGITAL_DOCUMENT">
<parameter-binding
android:value="disambiguatingDescription"
android:key="digitalDocument.disambiguatingDescription"/>
</capability-binding>
</shortcut>
</shortcuts>
actions.xml
digitalDocument.disambiguatingDescription
is an
intent parameter that supports inline inventory.
By defining an <entity-set>
for digitalDocument.disambiguatingDescription
,
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
disambiguatingDescription_one
entity, Assistant provides the associated identifier, ID_ONE
, as
the URL parameter disambiguatingDescription
to fulfillment.
If there is no inventory match, the text value received in the query for
digitalDocument.disambiguatingDescription
is passed
as-is.
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.GET_DIGITAL_DOCUMENT">
<fulfillment urlTemplate="myapp://deeplink{?disambiguatingDescription}" >
<!-- disambiguatingDescription = "ID_ONE" or "ID_TWO" -->
<!-- If no inventory match, disambiguatingDescription is a text value, such as "Document" -->
<!-- (Optional) Use entityMatchRequired="true" to require inventory match for fulfillment -->
<parameter-mapping urlParameter="disambiguatingDescription" intentParameter="digitalDocument.disambiguatingDescription" />
</fulfillment>
<!-- Define parameters with inventories here -->
<parameter name="digitalDocument.disambiguatingDescription">
<entity-set-reference entitySetId="disambiguatingDescriptionEntitySet"/>
</parameter>
</action>
<entity-set entitySetId="disambiguatingDescriptionEntitySet">
<!-- Provide an identifier per entity -->
<entity identifier="ID_ONE" name="disambiguatingDescription_one" alternateName="@array/disambiguatingDescription_one_synonyms"/>
<entity identifier="ID_TWO" name="disambiguatingDescription_two" alternateName="@array/disambiguatingDescription_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
disambiguatingDescription_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_DIGITAL_DOCUMENT">
<!-- 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="digitalDocument.disambiguatingDescription">
<entity-set-reference entitySetId="disambiguatingDescriptionEntitySet"/>
</parameter>
</action>
<entity-set entitySetId="disambiguatingDescriptionEntitySet">
<!-- Provide a URL per entity -->
<entity url="myapp://deeplink/one" name="disambiguatingDescription_one" alternateName="@array/disambiguatingDescription_one_synonyms"/>
<entity url="myapp://deeplink/two" name="disambiguatingDescription_two" alternateName="@array/disambiguatingDescription_two_synonyms"/>
</entity-set>
</actions>
Use web inventory
digitalDocument.description
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_DIGITAL_DOCUMENT">
<intent
android:action="android.intent.action.VIEW"
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<parameter android:name="digitalDocument.dateCreated">
<data android:pathPattern="https://www.mywebsite.com/link1/.*"/>
</parameter>
<parameter android:name="digitalDocument.description">
<data android:pathPattern="https://www.mywebsite.com/link2/.*"/>
</parameter>
<parameter android:name="digitalDocument.disambiguatingDescription">
<data android:pathPattern="https://www.mywebsite.com/link3/.*"/>
</parameter>
<parameter android:name="digitalDocument.author.name">
<data android:pathPattern="https://www.mywebsite.com/link4/.*"/>
</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_DIGITAL_DOCUMENT">
<!-- 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="digitalDocument.description">
<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.org", "@type": "DigitalDocument", "author": { "@type": "Person", "name": "John Doe" }, "dateCreated": "2011-12-20T23:59:59", "description": "New Document", "disambiguatingDescription": "Document" }