Built-in intents model some of the common ways that users express tasks they're trying to do or information they seek, such as ordering a meal, booking a ride, or checking an account balance.
You can use these built-in intents to build App Actions, but we are still fine tuning Action discovery and ranking. Note that built-in intents intended for conversational Actions won't work for App Actions and vice versa.
- If you are building App Actions, implement and test the relevant built-in intents for your app so that users can trigger them from the Assistant when this functionality becomes available. To learn more about using and testing these intents, see the Built-in intent guidelines for App Actions.
- If you are building conversational Actions, see the conversational Actions built-in intent reference instead.
Finance
Create money transfer
- Action ID
actions.intent.CREATE_MONEY_TRANSFER
- Description
- Start a money transfer.
- Example queries
- Supported fields
moneyTransfer.@context
moneyTransfer.@type
moneyTransfer.amount.@type
moneyTransfer.amount.currency
moneyTransfer.amount.value
moneyTransfer.moneyTransferDestination.@type
moneyTransfer.moneyTransferDestination.name
moneyTransfer.moneyTransferDestination.provider.@type
moneyTransfer.moneyTransferDestination.provider.name
moneyTransfer.moneyTransferOrigin.@type
moneyTransfer.moneyTransferOrigin.name
moneyTransfer.moneyTransferOrigin.provider.@type
moneyTransfer.moneyTransferOrigin.provider.name
moneyTransfer.transferMode
- Supported text field values
-
moneyTransfer.transferMode
(http://schema.googleapis.com/ReceiveMoney, http://schema.googleapis.com/SendMoney)
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "MoneyTransfer", "amount": { "@type": "MonetaryAmount", "currency": "USD", "value": "100" }, "moneyTransferDestination": { "@type": "Service", "name": "Savings account", "provider": { "@type": "Organization", "name": "Example Provider" } }, "moneyTransferOrigin": { "@type": "Service", "name": "Credit card", "provider": { "@type": "Organization", "name": "Example Provider" } }, "transferMode": "http://schema.googleapis.com/ReceiveMoney" } ], "name": "moneyTransfer", "schemaType": [ "http://schema.googleapis.com/MoneyTransfer" ] } ]
Create trade order
- Action ID
actions.intent.CREATE_TRADE_ORDER
- Description
- Create a trade order
- Example queries
- Supported fields
tradeOrder.@context
tradeOrder.@type
tradeOrder.assetOrdered.@type
tradeOrder.assetOrdered.assetIssuedBy.@type
tradeOrder.assetOrdered.assetIssuedBy.name
tradeOrder.assetOrdered.exchangeCode
tradeOrder.assetOrdered.tickerSymbol
tradeOrder.numberOfUnits.@type
tradeOrder.numberOfUnits.value
tradeOrder.typeOfOrder
tradeOrder.typeOfTrade
- Supported text field values
-
tradeOrder.typeOfOrder
(http://schema.googleapis.com/FinancialOrderTypeLimit, http://schema.googleapis.com/FinancialOrderTypeMarket, http://schema.googleapis.com/FinancialOrderTypeStop, http://schema.googleapis.com/FinancialOrderTypeStopLimit)
tradeOrder.typeOfTrade
(http://schema.googleapis.com/TradeTypeBuy, http://schema.googleapis.com/TradeTypeSell)
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "TradeOrder", "assetOrdered": { "@type": "TradableFinancialAsset", "assetIssuedBy": { "@type": "Corporation", "name": "Alphabet" }, "exchangeCode": "NASDAQ", "tickerSymbol": "GOOGL" }, "numberOfUnits": { "@type": "QuantitativeValue", "value": "100" }, "typeOfOrder": "http://schema.googleapis.com/FinancialOrderTypeLimit", "typeOfTrade": "http://schema.googleapis.com/TradeTypeSell" } ], "name": "tradeOrder", "schemaType": [ "http://schema.googleapis.com/TradeOrder" ] } ]
Get account
- Action ID
actions.intent.GET_ACCOUNT
- Description
- Get account information for a specified account
- Example queries
- Supported fields
account.@context
account.@type
account.name
account.provider.@type
account.provider.name
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "Account", "name": "utility", "provider": { "@type": "Organization", "name": "Example Provider" } } ], "name": "account", "schemaType": [ "http://schema.googleapis.com/Account" ] } ]
Get financial position
- Action ID
actions.intent.GET_FINANCIAL_POSITION
- Description
- Get financial position
- Example queries
- Supported fields
financialPosition.@context
financialPosition.@type
financialPosition.hasAsset.@type
financialPosition.hasAsset.assetIssuedBy.@type
financialPosition.hasAsset.assetIssuedBy.name
financialPosition.hasAsset.exchangeCode
financialPosition.hasAsset.tickerSymbol
financialPosition.heldInAccount.@type
financialPosition.heldInAccount.name
financialPosition.heldInAccount.provider.@type
financialPosition.heldInAccount.provider.name
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "FinancialPosition", "hasAsset": { "@type": "TradableFinancialAsset", "assetIssuedBy": { "@type": "Corporation", "name": "Alphabet" }, "exchangeCode": "NASDAQ", "tickerSymbol": "GOOGL" }, "heldInAccount": { "@type": "BrokerageAccount", "name": "401K", "provider": { "@type": "Organization", "name": "Example Provider" } } } ], "name": "financialPosition", "schemaType": [ "http://schema.googleapis.com/FinancialPosition" ] } ]
Get invoice
- Action ID
actions.intent.GET_INVOICE
- Description
- Get an invoice
- Example queries
- Supported fields
invoice.@context
invoice.@type
invoice.forService.@type
invoice.forService.name
invoice.forService.provider.@type
invoice.forService.provider.name
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "Invoice", "forService": { "@type": "Service", "name": "Utility", "provider": { "@type": "Organization", "name": "Example Provider" } } } ], "name": "invoice", "schemaType": [ "http://schema.googleapis.com/Invoice" ] } ]
Get stock quotes
- Action ID
actions.intent.GET_STOCK_QUOTE
- Description
- Get stock quotes
- Example queries
- Supported fields
tickerSymbol
- JSON-LD sample
[ { "exampleValues": [ "GOOGL" ], "name": "tickerSymbol", "schemaType": [] } ]
Pay invoice
- Action ID
actions.intent.PAY_INVOICE
- Description
- Pay an invoice
- Example queries
- Supported fields
amount.@context
amount.@type
amount.currency
amount.value
invoice.@context
invoice.@type
invoice.forService.@type
invoice.forService.name
invoice.forService.provider.@type
invoice.forService.provider.name
invoice.paymentMethodId
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.org", "@type": "MonetaryAmount", "currency": "USD", "value": "20" } ], "name": "invoice", "schemaType": [ "http://schema.org/MonetaryAmount" ] }, { "exampleValues": [ { "@context": "http://schema.org", "@type": "MonetaryAmount", "currency": "USD", "value": "20" } ], "name": "amount", "schemaType": [ "http://schema.org/MonetaryAmount" ] } ]
Food and drink
Order menu item
- Action ID
actions.intent.ORDER_MENU_ITEM
- Description
- Order food from a restaurant.
- Example queries
- Supported fields
menuItem.@context
menuItem.@type
menuItem.inMenuSection.@type
menuItem.inMenuSection.inMenu.@type
menuItem.inMenuSection.inMenu.name
menuItem.inMenuSection.inMenu.forRestaurant.@type
menuItem.inMenuSection.inMenu.forRestaurant.location.@type
menuItem.inMenuSection.inMenu.forRestaurant.location.geo.@type
menuItem.inMenuSection.inMenu.forRestaurant.location.geo.latitude
menuItem.inMenuSection.inMenu.forRestaurant.location.geo.longitude
menuItem.inMenuSection.inMenu.forRestaurant.location.name
menuItem.inMenuSection.inMenu.forRestaurant.name
menuItem.inMenuSection.inMenu.forRestaurant.servesCuisine
menuItem.inMenuSection.name
menuItem.name
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "MenuItem", "inMenuSection": { "@type": "MenuSection", "inMenu": { "@type": "Menu", "forRestaurant": { "@type": "Restaurant", "location": { "@type": "Place", "geo": { "@type": "GeoCoordinates", "latitude": "40.6782", "longitude": "-73.9442" }, "name": "brooklyn" }, "name": "Example restaurant", "servesCuisine": "Example cuisine" }, "name": "breakfast" }, "name": "dessert" }, "name": "pizza" } ], "name": "menuItem", "schemaType": [ "http://schema.googleapis.com/MenuItem" ] } ]
Get order
- Action ID
actions.intent.GET_ORDER
- Description
- Get order details.
- Example queries
Health and fitness
Get exercise observation
- Action ID
actions.intent.GET_EXERCISE_OBSERVATION
- Description
- Get exercise observation
- Example queries
- Supported fields
exerciseObservation.@context
exerciseObservation.@type
exerciseObservation.aboutExercise.@type
exerciseObservation.aboutExercise.name
exerciseObservation.endTime
exerciseObservation.measuredProperty.@type
exerciseObservation.measuredProperty.name
exerciseObservation.startTime
- Supported text field values
-
exerciseObservation.aboutExercise.name
(Aerobics, Bench Press, Biking, Burpee, Climbing, Cross Fit, Crunch, Hiking, Kayaking, Lunge, Other, Plank, Pull-up, Push-up, Rowing, Running, Sit-up, Skiing, Snow boarding, Squat, Stretching, Surfing, Swimming, Walking, Yoga)
exerciseObservation.measuredProperty.name
(Calories, Distance, Elevation gain, Floor, Lap, Pace, Step)
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "ExerciseObservation", "aboutExercise": { "@type": "Exercise", "name": "Climbing" }, "endTime": "2011-12-20T11:59:59", "measuredProperty": { "@type": "Property", "name": "Floor" }, "startTime": "2011-12-20T05:00:00" } ], "name": "exerciseObservation", "schemaType": [ "http://schema.googleapis.com/ExerciseObservation" ] } ]
Get exercise plan
- Action ID
actions.intent.GET_EXERCISE_PLAN
- Description
- Get an exercise plan
- Example queries
- Supported fields
exercisePlan.@context
exercisePlan.@type
exercisePlan.forExercise.@type
exercisePlan.forExercise.name
exercisePlan.name
- Supported text field values
-
exercisePlan.forExercise.name
(Aerobics, Bench Press, Biking, Burpee, Climbing, Cross Fit, Crunch, Hiking, Kayaking, Lunge, Other, Plank, Pull-up, Push-up, Rowing, Running, Sit-up, Skiing, Snow boarding, Squat, Stretching, Surfing, Swimming, Walking, Yoga)
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "ExercisePlan", "forExercise": { "@type": "Exercise", "name": "Yoga" }, "name": "ab" } ], "name": "exercisePlan", "schemaType": [ "http://schema.googleapis.com/ExercisePlan" ] } ]
Get food observation
- Action ID
actions.intent.GET_FOOD_OBSERVATION
- Description
- Get information about the food consumption.
- Example queries
- Supported fields
foodObservation.@context
foodObservation.@type
foodObservation.aboutNutrient.@type
foodObservation.aboutNutrient.name
foodObservation.endTime
foodObservation.forMeal
foodObservation.startTime
- Supported text field values
-
foodObservation.aboutNutrient.name
(Caffeine, Calcium, Calories, Carbohydrate, Cholesterol, Dietary Fiber, Fat, Iron, Protein, Sodium, Sugar, Trans fat, Vitamin A, Vitamin B-6, Vitamin C, Vitamin D, Vitamin D2, Vitamin K, Water)
foodObservation.forMeal
(http://schema.googleapis.com/MealTypeBreakfast, http://schema.googleapis.com/MealTypeBrunch, http://schema.googleapis.com/MealTypeDessert, http://schema.googleapis.com/MealTypeDinner, http://schema.googleapis.com/MealTypeLunch, http://schema.googleapis.com/MealTypeSnack)
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "FoodObservation", "aboutNutrient": { "@type": "Nutrient", "name": "Calories" }, "endTime": "2011-12-27T23:59:59", "forMeal": "http://schema.googleapis.com/MealTypeLunch", "startTime": "2011-12-27T00:00:00" } ], "name": "foodObservation", "schemaType": [ "http://schema.googleapis.com/FoodObservation" ] } ]
Get health stats
- Action ID
actions.intent.GET_HEALTH_OBSERVATION
- Description
- Get information about health stats.
- Example queries
- Supported fields
healthObservation.@context
healthObservation.@type
healthObservation.endTime
healthObservation.measuredProperty.@type
healthObservation.measuredProperty.name
healthObservation.startTime
- Supported text field values
-
healthObservation.measuredProperty.name
(Blood Pressure, Blood Sugar, Body Mass Index, Body Temperature, Heart Rate, Insulin Intake, Menstruation Cycle, Other, Sleep Duration, Waist Size, Water Consumption, Weight)
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "HealthObservation", "endTime": "2011-12-20T11:23:58", "measuredProperty": { "@type": "Property", "name": "Body Temperature" }, "startTime": "2011-12-20T11:23:58" } ], "name": "healthObservation", "schemaType": [ "http://schema.googleapis.com/HealthObservation" ] } ]
Pause exercise
- Action ID
actions.intent.PAUSE_EXERCISE
- Description
- Pause an exercise routine.
- Example queries
- Supported fields
exercise.@context
exercise.@type
exercise.name
- Supported text field values
-
exercise.name
(Aerobics, Bench Press, Biking, Burpee, Climbing, Cross Fit, Crunch, Hiking, Kayaking, Lunge, Other, Plank, Pull-up, Push-up, Rowing, Running, Sit-up, Skiing, Snow boarding, Squat, Stretching, Surfing, Swimming, Walking, Yoga)
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "Exercise", "name": "Running" } ], "name": "exercise", "schemaType": [ "http://schema.googleapis.com/Exercise" ] } ]
Track exercise
- Action ID
actions.intent.RECORD_EXERCISE
- Description
- Record exercise activity.
- Example queries
- Supported fields
exercise.@context
exercise.@type
exercise.distance.@type
exercise.distance.unitText
exercise.distance.value
exercise.duration
exercise.name
exercise.repetitions
- Supported text field values
-
exercise.name
(Aerobics, Bench Press, Biking, Burpee, Climbing, Cross Fit, Crunch, Hiking, Kayaking, Lunge, Other, Plank, Pull-up, Push-up, Rowing, Running, Sit-up, Skiing, Snow boarding, Squat, Stretching, Surfing, Swimming, Walking, Yoga)
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "Exercise", "distance": { "@type": "QuantitativeValue", "unitText": "Mile", "value": "30" }, "duration": "PT45M", "name": "Running", "repetitions": "20" } ], "name": "exercise", "schemaType": [ "http://schema.googleapis.com/Exercise" ] } ]
Record food or nutrition consumption
- Action ID
actions.intent.RECORD_FOOD_OBSERVATION
- Description
- Record food or nutrition consumption information.
- Example queries
- Supported fields
foodObservation.@context
foodObservation.@type
foodObservation.aboutFood.@type
foodObservation.aboutFood.name
foodObservation.aboutNutrient.@type
foodObservation.aboutNutrient.name
foodObservation.endTime
foodObservation.forMeal
foodObservation.startTime
foodObservation.value.@type
foodObservation.value.unitText
foodObservation.value.value
- Supported text field values
-
foodObservation.aboutNutrient.name
(Caffeine, Calcium, Calories, Carbohydrate, Dietary Fiber, Fat, Iron, Protein, Sugar, Vitamin A, Vitamin B-6, Vitamin C, Vitamin D, Vitamin D2, Vitamin K, Water)
foodObservation.forMeal
(http://schema.googleapis.com/MealTypeBreakfast, http://schema.googleapis.com/MealTypeBrunch, http://schema.googleapis.com/MealTypeDessert, http://schema.googleapis.com/MealTypeDinner, http://schema.googleapis.com/MealTypeLunch, http://schema.googleapis.com/MealTypeSnack)
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "FoodObservation", "aboutFood": { "@type": "Food", "name": "Rice" }, "aboutNutrient": { "@type": "Nutrient", "name": "Calcium" }, "endTime": "2011-12-20T23:59:59", "forMeal": "http://schema.googleapis.com/MealTypeLunch", "startTime": "2011-12-20T00:00:00", "value": { "@type": "QuantitativeValue", "unitText": "Ounce", "value": "6" } } ], "name": "foodObservation", "schemaType": [ "http://schema.googleapis.com/FoodObservation" ] } ]
Record health observation
- Action ID
actions.intent.RECORD_HEALTH_OBSERVATION
- Description
- Record information about health statistics.
- Example queries
- Supported fields
healthObservation.@context
healthObservation.@type
healthObservation.endTime
healthObservation.measuredProperty.@type
healthObservation.measuredProperty.name
healthObservation.startTime
healthObservation.value.@type
healthObservation.value.unitText
healthObservation.value.value
- Supported text field values
-
healthObservation.measuredProperty.name
(Blood Pressure, Blood Sugar, Body temperature, Weight)
healthObservation.value.unitText
(Gram, Kilogram, Ounce, Pound)
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "HealthObservation", "endTime": "2011-12-20T23:59:59", "measuredProperty": { "@type": "Property", "name": "Weight" }, "startTime": "2011-12-20T00:00:00", "value": { "@type": "QuantitativeValue", "unitText": "Kilogram", "value": "83" } } ], "name": "healthObservation", "schemaType": [ "http://schema.googleapis.com/HealthObservation" ] } ]
Resume exercise
- Action ID
actions.intent.RESUME_EXERCISE
- Description
- Resume an exercise routine.
- Example queries
- Supported fields
exercise.@context
exercise.@type
exercise.name
- Supported text field values
-
exercise.name
(Aerobics, Bench Press, Biking, Burpee, Climbing, Cross Fit, Crunch, Hiking, Kayaking, Lunge, Other, Plank, Pull-up, Push-up, Rowing, Running, Sit-up, Skiing, Snow boarding, Squat, Stretching, Surfing, Swimming, Walking, Yoga)
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "Exercise", "name": "Running" } ], "name": "exercise", "schemaType": [ "http://schema.googleapis.com/Exercise" ] } ]
Start exercise
- Action ID
actions.intent.START_EXERCISE
- Description
- Start an exercise routine.
- Example queries
- Supported fields
exercise.@context
exercise.@type
exercise.name
exercise.duration
- Supported text field values
-
exercise.name
(Aerobics, Bench Press, Biking, Burpee, Climbing, Cross Fit, Crunch, Hiking, Kayaking, Lunge, Other, Plank, Pull-up, Push-up, Rowing, Running, Sit-up, Skiing, Snow boarding, Squat, Stretching, Surfing, Swimming, Walking, Yoga)
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "Exercise", "duration": "PT1H", "name": "Running" } ], "name": "exercise", "schemaType": [ "http://schema.googleapis.com/Exercise" ] } ]
Stop exercise
- Action ID
actions.intent.STOP_EXERCISE
- Description
- Complete an exercise routine.
- Example queries
- Supported fields
exercise.@context
exercise.@type
exercise.name
- Supported text field values
-
exercise.name
(Bench Press, Biking, Cross Fit, Hiking, Other, Pull-up, Running, Squat, Stretching, Swimming, Walking, Yoga)
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "Exercise", "name": "Running" } ], "name": "exercise", "schemaType": [ "http://schema.googleapis.com/Exercise" ] } ]
Other
Open app feature
- Action ID
actions.intent.OPEN_APP_FEATURE
- Description
- Action for opening features within an app.
- Example queries
- Supported fields
feature
- JSON-LD sample
[ { "exampleValues": [ "History" ], "name": "feature", "schemaType": [] } ]
Transportation
Cancel taxi reservation
- Action ID
actions.intent.CANCEL_TAXI_RESERVATION
- Description
- Cancel a ride.
- Example queries
Create taxi reservation
- Action ID
actions.intent.CREATE_TAXI_RESERVATION
- Description
- Book a ride
- Example queries
- Supported fields
taxiReservation.@context
taxiReservation.@type
taxiReservation.category
taxiReservation.dropoffLocation.@type
taxiReservation.dropoffLocation.address
taxiReservation.dropoffLocation.geo.@type
taxiReservation.dropoffLocation.geo.latitude
taxiReservation.dropoffLocation.geo.longitude
taxiReservation.dropoffLocation.name
taxiReservation.pickupLocation.@type
taxiReservation.pickupLocation.address
taxiReservation.pickupLocation.geo.@type
taxiReservation.pickupLocation.geo.latitude
taxiReservation.pickupLocation.geo.longitude
taxiReservation.pickupLocation.name
- JSON-LD sample
[ { "exampleValues": [ { "@context": "http://schema.googleapis.com", "@type": "TaxiReservation", "category": "Shared", "dropoffLocation": { "@type": "Place", "address": "456 Main Street, Palo Alto", "geo": { "@type": "GeoCoordinates", "latitude": "33.7725", "longitude": "-84.3858" }, "name": "fox theater" }, "pickupLocation": { "@type": "Place", "address": "123 Easy Street, Mountain View, CA", "geo": { "@type": "GeoCoordinates", "latitude": "37.3861", "longitude": "-122.084" }, "name": "Mountain View" } } ], "name": "taxiReservation", "schemaType": [ "http://schema.googleapis.com/TaxiReservation" ] } ]
Get taxi reservation
- Action ID
actions.intent.GET_TAXI_RESERVATION
- Description
- Get details of a taxi reservation
- Example queries