Skip to content

Configuration for Google Sheets API

To allow the Archipelago Multi Importer (AMI) to read from Google spreadsheets, you first need to configure the Google Sheets API as outlined in the following instructions.

Please note:

  • Frequent changes to the Google Sheets API specifications may impact the configurations needed.
  • This set of instructions will only work for individuals using Google accounts affiliated with Organizations.
  • Please contact us on our Archipelago Commons Google Group with any questions/issues.

Generating Google OAuth2 Credentials

  1. Login to the Google Developer Console. You will see the API & Services Dashboard.

    Developer Console

  2. If you have not created Credentials or a Project before, you will need to first create a Project.

    • Recommended Project Name: "Archipelago Multi Importer" or "AMI".
    • The Organization and Location information should be specific to you and your organization/institution.

    Create Project

  3. Next, click the Create credentials select box and select OAuth client ID

    Create credentials select

  4. You will now need to Configure the Consent Screen.

    Configure Consent Screen

  5. On the initial OAuth Consent Screen setup, select Internal for User Type.

    OAuth Consent Screen Setup

  6. Now enter AMI as the App name, and your email address in the User support email. You may also wish to add Authorized domains (bottom of image below) as well.

    OAuth Consent App Info

  7. On the Scopes page, select Add or Remove Scopes. Then either search/filter the API table for the Google Sheets API. Or, under Manually add scopes enter:

    Scopes Setup 1

  8. After selecting or entering in the Google Sheets API, you should see this listed under Sensitive Scopes.

    Scopes Setup 2

  9. Review the information on the Summary page, then Save.

    Oauth Summary

  10. You will now be able to Create Oauth client ID. Select Web Application as the Application type

    Application Type

  11. Enter "AMI" under 'Name' and add any URIs you will be using below.

    • For using AMI within your local Archipelago environment, enter http://localhost:8001/google_api_client/callback
    • All URIs need to include /google_api_client/callback

      OauthClientID Configuration

  12. After Saving, you will see a message notifying you that the OAuth client was created. You can copy the Client ID and Client Secret directly from this confirmation message into a text editor. You can also access the information from Credentials in the APIs & Services section in the Developer console, where you will have additional options for downloading, copying, and modifying if needed.

    OauthClientID Details

    Google API Client Listing

  13. On the 'Add Google Api Client account' configuration page, enter the following information using your Client ID and Client Secret. 'Developer Key' is optional. Select Google Sheets API under 'Services' and https://www, under 'Scopes'. Check the box for Is Access Type Offline. Select the Save button.

    Add GoogleAPI Client Account

  14. You will now need to Authenticate your AMI Google API Client. Return to the Google API Client Listing page. Under the Operation menu on the right-hand side of the AMI client listing, select Authenticate.


  15. You will be directed to the Google Consent Screen. You may need to login to your corresponding Google Account before proceeding. When loged in, you will see the following screen requesting that AMI is allowed to "View your Google Spreadsheets". Click Allow.

    Google Consent

  16. On the Google API Client Listing page, your AMI client listing should now have 'Yes' under 'Is Authenticated'. You are now ready to use Google Sheets with AMI! Return to the main AMI documentation page to get started.

Thank you for reading! Please contact us on our Archipelago Commons Google Group with any questions or feedback.

Return to the Archipelago Documentation main page.