- Action ID
actions.intent.CREATE_FLIGHT_RESERVATION
- Description
-
Search for available flight tickets in an app. Populate the search criteria using the details that best match your app's search functionality. For example, you can populate the IATA codes for the departure and arrival airports using the
flightReservation.reservationFor.departureAirport.iataCode
andflightReservation.reservationFor.arrivalAirport.iataCode
intent parameters. The Google Assistant attempts to provide IATA codes for departure and arrival airports, and returns city or airport names instead if an attempt fails.If enough fields are populated to perform a search, your app can directly show search results. Your app must confirm with the user before creating a reservation.
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:
flightReservation.reservationFor.arrivalAirport.address
flightReservation.reservationFor.arrivalAirport.iataCode
flightReservation.reservationFor.departureAirport.address
flightReservation.reservationFor.departureAirport.iataCode
flightReservation.reservationFor.departureTime
flightReservation.reservationFor.provider.name
Other supported fields
The following fields represent information that users often provide to disambiguate their needs or otherwise improve their results:
flightReservation.@type
flightReservation.reservationFor.@type
flightReservation.reservationFor.arrivalAirport.@type
flightReservation.reservationFor.departureAirport.@type
flightReservation.reservationFor.provider.@type
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.CREATE_FLIGHT_RESERVATION">
<intent
android:action="android.intent.action.VIEW"
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<!-- Eg. departureTime = "2011-12-20T23:59:59" -->
<parameter
android:name="flightReservation.reservationFor.departureTime"
android:key="departureTime"/>
<!-- Eg. name = "Example Airline" -->
<parameter
android:name="flightReservation.reservationFor.provider.name"
android:key="name"/>
<!-- Eg. arrivalAirportAddress = "123 Main Street, San Francisco, CA 12345" -->
<parameter
android:name="flightReservation.reservationFor.arrivalAirport.address"
android:key="arrivalAirportAddress"/>
<!-- Eg. arrivalAirportIatacode = "SFO" -->
<parameter
android:name="flightReservation.reservationFor.arrivalAirport.iataCode"
android:key="arrivalAirportIatacode"/>
<!-- Eg. departureAirportAddress = "456 Market Street, New York, NY 67890" -->
<parameter
android:name="flightReservation.reservationFor.departureAirport.address"
android:key="departureAirportAddress"/>
<!-- Eg. departureAirportIatacode = "JFK" -->
<parameter
android:name="flightReservation.reservationFor.departureAirport.iataCode"
android:key="departureAirportIatacode"/>
</intent>
</capability>
</shortcuts>
actions.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.CREATE_FLIGHT_RESERVATION">
<fulfillment urlTemplate="myapp://custom-deeplink{?departureTime,name,arrivalAirportAddress,arrivalAirportIatacode,departureAirportAddress,departureAirportIatacode}">
<!-- e.g. departureTime = "2011-12-20T23:59:59" -->
<!-- (Optional) Require a field eg.departureTime for fulfillment with required="true" -->
<parameter-mapping urlParameter="departureTime" intentParameter="flightReservation.reservationFor.departureTime" required="true" />
<!-- e.g. name = "Example Airline" -->
<parameter-mapping urlParameter="name" intentParameter="flightReservation.reservationFor.provider.name" />
<!-- e.g. arrivalAirportAddress = "123 Main Street, San Francisco, CA 12345" -->
<parameter-mapping urlParameter="arrivalAirportAddress" intentParameter="flightReservation.reservationFor.arrivalAirport.address" />
<!-- e.g. arrivalAirportIatacode = "SFO" -->
<parameter-mapping urlParameter="arrivalAirportIatacode" intentParameter="flightReservation.reservationFor.arrivalAirport.iataCode" />
<!-- e.g. departureAirportAddress = "456 Market Street, New York, NY 67890" -->
<parameter-mapping urlParameter="departureAirportAddress" intentParameter="flightReservation.reservationFor.departureAirport.address" />
<!-- e.g. departureAirportIatacode = "JFK" -->
<parameter-mapping urlParameter="departureAirportIatacode" intentParameter="flightReservation.reservationFor.departureAirport.iataCode" />
</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
shortcuts.xml
flightReservation.reservationFor.provider.name
is an
intent parameter that supports inline inventory.
By defining a <shortcut>
for flightReservation.reservationFor.provider.name
,
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
name_one
shortcut, Assistant provides the associated shorcut identifier, ID_ONE
, as
the URL parameter name
to fulfillment.
If there is no inventory match, the text value received in the query for
flightReservation.reservationFor.provider.name
is passed
as-is.
<?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.CREATE_FLIGHT_RESERVATION">
<intent
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<parameter
android:name="flightReservation.reservationFor.departureTime"
android:key="departureTime"/>
<parameter
android:name="flightReservation.reservationFor.provider.name"
android:key="name"/>
<parameter
android:name="flightReservation.reservationFor.arrivalAirport.address"
android:key="arrivalAirportAddress"/>
<parameter
android:name="flightReservation.reservationFor.arrivalAirport.iataCode"
android:key="arrivalAirportIatacode"/>
<parameter
android:name="flightReservation.reservationFor.departureAirport.address"
android:key="departureAirportAddress"/>
<parameter
android:name="flightReservation.reservationFor.departureAirport.iataCode"
android:key="departureAirportIatacode"/>
</intent>
</capability>
<!-- Short and long labels must be @string resource. -->
<shortcut
android:shortcutId="ID_ONE"
android:shortcutShortLabel="@string/shortcut_short_label"
android:shortcutLongLabel="@string/shortcut_long_label">
<capability-binding android:key="actions.intent.CREATE_FLIGHT_RESERVATION">
<parameter-binding
android:value="name"
android:key="flightReservation.reservationFor.provider.name"/>
</capability-binding>
</shortcut>
</shortcuts>
actions.xml
flightReservation.reservationFor.provider.name
is an
intent parameter that supports inline inventory.
By defining an <entity-set>
for flightReservation.reservationFor.provider.name
,
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
name_one
entity, Assistant provides the associated identifier, ID_ONE
, as
the URL parameter name
to fulfillment.
If there is no inventory match, the text value received in the query for
flightReservation.reservationFor.provider.name
is passed
as-is.
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.CREATE_FLIGHT_RESERVATION">
<fulfillment urlTemplate="myapp://deeplink{?name}" >
<!-- name = "ID_ONE" or "ID_TWO" -->
<!-- If no inventory match, name is a text value, such as "Example Airline" -->
<!-- (Optional) Use entityMatchRequired="true" to require inventory match for fulfillment -->
<parameter-mapping urlParameter="name" intentParameter="flightReservation.reservationFor.provider.name" />
</fulfillment>
<!-- Define parameters with inventories here -->
<parameter name="flightReservation.reservationFor.provider.name">
<entity-set-reference entitySetId="nameEntitySet"/>
</parameter>
</action>
<entity-set entitySetId="nameEntitySet">
<!-- Provide an identifier per entity -->
<entity identifier="ID_ONE" name="name_one" alternateName="@array/name_one_synonyms"/>
<entity identifier="ID_TWO" name="name_two" alternateName="@array/name_two_synonyms"/>
</entity-set>
</actions>
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
name_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_FLIGHT_RESERVATION">
<!-- 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="flightReservation.reservationFor.provider.name">
<entity-set-reference entitySetId="nameEntitySet"/>
</parameter>
</action>
<entity-set entitySetId="nameEntitySet">
<!-- Provide a URL per entity -->
<entity url="myapp://deeplink/one" name="name_one" alternateName="@array/name_one_synonyms"/>
<entity url="myapp://deeplink/two" name="name_two" alternateName="@array/name_two_synonyms"/>
</entity-set>
</actions>
Use web inventory
flightReservation.reservationFor.provider.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.CREATE_FLIGHT_RESERVATION">
<intent
android:action="android.intent.action.VIEW"
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<parameter android:name="flightReservation.reservationFor.departureTime">
<data android:pathPattern="https://www.mywebsite.com/link1/.*"/>
</parameter>
<parameter android:name="flightReservation.reservationFor.provider.name">
<data android:pathPattern="https://www.mywebsite.com/link2/.*"/>
</parameter>
<parameter android:name="flightReservation.reservationFor.arrivalAirport.address">
<data android:pathPattern="https://www.mywebsite.com/link3/.*"/>
</parameter>
<parameter android:name="flightReservation.reservationFor.arrivalAirport.iataCode">
<data android:pathPattern="https://www.mywebsite.com/link4/.*"/>
</parameter>
<parameter android:name="flightReservation.reservationFor.departureAirport.address">
<data android:pathPattern="https://www.mywebsite.com/link5/.*"/>
</parameter>
<parameter android:name="flightReservation.reservationFor.departureAirport.iataCode">
<data android:pathPattern="https://www.mywebsite.com/link6/.*"/>
</parameter>
</intent>
</capability>
</shortcuts>
actions.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.CREATE_FLIGHT_RESERVATION">
<!-- 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="flightReservation.reservationFor.provider.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": "FlightReservation", "reservationFor": { "@type": "Flight", "arrivalAirport": { "@type": "Airport", "address": "123 Main Street, San Francisco, CA 12345", "iataCode": "SFO" }, "departureAirport": { "@type": "Airport", "address": "456 Market Street, New York, NY 67890", "iataCode": "JFK" }, "departureTime": "2011-12-20T23:59:59", "provider": { "@type": "Organization", "name": "Example Airline" } } }