Use the Google Search Console URL Inspection API in sheets to bulk check indexing and coverage reports. 🚀
Guest Contribution: This is a guest contribution from Google Sheets whizz Mike Richardson, an SEO Consultant from the UK.
Update: This sheet will now allow you to run a longer batch of URLs (the other one would time out due to a 6 minute timeout rule that Apps Script has). Please note, red errors will occur – but this doesn’t matter! Leave the script to run in the background (don’t keep clicking Run), and the data will slowly populate.
This script will automatically run at 10 minute intervals (it will run for 6 minutes, pause for 4, and then resume again). This is because of the timeout limits.
Check out the GIF to see it in action 🎥
Google’s New Search Console URL Inspection API
Google made a huge announcement at the end of January; they were to finally allow webmasters to query indexing and coverage data via an API.
This sheet will pull out basic information from GSC:
- The last time Google crawled the page
- The coverage status
- Whether or not robots.txt is blocking the page
- Whether the page is indexed
- Both the user-declared and Google canonical of a page
This is just the tip of the iceberg – the API provides a lot of other fields to dive in with.
How to use the Sheet
- Make a copy of the sheet.
- You will need a free Google service account to get going with this. If you haven’t got one already, it only takes a few minutes to set up:
- Head to https://console.cloud.google.com/
- Click the drop down in the header (just to the right of ‘Google Cloud Platform’). In the resulting popup click ‘New Project’.
- Add a name for your project and click ‘Create’.
- Make sure your project is selected in the top blue bar. Then, go to the main menu in the top left of the screen, click ‘APIs and Services’ and then click ‘Credentials’.
- Click Create Credentials > Service account
- Add a service account name (this can be anything you want). Click the white Create and Continue button.
- Select the role as Project owner (click Project on the first column, then Owner down the second). Click Continue.
- Type in your Google account email for both the user role and admin role box. Then click Done.
- Now that you are on the account screen, click into the service account you have just created.
- Navigate to the Keys tab, then click Add Key > Create new Key > JSON. A file will start downloading to your computer.
- You then need to pull out the details of this file. Get the client_email, client_id and private_key. Add them to this spreadsheet in the top fields on the sheet. You might want to then hide these rows so your keys are not visible to all.
- Return back to Google Cloud Console and in the top search bar search for ‘Google Search Console API’. Click into it and click ‘Enable’.
- The last step is to take your client_email and add it as a user in the GSC account you are going to query. This can be done by logging into GSC > Settings > Users and permissions > Add user.
- Once you have added your private key, client email and client ID, add the domain property (as it appears in GSC). Remember to take all trailing slashes into account (i.e., https://www.mikejrichardson.com/). Or, if your site is verified as a domain property, enter in the format of mikejrichardson.com.
- Under the URL column, enter all the URLs you want to analyse.
- Click the green ‘Run’ button. The script will start to run and the data will gradually populate in the sheet. The first time you run, you may be asked for authorization. Continue through these steps, and then click the green Run button again.
- When the script finishes (if you have a long list of URLs it will result in an error), don’t click Run again. It will automatically pick up where it left off several minutes later.
What if the script times out?
For a big batch of URLs, it will time out due to Apps Script timeout rules. However, even if you see the red timeout message, this is expected behaviour.
Several minutes later the script will resume again.
Are there any limitations?
Of course! This was created within hours of Google’s announcement. The API offers a host of opportunities.
As well as the additional fields that you could return, there are plenty of other things you could consider:
- Set up rules to check if the canonical tags are different
- Add conditional formatting to cells
Thanks for stopping by 👋
I’m Andrew Charlton, the Google Sheets nerd behind Keywords in Sheets. 🤓
Questions? Get in touch with me on social or comment below 👇