View as Markdown
Google Maps (Places API) icon

Google Maps (Places API) ACTION

Search Places

Searches for places based on location, radius, and optional filters like keywords, place type, or name. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Google Maps (Places API) account once, then configure and run Search Places from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "google_maps_platform-search-places",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_maps_platform: { authProvisionId: "apn_xxxxxxx" },
    textQuery: "Text Query",
    includedType: "Included Type",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Search Places inputs
Property Type Description
textQuery Text Query string
The text string on which to search, for example: "restaurant", "123 Main Street", or "best place to visit in San Francisco". The API returns candidate matches based on this string and orders the results based on their perceived relevance.
Required
includedType Included Type string
Restricts the results to places matching the specified type defined by Table A. Only one type may be specified.
Optional
includePureServiceAreaBusinesses Include Pure Service Area Businesses boolean
If set to true, the response includes businesses that visit or deliver to customers directly, but don't have a physical business location. If set to false, the API returns only businesses with a physical business location.
Optional
languageCode Language Code string
The language in which to return results.
Optional
locationBias Location Bias object
Specifies an area to search. This location serves as a bias which means results around the specified location can be returned, including results outside the specified area. See the documentation for further information.
Optional
locationRestriction Location Restriction string
Specifies an area to search. Results outside the specified area are not returned.
Optional
evOptions EV Options object
Specifies parameters for identifying available electric vehicle (EV) charging connectors and charging rates. See the documentation for further information.
Optional
minRating Min Rating string
Restricts results to only those whose average user rating is greater than or equal to this limit. Values must be between 0.0 and 5.0 (inclusive) in increments of 0.5. For example: 0, 0.5, 1.0, ... , 5.0 inclusive. Values are rounded up to the nearest 0.5. For example, a value of 0.6 eliminates all results with a rating less than 1.0.
Optional
openNow Open Now boolean
If true, return only those places that are open for business at the time the query is sent. If false, return all businesses regardless of open status. Places that don't specify opening hours in the Google Places database are returned if you set this parameter to false.
Optional
priceLevels Price Levels string[]
Restrict the search to places that are marked at certain price levels. The default is to select all price levels.
Optional
rankPreference Rank Preference string
Specifies how the results are ranked in the response based on the type of query: For a categorical query such as "Restaurants in New York City", RELEVANCE (rank results by search relevance) is the default. You can set Rank Preference to RELEVANCE or DISTANCE (rank results by distance). For a non-categorical query such as "Mountain View, CA", it is recommended that you leave Rank Preference unset.
Optional
regionCode Region Code string
The region code used to format the response, specified as a two-character CLDR code value. This parameter can also have a bias effect on the search results.
Optional
strictTypeFiltering Strict Type Filtering boolean
Used with the Included Type parameter. When set to true, only places that match the specified types specified by includeType are returned. When false, the default, the response can contain places that don't match the specified types.
Optional
simplified Simplified Response boolean
If true, the response will contain a reduced set of fields
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
google_maps_platform-search-places
Version
0.0.4
App
Google Maps (Places API)
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes