Console
    Contact Us Start free

    List objects

    This page shows you how to list the objects stored in your Cloud Storage buckets, which are ordered in the list lexicographically by name.

    Before you begin

    To get the permissions that you need to list objects, ask your administrator to grant you the Storage Object Viewer ( roles/storage.objectViewer ) IAM role for the bucket that contains the objects you want to list. If you want to list objects within managed folders , you can grant roles/storage.objectViewer on the managed folder that contains the objects you want to view instead of the bucket.

    If you plan on using the Google Cloud console to perform the tasks on this page, ask your administrator to grant you the Viewer ( roles/viewer ) basic role in addition to the Storage Object Viewer ( roles/storage.objectViewer ) role.

    These roles contain the permissions required to list objects. To see the exact permissions that are required, expand the Required permissionssection:

    Required permissions

    • storage.objects.list
    • storage.buckets.list
      • This permission is only needed if you want to use the Google Cloud console to perform the tasks on this page.

    You can also get these permissions with other predefined roles or custom roles .

    For information about granting roles for buckets, see Use IAM with buckets .

    List the objects in a bucket

    Console

    1. In the Google Cloud console, go to the Cloud Storage Buckets page.

      Go to Buckets

    2. In the bucket list, click the name of the bucket whose contents you want to view.

    Command line

    Use the gcloud storage ls command:

    gcloud storage ls gs:// BUCKET_NAME

    Where:

    • BUCKET_NAME is the name of the bucket that contains the objects you want to list. For example, my-bucket .

    Client libraries

    C++

    For more information, see the Cloud Storage C++ API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample lists all objects in a bucket:

      namespace 
  
 gcs 
  
 = 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 storage 
 ; 
 []( 
 gcs 
 :: 
 Client 
  
 client 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 bucket_name 
 ) 
  
 { 
  
 for 
  
 ( 
 auto 
&&  
 object_metadata 
  
 : 
  
 client 
 . 
 ListObjects 
 ( 
 bucket_name 
 )) 
  
 { 
  
 if 
  
 ( 
 ! 
 object_metadata 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 object_metadata 
 ). 
 status 
 (); 
  
 std 
 :: 
 cout 
 << 
 "bucket_name=" 
 << 
 object_metadata 
 - 
> bucket 
 () 
 << 
 ", object_name=" 
 << 
 object_metadata 
 - 
> name 
 () 
 << 
 " 
 \n 
 " 
 ; 
  
 } 
 }

    The following sample lists objects with a given prefix:

      namespace 
  
 gcs 
  
 = 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 storage 
 ; 
 []( 
 gcs 
 :: 
 Client 
  
 client 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 bucket_name 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 bucket_prefix 
 ) 
  
 { 
  
 for 
  
 ( 
 auto 
&&  
 object_metadata 
  
 : 
  
 client 
 . 
 ListObjects 
 ( 
 bucket_name 
 , 
  
 gcs 
 :: 
 Prefix 
 ( 
 bucket_prefix 
 ))) 
  
 { 
  
 if 
  
 ( 
 ! 
 object_metadata 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 object_metadata 
 ). 
 status 
 (); 
  
 std 
 :: 
 cout 
 << 
 "bucket_name=" 
 << 
 object_metadata 
 - 
> bucket 
 () 
 << 
 ", object_name=" 
 << 
 object_metadata 
 - 
> name 
 () 
 << 
 " 
 \n 
 " 
 ; 
  
 } 
 }

    C#

    For more information, see the Cloud Storage C# API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample lists all objects in a bucket:

      using 
  
  Google.Cloud.Storage.V1 
 
 ; 
 using 
  
 System 
 ; 
 using 
  
 System.Collections.Generic 
 ; 
 public 
  
 class 
  
 ListFilesSample 
 { 
  
 public 
  
 IEnumerable<Google 
 . 
 Apis 
 . 
 Storage 
 . 
 v1 
 . 
 Data 
 . 
 Object 
>  
 ListFiles 
 ( 
  
 string 
  
 bucketName 
  
 = 
  
 "your-unique-bucket-name" 
 ) 
  
 { 
  
 var 
  
 storage 
  
 = 
  
  StorageClient 
 
 . 
  Create 
 
 (); 
  
 var 
  
 storageObjects 
  
 = 
  
 storage 
 . 
 ListObjects 
 ( 
 bucketName 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Files in bucket {bucketName}:" 
 ); 
  
 foreach 
  
 ( 
 var 
  
 storageObject 
  
 in 
  
 storageObjects 
 ) 
  
 { 
  
 Console 
 . 
 WriteLine 
 ( 
 storageObject 
 . 
 Name 
 ); 
  
 } 
  
 return 
  
 storageObjects 
 ; 
  
 } 
 }

    The following sample lists objects with a given prefix:

      using 
  
  Google.Cloud.Storage.V1 
 
 ; 
 using 
  
 System 
 ; 
 using 
  
 System.Collections.Generic 
 ; 
 public 
  
 class 
  
 ListFilesWithPrefixSample 
 { 
  
 /// <summary> 
  
 /// Prefixes and delimiters can be used to emulate directory listings. 
  
 /// Prefixes can be used to filter objects starting with prefix. 
  
 /// The delimiter argument can be used to restrict the results to only the 
  
 /// objects in the given "directory". Without the delimiter, the entire  tree 
  
 /// under the prefix is returned. 
  
 /// For example, given these objects: 
  
 ///   a/1.txt 
  
 ///   a/b/2.txt 
  
 /// 
  
 /// If you just specify prefix="a/", you'll get back: 
  
 ///   a/1.txt 
  
 ///   a/b/2.txt 
  
 /// 
  
 /// However, if you specify prefix="a/" and delimiter="/", you'll get back: 
  
 ///   a/1.txt 
  
 /// </summary> 
  
 /// <param name="bucketName">The bucket to list the objects from.</param> 
  
 /// <param name="prefix">The prefix to match. Only objects with names that start with this string will 
  
 /// be returned. This parameter may be null or empty, in which case no filtering 
  
 /// is performed.</param> 
  
 /// <param name="delimiter">Used to list in "directory mode". Only objects whose names (aside from the prefix) 
  
 /// do not contain the delimiter will be returned.</param> 
  
 public 
  
 IEnumerable<Google 
 . 
 Apis 
 . 
 Storage 
 . 
 v1 
 . 
 Data 
 . 
 Object 
>  
 ListFilesWithPrefix 
 ( 
  
 string 
  
 bucketName 
  
 = 
  
 "your-unique-bucket-name" 
 , 
  
 string 
  
 prefix 
  
 = 
  
 "your-prefix" 
 , 
  
 string 
  
 delimiter 
  
 = 
  
 "your-delimiter" 
 ) 
  
 { 
  
 var 
  
 storage 
  
 = 
  
  StorageClient 
 
 . 
  Create 
 
 (); 
  
 var 
  
 options 
  
 = 
  
 new 
  
  ListObjectsOptions 
 
  
 { 
  
 Delimiter 
  
 = 
  
 delimiter 
  
 }; 
  
 var 
  
 storageObjects 
  
 = 
  
 storage 
 . 
 ListObjects 
 ( 
 bucketName 
 , 
  
 prefix 
 , 
  
 options 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Objects in bucket {bucketName} with prefix {prefix}:" 
 ); 
  
 foreach 
  
 ( 
 var 
  
 storageObject 
  
 in 
  
 storageObjects 
 ) 
  
 { 
  
 Console 
 . 
 WriteLine 
 ( 
 storageObject 
 . 
 Name 
 ); 
  
 } 
  
 return 
  
 storageObjects 
 ; 
  
 } 
 }

    Go

    For more information, see the Cloud Storage Go API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample lists all objects in a bucket:

      import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 "time" 
  
 "cloud.google.com/go/storage" 
  
 "google.golang.org/api/iterator" 
 ) 
 // listFiles lists objects within specified bucket. 
 func 
  
 listFiles 
 ( 
 w 
  
 io 
 . 
  Writer 
 
 , 
  
 bucket 
  
 string 
 ) 
  
 error 
  
 { 
  
 // bucket := "bucket-name" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 storage 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "storage.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 ctx 
 , 
  
 cancel 
  
 := 
  
 context 
 . 
 WithTimeout 
 ( 
 ctx 
 , 
  
 time 
 . 
 Second 
 * 
 10 
 ) 
  
 defer 
  
 cancel 
 () 
  
 it 
  
 := 
  
 client 
 . 
  Bucket 
 
 ( 
 bucket 
 ). 
  Objects 
 
 ( 
 ctx 
 , 
  
 nil 
 ) 
  
 for 
  
 { 
  
 attrs 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Bucket(%q).Objects: %w" 
 , 
  
 bucket 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintln 
 ( 
 w 
 , 
  
 attrs 
 . 
 Name 
 ) 
  
 } 
  
 return 
  
 nil 
 }

    The following sample lists objects with a given prefix:

      import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 "time" 
  
 "cloud.google.com/go/storage" 
  
 "google.golang.org/api/iterator" 
 ) 
 // listFilesWithPrefix lists objects using prefix and delimeter. 
 func 
  
 listFilesWithPrefix 
 ( 
 w 
  
 io 
 . 
  Writer 
 
 , 
  
 bucket 
 , 
  
 prefix 
 , 
  
 delim 
  
 string 
 ) 
  
 error 
  
 { 
  
 // bucket := "bucket-name" 
  
 // prefix := "/foo" 
  
 // delim := "_" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 storage 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "storage.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 // Prefixes and delimiters can be used to emulate directory listings. 
  
 // Prefixes can be used to filter objects starting with prefix. 
  
 // The delimiter argument can be used to restrict the results to only the 
  
 // objects in the given "directory". Without the delimiter, the entire tree 
  
 // under the prefix is returned. 
  
 // 
  
 // For example, given these blobs: 
  
 //   /a/1.txt 
  
 //   /a/b/2.txt 
  
 // 
  
 // If you just specify prefix="a/", you'll get back: 
  
 //   /a/1.txt 
  
 //   /a/b/2.txt 
  
 // 
  
 // However, if you specify prefix="a/" and delim="/", you'll get back: 
  
 //   /a/1.txt 
  
 ctx 
 , 
  
 cancel 
  
 := 
  
 context 
 . 
 WithTimeout 
 ( 
 ctx 
 , 
  
 time 
 . 
 Second 
 * 
 10 
 ) 
  
 defer 
  
 cancel 
 () 
  
 it 
  
 := 
  
 client 
 . 
  Bucket 
 
 ( 
 bucket 
 ). 
  Objects 
 
 ( 
 ctx 
 , 
  
& storage 
 . 
  Query 
 
 { 
  
 Prefix 
 : 
  
 prefix 
 , 
  
 Delimiter 
 : 
  
 delim 
 , 
  
 }) 
  
 for 
  
 { 
  
 attrs 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Bucket(%q).Objects(): %w" 
 , 
  
 bucket 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintln 
 ( 
 w 
 , 
  
 attrs 
 . 
 Name 
 ) 
  
 } 
  
 return 
  
 nil 
 }

    Java

    For more information, see the Cloud Storage Java API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample lists all objects in a bucket:

      import 
  
 com.google.api.gax.paging. Page 
 
 ; 
 import 
  
 com.google.cloud.storage. Blob 
 
 ; 
 import 
  
 com.google.cloud.storage. Storage 
 
 ; 
 import 
  
 com.google.cloud.storage. StorageOptions 
 
 ; 
 public 
  
 class 
 ListObjects 
  
 { 
  
 public 
  
 static 
  
 void 
  
 listObjects 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 bucketName 
 ) 
  
 { 
  
 // The ID of your GCP project 
  
 // String projectId = "your-project-id"; 
  
 // The ID of your GCS bucket 
  
 // String bucketName = "your-unique-bucket-name"; 
  
  Storage 
 
  
 storage 
  
 = 
  
  StorageOptions 
 
 . 
 newBuilder 
 (). 
 setProjectId 
 ( 
 projectId 
 ). 
 build 
 (). 
  getService 
 
 (); 
  
 Page<Blob> 
  
 blobs 
  
 = 
  
 storage 
 . 
  list 
 
 ( 
 bucketName 
 ); 
  
 for 
  
 ( 
  Blob 
 
  
 blob 
  
 : 
  
 blobs 
 . 
 iterateAll 
 ()) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 blob 
 . 
 getName 
 ()); 
  
 } 
  
 } 
 }

    The following sample lists objects with a given prefix:

      import 
  
 com.google.api.gax.paging. Page 
 
 ; 
 import 
  
 com.google.cloud.storage. Blob 
 
 ; 
 import 
  
 com.google.cloud.storage. Storage 
 
 ; 
 import 
  
 com.google.cloud.storage. StorageOptions 
 
 ; 
 public 
  
 class 
 ListObjectsWithPrefix 
  
 { 
  
 public 
  
 static 
  
 void 
  
 listObjectsWithPrefix 
 ( 
  
 String 
  
 projectId 
 , 
  
 String 
  
 bucketName 
 , 
  
 String 
  
 directoryPrefix 
 ) 
  
 { 
  
 // The ID of your GCP project 
  
 // String projectId = "your-project-id"; 
  
 // The ID of your GCS bucket 
  
 // String bucketName = "your-unique-bucket-name"; 
  
 // The directory prefix to search for 
  
 // String directoryPrefix = "myDirectory/" 
  
  Storage 
 
  
 storage 
  
 = 
  
  StorageOptions 
 
 . 
 newBuilder 
 (). 
 setProjectId 
 ( 
 projectId 
 ). 
 build 
 (). 
  getService 
 
 (); 
  
 /** 
 * Using the Storage.BlobListOption.currentDirectory() option here causes the results to display 
 * in a "directory-like" mode, showing what objects are in the directory you've specified, as 
 * well as what other directories exist in that directory. For example, given these blobs: 
 * 
 * <p>a/1.txt a/b/2.txt a/b/3.txt 
 * 
 * <p>If you specify prefix = "a/" and don't use Storage.BlobListOption.currentDirectory(), 
 * you'll get back: 
 * 
 * <p>a/1.txt a/b/2.txt a/b/3.txt 
 * 
 * <p>However, if you specify prefix = "a/" and do use 
 * Storage.BlobListOption.currentDirectory(), you'll get back: 
 * 
 * <p>a/1.txt a/b/ 
 * 
 * <p>Because a/1.txt is the only file in the a/ directory and a/b/ is a directory inside the 
 * /a/ directory. 
 */ 
  
 Page<Blob> 
  
 blobs 
  
 = 
  
 storage 
 . 
  list 
 
 ( 
  
 bucketName 
 , 
  
 Storage 
 . 
 BlobListOption 
 . 
 prefix 
 ( 
 directoryPrefix 
 ), 
  
 Storage 
 . 
 BlobListOption 
 . 
 currentDirectory 
 ()); 
  
 for 
  
 ( 
  Blob 
 
  
 blob 
  
 : 
  
 blobs 
 . 
 iterateAll 
 ()) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 blob 
 . 
 getName 
 ()); 
  
 } 
  
 } 
 }

    Node.js

    For more information, see the Cloud Storage Node.js API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample lists all objects in a bucket:

      /** 
 * TODO(developer): Uncomment the following lines before running the sample. 
 */ 
 // The ID of your GCS bucket 
 // const bucketName = 'your-unique-bucket-name'; 
 // Imports the Google Cloud client library 
 const 
  
 { 
 Storage 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/storage 
' 
 ); 
 // Creates a client 
 const 
  
 storage 
  
 = 
  
 new 
  
 Storage 
 (); 
 async 
  
 function 
  
 listFiles 
 () 
  
 { 
  
 // Lists files in the bucket 
  
 const 
  
 [ 
 files 
 ] 
  
 = 
  
 await 
  
 storage 
 . 
 bucket 
 ( 
 bucketName 
 ). 
  getFiles 
 
 (); 
  
 console 
 . 
 log 
 ( 
 'Files:' 
 ); 
  
 files 
 . 
 forEach 
 ( 
 file 
  
 = 
>  
 { 
  
 console 
 . 
 log 
 ( 
 file 
 . 
 name 
 ); 
  
 }); 
 } 
 listFiles 
 (). 
 catch 
 ( 
 console 
 . 
 error 
 );

    The following sample lists objects with a given prefix:

      /** 
 * TODO(developer): Uncomment the following lines before running the sample. 
 */ 
 // The ID of your GCS bucket 
 // const bucketName = 'your-unique-bucket-name'; 
 // The directory prefix to search for 
 // const prefix = 'myDirectory/'; 
 // The delimiter to use 
 // const delimiter = '/'; 
 // Imports the Google Cloud client library 
 const 
  
 { 
 Storage 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/storage 
' 
 ); 
 // Creates a client 
 const 
  
 storage 
  
 = 
  
 new 
  
 Storage 
 (); 
 async 
  
 function 
  
 listFilesByPrefix 
 () 
  
 { 
  
 /** 
 * This can be used to list all blobs in a "folder", e.g. "public/". 
 * 
 * The delimiter argument can be used to restrict the results to only the 
 * "files" in the given "folder". Without the delimiter, the entire tree under 
 * the prefix is returned. For example, given these blobs: 
 * 
 *   /a/1.txt 
 *   /a/b/2.txt 
 * 
 * If you just specify prefix = 'a/', you'll get back: 
 * 
 *   /a/1.txt 
 *   /a/b/2.txt 
 * 
 * However, if you specify prefix='a/' and delimiter='/', you'll get back: 
 * 
 *   /a/1.txt 
 */ 
  
 const 
  
 options 
  
 = 
  
 { 
  
 prefix 
 : 
  
 prefix 
 , 
  
 }; 
  
 if 
  
 ( 
 delimiter 
 ) 
  
 { 
  
 options 
 . 
 delimiter 
  
 = 
  
 delimiter 
 ; 
  
 } 
  
 // Lists files in the bucket, filtered by a prefix 
  
 const 
  
 [ 
 files 
 ] 
  
 = 
  
 await 
  
 storage 
 . 
 bucket 
 ( 
 bucketName 
 ). 
  getFiles 
 
 ( 
 options 
 ); 
  
 console 
 . 
 log 
 ( 
 'Files:' 
 ); 
  
 files 
 . 
 forEach 
 ( 
 file 
  
 = 
>  
 { 
  
 console 
 . 
 log 
 ( 
 file 
 . 
 name 
 ); 
  
 }); 
 } 
 listFilesByPrefix 
 (). 
 catch 
 ( 
 console 
 . 
 error 
 );

    PHP

    For more information, see the Cloud Storage PHP API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample lists all objects in a bucket:

      use Google\Cloud\Storage\StorageClient; 
 /** 
 * List Cloud Storage bucket objects. 
 * 
 * @param string $bucketName The name of your Cloud Storage bucket. 
 *        (e.g. 'my-bucket') 
 */ 
 function list_objects(string $bucketName): void 
 { 
 $storage = new StorageClient(); 
 $bucket = $storage->bucket($bucketName); 
 foreach ($bucket->objects() as $object) { 
 printf('Object: %s' . PHP_EOL, $object->name()); 
 } 
 }

    The following sample lists objects with a given prefix:

      use Google\Cloud\Storage\StorageClient; 
 /** 
 * List Cloud Storage bucket objects with specified prefix. 
 * 
 * @param string $bucketName The name of your Cloud Storage bucket. 
 *        (e.g. 'my-bucket') 
 * @param string $directoryPrefix the prefix to use in the list objects API call. 
 *        (e.g. 'myDirectory/') 
 */ 
 function list_objects_with_prefix(string $bucketName, string $directoryPrefix): void 
 { 
 $storage = new StorageClient(); 
 $bucket = $storage->bucket($bucketName); 
 $options = ['prefix' => $directoryPrefix]; 
 foreach ($bucket->objects($options) as $object) { 
 printf('Object: %s' . PHP_EOL, $object->name()); 
 } 
 }

    Python

    For more information, see the Cloud Storage Python API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample lists all objects in a bucket:

      from 
  
 google.cloud 
  
 import 
  storage 
 
 def 
  
 list_blobs 
 ( 
 bucket_name 
 ): 
  
 """Lists all the blobs in the bucket.""" 
 # bucket_name = "your-bucket-name" 
 storage_client 
 = 
  storage 
 
 . 
  Client 
 
 () 
 # Note: Client.list_blobs requires at least package version 1.17.0. 
 blobs 
 = 
 storage_client 
 . 
  list_blobs 
 
 ( 
 bucket_name 
 ) 
 # Note: The call returns a response only when the iterator is consumed. 
 for 
 blob 
 in 
 blobs 
 : 
 print 
 ( 
 blob 
 . 
 name 
 )

    The following sample lists objects with a given prefix:

      from 
  
 google.cloud 
  
 import 
  storage 
 
 def 
  
 list_blobs_with_prefix 
 ( 
 bucket_name 
 , 
 prefix 
 , 
 delimiter 
 = 
 None 
 ): 
  
 """Lists all the blobs in the bucket that begin with the prefix. 
 This can be used to list all blobs in a "folder", e.g. "public/". 
 The delimiter argument can be used to restrict the results to only the 
 "files" in the given "folder". Without the delimiter, the entire tree under 
 the prefix is returned. For example, given these blobs: 
 a/1.txt 
 a/b/2.txt 
 If you specify prefix ='a/', without a delimiter, you'll get back: 
 a/1.txt 
 a/b/2.txt 
 However, if you specify prefix='a/' and delimiter='/', you'll get back 
 only the file directly under 'a/': 
 a/1.txt 
 As part of the response, you'll also get back a blobs.prefixes entity 
 that lists the "subfolders" under `a/`: 
 a/b/ 
 Note: If you only want to list prefixes a/b/ and don't want to iterate over 
 blobs, you can do 
 ``` 
 for page in blobs.pages: 
 print(page.prefixes) 
 ``` 
 """ 
 storage_client 
 = 
  storage 
 
 . 
  Client 
 
 () 
 # Note: Client.list_blobs requires at least package version 1.17.0. 
 blobs 
 = 
 storage_client 
 . 
  list_blobs 
 
 ( 
 bucket_name 
 , 
 prefix 
 = 
 prefix 
 , 
 delimiter 
 = 
 delimiter 
 ) 
 # Note: The call returns a response only when the iterator is consumed. 
 print 
 ( 
 "Blobs:" 
 ) 
 for 
 blob 
 in 
 blobs 
 : 
 print 
 ( 
 blob 
 . 
 name 
 ) 
 if 
 delimiter 
 : 
 print 
 ( 
 "Prefixes:" 
 ) 
 for 
 prefix 
 in 
 blobs 
 . 
 prefixes 
 : 
 print 
 ( 
 prefix 
 )

    Ruby

    For more information, see the Cloud Storage Ruby API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample lists all objects in a bucket:

      def 
  
 list_files 
  
 bucket_name 
 : 
  
 # The ID of your GCS bucket 
  
 # bucket_name = "your-unique-bucket-name" 
  
 require 
  
 "google/cloud/storage" 
  
 storage 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  Storage 
 
 . 
  new 
 
  
 bucket 
  
 = 
  
 storage 
 . 
 bucket 
  
 bucket_name 
  
 bucket 
 . 
  files 
 
 . 
  each 
 
  
 do 
  
 | 
 file 
 | 
  
 puts 
  
 file 
 . 
 name 
  
 end 
 end

    The following sample lists objects with a given prefix:

      def 
  
 list_files_with_prefix 
  
 bucket_name 
 :, 
  
 prefix 
 :, 
  
 delimiter 
 : 
  
 nil 
  
 # Lists all the files in the bucket that begin with the prefix. 
  
 # 
  
 # This can be used to list all files in a "folder", e.g. "public/". 
  
 # 
  
 # The delimiter argument can be used to restrict the results to only the 
  
 # "files" in the given "folder". Without the delimiter, the entire tree under 
  
 # the prefix is returned. For example, given these files: 
  
 # 
  
 #     a/1.txt 
  
 #     a/b/2.txt 
  
 # 
  
 # If you just specify `prefix: "a"`, you will get back: 
  
 # 
  
 #     a/1.txt 
  
 #     a/b/2.txt 
  
 # 
  
 # However, if you specify `prefix: "a"` and `delimiter: "/"`, you will get back: 
  
 # 
  
 #     a/1.txt 
  
 # The ID of your GCS bucket 
  
 # bucket_name = "your-unique-bucket-name" 
  
 # The directory prefix to search for 
  
 # prefix = "a" 
  
 # The delimiter to be used to restrict the results 
  
 # delimiter = "/" 
  
 require 
  
 "google/cloud/storage" 
  
 storage 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  Storage 
 
 . 
  new 
 
  
 bucket 
  
 = 
  
 storage 
 . 
 bucket 
  
 bucket_name 
  
 files 
  
 = 
  
 bucket 
 . 
  files 
 
  
 prefix 
 : 
  
 prefix 
 , 
  
 delimiter 
 : 
  
 delimiter 
  
 files 
 . 
  each 
 
  
 do 
  
 | 
 file 
 | 
  
 puts 
  
 file 
 . 
 name 
  
 end 
 end

    REST APIs

    JSON API

    1. Have gcloud CLI installed and initialized , which lets you generate an access token for the Authorization header.

    2. Use cURL to call the JSON API with a request to list objects :

      curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://storage.googleapis.com/storage/v1/b/ BUCKET_NAME 
/o"

      Where BUCKET_NAME is the name of the bucket whose objects you want to list. For example, my-bucket .

    XML API

    1. Have gcloud CLI installed and initialized , which lets you generate an access token for the Authorization header.

    2. Use cURL to call the XML API with a GET Bucket request:

      curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://storage.googleapis.com/ BUCKET_NAME 
?list-type=2"

      Where BUCKET_NAME is the name of the bucket whose objects you want to list. For example, my-bucket .

      You can use a prefix= PREFIX query string parameter to limit results to objects that have the specified prefix.

    List the objects in a folder

    Console

    1. In the Google Cloud console, go to the Cloud Storage Buckets page.

      Go to Buckets

    2. In the bucket list, click the name of the bucket that contains the folder.

    3. In the Objectstab of the Bucket detailspage, click the name of the folder whose contents you want to view.

    Command line

    Use the gcloud storage ls command to list the objects in a folder:

    gcloud storage ls gs:// BUCKET_NAME 
/ FOLDER_NAME

    Where:

    • BUCKET_NAME is the name of the bucket that contains the folder. For example, my-bucket .

    • FOLDER_NAME is the name of the folder that contains the objects you want to list. For example, my-folder .

    REST APIs

    JSON API

    To list the objects in a folder, use a list objects request with the prefix and delimiter parameters. When the prefix parameter is set, the list operation is scoped to only return objects and folders under the prefix. When the delimiter parameter is set, the prefixes[] list in the response populates with the names of folders under the specified prefix.

    For example:

    • To list all objects in the folder image/ within the bucket my-bucket , use the following URL: "https://storage.googleapis.com/storage/v1/b/my-bucket/o?prefix=image&delimiter=/" .

      This could return the objects my-bucket/image/cat.jpeg and my-bucket/image/dog.jpeg .

    • To include objects in subfolders within image/ , remove the delimiter parameter: "https://storage.googleapis.com/storage/v1/b/my-bucket/o?prefix=image" .

      This could return the objects my-bucket/image/cat.jpeg , my-bucket/image/dog.jpeg , and my-bucket/image/dog/shiba.jpeg .

    To use wildcards in your list objects request and match objects by glob expression , use the matchGlob parameter. For example, matchGlob=**.jpeg matches all objects that end in .jpeg . When you use matchGlob , you must set delimiter to / .

    For example, use the following URL to match all objects within the folder image that end in .jpeg : "https://storage.googleapis.com/storage/v1/b/my-bucket/o?prefix=image&delimiter=/&matchGlob=**.jpeg"

    For more details about using parameters to filter for objects, see the Objects list JSON API reference documentation .

    Use case

    Using prefix to list the contents of a folder can be useful for when you only have the permission to list objects in the folder, but not the whole bucket. For example, say you have the Storage Object Viewer ( roles/storage.objectViewer ) IAM role for the managed folder my-bucket/my-managed-folder-a/ , but not for the managed folder my-bucket/my-managed-folder-b/ . To return only the objects in my-managed-folder-a , you can specify prefix=my-managed-folder-a/ .

    Filtering objects

    When listing objects, you can use prefixes or suffixes in your list request to filter objects by name.

    Console

    See filtering and sorting for information on how to filter and sort objects in buckets or folders.

    Command line

    You can use wildcards in your gcloud storage ls command to filter objects by prefix or suffix. For example, the following command only lists objects in the bucket my-bucket whose name begins with image and ends with .png :

    gcloud storage ls gs://my-bucket/image*.png

    If the request is successful, the response looks similar to the following:

    gs://my-bucket/image.png
gs://my-bucket/image-dog.png
gs://my-bucket/image-cat.png
...

    You can use double-star wildcards to match zero or more folder levels in a path. For example, the following command only lists objects whose name ends in .jpeg in any folder or subfolder within the bucket my-bucket :

    gcloud storage ls gs://my-bucket/**/*.jpeg

    If the request is successful, the response looks similar to the following:

    gs://my-bucket/puppy.jpeg
gs://my-bucket/pug.jpeg
gs://my-bucket/pets/dog.jpeg
...

    REST APIs

    See list objects in folders for information on how to filter objects by folder or object name prefix.

    Performance considerations when listing objects

    The underlying structure of buckets with hierarchical namespace enabled influences the performance of the listing objects operation, when compared to flat namespace buckets. For more information, see Optimize performance in buckets with hierarchical namespace enabled .

    What's next

    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: