API Scopes

Each app requires a particular set of permissions to access various parts of your Google account. These are called scopes and are visible when you first sign into an app, or from your connected apps page. By authorising an app, the token that grants access will remain on your device only - nowhere else!

Great tools take a lot of building.

Our tools are free for everyone, but we want to make more and make these ones even better. If you want amazing technical support, feature requests and a say in what we build next, please consider supporting us.

Support

Here are all the scopes we use, broken down by app, with a short description of why each permission is needed, and what it is used for. Sometimes, scopes are only required when you try to use a certain part or function within an app. These scopes are only requested at that point in time, and are not required for core functionality. We believe in asking for the minimum number of scopes to allow our apps to function. Extra scopes are only required if you want to use that feature (such as sending an email from one of our apps, for example). These scopes are marked as OPTIONAL in the list below.

Classes

An admin tool to monitor, configure and report on all your Google Classrooms.

  • Google
    • email - View your email address

    • Why? In order to display the address of your logged in account on the navigation menu, once you have signed in.

    • profile - View your basic profile info

    • Why? In order to display your name on the navigation menu, once you have signed in.

    • https://www.googleapis.com/auth/classroom.courses.readonly - View Classroom courses

    • Why? In order to read all your / your domain Google Classrooms.

    • https://www.googleapis.com/auth/classroom.rosters.readonly - View your Google Classroom class rosters

    • Why? In order to read Classroom owners and members

    • https://www.googleapis.com/auth/classroom.coursework.students.readonly - View course work and grades for students in the Google Classroom classes you teach or administer OPTIONAL

    • https://www.googleapis.com/auth/classroom.announcements.readonly - View announcements in Google Classroom OPTIONAL

    • https://www.googleapis.com/auth/classroom.topics.readonly - View topics in Google Classroom OPTIONAL

    • https://www.googleapis.com/auth/classroom.student-submissions.students.readonly - View coursework and marks for students in the Google Classroom classes that you teach or administer OPTIONAL

    • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly - View guardians for students in your Google Classroom classes OPTIONAL

    • Why? In order to calculate how many students in each classroom have guardians attached

    • https://www.googleapis.com/auth/classroom.rosters - Manage your Google Classroom class rosters OPTIONAL

    • Why? In order to add/remove Classroom teachers and students

    • https://www.googleapis.com/auth/classroom.courses - Manage your Google Classroom classes OPTIONAL

    • Why? In order to change the Google Classroom course statuses (e.g. archive old Classrooms)

    • https://www.googleapis.com/auth/drive.file - View and manage Google Drive files and folders that you have opened or created with this app OPTIONAL

    • Why? In order to create, and export data to a Google Sheet, we need access to it.

    • https://www.googleapis.com/auth/drive.appdata - View and manage its own configuration data in your Google Drive OPTIONAL

    • Why? In order to record your settings in Google Drive.

    • https://www.googleapis.com/auth/drive.install - Special scope used to let users approve installation of an app. OPTIONAL
    • Why? Allows you to install the app into your Google Drive, making opening it faster and easier from within the Google Drive Web App.
View

Producing customised views of your Google Sheets, with easy filtering and sharing

  • Google
    • email - View your email address

    • Why? In order to display the address of your logged in account on the navigation menu, once you have signed in.

    • profile - View your basic profile info

    • Why? In order to display your name on the navigation menu, once you have signed in.

    • https://www.googleapis.com/auth/drive.file - View and manage Google Drive files and folders that you have opened or created with this app

    • Why? In order to display the Google Drive Picker, at least one ‘Drive’ scope is required, and this is the lowest privilege one.

    • https://www.googleapis.com/auth/spreadsheets.readonly - View your Google Spreadsheets

    • Why? This app needs to load data from your spreadsheets in order to display it, but not to write to them.

    • https://www.googleapis.com/auth/drive.readonly - View the files in your Google Drive

    • Why? In order to read previously saved view files, this ‘readonly’ permissions is required.

    • https://www.googleapis.com/auth/urlshortener - Manage your goo.gl short URLs OPTIONAL

    • Why? Once you have created a link to share in this app, you have the option of using the Google Link Shortener to ‘compress’ it. This scope allows access to that feature.

    • https://www.googleapis.com/auth/drive.install - Special scope used to let users approve installation of an app. OPTIONAL
    • Why? Allows you to install the app into your Google Drive, making opening it faster and easier from within the Google Drive Web App.
Events

Tag and filter your Google Calendar Events

  • Google
    • email - View your email address

    • Why? In order to display the address of your logged in account on the navigation menu, once you have signed in.

    • profile - View your basic profile info

    • Why? In order to display your name on the navigation menu, once you have signed in.

    • https://www.googleapis.com/auth/calendar.readonly - View your calendars

    • Why? In order to display a list of your calendars, this permission is required.

    • https://www.googleapis.com/auth/calendar.events.readonly - View events on all your calendars

    • Why? In order to display calendar events, this permission is required.

    • https://www.googleapis.com/auth/calendar - Manage your calendars OPTIONAL
    • Why? In order to display and manage events from your Google Calendars.
Debug

Development Tests, code verification, process acceptance and tools.

  • Google
    • email - View your email address

    • Why? In order to display the address of your logged in account on the navigation menu, once you have signed in.

    • profile - View your basic profile info

    • Why? In order to display your name on the navigation menu, once you have signed in.

    • https://www.googleapis.com/auth/drive.appdata - View and manage its own configuration data in your Google Drive OPTIONAL

    • Why? In order to record your settings in Google Drive.

    • https://www.googleapis.com/auth/drive.file - View and manage Google Drive files and folders that you have opened or created with this app OPTIONAL
    • Why? In order to create, and read/write data from a Docket Google Sheet, we need access to it.
Reflect

Produce reflective reports, tracking your progress with evidence

  • Google
    • email - View your email address

    • Why? In order to display the address of your logged in account on the navigation menu, once you have signed in.

    • profile - View your basic profile info

    • Why? In order to display your name on the navigation menu, once you have signed in.

    • https://www.googleapis.com/auth/drive.appdata - View and manage its own configuration data in your Google Drive

    • Why? In order to record your settings in Google Drive.

    • https://www.googleapis.com/auth/drive.file - View and manage Google Drive files and folders that you have opened or created with this app

    • Why? In order to display the Google Drive Picker, at least one ‘Drive’ scope is required, and this is the lowest privilege one.

    • https://www.googleapis.com/auth/drive.readonly - View the files in your Google Drive

    • Why? In order to read forms, scales and reports that have been sent to you, this ‘readonly’ permissions is required.

    • https://www.googleapis.com/auth/spreadsheets - View / Edit your Google Spreadsheets OPTIONAL

    • Why? This app needs to write data to your spreadsheets in order to record periodic progress from your reflections.

    • https://www.googleapis.com/auth/drive - View and manage the files in your Google Drive OPTIONAL

    • Why? To sign files that you have opened directly from a link, this permission is needed.

    • https://www.googleapis.com/auth/gmail.send - Send Emails OPTIONAL

    • Why? This app can send emails on your behalf to allow for reports to be validated.

    • https://www.googleapis.com/auth/drive.install - Special scope used to let users approve installation of an app.
    • Why? Allows you to install the app into your Google Drive, making opening it faster and easier from within the Google Drive Web App.
Book

Easily manage, loan and track your G-Suite calendar resources

  • Google
    • email - View your email address

    • Why? In order to display the address of your logged in account on the navigation menu, once you have signed in.

    • profile - View your basic profile info

    • Why? In order to display your name on the navigation menu, once you have signed in.

    • https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly - View calendar resources on your domain

    • Why? In order to display bookable resources, this permission is required.

    • https://www.googleapis.com/auth/admin.directory.resource.calendar - View and manage the provisioning of calendar resources on your domain OPTIONAL

    • Why? In order to manage bookable resources (add, rename, edit etc) this permission is required.

    • https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly - View delegated admin roles for your domain OPTIONAL

    • Why? In order to manage bookings (loan and return) this permission is required.

    • https://www.googleapis.com/auth/calendar.readonly - View your calendars

    • Why? In order to get availability of groups of bookable resources, this permission is required.

    • https://www.googleapis.com/auth/calendar.events.readonly - View events on all your calendars

    • Why? In order to display bookable resources, this permission is required.

    • https://www.googleapis.com/auth/calendar.events - View and edit events on all your calendars OPTIONAL

    • Why? In order to book resources, we need permission to add events to your calendar.

    • https://www.googleapis.com/auth/calendar - Manage your calendars OPTIONAL

    • Why? In order to record loans and returns, we permission to manage events from your Google Calendars.

    • https://www.googleapis.com/auth/drive.file - View and manage Google Drive files and folders that you have opened or created with this app OPTIONAL

    • Why? In order to create, and read/write data from your Booking Log Google Sheet, we need access to it.

    • https://www.googleapis.com/auth/drive.appdata - View and manage its own configuration data in your Google Drive OPTIONAL
    • Why? In order to record your settings in Google Drive.
Folders

Search folders individually, view sizes, starred files and perform bulk conversions

  • Google
    • email - View your email address

    • Why? In order to display the address of your logged in account on the navigation menu, once you have signed in.

    • profile - View your basic profile info

    • Why? In order to display your name on the navigation menu, once you have signed in.

    • https://www.googleapis.com/auth/drive - View and manage the files in your Google Drive

    • Why? In order to search, manage and convert your Drive files.

    • https://www.googleapis.com/auth/admin.directory.group.readonly - View groups on your domain. OPTIONAL

    • Why? Allows you to enumerate group members to see who can access team drives etc.

    • https://www.googleapis.com/auth/drive.install - Special scope used to let users approve installation of an app. OPTIONAL
    • Why? Allows you to install the app into your Google Drive, making opening it faster and easier from within the Google Drive Web App.
Tag-a-doc

View tags in Google Docs and Calendars

  • Google
    • email - View your email address

    • Why? In order to display the address of your logged in account on the extension pop-up, once you have signed in.

    • profile - View your basic profile info

    • Why? In order to display your name on the extension pop-up, once you have signed in.

    • https://www.googleapis.com/auth/drive.readonly - View the files in your Google Drive

    • Why? In order to read metadata tags, file paths and team drive names; this ‘readonly’ permission is required.

    • https://www.googleapis.com/auth/calendar.events.readonly - View the files in your Google Drive
    • Why? In order to read metadata tags for events, this ‘readonly’ permissions is required.
Docket

Organise your days with this simple, diary style, task list that stores your data in your own Google Sheet

  • Google
    • email - View your email address

    • Why? In order to display the address of your logged in account on the navigation menu, once you have signed in.

    • profile - View your basic profile info

    • Why? In order to display your name on the navigation menu, once you have signed in.

    • https://www.googleapis.com/auth/drive.appdata - View and manage its own configuration data in your Google Drive

    • Why? In order to record your settings in Google Drive.

    • https://www.googleapis.com/auth/drive.file - View and manage Google Drive files and folders that you have opened or created with this app

    • Why? In order to create, and read/write data from a Docket Google Sheet, we need access to it.

    • https://www.googleapis.com/auth/calendar.readonly - View your calendars OPTIONAL

    • Why? In order to overlay events from your Google Calendar.

    • https://www.googleapis.com/auth/classroom.courses.readonly - View Classroom courses OPTIONAL

    • Why? In order to read your classes to choose which ones you would like to display deadlines for.

    • https://www.googleapis.com/auth/classroom.coursework.me.readonly - View assignments and questions and the work and grades for the courses that the current user participates in. OPTIONAL

    • Why? In order to read your class assignments and deadlines to display.

    • https://www.googleapis.com/auth/drive - View and manage the files in your Google Drive OPTIONAL

    • Why? To sign files that you have opened directly from a link, this permission is needed.

    • https://www.googleapis.com/auth/classroom.coursework.students.readonly - View assignments and questions and the work and grades for the courses that the current user teaches or administers. OPTIONAL
    • Why? In order to read your class assignments and deadlines to display.
© 2015-2021 educ.io