Lists the changes for a user or shared drive. Try it now.
For more information, see the Changes and revisions overview.
Request
HTTP request
GET https://www.googleapis.com/drive/v3/changes
Parameters
Parameter name | Value | Description |
---|---|---|
Required query parameters | ||
pageToken |
string |
The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. |
Optional query parameters | ||
driveId |
string |
The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. |
fields |
string |
The paths of the fields you want included in the response. If not specified, the response includes a default set of fields specific to this method. For development you can use the special value * to return all fields, but you'll achieve greater performance by only selecting the fields you need. For more information, see Return specific fields for a file.
|
includeCorpusRemovals |
boolean |
Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
(Default: false )
|
includeItemsFromAllDrives |
boolean |
Whether both My Drive and shared drive items should be included in results.
(Default: false )
|
includeLabels |
string |
A comma-separated list of IDs of labels to include in the labelInfo part of the response.
|
includePermissionsForView |
string |
Specifies which additional view's permissions to include in the response. Only 'published' is supported. |
includeRemoved |
boolean |
Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
(Default: true )
|
includeTeamDriveItems |
boolean |
Deprecated use includeItemsFromAllDrives instead.
(Default: false )
|
pageSize |
integer |
The maximum number of changes to return per page.
Acceptable values are 1 to 1000 , inclusive.
(Default: 100 )
|
restrictToMyDrive |
boolean |
Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
(Default: false )
|
spaces |
string |
A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'. |
supportsAllDrives |
boolean |
Whether the requesting application supports both My Drives and shared drives.
(Default: false )
|
supportsTeamDrives |
boolean |
Deprecated use supportsAllDrives instead.
(Default: false )
|
teamDriveId |
string |
Deprecated use driveId instead. |
Authorization
This request requires authorization with at least one of the following scopes:
Scope |
---|
https://www.googleapis.com/auth/drive |
https://www.googleapis.com/auth/drive.file |
https://www.googleapis.com/auth/drive.readonly |
https://www.googleapis.com/auth/drive.metadata.readonly |
https://www.googleapis.com/auth/drive.appdata |
https://www.googleapis.com/auth/drive.metadata |
https://www.googleapis.com/auth/drive.photos.readonly |
Some scopes are restricted and require a security assessment for your app to use them. For more information, see the authentication and authorization page.
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "drive#changeList", "nextPageToken": string, "newStartPageToken": string, "changes": [ changes Resource ] }
Property name | Value | Description | Notes |
---|---|---|---|
kind |
string |
Identifies what kind of resource this is. Value: the fixed string "drive#changeList" . |
|
nextPageToken |
string |
The page token for the next page of changes. This will be absent if the end of the changes list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. | |
newStartPageToken |
string |
The starting page token for future changes. This will be present only if the end of the current changes list has been reached. | |
changes[] |
list |
The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. |
Try it!
Use the APIs Explorer below to call this method on live data and see the response.