Introduction à l'API Admin Cloud Storage

Cloud Storage pour Firebase stocke vos données dans un bucket Google Cloud Storage , une solution de stockage d'objets à l'échelle de l'exaoctet avec une haute disponibilité et une redondance globale. Le SDK Firebase Admin vous permet d'accéder directement à vos buckets Cloud Storage à partir d'environnements privilégiés. Vous pouvez ensuite utiliser les API Google Cloud Storage pour manipuler les objets stockés dans les buckets.

Le SDK Admin vous permet également de créer des URL partageables afin que les utilisateurs puissent télécharger des objets dans vos compartiments.

Utiliser un compartiment par défaut

Vous pouvez spécifier un nom de compartiment par défaut lors de l'initialisation du SDK Admin. Vous pouvez ensuite récupérer une référence authentifiée à ce compartiment. Le nom du compartiment ne doit pas contenir gs:// ou tout autre préfixe de protocole. Par exemple, si l'URL du bucket affichée dans la console Firebase est gs://bucket-name.appspot.com , transmettez la chaîne bucket-name.appspot.com au SDK d'administration.

const { initializeApp, cert } = require('firebase-admin/app');
const { getStorage } = require('firebase-admin/storage');

const serviceAccount = require('./path/to/serviceAccountKey.json');

initializeApp({
  credential: cert(serviceAccount),
  storageBucket: '<BUCKET_NAME>.appspot.com'
});

const bucket = getStorage().bucket();

// 'bucket' is an object defined in the @google-cloud/storage library.
// See https://googlecloudplatform.github.io/google-cloud-node/#/docs/storage/latest/storage/bucket
// for more details.

FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccountKey.json");

FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.fromStream(serviceAccount))
    .setStorageBucket("<BUCKET_NAME>.appspot.com")
    .build();
FirebaseApp.initializeApp(options);

Bucket bucket = StorageClient.getInstance().bucket();

// 'bucket' is an object defined in the google-cloud-storage Java library.
// See http://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/com/google/cloud/storage/Bucket.html
// for more details.

import firebase_admin
from firebase_admin import credentials
from firebase_admin import storage

cred = credentials.Certificate('path/to/serviceAccountKey.json')
firebase_admin.initialize_app(cred, {
    'storageBucket': '<BUCKET_NAME>.appspot.com'
})

bucket = storage.bucket()

# 'bucket' is an object defined in the google-cloud-storage Python library.
# See https://googlecloudplatform.github.io/google-cloud-python/latest/storage/buckets.html
# for more details.

import (
	"context"
	"log"

	firebase "firebase.google.com/go/v4"
	"firebase.google.com/go/v4/auth"
	"google.golang.org/api/option"
)

config := &firebase.Config{
	StorageBucket: "<BUCKET_NAME>.appspot.com",
}
opt := option.WithCredentialsFile("path/to/serviceAccountKey.json")
app, err := firebase.NewApp(context.Background(), config, opt)
if err != nil {
	log.Fatalln(err)
}

client, err := app.Storage(context.Background())
if err != nil {
	log.Fatalln(err)
}

bucket, err := client.DefaultBucket()
if err != nil {
	log.Fatalln(err)
}
// 'bucket' is an object defined in the cloud.google.com/go/storage package.
// See https://godoc.org/cloud.google.com/go/storage#BucketHandle
// for more details.
storage.go

Vous pouvez utiliser les références de compartiment renvoyées par le SDK Admin en conjonction avec les bibliothèques clientes officielles de Google Cloud Storage pour charger, télécharger et modifier le contenu dans les compartiments associés à vos projets Firebase. Notez que vous n'avez pas besoin d'authentifier les bibliothèques Google Cloud Storage lorsque vous utilisez le SDK Firebase Admin. Les références de compartiment renvoyées par le SDK Admin sont déjà authentifiées avec les informations d'identification utilisées pour initialiser votre application Firebase.

Utiliser des compartiments personnalisés

Si vous souhaitez utiliser un bucket Cloud Storage autre que celui par défaut fourni ci-dessus, ou utiliser plusieurs buckets Cloud Storage dans une seule application, vous pouvez récupérer une référence à un bucket personnalisé comme indiqué ci-dessous :

const bucket = getStorage().bucket('my-custom-bucket');

Bucket bucket = StorageClient.getInstance().bucket("my-custom-bucket");

bucket = storage.bucket('my-custom-bucket')

 bucket, err := client.Bucket("my-custom-bucket")
storage.go

Utiliser une application Firebase personnalisée

Si vous créez une application plus complexe qui interagit avec plusieurs applications Firebase , vous pouvez accéder aux buckets Cloud Storage associés à une application Firebase spécifique comme suit :

const bucket = getStorage(customApp).bucket();

Bucket bucket = StorageClient.getInstance(customApp).bucket();

bucket = storage.bucket(app=custom_app)

otherClient, err := otherApp.Storage(context.Background())
bucket, err := otherClient.Bucket("other-app-bucket")

Obtenez une URL de téléchargement partageable

Vous pouvez utiliser le SDK Admin pour générer une URL de téléchargement non expirante pour les fichiers stockés dans vos compartiments. Toute personne disposant de cette URL peut accéder en permanence au fichier.

const { getStorage, getDownloadURL } = require('firebase-admin/storage');

const fileRef = getStorage().bucket('my-bucket').file('my-file');
const downloadURL= await getDownloadURL(fileRef);

Bibliothèques clientes Google Cloud Storage

Les SDK Firebase Admin dépendent des bibliothèques clientes Google Cloud Storage pour fournir un accès à Cloud Storage. Les références de compartiment renvoyées par le SDK Admin sont des objets définis dans ces bibliothèques. Reportez-vous à la documentation et aux références API des bibliothèques clientes Google Cloud Storage pour savoir comment utiliser les références de compartiment renvoyées dans des cas d'utilisation tels que le téléchargement et le téléchargement de fichiers.