Debian Codegraph @

docs/dyn/calendar_v3.acl.html

raw
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.acl.html">acl</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, ruleId)</a></code></p>
82 <p class="firstline">Deletes an access control rule.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(calendarId, ruleId)</a></code></p>
85 <p class="firstline">Returns an access control rule.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(calendarId, body=None, sendNotifications=None)</a></code></p>
88 <p class="firstline">Creates an access control rule.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(calendarId, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</a></code></p>
91 <p class="firstline">Returns the rules in the access control list for the calendar.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</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, ruleId, body=None, sendNotifications=None)</a></code></p>
97 <p class="firstline">Updates an access control rule. This method supports patch semantics.</p>
98 <p class="toc_element">
99 <code><a href="#update">update(calendarId, ruleId, body=None, sendNotifications=None)</a></code></p>
100 <p class="firstline">Updates an access control rule.</p>
101 <p class="toc_element">
102 <code><a href="#watch">watch(calendarId, body=None, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</a></code></p>
103 <p class="firstline">Watch for changes to ACL 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, ruleId)</code>
112 <pre>Deletes an access control rule.
113
114 Args:
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 &quot;primary&quot; keyword. (required)
116 ruleId: string, ACL rule identifier. (required)
117 </pre>
118 </div>
119
120 <div class="method">
121 <code class="details" id="get">get(calendarId, ruleId)</code>
122 <pre>Returns an access control rule.
123
124 Args:
125 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)
126 ruleId: string, ACL rule identifier. (required)
127
128 Returns:
129 An object of the form:
130
131 {
132 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
133 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
134 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
135 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
136 # - &quot;none&quot; - Provides no access.
137 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
138 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
139 # - &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. Provides read access to the calendar&#x27;s ACLs.
140 # - &quot;owner&quot; - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users.
141 # Important: the owner role is different from the calendar&#x27;s data owner. A calendar has a single data owner, but can have multiple users with owner role.
142 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
143 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
144 # - &quot;default&quot; - The public scope. This is the default value.
145 # - &quot;user&quot; - Limits the scope to a single user.
146 # - &quot;group&quot; - Limits the scope to a group.
147 # - &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.
148 &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;.
149 },
150 }</pre>
151 </div>
152
153 <div class="method">
154 <code class="details" id="insert">insert(calendarId, body=None, sendNotifications=None)</code>
155 <pre>Creates an access control rule.
156
157 Args:
158 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)
159 body: object, The request body.
160 The object takes the form of:
161
162 {
163 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
164 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
165 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
166 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
167 # - &quot;none&quot; - Provides no access.
168 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
169 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
170 # - &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. Provides read access to the calendar&#x27;s ACLs.
171 # - &quot;owner&quot; - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users.
172 # Important: the owner role is different from the calendar&#x27;s data owner. A calendar has a single data owner, but can have multiple users with owner role.
173 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
174 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
175 # - &quot;default&quot; - The public scope. This is the default value.
176 # - &quot;user&quot; - Limits the scope to a single user.
177 # - &quot;group&quot; - Limits the scope to a group.
178 # - &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.
179 &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;.
180 },
181 }
182
183 sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Optional. The default is True.
184
185 Returns:
186 An object of the form:
187
188 {
189 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
190 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
191 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
192 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
193 # - &quot;none&quot; - Provides no access.
194 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
195 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
196 # - &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. Provides read access to the calendar&#x27;s ACLs.
197 # - &quot;owner&quot; - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users.
198 # Important: the owner role is different from the calendar&#x27;s data owner. A calendar has a single data owner, but can have multiple users with owner role.
199 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
200 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
201 # - &quot;default&quot; - The public scope. This is the default value.
202 # - &quot;user&quot; - Limits the scope to a single user.
203 # - &quot;group&quot; - Limits the scope to a group.
204 # - &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.
205 &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;.
206 },
207 }</pre>
208 </div>
209
210 <div class="method">
211 <code class="details" id="list">list(calendarId, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</code>
212 <pre>Returns the rules in the access control list for the calendar.
213
214 Args:
215 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)
216 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.
217 pageToken: string, Token specifying which result page to return. Optional.
218 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.
219 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.
220 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.
221 Learn more about incremental synchronization.
222 Optional. The default is to return all entries.
223
224 Returns:
225 An object of the form:
226
227 {
228 &quot;etag&quot;: &quot;A String&quot;, # ETag of the collection.
229 &quot;items&quot;: [ # List of rules on the access control list.
230 {
231 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
232 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
233 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
234 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
235 # - &quot;none&quot; - Provides no access.
236 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
237 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
238 # - &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. Provides read access to the calendar&#x27;s ACLs.
239 # - &quot;owner&quot; - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users.
240 # Important: the owner role is different from the calendar&#x27;s data owner. A calendar has a single data owner, but can have multiple users with owner role.
241 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
242 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
243 # - &quot;default&quot; - The public scope. This is the default value.
244 # - &quot;user&quot; - Limits the scope to a single user.
245 # - &quot;group&quot; - Limits the scope to a group.
246 # - &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.
247 &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;.
248 },
249 },
250 ],
251 &quot;kind&quot;: &quot;calendar#acl&quot;, # Type of the collection (&quot;calendar#acl&quot;).
252 &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.
253 &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.
254 }</pre>
255 </div>
256
257 <div class="method">
258 <code class="details" id="list_next">list_next()</code>
259 <pre>Retrieves the next page of results.
260
261 Args:
262 previous_request: The request for the previous page. (required)
263 previous_response: The response from the request for the previous page. (required)
264
265 Returns:
266 A request object that you can call &#x27;execute()&#x27; on to request the next
267 page. Returns None if there are no more items in the collection.
268 </pre>
269 </div>
270
271 <div class="method">
272 <code class="details" id="patch">patch(calendarId, ruleId, body=None, sendNotifications=None)</code>
273 <pre>Updates an access control rule. This method supports patch semantics.
274
275 Args:
276 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)
277 ruleId: string, ACL rule identifier. (required)
278 body: object, The request body.
279 The object takes the form of:
280
281 {
282 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
283 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
284 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
285 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
286 # - &quot;none&quot; - Provides no access.
287 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
288 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
289 # - &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. Provides read access to the calendar&#x27;s ACLs.
290 # - &quot;owner&quot; - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users.
291 # Important: the owner role is different from the calendar&#x27;s data owner. A calendar has a single data owner, but can have multiple users with owner role.
292 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
293 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
294 # - &quot;default&quot; - The public scope. This is the default value.
295 # - &quot;user&quot; - Limits the scope to a single user.
296 # - &quot;group&quot; - Limits the scope to a group.
297 # - &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.
298 &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;.
299 },
300 }
301
302 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.
303
304 Returns:
305 An object of the form:
306
307 {
308 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
309 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
310 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
311 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
312 # - &quot;none&quot; - Provides no access.
313 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
314 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
315 # - &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. Provides read access to the calendar&#x27;s ACLs.
316 # - &quot;owner&quot; - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users.
317 # Important: the owner role is different from the calendar&#x27;s data owner. A calendar has a single data owner, but can have multiple users with owner role.
318 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
319 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
320 # - &quot;default&quot; - The public scope. This is the default value.
321 # - &quot;user&quot; - Limits the scope to a single user.
322 # - &quot;group&quot; - Limits the scope to a group.
323 # - &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.
324 &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;.
325 },
326 }</pre>
327 </div>
328
329 <div class="method">
330 <code class="details" id="update">update(calendarId, ruleId, body=None, sendNotifications=None)</code>
331 <pre>Updates an access control rule.
332
333 Args:
334 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)
335 ruleId: string, ACL rule identifier. (required)
336 body: object, The request body.
337 The object takes the form of:
338
339 {
340 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
341 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
342 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
343 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
344 # - &quot;none&quot; - Provides no access.
345 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
346 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
347 # - &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. Provides read access to the calendar&#x27;s ACLs.
348 # - &quot;owner&quot; - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users.
349 # Important: the owner role is different from the calendar&#x27;s data owner. A calendar has a single data owner, but can have multiple users with owner role.
350 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
351 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
352 # - &quot;default&quot; - The public scope. This is the default value.
353 # - &quot;user&quot; - Limits the scope to a single user.
354 # - &quot;group&quot; - Limits the scope to a group.
355 # - &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.
356 &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;.
357 },
358 }
359
360 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.
361
362 Returns:
363 An object of the form:
364
365 {
366 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
367 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
368 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
369 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
370 # - &quot;none&quot; - Provides no access.
371 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
372 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
373 # - &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. Provides read access to the calendar&#x27;s ACLs.
374 # - &quot;owner&quot; - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users.
375 # Important: the owner role is different from the calendar&#x27;s data owner. A calendar has a single data owner, but can have multiple users with owner role.
376 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
377 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
378 # - &quot;default&quot; - The public scope. This is the default value.
379 # - &quot;user&quot; - Limits the scope to a single user.
380 # - &quot;group&quot; - Limits the scope to a group.
381 # - &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.
382 &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;.
383 },
384 }</pre>
385 </div>
386
387 <div class="method">
388 <code class="details" id="watch">watch(calendarId, body=None, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</code>
389 <pre>Watch for changes to ACL resources.
390
391 Args:
392 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)
393 body: object, The request body.
394 The object takes the form of:
395
396 {
397 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
398 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
399 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
400 &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;.
401 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
402 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
403 },
404 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
405 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
406 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
407 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
408 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel. Valid values are &quot;web_hook&quot; (or &quot;webhook&quot;). Both values refer to a channel where Http requests are used to deliver messages.
409 }
410
411 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.
412 pageToken: string, Token specifying which result page to return. Optional.
413 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.
414 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.
415 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.
416 Learn more about incremental synchronization.
417 Optional. The default is to return all entries.
418
419 Returns:
420 An object of the form:
421
422 {
423 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
424 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
425 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
426 &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;.
427 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
428 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
429 },
430 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
431 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
432 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
433 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
434 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel. Valid values are &quot;web_hook&quot; (or &quot;webhook&quot;). Both values refer to a channel where Http requests are used to deliver messages.
435 }</pre>
436 </div>
437
438 </body></html>