https://github.com/groton-school/colorize-schoolcal
Google Calendar Add-on to set the block color of events synced by SchoolCal
https://github.com/groton-school/colorize-schoolcal
google-apps-script google-calendar google-workspace-add-on
Last synced: 4 months ago
JSON representation
Google Calendar Add-on to set the block color of events synced by SchoolCal
- Host: GitHub
- URL: https://github.com/groton-school/colorize-schoolcal
- Owner: groton-school
- License: gpl-3.0
- Created: 2023-03-02T20:54:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-19T19:35:28.000Z (10 months ago)
- Last Synced: 2025-08-19T20:33:24.295Z (10 months ago)
- Topics: google-apps-script, google-calendar, google-workspace-add-on
- Language: TypeScript
- Homepage:
- Size: 2.76 MB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Colorize SchoolCal
Google Calendar Add-on to set the block color of events synced by SchoolCal
This Google Calendar Add-on searches your calendar for all events synced by SchoolCal from your myGroton Schedule. You can either opt to use pre-defined block colors to assign a color matching the block to your classes, or you can do your own custom search/color-assignment combination. (For example, search for "Advanced History" and color it "Pale Red".) The color palette is limited by the available event colors in Google Calendar.
## Install
[Refer to my gist on Google Workspace Add-on publication](https://gist.github.com/battis/6e32031196316acd1b5e5700b328aef6#file-readme-md) for general directions on how to administratively publish a Google Workspace Add-on.
This add-on is a `Google Workspace Add-on` in its GCP app configuration and uses the Google Calendar API (which should be automatically enabled when you configure the GCP project's OAuth scopes).
To ensure that you only edit events created by SchoolCal, you need to specify your `SchoolSync.SchoolId` in the Script Settings:
1. Visit https://go.schoolcal.com as an administrator
2. Open your web inspector or developer view (whatever your browser calls it) and look at the network traffic. You're looking for requests to `https://go.schoolcal.co/Jobs/CurrentJobs`. In the response to this request, you will see JSON data that starts with your `SchoolId`.
3. Open the script associated with your Google Workspace Add-on ([step 1 of "in the browser"](https://gist.github.com/battis/6e32031196316acd1b5e5700b328aef6#in-the-browser-1)) and click the Project Settings gear in the left-hand sidebar.
4. Add a Script Property with the name `SchoolSync.SchoolId` and the value you determined in step 2.
## Tweaking colors/patterns
This script was written in about 15 minutes, and you may need to adjust it to your purposes. The list of color codes and Google Calendar colors is stored in the [`blocks`](https://github.com/groton-school/colorize-schoolcal/blob/5a6ca20b9970eb3cb06790fc0fea999958a63252/src/Calendar.ts#L3-L11) variable in [`src/Calendar.ts`](https://github.com/groton-school/colorize-schoolcal/blob/main/src/Calendar.ts). You can adjust the patterns and color assignments to suit your need. Note that you will need to quote patterns that include non-alphabetic characters.
```ts
const blocks = {
'Red Block': '11',
OR: '6',
YL: '5',
GR: '2',
LB: '7',
DB: '9',
PR: '3'
};
```
The color codes are defined in the [Google Calendar documentation](https://developers.google.com/apps-script/reference/calendar/event-color) (and can be sneaked from [the menu-creation at the end of the script](https://developers.google.com/apps-script/reference/calendar/event-color) as well).
If you want to adjust how the pattern is matched, you will need to edit the snippet that is currently [` (${code}`](https://github.com/groton-school/colorize-schoolcal/blob/5a6ca20b9970eb3cb06790fc0fea999958a63252/src/Calendar.ts#L29) and therefor matching things like ` (RD`.
## Privacy Policy
This app collects and stores no data.
## Terms of Service
No license or warranty is provided or granted. Use at your own risk.