### Get User Setting Source: https://developers.google.com/workspace/calendar/api/v3/reference?hl=it Retrieves a specific setting for a single user. ```APIDOC ## GET /users/me/settings/setting ### Description Returns a setting for a single user. ### Method GET ### Endpoint /users/me/settings/setting ### Request Example { "example": "request body" } ### Response #### Success Response (200) - **field1** (type) - Description #### Response Example { "example": "response body" } ``` -------------------------------- ### Update calendar with default reminders Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendarList/update This example demonstrates setting default reminders for a calendar. The `method` can be 'email' or 'popup', and `minutes` specifies the reminder time before the event. Both `method` and `minutes` are required when adding a reminder. ```json { "defaultReminders": [ { "method": "email", "minutes": 30 }, { "method": "popup", "minutes": 10 } ] } ``` -------------------------------- ### CalendarList: get Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendarList/get?hl=es-419 Devuelve un calendario de la lista de calendarios del usuario. Pruébalo ahora. ```APIDOC ## GET https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId ### Description Devuelve un calendario de la lista de calendarios del usuario. ### Method GET ### Endpoint https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId ### Parameters #### Path Parameters - **calendarId** (string) - Required - Es el identificador del calendario. Para recuperar los IDs de calendario, llama al método calendarList.list. Si deseas acceder al calendario principal del usuario que accedió actualmente, usa la palabra clave "primary". ### Authorization This request requires authorization with at least one of the following permissions: - `https://www.googleapis.com/auth/calendar.readonly` - `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` ### Request Body No proporciones un cuerpo de la solicitud con este método. ### Response #### Success Response (200) Si se aplica correctamente, este método muestra un recurso CalendarList en el cuerpo de la respuesta. ``` -------------------------------- ### Update calendar with notification settings Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendarList/update This example shows how to configure notification settings for a calendar. You can specify different notification types like 'eventCreation', 'eventChange', 'eventCancellation', 'eventResponse', or 'agenda', along with the delivery method, which is typically 'email'. ```json { "notificationSettings": { "notifications": [ { "type": "eventCreation", "method": "email" }, { "type": "agenda", "method": "email" } ] } } ``` -------------------------------- ### Update calendar with RGB colors Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendarList/update This example shows how to update a calendar's colors using RGB hexadecimal format. The `colorRgbFormat=true` query parameter must be set, and the `backgroundColor` and `foregroundColor` properties should be provided in the request body. ```json { "backgroundColor": "#0088aa", "foregroundColor": "#ffffff" } ``` -------------------------------- ### GET Request for CalendarList: get Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendarList/get?hl=es-419 This is the HTTP request structure for retrieving a specific calendar from the user's calendar list. Use 'primary' for the current user's main calendar. ```http GET https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId ``` -------------------------------- ### Update calendar visibility and summary Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendarList/update This example illustrates how to hide a calendar from the list by setting the `hidden` property to `true`, or to change the user-defined summary with `summaryOverride`. ```json { "hidden": true, "summaryOverride": "My Custom Calendar Name" } ``` -------------------------------- ### Event Resource Properties Source: https://developers.google.com/workspace/calendar/api/v3/reference/events This section details the properties of an event resource, including its description, start and end times, and creator information. ```APIDOC ## Event Resource Properties ### Description Details the properties of an event resource, including its description, start and end times, and creator information. ### Properties - **description** (string) - Description of the event. Can contain HTML. Optional. - **end** (nested object) - The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. - **date** (date) - The date, in the format "yyyy-mm-dd", if this is an all-day event. Writable. - **dateTime** (datetime) - 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`. Writable. - **creator** (object) - The creator of the event. Read-only. - **displayName** (string) - The creator's name, if available. - **email** (string) - The creator's email address, if available. - **id** (string) - The creator's Profile ID, if available. - **self** (boolean) - Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. - **created** (datetime) - Creation time of the event (as a RFC3339 timestamp). Read-only. ``` -------------------------------- ### Colors: get Source: https://developers.google.com/workspace/calendar/api/v3/reference/colors/get Returns the color definitions for calendars and events. ```APIDOC ## GET https://www.googleapis.com/calendar/v3/colors ### Description Returns the color definitions for calendars and events. ### Method GET ### Endpoint https://www.googleapis.com/calendar/v3/colors ### Authorization This request allows authorization with at least one of the following scopes: - `https://www.googleapis.com/auth/calendar` - `https://www.googleapis.com/auth/calendar.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.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` ### Request Body Do not supply a request body with this method. ### Response #### Success Response (200) If successful, this method returns a Colors resource in the response body. ``` -------------------------------- ### Calendars: get Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendars/get?hl=es-419 Devuelve los metadatos de un calendario. Se puede usar la palabra clave "primary" para acceder al calendario principal del usuario que accedió actualmente. ```APIDOC ## GET https://www.googleapis.com/calendar/v3/calendars/calendarId ### Description Devuelve los metadatos de un calendario. ### Method GET ### Endpoint https://www.googleapis.com/calendar/v3/calendars/calendarId ### Parameters #### Path Parameters - **calendarId** (string) - Required - Es el identificador del calendario. Para recuperar los IDs de calendario, llama al método calendarList.list. Si deseas acceder al calendario principal del usuario que accedió actualmente, usa la palabra clave "primary". ### Authorization This request requires authorization with at least one of the following permissions: - `https://www.googleapis.com/auth/calendar.readonly` - `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 ### Request Body No proporciones un cuerpo de la solicitud con este método. ### Response #### Success Response (200) Si la respuesta es correcta, este método muestra un recurso de Calendarios en el cuerpo de la respuesta. ``` -------------------------------- ### Colors - Get Source: https://developers.google.com/workspace/calendar/api/v3/reference?hl=es-419 Returns color definitions for calendars and events. ```APIDOC ## GET /colors ### Description Returns color definitions for calendars and events. ### Method GET ### Endpoint /colors ``` -------------------------------- ### get Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendarList?hl=pt-BR Retrieves a specific calendar from the user's calendar list. ```APIDOC ## get ### Description Retrieves a calendar from the user's calendar list. ### Method GET ### Endpoint /calendars/{calendarId} ### Parameters #### Path Parameters - **calendarId** (string) - Required - The ID of the calendar to retrieve. ``` -------------------------------- ### Get Calendar Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendarList?hl=tr Retrieves a calendar from the user's calendar list. ```APIDOC ## GET calendarList.get ### Description Retrieves a calendar from the user's calendar list. ### Method GET ### Endpoint GET https://www.googleapis.com/calendar/v3/users/me/calendarList/{calendarId} ``` -------------------------------- ### Calendars: get Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendars/get?hl=ar This function displays calendar metadata. Try it now. ```APIDOC ## GET https://www.googleapis.com/calendar/v3/calendars/calendarId ### Description Retrieves metadata for a calendar. ### Method GET ### Endpoint https://www.googleapis.com/calendar/v3/calendars/calendarId ### Parameters #### Path Parameters - **calendarId** (string) - Required - The calendar ID to retrieve. To get calendar IDs, you can call the calendarList.list method. If you want to access the primary calendar of the currently logged-in user, use the "primary" keyword. ### Request Body This method does not accept a request body. ### Response #### Success Response (200) Returns a Calendar resource in the response body. ``` -------------------------------- ### HTTP Request for Listing Events Source: https://developers.google.com/workspace/calendar/api/v3/reference/events/list This is the base HTTP GET request to list events for a given calendar. Replace `calendarId` with the actual ID of the calendar you want to retrieve events from. ```http GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events ``` -------------------------------- ### Patch Calendar in List Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendarList?hl=es-419 Updates an existing calendar in the user's list using patch semantics. This method consumes three quota units. It's recommended to use `get` followed by `update` instead. Specified fields will overwrite existing values; unspecified fields remain unchanged. Array fields, if specified, replace existing arrays. ```APIDOC ## PATCH CalendarList ### Description Updates an existing calendar in the user's list of calendars. This method supports patch semantics. Note that each patch request consumes three quota units. It is preferable to use a `get` followed by an `update`. Field values that you specify will overwrite the existing values. Fields that are not specified in your request will remain unchanged. Array fields, if specified, will overwrite the existing arrays, discarding any previous array elements. ### Method PATCH ### Endpoint /calendars/{calendarId} ``` -------------------------------- ### Calendars: get Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendars/get?hl=zh-CN Retrieves metadata for a calendar. You can use this method to get information about a specific calendar, such as its name, time zone, and description. ```APIDOC ## GET https://www.googleapis.com/calendar/v3/calendars/calendarId ### Description Retrieves metadata for a calendar. ### Method GET ### Endpoint https://www.googleapis.com/calendar/v3/calendars/calendarId ### Parameters #### Path Parameters - **calendarId** (string) - Required - The identifier of the calendar. To retrieve a calendar ID, call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the keyword "primary". ### Authorization This request requires authorization with at least one of the following scopes: - `https://www.googleapis.com/auth/calendar.readonly` - `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` ### Request Body Do not provide a request body when using this method. ### Response #### Success Response (200) Returns a Calendars resource in the response body. ``` -------------------------------- ### GET Instances Source: https://developers.google.com/workspace/calendar/api/v3/reference/events/instances Retrieves instances of a specified recurring event. This method is useful for getting all occurrences of a recurring event within a given time frame or for specific event IDs. ```APIDOC ## GET /calendars/calendarId/events/eventId/instances ### Description Returns instances of the specified recurring event. ### Method GET ### Endpoint https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId/instances ### Parameters #### Path Parameters - **calendarId** (string) - Required - 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. - **eventId** (string) - Required - Recurring event identifier. #### Query Parameters - **alwaysIncludeEmail** (boolean) - Optional - 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). - **maxAttendees** (integer) - Optional - 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. - **maxResults** (integer) - Optional - 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. - **originalStart** (string) - Optional - The original start time of the instance in the result. - **pageToken** (string) - Optional - Token specifying which result page to return. - **showDeleted** (boolean) - Optional - 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. The default is False. - **timeMax** (datetime) - Optional - Upper bound (exclusive) for an event's start time to filter by. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset. - **timeMin** (datetime) - Optional - Lower bound (inclusive) for an event's end time to filter by. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset. - **timeZone** (string) - Optional - Time zone used in the response. The default is the time zone of the calendar. ### Authorization This request allows authorization with at least one of the following scopes: - `https://www.googleapis.com/auth/calendar.readonly` - `https://www.googleapis.com/auth/calendar` - `https://www.googleapis.com/auth/calendar.events.readonly` - `https://www.googleapis.com/auth/calendar.events` - `https://www.googleapis.com/auth/calendar.app.created` - `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` ### Request Body Do not supply a request body with this method. ``` -------------------------------- ### List User Settings Source: https://developers.google.com/workspace/calendar/api/v3/reference?hl=it Retrieves all user settings for the authenticated user. ```APIDOC ## GET /users/me/settings ### Description Returns all user settings for the authenticated user. ### Method GET ### Endpoint /users/me/settings ### Request Example { "example": "request body" } ### Response #### Success Response (200) - **field1** (type) - Description #### Response Example { "example": "response body" } ``` -------------------------------- ### Calendars - Get Source: https://developers.google.com/workspace/calendar/api/v3/reference?hl=es-419 Returns metadata for a calendar. ```APIDOC ## GET /calendars/calendarId ### Description Returns metadata for a calendar. ### Method GET ### Endpoint /calendars/calendarId ``` -------------------------------- ### Watch Settings HTTP Request Source: https://developers.google.com/workspace/calendar/api/v3/reference/settings/watch Use this endpoint to initiate a watch channel for changes to Settings resources. Ensure you have the necessary authorization scopes. ```http POST https://www.googleapis.com/calendar/v3/users/me/settings/watch ``` -------------------------------- ### Settings Watch Response Body Source: https://developers.google.com/workspace/calendar/api/v3/reference/settings/watch The response indicates a successful channel creation, providing details like the channel ID, resource ID, and expiration timestamp. ```json { "kind": "api#channel", "id": string, "resourceId": string, "resourceUri": string, "token": string, "expiration": long } ``` -------------------------------- ### Settings Operations Source: https://developers.google.com/workspace/calendar/api/v3/reference?hl=es-419 Operations for retrieving and observing user settings. ```APIDOC ## GET /users/me/settings/setting ### Description Devuelve un solo parámetro de configuración del usuario. ### Method GET ### Endpoint /users/me/settings/setting ``` ```APIDOC ## GET /users/me/settings ### Description Devuelve todos los parámetros de configuración del usuario autenticado. ### Method GET ### Endpoint /users/me/settings ``` ```APIDOC ## POST /users/me/settings/watch ### Description Observa los cambios en los recursos de configuración. ### Method POST ### Endpoint /users/me/settings/watch ``` -------------------------------- ### Settings Resource Source: https://developers.google.com/workspace/calendar/api/v3/reference Operations for retrieving user settings. ```APIDOC ## Settings Resource ### Description Returns a single user setting. ### Method GET ### Endpoint `/users/me/settings/{setting}` ``` ```APIDOC ## Settings Resource ### Description Returns all user settings for the authenticated user. ### Method GET ### Endpoint `/users/me/settings` ``` ```APIDOC ## Settings Resource ### Description Watch for changes to Settings resources. ### Method POST ### Endpoint `/users/me/settings/watch` ``` -------------------------------- ### Get Calendar from List Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendarList?hl=es-419 Retrieves a specific calendar from the user's list of calendars. ```APIDOC ## GET CalendarList ### Description Retrieves a specific calendar from the user's list of calendars. ### Method GET ### Endpoint /calendars/{calendarId} ``` -------------------------------- ### Watch User Settings Source: https://developers.google.com/workspace/calendar/api/v3/reference?hl=it Monitors changes to settings resources. ```APIDOC ## POST /users/me/settings/watch ### Description Monitors changes to settings resources. ### Method POST ### Endpoint /users/me/settings/watch ### Request Example { "example": "request body" } ### Response #### Success Response (200) - **field1** (type) - Description #### Response Example { "example": "response body" } ``` -------------------------------- ### POST users.settings.watch Source: https://developers.google.com/workspace/calendar/api/v3/reference/settings/watch This method allows you to set up a push notification channel to receive notifications when your calendar settings change. You need to provide a callback address where the notifications will be sent. ```APIDOC ## POST users.settings.watch ### Description Watch for changes to Settings resources. ### Method POST ### Endpoint `https://www.googleapis.com/calendar/v3/users/me/settings/watch` ### Authorization This request requires authorization with at least one of the following scopes: - `https://www.googleapis.com/auth/calendar.readonly` - `https://www.googleapis.com/auth/calendar` - `https://www.googleapis.com/auth/calendar.settings.readonly` ### Request Body - **id** (string) - Required - A UUID or similar unique string that identifies this channel. - **token** (string) - Optional - An arbitrary string delivered to the target address with each notification delivered over this channel. - **type** (string) - Required - The type of delivery mechanism used for this channel. Valid values are "`web_hook`" (or "`webhook`"). - **address** (string) - Required - The address where notifications are delivered for this channel. - **params** (object) - Optional - Additional parameters controlling delivery channel behavior. - **ttl** (string) - Optional - The time-to-live in seconds for the notification channel. Default is 604800 seconds. ### Request Example ```json { "id": "your-unique-channel-id", "token": "your-arbitrary-token", "type": "web_hook", "address": "https://your-callback-url.com/notifications", "params": { "ttl": "3600" } } ``` ### Response #### Success Response (200) - **kind** (string) - Identifies this as a notification channel used to watch for changes to a resource, which is "`api#channel`". - **id** (string) - A UUID or similar unique string that identifies this channel. - **resourceId** (string) - An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. - **resourceUri** (string) - A version-specific identifier for the watched resource. - **token** (string) - An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. - **expiration** (long) - Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. #### Response Example ```json { "kind": "api#channel", "id": "your-unique-channel-id", "resourceId": "some-resource-id", "resourceUri": "https://www.googleapis.com/calendar/v3/users/me/settings", "token": "your-arbitrary-token", "expiration": 1678886400000 } ``` ``` -------------------------------- ### Get Access Control Rule Source: https://developers.google.com/workspace/calendar/api/v3/reference/acl/get Retrieves a single access control rule by its ID for a given calendar. This operation requires proper authorization. ```APIDOC ## GET /calendars/calendarId/acl/ruleId ### Description Retrieves a single access control rule. ### Method GET ### Endpoint `https://www.googleapis.com/calendar/v3/calendars/calendarId/acl/ruleId` ### Parameters #### Path Parameters - **calendarId** (string) - Required - 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** (string) - Required - ACL rule identifier. ### Authorization This request requires authorization with at least one of the following scopes: - `https://www.googleapis.com/auth/calendar.readonly` - `https://www.googleapis.com/auth/calendar` - `https://www.googleapis.com/auth/calendar.acls` - `https://www.googleapis.com/auth/calendar.acls.readonly` ### Request Body Do not supply a request body with this method. ### Response #### Success Response (200) Returns an Acl resource in the response body. ``` -------------------------------- ### Get Calendar Metadata Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendars/get Retrieves metadata for a calendar using its unique identifier. This method requires authentication and can be used to fetch details about a specific calendar. ```APIDOC ## GET /calendar/v3/calendars/calendarId ### Description Returns metadata for a calendar. ### Method GET ### Endpoint `https://www.googleapis.com/calendar/v3/calendars/calendarId` ### Parameters #### Path Parameters - **calendarId** (string) - Required - 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. ### Authorization This request requires authorization with at least one of the following scopes: - `https://www.googleapis.com/auth/calendar.readonly` - `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` ### Request Body Do not supply a request body with this method. ### Response #### Success Response (200) Returns a Calendars resource in the response body. ``` -------------------------------- ### List Events Parameters Source: https://developers.google.com/workspace/calendar/api/v3/reference/events/list This section details the query parameters available for listing events, including filtering by time, time zone, and update status. ```APIDOC ## Query Parameters ### `timeMax` - **Type**: `datetime` - **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`. ### `timeMin` - **Type**: `datetime` - **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`. ### `timeZone` - **Type**: `string` - **Description**: Time zone used in the response. Optional. The default is the time zone of the calendar. ### `updatedMin` - **Type**: `datetime` - **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. ``` -------------------------------- ### Calendars - Insert Source: https://developers.google.com/workspace/calendar/api/v3/reference?hl=es-419 Creates a secondary calendar. The authenticated user for the request becomes the owner of the new calendar's data. ```APIDOC ## POST /calendars ### Description Creates a secondary calendar. The authenticated user for the request becomes the owner of the new calendar's data. ### Method POST ### Endpoint /calendars ``` -------------------------------- ### CalendarList Resource Methods Source: https://developers.google.com/workspace/calendar/api/v3/reference Methods for managing a user's calendar list. ```APIDOC ## DELETE /users/me/calendarList/calendarId ### Description Removes a calendar from the user's calendar list. ### Method DELETE ### Endpoint /users/me/calendarList/calendarId ``` ```APIDOC ## GET /users/me/calendarList/calendarId ### Description Returns a calendar from the user's calendar list. ### Method GET ### Endpoint /users/me/calendarList/calendarId ``` ```APIDOC ## POST /users/me/calendarList ### Description Inserts an existing calendar into the user's calendar list. ### Method POST ### Endpoint /users/me/calendarList ``` ```APIDOC ## GET /users/me/calendarList ### Description Returns the calendars on the user's calendar list. ### Method GET ### Endpoint /users/me/calendarList ``` ```APIDOC ## PATCH /users/me/calendarList/calendarId ### Description Updates an existing calendar on the user's calendar list. This method supports patch semantics. Note that each patch request consumes three quota units; prefer using a `get` followed by an `update`. The field values you specify replace the existing values. Fields that you don't specify in the request remain unchanged. Array fields, if specified, overwrite the existing arrays; this discards any previous array elements. ### Method PATCH ### Endpoint /users/me/calendarList/calendarId ``` ```APIDOC ## PUT /users/me/calendarList/calendarId ### Description Updates an existing calendar on the user's calendar list. ### Method PUT ### Endpoint /users/me/calendarList/calendarId ``` ```APIDOC ## POST /users/me/calendarList/watch ### Description Watch for changes to CalendarList resources. ### Method POST ### Endpoint /users/me/calendarList/watch ``` -------------------------------- ### Get ACL Rule HTTP Request Source: https://developers.google.com/workspace/calendar/api/v3/reference/acl/get This is the HTTP request to retrieve a specific access control rule. Replace `calendarId` and `ruleId` with your actual values. This method does not require a request body. ```http GET https://www.googleapis.com/calendar/v3/calendars/calendarId/acl/ruleId ``` -------------------------------- ### HTTP Request for Freebusy Query Source: https://developers.google.com/workspace/calendar/api/v3/reference/freebusy/query This is the endpoint for querying free/busy information. It uses the POST method. ```http POST https://www.googleapis.com/calendar/v3/freeBusy ``` -------------------------------- ### GET Calendars Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendars/get Use this endpoint to retrieve metadata for a specific calendar. You can access the primary calendar of the logged-in user by using the 'primary' keyword for the calendar ID. Ensure you have the necessary authorization scopes. ```HTTP GET https://www.googleapis.com/calendar/v3/calendars/calendarId ``` -------------------------------- ### Channels Resource Methods Source: https://developers.google.com/workspace/calendar/api/v3/reference Methods for managing notification channels. ```APIDOC ## POST /channels/stop ### Description Stop watching resources through this channel. ### Method POST ### Endpoint /channels/stop ``` -------------------------------- ### Events: update Source: https://developers.google.com/workspace/calendar/api/v3/reference/events/update Updates an event. This method does not support patch semantics and always updates the entire event resource. To do a partial update, perform a `get` followed by an `update` using etags to ensure atomicity. ```APIDOC ## PUT https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId ### Description Updates an event. This method does not support patch semantics and always updates the entire event resource. To do a partial update, perform a `get` followed by an `update` using etags to ensure atomicity. ### Method PUT ### Endpoint https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId ### Parameters #### Path Parameters - **calendarId** (string) - Required - 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. - **eventId** (string) - Required - Event identifier. #### Query Parameters - **alwaysIncludeEmail** (boolean) - Optional - 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). - **conferenceDataVersion** (integer) - Optional - 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. Acceptable values are `0` to `1`, inclusive. - **maxAttendees** (integer) - Optional - 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. - **sendNotifications** (boolean) - Optional - Deprecated. Please use sendUpdates instead. Whether 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`. - **sendUpdates** (string) - Optional - Guests who should receive notifications about the event update (for example, title changes, etc.). Acceptable values are: `all`, `externalOnly`, `none`. For calendar migration tasks, consider using the Events.import method instead. - **supportsAttachments** (boolean) - Optional - Whether API client performing operation supports event attachments. The default is False. ### Authorization This request requires authorization with at least one of the following scopes: - `https://www.googleapis.com/auth/calendar` - `https://www.googleapis.com/auth/calendar.events` - `https://www.googleapis.com/auth/calendar.app.created` - `https://www.googleapis.com/auth/calendar.events.owned` ``` -------------------------------- ### Freebusy Resource Source: https://developers.google.com/workspace/calendar/api/v3/reference Provides methods to query free/busy information for a set of calendars. ```APIDOC ## Freebusy Resource ### Description Returns free/busy information for a set of calendars. ### Method POST ### Endpoint `/freeBusy` ``` -------------------------------- ### list Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendarList?hl=pt-BR Retrieves the list of calendars for the user. ```APIDOC ## list ### Description Returns the calendars in the user's calendar list. ### Method GET ### Endpoint /users/me/calendarList ### Query Parameters - **maxResults** (integer) - Optional - Maximum number of events returned on one page. Defaults to 100. ``` -------------------------------- ### Calendars: insert Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendars/insert Creates a secondary calendar. The authenticated user for the request is made the data owner of the new calendar. ```APIDOC ## POST https://www.googleapis.com/calendar/v3/calendars ### Description Creates a secondary calendar. The authenticated user for the request is made the data owner of the new calendar. ### Method POST ### Endpoint https://www.googleapis.com/calendar/v3/calendars ### Authorization This request requires authorization with at least one of the following scopes: - `https://www.googleapis.com/auth/calendar` - `https://www.googleapis.com/auth/calendar.app.created` - `https://www.googleapis.com/auth/calendar.calendars` ### Request Body #### Request Body - **summary** (string) - Required - Title of the calendar. ### Response #### Success Response (200) Returns a Calendars resource. ``` -------------------------------- ### insert Source: https://developers.google.com/workspace/calendar/api/v3/reference/calendarList?hl=pt-BR Adds a new calendar to the user's calendar list. ```APIDOC ## insert ### Description Inserts a calendar into the user's calendar list. ### Method POST ### Endpoint /calendars ### Request Body - **resource** (CalendarListEntry) - Required - The calendar list entry to insert. ``` -------------------------------- ### Freebusy Query Source: https://developers.google.com/workspace/calendar/api/v3/reference/freebusy/query Returns free/busy information for a set of calendars. This endpoint requires authentication. ```APIDOC ## POST https://www.googleapis.com/calendar/v3/freeBusy ### Description Returns free/busy information for a set of calendars. ### Method POST ### Endpoint https://www.googleapis.com/calendar/v3/freeBusy ### Authorization This request allows authorization with at least one of the following scopes: - `https://www.googleapis.com/auth/calendar.readonly` - `https://www.googleapis.com/auth/calendar` - `https://www.googleapis.com/auth/calendar.events.freebusy` - `https://www.googleapis.com/auth/calendar.freebusy` ### Request Body #### Request Body Structure ```json { "timeMin": "datetime", "timeMax": "datetime", "timeZone": "string", "groupExpansionMax": "integer", "calendarExpansionMax": "integer", "items": [ { "id": "string" } ] } ``` #### Request Body Parameters - **timeMin** (datetime) - Required - The start of the interval for the query formatted as per RFC3339. - **timeMax** (datetime) - Required - The end of the interval for the query formatted as per RFC3339. - **timeZone** (string) - Optional - Time zone used in the response. The default is UTC. - **groupExpansionMax** (integer) - Optional - Maximal number of calendar identifiers to be provided for a single group. An error is returned for a group with more members than this value. Maximum value is 100. - **calendarExpansionMax** (integer) - Optional - Maximal number of calendars for which FreeBusy information is to be provided. Maximum value is 50. - **items** (list) - Required - List of calendars and/or groups to query. - **items[].id** (string) - Required - The identifier of a calendar or a group. ### Response (Response details not provided in the source text) ```