ドキュメントサポート

お問い合わせ無料で開始

バケットラベルの使用

このページでは、Cloud Storage のバケットに設定されるラベルを追加、表示、編集、削除する方法を説明します。バケットとバケットラベルの概要については、主な用語をご覧ください。

バケットラベルを追加する

Console

Google Cloud Console で Cloud Storage ブラウザを開きます。
Cloud Storage ブラウザを開く
バケットリストで、ラベルを適用するバケットを探して、その [バケットオーバーフロー] メニュー（）をクリックします。
[ラベルを編集] をクリックします。
表示されたサイドパネルで [+ ラベルを追加] ボタンをクリックします。
ラベルの key と valueを指定します。
[保存] をクリックします。

[ラベルを編集] サイドパネルでは、既存のラベルの値も編集できます。

Cloud Storage ブラウザで失敗したオペレーションに関する詳細なエラー情報を確認する方法については、トラブルシューティングをご覧ください。

gsutil

label ch コマンドで -l フラグを使用します。例:

gsutil label ch -l KEY_1:VALUE_1 gs://BUCKET_NAME

ここで

KEY_1 は、ラベルのキー名です。例: pet
VALUE_1 は、ラベルの値です。例: dog
BUCKET_NAME は、ラベルが適用されるバケットの名前です。例: my-bucket

1 つのコマンドで複数の key:value ペアを追加または編集するには、複数の -l フラグを使用します。

既存のすべてのラベルを新しいラベルに置き換えるには、label set コマンドを使用します。

コードサンプル

C++

詳細については、Cloud Storage C++ API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

namespace gcs = google::cloud::storage;
using ::google::cloud::StatusOr;
[](gcs::Client client, std::string const& bucket_name,
   std::string const& label_key, std::string const& label_value) {
  StatusOr<gcs::BucketMetadata> updated_metadata = client.PatchBucket(
      bucket_name,
      gcs::BucketMetadataPatchBuilder().SetLabel(label_key, label_value));

  if (!updated_metadata) {
    throw std::runtime_error(updated_metadata.status().message());
  }

  std::cout << "Successfully set label " << label_key << " to " << label_value
            << " on bucket  " << updated_metadata->name() << ".";
  std::cout << " The bucket labels are now:";
  for (auto const& kv : updated_metadata->labels()) {
    std::cout << "\n  " << kv.first << ": " << kv.second;
  }
  std::cout << "\n";
}

Go

詳細については、Cloud Storage Go API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

import (
	"context"
	"fmt"
	"io"
	"time"

	"cloud.google.com/go/storage"
)

// addBucketLabel adds a label on a bucket.
func addBucketLabel(w io.Writer, bucketName, labelName, labelValue string) error {
	// bucketName := "bucket-name"
	// labelName := "label-name"
	// labelValue := "label-value"
	ctx := context.Background()
	client, err := storage.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("storage.NewClient: %v", err)
	}
	defer client.Close()

	ctx, cancel := context.WithTimeout(ctx, time.Second*10)
	defer cancel()

	bucket := client.Bucket(bucketName)
	bucketAttrsToUpdate := storage.BucketAttrsToUpdate{}
	bucketAttrsToUpdate.SetLabel(labelName, labelValue)
	if _, err := bucket.Update(ctx, bucketAttrsToUpdate); err != nil {
		return fmt.Errorf("Bucket(%q).Update: %v", bucketName, err)
	}
	fmt.Fprintf(w, "Added label %q with value %q to bucket %v\n", labelName, labelValue, bucketName)
	return nil
}

Java

詳細については、Cloud Storage Java API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

import com.google.cloud.storage.Bucket;
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.StorageOptions;
import java.util.HashMap;
import java.util.Map;

public class AddBucketLabel {
  public static void addBucketLabel(
      String projectId, String bucketName, String labelKey, String labelValue) {
    // The ID of your GCP project
    // String projectId = "your-project-id";

    // The ID of your GCS bucket
    // String bucketName = "your-unique-bucket-name";

    // The key of the label to add
    // String labelKey = "label-key-to-add";

    // The value of the label to add
    // String labelValue = "label-value-to-add";

    Map<String, String> labelsToAdd = new HashMap<>();
    labelsToAdd.put(labelKey, labelValue);

    Storage storage = StorageOptions.newBuilder().setProjectId(projectId).build().getService();
    Bucket bucket = storage.get(bucketName);
    Map<String, String> labels = bucket.getLabels();
    if (labels == null) {
      labels = labelsToAdd;
    } else {
      labels.putAll(labelsToAdd);
    }
    bucket.toBuilder().setLabels(labels).build().update();

    System.out.println(
        "Added label " + labelKey + " with value " + labelValue + " to bucket " + bucketName + ".");
  }
}

Node.js

詳細については、Cloud Storage Node.js API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

/**
 * TODO(developer): Uncomment the following lines before running the sample.
 */
// const bucketName = 'Name of a bucket, e.g. my-bucket';
// const labelKey = 'The key of the label to add, e.g. labelone';
// const labelValue = 'The value of the label to add, e.g. labelonevalue';

// Imports the Google Cloud client library
const {Storage} = require('@google-cloud/storage');

// Creates a client
const storage = new Storage();

const labels = {
  [labelKey]: labelValue,
};
async function addBucketLabel() {
  await storage.bucket(bucketName).setLabels(labels);
  console.log(`Added label to bucket ${bucketName}.`);
}

addBucketLabel();

PHP

詳細については、Cloud Storage PHP API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

use Google\Cloud\Storage\StorageClient;

/**
 * Adds or updates a bucket label.
 *
 * @param string $bucketName the name of your Cloud Storage bucket.
 * @param string $labelName the name of the label to add.
 * @param string $labelValue the value of the label to add.
 */
function add_bucket_label($bucketName, $labelName, $labelValue)
{
    $storage = new StorageClient();
    $bucket = $storage->bucket($bucketName);
    $newLabels = [$labelName => $labelValue];
    $bucket->update(['labels' => $newLabels]);
    printf('Added label %s (%s) to %s' . PHP_EOL, $labelName, $labelValue, $bucketName);
}

Python

詳細については、Cloud Storage Python API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

import pprint

from google.cloud import storage

def add_bucket_label(bucket_name):
    """Add a label to a bucket."""
    # bucket_name = "your-bucket-name"

    storage_client = storage.Client()

    bucket = storage_client.get_bucket(bucket_name)
    labels = bucket.labels
    labels["example"] = "label"
    bucket.labels = labels
    bucket.patch()

    print("Updated labels on {}.".format(bucket.name))
    pprint.pprint(bucket.labels)

Ruby

詳細については、Cloud Storage Ruby API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

def add_bucket_label bucket_name:, label_key:, label_value:
  # The ID of your GCS bucket
  # bucket_name = "your-unique-bucket-name"

  # The key of the label to add
  # label_key = "label-key-to-add"

  # The value of the label to add
  # label_value = "label-value-to-add"

  require "google/cloud/storage"

  storage = Google::Cloud::Storage.new
  bucket  = storage.bucket bucket_name

  bucket.update do |bucket|
    bucket.labels[label_key] = label_value
  end

  puts "Added label #{label_key} with value #{label_value} to #{bucket_name}"
end

REST API

JSON API

OAuth 2.0 Playground から承認アクセストークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
次の情報が含まれる .json ファイルを作成します。
```
{
  "labels": {
    "KEY_1": "VALUE_1"
  }
}
```
ここで
- KEY_1 は、ラベルのキー名です。例: pet
- VALUE_1 は、ラベルの値です。例: dog
cURL を使用して JSON API を呼び出し、PATCH Bucket リクエストを行います。
```
curl -X PATCH --data-binary @JSON_FILE_NAME.json \
  -H "Authorization: Bearer OAUTH2_TOKEN" \
  -H "Content-Type: application/json" \
  "https://storage.googleapis.com/storage/v1/b/BUCKET_NAME?fields=labels"
```
ここで
- JSON_FILE_NAME は、手順 2 で作成した JSON ファイルの名前です。
- OAUTH2_TOKEN は、手順 1 で生成したアクセストークンです。
- BUCKET_NAME は、ラベルが適用されるバケットの名前です。例: my-bucket

1 つのリクエストで複数の key:value ペアを追加または編集できます。

XML API

OAuth 2.0 Playground から承認アクセストークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
次の情報が含まれる .xml ファイルを作成します。
```
<Tagging>
  <TagSet>
    <Tag>
      <Key>KEY_1</Key>
      <Value>VALUE_1</Value>
    </Tag>
  </TagSet>
</Tagging>
```
ここで
- KEY_1 は、ラベルのキー名です。例: pet
- VALUE_1 は、ラベルの値です。例: dog
リクエストには複数の <Tag> 要素を追加できることに注意してください。
cURL を使用して、PUT Bucket リクエストと tagging クエリ文字列パラメータを含めた XML API を呼び出します。
```
curl -X PUT --data-binary @XML_FILE_NAME.xml \
  -H "Authorization: Bearer OAUTH2_TOKEN" \
  "https://storage.googleapis.com/BUCKET_NAME?tagging"
```
ここで
- XML_FILE_NAME は、手順 2 で作成した XML ファイルです。
- OAUTH2_TOKEN は、手順 1 で生成したアクセストークンです。
- BUCKET_NAME は、ラベルが適用されるバケットの名前です。例: my-bucket

バケットラベルを表示する

Console

Google Cloud Console で Cloud Storage ブラウザを開きます。
Cloud Storage ブラウザを開く
（オプション）: Cloud Console バケットリストに表示される列を制限するには、[列表示オプション] メニュー（）をクリックします。
バケットリストで、検証するバケットを探し、[ラベル] のエントリを確認します。[ラベル] 列を表示するには、横方向にスクロールする必要があります。

バケットに複数のラベルが含まれている場合は、一部が表示されない可能性があります。ラベルが表示されない場合は、展開可能ボタンが表示されます。このボタンをクリックすると、バケットのすべてのラベルが表示されます。

Cloud Storage ブラウザで失敗したオペレーションに関する詳細なエラー情報を確認する方法については、トラブルシューティングをご覧ください。

gsutil

次の gsutil ls コマンドを使用します。

gsutil ls -L -b gs://BUCKET_NAME

ここで

BUCKET_NAME は、ラベルを表示するバケットです。例: my-bucket

次の例のようなレスポンスになります。

gs://my-bucket/ :
  Storage class:         STANDARD
  ...
  ...
  Labels:
    {
      "your_label_key": "your_label_value"
    }
  ...

コードサンプル

C++

詳細については、Cloud Storage C++ API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

namespace gcs = google::cloud::storage;
using ::google::cloud::StatusOr;
[](gcs::Client client, std::string const& bucket_name) {
  StatusOr<gcs::BucketMetadata> bucket_metadata =
      client.GetBucketMetadata(bucket_name, gcs::Fields("labels"));

  if (!bucket_metadata) {
    throw std::runtime_error(bucket_metadata.status().message());
  }

  if (bucket_metadata->labels().empty()) {
    std::cout << "The bucket " << bucket_name << " has no labels set.\n";
    return;
  }

  std::cout << "The labels for bucket " << bucket_name << " are:";
  for (auto const& kv : bucket_metadata->labels()) {
    std::cout << "\n  " << kv.first << ": " << kv.second;
  }
  std::cout << "\n";
}

PHP

詳細については、Cloud Storage PHP API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

use Google\Cloud\Storage\StorageClient;

/**
 * Prints a list of a bucket's lables.
 *
 * @param string $bucketName the name of your Cloud Storage bucket.
 */
function get_bucket_labels($bucketName)
{
    $storage = new StorageClient();
    $bucket = $storage->bucket($bucketName);
    $info = $bucket->info();
    if (isset($info['labels'])) {
        foreach ($info['labels'] as $labelKey => $labelValue) {
            printf('%s: %s' . PHP_EOL, $labelKey, $labelValue);
        }
    }
}

Python

詳細については、Cloud Storage Python API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

import pprint

from google.cloud import storage

def get_bucket_labels(bucket_name):
    """Prints out a bucket's labels."""
    # bucket_name = 'your-bucket-name'
    storage_client = storage.Client()

    bucket = storage_client.get_bucket(bucket_name)

    labels = bucket.labels
    pprint.pprint(labels)

REST API

JSON API

OAuth 2.0 Playground から承認アクセストークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
cURL を使用して JSON API を呼び出し、fields=labels クエリ文字列パラメータを含む GET Bucket リクエストを行います。
```
curl -X GET \
  -H "Authorization: Bearer OAUTH2_TOKEN" \
  "https://storage.googleapis.com/storage/v1/b/BUCKET_NAME?fields=labels"
```
ここで
- OAUTH2_TOKEN は、手順 1 で生成したアクセストークンです。
- BUCKET_NAME は、ラベルを表示するバケットの名前です。例: my-bucket

次の例のようなレスポンスになります。

{
  "labels" : {
     (your_label_key): your_label_value
   },
}

XML API

OAuth 2.0 Playground から承認アクセストークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
cURL を使用して、GET Bucket リクエストと tagging クエリ文字列パラメータを含めた XML API を呼び出します。
```
curl -X GET \
  -H "Authorization: Bearer OAUTH2_TOKEN" \
  "https://storage.googleapis.com/BUCKET_NAME?tagging"
```
ここで
- OAUTH2_TOKEN は、手順 1 で生成したアクセストークンです。
- BUCKET_NAME は、ラベルを表示するバケットの名前です。例: my-bucket

次の例のようなレスポンスになります。

<Tagging>
  <TagSet>
    <Tag>
      <Key>your_label_key</Key>
      <Value>your_label_value</Value>
    </Tag>
  </TagSet>
</Tagging>

バケットラベルを削除する

Console

Google Cloud Console で Cloud Storage ブラウザを開きます。
Cloud Storage ブラウザを開く
バケットリストで、ラベルを削除するバケットを探し、そのバケットの [バケットオーバーフロー] メニュー（）をクリックします。
[ラベルを編集] をクリックします。
削除するラベルに関連付けられた X をクリックします。
[保存] をクリックします。

Cloud Storage ブラウザで、失敗したオペレーションに関する詳細なエラー情報を確認する方法については、トラブルシューティングをご覧ください。

gsutil

label ch コマンドで -d フラグを使用します。例:

gsutil label ch -d KEY_1 gs://BUCKET_NAME

ここで

KEY_1 は、ラベルのキー名です。例: pet
BUCKET_NAME は、ラベルが適用されるバケットの名前です。例: my-bucket

既存のすべてのラベルを新しいラベルに置き換えるには、label set コマンドを使用します。

コードサンプル

C++

詳細については、Cloud Storage C++ API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

namespace gcs = google::cloud::storage;
using ::google::cloud::StatusOr;
[](gcs::Client client, std::string const& bucket_name,
   std::string const& label_key) {
  StatusOr<gcs::BucketMetadata> updated_metadata = client.PatchBucket(
      bucket_name, gcs::BucketMetadataPatchBuilder().ResetLabel(label_key));

  if (!updated_metadata) {
    throw std::runtime_error(updated_metadata.status().message());
  }

  std::cout << "Successfully reset label " << label_key << " on bucket  "
            << updated_metadata->name() << ".";
  if (updated_metadata->labels().empty()) {
    std::cout << " The bucket now has no labels.\n";
    return;
  }
  std::cout << " The bucket labels are now:";
  for (auto const& kv : updated_metadata->labels()) {
    std::cout << "\n  " << kv.first << ": " << kv.second;
  }
  std::cout << "\n";
}

Go

詳細については、Cloud Storage Go API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

import (
	"context"
	"fmt"
	"io"
	"time"

	"cloud.google.com/go/storage"
)

// removeBucketLabel removes a label on a bucket.
func removeBucketLabel(w io.Writer, bucketName, labelName string) error {
	// bucketName := "bucket-name"
	// labelName := "label-name"
	ctx := context.Background()
	client, err := storage.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("storage.NewClient: %v", err)
	}
	defer client.Close()

	ctx, cancel := context.WithTimeout(ctx, time.Second*10)
	defer cancel()

	bucket := client.Bucket(bucketName)
	bucketAttrsToUpdate := storage.BucketAttrsToUpdate{}
	bucketAttrsToUpdate.DeleteLabel(labelName)
	if _, err := bucket.Update(ctx, bucketAttrsToUpdate); err != nil {
		return fmt.Errorf("Bucket(%q).Update: %v", bucketName, err)
	}
	fmt.Fprintf(w, "Removed label %q from bucket %v\n", labelName, bucketName)
	return nil
}

Java

詳細については、Cloud Storage Java API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

import com.google.cloud.storage.Bucket;
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.StorageOptions;
import java.util.HashMap;
import java.util.Map;

public class RemoveBucketLabel {
  public static void removeBucketLabel(String projectId, String bucketName, String labelKey) {
    // The ID of your GCP project
    // String projectId = "your-project-id";

    // The ID of your GCS bucket
    // String bucketName = "your-unique-bucket-name";

    // The key of the label to remove from the bucket
    // String labelKey = "label-key-to-remove";

    Storage storage = StorageOptions.newBuilder().setProjectId(projectId).build().getService();

    Map<String, String> labelsToRemove = new HashMap<>();
    labelsToRemove.put(labelKey, null);

    Bucket bucket = storage.get(bucketName);
    Map<String, String> labels;
    if (bucket.getLabels() == null) {
      labels = new HashMap<>();
    } else {
      labels = new HashMap(bucket.getLabels());
    }
    labels.putAll(labelsToRemove);
    bucket.toBuilder().setLabels(labels).build().update();

    System.out.println("Removed label " + labelKey + " from bucket " + bucketName);
  }
}

Node.js

詳細については、Cloud Storage Node.js API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

/**
 * TODO(developer): Uncomment the following lines before running the sample.
 */
// const bucketName = 'Name of a bucket, e.g. my-bucket';
// const label_keys = 'List of label keys, e.g. ['label1','label2']';

// Imports the Google Cloud client library
const {Storage} = require('@google-cloud/storage');

// Creates a client
const storage = new Storage();

async function removeBucketLabel() {
  await storage.bucket(bucketName).deleteLabels(label_keys);
  console.log(`Removed labels from bucket ${bucketName}.`);
}

removeBucketLabel();

PHP

詳細については、Cloud Storage PHP API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

use Google\Cloud\Storage\StorageClient;

/**
 * Removes a label from a bucket.
 *
 * @param string $bucketName the name of your Cloud Storage bucket.
 * @param string $labelName the name of the label to remove.
 */
function remove_bucket_label($bucketName, $labelName)
{
    $storage = new StorageClient();
    $bucket = $storage->bucket($bucketName);
    $labels = [$labelName => null];
    $bucket->update(['labels' => $labels]);
    printf('Removed label %s from %s' . PHP_EOL, $labelName, $bucketName);
}

Python

詳細については、Cloud Storage Python API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

import pprint

from google.cloud import storage

def remove_bucket_label(bucket_name):
    """Remove a label from a bucket."""
    # bucket_name = "your-bucket-name"

    storage_client = storage.Client()
    bucket = storage_client.get_bucket(bucket_name)

    labels = bucket.labels

    if "example" in labels:
        del labels["example"]

    bucket.labels = labels
    bucket.patch()

    print("Removed labels on {}.".format(bucket.name))
    pprint.pprint(bucket.labels)

Ruby

詳細については、Cloud Storage Ruby API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

def remove_bucket_label bucket_name:, label_key:
  # The ID of your GCS bucket
  # bucket_name = "your-unique-bucket-name"

  # The key of the label to remove from the bucket
  # label_key = "label-key-to-remove"

  require "google/cloud/storage"

  storage = Google::Cloud::Storage.new
  bucket  = storage.bucket bucket_name

  bucket.update do |bucket|
    bucket.labels[label_key] = nil
  end

  puts "Deleted label #{label_key} from #{bucket_name}"
end

REST API

JSON API

OAuth 2.0 Playground から承認アクセストークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
次の情報が含まれる .json ファイルを作成します。
```
{
  "labels": {
    "KEY_1": null
  }
}
```
ここで
- KEY_1 は、ラベルのキー名です。例: pet
cURL を使用して JSON API を呼び出し、PATCH Bucket リクエストを行います。
```
curl -X PATCH --data-binary @JSON_FILE_NAME.json \
  -H "Authorization: Bearer OAUTH2_TOKEN" \
  -H "Content-Type: application/json" \
  "https://storage.googleapis.com/storage/v1/b/BUCKET_NAME?fields=labels"
```
ここで
- JSON_FILE_NAME は、手順 2 で作成した JSON ファイルの名前です。
- OAUTH2_TOKEN は、手順 1 で生成したアクセストークンの名前です。
- BUCKET_NAME は、ラベルが適用されるバケットの名前です。例: my-bucket

1 つのリクエストで複数の key:value ペアを削除できます。

XML API

OAuth 2.0 Playground から承認アクセストークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
次の情報が含まれる .xml ファイルを作成します。
```
<Tagging>
  <TagSet>
    <Tag>
    </Tag>
  </TagSet>
</Tagging>
```
リクエストには複数の <Tag> 要素を追加できることに注意してください。
cURL を使用して、PUT Bucket リクエストと tagging クエリ文字列パラメータを含めた XML API を呼び出します。
```
curl -X PUT --data-binary @XML_FILE_NAME.xml \
  -H "Authorization: Bearer OAUTH2_TOKEN" \
  "https://storage.googleapis.com/BUCKET_NAME?tagging"
```
ここで
- XML_FILE_NAME は、手順 2 で作成した XML ファイルの名前です。
- OAUTH2_TOKEN は、手順 1 で生成したアクセストークンの名前です。
- BUCKET_NAME は、ラベルが適用されるバケットの名前です。例: my-bucket

次のステップ

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2021-02-08 UTC.