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