Skip to main content
Google Business Profile logo
  • Category: marketing
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 56
  • Triggers: 0
  • Slug: GOOGLE_BUSINESS_PROFILE
  • Version: 00000000_00

Tools

Slug: GOOGLE_BUSINESS_PROFILE_ACCEPT_INVITATIONAccept a pending Google Business Profile account invitation and grant the connected user its offered access. Warning: this changes account access; confirm the invitation, target account, and offered role before calling.

Input Parameters

string
required
Full invitation resource name to accept, in accounts/{account_id}/invitations/{invitation_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_BATCH_GET_LOCATIONSReturn multiple legacy Google Business Profile Location resources belonging to one account in a single request.

Input Parameters

string
required
Full parent account resource name in accounts/{account_id} form.
array
required
Nonempty list of full location resource names. Every item must use accounts/{account_id}/locations/{location_id} and belong to account_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_COMPLETE_VERIFICATIONSubmit a PIN to complete a pending non-automatic Google Business Profile verification. Warning: this is consequential and attempt-limited; an incorrect PIN may consume an attempt, so confirm the verification resource and PIN before calling.

Input Parameters

string
required
Verification PIN delivered by Google. Preserve leading zeros. Warning: an incorrect PIN may consume a limited verification attempt, so confirm both the verification resource and PIN before calling.
string
required
Full pending verification resource name in locations/{location_id}/verifications/{verification_id} form. Confirm this is the intended verification attempt before submitting its PIN.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_CREATE_ACCOUNTCreate a location-group or user-group account; this cannot create a personal account or organization.

Input Parameters

string
required
Human-readable name for the new account.
string ("LOCATION_GROUP" | "USER_GROUP")
required
Type of group account to create.
string
required
Required resource name of the account that will be the primary owner, in accounts/{account_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_CREATE_LOCAL_POSTPublish a customer-facing standard post, event, offer, or alert for a Google Business Profile location. Warning: this submits content for public display; confirm the text, destination links, event dates, offer terms, and photos before calling. Google may reject content under its policies, and ALERT authoring may not be available.

Input Parameters

object
Event title and complete schedule. Required for EVENT and OFFER posts; invalid for other variants.
array
URL-backed photos attached to the post. ALERT posts support only summary and call_to_action.
object
Offer code, redemption URL, and terms. Required only for an OFFER post.
string
Customer-facing post description or body text.
string
Alert subtype. Required only for ALERT; Google currently documents only COVID_19 and may disable new alert authoring.
string ("STANDARD" | "EVENT" | "OFFER" | "ALERT")
required
Post variant. EVENT requires event; OFFER requires event and offer; ALERT requires alert_type.
string
required
BCP 47 language code for the post.
string
required
Full parent resource name in accounts/{account_id}/locations/{location_id} form.
object
Optional customer action. Google ignores this on OFFER posts, so this tool rejects that combination.
string
Optional RFC 3339 timestamp at which Google should publish the post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_CREATE_LOCATIONCreate a merchant-owned Business Profile location. Google requires profile for non-lodging locations; omit it only for a lodging location. Category classification is enforced by Google. Search for an existing Google location first to avoid duplicates; use validate_only to check the payload without creating it.

Input Parameters

string
required
Public real-world business name.
array
Private merchant labels, each between 1 and 255 characters.
object
Location coordinates. Google ignores them when the storefront address geocodes successfully, and only approved clients can update them.
object
Merchant-authored business profile fields. Google requires profile for non-lodging locations; omission is valid only for lodging locations. This tool leaves category classification and enforcement to Google.
object
Operating status and optional partial opening date for the location.
array
Optional additional opening-hours groups for departments or customer groups.
string
Unique idempotency ID for duplicate detection; a UUID is recommended and must not be reused for another location.
string
Merchant-defined identifier that must be unique among the account’s locations.
string
Public website URL for this location.
string
required
Full parent account resource name, such as accounts/123.
object
Coverage for a business that serves customers at their locations.
string
required
BCP 47 language code for the listing; this cannot be changed after creation.
object
Primary and optional additional customer-facing phone numbers.
object
Normal weekly opening periods.
array
Optional standardized or custom services offered by the business.
object
Date-specific opening-hour exceptions; regular_hours must also be supplied.
boolean
Validate the payload without creating the location when true.
string
required
Primary category resource name, such as categories/gcid:restaurant.
object
Optional parent, child, and chain relationships for this location.
object
Storefront postal address; omit for a customer-location-only service-area business.
array
Additional category resource names; use as few specific categories as necessary.
object
Google Ads location-extension settings for the location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_CREATE_MEDIACreate and publish a customer-facing media item for a Google Business Profile location from a publicly reachable URL or an existing Google upload data reference. Warning: this publishes media on Search and Maps; confirm the exact location, source, and association before calling. This tool never uploads or pretends to upload local bytes.

Input Parameters

string
Existing Google MediaItemDataRef resourceName obtained after a real upload outside this toolkit. Mutually exclusive with source_url; this tool does not upload bytes.
string
Publicly reachable HTTP(S) URL from which Google can retrieve the media. Mutually exclusive with data_ref.
string
Optional description set when this media item is created. Google does not allow descriptions on COVER photos and does not allow changing a description after creation.
string
required
Media format. This API version supports only PHOTO creation.
string
required
Full parent resource name in accounts/{account_id}/locations/{location_id} form.
object
required
How the media is attached to the location. Set exactly one of category or price_list_item_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_DECLINE_INVITATIONPermanently decline a pending Google Business Profile account invitation. Warning: the offered access is rejected and accepting later requires a new invitation; confirm the invitation and target account before calling.

Input Parameters

string
required
Full invitation resource name to decline, in accounts/{account_id}/invitations/{invitation_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_DELETE_ADMINPermanently remove an administrator’s access from a Google Business Profile account or location. Destructive access revocation: confirm the exact administrator resource before calling.

Input Parameters

string
required
Full administrator resource name to permanently remove, in accounts/{account_id}/admins/{admin_id} or locations/{location_id}/admins/{admin_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_DELETE_LOCAL_POSTPermanently delete a local post from a Google Business Profile location. Warning: Destructive: the customer-facing post is permanently removed.

Input Parameters

string
required
Full local-post resource name to delete, in accounts/{account_id}/locations/{location_id}/localPosts/{post_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_DELETE_LOCATIONPermanently delete an API-deletable Business Profile location. Destructive and potentially business-impacting: this removes the listing when Google permits API deletion; confirm the exact location.

Input Parameters

string
required
Full location resource name to permanently delete, in locations/{location_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_DELETE_MEDIAPermanently delete merchant-owned media from a Google Business Profile location. Warning: Destructive: the media item is permanently removed from the profile; confirm the exact media resource before calling.

Input Parameters

string
required
Full merchant-owned media resource name to permanently delete, in accounts/{account_id}/locations/{location_id}/media/{media_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_DELETE_REVIEW_REPLYPermanently remove the merchant’s public reply from a Google Business Profile review. Warning: Destructive and public-facing: the existing merchant reply is permanently removed; confirm the exact review before calling.

Input Parameters

string
required
Full review resource name whose merchant reply will be permanently deleted, in accounts/{account_id}/locations/{location_id}/reviews/{review_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_FIND_CHAINSSearch Google Business Profile chains by display name, or return one chain by its exact chain resource name. Provide exactly one of chain_resource_name or chain_name.

Input Parameters

integer
Maximum matching chains to return from a name search (1-500).
string
Provide exactly one of chain_resource_name or chain_name. This display name uses Google’s exact, partial, fuzzy, and related chain search.
string
Provide exactly one of chain_resource_name or chain_name. This is the exact chain resource name in chains/{chain_place_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GENERATE_VERIFICATION_TOKENGenerate a Google Business Profile instant verification token for an unverified listing identified by its final location ID. The connected caller must own or manage the listing. A returned token is sensitive: use it only for the intended location and never log, disclose, or reuse it.

Input Parameters

string
required
Final location identifier from the Google Business Profile location resource name, without the locations/ prefix. The connected caller must be an owner or manager of this unverified listing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GET_ACCOUNTSList one page of Business Profile accounts accessible to the connected Google user, or return one exact account when account_name is supplied.

Input Parameters

string
Continuation cursor from a previous account-list response. Omit for the first page; not used when account_name is supplied.
string
Google account-list filter expression used only when listing accounts.
integer
Maximum accounts to return in this page (1-20).
string
Full account resource name, such as accounts/123. When supplied, returns that account instead of listing accounts.
string
Optional parent account resource name used only when listing accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GET_CATEGORIESSearch one page of localized Google Business Profile categories, or fetch up to 100 exact stable category resource names in one batch.

Input Parameters

string ("BASIC" | "FULL")
BASIC returns stable names and display names; FULL also requests service and additional-hours metadata.
string
Continuation cursor from a previous category-search response. Omit for the first page; ignored when category_names is supplied.
string
Optional list-mode prefix filter in displayName=value form, such as displayName=food. Ignored when category_names is supplied.
integer
Maximum categories to return in this search page (1-100).
string
ISO 3166-1 alpha-2 region code, such as US or GB. Required for category search; optional for exact batch lookup with category_names.
string
required
BCP 47 language code used to localize category names.
array
One to 100 exact category resource names, such as categories/gcid:restaurant. When supplied, uses batch lookup instead of category search; results are not guaranteed to preserve input order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GET_DAILY_METRICSReturn one or more daily Google Business Profile performance metrics over an inclusive date range, normalized into one list of metric time series. This Performance v1 action replaces the discontinued v4 location insights report for metrics that Google migrated.

Input Parameters

string
required
Inclusive last date in YYYY-MM-DD form.
string
required
Inclusive first date in YYYY-MM-DD form.
array
required
One or more documented DailyMetric enum values. Multiple values use Google’s multi-metric route and are sent as repeated dailyMetrics keys.
string
required
Full location resource name in locations/{location_id} form.
object
Optional day-of-week or time-of-day selector. Google accepts this only for a single requested metric; current metrics may not support breakdowns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GET_FOLLOWER_METADATAReturn the total follower count for a verified Google Business Profile location connected to Google Maps.

Input Parameters

string
required
Full follower-metadata resource name in accounts/{account_id}/locations/{location_id}/followers/metadata form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GET_FOOD_MENUSReturn food menus for an eligible Google Business Profile location, optionally restricted to top-level fields by a read mask.

Input Parameters

string
Comma-separated top-level FoodMenus fields to return. Valid fields are name and menus; nested repeated fields such as menus.sections are not valid. Omit to return the full resource.
string
required
Full food-menu resource name in accounts/{account_id}/locations/{location_id}/foodMenus form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GET_GOOGLE_UPDATED_LOCATIONReturn Google’s consumer-facing version of a Business Profile location and field masks describing differences and pending merchant changes.

Input Parameters

string
required
Comma-separated Location fields to compare, such as name,title,storeCode,websiteUri.
string
required
Full location resource name in locations/{location_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GET_LOCAL_POSTSList one page of local posts for a Google Business Profile location, or return one exact post when post_name is supplied.

Input Parameters

string
Continuation cursor from a previous local-post list response. Omit for the first page and for exact lookup.
integer
Maximum local posts to return in this list page.
string
Full local-post resource name. When supplied, returns that exact post instead of listing posts.
string
Full parent location resource name used to list posts, in accounts/{account_id}/locations/{location_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GET_LOCATIONReturn selected merchant-managed fields for one Business Profile location. Use read_mask=serviceItems to read services through the supported Business Information v1 replacement for the deprecated v4 service-list read.

Input Parameters

string
required
Comma-separated Location fields to return, such as name,title,storeCode,websiteUri.
string
required
Full location resource name in locations/{location_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GET_LOCATION_ATTRIBUTESReturn either merchant-set or Google-displayed attributes for one Google Business Profile location, preserving attribute identifiers and typed values.

Input Parameters

string ("MERCHANT" | "GOOGLE")
Attribute view to return. MERCHANT returns values set by the merchant; GOOGLE returns values displayed on Google Maps and Search.
string
required
Full location resource name in locations/{location_id} form. The tool derives the location’s attributes resource name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GET_LODGINGReturn merchant-set hotel lodging data or Google’s displayed lodging data and the fields Google changed.

Input Parameters

string ("MERCHANT" | "GOOGLE")
Lodging view to return. MERCHANT returns merchant-set hotel data; GOOGLE returns Google’s displayed data and a difference mask.
string
required
Comma-separated Lodging fields to return, such as name,accessibility,parking,policies.
string
required
Full hotel location resource name in locations/{location_id} form. The tool derives its locations/{location_id}/lodging resource name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GET_MEDIAList one page of merchant or customer-contributed media for a Google Business Profile location, or return one exact media item.

Input Parameters

string
Continuation cursor from a previous media list response. Use it with the same location_name and source; omit it for the first page and for exact lookup.
string ("MERCHANT" | "CUSTOMER")
Media ownership source. Use MERCHANT for profile-owner media or CUSTOMER for customer-contributed media; it must match media_name.
integer
Maximum items in a list page. MERCHANT supports 1-2500; CUSTOMER supports 1-200. Ignored for exact lookup.
string
Full merchant or customer media resource name. When supplied, returns that exact item instead of listing media.
string
Full location resource name in accounts/{account_id}/locations/{location_id} form. Required when listing media.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GET_NOTIFICATION_SETTINGReturn an account’s Google Pub/Sub topic and enabled Business Profile notification types.

Input Parameters

string
required
Full account resource name in accounts/{account_id} form. The tool derives the account’s notificationSetting resource name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GET_REVIEWSReturn one exact Google Business Profile review, one page for a verified location, or one account-batch page across up to 50 verified locations.

Input Parameters

string
Continuation cursor from a previous location-list or account-batch response. Omit for the first page and for exact lookup.
string
List or batch ordering: rating, rating desc, or updateTime desc. Google defaults to updateTime desc.
integer
Maximum reviews to return in this list or batch page (1-50).
string
Exact review resource name. Use alone to return one review, in accounts/{account_id}/locations/{location_id}/reviews/{review_id} form.
string
Account whose verified locations are queried in batch. Required with location_names and not allowed with review_name or location_name.
string
One verified location whose reviews to list. Use without review_name, account_name, or location_names.
array
One to 50 full verified-location resource names to query in one batch. Requires account_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_GET_VOICE_OF_MERCHANT_STATEReturn whether a Google Business Profile location has merchant control and the next required verification, ownership, review, or policy action.

Input Parameters

string
required
Full location resource name in locations/{location_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_INVITE_ADMINInvite a user or location group to administer a Google Business Profile account or location. Location groups can be invited only to locations. This changes who can manage the business and may send an invitation; confirm the parent resource, recipient, and role before calling.

Input Parameters

string ("OWNER" | "MANAGER" | "SITE_MANAGER")
required
Access role to grant. Allowed roles depend on the parent resource; Google does not allow SITE_MANAGER for every account.
string
Email address of the user to invite. Provide exactly one of admin or account.
string
Location-group resource in accounts/{account_id} form. Allowed only when parent_name is a location. Provide exactly one of account or admin.
string
required
Full parent resource name in accounts/{account_id} or locations/{location_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_LIST_ADMINSReturn administrators and their roles for a Google Business Profile account or location.

Input Parameters

string
required
Full parent resource name in accounts/{account_id} or locations/{location_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_LIST_ATTRIBUTE_METADATAReturn one page of valid Google Business Profile attribute definitions for a location or a category and region, including value constraints.

Input Parameters

string
Continuation cursor from a previous attribute-metadata response. Omit for the first page.
boolean
Return all available attribute metadata regardless of location or category. Requires language_code and region_code when true.
integer
Maximum attribute metadata records to return in this page.
string
ISO 3166-1 alpha-2 country code, such as US.
string
Primary category resource name used with region_code to resolve applicable attributes. Ignored when show_all is true.
string
BCP 47 language code for localized attribute display names.
string
Location resource name used to resolve applicable attributes. When set, omit category_name, region_code, language_code, and show_all.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_LIST_INVITATIONSReturn pending account invitations, optionally filtered by target type.

Input Parameters

string ("ACCOUNTS_ONLY" | "LOCATIONS_ONLY")
Optional invitation target type to return: accounts or locations only.
string
required
Full parent account resource name in accounts/{account_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_LIST_LOCATIONSReturn one page of Google Business Profile locations in an account, with the fields selected by read_mask and a cursor for the next page.

Input Parameters

string
Continuation cursor from a previous list-locations response. Omit for the first page.
string
Google location filter expression used to constrain the results.
string
Comma-separated ordering expression using Google’s exact field names title or storeCode; append ’ desc’ for descending order.
integer
Maximum locations to return in this page (1-100).
string
required
Comma-separated Location fields to return, such as name,title,storeCode.
string
required
Full parent account resource name, such as accounts/123456789. Use accounts/- to include locations directly and indirectly owned by the connected user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_LIST_PLACE_ACTION_TYPE_METADATAReturn one page of place-action types, such as appointment or food-ordering links, available for a Google Business Profile location or region.

Input Parameters

string
Continuation cursor from a previous place-action type metadata response. Omit for the first page.
string
Optional Google filter: location=locations/{location_id} or region_code={CLDR_region_code}. Omit to return all action types.
integer
Maximum place-action type metadata records to return in this page.
string
IETF BCP 47 language code for localized display names. Google falls back to English when the requested language is unavailable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_LIST_SEARCH_KEYWORD_IMPRESSIONSReturn one page of monthly search keyword impression counts for a Google Business Profile location and a cursor for the next page.

Input Parameters

string
Continuation cursor from a previous search-keyword-impressions response. Omit for the first page.
string
required
Inclusive last month in YYYY-MM format.
integer
Maximum search keyword rows to return in this page (1-100).
string
required
Inclusive first month in YYYY-MM format.
string
required
Full parent location resource name in locations/{location_id} format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_LIST_VERIFICATION_OPTIONSList the verification methods currently eligible for one Google Business Profile location in a requested language. This is a non-mutating discovery step to run before starting verification.

Input Parameters

object
Optional address context only for a CUSTOMER_LOCATION_ONLY service business. Google rejects this context for other business types.
string
required
BCP 47 language code for the verification process. Eligible options can vary by language.
string
required
Full location resource name in locations/{location_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_LIST_VERIFICATIONSReturn one page of verification attempts and states for a Google Business Profile location, plus a cursor for the next page.

Input Parameters

string
Continuation cursor from a previous list-verifications response. Omit for the first page.
integer
Maximum verification attempts to return in this page (1-100).
string
required
Full parent location resource name in locations/{location_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_SEARCH_GOOGLE_LOCATIONSFind an existing Google Maps location by free-form query or structured location data before creating or claiming a Business Profile. Provide exactly one of query or location. Google policy restricts this search to merchants with an existing business relationship with the caller and solely to creating or claiming their locations; never use it for lead generation. This is the supported Business Information v1 successor to the deprecated v4 findMatches operation.

Input Parameters

string
Provide exactly one of query or location. This is a free-form business name and address and is less accurate than a structured location.
object
Provide exactly one of query or location. This structured Google Location candidate uses documented JSON field names, must contain a nonblank title, and may include storefrontAddress, phoneNumbers, categories, websiteUri, or other Location fields.
integer
Number of matches to return (1-10). Defaults to 3; larger values may increase latency. This endpoint is not paginated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_START_VERIFICATIONStart Google Business Profile verification with a method currently eligible for the location. Warning: this is a consequential, policy-gated external side effect that may send mail, email, an SMS, or a phone call. Call it only on the business owner’s direct request, using an option Google returned from List Verification Options.

Input Parameters

string ("ADDRESS" | "EMAIL" | "PHONE_CALL" | "SMS" | "AUTO" | "TRUSTED_PARTNER" | "VETTED_PARTNER")
required
Eligible verification method returned by List Verification Options. Do not select a method Google did not return for this location.
object
Service-business context. Supply it only for a CUSTOMER_LOCATION_ONLY location; for non-ADDRESS methods, reuse the context supplied when fetching verification options.
string
PHONE_CALL- or SMS-only destination. It must exactly match a phone number in the fetched eligible option.
string
EMAIL-only destination. It must be eligible in the fetched option; change only the local part when that option says it is editable.
string
Optional BCP 47 language code to use for verification instructions.
string
required
Full Google location resource name in locations/{location_id} form.
string
ADDRESS-only contact name to print on the verification mail.
string
TRUSTED_PARTNER-only legacy token associated with this location. Mutually exclusive with instant_verification_token.
string
VETTED_PARTNER-only token returned by Generate Verification Token. The tool sends it as token.tokenString. Mutually exclusive with trusted_partner_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_TRANSFER_LOCATIONTransfer a Google Business Profile location to another account administered by the connected user. High-consequence ownership move: confirm both resource names before calling; this can disrupt management access and is not automatically reversible.

Input Parameters

string
required
Full location resource name in locations/{location_id} form.
string
required
Full destination account resource name in accounts/{account_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_UPDATE_ACCOUNTRename a non-personal Business Profile account; validate_only checks the request without applying it.

Input Parameters

string
required
Full account resource name to update, such as accounts/123.
boolean
Validate the update without changing the account when true.
string
required
New human-readable account name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_UPDATE_ADMINChange a Google Business Profile account or location administrator’s role. This alters their access to the business; confirm the administrator and replacement role before calling.

Input Parameters

string ("OWNER" | "MANAGER" | "SITE_MANAGER")
required
Replacement role allowed for this resource and administrator. Google does not allow SITE_MANAGER for every account.
string
required
Full administrator resource name in accounts/{account_id}/admins/{admin_id} or locations/{location_id}/admins/{admin_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_UPDATE_FOOD_MENUSReplace or update food-menu data for an eligible Google Business Profile location. Warning: menu content is customer-facing; omitting update_mask performs a full update that may clear omitted fields, and repeated menu elements cannot be updated individually.

Input Parameters

array
required
Complete documented food menus to write, including localized labels, sections, items, options, prices, and optional dietary details; use an empty list only when intentionally clearing all menus selected by the mask.
string
Comma-separated FoodMenus fields to update. Repeated menu elements cannot be updated individually. Omitting this mask performs a full update and may clear fields absent from the payload.
string
required
Full food-menu resource name in accounts/{account_id}/locations/{location_id}/foodMenus form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_UPDATE_LOCAL_POSTUpdate selected fields on an existing Google Business Profile local post. Warning: changes affect already-published customer-facing content; verify the post, text, links, dates, and offer terms before calling.

Input Parameters

object
required
Writable LocalPost fields and replacement values, using Google JSON field names: languageCode, summary, callToAction, scheduledTime, event, offer, media, topicType, or alertType. Null explicitly clears a nullable field. Nested objects replace that complete top-level field. Do not include name; post_name supplies it.
string
required
Full local-post resource name in accounts/{account_id}/locations/{location_id}/localPosts/{post_id} form.
string
Optional comma-separated field mask. Dotted paths such as callToAction.url are supported. Every path must be present in changes, and every changed top-level field must be covered. When omitted, the tool derives the mask from the top-level keys in changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_UPDATE_LOCATIONUpdate selected merchant-managed fields on a Google Business Profile location. Public listing changes can immediately affect Search and Maps; use validate_only before consequential edits. Use update_mask=serviceItems to replace services through the supported Business Information v1 replacement for the deprecated v4 service-list update.

Input Parameters

object
required
Documented Google Location fields and values to update, using JSON field names such as title, storefrontAddress, phoneNumbers, or regularHours. Do not include name; location_name supplies it.
string
required
Comma-separated Location field paths to update, using Google JSON field names such as title,storefrontAddress. Only these fields are changed.
string
required
Full Google location resource name in locations/{location_id} form.
boolean
Validate the requested changes without applying them. A successful validation can return an empty response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_UPDATE_LOCATION_ATTRIBUTESSet or clear selected merchant-managed attributes on a Google Business Profile location. Warning: every ID in attribute_mask that is omitted from attributes is deleted; inspect attribute metadata and current values first.

Input Parameters

array
required
Attribute values to set. This may be empty when clearing every attribute named by attribute_mask.
string
required
Full location resource name in locations/{location_id} form. The action derives the locations/{location_id}/attributes resource.
string
required
Comma-separated attribute IDs to update or clear. IDs may be bare or in attributes/{attribute_id} form. Every supplied attribute must be included; masked IDs omitted from attributes are deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_UPDATE_LODGINGUpdate selected lodging, amenity, policy, accessibility, service, or sustainability fields for a Google Business Profile hotel location. Warning: these values can become public hotel details; verify the field mask and payload.

Input Parameters

object
required
Partial documented Lodging resource. metadata.update_time is required. Supply every field selected by update_mask; set a selected field to null only when intentionally clearing it. Do not include name.
string
required
Comma-separated Lodging field paths to change, using Google JSON field names. Each selected path must be explicitly present in lodging. The ’*’ mask is allowed only when every mutable top-level field is explicitly supplied (a value or null); nested wildcards are rejected. Repeated-field items cannot be individually selected.
string
required
Full hotel location resource name in locations/{location_id} form. The action derives the locations/{location_id}/lodging resource name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_UPDATE_MEDIAUpdate the category association of merchant-owned Google Business Profile media. Warning: changing this metadata can immediately alter how public media is categorized or displayed; COVER and PROFILE cannot be assigned.

Input Parameters

string ("CATEGORY_UNSPECIFIED" | "EXTERIOR" | "INTERIOR" | "PRODUCT" | "AT_WORK" | "FOOD_AND_DRINK" | "MENU" | "COMMON_AREA" | "ROOMS" | "TEAMS" | "ADDITIONAL")
required
New Google category for the merchant-owned media item. COVER, PROFILE, and deprecated LOGO cannot be assigned when updating media.
string
required
Full merchant media resource name in accounts/{account_id}/locations/{location_id}/media/{media_key} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_UPDATE_NOTIFICATION_SETTINGSet or clear an account’s Pub/Sub topic and replace its enabled Google Business Profile notification types. Warning: notification_types is a complete replacement, and clearing either setting can stop event delivery.

Input Parameters

string
required
Full account resource name in accounts/{account_id} form. The action derives its accounts/{account_id}/notificationSetting resource.
string
Replacement Pub/Sub topic in projects/{project}/topics/{topic} form. Pass null explicitly to clear it. Supply pubsub_topic, notification_types, or both.
array
Complete replacement set of notification types. Pass an empty list to stop all notifications and delete the setting; this is not an append. Supply notification_types, pubsub_topic, or both. LOSS_OF_VOICE_OF_MERCHANT is deprecated; prefer VOICE_OF_MERCHANT_UPDATED.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_UPDATE_REVIEW_REPLYCreate or replace a merchant reply to a Google Business Profile review. Only call this after obtaining explicit end-client authorization from the represented business. Google moderates the reply; inspect review_reply_state to determine whether it is pending, rejected, or approved for public display.

Input Parameters

string
required
Merchant reply text, up to 4096 UTF-8 bytes. This replaces any existing reply and is subject to Google’s moderation before public display.
string
required
Full review resource name in accounts/{account_id}/locations/{location_id}/reviews/{review_id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_BUSINESS_PROFILE_UPLOAD_LOCATION_MEDIAUpload a photo file and publish it on a Google Business Profile location in one operation. This creates customer-facing media on Search and Maps; confirm the exact location, image, and association before calling. Final publish errors or malformed responses can be ambiguous: publication may have succeeded, so list the location’s media before retrying to avoid duplicates. If byte upload succeeds but publishing fails, temporary uploaded bytes can remain until Google expires them because Google provides no cleanup API.

Input Parameters

object
required
Photo file whose raw bytes Google should upload and publish.
string
Optional description set when the photo is published. Google does not allow descriptions on COVER photos.
string
required
Full parent resource name in accounts/{account_id}/locations/{location_id} form.
object
required
How the photo is attached to the location. Set exactly one of category or price_list_item_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not