TypeScript typings for Drive API v3
Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.
For detailed description please check documentation.
Installing
Install typings for Drive API:
npm install @types/gapi.client.drive-v3 --save-dev
Usage
You need to initialize Google API client in your code:
gapi.load('client', () => {
});
Then load api client wrapper:
gapi.client.load('https://www.googleapis.com/discovery/v1/apis/drive/v3/rest', () => {
});
gapi.client.load('drive', 'v3', () => {
});
Don't forget to authenticate your client before sending any request to resources:
var client_id = '',
scope = [
'https://www.googleapis.com/auth/drive',
'https://www.googleapis.com/auth/drive.appdata',
'https://www.googleapis.com/auth/drive.file',
'https://www.googleapis.com/auth/drive.metadata',
'https://www.googleapis.com/auth/drive.metadata.readonly',
'https://www.googleapis.com/auth/drive.photos.readonly',
'https://www.googleapis.com/auth/drive.readonly',
'https://www.googleapis.com/auth/drive.scripts',
],
immediate = true;
gapi.auth.authorize(
{ client_id: client_id, scope: scope, immediate: immediate },
authResult => {
if (authResult && !authResult.error) {
} else {
}
});
After that you can use Drive API resources:
await gapi.client.drive.about.get({ });
await gapi.client.drive.changes.getStartPageToken({ });
await gapi.client.drive.changes.list({ pageToken: "pageToken", });
await gapi.client.drive.changes.watch({ pageToken: "pageToken", });
await gapi.client.drive.channels.stop({ });
await gapi.client.drive.comments.create({ fileId: "fileId", });
await gapi.client.drive.comments.delete({ commentId: "commentId", fileId: "fileId", });
await gapi.client.drive.comments.get({ commentId: "commentId", fileId: "fileId", });
await gapi.client.drive.comments.list({ fileId: "fileId", });
await gapi.client.drive.comments.update({ commentId: "commentId", fileId: "fileId", });
await gapi.client.drive.drives.create({ requestId: "requestId", });
await gapi.client.drive.drives.delete({ driveId: "driveId", });
await gapi.client.drive.drives.get({ driveId: "driveId", });
await gapi.client.drive.drives.hide({ driveId: "driveId", });
await gapi.client.drive.drives.list({ });
await gapi.client.drive.drives.unhide({ driveId: "driveId", });
await gapi.client.drive.drives.update({ driveId: "driveId", });
await gapi.client.drive.files.copy({ fileId: "fileId", });
await gapi.client.drive.files.create({ });
await gapi.client.drive.files.delete({ fileId: "fileId", });
await gapi.client.drive.files.emptyTrash({ });
await gapi.client.drive.files.export({ fileId: "fileId", mimeType: "mimeType", });
await gapi.client.drive.files.generateIds({ });
await gapi.client.drive.files.get({ fileId: "fileId", });
await gapi.client.drive.files.list({ });
await gapi.client.drive.files.listLabels({ fileId: "fileId", });
await gapi.client.drive.files.modifyLabels({ fileId: "fileId", });
await gapi.client.drive.files.update({ fileId: "fileId", });
await gapi.client.drive.files.watch({ fileId: "fileId", });
await gapi.client.drive.permissions.create({ fileId: "fileId", });
await gapi.client.drive.permissions.delete({ fileId: "fileId", permissionId: "permissionId", });
await gapi.client.drive.permissions.get({ fileId: "fileId", permissionId: "permissionId", });
await gapi.client.drive.permissions.list({ fileId: "fileId", });
await gapi.client.drive.permissions.update({ fileId: "fileId", permissionId: "permissionId", });
await gapi.client.drive.replies.create({ commentId: "commentId", fileId: "fileId", });
await gapi.client.drive.replies.delete({ commentId: "commentId", fileId: "fileId", replyId: "replyId", });
await gapi.client.drive.replies.get({ commentId: "commentId", fileId: "fileId", replyId: "replyId", });
await gapi.client.drive.replies.list({ commentId: "commentId", fileId: "fileId", });
await gapi.client.drive.replies.update({ commentId: "commentId", fileId: "fileId", replyId: "replyId", });
await gapi.client.drive.revisions.delete({ fileId: "fileId", revisionId: "revisionId", });
await gapi.client.drive.revisions.get({ fileId: "fileId", revisionId: "revisionId", });
await gapi.client.drive.revisions.list({ fileId: "fileId", });
await gapi.client.drive.revisions.update({ fileId: "fileId", revisionId: "revisionId", });
await gapi.client.drive.teamdrives.create({ requestId: "requestId", });
await gapi.client.drive.teamdrives.delete({ teamDriveId: "teamDriveId", });
await gapi.client.drive.teamdrives.get({ teamDriveId: "teamDriveId", });
await gapi.client.drive.teamdrives.list({ });
await gapi.client.drive.teamdrives.update({ teamDriveId: "teamDriveId", });