Menu
Table of Contents

Google Search Console - v1.0.0

Installation

Install via Composer

composer require artisanpack-ui/google-search-console

The package auto-registers via Laravel's package discovery:

  • Service provider: ArtisanPackUI\GoogleSearchConsole\GoogleSearchConsoleServiceProvider
  • Facade alias: GoogleSearchConsole (ArtisanPackUI\GoogleSearchConsole\Facades\GoogleSearchConsole)

The base artisanpack-ui/google package is pulled in transitively; if you haven't installed it yet, install and configure it now — this package's reporting side refuses to boot without it.

Publish the config (optional)

php artisan vendor:publish --tag=google-search-console-config

Publishes config/google-search-console.php. Override the site URL, API base, cache TTL, scope list, or the HTTP route settings here. Full reference: Configuration.

Publish the views (optional)

php artisan vendor:publish --tag=google-search-console-views

Copies the three Blade views to resources/views/vendor/google-search-console/. Publish only if you need to customize the markup. Every component's view is a plain Blade file using BEM-classed HTML; there's no daisyUI / Tailwind Component library dependency by default. See Components/Livewire.

Publish the JS components (optional)

php artisan vendor:publish --tag=google-search-console-js

Copies the React (resources/js/react/), Vue (resources/js/vue/), and shared fetch layer (resources/js/shared/) sources to resources/js/vendor/google-search-console/. Skip this if you'd rather import from the package's resources/js/ directly. See Components/React and Components/Vue.

Configure your Search Console property

The package queries one Search Console property per app. Add it to .env:

# URL property — include the trailing slash
GSC_SITE_URL="https://example.com/"

# Domain property — use the sc-domain: prefix
GSC_SITE_URL="sc-domain:example.com"

The string must literally match one of the properties Google Search Console lists for the connected account. Trailing slashes, http vs https, and the sc-domain: prefix all matter. See property verification for the debugging routine.

For multi-tenant apps this env var is a footgun — override the container binding instead. See Reporting#Multi-tenant apps.

OAuth scope contribution

The webmasters.readonly scope is contributed to the base package's shared ScopeRegistry automatically on boot via the ap.google.scopes filter hook. The single-consent screen covers Search Console alongside every other Google service.

Users who connected before you installed this package will have needsReauthorize === true on the base package's connection UI, which links them to /google/auth/reauthorize for the delta.

Details: Scopes.

Apply route middleware (optional)

The three HTTP routes mount under /google-search-console with [ 'web', 'auth' ] middleware. Adjust in config/google-search-console.php:

'routes' => [
    'enabled'    => true,
    'prefix'     => 'google-search-console',
    'middleware' => [ 'web', 'auth' ],
],

Set 'enabled' => false to skip HTTP route registration entirely — the correct choice for headless / API-only apps that use only the server-side reporting API. Route reference: HTTP Endpoints.

Verify the install

php artisan route:list --path=google-search-console

You should see:

GET  google-search-console/performance    google-search-console.performance
GET  google-search-console/top-queries    google-search-console.top-queries
GET  google-search-console/top-pages      google-search-console.top-pages

Then from tinker:

php artisan tinker
>>> googleSearchConsole()->hasReporting()
=> true
>>> app( ArtisanPackUI\Google\Scopes\ScopeRegistry::class )->all()
=> [
     "openid",
     "https://www.googleapis.com/auth/userinfo.email",
     "https://www.googleapis.com/auth/userinfo.profile",
     "https://www.googleapis.com/auth/webmasters.readonly",
     ...
   ]

Deeper topics

Continue to Components →