(Tcl) Get File Metadata

Gets a file's metadata or content by ID.

See Google Drive Files get for additional details.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

set success 1

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

set gAuth [new_CkAuthGoogle]

CkAuthGoogle_put_AccessToken $gAuth "GOOGLE-DRIVE-ACCESS-TOKEN"

set rest [new_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.
set bAutoReconnect 1
set success [CkRest_Connect $rest "www.googleapis.com" 443 1 $bAutoReconnect]

# Provide the authentication credentials (i.e. the access token)
CkRest_SetAuthGoogle $rest $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.
set sbPath [new_CkStringBuilder]

CkStringBuilder_Append $sbPath "/drive/v3/files/"
# Assume we previously obtained the fileId for the file of interest...
CkStringBuilder_Append $sbPath "0B53Q6OSTWYolbUF6WS1Gei1oalk"

# Indicate that we want ALL possible fields.
# If no fields are indicated, then only the basic fields are returned.
set 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"

CkRest_AddQueryParam $rest "fields" $allFields

set jsonResponse [CkRest_fullRequestNoBody $rest "GET" [CkStringBuilder_getAsString $sbPath]]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkAuthGoogle $gAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    exit
}

# A successful response will have a status code equal to 200.
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts "response status code = [CkRest_get_ResponseStatusCode $rest]"
    puts "response status text = [CkRest_responseStatusText $rest]"
    puts "response header: [CkRest_responseHeader $rest]"
    puts "response JSON: $jsonResponse"
    delete_CkAuthGoogle $gAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    exit
}

# ---------------------------------------------------
# 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.
set json [new_CkJsonObject]

CkJsonObject_Load $json $jsonResponse

# Show the full JSON response.
CkJsonObject_put_EmitCompact $json 0
puts [CkJsonObject_emit $json]
puts "-"

# Demonstrate how to get pieces of information:
puts "Original Filename: [CkJsonObject_stringOf $json originalFilename]"

set wasLastModifiedUserMe [CkJsonObject_BoolOf $json "lastModifyingUser.me"]
puts "Was Last Modified by Me: $wasLastModifiedUserMe"

# Assuming this is an image file...
set width [CkJsonObject_IntOf $json "imageMediaMetadata.width"]
puts "Image Width: $width"

# Iterate over parents...

set numParents [CkJsonObject_SizeOfArray $json "parents"]
set i 0
while {$i < $numParents} {
    CkJsonObject_put_I $json $i
    puts "Parent $i: [CkJsonObject_stringOf $json {parents[i]}]"
    set i [expr $i + 1]
}

# Iterate over owners...
set numOwners [CkJsonObject_SizeOfArray $json "owners"]
set i 0
while {$i < $numOwners} {
    CkJsonObject_put_I $json $i
    puts "Owner $i: kind=[CkJsonObject_stringOf $json {owners[i].kind}] displayName=[CkJsonObject_stringOf $json {owners[i].displayName}]"
    set i [expr $i + 1]
}

# Iterate over permissions...
set numPermissions [CkJsonObject_SizeOfArray $json "permissions"]
set i 0
while {$i < $numPermissions} {
    CkJsonObject_put_I $json $i
    puts "Permission $i: kind=[CkJsonObject_stringOf $json {permissions[i].kind}] id=[CkJsonObject_stringOf $json {permissions[i].id}]"
    set i [expr $i + 1]
}

delete_CkAuthGoogle $gAuth
delete_CkRest $rest
delete_CkStringBuilder $sbPath
delete_CkJsonObject $json