searchConsoleR demo

Function Quick Guide

Search analytics

search_analytics() - download Google SEO data into an R dataframe.

Website admin

list_websites() - list websites in your Google Search Console.
add_website() - add a website to your Google Search Console.
delete_website() - delete a website from your Google Search Console.

Sitemaps

list_sitemaps() - list sitemaps recognised in Google Search Console.
add_sitemap() - add sitemap URL location to Google Search Console.
delete_sitemap() - remove sitemap URL location in Google Search Console.

Error listings

crawl_errors() - list various types of crawl errors googlebot has found.
list_crawl_error_samples() - get a list of example URLs with errors.
error_sample_url() - show details about an example URL error (for example, links to a 404 URL)
fix_sample_url() - make a URL as fixed.

Authentication functions from googleAuthR

gar_auth() - main authentication function. Works locally and within a Shiny environment.

Guide

Install googleAuthR from CRAN

install.packages("googleAuthR")
library(searchConsoleR)

Install searchConsoleR.

install.packages("searchConsoleR")
library(searchConsoleR)

Work flow always starts with authenticating with Google.

scr_auth()

Your browser window should open up and go through the Google sign in OAuth2 flow. Verify with a user that has Search Console access to the websites you want to work with.

Check out the documentation of any function for a guide on what else can be done.

?scr_auth

If it works, you should see a list of your websites in the Search Console via:

sc_websites <- list_websites()
sc_websites

We’ll need sc_websites$siteUrl for the majority of the other functions.

Most people will find the search analytics most useful. All methods from the web interface are available. Here is an example query:

gbr_desktop_queries <- 
    search_analytics("http://example.com", 
                     "2015-07-01", "2015-08-01", 
                     c("query", "page"), 
                     dimensionFilterExp = c("device==DESKTOP","country==GBR"), 
                     searchType = "web", searchAppearance = "AMP_BLUE_LINKS",
                     aggregationType = "byPage", rowLimit = 100))

dimensionFilterExp

Filter your API results using this format: filter operator expression

Filter can be one of:

‘country’,
‘device’
‘page’
‘query’
‘searchAppearance’)

Operator can be one of ~~, ==, !~, != where the symbols mean:

~~ : ‘contains’,
== : ‘equals’,
!~ : ‘notContains’,
!= : ‘notEquals’)

Expression for page or query if freeform.

Expression for country must be the three letter country code as per the [the ISO 3166-1 alpha-3] standard. e.g. GBR

Expression for device must be one of:

‘MOBILE’
‘DESKTOP’
‘TABLET’

Expression for searchAppearance must be one of:

‘AMP_BLUE_LINKS’
‘RICHCARD’

You can have multiple AND filters by putting them in a character vector.

c("device==DESKTOP","country==GBR")

OR filters aren’t supported yet in the API.