Get local business

Action ID

actions.intent.GET_LOCAL_BUSINESS

Description

Search for a business in an app. Filter businesses by type using the localBusiness.disambiguatingDescription intent parameter. Determine the location of the business using one of the following intent parameters, if available: localBusiness.location.name, localBusiness.location.address, or localBusiness.location.geo.latitude and localBusiness.location.geo.longitude. Otherwise, return businesses closest to the location of the user.

Locale support

Functionality	Locales
Preview creation using App Actions test tool	en-US
User invocation from Google Assistant	en-US

Example queries

en-US

• Find an urgent care with ExampleProvider
• Have ExampleProvider locate the nearest hospital
• Find car wash in Mountain View on ExampleProvider

Recommended fields

The following fields represent essential information that users often provide in queries that trigger this built-in intent:

localBusiness.disambiguatingDescription

Other supported fields

The following fields represent information that users often provide to disambiguate their needs or otherwise improve their results:

localBusiness.@type
localBusiness.location.@type
localBusiness.location.name
localBusiness.location.address
localBusiness.location.geo.@type
localBusiness.location.geo.latitude
localBusiness.location.geo.longitude

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

localBusiness.@type

• LocalBusiness

localBusiness.disambiguatingDescription

• FillingStation
• Gym
• ArtMuseum
• MovieTheater
• Museum
• Library
• Bookselling
• GroceryStore
• ChargingStation
• BeautySalon
• CarRental
• AutomobileRepairShop
• CarWash
• DryCleaning
• SelfServiceLaundry
• Hospital
• Clinic
• UrgentCareCenter
• PostOffice
• Pharmacy
• Other

localBusiness.location.@type

• Place

localBusiness.location.geo.@type

• GeoCoordinates

Inventory availability by field

localBusiness.disambiguatingDescription

• Web inventory

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_LOCAL_BUSINESS">
    <fulfillment urlTemplate="myapp://custom-deeplink{?disambiguatingDescription,name,address,latitude,longitude}">
      <!-- Eg. disambiguatingDescription = "CarWash" -->
      <!-- (Optional) Require a field eg.disambiguatingDescription for fulfillment with required="true" -->
      <parameter-mapping urlParameter="disambiguatingDescription" intentParameter="localBusiness.disambiguatingDescription" required="true" />
      <!-- Eg. name = "Mountain View" -->
      <parameter-mapping urlParameter="name" intentParameter="localBusiness.location.name" />
      <!-- Eg. address = "123 Easy Street, Mountain View, CA" -->
      <parameter-mapping urlParameter="address" intentParameter="localBusiness.location.address" />
      <!-- Eg. latitude = "37.3861" -->
      <parameter-mapping urlParameter="latitude" intentParameter="localBusiness.location.geo.latitude" />
      <!-- Eg. longitude = "-122.084" -->
      <parameter-mapping urlParameter="longitude" intentParameter="localBusiness.location.geo.longitude" />
    </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

localBusiness.disambiguatingDescription 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_LOCAL_BUSINESS">
    <!-- 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="localBusiness.disambiguatingDescription">
      <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": "LocalBusiness",
  "disambiguatingDescription": "CarWash",
  "location": {
    "@type": "Place",
    "address": "123 Easy Street, Mountain View, CA",
    "geo": {
      "@type": "GeoCoordinates",
      "latitude": "37.3861",
      "longitude": "-122.084"
    },
    "name": "Mountain View"
  }
}