(Xojo Plugin) Get File Metadata

Gets a file's metadata or content by ID.

See Google Drive Files get for additional details.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

Dim success As Boolean
success = True

// 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.

Dim gAuth As New Chilkat.AuthGoogle
gAuth.AccessToken = "GOOGLE-DRIVE-ACCESS-TOKEN"

Dim rest As New Chilkat.Rest

// 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.
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("www.googleapis.com",443,True,bAutoReconnect)

// Provide the authentication credentials (i.e. the access token)
success = 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.
Dim sbPath As New Chilkat.StringBuilder
success = sbPath.Append("/drive/v3/files/")
// Assume we previously obtained the fileId for the file of interest...
success = sbPath.Append("0B53Q6OSTWYolbUF6WS1Gei1oalk")

// Indicate that we want ALL possible fields.
// If no fields are indicated, then only the basic fields are returned.
Dim allFields As String
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"

success = rest.AddQueryParam("fields",allFields)

Dim jsonResponse As String
jsonResponse = rest.FullRequestNoBody("GET",sbPath.GetAsString())
If (rest.LastMethodSuccess <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// A successful response will have a status code equal to 200.
If (rest.ResponseStatusCode <> 200) Then
    System.DebugLog("response status code = " + Str(rest.ResponseStatusCode))
    System.DebugLog("response status text = " + rest.ResponseStatusText)
    System.DebugLog("response header: " + rest.ResponseHeader)
    System.DebugLog("response JSON: " + jsonResponse)
    Return
End If

// ---------------------------------------------------
// 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.
Dim json As New Chilkat.JsonObject
success = json.Load(jsonResponse)

// Show the full JSON response.
json.EmitCompact = False
System.DebugLog(json.Emit())
System.DebugLog("-")

// Demonstrate how to get pieces of information:
System.DebugLog("Original Filename: " + json.StringOf("originalFilename"))

Dim wasLastModifiedUserMe As Boolean
wasLastModifiedUserMe = json.BoolOf("lastModifyingUser.me")
System.DebugLog("Was Last Modified by Me: " + Str(wasLastModifiedUserMe))

// Assuming this is an image file...
Dim width As Int32
width = json.IntOf("imageMediaMetadata.width")
System.DebugLog("Image Width: " + Str(width))

// Iterate over parents...
Dim i As Int32
Dim numParents As Int32
numParents = json.SizeOfArray("parents")
i = 0
While i < numParents
    json.I = i
    System.DebugLog("Parent " + Str(i) + ": " + json.StringOf("parents[i]"))
    i = i + 1
Wend

// Iterate over owners...
Dim numOwners As Int32
numOwners = json.SizeOfArray("owners")
i = 0
While i < numOwners
    json.I = i
    System.DebugLog("Owner " + Str(i) + ": kind=" + json.StringOf("owners[i].kind") + " displayName=" + json.StringOf("owners[i].displayName"))
    i = i + 1
Wend

// Iterate over permissions...
Dim numPermissions As Int32
numPermissions = json.SizeOfArray("permissions")
i = 0
While i < numPermissions
    json.I = i
    System.DebugLog("Permission " + Str(i) + ": kind=" + json.StringOf("permissions[i].kind") + " id=" + json.StringOf("permissions[i].id"))
    i = i + 1
Wend