(Node.js) 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

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function 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..
    var sbToken = new chilkat.StringBuilder();
    sbToken.LoadFile("qa_data/tokens/googleCloudStorageAccessToken.txt","utf-8");

    var http = new chilkat.Http();
    http.AuthToken = sbToken.GetAsString();

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

    // resp: HttpResponse
    var resp = http.QuickGetObj("https://www.googleapis.com/storage/v1/b/{$bucket}/o?project={$ChilkatCloud}");
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var responseCode = resp.StatusCode;
    if (responseCode == 401) {
        console.log(resp.BodyStr);
        console.log("If invalid credentials, then it is likely the access token expired.");
        console.log("Your app should automatically fetch a new access token and re-try.");

        return;
    }

    console.log("Response code: " + responseCode);
    console.log("Response body");

    var json = new chilkat.JsonObject();
    success = json.Load(resp.BodyStr);

    json.EmitCompact = false;

    console.log(json.Emit());

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

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

    var kind = json.StringOf("kind");
    var i = 0;
    var count_i = json.SizeOfArray("items");
    while (i < count_i) {
        json.I = i;
        kind = json.StringOf("items[i].kind");
        id = json.StringOf("items[i].id");
        selfLink = json.StringOf("items[i].selfLink");
        mediaLink = json.StringOf("items[i].mediaLink");
        name = json.StringOf("items[i].name");
        bucket = json.StringOf("items[i].bucket");
        generation = json.StringOf("items[i].generation");
        metageneration = json.StringOf("items[i].metageneration");
        contentType = json.StringOf("items[i].contentType");
        storageClass = json.StringOf("items[i].storageClass");
        size = json.StringOf("items[i].size");
        md5Hash = json.StringOf("items[i].md5Hash");
        crc32c = json.StringOf("items[i].crc32c");
        etag = json.StringOf("items[i].etag");
        timeCreated = json.StringOf("items[i].timeCreated");
        updated = json.StringOf("items[i].updated");
        timeStorageClassUpdated = json.StringOf("items[i].timeStorageClassUpdated");
        i = i+1;
    }


}

chilkatExample();