1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="calendar_v3.html">Calendar API</a> . <a href="calendar_v3.calendarList.html">calendarList</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(calendarId)</a></code></p> 82<p class="firstline">Removes a calendar from the user's calendar list.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(calendarId)</a></code></p> 85<p class="firstline">Returns a calendar from the user's calendar list.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(body=None, colorRgbFormat=None)</a></code></p> 88<p class="firstline">Inserts an existing calendar into the user's calendar list.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, syncToken=None)</a></code></p> 91<p class="firstline">Returns the calendars on the user's calendar list.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(calendarId, body=None, colorRgbFormat=None)</a></code></p> 97<p class="firstline">Updates an existing calendar on the user's calendar list. This method supports patch semantics.</p> 98<p class="toc_element"> 99 <code><a href="#update">update(calendarId, body=None, colorRgbFormat=None)</a></code></p> 100<p class="firstline">Updates an existing calendar on the user's calendar list.</p> 101<p class="toc_element"> 102 <code><a href="#watch">watch(body=None, maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, syncToken=None)</a></code></p> 103<p class="firstline">Watch for changes to CalendarList resources.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="close">close()</code> 107 <pre>Close httplib2 connections.</pre> 108</div> 109 110<div class="method"> 111 <code class="details" id="delete">delete(calendarId)</code> 112 <pre>Removes a calendar from the user's calendar list. 113 114Args: 115 calendarId: string, 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) 116</pre> 117</div> 118 119<div class="method"> 120 <code class="details" id="get">get(calendarId)</code> 121 <pre>Returns a calendar from the user's calendar list. 122 123Args: 124 calendarId: string, 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) 125 126Returns: 127 An object of the form: 128 129 { 130 "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: 131 # - "freeBusyReader" - Provides read access to free/busy information. 132 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. 133 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. 134 # - "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. 135 "backgroundColor": "A String", # 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. 136 "colorId": "A String", # 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. 137 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. 138 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. 139 # The possible values are: 140 # - "eventHangout" 141 # - "eventNamedHangout" 142 # - "hangoutsMeet" Optional. 143 "A String", 144 ], 145 }, 146 "defaultReminders": [ # The default reminders that the authenticated user has for this calendar. 147 { 148 "method": "A String", # The method used by this reminder. Possible values are: 149 # - "email" - Reminders are sent via email. 150 # - "popup" - Reminders are sent via a UI popup. 151 # Required when adding a reminder. 152 "minutes": 42, # 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). 153 # Required when adding a reminder. 154 }, 155 ], 156 "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. 157 "description": "A String", # Description of the calendar. Optional. Read-only. 158 "etag": "A String", # ETag of the resource. 159 "foregroundColor": "A String", # 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. 160 "hidden": false, # 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. 161 "id": "A String", # Identifier of the calendar. 162 "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry"). 163 "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only. 164 "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar. 165 "notifications": [ # The list of notifications set for this calendar. 166 { 167 "method": "A String", # The method used to deliver the notification. The possible value is: 168 # - "email" - Notifications are sent via email. 169 # Required when adding a notification. 170 "type": "A String", # The type of notification. Possible values are: 171 # - "eventCreation" - Notification sent when a new event is put on the calendar. 172 # - "eventChange" - Notification sent when an event is changed. 173 # - "eventCancellation" - Notification sent when an event is cancelled. 174 # - "eventResponse" - Notification sent when an attendee responds to the event invitation. 175 # - "agenda" - An agenda with the events of the day (sent out in the morning). 176 # Required when adding a notification. 177 }, 178 ], 179 }, 180 "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. 181 "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False. 182 "summary": "A String", # Title of the calendar. Read-only. 183 "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional. 184 "timeZone": "A String", # The time zone of the calendar. Optional. Read-only. 185}</pre> 186</div> 187 188<div class="method"> 189 <code class="details" id="insert">insert(body=None, colorRgbFormat=None)</code> 190 <pre>Inserts an existing calendar into the user's calendar list. 191 192Args: 193 body: object, The request body. 194 The object takes the form of: 195 196{ 197 "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: 198 # - "freeBusyReader" - Provides read access to free/busy information. 199 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. 200 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. 201 # - "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. 202 "backgroundColor": "A String", # 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. 203 "colorId": "A String", # 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. 204 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. 205 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. 206 # The possible values are: 207 # - "eventHangout" 208 # - "eventNamedHangout" 209 # - "hangoutsMeet" Optional. 210 "A String", 211 ], 212 }, 213 "defaultReminders": [ # The default reminders that the authenticated user has for this calendar. 214 { 215 "method": "A String", # The method used by this reminder. Possible values are: 216 # - "email" - Reminders are sent via email. 217 # - "popup" - Reminders are sent via a UI popup. 218 # Required when adding a reminder. 219 "minutes": 42, # 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). 220 # Required when adding a reminder. 221 }, 222 ], 223 "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. 224 "description": "A String", # Description of the calendar. Optional. Read-only. 225 "etag": "A String", # ETag of the resource. 226 "foregroundColor": "A String", # 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. 227 "hidden": false, # 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. 228 "id": "A String", # Identifier of the calendar. 229 "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry"). 230 "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only. 231 "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar. 232 "notifications": [ # The list of notifications set for this calendar. 233 { 234 "method": "A String", # The method used to deliver the notification. The possible value is: 235 # - "email" - Notifications are sent via email. 236 # Required when adding a notification. 237 "type": "A String", # The type of notification. Possible values are: 238 # - "eventCreation" - Notification sent when a new event is put on the calendar. 239 # - "eventChange" - Notification sent when an event is changed. 240 # - "eventCancellation" - Notification sent when an event is cancelled. 241 # - "eventResponse" - Notification sent when an attendee responds to the event invitation. 242 # - "agenda" - An agenda with the events of the day (sent out in the morning). 243 # Required when adding a notification. 244 }, 245 ], 246 }, 247 "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. 248 "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False. 249 "summary": "A String", # Title of the calendar. Read-only. 250 "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional. 251 "timeZone": "A String", # The time zone of the calendar. Optional. Read-only. 252} 253 254 colorRgbFormat: boolean, 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. 255 256Returns: 257 An object of the form: 258 259 { 260 "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: 261 # - "freeBusyReader" - Provides read access to free/busy information. 262 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. 263 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. 264 # - "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. 265 "backgroundColor": "A String", # 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. 266 "colorId": "A String", # 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. 267 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. 268 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. 269 # The possible values are: 270 # - "eventHangout" 271 # - "eventNamedHangout" 272 # - "hangoutsMeet" Optional. 273 "A String", 274 ], 275 }, 276 "defaultReminders": [ # The default reminders that the authenticated user has for this calendar. 277 { 278 "method": "A String", # The method used by this reminder. Possible values are: 279 # - "email" - Reminders are sent via email. 280 # - "popup" - Reminders are sent via a UI popup. 281 # Required when adding a reminder. 282 "minutes": 42, # 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). 283 # Required when adding a reminder. 284 }, 285 ], 286 "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. 287 "description": "A String", # Description of the calendar. Optional. Read-only. 288 "etag": "A String", # ETag of the resource. 289 "foregroundColor": "A String", # 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. 290 "hidden": false, # 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. 291 "id": "A String", # Identifier of the calendar. 292 "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry"). 293 "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only. 294 "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar. 295 "notifications": [ # The list of notifications set for this calendar. 296 { 297 "method": "A String", # The method used to deliver the notification. The possible value is: 298 # - "email" - Notifications are sent via email. 299 # Required when adding a notification. 300 "type": "A String", # The type of notification. Possible values are: 301 # - "eventCreation" - Notification sent when a new event is put on the calendar. 302 # - "eventChange" - Notification sent when an event is changed. 303 # - "eventCancellation" - Notification sent when an event is cancelled. 304 # - "eventResponse" - Notification sent when an attendee responds to the event invitation. 305 # - "agenda" - An agenda with the events of the day (sent out in the morning). 306 # Required when adding a notification. 307 }, 308 ], 309 }, 310 "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. 311 "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False. 312 "summary": "A String", # Title of the calendar. Read-only. 313 "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional. 314 "timeZone": "A String", # The time zone of the calendar. Optional. Read-only. 315}</pre> 316</div> 317 318<div class="method"> 319 <code class="details" id="list">list(maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, syncToken=None)</code> 320 <pre>Returns the calendars on the user's calendar list. 321 322Args: 323 maxResults: integer, 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. 324 minAccessRole: string, The minimum access role for the user in the returned entries. Optional. The default is no restriction. 325 Allowed values 326 freeBusyReader - The user can read free/busy information. 327 owner - The user can read and modify events and access control lists. 328 reader - The user can read events that are not private. 329 writer - The user can read and modify events. 330 pageToken: string, Token specifying which result page to return. Optional. 331 showDeleted: boolean, Whether to include deleted calendar list entries in the result. Optional. The default is False. 332 showHidden: boolean, Whether to show hidden entries. Optional. The default is False. 333 syncToken: string, 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. 334To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. 335If 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. 336Learn more about incremental synchronization. 337Optional. The default is to return all entries. 338 339Returns: 340 An object of the form: 341 342 { 343 "etag": "A String", # ETag of the collection. 344 "items": [ # Calendars that are present on the user's calendar list. 345 { 346 "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: 347 # - "freeBusyReader" - Provides read access to free/busy information. 348 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. 349 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. 350 # - "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. 351 "backgroundColor": "A String", # 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. 352 "colorId": "A String", # 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. 353 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. 354 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. 355 # The possible values are: 356 # - "eventHangout" 357 # - "eventNamedHangout" 358 # - "hangoutsMeet" Optional. 359 "A String", 360 ], 361 }, 362 "defaultReminders": [ # The default reminders that the authenticated user has for this calendar. 363 { 364 "method": "A String", # The method used by this reminder. Possible values are: 365 # - "email" - Reminders are sent via email. 366 # - "popup" - Reminders are sent via a UI popup. 367 # Required when adding a reminder. 368 "minutes": 42, # 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). 369 # Required when adding a reminder. 370 }, 371 ], 372 "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. 373 "description": "A String", # Description of the calendar. Optional. Read-only. 374 "etag": "A String", # ETag of the resource. 375 "foregroundColor": "A String", # 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. 376 "hidden": false, # 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. 377 "id": "A String", # Identifier of the calendar. 378 "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry"). 379 "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only. 380 "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar. 381 "notifications": [ # The list of notifications set for this calendar. 382 { 383 "method": "A String", # The method used to deliver the notification. The possible value is: 384 # - "email" - Notifications are sent via email. 385 # Required when adding a notification. 386 "type": "A String", # The type of notification. Possible values are: 387 # - "eventCreation" - Notification sent when a new event is put on the calendar. 388 # - "eventChange" - Notification sent when an event is changed. 389 # - "eventCancellation" - Notification sent when an event is cancelled. 390 # - "eventResponse" - Notification sent when an attendee responds to the event invitation. 391 # - "agenda" - An agenda with the events of the day (sent out in the morning). 392 # Required when adding a notification. 393 }, 394 ], 395 }, 396 "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. 397 "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False. 398 "summary": "A String", # Title of the calendar. Read-only. 399 "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional. 400 "timeZone": "A String", # The time zone of the calendar. Optional. Read-only. 401 }, 402 ], 403 "kind": "calendar#calendarList", # Type of the collection ("calendar#calendarList"). 404 "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. 405 "nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. 406}</pre> 407</div> 408 409<div class="method"> 410 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 411 <pre>Retrieves the next page of results. 412 413Args: 414 previous_request: The request for the previous page. (required) 415 previous_response: The response from the request for the previous page. (required) 416 417Returns: 418 A request object that you can call 'execute()' on to request the next 419 page. Returns None if there are no more items in the collection. 420 </pre> 421</div> 422 423<div class="method"> 424 <code class="details" id="patch">patch(calendarId, body=None, colorRgbFormat=None)</code> 425 <pre>Updates an existing calendar on the user's calendar list. This method supports patch semantics. 426 427Args: 428 calendarId: string, 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) 429 body: object, The request body. 430 The object takes the form of: 431 432{ 433 "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: 434 # - "freeBusyReader" - Provides read access to free/busy information. 435 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. 436 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. 437 # - "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. 438 "backgroundColor": "A String", # 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. 439 "colorId": "A String", # 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. 440 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. 441 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. 442 # The possible values are: 443 # - "eventHangout" 444 # - "eventNamedHangout" 445 # - "hangoutsMeet" Optional. 446 "A String", 447 ], 448 }, 449 "defaultReminders": [ # The default reminders that the authenticated user has for this calendar. 450 { 451 "method": "A String", # The method used by this reminder. Possible values are: 452 # - "email" - Reminders are sent via email. 453 # - "popup" - Reminders are sent via a UI popup. 454 # Required when adding a reminder. 455 "minutes": 42, # 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). 456 # Required when adding a reminder. 457 }, 458 ], 459 "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. 460 "description": "A String", # Description of the calendar. Optional. Read-only. 461 "etag": "A String", # ETag of the resource. 462 "foregroundColor": "A String", # 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. 463 "hidden": false, # 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. 464 "id": "A String", # Identifier of the calendar. 465 "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry"). 466 "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only. 467 "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar. 468 "notifications": [ # The list of notifications set for this calendar. 469 { 470 "method": "A String", # The method used to deliver the notification. The possible value is: 471 # - "email" - Notifications are sent via email. 472 # Required when adding a notification. 473 "type": "A String", # The type of notification. Possible values are: 474 # - "eventCreation" - Notification sent when a new event is put on the calendar. 475 # - "eventChange" - Notification sent when an event is changed. 476 # - "eventCancellation" - Notification sent when an event is cancelled. 477 # - "eventResponse" - Notification sent when an attendee responds to the event invitation. 478 # - "agenda" - An agenda with the events of the day (sent out in the morning). 479 # Required when adding a notification. 480 }, 481 ], 482 }, 483 "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. 484 "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False. 485 "summary": "A String", # Title of the calendar. Read-only. 486 "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional. 487 "timeZone": "A String", # The time zone of the calendar. Optional. Read-only. 488} 489 490 colorRgbFormat: boolean, 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. 491 492Returns: 493 An object of the form: 494 495 { 496 "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: 497 # - "freeBusyReader" - Provides read access to free/busy information. 498 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. 499 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. 500 # - "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. 501 "backgroundColor": "A String", # 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. 502 "colorId": "A String", # 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. 503 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. 504 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. 505 # The possible values are: 506 # - "eventHangout" 507 # - "eventNamedHangout" 508 # - "hangoutsMeet" Optional. 509 "A String", 510 ], 511 }, 512 "defaultReminders": [ # The default reminders that the authenticated user has for this calendar. 513 { 514 "method": "A String", # The method used by this reminder. Possible values are: 515 # - "email" - Reminders are sent via email. 516 # - "popup" - Reminders are sent via a UI popup. 517 # Required when adding a reminder. 518 "minutes": 42, # 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). 519 # Required when adding a reminder. 520 }, 521 ], 522 "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. 523 "description": "A String", # Description of the calendar. Optional. Read-only. 524 "etag": "A String", # ETag of the resource. 525 "foregroundColor": "A String", # 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. 526 "hidden": false, # 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. 527 "id": "A String", # Identifier of the calendar. 528 "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry"). 529 "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only. 530 "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar. 531 "notifications": [ # The list of notifications set for this calendar. 532 { 533 "method": "A String", # The method used to deliver the notification. The possible value is: 534 # - "email" - Notifications are sent via email. 535 # Required when adding a notification. 536 "type": "A String", # The type of notification. Possible values are: 537 # - "eventCreation" - Notification sent when a new event is put on the calendar. 538 # - "eventChange" - Notification sent when an event is changed. 539 # - "eventCancellation" - Notification sent when an event is cancelled. 540 # - "eventResponse" - Notification sent when an attendee responds to the event invitation. 541 # - "agenda" - An agenda with the events of the day (sent out in the morning). 542 # Required when adding a notification. 543 }, 544 ], 545 }, 546 "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. 547 "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False. 548 "summary": "A String", # Title of the calendar. Read-only. 549 "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional. 550 "timeZone": "A String", # The time zone of the calendar. Optional. Read-only. 551}</pre> 552</div> 553 554<div class="method"> 555 <code class="details" id="update">update(calendarId, body=None, colorRgbFormat=None)</code> 556 <pre>Updates an existing calendar on the user's calendar list. 557 558Args: 559 calendarId: string, 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) 560 body: object, The request body. 561 The object takes the form of: 562 563{ 564 "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: 565 # - "freeBusyReader" - Provides read access to free/busy information. 566 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. 567 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. 568 # - "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. 569 "backgroundColor": "A String", # 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. 570 "colorId": "A String", # 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. 571 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. 572 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. 573 # The possible values are: 574 # - "eventHangout" 575 # - "eventNamedHangout" 576 # - "hangoutsMeet" Optional. 577 "A String", 578 ], 579 }, 580 "defaultReminders": [ # The default reminders that the authenticated user has for this calendar. 581 { 582 "method": "A String", # The method used by this reminder. Possible values are: 583 # - "email" - Reminders are sent via email. 584 # - "popup" - Reminders are sent via a UI popup. 585 # Required when adding a reminder. 586 "minutes": 42, # 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). 587 # Required when adding a reminder. 588 }, 589 ], 590 "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. 591 "description": "A String", # Description of the calendar. Optional. Read-only. 592 "etag": "A String", # ETag of the resource. 593 "foregroundColor": "A String", # 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. 594 "hidden": false, # 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. 595 "id": "A String", # Identifier of the calendar. 596 "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry"). 597 "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only. 598 "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar. 599 "notifications": [ # The list of notifications set for this calendar. 600 { 601 "method": "A String", # The method used to deliver the notification. The possible value is: 602 # - "email" - Notifications are sent via email. 603 # Required when adding a notification. 604 "type": "A String", # The type of notification. Possible values are: 605 # - "eventCreation" - Notification sent when a new event is put on the calendar. 606 # - "eventChange" - Notification sent when an event is changed. 607 # - "eventCancellation" - Notification sent when an event is cancelled. 608 # - "eventResponse" - Notification sent when an attendee responds to the event invitation. 609 # - "agenda" - An agenda with the events of the day (sent out in the morning). 610 # Required when adding a notification. 611 }, 612 ], 613 }, 614 "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. 615 "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False. 616 "summary": "A String", # Title of the calendar. Read-only. 617 "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional. 618 "timeZone": "A String", # The time zone of the calendar. Optional. Read-only. 619} 620 621 colorRgbFormat: boolean, 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. 622 623Returns: 624 An object of the form: 625 626 { 627 "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: 628 # - "freeBusyReader" - Provides read access to free/busy information. 629 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. 630 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. 631 # - "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. 632 "backgroundColor": "A String", # 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. 633 "colorId": "A String", # 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. 634 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. 635 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. 636 # The possible values are: 637 # - "eventHangout" 638 # - "eventNamedHangout" 639 # - "hangoutsMeet" Optional. 640 "A String", 641 ], 642 }, 643 "defaultReminders": [ # The default reminders that the authenticated user has for this calendar. 644 { 645 "method": "A String", # The method used by this reminder. Possible values are: 646 # - "email" - Reminders are sent via email. 647 # - "popup" - Reminders are sent via a UI popup. 648 # Required when adding a reminder. 649 "minutes": 42, # 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). 650 # Required when adding a reminder. 651 }, 652 ], 653 "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. 654 "description": "A String", # Description of the calendar. Optional. Read-only. 655 "etag": "A String", # ETag of the resource. 656 "foregroundColor": "A String", # 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. 657 "hidden": false, # 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. 658 "id": "A String", # Identifier of the calendar. 659 "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry"). 660 "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only. 661 "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar. 662 "notifications": [ # The list of notifications set for this calendar. 663 { 664 "method": "A String", # The method used to deliver the notification. The possible value is: 665 # - "email" - Notifications are sent via email. 666 # Required when adding a notification. 667 "type": "A String", # The type of notification. Possible values are: 668 # - "eventCreation" - Notification sent when a new event is put on the calendar. 669 # - "eventChange" - Notification sent when an event is changed. 670 # - "eventCancellation" - Notification sent when an event is cancelled. 671 # - "eventResponse" - Notification sent when an attendee responds to the event invitation. 672 # - "agenda" - An agenda with the events of the day (sent out in the morning). 673 # Required when adding a notification. 674 }, 675 ], 676 }, 677 "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. 678 "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False. 679 "summary": "A String", # Title of the calendar. Read-only. 680 "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional. 681 "timeZone": "A String", # The time zone of the calendar. Optional. Read-only. 682}</pre> 683</div> 684 685<div class="method"> 686 <code class="details" id="watch">watch(body=None, maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, syncToken=None)</code> 687 <pre>Watch for changes to CalendarList resources. 688 689Args: 690 body: object, The request body. 691 The object takes the form of: 692 693{ 694 "address": "A String", # The address where notifications are delivered for this channel. 695 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 696 "id": "A String", # A UUID or similar unique string that identifies this channel. 697 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". 698 "params": { # Additional parameters controlling delivery channel behavior. Optional. 699 "a_key": "A String", # Declares a new parameter by name. 700 }, 701 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 702 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 703 "resourceUri": "A String", # A version-specific identifier for the watched resource. 704 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 705 "type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages. 706} 707 708 maxResults: integer, 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. 709 minAccessRole: string, The minimum access role for the user in the returned entries. Optional. The default is no restriction. 710 Allowed values 711 freeBusyReader - The user can read free/busy information. 712 owner - The user can read and modify events and access control lists. 713 reader - The user can read events that are not private. 714 writer - The user can read and modify events. 715 pageToken: string, Token specifying which result page to return. Optional. 716 showDeleted: boolean, Whether to include deleted calendar list entries in the result. Optional. The default is False. 717 showHidden: boolean, Whether to show hidden entries. Optional. The default is False. 718 syncToken: string, 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. 719To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. 720If 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. 721Learn more about incremental synchronization. 722Optional. The default is to return all entries. 723 724Returns: 725 An object of the form: 726 727 { 728 "address": "A String", # The address where notifications are delivered for this channel. 729 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 730 "id": "A String", # A UUID or similar unique string that identifies this channel. 731 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". 732 "params": { # Additional parameters controlling delivery channel behavior. Optional. 733 "a_key": "A String", # Declares a new parameter by name. 734 }, 735 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 736 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 737 "resourceUri": "A String", # A version-specific identifier for the watched resource. 738 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 739 "type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages. 740}</pre> 741</div> 742 743</body></html>