Skip to main content

In your app

A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

Add the function

src/attract/revert-google-review-published-to-previous.ts

Call it

A script makes the client once and calls the function:
scripts/revert-google-review-published-to-previous.ts
Terminal
A route handler, a job or a queue worker calls it the same way.
Answers it; 400 invalid when there is none.

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.
TypeScript
Pass row.id as id. Drafts: list with { aposMode: 'draft' } to get the draft’s id (Find an id).

Required parameters

One object, e.g. revertGoogleReviewPublishedToPrevious({ id }); leave out the optional fields.
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).
A 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.
boolean | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Set when Google returned no reviewer name. The frontend shows a generic label + initial avatar.
number | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Rating (1–5).
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Review text.
Date | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Review date. Format: an ISO 8601 date (YYYY-MM-DD).
Sometimes sent: undefined when the site leaves it out, and it can be null. Hand-curation flag. The widget can be set to show only featured reviews.
Visibility | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Select whether this content is public or private. One of public, loginRequired; a newer site may send others, so keep a fallback.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. 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 | null
Sometimes sent: undefined when the site leaves it out, and it can be null. The business’s public reply to this review, if any.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. 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 | null
Sometimes sent: undefined when the site leaves it out, and it can be null. The policy reason Google gave when it rejected the owner reply, if any.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. 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 | null
Sometimes sent: undefined when the site leaves it out, and it can be null. What the staged reply will do when pushed: “reply” (create/update the owner reply) or “delete” (remove it). Blank when nothing is staged.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Permalink to the review on Google, when the provider supplies one. When set, a URL; empty or null when not.
GoogleReviewSource | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Source. One of manual, places-api, business-profile, demo; a newer site may send others, so keep a fallback.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. The review’s stable Google resource id — the de-duplication key set by a sync. Leave blank for manual entries.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. 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.
boolean | null
Sometimes sent: undefined when the site leaves it out, and it can be null. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.
Date | null
Sometimes sent: undefined when the site leaves it out, and it can be null. When it was created (ISO 8601). Format: an ISO 8601 date and time.
Date | null
Sometimes sent: undefined when the site leaves it out, and it can be null. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. 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 throws the rest as the classes below; catch only what you want to react to (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.
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
sites.forSite('acme') named a slug your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.
setup
The client’s settings are wrong: no FETCHSKI_ATTRACT_URL (or baseUrl), or a malformed API key.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

  • Access: an API key with content:google-reviews:publish (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 (milliseconds) on the client for longer.

Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with node --test.
tests/googleReviews-revertGoogleReviewPublishedToPrevious.test.ts
Answer with your own values: fake googleReviews.revertGoogleReviewPublishedToPrevious with factories.GoogleReview({...}), the fields you give over a valid example.
tests/googleReviews-revertGoogleReviewPublishedToPrevious-answer.test.ts

List a Google review’s locales

site.googleReviews().getGoogleReviewLocales()

List Google reviews

site.googleReviews().listGoogleReviews()

Create a Google review

site.googleReviews().createGoogleReview()

Get a Google review

site.googleReviews().getGoogleReview()

Replace a Google review

site.googleReviews().replaceGoogleReview()

Delete a Google review

site.googleReviews().deleteGoogleReview()

POST /google-review/{_id}/revert-published-to-previous

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