famdirksen/laravel-google-indexing

Index Laravel website in Google via Indexing API

v0.5 2022-09-27 14:52 UTC

README

Latest Version on Packagist GitHub Tests Action Status Quality Score Total Downloads

WORK IN PROGRESS, some functionalities may be changed in the future.

Request a page to be indexed by Google using the Indexing API.

Please, take a note at the allowed pages that can be index using this API at https://developers.google.com/search/apis/indexing-api/v3/quickstart.

Installation

You can install the package via composer:

composer require famdirksen/laravel-google-indexing

Next you have to follow the setup instructions from Google, this can be found here Google Indexing API documentation.

You need to make a file in your storage direct, but you can override this setting in config with the key laravel-google-indexing.google.auth_config.

Soon we'll publish a blog post on how to setup this package.

Usage

NOTE: this package works only for verified sites in your Google Search Console account

Inform Google about a new or updated URL:

LaravelGoogleIndexing::create()->update('https://www.my-domain.com')

Delete an URL from the index:

LaravelGoogleIndexing::create()->delete('https://www.my-domain.com')

Get the status of an URL:

LaravelGoogleIndexing::create()->status('https://www.my-domain.com')

Or use the Facade

Inform Google about a new or updated URL:

LaravelGoogleIndexing::update('https://www.my-domain.com')

Delete an URL from the index:

LaravelGoogleIndexing::delete('https://www.my-domain.com')

Get the status of an URL:

LaravelGoogleIndexing::status('https://www.my-domain.com')

For dealing with multiple urls, you can pass an array with multiple updated/deleted urls:

LaravelGoogleIndexing::multiplePublish([['URL_UPDATED' => 'https://www.site.com'], ['URL_DELETED' => 'https://www.site.com/deleted-url']])

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email info@famdirksen.nl instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.