インベントリレポートを使用する

このページでは、特定のバケット内のすべてのオブジェクトのメタデータの概要を把握できるように、インベントリレポートの構成と生成されたインベントリレポートを作成、管理する方法について説明します。インベントリレポートの概要については、インベントリレポートの概要ドキュメントをご覧ください。

始める前に

インベントリレポートとインベントリレポートの構成の作成と管理を開始する前に、次のサブセクションの手順に沿って操作してください。

必要なロールを取得する

インベントリレポートの作成と管理に必要な権限を取得するには、インベントリレポートを管理するプロジェクトまたはソースバケットと宛先バケットに対する次の IAM ロールの付与を管理者に依頼します。

インベントリレポートの構成を作成して管理するには:
- ソースバケットと宛先バケットに対する roles/storage.admin
- プロジェクトに対する roles/storageinsights.admin
インベントリレポートを表示してダウンロードするには:
- 宛先バケットに対する roles/storage.objectViewer
- プロジェクトに対する roles/storageinsights.viewer

これらの事前定義ロールには、インベントリレポートと構成を作成するために必要な権限が含まれています。必要な権限を正確に確認するには、「必要な権限」セクションを開いてください。

必要な権限

インベントリレポートの構成を作成して管理するために必要な権限は、次のとおりです。

ソースバケットに対する storage.buckets.get
ソースバケットに対する storage.objects.list
ソースバケットに対する storage.buckets.getObjectInsights
宛先バケットに対する storage.buckets.get
宛先バケットに対する storage.objects.create
プロジェクトに対する storageinsights.reportConfigs.delete
プロジェクトに対する storageinsights.reportConfigs.get
プロジェクトに対する storageinsights.reportConfigs.create
プロジェクトに対する storageinsights.reportConfigs.list
プロジェクトに対する storageinsights.reportConfigs.update

インベントリレポートを表示してダウンロードするには:

宛先バケットに対する storage.objects.get
プロジェクトに対する storageinsights.reportDetails.get
プロジェクトに対する storageinsights.reportDetails.list

他の事前定義ロールでこれらの権限を取得することもできます。どのロールがどの権限に関連付けられているかを確認するには、Cloud Storage に適用される IAM のロールをご覧ください。

ロールを使用してバケットへのアクセスを制御する手順については、IAM を使用するをご覧ください。ロールを使用してプロジェクトへのアクセスを制御する手順については、アクセスを管理するをご覧ください。

Storage Insights API を有効にする

コンソール

Enable the Storage Insights API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

コマンドライン

Enable the Storage Insights API:

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

gcloud services enable storageinsights.googleapis.com

REST API

gcloud CLI のインストールと初期化を行います。これにより、Authorization ヘッダーのアクセストークンを生成できます。

Storage Insights API を有効にするには、cURL を使用して services.enable メソッドを呼び出します。
```
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  https://serviceusage.googleapis.com/v1/projects/PROJECT_ID/services/storageinsights.googleapis.com:enable
```
次のように置き換えます。

PROJECT_ID は、API を有効にするプロジェクトの ID に置き換えます。

インベントリレポートの構成を作成する

コンソール

インベントリレポートの構成を作成する手順は次のとおりです。

Google Cloud コンソールで Cloud Storage の [バケット] ページに移動します。
[バケット] に移動
バケットのリストで、ソースバケットとして使用するバケットの名前をクリックします。
[バケットの詳細] ページで、[インベントリレポート] タブをクリックします。
[レポート構成を作成] をクリックします。
[レポート構成の指定] セクションで、インベントリレポート構成の表示名を作成します。表示名には最大 256 文字を使用できます。
[メタデータフィールドの選択] セクションで、インベントリレポートに含めるメタデータフィールドを選択します。
[続行] をクリックします。
[ファイル形式の選択] セクションで、インベントリレポートを生成するファイル形式を選択します。
[転送先バケットの選択] セクションで、転送先バケットとして使用するバケットを選択します。

[宛先のパスを入力（省略可）] セクションで、インベントリレポートを生成する宛先パスを指定できます。
[スケジュールのオプション] セクションで、レポートを生成する頻度、開始日、終了日を指定します。
[作成] をクリックします。

[レポート構成の詳細] ページが表示されます。生成されたインベントリレポートのメタデータがページに表示されます。

コマンドライン

インベントリレポート構成を作成するには、gcloud storage insights inventory-reports create コマンドを実行します。
```
gcloud storage insights inventory-reports create SOURCE_BUCKET_URL \
  --csv-separator=SEPARATOR \
  --csv-delimiter=DELIMITER \
  --[no]-csv-header \
  --parquet \
  --display-name=DISPLAY_NAME \
  --destination=DESTINATION_PATH \
  --metadata-fields=METADATA_FIELD \
  --schedule-starts=START_DATE \
  --schedule-repeats=FREQUENCY \
  --schedule-repeats-until=END_DATE
```
次のように置き換えます。
- SOURCE_BUCKET_URL は、ソースバケットの URL に置き換えます。例: gs://my_example_source_bucket
- SEPARATOR は、インベントリレポートの CSV ファイルでレコードの区切りを表す文字で置き換えます。\n または \r\n のいずれかを指定する必要があります。デフォルト値は \n です。省略可。--csv-separator フラグが使用されている場合、--parquet は使用できません。
- DELIMITER は、インベントリレポートの CSV ファイルでフィールドの区切りを表す文字で置き換えます。値には 1 つの文字を含めることができます。SEPARATOR と同じ値にすることはできません。デフォルト値は , です。省略可。--csv-delimiter が使用されている場合、--parquet は使用できません。
- --[no]-csv-header は、インベントリレポートの CSV ファイルにヘッダーが含まれているかどうかを示すフラグに置き換えます。ヘッダーを含める場合は --csv-header を使用し、ヘッダーを除外する場合は --no-csv-header を使用します。いずれかのフラグが使用されている場合、--parquet は使用できません。
- DISPLAY_NAME は、インベントリレポートの構成の名前で置き換えます。この名前は編集可能です。省略可。
- --parquet は、CSV ではなく Apache Parquet 形式でインベントリレポートを生成するフラグに置き換えます。これを使用した場合、--csv-delimiter、--csv-separator、--[no-]csv-header は使用できません。
- DESTINATION_PATH は、インベントリレポートが生成されるバケットまたはそのバケット内のフォルダに置き換えます。例: gs://my_example_destination_bucket、gs://my_example_destination_bucket/path/to/inventory/report
  
  バケット内のフォルダのパスを指定する場合は、パスにキーワードを使用できます。これらは、レポートの生成時に対応する値に置き換えられます。これにより、Hive パーティション分割形式でレポートを生成できるため、追加処理を行うことなく、BigQuery でのデータの読み込みやクエリを実行できます。
- METADATA_FIELD は、インベントリレポートに含めるメタデータフィールドのカンマ区切りのリストに置き換えます。
- START_DATE は、インベントリレポートの生成を開始する日付（UTC）に置き換えます。例: 2022-01-15
- FREQUENCY は、インベントリレポートを生成する頻度に置き換えます。値は daily か weekly です。
- END_DATE は、インベントリレポートの生成を停止する日付（UTC）に置き換えます。START_DATE より後の日付にする必要があります。たとえば、2022-02-15 を指定した場合、2022 年 2 月 16 日以降、インベントリレポートは生成されなくなります。

クライアントライブラリ

Java

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

Cloud Storage に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアントライブラリの認証情報を設定するをご覧ください。


import com.google.cloud.storageinsights.v1.CSVOptions;
import com.google.cloud.storageinsights.v1.CloudStorageDestinationOptions;
import com.google.cloud.storageinsights.v1.CloudStorageFilters;
import com.google.cloud.storageinsights.v1.CreateReportConfigRequest;
import com.google.cloud.storageinsights.v1.FrequencyOptions;
import com.google.cloud.storageinsights.v1.LocationName;
import com.google.cloud.storageinsights.v1.ObjectMetadataReportOptions;
import com.google.cloud.storageinsights.v1.ReportConfig;
import com.google.cloud.storageinsights.v1.StorageInsightsClient;
import com.google.common.collect.ImmutableList;
import com.google.type.Date;
import java.io.IOException;

public class CreateInventoryReportConfig {

  public static void createInventoryReportConfig(
      String projectId, String bucketLocation, String sourceBucket, String destinationBucket)
      throws IOException {
    try (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
      ReportConfig reportConfig =
          ReportConfig.newBuilder()
              .setDisplayName("Example inventory report configuration")
              .setFrequencyOptions(
                  FrequencyOptions.newBuilder()
                      .setFrequency(FrequencyOptions.Frequency.WEEKLY)
                      .setStartDate(Date.newBuilder().setDay(15).setMonth(8).setYear(3022).build())
                      .setEndDate(Date.newBuilder().setDay(15).setMonth(9).setYear(3022).build())
                      .build())
              .setCsvOptions(
                  CSVOptions.newBuilder()
                      .setDelimiter(",")
                      .setRecordSeparator("\n")
                      .setHeaderRequired(true)
                      .build())
              .setObjectMetadataReportOptions(
                  ObjectMetadataReportOptions.newBuilder()
                      .addAllMetadataFields(ImmutableList.of("project", "name", "bucket"))
                      .setStorageFilters(
                          CloudStorageFilters.newBuilder().setBucket(sourceBucket).build())
                      .setStorageDestinationOptions(
                          CloudStorageDestinationOptions.newBuilder()
                              .setBucket(destinationBucket)
                              .build())
                      .build())
              .build();
      CreateReportConfigRequest request =
          CreateReportConfigRequest.newBuilder()
              .setParent(LocationName.of(projectId, bucketLocation).toString())
              .setReportConfig(reportConfig)
              .build();
      ReportConfig response = storageInsightsClient.createReportConfig(request);
      System.out.println("Created inventory report config with name " + response.getName());
    }
  }
}

REST API

JSON API

インベントリレポートの構成を作成する手順は次のとおりです。

gcloud CLI のインストールと初期化を行います。これにより、Authorization ヘッダーのアクセストークンを生成できます。

次の情報が含まれる JSON ファイルを作成します。特に指定しない限り、すべてのフィールドは必須となります。
```
{
  "display_name": "DISPLAY_NAME",
  "frequency_options": {
    "frequency": "FREQUENCY",
    "start_date": "START_DATE",
    "end_date": "END_DATE",
  },
  "csv_options": {
    "record_separator": "RECORD_SEPARATOR",
    "delimiter": "DELIMITER",
    "header_required": HEADER_REQUIRED
  },
  "object_metadata_report_options": {
     "metadata_fields": [
      "METADATA_FIELD",
      ...
    ],
    "storage_filters": {
      "bucket": "SOURCE_BUCKET_NAME"
    },
    "storage_destination_options": {
      "bucket": "DESTINATION_BUCKET_NAME",
      "destination_path": "DESTINATION_PATH"
    }
  }
}
```
次のように置き換えます。
- SOURCE_BUCKET_NAME は、インベントリレポートを生成するオブジェクトを含むソースバケットの名前に置き換えます。例: my_example_bucket
- METADATA_FIELD は、インベントリレポートに含めるメタデータフィールドのカンマ区切りのリストに置き換えます。
- DESTINATION_BUCKET_NAME は、インベントリレポートが生成されて保存される転送先バケットの名前に置き換えます。例: my_example_destination_bucket
- DESTINATION_PATH は、生成されたインベントリレポートの宛先バケットのパスに置き換えます。このフィールドは省略可能です。
  
  バケット内のフォルダのパスを指定する場合は、パスにキーワードを使用できます。これらは、レポートの生成時に対応する値に置き換えられます。これにより、Hive パーティション分割形式でレポートを生成できるため、追加処理を行うことなく、BigQuery でのデータの読み込みやクエリを実行できます。
注: Apache Parquet 形式でインベントリレポートを生成するには、インベントリレポートの構成に "csv_options": {...} ではなく "parquet_options": {} を含めます。
たとえば、次のコードサンプルでは、「インベントリレポートの構成例」という名前のインベントリレポートの構成を作成します。この構成では毎週レポートを生成します。
```
{
  "display_name": "Example inventory report configuration",
  "frequency_options": {
    "frequency": "WEEKLY",
    "start_date": {
      "day": 15,
      "month": 8,
      "year": 2022
    },
    "end_date": {
      "day": 15,
      "month": 9,
      "year": 2022
    },
  },
  "csv_options": {
    "record_separator": "\n",
    "delimiter": ",",
    "header_required": true
  },
  "object_metadata_report_options": {
     "metadata_fields": [
      "project",
      "name",
      "bucket"
    ],
    "storage_filters": {
      "bucket": "example_source_bucket"
    },
    "storage_destination_options": {
      "bucket": "example_destination_bucket"
    }
  }
}
```
インベントリレポートの構成を適用するには、cURL を使用して、Create ReportConfig リクエストで JSON API を呼び出します。
```
curl -X POST --data-binary @JSON_FILE_NAME \
"https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs" \
  --header "Authorization: Bearer $(gcloud auth print-access-token)" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
```
次のように置き換えます。
- JSON_FILE_NAME は、前の手順で作成した JSON ファイルのパスに置き換えます。
- YOUR_PROJECT は、ソースバケットと宛先バケットが存在するプロジェクトの名前で置き換えます。
- LOCATION は、ソースバケットと宛先バケットのロケーションで置き換えます。例: us-west1。

サービスエージェントに必要なロールを付与する

インベントリレポートの構成を初めて設定するときに、プロジェクトレベルのサービスエージェントが自動的に作成されます。サービスエージェントは命名形式 service-PROJECT_NUMBER@gcp-sa-storageinsights.iam.gserviceaccount.com に従い、[Google 提供のロール付与を含める] チェックボックスが選択されているときに、 Google Cloud コンソールの [IAM] ページに表示されます。

Storage Insights でインベントリレポートを生成して書き込むようにするには、サービスエージェントに次の IAM ロールを付与するよう管理者に依頼してください。

ソースバケットに対する roles/storage.insightsCollectorService（storage.buckets.getObjectInsights 権限と storage.buckets.get 権限を含む）
転送先バケットに対する roles/storage.objectCreator（storage.objects.create 権限を含む）

ロールの付与手順については、IAM を使用するをご覧ください。roles/storage.insightsCollectorService ロールを付与するには、 Google Cloud コンソールまたは Google Cloud CLI を使用します。次に例を示します。

gcloud storage buckets add-iam-policy-binding SOURCE_BUCKET_URL \
    --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-storageinsights.iam.gserviceaccount.com \
    --role=roles/storage.insightsCollectorService

必要な権限がサービスエージェントに付与されてから、最初のインベントリレポートが転送先バケットに書き込まれるまでに最大で 24 時間かかります。

インベントリレポートの構成を編集する

インベントリレポートの構成が作成されたら、構成の特定のプロパティを変更できます。

コンソール

インベントリレポートの構成を編集する手順は次のとおりです。

Google Cloud コンソールで Cloud Storage の [バケット] ページに移動します。
[バケット] に移動
バケットのリストで、編集するインベントリレポート構成を含むソースバケットの名前をクリックします。
転送元バケットの [バケットの詳細] ページで、[インベントリレポート] タブをクリックします。
編集するインベントリレポート構成の構成名をクリックします。
表示された [レポート構成の詳細] ページで、 [編集] ボタンを使用してプロパティを編集します。

コマンドライン

インベントリレポートの構成を編集する手順は次のとおりです。

編集するインベントリレポートの構成名を確認するには、gcloud storage insights inventory-reports list コマンドを使用して、ソースバケット内のすべてのインベントリ構成を一覧表示します。
```
gcloud storage insights inventory-reports list \
  --source=SOURCE_BUCKET \
  --filter=EXPRESSION \
  --page-size=SIZE \
  --sort-by=FIELD \
  --format="yaml(name)"
```
次のように置き換えます。
- SOURCE_BUCKET は、インベントリレポートの構成を含むソースバケットの URL で置き換えます。
- EXPRESSION は、一覧表示する各リソース項目に適用するブール値フィルタで置き換えます。式が True と評価された場合、項目がリストされます。フィルタ式の詳細と例を表示するには、$ gcloud topic filters を実行します。
- SIZE は、1 ページあたりの最大リソース数で置き換えます。デフォルト値は 50 です。
- FIELD は、並べ替えるリソースフィールドキー名のカンマ区切りのリストで置き換えます。デフォルトの順序は昇順です。フィールドを降順で並べ替えるには、フィールドの先頭に ~ を付けます。
1. gcloud storage insights inventory-reports update コマンドを使用して、更新するインベントリレポートの構成フィールドを編集します。次の例では、インベントリレポートを Apache Parquet 形式で毎日生成するように、インベントリレポートの構成を更新しています。
```
gcloud storage insights inventory-reports update CONFIG_NAME \
--parquet \
--schedule-repeats="daily"
```

クライアントライブラリ

Java

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


import com.google.cloud.storageinsights.v1.ReportConfig;
import com.google.cloud.storageinsights.v1.ReportConfigName;
import com.google.cloud.storageinsights.v1.StorageInsightsClient;
import com.google.cloud.storageinsights.v1.UpdateReportConfigRequest;
import com.google.protobuf.FieldMask;
import java.io.IOException;

public class EditInventoryReportConfig {


  public static void editInventoryReportConfig(
          String projectId, String location, String inventoryReportConfigUuid) throws IOException {
    try (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
      ReportConfigName name = ReportConfigName.of(projectId, location, inventoryReportConfigUuid);
      ReportConfig reportConfig = storageInsightsClient.getReportConfig(name);

      // Set any other fields you want to update here
      ReportConfig updatedReportConfig =
              reportConfig.toBuilder().setDisplayName("Updated Display Name").build();

      storageInsightsClient.updateReportConfig(
              UpdateReportConfigRequest.newBuilder()
                      // Add any fields that you want to update to the update mask, in snake case
                      .setUpdateMask(FieldMask.newBuilder().addPaths("display_name")
                              .build())
                      .setReportConfig(updatedReportConfig).build());

      System.out.println("Edited inventory report config with name " + name);
    }
  }
}

REST API

JSON API

インベントリレポートの構成を編集する手順は次のとおりです。

gcloud CLI のインストールと初期化を行います。これにより、Authorization ヘッダーのアクセストークンを生成できます。

編集するインベントリレポートの構成名を取得するには、cURL を使用して、Get ReportConfig リクエストで JSON API を呼び出します。
```
curl --request GET \
"https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs?" \
  --header "Authorization: Bearer $(gcloud auth print-access-token)" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
```
次のように置き換えます。
- YOUR_PROJECT は、ソースバケットと宛先バケットが存在するプロジェクトの名前で置き換えます。
- LOCATION は、ソースバケットと宛先バケットのロケーションで置き換えます。例: us-west1。
特定のソースバケットのすべてのインベントリレポートの構成を取得するには、filter クエリパラメータをリクエストに追加します。
```
curl --request GET \
"https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs?filter=objectMetadataReportOptions.storageFilters.bucket=BUCKET_NAME" \
  --header "Authorization: Bearer $(gcloud auth print-access-token)" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
```
次のように置き換えます。
- YOUR_PROJECT は、ソースバケットと宛先バケットが存在するプロジェクトの名前で置き換えます。
- LOCATION は、ソースバケットと宛先バケットのロケーションで置き換えます。例: us-west1。
- BUCKET_NAME は、編集するインベントリレポート構成を含むソースバケットの名前で置き換えます。
編集するプロパティへの変更を含む JSON ファイルを作成します。次の例では、インベントリレポートを Apache Parquet 形式で毎日生成するように、インベントリレポートの構成を更新しています。
```
{
  "ReportConfig": {
    "frequency_options": {
      "frequency": "DAILY"
    },
    "parquet_options": {
    }
  }
```
インベントリレポートの構成を適用するには、cURL を使用して、Patch ReportConfig リクエストで JSON API を呼び出します。
```
curl --request PATCH \
"https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID" \
  --header "Authorization: Bearer $(gcloud auth print-access-token)" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data-binary "@JSON_FILE_NAME.json" \
```
次のように置き換えます。
- YOUR_PROJECT は、ソースバケットと宛先バケットが存在するプロジェクトの名前で置き換えます。
- LOCATION は、ソースバケットと宛先バケットのロケーションで置き換えます。例: us-west1。
- REPORT_CONFIG_UUID は、インベントリレポートの構成の自動生成 UUID で置き換えます。

インベントリレポートの構成を一覧取得する

コンソール

ソースバケット内のインベントリレポートの構成を一覧表示する手順は次のとおりです。

Google Cloud コンソールで Cloud Storage の [バケット] ページに移動します。
[バケット] に移動
バケットのリストで、表示するインベントリレポート構成を含むソースバケットの名前をクリックします。
[バケットの詳細] ページで、[インベントリレポート] タブをクリックします。

ソースバケットのインベントリレポート構成が表示されます。

コマンドライン

gcloud storage insights inventory-reports list コマンドを使用すると、ソースバケット内のすべてのインベントリ構成を一覧取得できます。

gcloud storage insights inventory-reports list \
  --source=SOURCE_BUCKET \
  --filter=EXPRESSION \
  --page-size=SIZE \
  --sort-by=FIELD \
  --format="yaml(name)"

次のように置き換えます。

SOURCE_BUCKET は、インベントリレポートの構成を含むソースバケットの URL で置き換えます。
EXPRESSION は、一覧表示する各リソース項目に適用するブール値フィルタで置き換えます。式が True と評価された場合、項目がリストされます。フィルタ式の詳細と例を表示するには、$ gcloud topic filters を実行します。
SIZE は、1 ページあたりの最大リソース数で置き換えます。デフォルト値は 50 です。
FIELD は、並べ替えるリソースフィールドキー名のカンマ区切りのリストで置き換えます。デフォルトの順序は昇順です。フィールドを降順で並べ替えるには、フィールドの先頭に ~ を付けます。

クライアントライブラリ

Java

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


import com.google.cloud.storageinsights.v1.LocationName;
import com.google.cloud.storageinsights.v1.ReportConfig;
import com.google.cloud.storageinsights.v1.StorageInsightsClient;
import java.io.IOException;

public class ListInventoryReportConfigs {


  public static void listInventoryReportConfigs(String projectId, String location)
      throws IOException {
    try (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
      System.out.println(
          "Printing inventory report configs in project "
              + projectId
              + " and location "
              + location);
      for (ReportConfig config :
          storageInsightsClient
              .listReportConfigs(LocationName.of(projectId, location))
              .iterateAll()) {
        System.out.println(config.getName());
      }
    }
  }
}

REST API

JSON API

gcloud CLI のインストールと初期化を行います。これにより、Authorization ヘッダーのアクセストークンを生成できます。

特定のロケーションのプロジェクト内のすべてのインベントリレポートの構成を一覧表示するには、インベントリレポート構成の一覧表示リクエストを使用します。
```
curl --request GET \
"https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs?" \
  --header "Authorization: Bearer $(gcloud auth print-access-token)" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
```
次のように置き換えます。
- YOUR_PROJECT は、ソースバケットと宛先バケットが存在するプロジェクトの名前で置き換えます。
- LOCATION は、ソースバケットと宛先バケットのロケーションで置き換えます。例: us-west1。
特定のソースバケットのすべてのインベントリレポートの構成を一覧取得するには、filter クエリパラメータをリクエストに追加します。
```
curl --request GET \
"https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs?filter=objectMetadataReportOptions.storageFilters.bucket=BUCKET_NAME" \
  --header "Authorization: Bearer $(gcloud auth print-access-token)" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
```
次のように置き換えます。
- YOUR_PROJECT は、ソースバケットと宛先バケットが存在するプロジェクトの名前で置き換えます。
- LOCATION は、ソースバケットと宛先バケットのロケーションで置き換えます。例: us-west1。
- BUCKET_NAME は、一覧取得するインベントリレポート構成を含むソースバケットの名前で置き換えます。

インベントリレポートをダウンロードする

コンソール

レポートを個別にダウンロードする

インベントリレポートは宛先バケット内に生成され、オブジェクトとして保存されるため、通常のオブジェクトと同様にダウンロードできます。

インベントリレポートをダウンロードする手順は次のとおりです。

Google Cloud コンソールで Cloud Storage の [バケット] ページに移動します。
[バケット] に移動
バケットのリストで、ダウンロードするインベントリレポートを含む転送先バケットの名前をクリックします。
[バケットの詳細] ページで、[オブジェクト] タブが選択されていることを確認します。
ダウンロードするインベントリレポートに関連付けられた [ ダウンロード] をクリックします。

転送先バケットがわからない場合は、生成元のインベントリレポート構成を通してインベントリレポートをダウンロードすることもできます。

Google Cloud コンソールで Cloud Storage の [バケット] ページに移動します。
[バケット] に移動
バケットのリストで、ダウンロードするレポートを生成したインベントリレポート構成を含む、転送元バケットの名前をクリックします。
[バケットの詳細] ページで、インベントリレポート構成の構成名をクリックします。
表示される [レポート構成の詳細] ページで、[インベントリレポートの履歴] セクションに移動し、ダウンロードするインベントリレポートの宛先オブジェクトのパスをクリックします。

インベントリレポートを含む転送先バケットの [バケットの詳細] ページが表示されます。
ダウンロードするインベントリレポートに関連付けられた [ ダウンロード] をクリックします。

レポートシャードをダウンロードする

1 つ以上のシャードに分割されたインベントリレポートをダウンロードするには、次の手順を完了します。

Google Cloud コンソールで Cloud Storage の [バケット] ページに移動します。
[バケット] に移動
バケットのリストで、インベントリレポート構成の作成時に指定した転送先バケットの名前をクリックします。
[バケットの詳細] ページで、マニフェストファイルが存在するかどうかを確認します。マニフェストファイルが存在する場合は、インベントリレポートのすべてのシャードが生成されています。

マニフェストファイルには fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:00_manifest.json のような名前が付いています。
転送先バケットで、マニフェストファイルに関連付けられた [ダウンロード] をクリックします。ダウンロードするシャードファイルの名前を report_shards_file_names フィールドからメモします。
転送先バケットで、ダウンロードするシャードファイルに関連付けられた [ ダウンロード] をクリックします。

コマンドライン

レポートを個別にダウンロードする

インベントリレポートをダウンロードする手順は次のとおりです。

インベントリレポートの構成によって生成されたすべてのインベントリレポートを一覧表示し、その REPORT_DETAIL_ID を取得するには、gcloud storage insights inventory-reports details list コマンドを使用します。
```
gcloud storage insights inventory-reports details list CONFIG_NAME \
  --filter=EXPRESSION \
  --page-size=SIZE \
  --sort-by=FIELD
```
次のように置き換えます。
- CONFIG_NAME は、インベントリレポートの構成の一意の名前（projects/PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID 形式）で置き換えます。
- EXPRESSION は、一覧表示する各リソース項目に適用するブール値フィルタで置き換えます。式が True と評価された場合、そのアイテムがリストされます。フィルタ式の詳細と例を表示するには、$ gcloud topic filters を実行します。
- SIZE は、1 ページあたりの最大リソース数で置き換えます。デフォルト値は 50 です。
- FIELD は、並べ替えるリソースフィールドキー名のカンマ区切りのリストで置き換えます。デフォルトの順序は昇順です。フィールドを降順で並べ替えるには、フィールドの先頭に ~ を付けます。
成功した場合、コマンドは次のような出力を返します。
```
REPORT_DETAIL_ID            SNAPSHOT_TIME
Report_2023-04-10T00-00     2023-04-10T00:53:03Z
Report_2023-04-12T00-00     2023-04-12T00:52:54Z
Report_2023-04-05T00-00     2023-04-05T00:53:01Z
```
インベントリレポートをダウンロードするには、まず ReportDetail オブジェクトの reportPathPrefix プロパティを取得する必要があります。レポートの reportPathPrefix を取得するには、gcloud storage insights inventory-reports details describe コマンドを使用します。
```
gcloud storage insights inventory-reports details describe REPORT_DETAIL_NAME
```
REPORT_DETAIL_NAME は、インベントリレポートの名前に置き換えます。形式は projects/PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID/reportDetails/REPORT_DETAIL_ID です。

レポートシャードをダウンロードする

1 つ以上のシャードに分割されたインベントリレポートをダウンロードするには、次の手順を完了します。

gcloud storage cp コマンドを使用して、インベントリレポートのマニフェストファイルをダウンロードします。
```
gcloud storage cp gs://BUCKET_NAME/MANIFEST_FILE_NAME DOWNLOAD_PATH
```
次のように置き換えます。
- BUCKET_NAME は、宛先バケットの名前に置き換えます。
- MANIFEST_FILE_NAME は、転送先バケットのマニフェストファイルの名前に置き換えます。次の命名規則を使用します。
```
REPORT_CONFIG_UUID_TARGET_DATETIME_manifest.json
```
  ここで
  - REPORT_CONFIG_UUID は、ダウンロードするレポートシャードを生成したインベントリレポート構成の自動生成 UUID です。
  - TARGET_DATETIME は、インベントリレポートが生成された日時です。
  例: fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:00_manifest.json。
- DOWNLOAD_PATH は、インベントリレポートを保存するファイルシステムのパスに置き換えます。例: ./example_report.csv。
シャードファイルをダウンロードするには、gcloud storage cp コマンドを使用します。
```
gcloud storage cp gs://BUCKET_NAME/SHARD_FILE_NAME DOWNLOAD_PATH
```
次のように置き換えます。
- BUCKET_NAME は、宛先バケットの名前に置き換えます。
- SHARD_FILE_NAME は、ダウンロードするシャードファイルの URL エンコードされた名前に置き換えます。例: fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:54_0.csv
- DOWNLOAD_PATH は、インベントリレポートを保存するファイルシステムのパスに置き換えます。例: ./example_report.csv。

クライアントライブラリ

Java

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


import com.google.cloud.storageinsights.v1.ReportConfig;
import com.google.cloud.storageinsights.v1.ReportConfigName;
import com.google.cloud.storageinsights.v1.ReportDetail;
import com.google.cloud.storageinsights.v1.StorageInsightsClient;
import java.io.IOException;

public class GetInventoryReportNames {


  public static void getInventoryReportNames(
      String projectId, String location, String reportConfigUuid) throws IOException {
    try (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
      ReportConfig config =
          storageInsightsClient.getReportConfig(
              ReportConfigName.of(projectId, location, reportConfigUuid));
      String extension = config.hasCsvOptions() ? "csv" : "parquet";
      System.out.println(
          "You can use the Google Cloud Storage Client "
              + "to download the following objects from Google Cloud Storage:");
      for (ReportDetail reportDetail :
          storageInsightsClient.listReportDetails(config.getName()).iterateAll()) {
        for (long index = reportDetail.getShardsCount() - 1; index >= 0; index--) {
          System.out.println(reportDetail.getReportPathPrefix() + index + "." + extension);
        }
      }
    }
  }
}

REST API

JSON API

レポートを個別にダウンロードする

インベントリレポートをダウンロードする手順は次のとおりです。

gcloud CLI のインストールと初期化を行います。これにより、Authorization ヘッダーのアクセストークンを生成できます。

インベントリレポートの構成で生成されたすべてのインベントリレポートを一覧表示するには、cURL を使用して、インベントリレポート詳細の一覧表示リクエストで JSON API を呼び出します。
```
curl --request GET \
"https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID/reportDetails/" \
  --header "Authorization: Bearer $(gcloud auth print-access-token)" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
```
次のように置き換えます。
- YOUR_PROJECT は、ソースバケットと宛先バケットが存在するプロジェクトの名前で置き換えます。
- LOCATION は、ソースバケットと宛先バケットのロケーションで置き換えます。例: us-west1。
- REPORT_CONFIG_UUID は、ダウンロードするレポートを生成したインベントリレポート構成の自動生成 UUID で置き換えます。
個々のレポートの詳細を取得するには、次のように cURL で Get ReportDetails リクエストを指定して JSON API を呼び出します。
```
curl --request GET \
"https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID/reportDetails/REPORT_DETAIL_ID" \
  --header "Authorization: Bearer $(gcloud auth print-access-token)" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
```
次のように置き換えます。
- YOUR_PROJECT は、ソースバケットと宛先バケットが存在するプロジェクトの名前で置き換えます。
- LOCATION は、ソースバケットと宛先バケットのロケーションで置き換えます。例: us-west1。
- REPORT_CONFIG_UUID は、ダウンロードするレポートを生成したインベントリレポート構成の自動生成 UUID で置き換えます。
- REPORT_DETAIL_ID は、ダウンロードするインベントリレポートの名前で置き換えます。

レポートシャードをダウンロードする

1 つ以上のシャードに分割されたインベントリレポートをダウンロードするには、次の手順を完了します。

gcloud CLI のインストールと初期化を行います。これにより、Authorization ヘッダーのアクセストークンを生成できます。

インベントリレポートのマニフェストファイルをダウンロードするには、cURL を使用して、GET Object リクエストで JSON API を呼び出します。
```
curl -X GET \
  --header "Authorization: Bearer $(gcloud auth print-access-token)" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  "https://storage.googleapis.com/storage/v1/b/BUCKET_NAME/o/MANIFEST_FILE_NAME?alt=media"
```
次のように置き換えます。
- BUCKET_NAME は、宛先バケットの名前に置き換えます。
- MANIFEST_FILE_NAME は、転送先バケットのマニフェストファイルの名前に置き換えます。次の命名規則を使用します。
```
REPORT_CONFIG_UUID_TARGET_DATETIME_manifest.json
```
  ここで
  - REPORT_CONFIG_UUID は、ダウンロードするレポートシャードを生成したインベントリレポート構成の自動生成 UUID です。
  - TARGET_DATETIME は、インベントリレポートが生成された日付です。
例: fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:00_manifest.json。

マニフェストファイルの report_shards_file_names フィールドに、ダウンロード可能なインベントリレポートシャードの名前が含まれています。
インベントリレポートのシャードファイルをダウンロードするには、curl で Get Object リクエストを指定して Cloud Storage JSON API を呼び出します。
```
curl -X GET \
  --header "Authorization: Bearer $(gcloud auth print-access-token)" \
  -o "DOWNLOAD_PATH" \
  "https://storage.googleapis.com/storage/v1/b/BUCKET_NAME/o/SHARD_FILE_NAME?alt=media"
```
次のように置き換えます。
- DOWNLOAD_PATH は、オブジェクトを保存するローカルファイルシステムのパスに置き換えます。例: Desktop/dog.png
- BUCKET_NAME は、インベントリレポートを含む宛先バケットの名前で置き換えます。例: my-bucket
- SHARD_FILE_NAME は、ダウンロードするシャードファイルの URL エンコードされた名前に置き換えます。例: fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:54_0.csv

インベントリレポートの構成を削除する

コンソール

インベントリレポートの構成を削除する手順は次のとおりです。

Google Cloud コンソールで Cloud Storage の [バケット] ページに移動します。
[バケット] に移動
バケットのリストで、削除するインベントリレポート構成を含むソースバケットの名前をクリックします。
転送元バケットの [バケットの詳細] ページで、[インベントリレポート] タブをクリックします。
削除するインベントリレポート構成の構成名をクリックします。
表示された [レポート構成の詳細] ページで、[ 削除] をクリックします。

コマンドライン

インベントリレポート構成を削除するには、gcloud storage insights inventory-reports delete コマンドを使用します。

gcloud storage insights inventory-reports delete CONFIG_NAME
  --force

CONFIG_NAME は、インベントリレポート構成の一意の名前（projects/PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID 形式）に置き換えます。

--force フラグを指定すると、指定されたインベントリレポートの構成によって生成されたインベントリレポートのメタデータがすべて削除されます。インベントリレポートオブジェクト自体は削除されません。

クライアントライブラリ

Java

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


import com.google.cloud.storageinsights.v1.ReportConfigName;
import com.google.cloud.storageinsights.v1.StorageInsightsClient;
import java.io.IOException;

public class DeleteInventoryReportConfig {


  public static void deleteInventoryReportConfig(
      String projectId, String location, String inventoryReportConfigUuid) throws IOException {
    try (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
      ReportConfigName name = ReportConfigName.of(projectId, location, inventoryReportConfigUuid);
      storageInsightsClient.deleteReportConfig(name);

      System.out.println("Deleted inventory report config with name " + name);
    }
  }
}

REST API

JSON API

インベントリレポートの構成を削除する手順は次のとおりです。

gcloud CLI のインストールと初期化を行います。これにより、Authorization ヘッダーのアクセストークンを生成できます。

インベントリレポートの構成を削除するには、cURL を使用して、Delete ReportConfig リクエストで JSON API を呼び出します、
```
curl --request DELETE \
'https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID?force=true' \
  --header 'Authorization: Bearer $(gcloud auth print-access-token)' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
```
次のように置き換えます。
- YOUR_PROJECT は、ソースバケットと宛先バケットが存在するプロジェクトの名前で置き換えます。
- LOCATION は、ソースバケットと宛先バケットのロケーションで置き換えます。例: us-west1。
- REPORT_CONFIG_UUID は、削除するインベントリレポート構成の自動生成 UUID で置き換えます。

force クエリパラメータは、指定されたインベントリレポートの構成によって生成されたインベントリレポートのメタデータをすべて削除します。インベントリレポートオブジェクト自体は削除されません。

高度な設定: Hive パーティション分割形式でインベントリレポートを生成する

インベントリレポートの構成を作成する際、インベントリレポートを生成する宛先バケット内の場所を、宛先パスとして指定できます。これにより、Hive パーティション分割形式でインベントリレポートを生成できます。

プレースホルダキーワードを使用して宛先パスを指定します。インベントリレポートの生成時に、リンク先のパスのキーワードが対応する値に置き換えられます。たとえば、宛先のパス config={{report-config-id}}/date={{date}} は、config=1A34-F2E456-12B456-1C3D/date=2022-05-20 に解決されます。

宛先パスのキーワード

キーワード report-config-id、date、または datetime を {{ と }} で囲んで指定できます。ここで、

report-config-id は、インベントリレポートの構成の UUID です。
date は、インベントリレポートが生成される日付です。ISO 8601 形式に従います。
datetime は、インベントリレポートが生成される日時です。ISO 8601 形式に従います。

キーワードは、次のいずれかのツールを使用して指定できます。

Google Cloud コンソールを使用する場合は、[宛先のパスを入力（省略可）] セクションでキーワードを指定します。このセクションは、インベントリレポートの構成を作成するときに表示されます。
Google Cloud CLI を使用する場合は、--destination フラグを使用してプレースホルダキーワードを指定します。
JSON API を使用する場合は、ReportConfig オブジェクトの storage_destination_options.destination_path フィールドにプレースホルダキーワードを指定します。

アクセス制御とセキュリティ

インベントリレポートとその構成のセキュリティや使用に関連する推奨事項と考慮事項は次のとおりです。

オブジェクトやメタデータの読み取りなど、バケット内のすべてのリソースの使用に対する制御を維持できるように、roles/storage.admin ロールが付与されたユーザーにも storageinsights.reportConfigs.* 権限を付与することをおすすめします。
storageinsights.reportConfigs.* 権限を必要な個人にのみ付与することで、インベントリレポートリソースへのアクセスを制限することをおすすめします。
インベントリレポートの構成を作成した後、その構成を作成したユーザーが必要な権限を失った場合でも、インベントリレポートは引き続き生成されます。インベントリレポートの生成を停止するには、インベントリレポート構成の終了日を編集するか、構成を完全に削除します。

次のステップ

インベントリレポートの生成で問題が発生した場合は、トラブルシューティングをご覧ください。

インベントリ レポートを使用する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

始める前に

必要なロールを取得する

必要な権限

Storage Insights API を有効にする

コンソール

コマンドライン

REST API

インベントリ レポートの構成を作成する

コンソール

コマンドライン

クライアント ライブラリ

Java

REST API

JSON API

サービス エージェントに必要なロールを付与する

インベントリ レポートの構成を編集する

コンソール

コマンドライン

クライアント ライブラリ

Java

REST API

JSON API

インベントリ レポートの構成を一覧取得する

コンソール

コマンドライン

クライアント ライブラリ

Java

REST API

JSON API

インベントリ レポートをダウンロードする

コンソール

レポートを個別にダウンロードする

レポート シャードをダウンロードする

コマンドライン

レポートを個別にダウンロードする

レポート シャードをダウンロードする

クライアント ライブラリ

Java

REST API

JSON API

レポートを個別にダウンロードする

レポート シャードをダウンロードする

インベントリ レポートの構成を削除する

コンソール

コマンドライン

クライアント ライブラリ

Java

REST API

JSON API

高度な設定: Hive パーティション分割形式でインベントリ レポートを生成する

宛先パスのキーワード

アクセス制御とセキュリティ

次のステップ

インベントリレポートを使用する

インベントリレポートの構成を作成する

クライアントライブラリ

サービスエージェントに必要なロールを付与する

インベントリレポートの構成を編集する

クライアントライブラリ

インベントリレポートの構成を一覧取得する

クライアントライブラリ

インベントリレポートをダウンロードする

レポートシャードをダウンロードする

レポートシャードをダウンロードする

クライアントライブラリ

レポートシャードをダウンロードする

インベントリレポートの構成を削除する

クライアントライブラリ

高度な設定: Hive パーティション分割形式でインベントリレポートを生成する