calendar (v3)
PREREQUISITE: Read
../gws-shared/SKILL.mdfor auth, global flags, and security rules. If missing, rungws generate-skillsto create it.
gws calendar <resource> <method> [flags]Helper Commands
| Command | Description |
|---|---|
+insert |
create a new event |
+agenda |
Show upcoming events across all calendars |
API Resources
acl
deleteโ Deletes an access control rule.getโ Returns an access control rule.insertโ Creates an access control rule.listโ Returns the rules in the access control list for the calendar.patchโ Updates an access control rule. This method supports patch semantics.updateโ Updates an access control rule.watchโ Watch for changes to ACL resources.
calendarList
deleteโ Removes a calendar from the user's calendar list.getโ Returns a calendar from the user's calendar list.insertโ Inserts an existing calendar into the user's calendar list.listโ Returns the calendars on the user's calendar list.patchโ Updates an existing calendar on the user's calendar list. This method supports patch semantics.updateโ Updates an existing calendar on the user's calendar list.watchโ Watch for changes to CalendarList resources.
calendars
clearโ Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.deleteโ Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.getโ Returns metadata for a calendar.insertโ Creates a secondary calendar. The authenticated user for the request is made the data owner of the new calendar.
Note: We recommend to authenticate as the intended data owner of the calendar. You can use domain-wide delegation of authority to allow applications to act on behalf of a specific user. Don't use a service account for authentication. If you use a service account for authentication, the service account is the data owner, which can lead to unexpected behavior.
patchโ Updates metadata for a calendar. This method supports patch semantics.updateโ Updates metadata for a calendar.
channels
stopโ Stop watching resources through this channel
colors
getโ Returns the color definitions for calendars and events.
events
deleteโ Deletes an event.getโ Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID, call the events.list method using the iCalUID parameter.importโ Imports an event. This operation is used to add a private copy of an existing event to a calendar. Only events with an eventType of default may be imported. Deprecated behavior: If a non-default event is imported, its type will be changed to default and any event-type-specific properties it may have will be dropped.insertโ Creates an event.instancesโ Returns instances of the specified recurring event.listโ Returns events on the specified calendar.moveโ Moves an event to another calendar, i.e. changes an event's organizer. Note that only default events can be moved; birthday, focusTime, fromGmail, outOfOffice and workingLocation events cannot be moved.patchโ Updates an event. This method supports patch semantics.quickAddโ Creates an event based on a simple text string.updateโ Updates an event.watchโ Watch for changes to Events resources.
freebusy
queryโ Returns free/busy information for a set of calendars.
settings
getโ Returns a single user setting.listโ Returns all user settings for the authenticated user.watchโ Watch for changes to Settings resources.
Discovering Commands
Before calling any API method, inspect it:
# Browse resources and methods
gws calendar --help
# Inspect a method's required params, types, and defaults
gws schema calendar.<resource>.<method>Use gws schema output to build your --params and --json flags.