README

Formerly omnireach/search-console (renamed on 2026-11-10 with its family: Omnireach\ is now Omnipulse\; this package replaces the former name).

omnisense/omnipulse's Google Search Console, under any PHP host: a property's search queries, pages, countries and devices with their clicks, impressions, CTR and average position, day by day or over a period - for a site taken over, the history of its pages before and after.

use Omnipulse\Registry;
use Omnipulse\SearchConsole\SearchConsoleFactory;
use Symfony\Component\HttpClient\HttpClient;

$registry = new Registry([new SearchConsoleFactory(HttpClient::create())], [
    'google' => ['factory' => 'search-console', 'options' => ['site' => 'sc-domain:example.org', 'credentials' => '/secrets/service-account.json']],
]);

Options: site (sc-domain:example.org or https://example.org/), credentials or access_token (scope webmasters.readonly; the service account added as a user of the property), data_state (final, or all for the provisional last days), url.

The API

POST sites/{site}/searchAnalytics/query (https://developers.google.com/webmaster-tools): startDate, endDate, dimensions (query, page, country, device, date - combined freely), dimensionFilterGroups (equals), rowLimit (25,000 at most) and startRow for pages, dataState. Countries come as ISO 3166-1 alpha-3 (FRA, upper-cased here), devices lower-cased.

Terms and limits (https://developers.google.com/webmaster-tools/terms, https://developers.google.com/webmaster-tools/limits): load quotas per site, per user and per project - a query grouped by page or query costs more; 16 months of data; the top rows only (anonymized queries are left out of a query breakdown).

Google credentials: a service account's JSON key (credentials: the JSON or the path of its file) - the token is asked with a JWT signed by its key (RS256, the OAuth 2.0 JWT bearer grant) and kept until a minute before it expires - or an access_token obtained elsewhere. GoogleToken is the same class in omnipulse/search-console and omnipulse/ga4.

Reuse: Google's PHP libraries were set aside: google/apiclient with google/apiclient-services (every Google API generated, a very large package, its own Guzzle stack), google/analytics-data (gRPC and protobuf through google/gax), google/auth (Guzzle again). The family injects the application's HTTP client and needs one JSON call per report and one signed JWT, done here with ext-openssl.

Usage policy

Search Console's usage policy is declared as data in policy.json (omnisense/contracts' schema, named in composer.json's extra.omnisense.policy), its terms read on 2026-11-10 (https://developers.google.com/webmaster-tools/limits): Search Analytics: 1,200 queries a minute per site and per user, 40,000 a minute and 30,000,000 a day per project; rights unknown; OAuth credentials. omnipulse's registry enforces it - a call over a limit is never made, a 429 and its Retry-After hold every next call (UsageLimitReachedException) - and a site may tighten it, never loosen it (omnisense/omnipulse's docs/policies.md).

Verified, and not

Verified (the core's harness, PHP 8.4): a query by query and country with two filters, the request's body and URL, the service account's token (asked once, kept; the JWT's claims, its signature checked with the key's public half - a key made by the test), credentials from JSON or a file, a refused property - against answers composed in the shape the reference documents, not recorded; every class loading with the package's requirements alone (BareTest).
Not verified live: no Google account was used.

Licence

MIT. An unofficial client, affiliated with Google in no way.

omnipulse / search-console

Package info

Security

Statistics

README

The API

Usage policy

Verified, and not

Licence