blob: 2788d8c4f976c58c6054525d0004e9bc4e2a0c3f [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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.acl.html">acl</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(calendarId, ruleId)</a></code></p>
79<p class="firstline">Deletes an access control rule.</p>
80<p class="toc_element">
81 <code><a href="#get">get(calendarId, ruleId)</a></code></p>
82<p class="firstline">Returns an access control rule.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#insert">insert(calendarId, body=None, sendNotifications=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040085<p class="firstline">Creates an access control rule.</p>
86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070087 <code><a href="#list">list(calendarId, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040088<p class="firstline">Returns the rules in the access control list for the calendar.</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">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#patch">patch(calendarId, ruleId, body=None, sendNotifications=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040094<p class="firstline">Updates an access control rule. This method supports patch semantics.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#update">update(calendarId, ruleId, body=None, sendNotifications=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040097<p class="firstline">Updates an access control rule.</p>
98<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070099 <code><a href="#watch">watch(calendarId, body=None, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400100<p class="firstline">Watch for changes to ACL resources.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="delete">delete(calendarId, ruleId)</code>
104 <pre>Deletes an access control rule.
105
106Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700107 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 &quot;primary&quot; keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -0400108 ruleId: string, ACL rule identifier. (required)
109</pre>
110</div>
111
112<div class="method">
113 <code class="details" id="get">get(calendarId, ruleId)</code>
114 <pre>Returns an access control rule.
115
116Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700117 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 &quot;primary&quot; keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -0400118 ruleId: string, ACL rule identifier. (required)
119
120Returns:
121 An object of the form:
122
123 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700124 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
125 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
126 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
127 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
128 # - &quot;none&quot; - Provides no access.
129 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
130 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
131 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
132 # - &quot;owner&quot; - 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.
133 &quot;scope&quot;: { # The scope of the rule.
134 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
135 # - &quot;default&quot; - The public scope. This is the default value.
136 # - &quot;user&quot; - Limits the scope to a single user.
137 # - &quot;group&quot; - Limits the scope to a group.
138 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
139 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
140 },
141 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400142</div>
143
144<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700145 <code class="details" id="insert">insert(calendarId, body=None, sendNotifications=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400146 <pre>Creates an access control rule.
147
148Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700149 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 &quot;primary&quot; keyword. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700150 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400151 The object takes the form of:
152
153{
Bu Sun Kim65020912020-05-20 12:08:20 -0700154 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
155 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
156 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
157 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
158 # - &quot;none&quot; - Provides no access.
159 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
160 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
161 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
162 # - &quot;owner&quot; - 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.
163 &quot;scope&quot;: { # The scope of the rule.
164 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
165 # - &quot;default&quot; - The public scope. This is the default value.
166 # - &quot;user&quot; - Limits the scope to a single user.
167 # - &quot;group&quot; - Limits the scope to a group.
168 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
169 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
170 },
171}
John Asmuth614db982014-04-24 15:46:26 -0400172
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700173 sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Optional. The default is True.
John Asmuth614db982014-04-24 15:46:26 -0400174
175Returns:
176 An object of the form:
177
178 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700179 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
180 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
181 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
182 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
183 # - &quot;none&quot; - Provides no access.
184 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
185 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
186 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
187 # - &quot;owner&quot; - 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.
188 &quot;scope&quot;: { # The scope of the rule.
189 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
190 # - &quot;default&quot; - The public scope. This is the default value.
191 # - &quot;user&quot; - Limits the scope to a single user.
192 # - &quot;group&quot; - Limits the scope to a group.
193 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
194 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
195 },
196 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400197</div>
198
199<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700200 <code class="details" id="list">list(calendarId, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400201 <pre>Returns the rules in the access control list for the calendar.
202
203Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700204 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 &quot;primary&quot; keyword. (required)
205 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.
206 pageToken: string, Token specifying which result page to return. Optional.
207 showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to &quot;none&quot;. Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
Craig Citro065b5302014-08-14 00:47:23 -0700208 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. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.
209If 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.
210Learn more about incremental synchronization.
211Optional. The default is to return all entries.
John Asmuth614db982014-04-24 15:46:26 -0400212
213Returns:
214 An object of the form:
215
216 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700217 &quot;etag&quot;: &quot;A String&quot;, # ETag of the collection.
218 &quot;items&quot;: [ # List of rules on the access control list.
John Asmuth614db982014-04-24 15:46:26 -0400219 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700220 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
221 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
222 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
223 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
224 # - &quot;none&quot; - Provides no access.
225 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
226 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
227 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
228 # - &quot;owner&quot; - 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.
229 &quot;scope&quot;: { # The scope of the rule.
230 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
231 # - &quot;default&quot; - The public scope. This is the default value.
232 # - &quot;user&quot; - Limits the scope to a single user.
233 # - &quot;group&quot; - Limits the scope to a group.
234 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
235 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
John Asmuth614db982014-04-24 15:46:26 -0400236 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700237 },
John Asmuth614db982014-04-24 15:46:26 -0400238 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700239 &quot;kind&quot;: &quot;calendar#acl&quot;, # Type of the collection (&quot;calendar#acl&quot;).
240 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
241 &quot;nextSyncToken&quot;: &quot;A String&quot;, # 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.
John Asmuth614db982014-04-24 15:46:26 -0400242 }</pre>
243</div>
244
245<div class="method">
246 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
247 <pre>Retrieves the next page of results.
248
249Args:
250 previous_request: The request for the previous page. (required)
251 previous_response: The response from the request for the previous page. (required)
252
253Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700254 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400255 page. Returns None if there are no more items in the collection.
256 </pre>
257</div>
258
259<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700260 <code class="details" id="patch">patch(calendarId, ruleId, body=None, sendNotifications=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400261 <pre>Updates an access control rule. This method supports patch semantics.
262
263Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700264 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 &quot;primary&quot; keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -0400265 ruleId: string, ACL rule identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700266 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400267 The object takes the form of:
268
269{
Bu Sun Kim65020912020-05-20 12:08:20 -0700270 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
271 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
272 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
273 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
274 # - &quot;none&quot; - Provides no access.
275 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
276 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
277 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
278 # - &quot;owner&quot; - 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.
279 &quot;scope&quot;: { # The scope of the rule.
280 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
281 # - &quot;default&quot; - The public scope. This is the default value.
282 # - &quot;user&quot; - Limits the scope to a single user.
283 # - &quot;group&quot; - Limits the scope to a group.
284 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
285 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
286 },
287}
John Asmuth614db982014-04-24 15:46:26 -0400288
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700289 sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
John Asmuth614db982014-04-24 15:46:26 -0400290
291Returns:
292 An object of the form:
293
294 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700295 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
296 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
297 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
298 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
299 # - &quot;none&quot; - Provides no access.
300 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
301 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
302 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
303 # - &quot;owner&quot; - 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.
304 &quot;scope&quot;: { # The scope of the rule.
305 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
306 # - &quot;default&quot; - The public scope. This is the default value.
307 # - &quot;user&quot; - Limits the scope to a single user.
308 # - &quot;group&quot; - Limits the scope to a group.
309 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
310 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
311 },
312 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400313</div>
314
315<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700316 <code class="details" id="update">update(calendarId, ruleId, body=None, sendNotifications=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400317 <pre>Updates an access control rule.
318
319Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700320 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 &quot;primary&quot; keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -0400321 ruleId: string, ACL rule identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700322 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400323 The object takes the form of:
324
325{
Bu Sun Kim65020912020-05-20 12:08:20 -0700326 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
327 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
328 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
329 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
330 # - &quot;none&quot; - Provides no access.
331 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
332 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
333 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
334 # - &quot;owner&quot; - 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.
335 &quot;scope&quot;: { # The scope of the rule.
336 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
337 # - &quot;default&quot; - The public scope. This is the default value.
338 # - &quot;user&quot; - Limits the scope to a single user.
339 # - &quot;group&quot; - Limits the scope to a group.
340 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
341 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
342 },
343}
John Asmuth614db982014-04-24 15:46:26 -0400344
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700345 sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
John Asmuth614db982014-04-24 15:46:26 -0400346
347Returns:
348 An object of the form:
349
350 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700351 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
352 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
353 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
354 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
355 # - &quot;none&quot; - Provides no access.
356 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
357 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
358 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
359 # - &quot;owner&quot; - 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.
360 &quot;scope&quot;: { # The scope of the rule.
361 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
362 # - &quot;default&quot; - The public scope. This is the default value.
363 # - &quot;user&quot; - Limits the scope to a single user.
364 # - &quot;group&quot; - Limits the scope to a group.
365 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
366 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
367 },
368 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400369</div>
370
371<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700372 <code class="details" id="watch">watch(calendarId, body=None, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400373 <pre>Watch for changes to ACL resources.
374
375Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700376 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 &quot;primary&quot; keyword. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700377 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400378 The object takes the form of:
379
380{
Bu Sun Kim65020912020-05-20 12:08:20 -0700381 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
382 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
383 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
384 &quot;kind&quot;: &quot;api#channel&quot;, # Identifies this as a notification channel used to watch for changes to a resource, which is &quot;api#channel&quot;.
385 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
386 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
John Asmuth614db982014-04-24 15:46:26 -0400387 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700388 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
389 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
390 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
391 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
392 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel.
John Asmuth614db982014-04-24 15:46:26 -0400393 }
394
Bu Sun Kim65020912020-05-20 12:08:20 -0700395 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.
396 pageToken: string, Token specifying which result page to return. Optional.
397 showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to &quot;none&quot;. Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
Craig Citro065b5302014-08-14 00:47:23 -0700398 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. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.
399If 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.
400Learn more about incremental synchronization.
401Optional. The default is to return all entries.
John Asmuth614db982014-04-24 15:46:26 -0400402
403Returns:
404 An object of the form:
405
406 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700407 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
408 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
409 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
410 &quot;kind&quot;: &quot;api#channel&quot;, # Identifies this as a notification channel used to watch for changes to a resource, which is &quot;api#channel&quot;.
411 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
412 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
John Asmuth614db982014-04-24 15:46:26 -0400413 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700414 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
415 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
416 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
417 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
418 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel.
John Asmuth614db982014-04-24 15:46:26 -0400419 }</pre>
420</div>
421
422</body></html>