Share a Google review’s draft

use Fetchski\AttractCmsLaravel\Facades\Attract;

$googleReview = Attract::googleReviews()->shareGoogleReview(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "reviewerName": "Example reviewer name",
  "isAnonymous": false,
  "rating": 5,
  "reviewText": "Example review text",
  "reviewedAt": "2026-10-24",
  "featured": false,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "reviewerPhotoUrl": "https://acme.example/example",
  "ownerReply": "Example owner reply",
  "replyState": "Example reply state",
  "replyPolicyViolation": "Example reply policy violation",
  "stagedReply": "Example staged reply",
  "stagedReplyAction": "Example staged reply action",
  "reviewUrl": "https://acme.example/example",
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "gbpLocationId": "clx8m2k4p0000a1b2c3d4e5f6",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

$googleReview = Attract::googleReviews()->shareGoogleReview(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "reviewerName": "Example reviewer name",
  "isAnonymous": false,
  "rating": 5,
  "reviewText": "Example review text",
  "reviewedAt": "2026-10-24",
  "featured": false,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "reviewerPhotoUrl": "https://acme.example/example",
  "ownerReply": "Example owner reply",
  "replyState": "Example reply state",
  "replyPolicyViolation": "Example reply policy violation",
  "stagedReply": "Example staged reply",
  "stagedReplyAction": "Example staged reply action",
  "reviewUrl": "https://acme.example/example",
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "gbpLocationId": "clx8m2k4p0000a1b2c3d4e5f6",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

In your app

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

Add the controller

app/Http/Controllers/ShareGoogleReviewController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\GoogleReview;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class ShareGoogleReviewController
{
    public function __invoke(string $id): GoogleReview
    {
        return Attract::googleReviews()->shareGoogleReview(id: $id);
    }
}

Add the route

routes/web.php

use App\Http\Controllers\ShareGoogleReviewController;
use Illuminate\Support\Facades\Route;

Route::post('/google-review/{id}/share', ShareGoogleReviewController::class)->middleware('auth');

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/share (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/ShareGoogleReview.php (an invokable Action that calls shareGoogleReview()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action googleReviews.shareGoogleReview

Call it from the terminal

Terminal

php artisan attract:call googleReviews.shareGoogleReview id=clx8m2k4p0000a1b2c3d4e5f6

It calls shareGoogleReview() 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. Takes the draft’s exact _id (…:en:draft). Answers the draft, with its aposShareKey while the link is on: the link is the draft’s _url with aposShareKey and aposShareId (the draft’s _id) in its query.

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

use Fetchski\AttractCmsLaravel\Facades\Attract;

$row = Attract::googleReviews()->listGoogleReviewsPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null

Terminal

php artisan attract:call googleReviews.listGoogleReviewsPick fields=title,slug

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. shareGoogleReview(id: …); leave out the optional ones.

string

required

Required. The draft’s exact _id (…:en:draft).

Optional parameters

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. true adds a share key (aposShareKey) to the draft; false (the default) removes it.

Returns

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).

?bool

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.

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.

Errors

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().

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/ShareGoogleReviewTest.php, then run your tests:

tests/Feature/ShareGoogleReviewTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use App\Models\User;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

final class ShareGoogleReviewTest extends TestCase
{
    use RefreshDatabase;

    public function test_share_google_review(): void
    {
        Attract::fake();

        $this->actingAs(User::factory()->create())
            ->postJson('/google-review/clx8m2k4p0000a1b2c3d4e5f6/share')
            ->assertOk();

        Attract::assertCalled('googleReviews.shareGoogleReview', fn (array $args): bool => $args['id'] === 'clx8m2k4p0000a1b2c3d4e5f6');
    }
}

Terminal

php artisan test

Answer with your own values: fake googleReviews.shareGoogleReview with GoogleReview::factory()->make([...]), the fields you give over a valid example.

tests/Feature/ShareGoogleReviewAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Data\GoogleReview;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class ShareGoogleReviewAnswerTest extends TestCase
{
    public function test_share_google_review_answers_your_values(): void
    {
        Attract::fake([
            'googleReviews.shareGoogleReview' => GoogleReview::factory()->make(['title' => 'Your value']),
        ]);

        $googleReview = Attract::googleReviews()->shareGoogleReview(id: 'clx8m2k4p0000a1b2c3d4e5f6');

        $this->assertSame('Your value', $googleReview->title);
    }
}

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}/share

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

use Fetchski\AttractCmsLaravel\Facades\Attract;

$googleReview = Attract::googleReviews()->shareGoogleReview(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "reviewerName": "Example reviewer name",
  "isAnonymous": false,
  "rating": 5,
  "reviewText": "Example review text",
  "reviewedAt": "2026-10-24",
  "featured": false,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "reviewerPhotoUrl": "https://acme.example/example",
  "ownerReply": "Example owner reply",
  "replyState": "Example reply state",
  "replyPolicyViolation": "Example reply policy violation",
  "stagedReply": "Example staged reply",
  "stagedReplyAction": "Example staged reply action",
  "reviewUrl": "https://acme.example/example",
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "gbpLocationId": "clx8m2k4p0000a1b2c3d4e5f6",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Call it from the terminal

Find the id

Behavior

Test it

List a Google review’s locales

List Google reviews

Create a Google review

Get a Google review

Replace a Google review

Delete a Google review

POST /google-review/{_id}/share

In your app

Call it from the terminal

Find the id

Behavior

Test it

Related

List a Google review’s locales

List Google reviews

Create a Google review

Get a Google review

Replace a Google review

Delete a Google review

POST /google-review/{_id}/share