Get Review

google_business_profile.get_review
ActionBusiness appsconnection required

Calls the Google Business Profile API with the connection's credentials.

Read one review on a location, including any existing reply.

Connection

Required
Yes — the node will not save without one
Auth type
OAuth 2.0
Providers
Google Business Profile
Secret shape
{"client_id", "client_secret", "refresh_token"}
Config it needs
account_id, token_uri
Resolved by
config.connection_id, else node.connection_id

Configuration

3 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
review_id
Google's review id, or the review's full resource name.
stringYes———
location_id
Location, as locations/12345, accounts/1/locations/12345 or just 12345.
stringYes——locations/12345678901234567890
account_id
Business Profile account, as accounts/12345 or just 12345. Overrides the account id stored on the connection.
stringNo———

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "location_id": "locations/12345678901234567890"
}

Output

One shape.

result

FieldTypeExample
review_id
Google's id for the review.
stringAbCd-EfG
name
Full resource name of the review.
string—
location
The accounts/*/locations/* the review belongs to.
string—
star_rating
Google's enum: ONE, TWO, THREE, FOUR or FIVE.
string—
rating
The same rating as a number from 1 to 5 (0 when unspecified).
number—
comment
The reviewer's text; empty for a rating-only review.
string—
create_time
When the review was written (RFC 3339).
string—
update_time
When the review last changed (RFC 3339).
string—
reviewer_display_name
The reviewer's name, when not anonymous.
string—
reviewer_profile_photo_url
The reviewer's profile photo.
string—
reviewer_is_anonymous
True when Google withheld the reviewer's name.
boolean—
reply_comment
The merchant's existing reply, if any.
string—
reply_update_time
When the existing reply was last changed.
string—
has_reply
True when this review already has a merchant reply.
boolean—
review_reply_url
Link that opens the reply form on Google.
string—
review
The whole Review object as Google returned it.
object—
{
  "comment": "",
  "create_time": "",
  "has_reply": false,
  "location": "",
  "name": "",
  "rating": 0,
  "reply_comment": "",
  "reply_update_time": "",
  "review": {},
  "review_id": "AbCd-EfG",
  "review_reply_url": "",
  "reviewer_display_name": "",
  "reviewer_is_anonymous": false,
  "reviewer_profile_photo_url": "",
  "star_rating": "",
  "update_time": ""
}

See Get Review run in a workflow.

In a technical demo we add the Google Business Profile connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.