> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# google-calendar-api-management
> Google Calendar Management
**Server path:** `/google-calendar-api-management` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| [`google-calendar-api-management_add_calendar_to_list`](#google-calendar-api-management_add_calendar_to_list) | Inserts an existing calendar into the user's calendar list. |
| [`google-calendar-api-management_create_acl_rule`](#google-calendar-api-management_create_acl_rule) | Creates an access control rule. |
| [`google-calendar-api-management_create_calendar`](#google-calendar-api-management_create_calendar) | Creates a secondary calendar. |
| [`google-calendar-api-management_delete_acl_rule`](#google-calendar-api-management_delete_acl_rule) | Deletes an access control rule. |
| [`google-calendar-api-management_delete_calendar`](#google-calendar-api-management_delete_calendar) | Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars. |
| [`google-calendar-api-management_get_acl_rule`](#google-calendar-api-management_get_acl_rule) | Returns an access control rule. |
| [`google-calendar-api-management_get_calendar`](#google-calendar-api-management_get_calendar) | Returns metadata for a calendar. |
| [`google-calendar-api-management_get_calendar_list_entry`](#google-calendar-api-management_get_calendar_list_entry) | Returns a calendar from the user's calendar list. |
| [`google-calendar-api-management_get_colors`](#google-calendar-api-management_get_colors) | Returns the color definitions for calendars and events. |
| [`google-calendar-api-management_get_setting`](#google-calendar-api-management_get_setting) | Returns a single user setting. |
| [`google-calendar-api-management_list_acl_rules`](#google-calendar-api-management_list_acl_rules) | Returns the rules in the access control list for the calendar. |
| [`google-calendar-api-management_list_calendars`](#google-calendar-api-management_list_calendars) | Returns the calendars on the user's calendar list. |
| [`google-calendar-api-management_list_settings`](#google-calendar-api-management_list_settings) | Returns all user settings for the authenticated user. |
| [`google-calendar-api-management_query_free_busy`](#google-calendar-api-management_query_free_busy) | Returns free/busy information for a set of calendars. |
| [`google-calendar-api-management_remove_calendar_from_list`](#google-calendar-api-management_remove_calendar_from_list) | Removes a calendar from the user's calendar list. |
| [`google-calendar-api-management_replace_acl_rule`](#google-calendar-api-management_replace_acl_rule) | Updates an access control rule. |
| [`google-calendar-api-management_replace_calendar`](#google-calendar-api-management_replace_calendar) | Updates metadata for a calendar. |
| [`google-calendar-api-management_replace_calendar_list_entry`](#google-calendar-api-management_replace_calendar_list_entry) | Updates an existing calendar on the user's calendar list. |
| [`google-calendar-api-management_update_acl_rule`](#google-calendar-api-management_update_acl_rule) | Updates an access control rule. This method supports patch semantics. |
| [`google-calendar-api-management_update_calendar`](#google-calendar-api-management_update_calendar) | Updates metadata for a calendar. This method supports patch semantics. |
| [`google-calendar-api-management_update_calendar_list_entry`](#google-calendar-api-management_update_calendar_list_entry) | Updates an existing calendar on the user's calendar list. This method supports patch semantics. |
***
## google-calendar-api-management\_add\_calendar\_to\_list
Inserts an existing calendar into the user's calendar list.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `colorRgbFormat` | boolean | No | — | 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. |
| `accessRole` | string | No | — | The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. |
| `backgroundColor` | string | No | — | 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. |
| `colorId` | string | No | — | 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. |
| `conferenceProperties` | object | No | — | Conference Properties |
| `defaultReminders` | object\[] | No | — | The default reminders that the authenticated user has for this calendar. |
| `deleted` | boolean | No | — | Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. |
| `description` | string | No | — | Description of the calendar. Optional. Read-only. |
| `etag` | string | No | — | ETag of the resource. |
| `foregroundColor` | string | No | — | 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. |
| `hidden` | boolean | No | — | 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. |
| `id` | string | No | — | Identifier of the calendar. |
| `kind` | string | No | — | Type of the resource ("calendar#calendarListEntry"). |
| `location` | string | No | — | Geographic location of the calendar as free-form text. Optional. Read-only. |
| `notificationSettings` | object | No | — | The notifications that the authenticated user is receiving for this calendar. |
| `primary` | boolean | No | — | Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. |
| `selected` | boolean | No | — | Whether the calendar content shows up in the calendar UI. Optional. The default is False. |
| `summary` | string | No | — | Title of the calendar. Read-only. |
| `summaryOverride` | string | No | — | The summary that the authenticated user has set for this calendar. Optional. |
| `timeZone` | string | No | — | The time zone of the calendar. Optional. Read-only. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"colorRgbFormat": {
"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."
},
"accessRole": {
"type": "string",
"description": "The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - \"freeBusyReader\" - Provides read access to free/busy information. - \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs."
},
"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."
},
"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."
},
"conferenceProperties": {
"type": "object",
"description": "Conference Properties",
"properties": {
"allowedConferenceSolutionTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "The types of conference solutions that are supported for this calendar. The possible values are: - \"eventHangout\" - \"eventNamedHangout\" - \"hangoutsMeet\" Optional."
}
}
},
"defaultReminders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"method": {
"type": "string",
"description": "The method used by this reminder. Possible values are: - \"email\" - Reminders are sent via email. - \"popup\" - Reminders are sent via a UI popup. Required when adding a reminder."
},
"minutes": {
"type": "integer",
"format": "int32",
"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). Required when adding a reminder."
}
}
},
"description": "The default reminders that the authenticated user has for this calendar."
},
"deleted": {
"type": "boolean",
"description": "Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False."
},
"description": {
"type": "string",
"description": "Description of the calendar. Optional. Read-only."
},
"etag": {
"type": "string",
"description": "ETag of the resource."
},
"foregroundColor": {
"type": "string",
"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."
},
"hidden": {
"type": "boolean",
"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."
},
"id": {
"type": "string",
"description": "Identifier of the calendar."
},
"kind": {
"type": "string",
"description": "Type of the resource (\"calendar#calendarListEntry\")."
},
"location": {
"type": "string",
"description": "Geographic location of the calendar as free-form text. Optional. Read-only."
},
"notificationSettings": {
"type": "object",
"description": "The notifications that the authenticated user is receiving for this calendar.",
"properties": {
"notifications": {
"type": "array",
"items": {
"type": "object"
},
"description": "The list of notifications set for this calendar."
}
}
},
"primary": {
"type": "boolean",
"description": "Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False."
},
"selected": {
"type": "boolean",
"description": "Whether the calendar content shows up in the calendar UI. Optional. The default is False."
},
"summary": {
"type": "string",
"description": "Title of the calendar. Read-only."
},
"summaryOverride": {
"type": "string",
"description": "The summary that the authenticated user has set for this calendar. Optional."
},
"timeZone": {
"type": "string",
"description": "The time zone of the calendar. Optional. Read-only."
}
},
"required": [
"PCID"
]
}
```
***
## google-calendar-api-management\_create\_acl\_rule
Creates an access control rule.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarId` | string | Yes | — | 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` | boolean | No | — | Whether to send notifications about the calendar sharing change. Optional. The default is True. |
| `etag` | string | No | — | ETag of the resource. |
| `id` | string | No | — | Identifier of the Access Control List (ACL) rule. See Sharing calendars. |
| `kind` | string | No | — | Type of the resource ("calendar#aclRule"). |
| `role` | string | No | — | The role assigned to the scope. Possible values are: - "none" - Provides no access. - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. |
| `scope` | object | No | — | The extent to which calendar access is granted by this ACL rule. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarId": {
"type": "string",
"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": {
"type": "boolean",
"description": "Whether to send notifications about the calendar sharing change. Optional. The default is True."
},
"etag": {
"type": "string",
"description": "ETag of the resource."
},
"id": {
"type": "string",
"description": "Identifier of the Access Control List (ACL) rule. See Sharing calendars."
},
"kind": {
"type": "string",
"description": "Type of the resource (\"calendar#aclRule\")."
},
"role": {
"type": "string",
"description": "The role assigned to the scope. Possible values are: - \"none\" - Provides no access. - \"freeBusyReader\" - Provides read access to free/busy information. - \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs."
},
"scope": {
"type": "object",
"description": "The extent to which calendar access is granted by this ACL rule.",
"properties": {
"type": {
"type": "string",
"description": "The type of the scope. Possible values are: - \"default\" - The public scope. This is the default value. - \"user\" - Limits the scope to a single user. - \"group\" - Limits the scope to a group. - \"domain\" - Limits the scope to a domain. Note: The permissions granted to the \"default\", or public, scope apply to any user, authenticated or not."
},
"value": {
"type": "string",
"description": "The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type \"default\"."
}
}
}
},
"required": [
"PCID",
"calendarId"
]
}
```
***
## google-calendar-api-management\_create\_calendar
Creates a secondary calendar.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `conferenceProperties` | object | No | — | Conference Properties |
| `description` | string | No | — | Description of the calendar. Optional. |
| `etag` | string | No | — | ETag of the resource. |
| `id` | string | No | — | Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
| `kind` | string | No | — | Type of the resource ("calendar#calendar"). |
| `location` | string | No | — | Geographic location of the calendar as free-form text. Optional. |
| `summary` | string | No | — | Title of the calendar. |
| `timeZone` | string | No | — | The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"conferenceProperties": {
"type": "object",
"description": "Conference Properties",
"properties": {
"allowedConferenceSolutionTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "The types of conference solutions that are supported for this calendar. The possible values are: - \"eventHangout\" - \"eventNamedHangout\" - \"hangoutsMeet\" Optional."
}
}
},
"description": {
"type": "string",
"description": "Description of the calendar. Optional."
},
"etag": {
"type": "string",
"description": "ETag of the resource."
},
"id": {
"type": "string",
"description": "Identifier of the calendar. To retrieve IDs call the calendarList.list() method."
},
"kind": {
"type": "string",
"description": "Type of the resource (\"calendar#calendar\")."
},
"location": {
"type": "string",
"description": "Geographic location of the calendar as free-form text. Optional."
},
"summary": {
"type": "string",
"description": "Title of the calendar."
},
"timeZone": {
"type": "string",
"description": "The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) Optional."
}
},
"required": [
"PCID"
]
}
```
***
## google-calendar-api-management\_delete\_acl\_rule
Deletes an access control rule.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarId` | string | Yes | — | 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 | Yes | — | ACL rule identifier. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarId": {
"type": "string",
"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": {
"type": "string",
"description": "ACL rule identifier."
}
},
"required": [
"PCID",
"calendarId",
"ruleId"
]
}
```
***
## google-calendar-api-management\_delete\_calendar
Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarId` | string | Yes | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarId": {
"type": "string",
"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."
}
},
"required": [
"PCID",
"calendarId"
]
}
```
***
## google-calendar-api-management\_get\_acl\_rule
Returns an access control rule.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarId` | string | Yes | — | 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 | Yes | — | ACL rule identifier. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarId": {
"type": "string",
"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": {
"type": "string",
"description": "ACL rule identifier."
}
},
"required": [
"PCID",
"calendarId",
"ruleId"
]
}
```
***
## google-calendar-api-management\_get\_calendar
Returns metadata for a calendar.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarId` | string | Yes | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarId": {
"type": "string",
"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."
}
},
"required": [
"PCID",
"calendarId"
]
}
```
***
## google-calendar-api-management\_get\_calendar\_list\_entry
Returns a calendar from the user's calendar list.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarId` | string | Yes | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarId": {
"type": "string",
"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."
}
},
"required": [
"PCID",
"calendarId"
]
}
```
***
## google-calendar-api-management\_get\_colors
Returns the color definitions for calendars and events.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
}
},
"required": [
"PCID"
]
}
```
***
## google-calendar-api-management\_get\_setting
Returns a single user setting.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `setting` | string | Yes | — | The id of the user setting. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"setting": {
"type": "string",
"description": "The id of the user setting."
}
},
"required": [
"PCID",
"setting"
]
}
```
***
## google-calendar-api-management\_list\_acl\_rules
Returns the rules in the access control list for the calendar.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarId` | string | Yes | — | 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` | integer | No | — | 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` | string | No | — | Token specifying which result page to return. Optional. |
| `showDeleted` | boolean | No | — | 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. |
| `syncToken` | string | No | — | 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. 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. Learn more about incremental synchronization. Optional. The default is to return all entries. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarId": {
"type": "string",
"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": {
"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."
},
"pageToken": {
"type": "string",
"description": "Token specifying which result page to return. Optional."
},
"showDeleted": {
"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."
},
"syncToken": {
"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. 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. Learn more about incremental synchronization. Optional. The default is to return all entries."
}
},
"required": [
"PCID",
"calendarId"
]
}
```
***
## google-calendar-api-management\_list\_calendars
Returns the calendars on the user's calendar list.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `maxResults` | integer | No | — | 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. |
| `minAccessRole` | string | No | — | The minimum access role for the user in the returned entries. Optional. The default is no restriction. |
| `pageToken` | string | No | — | Token specifying which result page to return. Optional. |
| `showDeleted` | boolean | No | — | Whether to include deleted calendar list entries in the result. Optional. The default is False. |
| `showHidden` | boolean | No | — | Whether to show hidden entries. Optional. The default is False. |
| `syncToken` | string | No | — | 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. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. 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. Learn more about incremental synchronization. Optional. The default is to return all entries. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"maxResults": {
"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."
},
"minAccessRole": {
"type": "string",
"description": "The minimum access role for the user in the returned entries. Optional. The default is no restriction.",
"enum": [
"freeBusyReader",
"owner",
"reader",
"writer"
]
},
"pageToken": {
"type": "string",
"description": "Token specifying which result page to return. Optional."
},
"showDeleted": {
"type": "boolean",
"description": "Whether to include deleted calendar list entries in the result. Optional. The default is False."
},
"showHidden": {
"type": "boolean",
"description": "Whether to show hidden entries. Optional. The default is False."
},
"syncToken": {
"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. 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. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. 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. Learn more about incremental synchronization. Optional. The default is to return all entries."
}
},
"required": [
"PCID"
]
}
```
***
## google-calendar-api-management\_list\_settings
Returns all user settings for the authenticated user.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `maxResults` | integer | No | — | 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` | string | No | — | Token specifying which result page to return. Optional. |
| `syncToken` | string | No | — | 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 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. Learn more about incremental synchronization. Optional. The default is to return all entries. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"maxResults": {
"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."
},
"pageToken": {
"type": "string",
"description": "Token specifying which result page to return. Optional."
},
"syncToken": {
"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. 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. Learn more about incremental synchronization. Optional. The default is to return all entries."
}
},
"required": [
"PCID"
]
}
```
***
## google-calendar-api-management\_query\_free\_busy
Returns free/busy information for a set of calendars.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarExpansionMax` | integer | No | — | Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50. |
| `groupExpansionMax` | integer | No | — | 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` | object\[] | No | — | List of calendars and/or groups to query. |
| `timeMax` | string | No | — | The end of the interval for the query formatted as per RFC3339. |
| `timeMin` | string | No | — | The start of the interval for the query formatted as per RFC3339. |
| `timeZone` | string | No | — | Time zone used in the response. Optional. The default is UTC. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarExpansionMax": {
"type": "integer",
"description": "Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50."
},
"groupExpansionMax": {
"type": "integer",
"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",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The identifier of a calendar or a group."
}
}
},
"description": "List of calendars and/or groups to query."
},
"timeMax": {
"type": "string",
"description": "The end of the interval for the query formatted as per RFC3339."
},
"timeMin": {
"type": "string",
"description": "The start of the interval for the query formatted as per RFC3339."
},
"timeZone": {
"type": "string",
"description": "Time zone used in the response. Optional. The default is UTC."
}
},
"required": [
"PCID"
]
}
```
***
## google-calendar-api-management\_remove\_calendar\_from\_list
Removes a calendar from the user's calendar list.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarId` | string | Yes | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarId": {
"type": "string",
"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."
}
},
"required": [
"PCID",
"calendarId"
]
}
```
***
## google-calendar-api-management\_replace\_acl\_rule
Updates an access control rule.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarId` | string | Yes | — | 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 | Yes | — | ACL rule identifier. |
| `sendNotifications` | boolean | No | — | Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True. |
| `etag` | string | No | — | ETag of the resource. |
| `id` | string | No | — | Identifier of the Access Control List (ACL) rule. See Sharing calendars. |
| `kind` | string | No | — | Type of the resource ("calendar#aclRule"). |
| `role` | string | No | — | The role assigned to the scope. Possible values are: - "none" - Provides no access. - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. |
| `scope` | object | No | — | The extent to which calendar access is granted by this ACL rule. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarId": {
"type": "string",
"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": {
"type": "string",
"description": "ACL rule identifier."
},
"sendNotifications": {
"type": "boolean",
"description": "Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True."
},
"etag": {
"type": "string",
"description": "ETag of the resource."
},
"id": {
"type": "string",
"description": "Identifier of the Access Control List (ACL) rule. See Sharing calendars."
},
"kind": {
"type": "string",
"description": "Type of the resource (\"calendar#aclRule\")."
},
"role": {
"type": "string",
"description": "The role assigned to the scope. Possible values are: - \"none\" - Provides no access. - \"freeBusyReader\" - Provides read access to free/busy information. - \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs."
},
"scope": {
"type": "object",
"description": "The extent to which calendar access is granted by this ACL rule.",
"properties": {
"type": {
"type": "string",
"description": "The type of the scope. Possible values are: - \"default\" - The public scope. This is the default value. - \"user\" - Limits the scope to a single user. - \"group\" - Limits the scope to a group. - \"domain\" - Limits the scope to a domain. Note: The permissions granted to the \"default\", or public, scope apply to any user, authenticated or not."
},
"value": {
"type": "string",
"description": "The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type \"default\"."
}
}
}
},
"required": [
"PCID",
"calendarId",
"ruleId"
]
}
```
***
## google-calendar-api-management\_replace\_calendar
Updates metadata for a calendar.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarId` | string | Yes | — | 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. |
| `conferenceProperties` | object | No | — | Conference Properties |
| `description` | string | No | — | Description of the calendar. Optional. |
| `etag` | string | No | — | ETag of the resource. |
| `id` | string | No | — | Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
| `kind` | string | No | — | Type of the resource ("calendar#calendar"). |
| `location` | string | No | — | Geographic location of the calendar as free-form text. Optional. |
| `summary` | string | No | — | Title of the calendar. |
| `timeZone` | string | No | — | The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarId": {
"type": "string",
"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."
},
"conferenceProperties": {
"type": "object",
"description": "Conference Properties",
"properties": {
"allowedConferenceSolutionTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "The types of conference solutions that are supported for this calendar. The possible values are: - \"eventHangout\" - \"eventNamedHangout\" - \"hangoutsMeet\" Optional."
}
}
},
"description": {
"type": "string",
"description": "Description of the calendar. Optional."
},
"etag": {
"type": "string",
"description": "ETag of the resource."
},
"id": {
"type": "string",
"description": "Identifier of the calendar. To retrieve IDs call the calendarList.list() method."
},
"kind": {
"type": "string",
"description": "Type of the resource (\"calendar#calendar\")."
},
"location": {
"type": "string",
"description": "Geographic location of the calendar as free-form text. Optional."
},
"summary": {
"type": "string",
"description": "Title of the calendar."
},
"timeZone": {
"type": "string",
"description": "The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) Optional."
}
},
"required": [
"PCID",
"calendarId"
]
}
```
***
## google-calendar-api-management\_replace\_calendar\_list\_entry
Updates an existing calendar on the user's calendar list.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarId` | string | Yes | — | 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` | boolean | No | — | 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. |
| `accessRole` | string | No | — | The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. |
| `backgroundColor` | string | No | — | 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. |
| `colorId` | string | No | — | 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. |
| `conferenceProperties` | object | No | — | Conference Properties |
| `defaultReminders` | object\[] | No | — | The default reminders that the authenticated user has for this calendar. |
| `deleted` | boolean | No | — | Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. |
| `description` | string | No | — | Description of the calendar. Optional. Read-only. |
| `etag` | string | No | — | ETag of the resource. |
| `foregroundColor` | string | No | — | 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. |
| `hidden` | boolean | No | — | 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. |
| `id` | string | No | — | Identifier of the calendar. |
| `kind` | string | No | — | Type of the resource ("calendar#calendarListEntry"). |
| `location` | string | No | — | Geographic location of the calendar as free-form text. Optional. Read-only. |
| `notificationSettings` | object | No | — | The notifications that the authenticated user is receiving for this calendar. |
| `primary` | boolean | No | — | Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. |
| `selected` | boolean | No | — | Whether the calendar content shows up in the calendar UI. Optional. The default is False. |
| `summary` | string | No | — | Title of the calendar. Read-only. |
| `summaryOverride` | string | No | — | The summary that the authenticated user has set for this calendar. Optional. |
| `timeZone` | string | No | — | The time zone of the calendar. Optional. Read-only. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarId": {
"type": "string",
"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": {
"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."
},
"accessRole": {
"type": "string",
"description": "The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - \"freeBusyReader\" - Provides read access to free/busy information. - \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs."
},
"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."
},
"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."
},
"conferenceProperties": {
"type": "object",
"description": "Conference Properties",
"properties": {
"allowedConferenceSolutionTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "The types of conference solutions that are supported for this calendar. The possible values are: - \"eventHangout\" - \"eventNamedHangout\" - \"hangoutsMeet\" Optional."
}
}
},
"defaultReminders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"method": {
"type": "string",
"description": "The method used by this reminder. Possible values are: - \"email\" - Reminders are sent via email. - \"popup\" - Reminders are sent via a UI popup. Required when adding a reminder."
},
"minutes": {
"type": "integer",
"format": "int32",
"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). Required when adding a reminder."
}
}
},
"description": "The default reminders that the authenticated user has for this calendar."
},
"deleted": {
"type": "boolean",
"description": "Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False."
},
"description": {
"type": "string",
"description": "Description of the calendar. Optional. Read-only."
},
"etag": {
"type": "string",
"description": "ETag of the resource."
},
"foregroundColor": {
"type": "string",
"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."
},
"hidden": {
"type": "boolean",
"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."
},
"id": {
"type": "string",
"description": "Identifier of the calendar."
},
"kind": {
"type": "string",
"description": "Type of the resource (\"calendar#calendarListEntry\")."
},
"location": {
"type": "string",
"description": "Geographic location of the calendar as free-form text. Optional. Read-only."
},
"notificationSettings": {
"type": "object",
"description": "The notifications that the authenticated user is receiving for this calendar.",
"properties": {
"notifications": {
"type": "array",
"items": {
"type": "object"
},
"description": "The list of notifications set for this calendar."
}
}
},
"primary": {
"type": "boolean",
"description": "Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False."
},
"selected": {
"type": "boolean",
"description": "Whether the calendar content shows up in the calendar UI. Optional. The default is False."
},
"summary": {
"type": "string",
"description": "Title of the calendar. Read-only."
},
"summaryOverride": {
"type": "string",
"description": "The summary that the authenticated user has set for this calendar. Optional."
},
"timeZone": {
"type": "string",
"description": "The time zone of the calendar. Optional. Read-only."
}
},
"required": [
"PCID",
"calendarId"
]
}
```
***
## google-calendar-api-management\_update\_acl\_rule
Updates an access control rule. This method supports patch semantics.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarId` | string | Yes | — | 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 | Yes | — | ACL rule identifier. |
| `sendNotifications` | boolean | No | — | Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True. |
| `etag` | string | No | — | ETag of the resource. |
| `id` | string | No | — | Identifier of the Access Control List (ACL) rule. See Sharing calendars. |
| `kind` | string | No | — | Type of the resource ("calendar#aclRule"). |
| `role` | string | No | — | The role assigned to the scope. Possible values are: - "none" - Provides no access. - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. |
| `scope` | object | No | — | The extent to which calendar access is granted by this ACL rule. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarId": {
"type": "string",
"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": {
"type": "string",
"description": "ACL rule identifier."
},
"sendNotifications": {
"type": "boolean",
"description": "Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True."
},
"etag": {
"type": "string",
"description": "ETag of the resource."
},
"id": {
"type": "string",
"description": "Identifier of the Access Control List (ACL) rule. See Sharing calendars."
},
"kind": {
"type": "string",
"description": "Type of the resource (\"calendar#aclRule\")."
},
"role": {
"type": "string",
"description": "The role assigned to the scope. Possible values are: - \"none\" - Provides no access. - \"freeBusyReader\" - Provides read access to free/busy information. - \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs."
},
"scope": {
"type": "object",
"description": "The extent to which calendar access is granted by this ACL rule.",
"properties": {
"type": {
"type": "string",
"description": "The type of the scope. Possible values are: - \"default\" - The public scope. This is the default value. - \"user\" - Limits the scope to a single user. - \"group\" - Limits the scope to a group. - \"domain\" - Limits the scope to a domain. Note: The permissions granted to the \"default\", or public, scope apply to any user, authenticated or not."
},
"value": {
"type": "string",
"description": "The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type \"default\"."
}
}
}
},
"required": [
"PCID",
"calendarId",
"ruleId"
]
}
```
***
## google-calendar-api-management\_update\_calendar
Updates metadata for a calendar. This method supports patch semantics.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarId` | string | Yes | — | 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. |
| `conferenceProperties` | object | No | — | Conference Properties |
| `description` | string | No | — | Description of the calendar. Optional. |
| `etag` | string | No | — | ETag of the resource. |
| `id` | string | No | — | Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
| `kind` | string | No | — | Type of the resource ("calendar#calendar"). |
| `location` | string | No | — | Geographic location of the calendar as free-form text. Optional. |
| `summary` | string | No | — | Title of the calendar. |
| `timeZone` | string | No | — | The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarId": {
"type": "string",
"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."
},
"conferenceProperties": {
"type": "object",
"description": "Conference Properties",
"properties": {
"allowedConferenceSolutionTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "The types of conference solutions that are supported for this calendar. The possible values are: - \"eventHangout\" - \"eventNamedHangout\" - \"hangoutsMeet\" Optional."
}
}
},
"description": {
"type": "string",
"description": "Description of the calendar. Optional."
},
"etag": {
"type": "string",
"description": "ETag of the resource."
},
"id": {
"type": "string",
"description": "Identifier of the calendar. To retrieve IDs call the calendarList.list() method."
},
"kind": {
"type": "string",
"description": "Type of the resource (\"calendar#calendar\")."
},
"location": {
"type": "string",
"description": "Geographic location of the calendar as free-form text. Optional."
},
"summary": {
"type": "string",
"description": "Title of the calendar."
},
"timeZone": {
"type": "string",
"description": "The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) Optional."
}
},
"required": [
"PCID",
"calendarId"
]
}
```
***
## google-calendar-api-management\_update\_calendar\_list\_entry
Updates an existing calendar on the user's calendar list. This method supports patch semantics.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | 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. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `calendarId` | string | Yes | — | 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` | boolean | No | — | 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. |
| `accessRole` | string | No | — | The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. |
| `backgroundColor` | string | No | — | 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. |
| `colorId` | string | No | — | 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. |
| `conferenceProperties` | object | No | — | Conference Properties |
| `defaultReminders` | object\[] | No | — | The default reminders that the authenticated user has for this calendar. |
| `deleted` | boolean | No | — | Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. |
| `description` | string | No | — | Description of the calendar. Optional. Read-only. |
| `etag` | string | No | — | ETag of the resource. |
| `foregroundColor` | string | No | — | 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. |
| `hidden` | boolean | No | — | 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. |
| `id` | string | No | — | Identifier of the calendar. |
| `kind` | string | No | — | Type of the resource ("calendar#calendarListEntry"). |
| `location` | string | No | — | Geographic location of the calendar as free-form text. Optional. Read-only. |
| `notificationSettings` | object | No | — | The notifications that the authenticated user is receiving for this calendar. |
| `primary` | boolean | No | — | Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. |
| `selected` | boolean | No | — | Whether the calendar content shows up in the calendar UI. Optional. The default is False. |
| `summary` | string | No | — | Title of the calendar. Read-only. |
| `summaryOverride` | string | No | — | The summary that the authenticated user has set for this calendar. Optional. |
| `timeZone` | string | No | — | The time zone of the calendar. Optional. Read-only. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"calendarId": {
"type": "string",
"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": {
"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."
},
"accessRole": {
"type": "string",
"description": "The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - \"freeBusyReader\" - Provides read access to free/busy information. - \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs."
},
"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."
},
"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."
},
"conferenceProperties": {
"type": "object",
"description": "Conference Properties",
"properties": {
"allowedConferenceSolutionTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "The types of conference solutions that are supported for this calendar. The possible values are: - \"eventHangout\" - \"eventNamedHangout\" - \"hangoutsMeet\" Optional."
}
}
},
"defaultReminders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"method": {
"type": "string",
"description": "The method used by this reminder. Possible values are: - \"email\" - Reminders are sent via email. - \"popup\" - Reminders are sent via a UI popup. Required when adding a reminder."
},
"minutes": {
"type": "integer",
"format": "int32",
"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). Required when adding a reminder."
}
}
},
"description": "The default reminders that the authenticated user has for this calendar."
},
"deleted": {
"type": "boolean",
"description": "Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False."
},
"description": {
"type": "string",
"description": "Description of the calendar. Optional. Read-only."
},
"etag": {
"type": "string",
"description": "ETag of the resource."
},
"foregroundColor": {
"type": "string",
"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."
},
"hidden": {
"type": "boolean",
"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."
},
"id": {
"type": "string",
"description": "Identifier of the calendar."
},
"kind": {
"type": "string",
"description": "Type of the resource (\"calendar#calendarListEntry\")."
},
"location": {
"type": "string",
"description": "Geographic location of the calendar as free-form text. Optional. Read-only."
},
"notificationSettings": {
"type": "object",
"description": "The notifications that the authenticated user is receiving for this calendar.",
"properties": {
"notifications": {
"type": "array",
"items": {
"type": "object"
},
"description": "The list of notifications set for this calendar."
}
}
},
"primary": {
"type": "boolean",
"description": "Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False."
},
"selected": {
"type": "boolean",
"description": "Whether the calendar content shows up in the calendar UI. Optional. The default is False."
},
"summary": {
"type": "string",
"description": "Title of the calendar. Read-only."
},
"summaryOverride": {
"type": "string",
"description": "The summary that the authenticated user has set for this calendar. Optional."
},
"timeZone": {
"type": "string",
"description": "The time zone of the calendar. Optional. Read-only."
}
},
"required": [
"PCID",
"calendarId"
]
}
```