- Action ID
actions.intent.GET_OFFER
- Description
- Search and view deals on goods or services. Search deals by item description and category using
the
offer.itemOffered.description
andoffer.category
intent parameters. Additionally filter deals by validity using theoffer.validThrough
intent parameter, if available.
Locale support
Functionality | Locales |
---|---|
Preview creation using App Actions test tool | en-US, pt-BR |
User invocation from Google Assistant | en-US, pt-BR |
Example queries
Recommended fields
The following fields represent essential information that users often provide in queries that trigger this built-in intent:
offer.itemOffered.description
offer.category
Other supported fields
The following fields represent information that users often provide to disambiguate their needs or otherwise improve their results:
offer.@type
offer.itemOffered.@type
offer.validThrough
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_OFFER">
<intent
android:action="android.intent.action.VIEW"
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<!-- Eg. category = "coupon" -->
<parameter
android:name="offer.category"
android:key="category"/>
<!-- Eg. validThrough = "2018-06-17T15:00Z" -->
<parameter
android:name="offer.validThrough"
android:key="validThrough"/>
<!-- Eg. description = "example description" -->
<parameter
android:name="offer.itemOffered.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_OFFER">
<fulfillment urlTemplate="myapp://custom-deeplink{?category,validThrough,description}">
<!-- e.g. category = "coupon" -->
<!-- (Optional) Require a field eg.category for fulfillment with required="true" -->
<parameter-mapping urlParameter="category" intentParameter="offer.category" required="true" />
<!-- e.g. validThrough = "2018-06-17T15:00Z" -->
<parameter-mapping urlParameter="validThrough" intentParameter="offer.validThrough" />
<!-- e.g. description = "example description" -->
<parameter-mapping urlParameter="description" intentParameter="offer.itemOffered.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
offer.category
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_OFFER">
<intent
android:action="android.intent.action.VIEW"
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<parameter android:name="offer.category">
<data android:pathPattern="https://www.mywebsite.com/link1/.*"/>
</parameter>
<parameter android:name="offer.validThrough">
<data android:pathPattern="https://www.mywebsite.com/link2/.*"/>
</parameter>
<parameter android:name="offer.itemOffered.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_OFFER">
<!-- 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="offer.category">
<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": "https://schema.org", "@type": "Offer", "category": "coupon", "itemOffered": { "@type": "Product", "description": "example description" }, "validThrough": "2018-06-17T15:00Z" } "http://schema.googleapis.com/ServiceTypeUtility"