> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a Google review

> Create a new Google review.

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$googleReview = Attract::googleReviews()->createGoogleReview(title: 'Example title', reviewerName: 'Example reviewer name');
```

```json 200 wrap theme={"dark"}
{
  "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 `createGoogleReview()` and returns the answer.

**1. Add the controller**

```php app/Http/Controllers/CreateGoogleReviewController.php theme={"dark"}
<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class CreateGoogleReviewController
{
    public function __invoke(): GoogleReview
    {
        return Attract::googleReviews()->createGoogleReview(title: 'Example title', reviewerName: 'Example reviewer name');
    }
}
```

The other values are the example’s: take yours from the request, a form or your database.

**2. Add the route**

```php routes/web.php theme={"dark"}
use App\Http\Controllers\CreateGoogleReviewController;
use Illuminate\Support\Facades\Route;

Route::post('/google-review', CreateGoogleReviewController::class)->middleware('auth');
```

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

**3. Call it**

Your own page’s form or script sends `POST /google-review` (a form adds `@csrf`, as every web route checks it), and gets back its answer as JSON. Test it, below, calls it.

> [!TIP]
>
> To keep the call in an Action instead, this writes `app/Actions/Attract/CreateGoogleReview.php` (an invokable Action that calls `createGoogleReview()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action googleReviews.createGoogleReview
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call googleReviews.createGoogleReview \
  'title=Example title' \
  'reviewerName=Example reviewer name'
```

It calls `createGoogleReview()` 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](https://docs.fetchski-attract.com/call-command.md) for every argument type.

> [accordion] Required parameters
>
> Named arguments, e.g. `createGoogleReview(title: …)`; leave out the optional ones.
>
> **title** `string` *required*
>
> **Required.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **reviewerName** `string` *required*
>
> **Required.** Reviewer name.

> [accordion] Optional parameters
>
> **aposMode** `Enums\\AposMode|string|null`
>
> **Optional.** Leave it out and the site uses `"published"`. `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content:<type>:write`), or a signed-in editor. The public and a key with only the read scope get 403. One of `draft`, `published`.
>
> **aposLocale** `?string`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. `en` (default: the site’s default locale).
>
> **isAnonymous** `?bool`
>
> **Optional.** Leave it out and the site uses `false`. Set when Google returned no reviewer name. The frontend shows a generic label + initial avatar.
>
> **rating** `?int`
>
> **Optional.** Leave it out and the site uses `5`. Rating (1–5).
>
> **reviewText** `?string`
>
> **Optional.** Leave it out and the site uses `""`. Review text.
>
> **reviewedAt** `\\DateTimeInterface|string|null`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Review date. Format: an ISO 8601 date (`YYYY-MM-DD`).
>
> **featured** `?bool`
>
> **Optional.** Leave it out and the site uses `false`. Hand-curation flag. The widget can be set to show only featured reviews.
>
> **slug** `?string`
>
> **Optional.** Leave it out and the site uses `""`. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept). Left out, it’s made from the title.
>
> **visibility** `Enums\\Visibility|string|null`
>
> **Optional.** Leave it out and the site uses `"public"`. Select whether this content is public or private. One of `public`, `loginRequired`.
>
> **scheduledPublish** `?string`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **scheduledUnpublish** `?string`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **reviewerPhotoUrl** `?string`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. 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.
>
> **ownerReply** `?string`
>
> **Optional.** Leave it out and the site uses `""`. The business’s public reply to this review, if any.
>
> **reviewUrl** `?string`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Permalink to the review on Google, when the provider supplies one. When set, a URL; empty or null when not.
>
> **source** `Enums\\GoogleReviewSource|string|null`
>
> **Optional.** Leave it out and the site uses `"manual"`. Source. One of `manual`, `places-api`, `business-profile`, `demo`.
>
> **sourceId** `?string`
>
> **Optional.** Leave it out and the site uses `""`. The review’s stable Google resource id — the de-duplication key set by a sync. Leave blank for manual entries.
>
> **archived** `?bool`
>
> **Optional.** Leave it out and the site uses `false`. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document.

> [accordion] 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`).
>
> **title** `string`
>
> **Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **reviewerName** `string`
>
> **Always sent.** Reviewer name.
>
> **slug** `string`
>
> **Always sent.** The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **id** `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.
>
> **type** `string`
>
> **Always sent.** The document type’s name: always this type’s.
>
> **isAnonymous** `?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.
>
> **rating** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Rating (1–5).
>
> **reviewText** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Review text.
>
> **reviewedAt** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. Review date. Format: an ISO 8601 date (`YYYY-MM-DD`).
>
> **featured** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. Hand-curation flag. The widget can be set to show only featured reviews.
>
> **visibility** `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.
>
> **scheduledPublish** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **scheduledUnpublish** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **reviewerPhotoUrl** `?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.
>
> **ownerReply** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The business’s public reply to this review, if any.
>
> **replyState** `?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.
>
> **replyPolicyViolation** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The policy reason Google gave when it rejected the owner reply, if any.
>
> **stagedReply** `?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.
>
> **stagedReplyAction** `?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.
>
> **reviewUrl** `?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.
>
> **source** `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.
>
> **sourceId** `?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.
>
> **gbpLocationId** `?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.
>
> **archived** `?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.
>
> **createdAt** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **aposShareKey** `?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.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see [Errors and testing](https://docs.fetchski-attract.com/laravel/errors.md)).
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors()` lists each field’s problem, `siteMessage()` the first.
>
> **Retried first:** No. **Read:** `errors()` (field → messages), `siteMessage()`.
>
> **AuthenticationFailed** `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()`.
>
> **Forbidden** `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()`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No: a write may have landed. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **SiteUnreachable** `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()`.
>
> **RequestNotSent** `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).
>
> **SiteRequestFailed** `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()`.
>
> **UnknownSite** `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`.
>
> **SiteConfigurationError** `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`). In published mode (the default) it goes live too, so the key also needs `content:google-reviews:publish` (or a master above it); send `aposMode=draft` to change only the draft. 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/CreateGoogleReviewTest.php`, then run your tests:

```php tests/Feature/CreateGoogleReviewTest.php theme={"dark"}
<?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 CreateGoogleReviewTest extends TestCase
{
    use RefreshDatabase;

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

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

        Attract::assertCalled('googleReviews.createGoogleReview');
    }
}
```

```bash Terminal theme={"dark"}
php artisan test
```

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

```php tests/Feature/CreateGoogleReviewAnswerTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

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

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

        $googleReview = Attract::googleReviews()->createGoogleReview(title: 'Example title', reviewerName: 'Example reviewer name');

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

## Related

> [card] [List a Google review’s locales](https://docs.fetchski-attract.com/laravel/reference/google-reviews/get-google-review-locales.md)
>
> `Attract::googleReviews()->getGoogleReviewLocales()`

> [card] [List Google reviews](https://docs.fetchski-attract.com/laravel/reference/google-reviews/list-google-reviews.md)
>
> `Attract::googleReviews()->listGoogleReviews()`

> [card] [Get a Google review](https://docs.fetchski-attract.com/laravel/reference/google-reviews/get-google-review.md)
>
> `Attract::googleReviews()->getGoogleReview()`

> [card] [Replace a Google review](https://docs.fetchski-attract.com/laravel/reference/google-reviews/replace-google-review.md)
>
> `Attract::googleReviews()->replaceGoogleReview()`

> [card] [Delete a Google review](https://docs.fetchski-attract.com/laravel/reference/google-reviews/delete-google-review.md)
>
> `Attract::googleReviews()->deleteGoogleReview()`

> [card] [Update a Google review](https://docs.fetchski-attract.com/laravel/reference/google-reviews/update-google-review.md)
>
> `Attract::googleReviews()->updateGoogleReview()`

> [card] [POST /google-review](https://docs.fetchski-attract.com/api-reference/google-reviews/create-a-google-review.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.