{ "basePath": "/calendar/v3/", "resources": { "acl": { "methods": { "list": { "description": "Returns the rules in the access control list for the calendar.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.acls", "https://www.googleapis.com/auth/calendar.acls.readonly" ], "path": "calendars/{calendarId}/acl", "supportsSubscription": true, "response": { "$ref": "Acl" }, "id": "calendar.acl.list", "httpMethod": "GET", "parameterOrder": [ "calendarId" ], "parameters": { "calendarId": { "type": "string", "required": true, "location": "path", "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword." }, "maxResults": { "minimum": "1", "location": "query", "type": "integer", "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.", "format": "int32" }, "pageToken": { "location": "query", "type": "string", "description": "Token specifying which result page to return. Optional." }, "syncToken": { "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.", "location": "query", "type": "string" }, "showDeleted": { "type": "boolean", "location": "query", "description": "Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False." } } }, "insert": { "parameters": { "calendarId": { "type": "string", "required": true, "location": "path", "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword." }, "sendNotifications": { "description": "Whether to send notifications about the calendar sharing change. Optional. The default is True.", "type": "boolean", "location": "query" } }, "id": "calendar.acl.insert", "httpMethod": "POST", "parameterOrder": [ "calendarId" ], "response": { "$ref": "AclRule" }, "description": "Creates an access control rule.", "request": { "$ref": "AclRule" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.acls" ], "path": "calendars/{calendarId}/acl" }, "update": { "response": { "$ref": "AclRule" }, "description": "Updates an access control rule.", "request": { "$ref": "AclRule" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.acls" ], "path": "calendars/{calendarId}/acl/{ruleId}", "parameters": { "calendarId": { "type": "string", "required": true, "location": "path", "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword." }, "ruleId": { "description": "ACL rule identifier.", "location": "path", "type": "string", "required": true }, "sendNotifications": { "description": "Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.", "type": "boolean", "location": "query" } }, "id": "calendar.acl.update", "httpMethod": "PUT", "parameterOrder": [ "calendarId", "ruleId" ] }, "delete": { "path": "calendars/{calendarId}/acl/{ruleId}", "description": "Deletes an access control rule.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.acls" ], "parameterOrder": [ "calendarId", "ruleId" ], "id": "calendar.acl.delete", "httpMethod": "DELETE", "parameters": { "calendarId": { "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.", "type": "string", "required": true, "location": "path" }, "ruleId": { "description": "ACL rule identifier.", "type": "string", "required": true, "location": "path" } } }, "get": { "response": { "$ref": "AclRule" }, "parameters": { "calendarId": { "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.", "type": "string", "required": true, "location": "path" }, "ruleId": { "type": "string", "required": true, "location": "path", "description": "ACL rule identifier." } }, "parameterOrder": [ "calendarId", "ruleId" ], "id": "calendar.acl.get", "httpMethod": "GET", "path": "calendars/{calendarId}/acl/{ruleId}", "description": "Returns an access control rule.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.acls", "https://www.googleapis.com/auth/calendar.acls.readonly", "https://www.googleapis.com/auth/calendar.readonly" ] }, "patch": { "parameters": { "calendarId": { "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.", "location": "path", "type": "string", "required": true }, "ruleId": { "location": "path", "type": "string", "required": true, "description": "ACL rule identifier." }, "sendNotifications": { "type": "boolean", "location": "query", "description": "Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True." } }, "parameterOrder": [ "calendarId", "ruleId" ], "id": "calendar.acl.patch", "httpMethod": "PATCH", "response": { "$ref": "AclRule" }, "path": "calendars/{calendarId}/acl/{ruleId}", "description": "Updates an access control rule. This method supports patch semantics.", "request": { "$ref": "AclRule" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.acls" ] }, "watch": { "supportsSubscription": true, "response": { "$ref": "Channel" }, "path": "calendars/{calendarId}/acl/watch", "description": "Watch for changes to ACL resources.", "request": { "$ref": "Channel", "parameterName": "resource" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.acls", "https://www.googleapis.com/auth/calendar.acls.readonly" ], "parameters": { "showDeleted": { "location": "query", "type": "boolean", "description": "Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False." }, "calendarId": { "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.", "type": "string", "required": true, "location": "path" }, "maxResults": { "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.", "format": "int32", "minimum": "1", "type": "integer", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "Token specifying which result page to return. Optional." }, "syncToken": { "location": "query", "type": "string", "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries." } }, "parameterOrder": [ "calendarId" ], "id": "calendar.acl.watch", "httpMethod": "POST" } } }, "calendars": { "methods": { "clear": { "parameters": { "calendarId": { "location": "path", "type": "string", "required": true, "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword." } }, "parameterOrder": [ "calendarId" ], "id": "calendar.calendars.clear", "httpMethod": "POST", "path": "calendars/{calendarId}/clear", "description": "Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.calendars" ] }, "delete": { "path": "calendars/{calendarId}", "description": "Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.calendars" ], "parameterOrder": [ "calendarId" ], "id": "calendar.calendars.delete", "httpMethod": "DELETE", "parameters": { "calendarId": { "type": "string", "required": true, "location": "path", "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword." } } }, "get": { "response": { "$ref": "Calendar" }, "parameters": { "calendarId": { "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "calendarId" ], "id": "calendar.calendars.get", "httpMethod": "GET", "path": "calendars/{calendarId}", "description": "Returns metadata for a calendar.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.calendars", "https://www.googleapis.com/auth/calendar.calendars.readonly", "https://www.googleapis.com/auth/calendar.readonly" ] }, "patch": { "id": "calendar.calendars.patch", "httpMethod": "PATCH", "parameterOrder": [ "calendarId" ], "parameters": { "calendarId": { "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.", "type": "string", "required": true, "location": "path" } }, "description": "Updates metadata for a calendar. This method supports patch semantics.", "request": { "$ref": "Calendar" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.calendars" ], "path": "calendars/{calendarId}", "response": { "$ref": "Calendar" } }, "update": { "response": { "$ref": "Calendar" }, "description": "Updates metadata for a calendar.", "request": { "$ref": "Calendar" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.calendars" ], "path": "calendars/{calendarId}", "parameters": { "calendarId": { "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.", "type": "string", "required": true, "location": "path" } }, "id": "calendar.calendars.update", "httpMethod": "PUT", "parameterOrder": [ "calendarId" ] }, "insert": { "path": "calendars", "description": "Creates a secondary calendar.\nThe authenticated user for the request is made the data owner of the new calendar.\n\nNote: 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. For example, if a service account is the data owner, data ownership cannot be transferred.", "request": { "$ref": "Calendar" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.calendars" ], "id": "calendar.calendars.insert", "httpMethod": "POST", "response": { "$ref": "Calendar" } } } }, "freebusy": { "methods": { "query": { "id": "calendar.freebusy.query", "httpMethod": "POST", "description": "Returns free/busy information for a set of calendars.", "request": { "$ref": "FreeBusyRequest" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.events.freebusy", "https://www.googleapis.com/auth/calendar.freebusy", "https://www.googleapis.com/auth/calendar.readonly" ], "path": "freeBusy", "response": { "$ref": "FreeBusyResponse" } } } }, "channels": { "methods": { "stop": { "path": "channels/stop", "description": "Stop watching resources through this channel", "request": { "$ref": "Channel", "parameterName": "resource" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.acls", "https://www.googleapis.com/auth/calendar.acls.readonly", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.calendarlist", "https://www.googleapis.com/auth/calendar.calendarlist.readonly", "https://www.googleapis.com/auth/calendar.events", "https://www.googleapis.com/auth/calendar.events.freebusy", "https://www.googleapis.com/auth/calendar.events.owned", "https://www.googleapis.com/auth/calendar.events.owned.readonly", "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.events.readonly", "https://www.googleapis.com/auth/calendar.readonly", "https://www.googleapis.com/auth/calendar.settings.readonly" ], "id": "calendar.channels.stop", "httpMethod": "POST" } } }, "events": { "methods": { "delete": { "path": "calendars/{calendarId}/events/{eventId}", "description": "Deletes an event.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", "https://www.googleapis.com/auth/calendar.events.owned" ], "parameterOrder": [ "calendarId", "eventId" ], "id": "calendar.events.delete", "httpMethod": "DELETE", "parameters": { "eventId": { "description": "Event identifier.", "location": "path", "type": "string", "required": true }, "calendarId": { "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.", "type": "string", "required": true, "location": "path" }, "sendNotifications": { "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.", "type": "boolean", "location": "query" }, "sendUpdates": { "description": "Guests who should receive notifications about the deletion of the event.", "enum": [ "all", "externalOnly", "none" ], "enumDescriptions": [ "Notifications are sent to all guests.", "Notifications are sent to non-Google Calendar guests only.", "No notifications are sent. For calendar migration tasks, consider using the Events.import method instead." ], "location": "query", "type": "string" } } }, "patch": { "description": "Updates an event. This method supports patch semantics.", "request": { "$ref": "Event" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", "https://www.googleapis.com/auth/calendar.events.owned" ], "path": "calendars/{calendarId}/events/{eventId}", "response": { "$ref": "Event" }, "id": "calendar.events.patch", "httpMethod": "PATCH", "parameterOrder": [ "calendarId", "eventId" ], "parameters": { "eventId": { "type": "string", "required": true, "location": "path", "description": "Event identifier." }, "alwaysIncludeEmail": { "location": "query", "type": "boolean", "description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided)." }, "calendarId": { "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.", "type": "string", "required": true, "location": "path" }, "maxAttendees": { "location": "query", "type": "integer", "minimum": "1", "format": "int32", "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional." }, "sendUpdates": { "enumDescriptions": [ "Notifications are sent to all guests.", "Notifications are sent to non-Google Calendar guests only.", "No notifications are sent. For calendar migration tasks, consider using the Events.import method instead." ], "location": "query", "type": "string", "description": "Guests who should receive notifications about the event update (for example, title changes, etc.).", "enum": [ "all", "externalOnly", "none" ] }, "conferenceDataVersion": { "maximum": "1", "minimum": "0", "type": "integer", "location": "query", "description": "Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.", "format": "int32" }, "sendNotifications": { "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.", "location": "query", "type": "boolean" }, "supportsAttachments": { "location": "query", "type": "boolean", "description": "Whether API client performing operation supports event attachments. Optional. The default is False." } } }, "watch": { "supportsSubscription": true, "response": { "$ref": "Channel" }, "description": "Watch for changes to Events resources.", "request": { "$ref": "Channel", "parameterName": "resource" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", "https://www.googleapis.com/auth/calendar.events.freebusy", "https://www.googleapis.com/auth/calendar.events.owned", "https://www.googleapis.com/auth/calendar.events.owned.readonly", "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.events.readonly", "https://www.googleapis.com/auth/calendar.readonly" ], "path": "calendars/{calendarId}/events/watch", "parameters": { "singleEvents": { "location": "query", "type": "boolean", "description": "Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False." }, "maxAttendees": { "type": "integer", "location": "query", "minimum": "1", "format": "int32", "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional." }, "maxResults": { "description": "Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.", "format": "int32", "default": "250", "minimum": "1", "type": "integer", "location": "query" }, "syncToken": { "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin All other query parameters should be the same as for the initial synchronization to avoid undefined behavior. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.", "location": "query", "type": "string" }, "timeMin": { "description": "Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.", "type": "string", "format": "date-time", "location": "query" }, "updatedMin": { "description": "Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.", "location": "query", "type": "string", "format": "date-time" }, "timeMax": { "description": "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.", "location": "query", "type": "string", "format": "date-time" }, "timeZone": { "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.", "type": "string", "location": "query" }, "sharedExtendedProperty": { "type": "string", "location": "query", "description": "Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.", "repeated": true }, "eventTypes": { "description": "Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.", "repeated": true, "enum": [ "birthday", "default", "focusTime", "fromGmail", "outOfOffice", "workingLocation" ], "enumDescriptions": [ "Special all-day events with an annual recurrence.", "Regular events.", "Focus time events.", "Events from Gmail.", "Out of office events.", "Working location events." ], "location": "query", "type": "string" }, "iCalUID": { "location": "query", "type": "string", "description": "Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID." }, "privateExtendedProperty": { "type": "string", "location": "query", "description": "Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.", "repeated": true }, "q": { "description": "Free text search terms to find events that match these terms in the following fields:\n\n- summary \n- description \n- location \n- attendee's displayName \n- attendee's email \n- organizer's displayName \n- organizer's email \n- workingLocationProperties.officeLocation.buildingId \n- workingLocationProperties.officeLocation.deskId \n- workingLocationProperties.officeLocation.label \n- workingLocationProperties.customLocation.label \nThese search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for \"Office\" or \"Bureau\" returns working location events of type officeLocation, whereas searching for \"Out of office\" or \"Abwesend\" returns out-of-office events. Optional.", "type": "string", "location": "query" }, "showHiddenInvitations": { "description": "Whether to include hidden invitations in the result. Optional. The default is False.", "type": "boolean", "location": "query" }, "orderBy": { "enum": [ "startTime", "updated" ], "description": "The order of the events returned in the result. Optional. The default is an unspecified, stable order.", "type": "string", "enumDescriptions": [ "Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)", "Order by last modification time (ascending)." ], "location": "query" }, "showDeleted": { "description": "Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.", "type": "boolean", "location": "query" }, "calendarId": { "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.", "location": "path", "type": "string", "required": true }, "pageToken": { "description": "Token specifying which result page to return. Optional.", "location": "query", "type": "string" }, "alwaysIncludeEmail": { "description": "Deprecated and ignored.", "type": "boolean", "location": "query" } }, "id": "calendar.events.watch", "httpMethod": "POST", "parameterOrder": [ "calendarId" ] }, "quickAdd": { "id": "calendar.events.quickAdd", "httpMethod": "POST", "parameterOrder": [ "calendarId", "text" ], "description": "Creates an event based on a simple text string.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", "https://www.googleapis.com/auth/calendar.events.owned" ], "path": "calendars/{calendarId}/events/quickAdd", "parameters": { "calendarId": { "type": "string", "required": true, "location": "path", "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword." }, "sendNotifications": { "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.", "type": "boolean", "location": "query" }, "sendUpdates": { "description": "Guests who should receive notifications about the creation of the new event.", "enum": [ "all", "externalOnly", "none" ], "enumDescriptions": [ "Notifications are sent to all guests.", "Notifications are sent to non-Google Calendar guests only.", "No notifications are sent. For calendar migration tasks, consider using the Events.import method instead." ], "location": "query", "type": "string" }, "text": { "description": "The text describing the event to be created.", "location": "query", "type": "string", "required": true } }, "response": { "$ref": "Event" } }, "update": { "parameterOrder": [ "calendarId", "eventId" ], "id": "calendar.events.update", "httpMethod": "PUT", "parameters": { "alwaysIncludeEmail": { "location": "query", "type": "boolean", "description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided)." }, "eventId": { "type": "string", "required": true, "location": "path", "description": "Event identifier." }, "calendarId": { "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.", "location": "path", "type": "string", "required": true }, "maxAttendees": { "type": "integer", "location": "query", "minimum": "1", "format": "int32", "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional." }, "sendUpdates": { "description": "Guests who should receive notifications about the event update (for example, title changes, etc.).", "enum": [ "all", "externalOnly", "none" ], "enumDescriptions": [ "Notifications are sent to all guests.", "Notifications are sent to non-Google Calendar guests only.", "No notifications are sent. For calendar migration tasks, consider using the Events.import method instead." ], "location": "query", "type": "string" }, "conferenceDataVersion": { "format": "int32", "description": "Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.", "type": "integer", "location": "query", "maximum": "1", "minimum": "0" }, "supportsAttachments": { "description": "Whether API client performing operation supports event attachments. Optional. The default is False.", "location": "query", "type": "boolean" }, "sendNotifications": { "type": "boolean", "location": "query", "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false." } }, "path": "calendars/{calendarId}/events/{eventId}", "description": "Updates an event.", "request": { "$ref": "Event" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", "https://www.googleapis.com/auth/calendar.events.owned" ], "response": { "$ref": "Event" } }, "instances": { "parameters": { "eventId": { "description": "Recurring event identifier.", "location": "path", "type": "string", "required": true }, "alwaysIncludeEmail": { "description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).", "location": "query", "type": "boolean" }, "originalStart": { "description": "The original start time of the instance in the result. Optional.", "type": "string", "location": "query" }, "showDeleted": { "type": "boolean", "location": "query", "description": "Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False." }, "calendarId": { "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.", "type": "string", "required": true, "location": "path" }, "maxAttendees": { "location": "query", "type": "integer", "minimum": "1", "format": "int32", "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional." }, "maxResults": { "minimum": "1", "location": "query", "type": "integer", "description": "Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.", "format": "int32" }, "pageToken": { "description": "Token specifying which result page to return. Optional.", "location": "query", "type": "string" }, "timeMin": { "description": "Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.", "type": "string", "format": "date-time", "location": "query" }, "timeMax": { "location": "query", "type": "string", "format": "date-time", "description": "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset." }, "timeZone": { "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.", "type": "string", "location": "query" } }, "id": "calendar.events.instances", "httpMethod": "GET", "parameterOrder": [ "calendarId", "eventId" ], "response": { "$ref": "Events" }, "supportsSubscription": true, "description": "Returns instances of the specified recurring event.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", "https://www.googleapis.com/auth/calendar.events.freebusy", "https://www.googleapis.com/auth/calendar.events.owned", "https://www.googleapis.com/auth/calendar.events.owned.readonly", "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.events.readonly", "https://www.googleapis.com/auth/calendar.readonly" ], "path": "calendars/{calendarId}/events/{eventId}/instances" }, "move": { "response": { "$ref": "Event" }, "parameters": { "eventId": { "description": "Event identifier.", "type": "string", "required": true, "location": "path" }, "calendarId": { "description": "Calendar identifier of the source calendar where the event currently is on.", "location": "path", "type": "string", "required": true }, "destination": { "location": "query", "type": "string", "required": true, "description": "Calendar identifier of the target calendar where the event is to be moved to." }, "sendUpdates": { "enum": [ "all", "externalOnly", "none" ], "description": "Guests who should receive notifications about the change of the event's organizer.", "type": "string", "enumDescriptions": [ "Notifications are sent to all guests.", "Notifications are sent to non-Google Calendar guests only.", "No notifications are sent. For calendar migration tasks, consider using the Events.import method instead." ], "location": "query" }, "sendNotifications": { "type": "boolean", "location": "query", "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false." } }, "parameterOrder": [ "calendarId", "eventId", "destination" ], "id": "calendar.events.move", "httpMethod": "POST", "path": "calendars/{calendarId}/events/{eventId}/move", "description": "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.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.events", "https://www.googleapis.com/auth/calendar.events.owned" ] }, "insert": { "response": { "$ref": "Event" }, "path": "calendars/{calendarId}/events", "description": "Creates an event.", "request": { "$ref": "Event" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", "https://www.googleapis.com/auth/calendar.events.owned" ], "parameters": { "sendNotifications": { "type": "boolean", "location": "query", "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false." }, "supportsAttachments": { "description": "Whether API client performing operation supports event attachments. Optional. The default is False.", "location": "query", "type": "boolean" }, "conferenceDataVersion": { "maximum": "1", "minimum": "0", "type": "integer", "location": "query", "description": "Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.", "format": "int32" }, "calendarId": { "type": "string", "required": true, "location": "path", "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword." }, "maxAttendees": { "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.", "format": "int32", "minimum": "1", "type": "integer", "location": "query" }, "sendUpdates": { "enumDescriptions": [ "Notifications are sent to all guests.", "Notifications are sent to non-Google Calendar guests only.", "No notifications are sent. Warning: Using the value none can have significant adverse effects, including events not syncing to external calendars or events being lost altogether for some users. For calendar migration tasks, consider using the events.import method instead." ], "location": "query", "type": "string", "description": "Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.", "enum": [ "all", "externalOnly", "none" ] } }, "parameterOrder": [ "calendarId" ], "id": "calendar.events.insert", "httpMethod": "POST" }, "get": { "response": { "$ref": "Event" }, "parameters": { "calendarId": { "type": "string", "required": true, "location": "path", "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword." }, "maxAttendees": { "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.", "format": "int32", "minimum": "1", "type": "integer", "location": "query" }, "alwaysIncludeEmail": { "type": "boolean", "location": "query", "description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided)." }, "eventId": { "description": "Event identifier.", "type": "string", "required": true, "location": "path" }, "timeZone": { "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.", "location": "query", "type": "string" } }, "parameterOrder": [ "calendarId", "eventId" ], "id": "calendar.events.get", "httpMethod": "GET", "path": "calendars/{calendarId}/events/{eventId}", "description": "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.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", "https://www.googleapis.com/auth/calendar.events.freebusy", "https://www.googleapis.com/auth/calendar.events.owned", "https://www.googleapis.com/auth/calendar.events.owned.readonly", "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.events.readonly", "https://www.googleapis.com/auth/calendar.readonly" ] }, "import": { "description": "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.\nDeprecated 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.", "request": { "$ref": "Event" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", "https://www.googleapis.com/auth/calendar.events.owned" ], "path": "calendars/{calendarId}/events/import", "response": { "$ref": "Event" }, "id": "calendar.events.import", "httpMethod": "POST", "parameterOrder": [ "calendarId" ], "parameters": { "conferenceDataVersion": { "maximum": "1", "minimum": "0", "type": "integer", "location": "query", "description": "Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.", "format": "int32" }, "supportsAttachments": { "location": "query", "type": "boolean", "description": "Whether API client performing operation supports event attachments. Optional. The default is False." }, "calendarId": { "type": "string", "required": true, "location": "path", "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword." } } }, "list": { "id": "calendar.events.list", "httpMethod": "GET", "parameterOrder": [ "calendarId" ], "parameters": { "alwaysIncludeEmail": { "description": "Deprecated and ignored.", "type": "boolean", "location": "query" }, "calendarId": { "type": "string", "required": true, "location": "path", "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword." }, "pageToken": { "description": "Token specifying which result page to return. Optional.", "type": "string", "location": "query" }, "eventTypes": { "enum": [ "birthday", "default", "focusTime", "fromGmail", "outOfOffice", "workingLocation" ], "description": "Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.", "repeated": true, "type": "string", "enumDescriptions": [ "Special all-day events with an annual recurrence.", "Regular events.", "Focus time events.", "Events from Gmail.", "Out of office events.", "Working location events." ], "location": "query" }, "iCalUID": { "description": "Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.", "type": "string", "location": "query" }, "sharedExtendedProperty": { "type": "string", "location": "query", "description": "Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.", "repeated": true }, "privateExtendedProperty": { "location": "query", "type": "string", "description": "Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.", "repeated": true }, "q": { "location": "query", "type": "string", "description": "Free text search terms to find events that match these terms in the following fields:\n\n- summary \n- description \n- location \n- attendee's displayName \n- attendee's email \n- organizer's displayName \n- organizer's email \n- workingLocationProperties.officeLocation.buildingId \n- workingLocationProperties.officeLocation.deskId \n- workingLocationProperties.officeLocation.label \n- workingLocationProperties.customLocation.label \nThese search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for \"Office\" or \"Bureau\" returns working location events of type officeLocation, whereas searching for \"Out of office\" or \"Abwesend\" returns out-of-office events. Optional." }, "showHiddenInvitations": { "location": "query", "type": "boolean", "description": "Whether to include hidden invitations in the result. Optional. The default is False." }, "orderBy": { "enum": [ "startTime", "updated" ], "description": "The order of the events returned in the result. Optional. The default is an unspecified, stable order.", "type": "string", "enumDescriptions": [ "Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)", "Order by last modification time (ascending)." ], "location": "query" }, "showDeleted": { "location": "query", "type": "boolean", "description": "Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False." }, "singleEvents": { "description": "Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.", "type": "boolean", "location": "query" }, "timeMin": { "location": "query", "type": "string", "format": "date-time", "description": "Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax." }, "maxAttendees": { "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.", "format": "int32", "minimum": "1", "type": "integer", "location": "query" }, "maxResults": { "default": "250", "minimum": "1", "type": "integer", "location": "query", "description": "Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.", "format": "int32" }, "syncToken": { "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin All other query parameters should be the same as for the initial synchronization to avoid undefined behavior. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.", "type": "string", "location": "query" }, "updatedMin": { "type": "string", "format": "date-time", "location": "query", "description": "Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time." }, "timeMax": { "type": "string", "format": "date-time", "location": "query", "description": "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin." }, "timeZone": { "location": "query", "type": "string", "description": "Time zone used in the response. Optional. The default is the time zone of the calendar." } }, "description": "Returns events on the specified calendar.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", "https://www.googleapis.com/auth/calendar.events.freebusy", "https://www.googleapis.com/auth/calendar.events.owned", "https://www.googleapis.com/auth/calendar.events.owned.readonly", "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.events.readonly", "https://www.googleapis.com/auth/calendar.readonly" ], "path": "calendars/{calendarId}/events", "response": { "$ref": "Events" }, "supportsSubscription": true } } }, "settings": { "methods": { "list": { "path": "users/me/settings", "description": "Returns all user settings for the authenticated user.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.readonly", "https://www.googleapis.com/auth/calendar.settings.readonly" ], "id": "calendar.settings.list", "httpMethod": "GET", "response": { "$ref": "Settings" }, "parameters": { "maxResults": { "minimum": "1", "location": "query", "type": "integer", "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.", "format": "int32" }, "pageToken": { "description": "Token specifying which result page to return. Optional.", "location": "query", "type": "string" }, "syncToken": { "type": "string", "location": "query", "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries." } }, "supportsSubscription": true }, "get": { "path": "users/me/settings/{setting}", "description": "Returns a single user setting.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.readonly", "https://www.googleapis.com/auth/calendar.settings.readonly" ], "parameterOrder": [ "setting" ], "id": "calendar.settings.get", "httpMethod": "GET", "response": { "$ref": "Setting" }, "parameters": { "setting": { "description": "The id of the user setting.", "type": "string", "required": true, "location": "path" } } }, "watch": { "path": "users/me/settings/watch", "description": "Watch for changes to Settings resources.", "request": { "$ref": "Channel", "parameterName": "resource" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.readonly", "https://www.googleapis.com/auth/calendar.settings.readonly" ], "response": { "$ref": "Channel" }, "supportsSubscription": true, "id": "calendar.settings.watch", "httpMethod": "POST", "parameters": { "maxResults": { "format": "int32", "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.", "location": "query", "type": "integer", "minimum": "1" }, "pageToken": { "location": "query", "type": "string", "description": "Token specifying which result page to return. Optional." }, "syncToken": { "type": "string", "location": "query", "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries." } } } } }, "calendarList": { "methods": { "insert": { "id": "calendar.calendarList.insert", "httpMethod": "POST", "path": "users/me/calendarList", "description": "Inserts an existing calendar into the user's calendar list.", "request": { "$ref": "CalendarListEntry" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.calendarlist" ], "response": { "$ref": "CalendarListEntry" }, "parameters": { "colorRgbFormat": { "type": "boolean", "location": "query", "description": "Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False." } } }, "list": { "id": "calendar.calendarList.list", "httpMethod": "GET", "description": "Returns the calendars on the user's calendar list.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.calendarlist", "https://www.googleapis.com/auth/calendar.calendarlist.readonly", "https://www.googleapis.com/auth/calendar.readonly" ], "path": "users/me/calendarList", "supportsSubscription": true, "parameters": { "minAccessRole": { "description": "The minimum access role for the user in the returned entries. Optional. The default is no restriction.", "enum": [ "freeBusyReader", "owner", "reader", "writer", "writerWithoutPrivateAccess" ], "enumDescriptions": [ "The user can read free/busy information.", "The user can read and modify events and access control lists.", "The user can read events that are not private.", "The user can read and modify events.", "The user can read and modify events that aren't private. The user can read free/busy information about private events. The user can't modify private events." ], "location": "query", "type": "string" }, "showDeleted": { "description": "Whether to include deleted calendar list entries in the result. Optional. The default is False.", "location": "query", "type": "boolean" }, "maxResults": { "type": "integer", "location": "query", "minimum": "1", "format": "int32", "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional." }, "pageToken": { "type": "string", "location": "query", "description": "Token specifying which result page to return. Optional." }, "showHidden": { "type": "boolean", "location": "query", "description": "Whether to show hidden entries. Optional. The default is False." }, "syncToken": { "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.", "type": "string", "location": "query" } }, "response": { "$ref": "CalendarList" } }, "delete": { "description": "Removes a calendar from the user's calendar list.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.calendarlist" ], "path": "users/me/calendarList/{calendarId}", "id": "calendar.calendarList.delete", "httpMethod": "DELETE", "parameterOrder": [ "calendarId" ], "parameters": { "calendarId": { "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.", "location": "path", "type": "string", "required": true } } }, "get": { "response": { "$ref": "CalendarListEntry" }, "parameters": { "calendarId": { "location": "path", "type": "string", "required": true, "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword." } }, "path": "users/me/calendarList/{calendarId}", "description": "Returns a calendar from the user's calendar list.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.calendarlist", "https://www.googleapis.com/auth/calendar.calendarlist.readonly", "https://www.googleapis.com/auth/calendar.readonly" ], "parameterOrder": [ "calendarId" ], "id": "calendar.calendarList.get", "httpMethod": "GET" }, "patch": { "parameters": { "calendarId": { "location": "path", "type": "string", "required": true, "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword." }, "colorRgbFormat": { "location": "query", "type": "boolean", "description": "Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False." } }, "id": "calendar.calendarList.patch", "httpMethod": "PATCH", "parameterOrder": [ "calendarId" ], "response": { "$ref": "CalendarListEntry" }, "description": "Updates an existing calendar on the user's calendar list. This method supports patch semantics.", "request": { "$ref": "CalendarListEntry" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.calendarlist" ], "path": "users/me/calendarList/{calendarId}" }, "watch": { "response": { "$ref": "Channel" }, "supportsSubscription": true, "description": "Watch for changes to CalendarList resources.", "request": { "$ref": "Channel", "parameterName": "resource" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.calendarlist", "https://www.googleapis.com/auth/calendar.calendarlist.readonly", "https://www.googleapis.com/auth/calendar.readonly" ], "path": "users/me/calendarList/watch", "parameters": { "minAccessRole": { "description": "The minimum access role for the user in the returned entries. Optional. The default is no restriction.", "enum": [ "freeBusyReader", "owner", "reader", "writer", "writerWithoutPrivateAccess" ], "enumDescriptions": [ "The user can read free/busy information.", "The user can read and modify events and access control lists.", "The user can read events that are not private.", "The user can read and modify events.", "The user can read and modify events that aren't private. The user can read free/busy information about private events. The user can't modify private events." ], "location": "query", "type": "string" }, "showDeleted": { "description": "Whether to include deleted calendar list entries in the result. Optional. The default is False.", "type": "boolean", "location": "query" }, "maxResults": { "type": "integer", "location": "query", "minimum": "1", "format": "int32", "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional." }, "pageToken": { "description": "Token specifying which result page to return. Optional.", "location": "query", "type": "string" }, "showHidden": { "description": "Whether to show hidden entries. Optional. The default is False.", "type": "boolean", "location": "query" }, "syncToken": { "type": "string", "location": "query", "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries." } }, "id": "calendar.calendarList.watch", "httpMethod": "POST" }, "update": { "parameters": { "calendarId": { "type": "string", "required": true, "location": "path", "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword." }, "colorRgbFormat": { "description": "Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.", "location": "query", "type": "boolean" } }, "id": "calendar.calendarList.update", "httpMethod": "PUT", "parameterOrder": [ "calendarId" ], "response": { "$ref": "CalendarListEntry" }, "description": "Updates an existing calendar on the user's calendar list.", "request": { "$ref": "CalendarListEntry" }, "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.calendarlist" ], "path": "users/me/calendarList/{calendarId}" } } }, "colors": { "methods": { "get": { "response": { "$ref": "Colors" }, "id": "calendar.colors.get", "httpMethod": "GET", "description": "Returns the color definitions for calendars and events.", "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.calendarlist", "https://www.googleapis.com/auth/calendar.calendarlist.readonly", "https://www.googleapis.com/auth/calendar.events.freebusy", "https://www.googleapis.com/auth/calendar.events.owned", "https://www.googleapis.com/auth/calendar.events.owned.readonly", "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.readonly" ], "path": "colors" } } } }, "version": "v3", "baseUrl": "https://www.googleapis.com/calendar/v3/", "servicePath": "calendar/v3/", "ownerName": "Google", "id": "calendar:v3", "icons": { "x16": "http://fonts.gstatic.com/s/i/productlogos/calendar_2020q4/v8/web-16dp/logo_calendar_2020q4_color_1x_web_16dp.png", "x32": "http://fonts.gstatic.com/s/i/productlogos/calendar_2020q4/v8/web-32dp/logo_calendar_2020q4_color_1x_web_32dp.png" }, "revision": "20260617", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/workspace/calendar/firstapp", "kind": "discovery#restDescription", "parameters": { "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string", "location": "query" }, "alt": { "enum": [ "json" ], "description": "Data format for the response.", "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json" ], "location": "query", "default": "json" }, "userIp": { "type": "string", "location": "query", "description": "Deprecated. Please use quotaUser instead." }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "prettyPrint": { "type": "boolean", "location": "query", "description": "Returns response with indentations and line breaks.", "default": "true" }, "quotaUser": { "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", "type": "string", "location": "query" } }, "protocol": "rest", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/calendar": { "description": "See, edit, share, and permanently delete all the calendars you can access using Google Calendar" }, "https://www.googleapis.com/auth/calendar.events.public.readonly": { "description": "See the events on public calendars" }, "https://www.googleapis.com/auth/calendar.acls.readonly": { "description": "See the sharing permissions of Google calendars you own" }, "https://www.googleapis.com/auth/calendar.acls": { "description": "See and change the sharing permissions of Google calendars you own" }, "https://www.googleapis.com/auth/calendar.freebusy": { "description": "View your availability in your calendars" }, "https://www.googleapis.com/auth/calendar.calendars.readonly": { "description": "See the title, description, default time zone, and other properties of Google calendars you have access to" }, "https://www.googleapis.com/auth/calendar.events.freebusy": { "description": "See the availability on Google calendars you have access to" }, "https://www.googleapis.com/auth/calendar.events.readonly": { "description": "View events on all your calendars" }, "https://www.googleapis.com/auth/calendar.calendars": { "description": "See and change the properties of Google calendars you have access to, and create secondary calendars" }, "https://www.googleapis.com/auth/calendar.events": { "description": "View and edit events on all your calendars" }, "https://www.googleapis.com/auth/calendar.events.owned.readonly": { "description": "See the events on Google calendars you own" }, "https://www.googleapis.com/auth/calendar.calendarlist.readonly": { "description": "See the list of Google calendars you’re subscribed to" }, "https://www.googleapis.com/auth/calendar.readonly": { "description": "See and download any calendar you can access using your Google Calendar" }, "https://www.googleapis.com/auth/calendar.settings.readonly": { "description": "View your Calendar settings" }, "https://www.googleapis.com/auth/calendar.calendarlist": { "description": "See, add, and remove Google calendars you’re subscribed to" }, "https://www.googleapis.com/auth/calendar.events.owned": { "description": "See, create, change, and delete events on Google calendars you own" }, "https://www.googleapis.com/auth/calendar.app.created": { "description": "Make secondary Google calendars, and see, create, change, and delete events on them" } } } }, "title": "Calendar API", "rootUrl": "https://www.googleapis.com/", "schemas": { "TimePeriod": { "properties": { "end": { "type": "string", "format": "date-time", "description": "The (exclusive) end of the time period." }, "start": { "type": "string", "format": "date-time", "description": "The (inclusive) start of the time period." } }, "type": "object", "id": "TimePeriod" }, "Acl": { "id": "Acl", "type": "object", "properties": { "nextPageToken": { "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.", "type": "string" }, "items": { "description": "List of rules on the access control list.", "items": { "$ref": "AclRule" }, "type": "array" }, "etag": { "type": "string", "description": "ETag of the collection." }, "nextSyncToken": { "description": "Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.", "type": "string" }, "kind": { "description": "Type of the collection (\"calendar#acl\").", "default": "calendar#acl", "type": "string" } } }, "Colors": { "id": "Colors", "type": "object", "properties": { "calendar": { "description": "A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its colorId field. Read-only.", "additionalProperties": { "$ref": "ColorDefinition", "description": "A calendar color definition." }, "type": "object" }, "event": { "type": "object", "description": "A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its colorId field. Read-only.", "additionalProperties": { "$ref": "ColorDefinition", "description": "An event color definition." } }, "kind": { "type": "string", "description": "Type of the resource (\"calendar#colors\").", "default": "calendar#colors" }, "updated": { "description": "Last modification time of the color palette (as a RFC3339 timestamp). Read-only.", "type": "string", "format": "date-time" } } }, "ConferenceRequestStatus": { "properties": { "statusCode": { "description": "The current status of the conference create request. Read-only.\nThe possible values are: \n- \"pending\": the conference create request is still being processed.\n- \"success\": the conference create request succeeded, the entry points are populated.\n- \"failure\": the conference create request failed, there are no entry points.", "type": "string" } }, "id": "ConferenceRequestStatus", "type": "object" }, "Error": { "properties": { "reason": { "description": "Specific reason for the error. Some of the possible values are: \n- \"groupTooBig\" - The group of users requested is too large for a single query. \n- \"tooManyCalendarsRequested\" - The number of calendars requested is too large for a single query. \n- \"notFound\" - The requested resource was not found. \n- \"internalError\" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.", "type": "string" }, "domain": { "description": "Domain, or broad category, of the error.", "type": "string" } }, "type": "object", "id": "Error" }, "ConferenceSolution": { "properties": { "iconUri": { "description": "The user-visible icon for this solution.", "type": "string" }, "key": { "$ref": "ConferenceSolutionKey", "description": "The key which can uniquely identify the conference solution for this event." }, "name": { "description": "The user-visible name of this solution. Not localized.", "type": "string" } }, "type": "object", "id": "ConferenceSolution" }, "EventOutOfOfficeProperties": { "type": "object", "id": "EventOutOfOfficeProperties", "properties": { "autoDeclineMode": { "type": "string", "description": "Whether to decline meeting invitations which overlap Out of office events. Valid values are declineNone, meaning that no meeting invitations are declined; declineAllConflictingInvitations, meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations, meaning that only new conflicting meeting invitations which arrive while the Out of office event is present are to be declined." }, "declineMessage": { "type": "string", "description": "Response message to set if an existing event or new invitation is automatically declined by Calendar." } } }, "Channel": { "properties": { "payload": { "type": "boolean", "description": "A Boolean value to indicate whether payload is wanted. Optional." }, "id": { "type": "string", "description": "A UUID or similar unique string that identifies this channel." }, "type": { "description": "The type of delivery mechanism used for this channel. Valid values are \"web_hook\" (or \"webhook\"). Both values refer to a channel where Http requests are used to deliver messages.", "type": "string" }, "params": { "type": "object", "description": "Additional parameters controlling delivery channel behavior. Optional.", "additionalProperties": { "type": "string", "description": "Declares a new parameter by name." } }, "kind": { "description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".", "default": "api#channel", "type": "string" }, "expiration": { "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.", "type": "string", "format": "int64" }, "token": { "type": "string", "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional." }, "resourceId": { "type": "string", "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions." }, "address": { "type": "string", "description": "The address where notifications are delivered for this channel." }, "resourceUri": { "description": "A version-specific identifier for the watched resource.", "type": "string" } }, "id": "Channel", "type": "object" }, "ConferenceParametersAddOnParameters": { "properties": { "parameters": { "type": "object", "additionalProperties": { "type": "string" } } }, "id": "ConferenceParametersAddOnParameters", "type": "object" }, "EventWorkingLocationProperties": { "properties": { "homeOffice": { "type": "any", "description": "If present, specifies that the user is working at home." }, "officeLocation": { "type": "object", "properties": { "deskId": { "type": "string", "description": "An optional desk identifier." }, "buildingId": { "type": "string", "description": "An optional building identifier. This should reference a building ID in the organization's Resources database." }, "floorId": { "description": "An optional floor identifier.", "type": "string" }, "floorSectionId": { "type": "string", "description": "An optional floor section identifier." }, "label": { "type": "string", "description": "The office name that's displayed in Calendar Web and Mobile clients. We recommend you reference a building name in the organization's Resources database." } }, "description": "If present, specifies that the user is working from an office." }, "customLocation": { "properties": { "label": { "description": "An optional extra label for additional information.", "type": "string" } }, "description": "If present, specifies that the user is working from a custom location.", "type": "object" }, "type": { "type": "string", "description": "Type of the working location. Possible values are: \n- \"homeOffice\" - The user is working at home. \n- \"officeLocation\" - The user is working from an office. \n- \"customLocation\" - The user is working from a custom location. Any details are specified in a sub-field of the specified name, but this field may be missing if empty. Any other fields are ignored.\nRequired when adding working location properties." } }, "type": "object", "id": "EventWorkingLocationProperties" }, "Event": { "type": "object", "id": "Event", "properties": { "id": { "description": "Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: \n- characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 \n- the length of the ID must be between 5 and 1024 characters \n- the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.\nIf you do not specify an ID, it will be automatically generated by the server.\nNote that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.", "type": "string" }, "extendedProperties": { "type": "object", "properties": { "shared": { "description": "Properties that are shared between copies of the event on other attendees' calendars.", "additionalProperties": { "type": "string", "description": "The name of the shared property and the corresponding value." }, "type": "object" }, "private": { "description": "Properties that are private to the copy of the event that appears on this calendar.", "additionalProperties": { "description": "The name of the private property and the corresponding value.", "type": "string" }, "type": "object" } }, "description": "Extended properties of the event." }, "guestsCanInviteOthers": { "description": "Whether attendees other than the organizer can invite others to the event. Optional. The default is True.", "default": "true", "type": "boolean" }, "created": { "type": "string", "format": "date-time", "description": "Creation time of the event (as a RFC3339 timestamp). Read-only." }, "reminders": { "type": "object", "description": "Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event.", "properties": { "overrides": { "description": "If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.", "items": { "$ref": "EventReminder" }, "type": "array" }, "useDefault": { "description": "Whether the default reminders of the calendar apply to the event.", "type": "boolean" } } }, "attachments": { "type": "array", "description": "File attachments for the event.\nIn order to modify attachments the supportsAttachments request parameter should be set to true.\nThere can be at most 25 attachments per event,", "items": { "$ref": "EventAttachment" } }, "organizer": { "description": "The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.", "properties": { "displayName": { "description": "The organizer's name, if available.", "type": "string" }, "email": { "description": "The organizer's email address, if available. It must be a valid email address as per RFC5322.", "type": "string" }, "self": { "description": "Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.", "default": "false", "type": "boolean" }, "id": { "type": "string", "description": "The organizer's Profile ID, if available." } }, "type": "object" }, "colorId": { "description": "The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.", "type": "string" }, "transparency": { "description": "Whether the event blocks time on the calendar. Optional. Possible values are: \n- \"opaque\" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. \n- \"transparent\" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.", "default": "opaque", "type": "string" }, "attendeesOmitted": { "description": "Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.", "default": "false", "type": "boolean" }, "locked": { "description": "Whether this is a locked event copy where no changes can be made to the main event fields \"summary\", \"description\", \"location\", \"start\", \"end\" or \"recurrence\". The default is False. Read-Only.", "default": "false", "type": "boolean" }, "endTimeUnspecified": { "description": "Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.", "default": "false", "type": "boolean" }, "hangoutLink": { "type": "string", "description": "An absolute link to the Google Hangout associated with this event. Read-only." }, "recurrence": { "type": "array", "description": "List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.", "items": { "type": "string" } }, "guestsCanSeeOtherGuests": { "description": "Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.", "default": "true", "type": "boolean" }, "iCalUID": { "type": "string", "description": "Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.\nNote that the iCalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same iCalUIDs. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method.", "annotations": { "required": [ "calendar.events.import" ] } }, "sequence": { "type": "integer", "format": "int32", "description": "Sequence number as per iCalendar." }, "eventType": { "description": "Specific type of the event. This cannot be modified after the event is created. Possible values are: \n- \"birthday\" - A special all-day event with an annual recurrence. \n- \"default\" - A regular event or not further specified. \n- \"focusTime\" - A focus-time event. \n- \"fromGmail\" - An event from Gmail. This type of event cannot be created. \n- \"outOfOffice\" - An out-of-office event. \n- \"workingLocation\" - A working location event.", "default": "default", "type": "string" }, "end": { "$ref": "EventDateTime", "description": "The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.", "annotations": { "required": [ "calendar.events.import", "calendar.events.insert", "calendar.events.update" ] } }, "attendees": { "description": "The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.", "items": { "$ref": "EventAttendee" }, "type": "array" }, "birthdayProperties": { "$ref": "EventBirthdayProperties", "description": "Birthday or special event data. Used if eventType is \"birthday\". Immutable." }, "originalStartTime": { "$ref": "EventDateTime", "description": "For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable." }, "workingLocationProperties": { "$ref": "EventWorkingLocationProperties", "description": "Working location event data." }, "creator": { "properties": { "email": { "description": "The creator's email address, if available.", "type": "string" }, "self": { "type": "boolean", "description": "Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.", "default": "false" }, "id": { "type": "string", "description": "The creator's Profile ID, if available." }, "displayName": { "type": "string", "description": "The creator's name, if available." } }, "description": "The creator of the event. Read-only.", "type": "object" }, "privateCopy": { "type": "boolean", "description": "If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.", "default": "false" }, "conferenceData": { "$ref": "ConferenceData", "description": "The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field." }, "kind": { "type": "string", "description": "Type of the resource (\"calendar#event\").", "default": "calendar#event" }, "summary": { "type": "string", "description": "Title of the event." }, "etag": { "type": "string", "description": "ETag of the resource." }, "htmlLink": { "type": "string", "description": "An absolute link to this event in the Google Calendar Web UI. Read-only." }, "updated": { "type": "string", "format": "date-time", "description": "Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only." }, "start": { "$ref": "EventDateTime", "description": "The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.", "annotations": { "required": [ "calendar.events.import", "calendar.events.insert", "calendar.events.update" ] } }, "recurringEventId": { "type": "string", "description": "For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable." }, "focusTimeProperties": { "$ref": "EventFocusTimeProperties", "description": "Focus Time event data. Used if eventType is focusTime." }, "gadget": { "properties": { "display": { "description": "The gadget's display mode. Deprecated. Possible values are: \n- \"icon\" - The gadget displays next to the event's title in the calendar view. \n- \"chip\" - The gadget displays when the event is clicked.", "type": "string" }, "type": { "type": "string", "description": "The gadget's type. Deprecated." }, "width": { "type": "integer", "format": "int32", "description": "The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated." }, "link": { "description": "The gadget's URL. The URL scheme must be HTTPS. Deprecated.", "type": "string" }, "height": { "description": "The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.", "type": "integer", "format": "int32" }, "title": { "type": "string", "description": "The gadget's title. Deprecated." }, "iconLink": { "description": "The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.", "type": "string" }, "preferences": { "type": "object", "description": "Preferences.", "additionalProperties": { "description": "The preference name and corresponding value.", "type": "string" } } }, "description": "A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.", "type": "object" }, "outOfOfficeProperties": { "$ref": "EventOutOfOfficeProperties", "description": "Out of office event data. Used if eventType is outOfOffice." }, "location": { "type": "string", "description": "Geographic location of the event as free-form text. Optional." }, "visibility": { "type": "string", "description": "Visibility of the event. Optional. Possible values are: \n- \"default\" - Uses the default visibility for events on the calendar. This is the default value. \n- \"public\" - The event is public and event details are visible to all readers of the calendar. \n- \"private\" - The event is private and only event attendees may view event details. \n- \"confidential\" - The event is private. This value is provided for compatibility reasons.", "default": "default" }, "description": { "description": "Description of the event. Can contain HTML. Optional.", "type": "string" }, "source": { "properties": { "title": { "description": "Title of the source; for example a title of a web page or an email subject.", "type": "string" }, "url": { "type": "string", "description": "URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS." } }, "description": "Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.", "type": "object" }, "guestsCanModify": { "description": "Whether attendees other than the organizer can modify the event. Optional. The default is False.", "default": "false", "type": "boolean" }, "status": { "type": "string", "description": "Status of the event. Optional. Possible values are: \n- \"confirmed\" - The event is confirmed. This is the default status. \n- \"tentative\" - The event is tentatively confirmed. \n- \"cancelled\" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.\nA cancelled status represents two different states depending on the event type: \n- Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.\nCancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. \n- All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.\nDeleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.\nIf an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated." }, "anyoneCanAddSelf": { "description": "Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.", "default": "false", "type": "boolean" } } }, "FreeBusyRequestItem": { "properties": { "id": { "description": "The identifier of a calendar or a group.", "type": "string" } }, "type": "object", "id": "FreeBusyRequestItem" }, "EventDateTime": { "properties": { "date": { "description": "The date, in the format \"yyyy-mm-dd\", if this is an all-day event.", "type": "string", "format": "date" }, "dateTime": { "description": "The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.", "type": "string", "format": "date-time" }, "timeZone": { "description": "The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.", "type": "string" } }, "type": "object", "id": "EventDateTime" }, "CalendarList": { "id": "CalendarList", "type": "object", "properties": { "etag": { "description": "ETag of the collection.", "type": "string" }, "items": { "description": "Calendars that are present on the user's calendar list.", "items": { "$ref": "CalendarListEntry" }, "type": "array" }, "nextPageToken": { "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.", "type": "string" }, "kind": { "description": "Type of the collection (\"calendar#calendarList\").", "default": "calendar#calendarList", "type": "string" }, "nextSyncToken": { "type": "string", "description": "Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided." } } }, "FreeBusyGroup": { "properties": { "calendars": { "description": "List of calendars' identifiers within a group.", "items": { "type": "string" }, "type": "array" }, "errors": { "description": "Optional error(s) (if computation for the group failed).", "items": { "$ref": "Error" }, "type": "array" } }, "type": "object", "id": "FreeBusyGroup" }, "EntryPoint": { "properties": { "password": { "description": "The password to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional.", "type": "string" }, "regionCode": { "type": "string", "description": "The CLDR/ISO 3166 region code for the country associated with this phone access. Example: \"SE\" for Sweden.\nCalendar backend will populate this field only for EntryPointType.PHONE." }, "pin": { "type": "string", "description": "The PIN to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional." }, "accessCode": { "type": "string", "description": "The access code to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional." }, "meetingCode": { "type": "string", "description": "The meeting code to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional." }, "label": { "type": "string", "description": "The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.\nExamples: \n- for video: meet.google.com/aaa-bbbb-ccc\n- for phone: +1 123 268 2601\n- for sip: 12345678@altostrat.com\n- for more: should not be filled \nOptional." }, "passcode": { "description": "The passcode to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.", "type": "string" }, "uri": { "description": "The URI of the entry point. The maximum length is 1300 characters.\nFormat: \n- for video, http: or https: schema is required.\n- for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).\n- for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.\n- for more, http: or https: schema is required.", "type": "string" }, "entryPointType": { "type": "string", "description": "The type of the conference entry point.\nPossible values are: \n- \"video\" - joining a conference over HTTP. A conference can have zero or one video entry point.\n- \"phone\" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.\n- \"sip\" - joining a conference over SIP. A conference can have zero or one sip entry point.\n- \"more\" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference." }, "entryPointFeatures": { "description": "Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.", "items": { "type": "string" }, "type": "array" } }, "id": "EntryPoint", "type": "object" }, "ConferenceData": { "properties": { "conferenceId": { "type": "string", "description": "The ID of the conference.\nCan be used by developers to keep track of conferences, should not be displayed to users.\nThe ID value is formed differently for each conference solution type: \n- eventHangout: ID is not set. (This conference type is deprecated.)\n- eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)\n- hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.\n- addOn: ID is defined by the third-party provider. Optional." }, "signature": { "type": "string", "description": "The signature of the conference data.\nGenerated on server side.\nUnset for a conference with a failed create request.\nOptional for a conference with a pending create request." }, "notes": { "description": "Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.", "type": "string" }, "parameters": { "$ref": "ConferenceParameters", "description": "Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming." }, "conferenceSolution": { "$ref": "ConferenceSolution", "description": "The conference solution, such as Google Meet.\nUnset for a conference with a failed create request.\nEither conferenceSolution and at least one entryPoint, or createRequest is required." }, "entryPoints": { "description": "Information about individual conference entry points, such as URLs or phone numbers.\nAll of them must belong to the same conference.\nEither conferenceSolution and at least one entryPoint, or createRequest is required.", "items": { "$ref": "EntryPoint" }, "type": "array" }, "createRequest": { "$ref": "CreateConferenceRequest", "description": "A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.\nEither conferenceSolution and at least one entryPoint, or createRequest is required." } }, "type": "object", "id": "ConferenceData" }, "EventBirthdayProperties": { "type": "object", "id": "EventBirthdayProperties", "properties": { "customTypeName": { "description": "Custom type label specified for this event. This is populated if birthdayProperties.type is set to \"custom\". Read-only.", "type": "string" }, "type": { "description": "Type of birthday or special event. Possible values are: \n- \"anniversary\" - An anniversary other than birthday. Always has a contact. \n- \"birthday\" - A birthday event. This is the default value. \n- \"custom\" - A special date whose label is further specified in the customTypeName field. Always has a contact. \n- \"other\" - A special date which does not fall into the other categories, and does not have a custom label. Always has a contact. \n- \"self\" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type \"birthday\". The type cannot be changed after the event is created.", "default": "birthday", "type": "string" }, "contact": { "type": "string", "description": "Resource name of the contact this birthday event is linked to. This can be used to fetch contact details from People API. Format: \"people/c12345\". Read-only." } } }, "CalendarNotification": { "type": "object", "id": "CalendarNotification", "properties": { "method": { "description": "The method used to deliver the notification. The possible value is: \n- \"email\" - Notifications are sent via email. \nRequired when adding a notification.", "type": "string" }, "type": { "description": "The type of notification. Possible values are: \n- \"eventCreation\" - Notification sent when a new event is put on the calendar. \n- \"eventChange\" - Notification sent when an event is changed. \n- \"eventCancellation\" - Notification sent when an event is cancelled. \n- \"eventResponse\" - Notification sent when an attendee responds to the event invitation. \n- \"agenda\" - An agenda with the events of the day (sent out in the morning). \nRequired when adding a notification.", "type": "string" } } }, "FreeBusyResponse": { "type": "object", "id": "FreeBusyResponse", "properties": { "calendars": { "type": "object", "additionalProperties": { "$ref": "FreeBusyCalendar", "description": "Free/busy expansions for a single calendar." }, "description": "List of free/busy information for calendars." }, "kind": { "description": "Type of the resource (\"calendar#freeBusy\").", "default": "calendar#freeBusy", "type": "string" }, "groups": { "description": "Expansion of groups.", "additionalProperties": { "$ref": "FreeBusyGroup", "description": "List of calendars that are members of this group." }, "type": "object" }, "timeMax": { "description": "The end of the interval.", "type": "string", "format": "date-time" }, "timeMin": { "type": "string", "format": "date-time", "description": "The start of the interval." } } }, "FreeBusyCalendar": { "properties": { "errors": { "type": "array", "description": "Optional error(s) (if computation for the calendar failed).", "items": { "$ref": "Error" } }, "busy": { "type": "array", "description": "List of time ranges during which this calendar should be regarded as busy.", "items": { "$ref": "TimePeriod" } } }, "id": "FreeBusyCalendar", "type": "object" }, "Events": { "type": "object", "id": "Events", "properties": { "description": { "type": "string", "description": "Description of the calendar. Read-only." }, "nextSyncToken": { "description": "Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.", "type": "string" }, "kind": { "type": "string", "description": "Type of the collection (\"calendar#events\").", "default": "calendar#events" }, "items": { "type": "array", "description": "List of events on the calendar.", "items": { "$ref": "Event" } }, "summary": { "type": "string", "description": "Title of the calendar. Read-only." }, "etag": { "description": "ETag of the collection.", "type": "string" }, "updated": { "description": "Last modification time of the calendar (as a RFC3339 timestamp). Read-only.", "type": "string", "format": "date-time" }, "accessRole": { "type": "string", "description": "The user's access role for this calendar. Read-only. Possible values are: \n- \"none\" - The user has no access. \n- \"freeBusyReader\" - The user has read access to free/busy information. \n- \"reader\" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - The user has manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role." }, "defaultReminders": { "description": "The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).", "items": { "$ref": "EventReminder" }, "type": "array" }, "timeZone": { "description": "The time zone of the calendar. Read-only.", "type": "string" }, "nextPageToken": { "type": "string", "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided." } } }, "ConferenceParameters": { "properties": { "addOnParameters": { "$ref": "ConferenceParametersAddOnParameters", "description": "Additional add-on specific data." } }, "id": "ConferenceParameters", "type": "object" }, "EventAttendee": { "properties": { "additionalGuests": { "description": "Number of additional guests. Optional. The default is 0.", "default": "0", "type": "integer", "format": "int32" }, "comment": { "description": "The attendee's response comment. Optional.", "type": "string" }, "displayName": { "type": "string", "description": "The attendee's name, if available. Optional." }, "organizer": { "type": "boolean", "description": "Whether the attendee is the organizer of the event. Read-only. The default is False." }, "id": { "type": "string", "description": "The attendee's Profile ID, if available." }, "email": { "type": "string", "description": "The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.\nRequired when adding an attendee." }, "asyncOperation": { "description": "If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present.\nPossible values are: \n- \"inProgress\" - The asynchronous operation is in progress. \n- (not present) - Otherwise.", "default": "", "type": "string" }, "optional": { "type": "boolean", "description": "Whether this is an optional attendee. Optional. The default is False.", "default": "false" }, "resource": { "type": "boolean", "description": "Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.", "default": "false" }, "self": { "type": "boolean", "description": "Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.", "default": "false" }, "responseStatus": { "description": "The attendee's response status. Possible values are: \n- \"needsAction\" - The attendee has not responded to the invitation (recommended for new events). \n- \"declined\" - The attendee has declined the invitation. \n- \"tentative\" - The attendee has tentatively accepted the invitation. \n- \"accepted\" - The attendee has accepted the invitation. Warning: If you add an event using the values declined, tentative, or accepted, attendees with the \"Add invitations to my calendar\" setting set to \"When I respond to invitation in email\" or \"Only if the sender is known\" might have their response reset to needsAction and won't see an event in their calendar unless they change their response in the event invitation email. Furthermore, if more than 200 guests are invited to the event, response status is not propagated to the guests.", "type": "string" } }, "id": "EventAttendee", "type": "object" }, "EventAttachment": { "properties": { "mimeType": { "type": "string", "description": "Internet media type (MIME type) of the attachment." }, "title": { "description": "Attachment title.", "type": "string" }, "iconLink": { "description": "URL link to the attachment's icon. This field can only be modified for custom third-party attachments.", "type": "string" }, "fileUrl": { "type": "string", "description": "URL link to the attachment.\nFor adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.\nRequired when adding an attachment." }, "fileId": { "type": "string", "description": "ID of the attached file. Read-only.\nFor Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API." } }, "type": "object", "id": "EventAttachment" }, "AclRule": { "type": "object", "id": "AclRule", "properties": { "etag": { "description": "ETag of the resource.", "type": "string" }, "role": { "description": "The role assigned to the scope. Possible values are: \n- \"none\" - Provides no access. \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. \n- \"owner\" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.", "annotations": { "required": [ "calendar.acl.insert" ] }, "type": "string" }, "scope": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the scope. Possible values are: \n- \"default\" - The public scope. This is the default value. \n- \"user\" - Limits the scope to a single user. \n- \"group\" - Limits the scope to a group. \n- \"domain\" - Limits the scope to a domain. Note: The permissions granted to the \"default\", or public, scope apply to any user, authenticated or not.", "annotations": { "required": [ "calendar.acl.insert", "calendar.acl.update" ] } }, "value": { "description": "The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type \"default\".", "type": "string" } }, "description": "The extent to which calendar access is granted by this ACL rule.", "annotations": { "required": [ "calendar.acl.insert", "calendar.acl.update" ] } }, "kind": { "description": "Type of the resource (\"calendar#aclRule\").", "default": "calendar#aclRule", "type": "string" }, "id": { "description": "Identifier of the Access Control List (ACL) rule. See Sharing calendars.", "type": "string" } } }, "CreateConferenceRequest": { "properties": { "requestId": { "description": "The client-generated unique ID for this request.\nClients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.", "type": "string" }, "conferenceSolutionKey": { "$ref": "ConferenceSolutionKey", "description": "The conference solution, such as Hangouts or Google Meet." }, "status": { "$ref": "ConferenceRequestStatus", "description": "The status of the conference create request." } }, "type": "object", "id": "CreateConferenceRequest" }, "Setting": { "properties": { "etag": { "type": "string", "description": "ETag of the resource." }, "kind": { "description": "Type of the resource (\"calendar#setting\").", "default": "calendar#setting", "type": "string" }, "value": { "description": "Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters.", "type": "string" }, "id": { "type": "string", "description": "The id of the user setting." } }, "type": "object", "id": "Setting" }, "FreeBusyRequest": { "properties": { "timeMax": { "description": "The end of the interval for the query formatted as per RFC3339.", "type": "string", "format": "date-time" }, "timeZone": { "type": "string", "description": "Time zone used in the response. Optional. The default is UTC.", "default": "UTC" }, "calendarExpansionMax": { "type": "integer", "format": "int32", "description": "Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50." }, "timeMin": { "type": "string", "format": "date-time", "description": "The start of the interval for the query formatted as per RFC3339." }, "groupExpansionMax": { "type": "integer", "format": "int32", "description": "Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100." }, "items": { "type": "array", "description": "List of calendars and/or groups to query.", "items": { "$ref": "FreeBusyRequestItem" } } }, "id": "FreeBusyRequest", "type": "object" }, "Calendar": { "properties": { "id": { "description": "Identifier of the calendar. To retrieve IDs call the calendarList.list() method.", "type": "string" }, "timeZone": { "description": "The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) Optional.", "type": "string" }, "autoAcceptInvitations": { "type": "boolean", "description": "Whether this calendar automatically accepts invitations. Only valid for resource calendars." }, "location": { "type": "string", "description": "Geographic location of the calendar as free-form text. Optional." }, "description": { "type": "string", "description": "Description of the calendar. Optional." }, "dataOwner": { "description": "The email of the owner of the calendar. Set only for secondary calendars. Read-only.", "type": "string" }, "kind": { "description": "Type of the resource (\"calendar#calendar\").", "default": "calendar#calendar", "type": "string" }, "summary": { "description": "Title of the calendar.", "annotations": { "required": [ "calendar.calendars.insert" ] }, "type": "string" }, "etag": { "description": "ETag of the resource.", "type": "string" }, "conferenceProperties": { "$ref": "ConferenceProperties", "description": "Conferencing properties for this calendar, for example what types of conferences are allowed." } }, "type": "object", "id": "Calendar" }, "EventFocusTimeProperties": { "id": "EventFocusTimeProperties", "type": "object", "properties": { "chatStatus": { "description": "The status to mark the user in Chat and related products. This can be available or doNotDisturb.", "type": "string" }, "autoDeclineMode": { "description": "Whether to decline meeting invitations which overlap Focus Time events. Valid values are declineNone, meaning that no meeting invitations are declined; declineAllConflictingInvitations, meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations, meaning that only new conflicting meeting invitations which arrive while the Focus Time event is present are to be declined.", "type": "string" }, "declineMessage": { "type": "string", "description": "Response message to set if an existing event or new invitation is automatically declined by Calendar." } } }, "EventLabel": { "id": "EventLabel", "type": "object" }, "LabelProperties": { "type": "object", "id": "LabelProperties" }, "ConferenceSolutionKey": { "type": "object", "id": "ConferenceSolutionKey", "properties": { "type": { "type": "string", "description": "The conference solution type.\nIf a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.\nThe possible values are: \n- \"eventHangout\" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)\n- \"eventNamedHangout\" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)\n- \"hangoutsMeet\" for Google Meet (http://meet.google.com)\n- \"addOn\" for 3P conference providers" } } }, "EventReminder": { "id": "EventReminder", "type": "object", "properties": { "method": { "description": "The method used by this reminder. Possible values are: \n- \"email\" - Reminders are sent via email. \n- \"popup\" - Reminders are sent via a UI popup. \nRequired when adding a reminder.", "type": "string" }, "minutes": { "description": "Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).\nRequired when adding a reminder.", "type": "integer", "format": "int32" } } }, "Settings": { "properties": { "nextPageToken": { "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.", "type": "string" }, "etag": { "type": "string", "description": "Etag of the collection." }, "items": { "type": "array", "description": "List of user settings.", "items": { "$ref": "Setting" } }, "kind": { "type": "string", "description": "Type of the collection (\"calendar#settings\").", "default": "calendar#settings" }, "nextSyncToken": { "type": "string", "description": "Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided." } }, "type": "object", "id": "Settings" }, "CalendarListEntry": { "id": "CalendarListEntry", "type": "object", "properties": { "kind": { "type": "string", "description": "Type of the resource (\"calendar#calendarListEntry\").", "default": "calendar#calendarListEntry" }, "foregroundColor": { "description": "The foreground color of the calendar in the hexadecimal format \"#ffffff\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.", "type": "string" }, "summary": { "type": "string", "description": "Title of the calendar. Read-only." }, "deleted": { "description": "Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.", "default": "false", "type": "boolean" }, "etag": { "type": "string", "description": "ETag of the resource." }, "id": { "type": "string", "description": "Identifier of the calendar.", "annotations": { "required": [ "calendar.calendarList.insert" ] } }, "defaultReminders": { "type": "array", "description": "The default reminders that the authenticated user has for this calendar.", "items": { "$ref": "EventReminder" } }, "selected": { "type": "boolean", "description": "Whether the calendar content shows up in the calendar UI. Optional. The default is False.", "default": "false" }, "backgroundColor": { "type": "string", "description": "The main color of the calendar in the hexadecimal format \"#0088aa\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional." }, "summaryOverride": { "description": "The summary that the authenticated user has set for this calendar. Optional.", "type": "string" }, "description": { "type": "string", "description": "Description of the calendar. Optional. Read-only." }, "dataOwner": { "type": "string", "description": "The email of the owner of the calendar. Set only for secondary calendars. Read-only." }, "conferenceProperties": { "$ref": "ConferenceProperties", "description": "Conferencing properties for this calendar, for example what types of conferences are allowed." }, "accessRole": { "description": "The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.", "type": "string" }, "colorId": { "type": "string", "description": "The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional." }, "timeZone": { "type": "string", "description": "The time zone of the calendar. Optional. Read-only." }, "autoAcceptInvitations": { "type": "boolean", "description": "Whether this calendar automatically accepts invitations. Only valid for resource calendars. Read-only." }, "primary": { "description": "Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.", "default": "false", "type": "boolean" }, "location": { "description": "Geographic location of the calendar as free-form text. Optional. Read-only.", "type": "string" }, "hidden": { "description": "Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.", "default": "false", "type": "boolean" }, "notificationSettings": { "type": "object", "properties": { "notifications": { "type": "array", "description": "The list of notifications set for this calendar.", "items": { "$ref": "CalendarNotification" } } }, "description": "The notifications that the authenticated user is receiving for this calendar." } } }, "ColorDefinition": { "properties": { "background": { "type": "string", "description": "The background color associated with this color definition." }, "foreground": { "type": "string", "description": "The foreground color that can be used to write on top of a background with 'background' color." } }, "id": "ColorDefinition", "type": "object" }, "ConferenceProperties": { "properties": { "allowedConferenceSolutionTypes": { "description": "The types of conference solutions that are supported for this calendar.\nThe possible values are: \n- \"eventHangout\" \n- \"eventNamedHangout\" \n- \"hangoutsMeet\" Optional.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "id": "ConferenceProperties" } }, "batchPath": "batch/calendar/v3", "description": "Manipulates events and other calendar data.", "ownerDomain": "google.com", "name": "calendar" }