Administrator

How do I integrate G Suite to enable Google Drive collaboration?

Follow
Ryan Richins
  • Agilix team member
  • Updated:
    info_outline
    Created:

During the summer of 2017, we released a new Buzz UI, giving you the same features and functionality with a cleaner, simpler user experience!

The features covered in this article are only included in the new Buzz UI. If you don't know which version you are using, review the differences and/or contact your system admin or Agilix account manager.

G Suite integration enables:

  • Easy creation of Google Drive documents in the Student app when completing a dropbox activity. Previously, if students wanted to submit an activity as a Google Doc, they had to create the document in their Google Drive, then open the activity in Buzz and search for that document to attach. Now they can create and submit all within Buzz.
  • PDF snapshots of Google Drive submissions. When a student submits an activity as a Google Doc, Buzz creates a PDF snapshot that is available to both the student and the teacher. This way a record remains if the student makes changes to the document, or even if the Google Drive account is deactivated.
  • Automatic permissions management. Google Docs makes collaboration and inline commenting easy, as long as all members have the correct permissions. With G Suite integration, Buzz automatically gives students (including students that are in the same group assignment) and teachers the correct permissions for easy collaboration. If, for any reason, permissions are not correctly granted, users will simply ask for permission using Google Drive.
  • Automatic copies of Google Drive documents when duplicating activities. Teachers can include Google Drive documents as part of activities. If a colleague wants to duplicate the activity for their own use, they can easily copy the attached Google Drive document to their Google Drive for their own use.

G Suite integration is managed by Admins at your root domain. Once it is set up, it is inherited by all subdomains.

In order to set up your G Suite integration:

Create a service account

1. Create a project

Any Google Cloud Platform resources that you allocate and use must belong to a project.You can think of a project as the organizing entity for what you're building. A project is made up of the settings, permissions, and other metadata that describe your applications. Learn more about projects.

If you already have a project that you want to use, you can skip to Step 2. Enable the Google Drive API.

To create a project:

  1. Go to the Google Developers Console (https://console.developers.google.com/project) and sign in as a super administrator.
  2. Create a new project in one of the following ways:
    • If you haven't used the Developers Console before, agree to the Google Cloud Platform Terms of Service. Then, click Create a project.
    • If you have used the Developers Console, click the down arrow at the top of the screen next to your most recent project name to open your projects list. Click Create.
  3. Enter a project name and click Create.

2. Enable the Google Drive API

In order for Buzz to interface with the Google Drive API, you need to enable it.

  1. Go to the API dashboard (https://console.developers.google.com/apis/dashboard) and select the project you created or selected in Step 1.
  2. Click Enable APIs and Services in the Dashboard.
  1. Search for Google Drive API and select it from the results.
  1. Click Enable.

3. Create a service account for the project

In order for Buzz to manage permissions effectively, it needs access to your Google service account.

  1. Open the Menu in the top-left corner of the console and click IAM & Admin > Service accounts.
  1. Click Create Service Account, and in the popup that appears, enter a title in the Service Account Name field.
  2. Check the Furnish a new private key box and ensure the key type is set to JSON.
  3. Check the Enable Domain-wide Delegation box and enter a name in the Product name for the consent screen field.
  4. Click Save.
  1. You'll see a message that the service account JSON file has been downloaded to your computer. You will need it later, so make a note of the location and name of this file. Click Close.
  2. You can click the View Client ID link to review the service account you have just created. Copy the Client ID value. You will need this in Step 4.

4. Enable API client access for the service account

Once Google Drive API is enable, you need to give Buzz access to the service account.

Tips

Your organization may have multiple active domains within your G Suite account (e.g., @studentemail.com, @teacheremail.com, @parentemail.com). If so, each of these domains need the client access you set up in these steps, and you need to repeat them for each domain.

  1. In your G Suite domain’s Admin console (https://admin.google.com), select Security from the list of controls.
    • If you don't see Security listed, select More controls from the gray bar at the bottom of the page, then select Security from the list of controls.
    • If you can't see the controls, make sure you're signed in as an administrator for the domain.
  1. In Security, select Show more > Advanced settings, and then click Manage API client access next to Authentication.
  1. In the Client Name field, enter the service account's Client ID. You should have copied this in Step 3, or you can find it in the Service accounts page.
  2. In the One or More API Scopes field, enter “https://www.googleapis.com/auth/drive”
  3. Click Authorize.

Enable G Suite integration on Buzz

Once you have a Google service account created, you can enable the G Suite integration:  

  1. Open the side menu in Domain > Details.
  2. Select Configure G Suite.
  1. Check Enable G Suite service account box.
  2. Choose the Google Drive folder name (this is The top-most Drive folder where Buzz stores documents).
  3. Click Edit service-account key.
  1. Copy and paste the contents from the .json file that Google provided when you set up your service account into this field.
  2. Click Done.

When users open Google Drive from Buzz for the first time, they may be asked to verify the access, sign into their account, indicate which account, etc. Review the possible requests pictured here.

Users' browsers must allow Google to popup windows.

Error messaging

  • If the Google Drive fails to create or copy documents, Buzz reports an error.
  • If the Google Drive cannot correctly grant permissions, Buzz does not report an error and users will simply ask for permission from the document author using Google Drive screens.
  • If Google fails to generate a PDF snapshot, Buzz attaches a TXT file to the activity in the PDF's place, alerting you of the issue.

Comments

Please sign in to leave a comment.