docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/calendar_v3.acl.html b/docs/dyn/calendar_v3.acl.html
index 3cae543..2788d8c 100644
--- a/docs/dyn/calendar_v3.acl.html
+++ b/docs/dyn/calendar_v3.acl.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(calendarId, body=None, sendNotifications=None)</a></code></p>
<p class="firstline">Creates an access control rule.</p>
<p class="toc_element">
- <code><a href="#list">list(calendarId, syncToken=None, pageToken=None, maxResults=None, showDeleted=None)</a></code></p>
+ <code><a href="#list">list(calendarId, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</a></code></p>
<p class="firstline">Returns the rules in the access control list for the calendar.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -96,7 +96,7 @@
<code><a href="#update">update(calendarId, ruleId, body=None, sendNotifications=None)</a></code></p>
<p class="firstline">Updates an access control rule.</p>
<p class="toc_element">
- <code><a href="#watch">watch(calendarId, body=None, syncToken=None, pageToken=None, maxResults=None, showDeleted=None)</a></code></p>
+ <code><a href="#watch">watch(calendarId, body=None, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</a></code></p>
<p class="firstline">Watch for changes to ACL resources.</p>
<h3>Method Details</h3>
<div class="method">
@@ -104,7 +104,7 @@
<pre>Deletes an access control rule.
Args:
- 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)
+ 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)
ruleId: string, ACL rule identifier. (required)
</pre>
</div>
@@ -114,31 +114,31 @@
<pre>Returns an access control rule.
Args:
- 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)
+ 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)
ruleId: string, ACL rule identifier. (required)
Returns:
An object of the form:
{
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- }</pre>
+ "etag": "A String", # ETag of the resource.
+ "id": "A String", # Identifier of the ACL rule.
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "scope": { # The scope of the rule.
+ "type": "A String", # The type of the scope. Possible values are:
+ # - "default" - The public scope. This is the default value.
+ # - "user" - Limits the scope to a single user.
+ # - "group" - Limits the scope to a group.
+ # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
+ "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
+ },
+ }</pre>
</div>
<div class="method">
@@ -146,29 +146,29 @@
<pre>Creates an access control rule.
Args:
- 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)
+ 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)
body: object, The request body.
The object takes the form of:
{
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- }
+ "etag": "A String", # ETag of the resource.
+ "id": "A String", # Identifier of the ACL rule.
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "scope": { # The scope of the rule.
+ "type": "A String", # The type of the scope. Possible values are:
+ # - "default" - The public scope. This is the default value.
+ # - "user" - Limits the scope to a single user.
+ # - "group" - Limits the scope to a group.
+ # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
+ "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
+ },
+}
sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Optional. The default is True.
@@ -176,69 +176,69 @@
An object of the form:
{
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- }</pre>
+ "etag": "A String", # ETag of the resource.
+ "id": "A String", # Identifier of the ACL rule.
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "scope": { # The scope of the rule.
+ "type": "A String", # The type of the scope. Possible values are:
+ # - "default" - The public scope. This is the default value.
+ # - "user" - Limits the scope to a single user.
+ # - "group" - Limits the scope to a group.
+ # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
+ "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
+ },
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(calendarId, syncToken=None, pageToken=None, maxResults=None, showDeleted=None)</code>
+ <code class="details" id="list">list(calendarId, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</code>
<pre>Returns the rules in the access control list for the calendar.
Args:
- 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)
+ 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)
+ 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.
+ pageToken: string, Token specifying which result page to return. Optional.
+ showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.
If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
- pageToken: string, Token specifying which result page to return. Optional.
- 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.
- showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
Returns:
An object of the form:
{
- "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.
- "items": [ # List of rules on the access control list.
+ "etag": "A String", # ETag of the collection.
+ "items": [ # List of rules on the access control list.
{
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
+ "etag": "A String", # ETag of the resource.
+ "id": "A String", # Identifier of the ACL rule.
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "scope": { # The scope of the rule.
+ "type": "A String", # The type of the scope. Possible values are:
+ # - "default" - The public scope. This is the default value.
+ # - "user" - Limits the scope to a single user.
+ # - "group" - Limits the scope to a group.
+ # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
+ "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
},
+ },
],
- "kind": "calendar#acl", # Type of the collection ("calendar#acl").
- "etag": "A String", # ETag of the collection.
- "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.
+ "kind": "calendar#acl", # Type of the collection ("calendar#acl").
+ "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.
+ "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.
}</pre>
</div>
@@ -251,7 +251,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -261,30 +261,30 @@
<pre>Updates an access control rule. This method supports patch semantics.
Args:
- 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)
+ 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)
ruleId: string, ACL rule identifier. (required)
body: object, The request body.
The object takes the form of:
{
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- }
+ "etag": "A String", # ETag of the resource.
+ "id": "A String", # Identifier of the ACL rule.
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "scope": { # The scope of the rule.
+ "type": "A String", # The type of the scope. Possible values are:
+ # - "default" - The public scope. This is the default value.
+ # - "user" - Limits the scope to a single user.
+ # - "group" - Limits the scope to a group.
+ # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
+ "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
+ },
+}
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.
@@ -292,24 +292,24 @@
An object of the form:
{
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- }</pre>
+ "etag": "A String", # ETag of the resource.
+ "id": "A String", # Identifier of the ACL rule.
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "scope": { # The scope of the rule.
+ "type": "A String", # The type of the scope. Possible values are:
+ # - "default" - The public scope. This is the default value.
+ # - "user" - Limits the scope to a single user.
+ # - "group" - Limits the scope to a group.
+ # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
+ "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
+ },
+ }</pre>
</div>
<div class="method">
@@ -317,30 +317,30 @@
<pre>Updates an access control rule.
Args:
- 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)
+ 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)
ruleId: string, ACL rule identifier. (required)
body: object, The request body.
The object takes the form of:
{
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- }
+ "etag": "A String", # ETag of the resource.
+ "id": "A String", # Identifier of the ACL rule.
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "scope": { # The scope of the rule.
+ "type": "A String", # The type of the scope. Possible values are:
+ # - "default" - The public scope. This is the default value.
+ # - "user" - Limits the scope to a single user.
+ # - "group" - Limits the scope to a group.
+ # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
+ "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
+ },
+}
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.
@@ -348,74 +348,74 @@
An object of the form:
{
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- }</pre>
+ "etag": "A String", # ETag of the resource.
+ "id": "A String", # Identifier of the ACL rule.
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "scope": { # The scope of the rule.
+ "type": "A String", # The type of the scope. Possible values are:
+ # - "default" - The public scope. This is the default value.
+ # - "user" - Limits the scope to a single user.
+ # - "group" - Limits the scope to a group.
+ # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
+ "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
+ },
+ }</pre>
</div>
<div class="method">
- <code class="details" id="watch">watch(calendarId, body=None, syncToken=None, pageToken=None, maxResults=None, showDeleted=None)</code>
+ <code class="details" id="watch">watch(calendarId, body=None, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</code>
<pre>Watch for changes to ACL resources.
Args:
- 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)
+ 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)
body: object, The request body.
The object takes the form of:
{
- "resourceUri": "A String", # A version-specific identifier for the watched resource.
- "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
- "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
- "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
- "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
- "params": { # Additional parameters controlling delivery channel behavior. Optional.
- "a_key": "A String", # Declares a new parameter by name.
+ "address": "A String", # The address where notifications are delivered for this channel.
+ "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
+ "id": "A String", # A UUID or similar unique string that identifies this channel.
+ "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
+ "params": { # Additional parameters controlling delivery channel behavior. Optional.
+ "a_key": "A String", # Declares a new parameter by name.
},
- "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
- "address": "A String", # The address where notifications are delivered for this channel.
- "type": "A String", # The type of delivery mechanism used for this channel.
- "id": "A String", # A UUID or similar unique string that identifies this channel.
+ "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
+ "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
+ "resourceUri": "A String", # A version-specific identifier for the watched resource.
+ "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
+ "type": "A String", # The type of delivery mechanism used for this channel.
}
+ 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.
+ pageToken: string, Token specifying which result page to return. Optional.
+ showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.
If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
- pageToken: string, Token specifying which result page to return. Optional.
- 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.
- showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
Returns:
An object of the form:
{
- "resourceUri": "A String", # A version-specific identifier for the watched resource.
- "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
- "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
- "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
- "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
- "params": { # Additional parameters controlling delivery channel behavior. Optional.
- "a_key": "A String", # Declares a new parameter by name.
+ "address": "A String", # The address where notifications are delivered for this channel.
+ "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
+ "id": "A String", # A UUID or similar unique string that identifies this channel.
+ "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
+ "params": { # Additional parameters controlling delivery channel behavior. Optional.
+ "a_key": "A String", # Declares a new parameter by name.
},
- "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
- "address": "A String", # The address where notifications are delivered for this channel.
- "type": "A String", # The type of delivery mechanism used for this channel.
- "id": "A String", # A UUID or similar unique string that identifies this channel.
+ "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
+ "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
+ "resourceUri": "A String", # A version-specific identifier for the watched resource.
+ "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
+ "type": "A String", # The type of delivery mechanism used for this channel.
}</pre>
</div>