Authoritas is a comprehensive SEO software platform that supports professional SEO teams to produce consistent organic growth.
We've built an add-on for Google Sheets which allows you to use our Keyword Research, Keyword rank tracking and SERPs API tools within Google Sheets, to help you easily research keywords and run keyword rank checks for your site and your competitors.
You'll be pleased to hear that you can use the add-on totally for free for up to 1,000 keyword requests per month :) - All we ask in return, is for a nice review on the Google Apps marketplace (should you think we deserve it) and perhaps helping us to spread the word with your friends and colleagues.
Google Workspace Users - Credit Allowance
If you are using Google Workspace and you install the add-on as individual users, then each user will get 1,000 free keyword requests. Standard priority requests costs 1 credit, but high priority requests cost 2 credits per keyword phrase and will consume your allowance more quickly.
If you are a Google Workspace admin and you install it as a 'Domain Install', then this will give all users access to this add-on but the initial complementary credit allowance will be split across all users in your organisation.
Upgrading your credit allowance
If you need to increase your credit allowance, please contact us via our website. We will be adding simple, cost-effective keyword ranking and researching pricing in the near future.
- Perform one-off or regular scheduled keyword ranking tasks and check the rankings of multiple domains in one go
- Pull-in and analyse the top 100 competitors for any keyword in any major search engine worldwide
- Perform in-depth keyword research and get related keywords, questions people ask, universal SERP features and unique to Authoritas - the keyword or user intent for the keyword phrase
- Once the data is in Sheets you can easily visualise it in Google Data Studio and/or send it to Big Query
- If you are considering using the Authoritas SERPs API for your SEO project, then the Google Sheets add-on is a great way to test the API without having to get an engineer to do it for you
- You need to get an API key - it is free for your first 1,000 requests per month
- Simply complete the form here: https://www.authoritas.com/request-free-serps-api-key/
- You then need to install the "Authoritas SEO - The Really Useful Keyword Tool" add-on for your Google account or Google Workspace domain
- Visit [Google Workspace Marketplace Link] and install the add-on for your account.
- If you are a Google Workspace domain administrator and wish to install this for your entire domain, then click ‘Domain install’.
The "Really Useful Keyword Tool" add-on gives access to three core SEO tools provided by the Authoritas SERPs API:
- Keyword Ranking - This replicates the keyword ranking functionality found in the Authoritas SEO platform
- Top 100 SERP View - This gives you the complete listing of all ranking URLs and universal search results for each keyword, as if you had made a request to the Authoritas SERPs API
- Keyword Research - This gives you deep information about your keyword and related keywords and replicates some of the advanced keyword research tools and data in the SEO platform
You have the option to query all 3 tools at once or to just select the specific tools and output format you are interested in.
Step-by-step Guide - How to Make a Request
The add-on is split into 6 main sections:
Section 1: Adding a list of keywords or phrases for which to make SERP requests
Create a sheet or select an existing sheet - In the first step, create a sheet in which to put the keywords or phrases that you want to make SERP requests for. This can be any sheet, but the add-on will read the list of keywords from column A of the chosen sheet.
Enter the sheet name - The Sheet’s name should be entered into the input box in order to identify which sheet to get keywords from. The keywords/phrases should be entered from cell A2 onwards as this gives leeway for a header column in row 1.
Press 'Refresh' to check the list of words and display the number found.
If the sheet name entered in the input box doesn’t exist in the current Spreadsheet, this will be indicated by a red border around the input box. Attempting to make API requests without a valid sheet will result in failed calls, as no phrase will be provided in the request.
Section 2: SERPs API Service Selection
As mentioned at the beginning of this tutorial, the add-on supports three SEO tools provided by the Authoritas SERPs API. For each set of keywords, the services which you wish to use for the data analysis must be selected in the Step 2 input box.
N/B: At least one service must be selected. If no services are selected then the API call will not be made, and the grey bar at the top where the text “Step 2: Select Services” is displayed will turn red until at least one service is checked.
Section 3: Setting up the parameters of the request
This is the section in which the parameters in the request to the SERPs API should be set. The values of certain parameters in some cases depend on the values of others (for example London isn’t an accepted value for the Town Selection if the Country is set to say, Indonesia).
The add-on will handle incompatible values so that only valid parameters will be available based on what values have already been entered.
The selections will be broken down below, but you can read the Authoritas SERPs API documentation for more detailed information on the request. The request object information can be found here, and the full list of supported search engines, regions, languages and towns is available on this page.
The search engine selector is simply the search engine to query the SERP results from. This is the search engine from which the results will be returned. e.g. Google, Yahoo, etc.
The country selector will be automatically unlocked and populated once the search engine field has been filled. Not all search engines have the same country availability, as can be seen on the supported countries link previously mentioned.
The language selector, much like the country selector, is populated depending on the value selected in the previous fields, in this case both search engine and country.
If, for example, the search engine Google is chosen along with Germany as the country, then both German and English will be available languages to select from. If the search engine chosen is instead Yahoo, then for Germany, only German is available in the language selector. This is handled by the add-on so incompatible parameters can not be chosen together.
Once the language has been chosen, the rest of the fields will become unlocked.
The town selector is populated with a list of supported towns by the API. This is dependent on the country, and much like for the language selector this is populated automatically.
The API will only accept value for either town, or latitude and longitude. Selecting a town will cause the latitude and longitude inputs to become disabled, and vice versa is also true.
The latitude and longitude inputs will only take valid values - this is a numerical value between -90 and +90 for latitude, and between -180 and +180 for longitude.
Be aware, that it is possible to input coordinates for a location outside of the country selected. The add-on will presume that the latitude and longitude values entered are within the borders of the country that has been chosen and so will make no check to see if it is valid. If it is not valid, the API call will be made anyway, but will fail.
The Device parameter specifies for which user agent to emulate the search engine query - either a desktop or mobile device.
The priority selector lets the API know with which priority to treat the request. A standard priority request will use 1 API credit, but high-priority is also available, which will speed up the availability of the request for a cost of 2 API credits.
The Update Frequency is defined as how often should the SERP request be made.
Three options are available:
Weekly - automatically repeat this check on a weekly schedule.
Monthly - automatically repeat this check on a monthly schedule.
Ad-hoc - make a one-off request and do not schedule this in the future.
Section 4: Domain tracking selection
This section is only available if Keyword Rankings is selected in step 2. These are domains to track in the SERP results.
The domain tracker will validate URLs that are entered into the domain tracker and do two things:
- Check if the URL redirects to another location. If it does, it will continually follow the redirects until a final endpoint is hit. It will then replace the initially entered URL with the final location.
- If the URL is valid, then the input box will turn green indicating such. If the URL is not valid, then the input box will turn red indicating that the URL does not return a 200 status code and should be checked before making the request (shown below).
If more than two domains are to be tracked for a given keyword, then additional domains can be added by pressing the + button. In a similar vein, unwanted domain fields can be removed with the - button next to them.
Section 5: Setting up email address and API key
Once an API key has been obtained by filling out the form at the link in the Prerequisites section of this page, you can enter the API key provided to you in this section.
This is the API key that the add-on will use to make the API requests. The email address should be the same as the one with which you signed up for the API key.
Section 6: Response Polling Options
The response polling options allows the frequency with which the API should be checked for results from the keyword requests made. By default, the add-on will set this to every 6 hours, meaning that the first time a request to check if the results are ready will be made 6 hours after the initial request.
Due to the Google Workspace add-on environment, an add-on trigger can not run more frequently than once per hour, so this is the minimum allowed response polling time.
There may be a delay of ±15 minutes for polling requests, this is normal and is an artifact of Google Apps Script trigger functionality.
When the add-on is installed and opened for the first time, in order to perform actions on your behalf a consent screen will appear, asking to give permission for the add-on to have certain levels of access to your account.
The add-on will request certain scopes of access so that it can perform its functions. The consent screen that is presented will look similar to the one here, with buttons that say Allow and Cancel underneath.
In order to use the add-on, you must grant it access to the scopes presented to you. The scopes of access and justifications are as follows:
"View and manage spreadsheets that this application has been installed in"
View, modify and share with other users spreadsheets that this application has been installed in
The add-on will be able to perform actions on Spreadsheets in your Drive, including editing, copying, creating and deleting. The add-on however only has access to the current Spreadsheet - that is to say, the only Spreadsheet it can make any changes to is the one that it is being actively used in. The changing of another spreadsheet from this context is disallowed.
"Connect to an external service"
Create a network connection to any external service (e.g. to read or write data)
The add-on will make requests to the Authoritas SERPs API endpoint located at v3.api.analyticsseo.com/serps/. This is used to make both initial requests, as well as for polling the API for results.
"Allow this application to run when you are not present"
Allow this application to run when you are not present
Certain background processes are created which allows for the results to be retrieved and processed by the add-on while the spreadsheet isn’t open. This means that a set of requests can be made, and without you being present the results will be polled and entered into the Spreadsheet automatically.
"Display and run third-party web content in prompts and sidebars inside Google applications"
Display third-party web content in prompts and sidebars inside Google applications
"Run third-party code in your browser"
"Receive data you input"
This is required to be able to display UI elements such as the sidebar at the right-hand side of the Spreadsheet. It allows data to be inputted into the add-on for configuration, such as request settings or API keys.
Setting up the Trigger Schedules and making API requests
There are two buttons at the bottom of the sidebar: the verbose “Set up Trigger Schedule” and the concise “Run” buttons.
When the add-on is first opened, the consent screen previously mentioned will appear. Before authorisation has been granted, the add-on cannot set up the API polling so this must be set up manually. All that needs to be done is to click the “Set up Trigger Schedule” button once. Although clicking it more than once will not cause issues, it is not recommended.
The “Run” button performs two actions: it validates that the request parameters entered are valid, and assuming that they are, makes a request with all the parameters entered for each keyword in the sheet.
If for whatever reason the request parameters are not valid, the problem fields will be highlighted in red until they are fixed.
Deleting the app and your user data
Simply remove the add-on from Google Sheets in the normal way.
We do not store any personal data, other than the details you provided when you requested the API key. If you would like us to delete your personal details please email us at the address below.
Need Further Help?
Please raise a ticket or contact email@example.com with any suggestions or if you have any issues installing or running the add-on, or if you spot a bug.
Please sign in to leave a comment.