A simplified package for Google Search Console API
A simplified, object-oriented helper library for the Google Search Console API. This package only covers basic API calls and was mainly created for practice purposes. To get the full Google Search Console API experience see Josh Carty's python wrapper.
Install the library on your local machine.
pip3 install gsclight
Use a Google account to create application credentials, download the JSON file and put it in the same directory as your script with the name
client_secret.json. Every execution of any API-dependent library code,will prompt to perform the auth flow.
from gsclight import oauth CLIENT_SECRET = "../client_secret.json" AUTH_SCOPE = "https://www.googleapis.com/auth/webmasters.readonly" account = oauth.authenticate_to_gsc(CLIENT_SECRET, AUTH_SCOPE)
Use the Google Search Console wrapper to get an overview of all sites your personal account has access as well as all sites your account is verified for (meaning you can request data via the API).
To access data programmatically via the API specify the URI, date range as well as the dimensions your report should contain (metrics always consist of
position). Filters are currently not implemented. The row limit is set to 25,000 rows and can not be adjusted. If you exceed the row limit try to request smaller chunks of data (e.g. apply smaller date range). Per default the search type
web is used, but this can be adjusted to
report, dimensions = account.get_data('https://www.my-website.com/', "2019-09-02", "2019-09-03", 'date', 'device')
In order to use the Google Search Console API response for further analysis the library comes with a built-in function to parse the reports to human-readable dataframes.
from gsclight import parse_report as p df = p.parse_report(report, dimensions) df.head()
Authentication & Client Secrets
This library currently only supports user-based OAuth crendentials. Service accounts can not be used.
The Google OAuth flows requires you to provide a client id and secret in the from of a
JSON file. You can create these in any Google Cloud or Google Developer project:
- Open the Google API Console Credentials page.
- Optional: From the project drop-down, choose Create a new project, enter a name for the project, and optionally, edit the provided Project ID. Click
- On the Credentials page, select
Create credentials, then select
OAuth client ID.
Otherfor the Application type, and enter any additional information required.
- On the page that appears, you can download client id and secret as a JSON file.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.