PureBasic

List all Folders

See more Google Drive Examples

Demonstrates how to retrieve a list of all folders.

Note: Let's say we have a directory tree with the following folders in Google Drive:

/AAWorkArea
/AAWorkArea/FolderA
/AAWorkArea/FolderB
/Folder2
/Folder2/FolderA

This would be our result. Notice that the "name" of each folder is NOT the full path, but just the final folder name. To distinguish between the two FolderA's, we would need to get the parent information for each.

---- Page 1 ----
name: FolderB
id: 1ep8p9wsCV8S_xTI7G1-qEuf8RNO_9250
mimeType: application/vnd.google-apps.folder
-
name: FolderA
id: 1h_BWJGEn7L7aFV5SN8iOKv91uxddTbY8
mimeType: application/vnd.google-apps.folder
-
name: Folder2
id: 1cvDIF78KSDuUyrU_VCKRSRbmENWkHNqV
mimeType: application/vnd.google-apps.folder
-
name: AAWorkArea
id: 0BzXkF-yZEO0-ank3VndfZTZsdlk
mimeType: application/vnd.google-apps.folder
-
name: FolderA
id: 1Fksv-TfA1ILii1YjXsNa1-rDu8Cdrg72
mimeType: application/vnd.google-apps.folder
-

PureBasic

IncludeFile "CkAuthGoogle.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

    success = 1

    ; This example 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.

    gAuth.i = CkAuthGoogle::ckCreate()
    If gAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthGoogle::setCkAccessToken(gAuth, "GOOGLE-DRIVE-ACCESS-TOKEN")

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect using TLS.
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"www.googleapis.com",443,1,bAutoReconnect)

    ; Provide the authentication credentials (i.e. the access token)
    CkRest::ckSetAuthGoogle(rest,gAuth)

    ; Get 50 results per page for testing.  (The default page size is 100, with a max of 1000.
    CkRest::ckAddQueryParam(rest,"pageSize","50")

    ; Get all entries that are folders.
    CkRest::ckAddQueryParam(rest,"q","mimeType = 'application/vnd.google-apps.folder'")

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(json, 0)

    i.i
    numFiles.i

    ; Send the request for the 1st page.
    jsonResponse.s = CkRest::ckFullRequestNoBody(rest,"GET","/drive/v3/files")

    pageNumber.i = 1
    pageToken.s
    bContinueLoop.i = CkRest::ckLastMethodSuccess(rest) AND (CkRest::ckResponseStatusCode(rest) = 200)

    While bContinueLoop = 1

        Debug "---- Page " + Str(pageNumber) + " ----"

        ; Iterate over each file in the response and show the name, id, and mimeType.
        CkJsonObject::ckLoad(json,jsonResponse)

        numFiles = CkJsonObject::ckSizeOfArray(json,"files")
        i = 0
        While i < numFiles
            CkJsonObject::setCkI(json, i)
            Debug "name: " + CkJsonObject::ckStringOf(json,"files[i].name")
            Debug "id: " + CkJsonObject::ckStringOf(json,"files[i].id")
            Debug "mimeType: " + CkJsonObject::ckStringOf(json,"files[i].mimeType")
            Debug "-"
            i = i + 1
        Wend

        ; Get the next page of files.
        ; If the "nextPageToken" is present in the JSON response, then use it in the "pageToken" parameter
        ; for the next request.   If no "nextPageToken" was present, then this was the last page of files.
        pageToken = CkJsonObject::ckStringOf(json,"nextPageToken")
        bContinueLoop = 0
        bHasMorePages.i = CkJsonObject::ckLastMethodSuccess(json)
        If bHasMorePages = 1
            CkRest::ckClearAllQueryParams(rest)
            CkRest::ckAddQueryParam(rest,"pageSize","50")
            CkRest::ckAddQueryParam(rest,"pageToken",pageToken)
            CkRest::ckAddQueryParam(rest,"q","mimeType = 'application/vnd.google-apps.folder'")

            jsonResponse = CkRest::ckFullRequestNoBody(rest,"GET","/drive/v3/files")
            bContinueLoop = CkRest::ckLastMethodSuccess(rest) AND (CkRest::ckResponseStatusCode(rest) = 200)
            pageNumber = pageNumber + 1
        EndIf

    Wend

    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkAuthGoogle::ckDispose(gAuth)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    ; A successful response will have a status code equal to 200.
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response JSON: " + jsonResponse
        CkAuthGoogle::ckDispose(gAuth)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf



    CkAuthGoogle::ckDispose(gAuth)
    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure