本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 使用 Commerce Analytics Service AWS Marketplace 產生資料集
<a name="technical-documentation"></a>

註冊 AWS Marketplace Commerce Analytics Service 之後，您可以透過 AWS CLI 和 存取您的用量、訂閱和帳單報告 適用於 Java 的 AWS SDK。您使用 SDK 工具請求的資料會以資料集 AWS 帳戶 的形式交付至您的 。大多數資料集對應到與 上可用的文字型報告相同的資料[AWS Marketplace 管理入口網站](https://aws.amazon.com/marketplace/management/tour)。如需詳細資訊，請參閱[使用 Commerce Analytics Service AWS Marketplace 存取產品和客戶資料](commerce-analytics-service.md)。這些區段提供有關 Commerce Analytics Service 產生之資料集的相關參數、回應和輸出的資訊。

**Topics**
+ [`GenerateDataSet` 參數](#generate-data-set-parameters)
+ [回應](#responses)
+ [輸出](#outputs)

## `GenerateDataSet` 參數
<a name="generate-data-set-parameters"></a>

 AWS Marketplace Commerce Analytics Service 公開了一種方法 `GenerateDataSet`，您可以用來請求將資料集發佈到您的 Amazon S3 儲存貯體。下表列出 的參數`GenerateDataSet`。


**資料集參數**  

| **欄位** | **Description** | 
| --- | --- | 
| 資料集類型 | 此資料集將作為請求的結果傳回。 | 
| 資料集發佈日期  | 資料集發佈的日期。<br />對於每日資料集，請提供所需日期的日層級精細程度。<br />對於每月資料集，請提供所需月份的月份層級精細程度日期。系統會忽略日值。 | 
| 角色名稱 ARN | 角色的 ARN 與連接的許可政策，該政策可讓 服務存取您的 資源。 | 
| 目的地 Amazon S3 儲存貯體名稱 | 目的地 Amazon S3 儲存貯體的名稱 （易記的名稱，而非 ARN)。您的資料集會發佈至此位置。 | 
| 目的地 Amazon S3 字首 | （選用） 已發佈資料集的 Amazon S3 字首，類似於標準檔案系統中的目錄路徑。<br />例如，如果指定儲存貯體名稱`mybucket`和字首 `myprefix/mydatasets`，輸出檔案會發佈至 `s3://amzn-s3-demo-bucket/myprefix/mydatasets/outputfile`。<br />如果字首目錄結構不存在，則會建立。<br />如果未提供字首，資料集會發佈至 Amazon S3 儲存貯體根目錄。 | 
| SNS Topic ARN (SNS 主題 ARN) |  發佈資料集或發生錯誤時通知的 Amazon SNS 主題 ARN。 | 

## 回應
<a name="responses"></a>

Commerce Analytics Service AWS Marketplace 會傳回兩個回應。第一個是同步，它會立即傳回，第二個是非同步，它會使用 Amazon SNS 傳回。同步回應類似於此範例。


**資料集參數**  

| **欄位** | **Description** | 
| --- | --- | 
| 資料集請求 ID  | 代表服務特定請求的唯一識別符。此識別符可用來將請求與 Amazon SNS 主題上的通知建立關聯。 | 

非同步回應會以 JSON 格式的文件發佈到您的 Amazon SNS 主題，與此範例類似。


**資料集參數**  

|  **欄位**  |  **Description**  | 
| --- | --- | 
| 資料集 S3 位置  | 已交付資料集的儲存貯體名稱和金鑰。 | 
| 資料集中繼資料 S3 位置  | 已交付資料集中繼資料檔案的儲存貯體名稱和金鑰。 | 
| 資料集請求 ID  | 代表服務特定請求的唯一識別符。此識別符可用來將請求與 Amazon SNS 主題上的通知建立關聯。 | 
| 成功  | 如果操作成功，則為「True」；如果失敗，則為「false」。 | 
| 訊息  | （選用） 如果發生錯誤 （例如，「成功」是「錯誤」)，此訊息會包含失敗的相關資訊。 | 

 **範例 JSON 格式的非同步回應** 

```
 {    
   "dataSetS3Location":{
      "bucketName":"demo-bucket",
      "key":"demo-prefix/customer_subscriber_hourly_monthly_subscriptions_2014-06-09.csv"
   },
   "dataSetMetaDataS3Location":{
      "bucketName":"demo-bucket",
      "key":"demo-prefix/customer_subscriber_hourly_monthly_subscriptions_2014-06-09.meta.json"
   },
   "dataSetRequestId":"f65b7244-6862-11e5-80e2-c5127e17c023",
   "success":true
 }
```

## 輸出
<a name="outputs"></a>

請求成功後，請求的資料集會以 .csv 檔案的形式交付到您的 Amazon S3 儲存貯體。JSON 格式中繼資料檔案會發佈到與資料集檔案相同的位置。中繼資料檔案提供有關資料集和原始請求參數的實用資訊。中繼資料檔案與資料集檔案的名稱相同，但結尾為副檔名 .meta.json。下表列出 .csv 檔案中的中繼資料欄位。


**中繼資料欄位**  

|  **欄位**  |  **Description**  | 
| --- | --- | 
| 資料集請求 ID  | 代表服務特定請求的唯一識別符。此識別符可用來將請求與 Amazon SNS 主題上的通知建立關聯。 | 
| 資料集涵蓋範圍  | 定義資料涵蓋範圍的開始日期/時間和結束日期/時間。這些日期採用 ISO 8601 格式。 | 
| 資料集請求參數  | GenerateDataSet 方法的原始請求參數。 | 
| 資料集 S3 位置  | 已交付資料集的儲存貯體名稱和金鑰。 | 
| 資料集中繼資料 S3 位置  | 已交付資料集中繼資料檔案的儲存貯體名稱和金鑰。 | 

以下是 JSON 格式中繼資料內容的範例。

```
{
"dataSetRequestId": "43d7137b-8a94-4042-a09d-c41e87f371c1",
"dataSetCoverageRange": {
"startDateTime": "2014-06-08T00:00:00.000Z",
"endDateTime": "2014-06-08T23:59:59.000Z"
},
"dataSetRequestParameters": {
"sellerAccountId": "123412341234",
"dataSetType": "customer_subscriber_hourly_monthly_subscriptions",
"dataSetPublicationDate": "2014-06-09T00:00:00.000Z",
"roleNameArn": "arn:aws:iam::123412341234:role/MarketplaceCommerceAnalyticsRole",
"destinationS3BucketName": "demo-bucket",
"destinationS3Prefix": "demo_prefix/customer_subscriber_hourly_monthly_subscriptions",
"snsTopicArn": "arn:aws:sns:us-west-2:123412341234:demo-topic"
},
"dataSetS3Location": {
"bucketName": "demo-bucket",
"key": "demo_prefix/customer_subscriber_hourly_monthly_subscriptions_2014-06-09.csv"
},
"dataSetMetaDataS3Location": {
"bucketName": "demo-bucket",
"key": "demo_prefix/customer_subscriber_hourly_monthly_subscriptions_2014-06-09.meta.json"
}
}
```

如需可用資料集的完整清單，包括可用性日期，請參閱 [AWS SDK 文件](https://docs.aws.amazon.com/cli/latest/reference/marketplacecommerceanalytics/generate-data-set.html#options)。