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/appsactivity_v1.activities.html b/docs/dyn/appsactivity_v1.activities.html
index d979400..238201b 100644
--- a/docs/dyn/appsactivity_v1.activities.html
+++ b/docs/dyn/appsactivity_v1.activities.html
@@ -75,204 +75,204 @@
<h1><a href="appsactivity_v1.html">Drive Activity API</a> . <a href="appsactivity_v1.activities.html">activities</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#list">list(pageSize=None, source=None, groupingStrategy=None, userId=None, drive_ancestorId=None, pageToken=None, drive_fileId=None)</a></code></p>
+ <code><a href="#list">list(drive_ancestorId=None, drive_fileId=None, groupingStrategy=None, pageSize=None, pageToken=None, source=None, userId=None)</a></code></p>
<p class="firstline">Returns a list of activities visible to the current logged in user. Visible activities are determined by the visibility settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="list">list(pageSize=None, source=None, groupingStrategy=None, userId=None, drive_ancestorId=None, pageToken=None, drive_fileId=None)</code>
+ <code class="details" id="list">list(drive_ancestorId=None, drive_fileId=None, groupingStrategy=None, pageSize=None, pageToken=None, source=None, userId=None)</code>
<pre>Returns a list of activities visible to the current logged in user. Visible activities are determined by the visibility settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter.
Args:
- pageSize: integer, The maximum number of events to return on a page. The response includes a continuation token if there are more events.
- source: string, The Google service from which to return activities. Possible values of source are:
-- drive.google.com
+ drive_ancestorId: string, Identifies the Drive folder containing the items for which to return activities.
+ drive_fileId: string, Identifies the Drive item to return activities for.
groupingStrategy: string, Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.
Allowed values
driveUi -
none -
- userId: string, The ID used for ACL checks (does not filter the resulting event list by the assigned value). Use the special value me to indicate the currently authenticated user.
- drive_ancestorId: string, Identifies the Drive folder containing the items for which to return activities.
+ pageSize: integer, The maximum number of events to return on a page. The response includes a continuation token if there are more events.
pageToken: string, A token to retrieve a specific page of results.
- drive_fileId: string, Identifies the Drive item to return activities for.
+ source: string, The Google service from which to return activities. Possible values of source are:
+- drive.google.com
+ userId: string, The ID used for ACL checks (does not filter the resulting event list by the assigned value). Use the special value me to indicate the currently authenticated user.
Returns:
An object of the form:
{ # The response from the list request. Contains a list of activities and a token to retrieve the next page of results.
- "nextPageToken": "A String", # Token for the next page of results.
- "activities": [ # List of activities.
+ "activities": [ # List of activities.
{ # An Activity resource is a combined view of multiple events. An activity has a list of individual events and a combined view of the common fields among all events.
- "combinedEvent": { # Represents the changes associated with an action taken by a user. # The fields common to all of the singleEvents that make up the Activity.
- "rename": { # Contains information about a renametype event. # Extra information for rename type events, such as the old and new names.
- "newTitle": "A String", # The new title.
- "oldTitle": "A String", # The old title.
- },
- "target": { # Information about the object modified by the event. # Information specific to the Target object modified by the event.
- "mimeType": "A String", # The MIME type of the target.
- "id": "A String", # The ID of the target. For example, in Google Drive, this is the file or folder ID.
- "name": "A String", # The name of the target. For example, in Google Drive, this is the title of the file.
- },
- "additionalEventTypes": [ # Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.
- "A String",
+ "combinedEvent": { # Represents the changes associated with an action taken by a user. # The fields common to all of the singleEvents that make up the Activity.
+ "additionalEventTypes": [ # Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.
+ "A String",
],
- "move": { # Contains information about changes in an object's parents as a result of a move type event. # Extra information for move type events, such as changes in an object's parents.
- "removedParents": [ # The removed parent(s).
+ "eventTimeMillis": "A String", # The time at which the event occurred formatted as Unix time in milliseconds.
+ "fromUserDeletion": True or False, # Whether this event is caused by a user being deleted.
+ "move": { # Contains information about changes in an object's parents as a result of a move type event. # Extra information for move type events, such as changes in an object's parents.
+ "addedParents": [ # The added parent(s).
{ # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.
- "id": "A String", # The parent's ID.
- "isRoot": True or False, # Whether this is the root folder.
- "title": "A String", # The parent's title.
+ "id": "A String", # The parent's ID.
+ "isRoot": True or False, # Whether this is the root folder.
+ "title": "A String", # The parent's title.
},
],
- "addedParents": [ # The added parent(s).
+ "removedParents": [ # The removed parent(s).
{ # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.
- "id": "A String", # The parent's ID.
- "isRoot": True or False, # Whether this is the root folder.
- "title": "A String", # The parent's title.
+ "id": "A String", # The parent's ID.
+ "isRoot": True or False, # Whether this is the root folder.
+ "title": "A String", # The parent's title.
},
],
},
- "permissionChanges": [ # Extra information for permissionChange type events, such as the user or group the new permission applies to.
- { # Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.
- "removedPermissions": [ # Lists all Permission objects removed.
+ "permissionChanges": [ # Extra information for permissionChange type events, such as the user or group the new permission applies to.
+ { # Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.
+ "addedPermissions": [ # Lists all Permission objects added.
{ # Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.
- "withLink": True or False, # Whether the permission requires a link to the file.
- "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
- "name": "A String", # The name of the user or group the permission applies to.
- "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
- "user": { # A representation of a user. # The user's information if the type is USER.
- "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
- "url": "A String", # The URL of the photo.
+ "name": "A String", # The name of the user or group the permission applies to.
+ "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
+ "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
+ "type": "A String", # Indicates how widely permissions are granted.
+ "user": { # A representation of a user. # The user's information if the type is USER.
+ "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
+ "isMe": True or False, # Whether the user is the authenticated user.
+ "name": "A String", # The displayable name of the user.
+ "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
+ "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
+ "url": "A String", # The URL of the photo.
},
- "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
- "isMe": True or False, # Whether the user is the authenticated user.
- "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
- "name": "A String", # The displayable name of the user.
},
- "type": "A String", # Indicates how widely permissions are granted.
+ "withLink": True or False, # Whether the permission requires a link to the file.
},
],
- "addedPermissions": [ # Lists all Permission objects added.
+ "removedPermissions": [ # Lists all Permission objects removed.
{ # Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.
- "withLink": True or False, # Whether the permission requires a link to the file.
- "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
- "name": "A String", # The name of the user or group the permission applies to.
- "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
- "user": { # A representation of a user. # The user's information if the type is USER.
- "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
- "url": "A String", # The URL of the photo.
+ "name": "A String", # The name of the user or group the permission applies to.
+ "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
+ "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
+ "type": "A String", # Indicates how widely permissions are granted.
+ "user": { # A representation of a user. # The user's information if the type is USER.
+ "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
+ "isMe": True or False, # Whether the user is the authenticated user.
+ "name": "A String", # The displayable name of the user.
+ "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
+ "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
+ "url": "A String", # The URL of the photo.
},
- "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
- "isMe": True or False, # Whether the user is the authenticated user.
- "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
- "name": "A String", # The displayable name of the user.
},
- "type": "A String", # Indicates how widely permissions are granted.
+ "withLink": True or False, # Whether the permission requires a link to the file.
},
],
},
],
- "user": { # A representation of a user. # Represents the user responsible for the event.
- "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
- "url": "A String", # The URL of the photo.
- },
- "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
- "isMe": True or False, # Whether the user is the authenticated user.
- "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
- "name": "A String", # The displayable name of the user.
+ "primaryEventType": "A String", # The main type of event that occurred.
+ "rename": { # Contains information about a renametype event. # Extra information for rename type events, such as the old and new names.
+ "newTitle": "A String", # The new title.
+ "oldTitle": "A String", # The old title.
},
- "eventTimeMillis": "A String", # The time at which the event occurred formatted as Unix time in milliseconds.
- "primaryEventType": "A String", # The main type of event that occurred.
- "fromUserDeletion": True or False, # Whether this event is caused by a user being deleted.
+ "target": { # Information about the object modified by the event. # Information specific to the Target object modified by the event.
+ "id": "A String", # The ID of the target. For example, in Google Drive, this is the file or folder ID.
+ "mimeType": "A String", # The MIME type of the target.
+ "name": "A String", # The name of the target. For example, in Google Drive, this is the title of the file.
+ },
+ "user": { # A representation of a user. # Represents the user responsible for the event.
+ "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
+ "isMe": True or False, # Whether the user is the authenticated user.
+ "name": "A String", # The displayable name of the user.
+ "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
+ "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
+ "url": "A String", # The URL of the photo.
+ },
+ },
},
- "singleEvents": [ # A list of all the Events that make up the Activity.
+ "singleEvents": [ # A list of all the Events that make up the Activity.
{ # Represents the changes associated with an action taken by a user.
- "rename": { # Contains information about a renametype event. # Extra information for rename type events, such as the old and new names.
- "newTitle": "A String", # The new title.
- "oldTitle": "A String", # The old title.
- },
- "target": { # Information about the object modified by the event. # Information specific to the Target object modified by the event.
- "mimeType": "A String", # The MIME type of the target.
- "id": "A String", # The ID of the target. For example, in Google Drive, this is the file or folder ID.
- "name": "A String", # The name of the target. For example, in Google Drive, this is the title of the file.
- },
- "additionalEventTypes": [ # Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.
- "A String",
+ "additionalEventTypes": [ # Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.
+ "A String",
],
- "move": { # Contains information about changes in an object's parents as a result of a move type event. # Extra information for move type events, such as changes in an object's parents.
- "removedParents": [ # The removed parent(s).
+ "eventTimeMillis": "A String", # The time at which the event occurred formatted as Unix time in milliseconds.
+ "fromUserDeletion": True or False, # Whether this event is caused by a user being deleted.
+ "move": { # Contains information about changes in an object's parents as a result of a move type event. # Extra information for move type events, such as changes in an object's parents.
+ "addedParents": [ # The added parent(s).
{ # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.
- "id": "A String", # The parent's ID.
- "isRoot": True or False, # Whether this is the root folder.
- "title": "A String", # The parent's title.
+ "id": "A String", # The parent's ID.
+ "isRoot": True or False, # Whether this is the root folder.
+ "title": "A String", # The parent's title.
},
],
- "addedParents": [ # The added parent(s).
+ "removedParents": [ # The removed parent(s).
{ # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.
- "id": "A String", # The parent's ID.
- "isRoot": True or False, # Whether this is the root folder.
- "title": "A String", # The parent's title.
+ "id": "A String", # The parent's ID.
+ "isRoot": True or False, # Whether this is the root folder.
+ "title": "A String", # The parent's title.
},
],
},
- "permissionChanges": [ # Extra information for permissionChange type events, such as the user or group the new permission applies to.
- { # Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.
- "removedPermissions": [ # Lists all Permission objects removed.
+ "permissionChanges": [ # Extra information for permissionChange type events, such as the user or group the new permission applies to.
+ { # Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.
+ "addedPermissions": [ # Lists all Permission objects added.
{ # Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.
- "withLink": True or False, # Whether the permission requires a link to the file.
- "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
- "name": "A String", # The name of the user or group the permission applies to.
- "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
- "user": { # A representation of a user. # The user's information if the type is USER.
- "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
- "url": "A String", # The URL of the photo.
+ "name": "A String", # The name of the user or group the permission applies to.
+ "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
+ "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
+ "type": "A String", # Indicates how widely permissions are granted.
+ "user": { # A representation of a user. # The user's information if the type is USER.
+ "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
+ "isMe": True or False, # Whether the user is the authenticated user.
+ "name": "A String", # The displayable name of the user.
+ "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
+ "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
+ "url": "A String", # The URL of the photo.
},
- "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
- "isMe": True or False, # Whether the user is the authenticated user.
- "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
- "name": "A String", # The displayable name of the user.
},
- "type": "A String", # Indicates how widely permissions are granted.
+ "withLink": True or False, # Whether the permission requires a link to the file.
},
],
- "addedPermissions": [ # Lists all Permission objects added.
+ "removedPermissions": [ # Lists all Permission objects removed.
{ # Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.
- "withLink": True or False, # Whether the permission requires a link to the file.
- "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
- "name": "A String", # The name of the user or group the permission applies to.
- "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
- "user": { # A representation of a user. # The user's information if the type is USER.
- "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
- "url": "A String", # The URL of the photo.
+ "name": "A String", # The name of the user or group the permission applies to.
+ "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
+ "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
+ "type": "A String", # Indicates how widely permissions are granted.
+ "user": { # A representation of a user. # The user's information if the type is USER.
+ "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
+ "isMe": True or False, # Whether the user is the authenticated user.
+ "name": "A String", # The displayable name of the user.
+ "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
+ "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
+ "url": "A String", # The URL of the photo.
},
- "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
- "isMe": True or False, # Whether the user is the authenticated user.
- "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
- "name": "A String", # The displayable name of the user.
},
- "type": "A String", # Indicates how widely permissions are granted.
+ "withLink": True or False, # Whether the permission requires a link to the file.
},
],
},
],
- "user": { # A representation of a user. # Represents the user responsible for the event.
- "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
- "url": "A String", # The URL of the photo.
- },
- "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
- "isMe": True or False, # Whether the user is the authenticated user.
- "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
- "name": "A String", # The displayable name of the user.
+ "primaryEventType": "A String", # The main type of event that occurred.
+ "rename": { # Contains information about a renametype event. # Extra information for rename type events, such as the old and new names.
+ "newTitle": "A String", # The new title.
+ "oldTitle": "A String", # The old title.
},
- "eventTimeMillis": "A String", # The time at which the event occurred formatted as Unix time in milliseconds.
- "primaryEventType": "A String", # The main type of event that occurred.
- "fromUserDeletion": True or False, # Whether this event is caused by a user being deleted.
+ "target": { # Information about the object modified by the event. # Information specific to the Target object modified by the event.
+ "id": "A String", # The ID of the target. For example, in Google Drive, this is the file or folder ID.
+ "mimeType": "A String", # The MIME type of the target.
+ "name": "A String", # The name of the target. For example, in Google Drive, this is the title of the file.
+ },
+ "user": { # A representation of a user. # Represents the user responsible for the event.
+ "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
+ "isMe": True or False, # Whether the user is the authenticated user.
+ "name": "A String", # The displayable name of the user.
+ "permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.
+ "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
+ "url": "A String", # The URL of the photo.
+ },
+ },
},
],
},
],
+ "nextPageToken": "A String", # Token for the next page of results.
}</pre>
</div>
@@ -285,7 +285,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>