Admin Cloud Storage API 簡介

Cloud Storage for Firebase 會將資料儲存在 Google Cloud Storage 值區中，這是具有高可用性和全球冗餘的 Exabyte 級物件儲存解決方案。Firebase Admin SDK 可讓您從具備權限的環境直接存取 Cloud Storage 值區。接著，您可以使用 Google Cloud Storage API 來控管儲存在值區中的物件。

您也可以透過 Admin SDK 建立可分享的網址，讓使用者下載 bucket 中的物件。

使用預設 bucket

初始化 Admin SDK 時，您可以指定預設 bucket 名稱。然後，您就可以擷取這個值區的已驗證參照。

bucket 名稱不得包含 gs:// 或任何其他通訊協定前置字串。 舉例來說，如果 Firebase 控制台中顯示的值區網址為 gs://PROJECT_ID.firebasestorage.app，請將字串 PROJECT_ID.firebasestorage.app 傳遞至 Admin SDK。

Node.js

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.

Java

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 https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Bucket
// for more details.

Python

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': 'PROJECT_ID.firebasestorage.app'
})

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.

Go

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

您可以搭配官方的 Google Cloud Storage 用戶端程式庫，使用 Admin SDK 傳回的 bucket 參照，上傳、下載及修改與 Firebase 專案相關聯 bucket 中的內容。請注意，使用 Firebase Admin SDK 時，不必驗證 Google Cloud Storage 程式庫。Admin SDK 傳回的 bucket 參照已透過用於初始化 Firebase 應用程式的憑證完成驗證。

使用自訂值區

如要使用預設值區以外的 Cloud Storage 值區 (本指南稍早說明)，或在單一應用程式中使用多個 Cloud Storage 值區，可以擷取自訂值區的參照：

Node.js

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

Java

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

Python

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

Go

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

使用自訂 Firebase 應用程式

如果您要建構與多個 Firebase 應用程式互動的複雜應用程式，可以按照下列步驟存取與特定 Firebase 應用程式相關聯的 Cloud Storage bucket：

Node.js

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

Java

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

Python

bucket = storage.bucket(app=custom_app)

Go

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

取得可分享的下載網址

您可以使用 Admin SDK，為儲存在值區中的檔案產生不會過期的下載網址。知道這個網址的人都能永久存取檔案。

Node.js

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

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

Google Cloud Storage 用戶端程式庫

Firebase Admin SDK 依附於Google Cloud Storage用戶端程式庫，以提供 Cloud Storage 存取權。Admin SDK 傳回的 bucket 參照是這些程式庫中定義的物件。請參閱 Google Cloud Storage 用戶端程式庫的說明文件和 API 參考資料，瞭解如何在檔案上傳和下載等用途中，使用傳回的 bucket 參照。