Menu
Table of Contents

Analytics - Google - v1.0.0

Configuration

This page collects every configurable knob in config/analytics-google.php organized by the task you're trying to accomplish. For a straight top-to-bottom mirror of the published config file, see Configuration reference. For env-var-specific detail, see Environment variables.

Publishing

php artisan vendor:publish --tag=analytics-google-config

Copies config/analytics-google.php into your app. The published file is the source of truth.

Task-oriented reference

I want to turn tracking on / off

  • Turn it off: unset GA4_MEASUREMENT_ID, or set GA4_TRACKING_ENABLED=false.
  • Turn it on: set both.

The @ga4Snippet directive and React/Vue components respect this switch. When off, they emit nothing at all.

I want to change the GA4 property server-side reporting targets

Set GA4_PROPERTY_ID. Or set analytics-google.reporting.property_id directly. Overridable per call via Ga4DataClient::runReport( $request, $connection, $propertyId ).

'tracking' => [
    'respect_consent' => false,
],

See Consent Integration for the full picture.

I want to customize the gtag('config', …) options

'tracking' => [
    'config' => [
        'anonymize_ip'  => true,
        'send_page_view' => false,
    ],
],

Keep values to primitives — the emitted <script> uses JSON-escape flags to prevent breakout, but complex object graphs are still noisy.

I want to change the cache TTL for reports

'reporting' => [
    'cache_ttl' => 300,
],

Set to 0 to disable. See Caching for the key shape and store-selection details.

I want to change the request timeout for the Data API

'reporting' => [
    'timeout' => 30,
],

Trips ReportingException::transportFailure() on timeout.

I want to disable the HTTP endpoints (headless / API app)

'routes' => [
    'enabled' => false,
],

Livewire components still work — they hit the fetchers directly and never touch the routes.

I want to move the endpoints under a different prefix

'routes' => [
    'prefix' => 'admin/analytics',
],

The React and Vue components accept a baseUrl prop so you can point them at the new prefix without editing the shipped source.

I want to change route middleware

'routes' => [
    'middleware' => [ 'web', 'auth', 'can:view-analytics' ],
],

Anything in the Laravel middleware pipeline works. The default [ 'web', 'auth' ] mounts the routes under the session guard needed for the controller's $request->user() calls.

I want to rename the provider registered with the analytics parent

'provider_name' => 'google-analytics',

Then add google-analytics to artisanpack.analytics.active_providers on the parent. See Analytics Parent Integration.

I want to change the OAuth scopes contributed to the base

'scopes' => [
    'https://www.googleapis.com/auth/analytics.readonly',
    'https://www.googleapis.com/auth/analytics.edit', // for example
],

Contributed to the base's ScopeRegistry via ap.google.scopes. Also add the new scope to the OAuth consent screen — see Google Cloud setup.