novembro 17, 2023
Read and write out of office and focus time events using the Calendar API
What’s changing
In addition to reading and writing working location data, we’re expanding the Calendar API functionality to encompass out of office and focus time data. Developers can use the API to read and write this information and synchronize users’ availability with external systems. For example, you can use the API in conjunction with HR systems to automatically add OOO entries to a user’s calendar when they submit vacation time. Or the API can be used to automatically block focus time on a user’s calendar to complete training courses.
- Reading and writing out of office and focus time is helpful in a variety of situations such as:
- Creating and updating OOO and Focus Time events (Events.Insert, Events.Update, Events.Patch).
- Specifying OOO and Focus Time specific features, such as auto-declining meetings, and setting do-not-disturb statuses.
- Selecting any combination of event types to read from a calendar (Events.List).
Further, reading and writing this information eliminates the need for users to enter the same information into multiple systems, helping to cut down on manual churn.
Who’s impacted
Developers
Why you’d use it
Out of office and focus time event support joins support for working location, which was announced earlier this year, to round out API functionality for calendar events. Each specific event type can be synced throughout your organization's IT ecosystem, creating seamless user journeys and helping to connect users with resources and each other. This includes things such as:
- Mapping working location data to better adapt on-site resources and update other third-party surfaces, such as hot desk booking tools.
- Automatically blocking OOO based on vacation or PTO requests.
- Blocking off focus time events to give users time to go through onboarding or other company training programs.
Additional details
Prior to this update, if you requested to read a user’s calendar via API v3, out of office and focus time events were returned with unknownorganizer@calendar.google.com in the organizer field, and without their specific features. With this update, these events will return with all their properties and the specific user as organizer. Please check your code to ensure it does not make implicit assumptions about the previous API return values, and use the eventType parameter to perform different operations with regular, OOO, Focus Time, or Working Location events
Getting started
- Admins: There is no admin control for this feature.
- Developers: Use our Developer Documentation for more information about managing focus time, out of office, and working location events.
- End users: There is no end user action required. Visit the Help Center to learn more about showing when you're out of office or using focus time in Calendar.
Rollout pace
- Rapid Release and Scheduled Release domains: Extended rollout (potentially longer than 15 days for feature visibility) starting on November 16, 2023
Availability
- The Calendar API is available to all.
- Out of Office events are available to Google Workspace Essentials, Enterprise Essentials, Frontline, Enterprise Starter, Enterprise Standard, Enterprise Plus, Nonprofits, Business Starter, Business Standard, Business Plus, Education Fundamentals, Education Standard, and Education Plus customers.
- Focus Time events are available to Google Workspace Enterprise Starter, Enterprise Standard, Enterprise Plus, Nonprofits, Business Standard, Business Plus, Education Fundamentals, Education Standard, and Education Plus customers.