- 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 Slices
We recommend implementing Android Slices for this built-in intent. An Android Slice presents information or interaction options from your app to improve user engagement in the Google Assistant.
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.GET_REVIEW">
<fulfillment urlTemplate="myapp://custom-deeplink{?name,description}">
<!-- Eg. name = "Item name" -->
<!-- (Optional) Require a field eg.name for fulfillment with required="true" -->
<parameter-mapping urlParameter="name" intentParameter="review.itemReviewed.name" required="true" />
<!-- Eg. 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 to discover URLs for fulfillment
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/.*
.
<?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" } }