Create digital document

Action ID
actions.intent.CREATE_DIGITAL_DOCUMENT
Description

Construct a new document or note. Populate the new document or note with a document name using the digitalDocument.name intent parameter. For notes, also populate the body content using the digitalDocument.articleBody 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

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

digitalDocument.articleBody
digitalDocument.disambiguatingDescription
digitalDocument.name

Other supported fields

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

digitalDocument.@type
digitalDocument.description

Supported text values by field



Inventory availability by field


Sample actions.xml

For information about the actions schema, read Create actions.xml.

Handle intent parameters as URL parameters

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.CREATE_DIGITAL_DOCUMENT">
    <fulfillment urlTemplate="myapp://custom-deeplink{?name,articleBody,description,disambiguatingDescription}">
      <!-- Eg. name = "Product Requirement Document" -->
      <!-- (Optional) Require a field eg.name for fulfillment with required="true" -->
      <parameter-mapping urlParameter="name" intentParameter="digitalDocument.name" required="true" />
      <!-- Eg. articleBody = "article text" -->
      <parameter-mapping urlParameter="articleBody" intentParameter="digitalDocument.articleBody" />
      <!-- Eg. description = "New Document" -->
      <parameter-mapping urlParameter="description" intentParameter="digitalDocument.description" />
      <!-- Eg. disambiguatingDescription = "Document" -->
      <parameter-mapping urlParameter="disambiguatingDescription" intentParameter="digitalDocument.disambiguatingDescription" />
    </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 to guide query matching

digitalDocument.disambiguatingDescription is a field 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.CREATE_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>

Derive fulfillment URL using inline inventory

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.CREATE_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>

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",
  "articleBody": "article text",
  "description": "New Document",
  "disambiguatingDescription": "Document",
  "name": "Product Requirement Document"
}