Cloud Storage for Unity でストレージ参照を作成する

ファイルは Google Cloud Storage バケットに保存されます。このバケット内のファイルは、ローカル ハードディスク上のファイル システムや Firebase Realtime Database 内のデータと同様の階層構造で表されます。アプリからファイルにアクセスするには、そのファイルへの参照を作成します。作成した参照を使うと、データのアップロードやダウンロード、メタデータの取得や更新、ファイルの削除などを行うことができます。参照は特定のファイルまたは階層内の上位ノードをポイントします。

Firebase Realtime Database を使用したことがある場合は、これらのパスになじみがあると思いますが、ファイルデータの格納場所は Realtime Database ではなく Google Cloud Storage になります。

参照を作成する

ファイルをアップロード、ダウンロード、または削除したり、ファイルのメタデータを取得または更新したりするには、参照を作成します。参照はクラウド内のファイルへのポインタと考えることができます。参照は軽量なので、必要なだけいくつでも作成でき、複数の操作で再利用することもできます。

Firebase アプリの Firebase.Storage.FirebaseStorage サービスから参照を作成するには、GetReferenceFromUrl() メソッドを呼び出して、gs://<your-cloud-storage-bucket> という URL 形式で渡します。この URL は Firebase コンソールの [Storage] セクションで確認できます。

// Get a reference to the storage service, using the default Firebase App
Firebase.Storage.FirebaseStorage storage = Firebase.Storage.FirebaseStorage.DefaultInstance;

// Create a storage reference from our storage service
Firebase.Storage.StorageReference storage_ref =
  storage.GetReferenceFromUrl("gs://<your-cloud-storage-bucket>");

ツリーの下位（child など）への参照を作成するには、既存の参照で 'images/space.jpg' メソッドを使用します。

// Create a child reference
// images_ref now points to "images"
Firebase.Storage.StorageReference images_ref = storage_ref.Child("images");

// Child references can also take paths delimited by '/' such as:
// "images/space.jpg".
Firebase.Storage.StorageReference space_ref = images_ref.Child("space.jpg");
// space_ref now points to "images/space.jpg"
// images_ref still points to "images"

// This is equivalent to creating the full reference
Firebase.Storage.StorageReference space_ref = storage.GetReferenceFromUrl(
    "gs://<your-cloud-storage-bucket>/images/space.jpg");

参照を使って移動する

Parent メソッドや Root メソッドを使用して、ファイル階層を上に移動することもできます。Parent は 1 つ上のレベルに移動し、Root は最上位に移動します。

// Parent allows us to move to the parent of a reference
// images_ref now points to 'images'
Firebase.Storage.StorageReference images_ref = space_ref.Parent;

// Root allows us to move all the way back to the top of our bucket
// root_ref now points to the root
Firebase.Storage.StorageReference root_ref = space_ref.Root;

Child、Parent、Root を複数つなげて参照を返すことができます。例外は Root の Parent で、これは無効な StorageReference になります。

// References can be chained together multiple times
// earth_ref points to "images/earth.jpg"
Firebase.Storage.StorageReference earth_ref =
  space_ref.Parent.Child("earth.jpg");

// null_ref is null since the parent of root is an invalid StorageReference
Firebase.Storage.StorageReference null_ref = space_ref.Root.Parent;

参照メソッド

Path、Name、Bucket プロパティを使用して参照を調べ、その参照がポイントしているファイルについて詳しく知ることができます。これらのプロパティは、ファイルの完全なパス、名前、バケットを取得します。

// Reference's path is: "images/space.jpg"
// This is analogous to a file path on disk
space_ref.Path;

// Reference's name is the last segment of the full path: "space.jpg"
// This is analogous to the file name
space_ref.Name;

// Reference's bucket is the name of the storage bucket where files are stored
space_ref.Bucket;

参照の制約事項

参照のパスと名前には、有効な Unicode 文字を任意の順序で含めることができますが、次のような一定の制約があります。

1. UTF-8 でエンコードする場合は、reference.Path の全体の長さを 1～1,024 バイトにする必要があります。
2. 改行またはラインフィード文字は使用できません。
3. #、[、]、*、? の使用は避けてください。これらの文字は、Firebase Realtime Database や gsutil などの他のツールではうまく機能しません。

例

Firebase.Storage.FirebaseStorage storage = Firebase.Storage.FirebaseStorage.DefaultInstance;

// Points to the root reference
Firebase.Storage.StorageReference storage_ref =
  storage.GetReferenceFromUrl("gs://<your-bucket-name>");

// Points to "images"
Firebase.Storage.StorageReference images_ref = storage_ref.Child("images");

// Points to "images/space.jpg"
// Note that you can use variables to create child values
string filename = "space.jpg";
Firebase.Storage.StorageReference space_ref = images_ref.Child(filename);

// File path is "images/space.jpg"
string path = space_ref.Path;

// File name is "space.jpg"
string name = space_ref.Name;

// Points to "images"
Firebase.Storage.StorageReference images_ref = space_ref.Parent;

次のステップ

次に、Cloud Storage にファイルをアップロードする方法を学習しましょう。