- Action ID
actions.intent.GET_REVIEW
- Description
- Search and view reviews for products, locations, content, or other things. Populate the search
criteria using the details that best match your app's search functionality. For example, you can
populate the name, brand name, and rating value using the
review.itemReviewed.name
,review.itemReviewed.brand.name
, andreview.reviewRating.ratingValue
intent parameters.
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:
review.itemReviewed.@type
review.itemReviewed.brand.name
review.itemReviewed.description
review.itemReviewed.name
review.reviewRating.ratingValue
Other supported fields
The following fields represent information that users often provide to disambiguate their needs or otherwise improve their results:
review.@type
review.itemReviewed.brand.@type
review.itemReviewed.disambiguatingDescription
review.reviewRating.@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_REVIEW">
<intent
android:action="android.intent.action.VIEW"
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<!-- Eg. name = "Item name" -->
<parameter
android:name="review.itemReviewed.name"
android:key="name"/>
<!-- Eg. description = "description of item reviewed" -->
<parameter
android:name="review.itemReviewed.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_REVIEW">
<fulfillment urlTemplate="myapp://custom-deeplink{?name,description}">
<!-- e.g. name = "Item name" -->
<!-- (Optional) Require a field eg.name for fulfillment with required="true" -->
<parameter-mapping urlParameter="name" intentParameter="review.itemReviewed.name" required="true" />
<!-- e.g. description = "description of item reviewed" -->
<parameter-mapping urlParameter="description" intentParameter="review.itemReviewed.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
review.itemReviewed.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_REVIEW">
<intent
android:action="android.intent.action.VIEW"
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<parameter android:name="review.itemReviewed.name">
<data android:pathPattern="https://www.mywebsite.com/link1/.*"/>
</parameter>
<parameter android:name="review.itemReviewed.description">
<data android:pathPattern="https://www.mywebsite.com/link2/.*"/>
</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_REVIEW">
<!-- 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="review.itemReviewed.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.org", "@type": "Review", "itemReviewed": { "@type": "Thing", "description": "description of item reviewed", "name": "Item name" } } { "@context": "http://schema.org", "@type": "Review", "itemReviewed": { "@type": "Product", "brand": { "@type": "Brand", "name": "Brand name" }, "description": "description of item reviewed", "name": "Grinder" }, "reviewRating": { "@type": "Rating", "ratingValue": "3" } } { "@context": "http://schema.org", "@type": "Review", "itemReviewed": { "@type": "MediaObject", "disambiguatingDescription": "Movie", "name": "Example Movie Name" } }