Dart

Get File Metadata

See more Google Drive Examples

Gets a file's metadata or content by ID.

See Google Drive Files get for additional details.

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // It requires the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  // This example uses a previously obtained access token having permission for the 
  // Google Drive scope.

  final gAuth = CkAuthGoogle();
  gAuth.accessToken = 'GOOGLE-DRIVE-ACCESS-TOKEN';

  final rest = CkRest();

  // Connect using TLS.
  // A single REST object, once connected, can be used for many Google Drive REST API calls.
  // The auto-reconnect indicates that if the already-established HTTPS connection is closed,
  // then it will be automatically re-established as needed.
  final bAutoReconnect = true;
  rest.connect('www.googleapis.com', 443, true, bAutoReconnect);

  // Provide the authentication credentials (i.e. the access token)
  rest.setAuthGoogle(gAuth);

  // ------------------------------------------------------------------------------

  // We need to send a GET request like this:
  // GET https://www.googleapis.com/drive/v3/files/fileId
  // The fileId is part of the path.
  final sbPath = CkStringBuilder();
  sbPath.append('/drive/v3/files/');
  // Assume we previously obtained the fileId for the file of interest...
  sbPath.append('0B53Q6OSTWYolbUF6WS1Gei1oalk');

  // Indicate that we want ALL possible fields.
  // If no fields are indicated, then only the basic fields are returned.
  final allFields = 'appProperties,capabilities,contentHints,createdTime,description,explicitlyTrashed,fileExtension,folderColorRgb,fullFileExtension,headRevisionId,iconLink,id,imageMediaMetadata,isAppAuthorized,kind,lastModifyingUser,md5Checksum,mimeType,modifiedByMeTime,modifiedTime,name,originalFilename,ownedByMe,owners,parents,permissions,properties,quotaBytesUsed,shared,sharedWithMeTime,sharingUser,size,spaces,starred,thumbnailLink,trashed,version,videoMediaMetadata,viewedByMe,viewedByMeTime,viewersCanCopyContent,webContentLink,webViewLink,writersCanShare';

  rest.addQueryParam('fields', allFields);

  final String jsonResponse;
  try {
    jsonResponse = rest.fullRequestNoBody('GET', sbPath.getAsString());
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // A successful response will have a status code equal to 200.
  if (rest.responseStatusCode != 200) {
    print('response status code = ${rest.responseStatusCode}');
    print('response status text = ${rest.responseStatusText}');
    print('response header: ${rest.responseHeader}');
    print('response JSON: $jsonResponse');
    return;
  }

  // ---------------------------------------------------
  // Sample code for parsing this JSON is shown below...
  // ---------------------------------------------------

  // A successful response looks like this:
  // {
  //   "kind": "drive#file",
  //   "id": "0B53Q6OSTWYolbUF6WS1Gei1oalk",
  //   "name": "penguins.jpg",
  //   "mimeType": "image/jpeg",
  //   "starred": false,
  //   "trashed": false,
  //   "explicitlyTrashed": false,
  //   "parents": [
  //     "0B53Q6OSTWYola296ODZUSm5GYU0"
  //   ],
  //   "spaces": [
  //     "drive"
  //   ],
  //   "version": "672",
  //   "webContentLink": "https://docs.google.com/a/chilkatcloud.com/uc?id=0B53Q6OSTWYolbUF6WS1Gei1oalk&export=download",
  //   "webViewLink": "https://drive.google.com/a/chilkatcloud.com/file/d/0B53Q6OSTWYolbUF6WS1Gei1oalk/view?usp=drivesdk",
  //   "iconLink": "https://ssl.gstatic.com/docs/doclist/images/icon_11_image_list.png",
  //   "thumbnailLink": "https://lh5.googleusercontent.com/uIV1dJdc8vsAQzaaIInpc9AV55AcdHhpM7fQeI2RN2qbCSnhjK9IDdNQAOTtkvjS9ZObqw=s220",
  //   "viewedByMe": true,
  //   "viewedByMeTime": "2016-10-08T12:38:02.258Z",
  //   "createdTime": "2016-10-08T12:38:02.258Z",
  //   "modifiedTime": "2016-10-08T12:38:02.258Z",
  //   "modifiedByMeTime": "2016-10-08T12:38:02.258Z",
  //   "owners": [
  //     {
  //       "kind": "drive#user",
  //       "displayName": "Matthew Smith",
  //       "me": true,
  //       "permissionId": "08366696655122259092",
  //       "emailAddress": "support@chilkatcloud.com"
  //     }
  //   ],
  //   "lastModifyingUser": {
  //     "kind": "drive#user",
  //     "displayName": "Matthew Smith",
  //     "me": true,
  //     "permissionId": "08366696655122259092",
  //     "emailAddress": "support@chilkatcloud.com"
  //   },
  //   "shared": false,
  //   "ownedByMe": true,
  //   "capabilities": {
  //     "canEdit": true,
  //     "canComment": true,
  //     "canShare": true,
  //     "canCopy": true,
  //     "canReadRevisions": true
  //   },
  //   "viewersCanCopyContent": true,
  //   "writersCanShare": true,
  //   "permissions": [
  //     {
  //       "kind": "drive#permission",
  //       "id": "08366696655122259092",
  //       "type": "user",
  //       "emailAddress": "support@chilkatcloud.com",
  //       "role": "owner",
  //       "displayName": "Matthew Smith"
  //     }
  //   ],
  //   "originalFilename": "penguins.jpg",
  //   "fullFileExtension": "jpg",
  //   "fileExtension": "jpg",
  //   "md5Checksum": "9d377b10ce778c4938b3c7e2c63a229a",
  //   "size": "777835",
  //   "quotaBytesUsed": "777835",
  //   "headRevisionId": "0B53Q6OSTWYolUUlHVFhHdFlXQ0R1aHZuT0tORTVzc2h5NnZjPQ",
  //   "imageMediaMetadata": {
  //     "width": 1024,
  //     "height": 768,
  //     "rotation": 0,
  //     "time": "2009:03:12 13:48:35"
  //   },
  //   "isAppAuthorized": false
  // }

  // Iterate over each file in the response and show the name, id, and mimeType.
  final json = CkJsonObject();
  json.load(jsonResponse);

  // Show the full JSON response.
  json.emitCompact = false;
  print(json.emit());
  print('-');

  // Demonstrate how to get pieces of information:
  print('Original Filename: ${json.stringOf('originalFilename')}');

  final wasLastModifiedUserMe = json.boolOf('lastModifyingUser.me');
  print('Was Last Modified by Me: $wasLastModifiedUserMe');

  // Assuming this is an image file...
  final width = json.intOf('imageMediaMetadata.width');
  print('Image Width: $width');

  // Iterate over parents...
  var i = 0;
  final numParents = json.sizeOfArray('parents');
  i = 0;
  while (i < numParents) {
    json.i = i;
    print('Parent $i: ${json.stringOf('parents[i]')}');
    i++;
  }

  // Iterate over owners...
  final numOwners = json.sizeOfArray('owners');
  i = 0;
  while (i < numOwners) {
    json.i = i;
    print('Owner $i: kind=${json.stringOf('owners[i].kind')} displayName=${json.stringOf('owners[i].displayName')}');
    i++;
  }

  // Iterate over permissions...
  final numPermissions = json.sizeOfArray('permissions');
  i = 0;
  while (i < numPermissions) {
    json.i = i;
    print('Permission $i: kind=${json.stringOf('permissions[i].kind')} id=${json.stringOf('permissions[i].id')}');
    i++;
  }
}