Lua

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.

Lua

local chilkat = require("chilkat")

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

local gAuth = chilkat.AuthGoogle.new()
gAuth.access_token = "GOOGLE-DRIVE-ACCESS-TOKEN"

local rest = chilkat.Rest.new()

-- 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.
local bAutoReconnect = true
success = rest:connect("www.googleapis.com", 443, true, bAutoReconnect)

-- Provide the authentication credentials (i.e. the access token)
rest:set_auth_google(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.
local sbPath = chilkat.StringBuilder.new()
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.
local 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:add_query_param("fields", allFields)

local jsonResponse = rest:full_request_no_body("GET", sbPath:get_as_string())
if not rest.last_method_success then
    print(rest.last_error_text)
    return
end

-- A successful response will have a status code equal to 200.
if rest.response_status_code ~= 200 then
    print("response status code = " .. rest.response_status_code)
    print("response status text = " .. rest.response_status_text)
    print("response header: " .. rest.response_header)
    print("response JSON: " .. jsonResponse)
    return
end

-- ---------------------------------------------------
-- 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.
local json = chilkat.JsonObject.new()
json:load(jsonResponse)

-- Show the full JSON response.
json.emit_compact = false
print(json:emit())
print("-")

-- Demonstrate how to get pieces of information:
print("Original Filename: " .. json:string_of("originalFilename"))

local wasLastModifiedUserMe = json:bool_of("lastModifyingUser.me")
print("Was Last Modified by Me: " .. tostring(wasLastModifiedUserMe))

-- Assuming this is an image file...
local width = json:int_of("imageMediaMetadata.width")
print("Image Width: " .. width)

-- Iterate over parents...
local numParents = json:size_of_array("parents")
local i = 0
while i < numParents do
    json.i = i
    print("Parent " .. i .. ": " .. json:string_of("parents[i]"))
    i = i + 1
end

-- Iterate over owners...
local numOwners = json:size_of_array("owners")
i = 0
while i < numOwners do
    json.i = i
    print("Owner " .. i .. ": kind=" .. json:string_of("owners[i].kind") .. " displayName=" .. json:string_of("owners[i].displayName"))
    i = i + 1
end

-- Iterate over permissions...
local numPermissions = json:size_of_array("permissions")
i = 0
while i < numPermissions do
    json.i = i
    print("Permission " .. i .. ": kind=" .. json:string_of("permissions[i].kind") .. " id=" .. json:string_of("permissions[i].id"))
    i = i + 1
end