(PureBasic) Google Cloud Storage List Bucket Objects

See more Google Cloud Storage Examples

List the objects in a Google Cloud Storage bucket.

For more information, see https://cloud.google.com/storage/docs/json_api/v1/objects/list

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    ; 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 
    ; scope "https://www.googleapis.com/auth/cloud-platform"

    ; In this example, Get Google Cloud Storage OAuth2 Access Token, 
    ; the service account access token was saved to a text file.  This example fetches the access token from the file..
    sbToken.i = CkStringBuilder::ckCreate()
    If sbToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckLoadFile(sbToken,"qa_data/tokens/googleCloudStorageAccessToken.txt","utf-8")

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

    CkHttp::setCkAuthToken(http, CkStringBuilder::ckGetAsString(sbToken))

    ; For more info see Cloud Storage Documentation - Objects: list 
    ; 
    success.i = CkHttp::ckSetUrlVar(http,"bucket","chilkat-ocean")
    success = CkHttp::ckSetUrlVar(http,"PROJECT_NAME","ChilkatCloud")

    resp.i = CkHttp::ckQuickGetObj(http,"https://www.googleapis.com/storage/v1/b/{$bucket}/o?project={$ChilkatCloud}")
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkStringBuilder::ckDispose(sbToken)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    responseCode.i = CkHttpResponse::ckStatusCode(resp)
    If responseCode = 401
        Debug CkHttpResponse::ckBodyStr(resp)
        Debug "If invalid credentials, then it is likely the access token expired."
        Debug "Your app should automatically fetch a new access token and re-try."
        CkHttpResponse::ckDispose(resp)

        CkStringBuilder::ckDispose(sbToken)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    Debug "Response code: " + Str(responseCode)
    Debug "Response body"

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

    success = CkJsonObject::ckLoad(json,CkHttpResponse::ckBodyStr(resp))
    CkHttpResponse::ckDispose(resp)

    CkJsonObject::setCkEmitCompact(json, 0)

    Debug CkJsonObject::ckEmit(json)

    ; A response code = 200 indicates success, and the response body contains JSON such as this:

    ; {
    ;   "kind": "storage#objects",
    ;   "items": [
    ;     {
    ;       "kind": "storage#object",
    ;       "id": "chilkat-ocean/file with space char.jpg/1555776690752366",
    ;       "selfLink": "https://www.googleapis.com/storage/v1/b/chilkat-ocean/o/file%20with%20space%20char.jpg",
    ;       "mediaLink": "https://www.googleapis.com/download/storage/v1/b/chilkat-ocean/o/file%20with%20space%20char.jpg?generation=1555776690752366&alt=media",
    ;       "name": "file with space char.jpg",
    ;       "bucket": "chilkat-ocean",
    ;       "generation": "1555776690752366",
    ;       "metageneration": "1",
    ;       "contentType": "image/jpeg",
    ;       "storageClass": "MULTI_REGIONAL",
    ;       "size": "6229",
    ;       "md5Hash": "LpxZ2/JmI2fcl9/dqF2gSA==",
    ;       "crc32c": "9RjgwQ==",
    ;       "etag": "CO6WguiH3+ECEAE=",
    ;       "timeCreated": "2019-04-20T16:11:30.752Z",
    ;       "updated": "2019-04-20T16:11:30.752Z",
    ;       "timeStorageClassUpdated": "2019-04-20T16:11:30.752Z"
    ;     },
    ;     {
    ;       "kind": "storage#object",
    ; 
    ;       "id": "chilkat-ocean/penguins.jpg/1555775749593296",
    ;       "selfLink": "https://www.googleapis.com/storage/v1/b/chilkat-ocean/o/penguins.jpg",
    ;       "mediaLink": "https://www.googleapis.com/download/storage/v1/b/chilkat-ocean/o/penguins.jpg?generation=1555775749593296&alt=media",
    ;       "name": "penguins.jpg",
    ;       "bucket": "chilkat-ocean",
    ;       "generation": "1555775749593296",
    ;       "metageneration": "1",
    ;       "contentType": "image/jpeg",
    ;       "storageClass": "MULTI_REGIONAL",
    ;       "size": "777835",
    ;       "md5Hash": "nTd7EM53jEk4s8fixjoimg==",
    ;       "crc32c": "ixxYVw==",
    ;       "etag": "CNCxnqeE3+ECEAE=",
    ;       "timeCreated": "2019-04-20T15:55:49.593Z",
    ;       "updated": "2019-04-20T15:55:49.593Z",
    ;       "timeStorageClassUpdated": "2019-04-20T15:55:49.593Z"
    ;     },
    ;     {
    ;       "kind": "storage#object",
    ;       "id": "chilkat-ocean/starfish.jpg/1628958192639968",
    ;       "selfLink": "https://www.googleapis.com/storage/v1/b/chilkat-ocean/o/starfish.jpg",
    ;       "mediaLink": "https://www.googleapis.com/download/storage/v1/b/chilkat-ocean/o/starfish.jpg?generation=1628958192639968&alt=media",
    ;       "name": "starfish.jpg",
    ;       "bucket": "chilkat-ocean",
    ;       "generation": "1628958192639968",
    ;       "metageneration": "1",
    ;       "contentType": "image/jpeg",
    ;       "storageClass": "MULTI_REGIONAL",
    ;       "size": "6229",
    ;       "md5Hash": "LpxZ2/JmI2fcl9/dqF2gSA==",
    ;       "crc32c": "9RjgwQ==",
    ;       "etag": "COC/tJP2sPICEAE=",
    ;       "timeCreated": "2021-08-14T16:23:12.660Z",
    ;       "updated": "2021-08-14T16:23:12.660Z",
    ;       "timeStorageClassUpdated": "2021-08-14T16:23:12.660Z"
    ;     }
    ;   ]
    ; }

    ; Use this online tool to generate parsing code from sample JSON: 
    ; Generate Parsing Code from JSON

    id.s
    selfLink.s
    mediaLink.s
    name.s
    bucket.s
    generation.s
    metageneration.s
    contentType.s
    storageClass.s
    size.s
    md5Hash.s
    crc32c.s
    etag.s
    timeCreated.s
    updated.s
    timeStorageClassUpdated.s

    kind.s = CkJsonObject::ckStringOf(json,"kind")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(json,"items")
    While i < count_i
        CkJsonObject::setCkI(json, i)
        kind = CkJsonObject::ckStringOf(json,"items[i].kind")
        id = CkJsonObject::ckStringOf(json,"items[i].id")
        selfLink = CkJsonObject::ckStringOf(json,"items[i].selfLink")
        mediaLink = CkJsonObject::ckStringOf(json,"items[i].mediaLink")
        name = CkJsonObject::ckStringOf(json,"items[i].name")
        bucket = CkJsonObject::ckStringOf(json,"items[i].bucket")
        generation = CkJsonObject::ckStringOf(json,"items[i].generation")
        metageneration = CkJsonObject::ckStringOf(json,"items[i].metageneration")
        contentType = CkJsonObject::ckStringOf(json,"items[i].contentType")
        storageClass = CkJsonObject::ckStringOf(json,"items[i].storageClass")
        size = CkJsonObject::ckStringOf(json,"items[i].size")
        md5Hash = CkJsonObject::ckStringOf(json,"items[i].md5Hash")
        crc32c = CkJsonObject::ckStringOf(json,"items[i].crc32c")
        etag = CkJsonObject::ckStringOf(json,"items[i].etag")
        timeCreated = CkJsonObject::ckStringOf(json,"items[i].timeCreated")
        updated = CkJsonObject::ckStringOf(json,"items[i].updated")
        timeStorageClassUpdated = CkJsonObject::ckStringOf(json,"items[i].timeStorageClassUpdated")
        i = i + 1
    Wend


    CkStringBuilder::ckDispose(sbToken)
    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure