Skip to main content

In your app

A controller answers a route on your app: it calls localizeGoogleReview() and returns the answer.

Add the controller

app/Http/Controllers/LocalizeGoogleReviewController.php
The other values are the example’s: take yours from the request, a form or your database.

Add the route

routes/web.php
It acts with your key’s access, so auth lets only your signed-in users reach it.

Call it

Your own page’s form or script sends POST /google-review/clx8m2k4p0000a1b2c3d4e5f6/localize (a form adds @csrf, as every web route checks it), and gets back its answer as JSON. Test it, below, calls it.
To keep the call in an Action instead, this writes app/Actions/Attract/LocalizeGoogleReview.php (an invokable Action that calls localizeGoogleReview()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):
Terminal

Call it from the terminal

Terminal
It calls localizeGoogleReview() on your default site and prints its answer as JSON. It writes, so it asks first: add --force to skip the question in a script. See Call any method from the terminal for every argument type. Answers that copy. 409 conflict when one exists and update is not true.

Find the id

id is the document’s _id, from a list. Ask the list for only the fields you need: each row is a document’s id and those fields.
Laravel
Terminal
Pass $row['id'] as id. Drafts: list with aposMode: 'draft' to get the draft’s id (Find an id).

Required parameters

Named arguments, e.g. localizeGoogleReview(id: …); leave out the optional ones.
string
required
Required. The document’s _id: a full id names its own locale and mode (the draft’s …:en:draft, the published one’s …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).
string
required
Required. The locale to copy it into: a configured locale, not the current one.
?bool
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Overwrite the copy if one already exists there (default false: 409 conflict instead).
A GoogleReview (Fetchski\AttractCmsLaravel\Data\GoogleReview). GoogleReview content type. Read its properties ($googleReview->title): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (_id → id).
string
Always sent. Its title: the name it goes by in every list, and the heading of its page where it has one.
string
Always sent. Reviewer name.
string
Always sent. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
string
Always sent. The document’s id. On a type with drafts it ends in its locale and mode (…:en:published, …:en:draft): the part before the first colon is its aposDocId, shared by both copies. The {_id} the type’s routes take.
string
Always sent. The document type’s name: always this type’s.
?bool
Sometimes sent: null when the site leaves it out. Set when Google returned no reviewer name. The frontend shows a generic label + initial avatar.
?int
Sometimes sent: null when the site leaves it out. Rating (1–5).
?string
Sometimes sent: null when the site leaves it out. Review text.
?CarbonImmutable
Sometimes sent: null when the site leaves it out. Review date. Format: an ISO 8601 date (YYYY-MM-DD).
Sometimes sent: null when the site leaves it out. Hand-curation flag. The widget can be set to show only featured reviews.
Enums\Visibility|string|null
Sometimes sent: null when the site leaves it out. Select whether this content is public or private. One of public, loginRequired; a newer site may send others, so keep a fallback.
?string
Sometimes sent: null when the site leaves it out. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.
?string
Sometimes sent: null when the site leaves it out. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.
?string
Sometimes sent: null when the site leaves it out. The reviewer’s Google avatar URL, stored as-is (not downloaded). The frontend renders it directly and falls back to a lettered avatar if missing or stale. When set, a URL; empty or null when not.
?string
Sometimes sent: null when the site leaves it out. The business’s public reply to this review, if any.
?string
Sometimes sent: null when the site leaves it out. Google moderates owner replies asynchronously: PENDING until reviewed, then APPROVED or REJECTED. Synced from the Business Profile API; blank for manual rows or replies predating moderation visibility.
?string
Sometimes sent: null when the site leaves it out. The policy reason Google gave when it rejected the owner reply, if any.
?string
Sometimes sent: null when the site leaves it out. A reply drafted in the Google Business Dashboard and not yet pushed to Google. Managed by the dashboard’s Review & push flow, never edited here.
?string
Sometimes sent: null when the site leaves it out. What the staged reply will do when pushed: “reply” (create/update the owner reply) or “delete” (remove it). Blank when nothing is staged.
?string
Sometimes sent: null when the site leaves it out. Permalink to the review on Google, when the provider supplies one. When set, a URL; empty or null when not.
Enums\GoogleReviewSource|string|null
Sometimes sent: null when the site leaves it out. Source. One of manual, places-api, business-profile, demo; a newer site may send others, so keep a fallback.
?string
Sometimes sent: null when the site leaves it out. The review’s stable Google resource id — the de-duplication key set by a sync. Leave blank for manual entries.
?string
Sometimes sent: null when the site leaves it out. The Google Business Profile location this review belongs to (bare location id) — set by the Business Profile sync; ties the review to its gbp-location mirror row and the dashboard’s Reviews section.
?bool
Sometimes sent: null when the site leaves it out. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.
?CarbonImmutable
Sometimes sent: null when the site leaves it out. When it was created (ISO 8601). Format: an ISO 8601 date and time.
?CarbonImmutable
Sometimes sent: null when the site leaves it out. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
?string
Sometimes sent: null when the site leaves it out. The draft’s preview share key, while its share link is on: the link is the draft’s _url with aposShareKey and aposShareId (the draft’s _id) in its query. Absent otherwise, and on published documents.
Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).
400
The site refused what was sent: errors() lists each field’s problem, siteMessage() the first.Retried first: No. Read: errors() (field → messages), siteMessage().
401
The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read: siteMessage(), errorName(), data().
403
The key may not do this: a scope it lacks, or an address outside its allowlist. siteMessage() names it.Retried first: No. Read: siteMessage(), errorName(), data().
404
Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage(), errorName(), data().
409
A copy already exists in that locale: send update: true to overwrite it.Retried first: No. Read: siteMessage(), errorName(), data().
500
The site failed. Its logs say why.Retried first: No: a write may have landed. Read: siteMessage(), errorName(), data().
no answer
No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Only when nothing reached the site (neverConnected()); never after a timeout, when it may have landed. Read: reason(), neverConnected().
not sent
The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason() (what to change).
any other
Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason(), status().
setup
Attract::site('acme') named a slug that isn’t under sites in config/fetchski-attract.php.Retried first: No: nothing was sent. Read: getMessage(), $e->slug.
setup
The site’s config entry is wrong: no url, a malformed api_key, a key filed under another slug, or no default site.Retried first: No: nothing was sent. Read: getMessage() (what to fix).

Behavior

  • Access: an API key with content:google-reviews:write (or a master above it: content:google-reviews:all, content:all, admin:all). A signed-in person may call it as far as their own permissions allow; anyone else gets 403.
  • Rate limit: the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
  • Retries: a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
  • Timeout: 15 s per attempt by default; raise timeout in config/fetchski-attract.php for longer.

Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as tests/Feature/LocalizeGoogleReviewTest.php, then run your tests:
tests/Feature/LocalizeGoogleReviewTest.php
Terminal
Answer with your own values: fake googleReviews.localizeGoogleReview with GoogleReview::factory()->make([...]), the fields you give over a valid example.
tests/Feature/LocalizeGoogleReviewAnswerTest.php

List a Google review’s locales

Attract::googleReviews()->getGoogleReviewLocales()

List Google reviews

Attract::googleReviews()->listGoogleReviews()

Create a Google review

Attract::googleReviews()->createGoogleReview()

Get a Google review

Attract::googleReviews()->getGoogleReview()

Replace a Google review

Attract::googleReviews()->replaceGoogleReview()

Delete a Google review

Attract::googleReviews()->deleteGoogleReview()

POST /google-review/{_id}/localize

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.