使用庫存報表

JSON API

如要建立庫存報表設定，請完成下列步驟：

1. 安裝並初始化 gcloud CLI，以便為 Authorization 標頭產生存取權杖。

2. 建立包含下列資訊的 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"
       }
     }
   }

   更改項目：

   • DISPLAY_NAME：庫存報表設定的可編輯顯示名稱。最多可包含 256 個字元。

   • FREQUENCY 替換為產生商品目錄報表的頻率。值為 DAILY 或 WEEKLY。

   • START_DATE 替換成要開始產生庫存報表的世界標準時間日期。不得為當天或過去的日期。值必須是包含 day、month 和 year 鍵的物件。例如：{"day": 15, "month": 8, "year": 2022}。

   • END_DATE：世界標準時間日期，表示您希望停止產生商品目錄報表的時間。值必須是包含 day、month 和 year 鍵的物件。舉例來說，如果您指定 {"day": 15, "month": 9, "year": 2022}，系統就不會再產生 2022 年 9 月 16 日之後的商品目錄報表。

   • RECORD_SEPARATOR 替換為用於分隔 CSV 檔案中記錄的字元。必須是 \n 或 \r\n。預設值為 \n。這是選填欄位。

   • DELIMITER：用於分隔 CSV 格式商品目錄報表中欄位的分隔符號。值可以包含一個字元，且不得與 RECORD_SEPARATOR 相同。預設值為 ,。這是選填欄位。

   • HEADER_REQUIRED：布林值，表示 CSV 檔案是否包含標頭。這是選填欄位。

   • SOURCE_BUCKET_NAME 替換成來源 bucket 的名稱，該 bucket 包含要產生清查報表的物件。例如：my_example_bucket。

   • METADATA_FIELD：以半形逗號分隔的清單，列出要納入清查報表的中繼資料欄位。

   • DESTINATION_BUCKET_NAME：目的地 bucket 的名稱，用於產生及儲存庫存報表。例如：my_example_destination_bucket。

   • DESTINATION_PATH：產生清查報表的目的地 bucket 路徑。這是選填欄位。

     指定 bucket 內資料夾的路徑時，您可以在路徑中使用關鍵字，系統會在產生報表時將關鍵字替換為相應的值。這樣一來，您就能以 Hive 分區格式產生報表，在 BigQuery 中載入或查詢資料，不必額外處理。

   舉例來說，下列程式碼範例會建立名為「Example inventory report configuration」的商品目錄報表設定，並每週產生報表：

   {
     "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"
       }
     }
   }

3. 如要套用庫存報表設定，請使用 cURL 呼叫 JSON API，並傳送 Create ReportConfig 要求：

   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：來源和目的地 bucket 所在的專案名稱。

   • LOCATION 替換為來源和目的地 bucket 的位置。例如：us-west1。

JSON API

如要編輯庫存報表設定，請完成下列步驟：

1. 安裝並初始化 gcloud CLI，以便為 Authorization 標頭產生存取權杖。

2. 使用 cURL 呼叫 JSON API，並傳送 Get ReportConfig 要求，取得要編輯的清查報表設定名稱：

   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：來源和目的地 bucket 所在的專案名稱。

   • LOCATION 替換為來源和目的地 bucket 的位置。例如：us-west1。

   如要擷取特定來源 bucket 中的所有庫存報表設定，請在要求中附加 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：來源和目的地 bucket 所在的專案名稱。
   • LOCATION 替換為來源和目的地 bucket 的位置。例如：us-west1。
   • BUCKET_NAME：來源 bucket 的名稱，其中包含要編輯的庫存報表設定。

3. 建立 JSON 檔案，其中包含要編輯的屬性變更。以下範例會更新庫存報表設定，以 Apache Parquet 格式每日產生庫存報表：

   {
     "ReportConfig": {
       "frequency_options": {
         "frequency": "DAILY"
       },
       "parquet_options": {
       }
     }

4. 如要套用庫存報表設定，請使用 cURL 呼叫 JSON API，並傳送 Patch ReportConfig 要求：

   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：來源和目的地 bucket 所在的專案名稱。

   • LOCATION 替換為來源和目的地 bucket 的位置。例如：us-west1。

   • REPORT_CONFIG_UUID 替換為自動生成的庫存報表設定 UUID。

JSON API

1. 安裝並初始化 gcloud CLI，以便為 Authorization 標頭產生存取權杖。

2. 您可以使用列出庫存報表設定的要求，列出專案中特定位置的所有庫存報表設定：

   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：來源和目的地 bucket 所在的專案名稱。

   • LOCATION 替換為來源和目的地 bucket 的位置。例如：us-west1。

   如要列出特定來源 bucket 中的所有商品目錄報表設定，請在要求中附加 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：來源和目的地 bucket 所在的專案名稱。

   • LOCATION 替換為來源和目的地 bucket 的位置。例如：us-west1。

   • BUCKET_NAME 替換為來源 bucket 的名稱，該 bucket 包含要列出的庫存報表設定。

JSON API

下載個別報表

如要下載商品目錄報表，請完成下列步驟：

1. 安裝並初始化 gcloud CLI，以便為 Authorization 標頭產生存取權杖。

2. 使用 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：來源和目的地 bucket 所在的專案名稱。

   • LOCATION 替換為來源和目的地 bucket 的位置。例如：us-west1。

   • REPORT_CONFIG_UUID 替換為自動生成的 UUID，該 UUID 屬於產生您要下載報表的盤點報表設定。

3. 如要取得個別報表的詳細資料，請使用 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：來源和目的地 bucket 所在的專案名稱。

   • LOCATION 替換為來源和目的地 bucket 的位置。例如：us-west1。

   • REPORT_CONFIG_UUID 替換為自動生成的 UUID，該 UUID 屬於產生您要下載報表的盤點報表設定。

   • 將 REPORT_DETAIL_ID 替換為要下載的庫存報表名稱。

下載報表 shard

如要下載已分割成一或多個 shard 的庫存報表，請完成下列步驟：

1. 安裝並初始化 gcloud CLI，以便為 Authorization 標頭產生存取權杖。

2. 如要下載清查報表的資訊清單檔案，請使用 cURL 透過 GET 物件要求呼叫 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：目的地 bucket 的名稱。

   • MANIFEST_FILE_NAME：目的地 bucket 中的資訊清單檔案名稱，命名慣例如下：

     REPORT_CONFIG_UUID_TARGET_DATETIME_manifest.json

     其中：

     • REPORT_CONFIG_UUID 是自動生成的 UUID，代表產生您要下載的報表 shard 的庫存報表設定。

     • TARGET_DATETIME 是產生商品目錄報表的日期。

   例如 fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:00_manifest.json。

   資訊清單檔案的 report_shards_file_names 欄位包含可下載的庫存報表 shard 名稱。

3. 如要下載盤點報表 shard 檔案，請使用 curl 呼叫 Cloud Storage JSON API，並傳送 Get 物件要求：

   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 替換為包含清查報表的目標 bucket 名稱。例如：my-bucket。

   • SHARD_FILE_NAME：要下載的 shard 檔案名稱，須經過網址編碼。例如：fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:54_0.csv。

JSON API

如要刪除盤點報表設定，請完成下列步驟：

1. 安裝並初始化 gcloud CLI，以便為 Authorization 標頭產生存取權杖。

2. 如要刪除清查報表設定，請使用 cURL 呼叫 JSON API，並傳送 Delete ReportConfig 要求：

   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：來源和目的地 bucket 所在的專案名稱。

   • LOCATION 替換為來源和目的地 bucket 的位置。例如：us-west1。

   • 將 REPORT_CONFIG_UUID 替換為要刪除的庫存報表設定自動產生的 UUID。

force 查詢參數會刪除指定庫存報表設定產生的所有庫存報表中繼資料。但不會刪除清查報表物件本身。