View as Markdown
Google Business Profile icon

Google Business Profile ACTION

List Locations

Lists the locations for the specified account. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Google Business Profile account once, then configure and run List Locations 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_my_business-list-locations",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_my_business: { authProvisionId: "apn_xxxxxxx" },
    account: "Account Name",
    readMask: "Read Mask",
  },
})

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.

List Locations inputs
Property Type Description
account Account Name string
Select an Account or provide a custom Account Name.
Required Dynamic
readMask Read Mask string
A comma-separated list of fields to return for each location (e.g. name,title,categories,storefrontAddress). Defaults to name,title if omitted.
Optional
filter Filter string
A filter constraining the locations to return. See the documentation for supported filter syntax.
Optional
orderBy Order By string
Sorting order for the request. Multiple fields should be comma-separated, following SQL syntax. The default sorting order is ascending. To specify descending order, a suffix " desc" should be added. Valid fields to orderBy are title and storeCode. For example: "title, storeCode desc" or "title" or "storeCode desc"
Optional
pageSize Page Size integer
Number of locations to return per page.
Optional
pageToken Page Token string
Token from a previous response to retrieve the next page of results.
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_my_business-list-locations
Version
0.0.2
App
Google Business Profile
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes