Breadcrumbs

Configure Google Workspace

Prerequisites

The Google Workspace Admin SDK Reports API has several prerequisites, which can be found in the Google Admin SDK Documentation. Most importantly, for access to the Google Admin Console, you need:

  • A Super Administrator account to enable API Access; and

  • An admin account with the Reports Administrator privilege to create and grant permission to the application.

Create a Project

  1. Open the Google API Console: https://console.developers.google.com

  2. Open the Select a Project window, and then click New Project.
    image2022-1-12_18-37-52.png

  3. Give the project a name, such as "demo."

    If you are familiar with Google APIs and projects, you can use an existing project.


  4. (Optional) Edit the Project ID and Organization.

  5. Click Enable APIs and Services.
    image2022-1-12_18-51-59.png

  6. In the search bar, type Admin SDK.
    image2022-1-12_18-53-24.png

  7. Click Admin SDK API, and then click Enable.
    image2022-1-12_18-54-11.png

Create Credentials

  1. Open the Google API Console: https://console.developers.google.com.

  2. From the top-left menu, select your project (in the example below, "demo."
    image2022-1-12_19-1-27.png

  3. Click the OAuth Consent Screen tab, select Internal as the User Type, and then click Create.
    image2022-1-13_1-5-56.png

  4. Enter the App Name, User Support Email, and Developer Contact Information on this page.
    image2022-1-13_1-8-36.png

  5. Click Save and Continue.
    image2022-1-13_1-13-45.png

  6. Click Add or Remove Scopes.
    image2022-1-13_1-28-32.png

  7.  Click on the Filter field, select API, and then select Admin SDK API from the drop-down
    image2022-1-13_1-32-15.png

  8.  Click on the Filter field again, type Reports, hit enter, and select both of the listed APIs.  Finally, click on Update to save the scopes.
    image2022-1-13_1-35-37.png

  9.  Newly added scopes will be shown on the dashboard.  Click Save and Continue. Finally, click on the Credentials option in the left menu.
    image2022-1-13_1-41-16.png

  10. Open the Create Credentials drop-down menu, and click OAuth client ID.

    image2022-1-13_1-48-11.png

  11. On the Create OAuth Client ID page, do the following:

    1. For Application type, select Desktop App.

    2. Enter a Name, such as "lr-gsbeat."

    3. Click Create.

      Your OAuth Consent screen config may look different than the screenshot below. Ensure that you fill out all required fields.

      image2022-1-13_1-50-20.png

  12. The OAuth client window appears with your client ID and client secret.
    image2019-5-30_13-45-35.png

  13. Copy the client ID and paste it into a text editor. It will be used to configure the app in the workspace admin portal.

  14. To close the popup, click OK.
    The client ID is now populated on the Credentials page.

  15. Download the JSON credentials. You need them to Initialize the Google Workspace Beat.
    image2022-1-13_1-53-16.png

Enable API Access

  1. Open the Google Admin console: https://admin.google.com.

  2. On the home page, click Security.
    image2022-1-13_2-2-54.png

  3. Click API Controls.
    image2022-1-13_2-4-18.png

  4. Click Manage Third-Party App Access.
    image2022-1-13_2-6-59.png

  5. Click on Add app, and select OAuth App Name or Client ID.
    image2022-1-13_2-24-19.png

  6. Paste the Client ID copied in the Create Credentials section, and click Search.
    image2022-1-21_16-50-22.png

  7. Select OAuth Client ID and the client ID you pasted, then click Select. 
    image2022-1-21_16-51-42.png

  8. Select the Trusted: Can access all Google services option, and then click Configure.
    image2022-1-13_2-32-11.png

  9.  Your app is configured to be used, and you can now Initialize the Google Workspace Beat.