本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 使用 AWS Marketplace Commerce Analytics Service 生成数据集
<a name="technical-documentation"></a>

在 AWS Marketplace Commerce Analytics Service 中注册后，您可以通过 AWS CLI 和 适用于 Java 的 AWS SDK 查看自己的使用情况、订阅以及账单报告。您使用开发工具包工具请求的数据，将以数据集的形式交付到您的 AWS 账户。大多数数据集对应的数据与 [AWS Marketplace 管理门户](https://aws.amazon.com/marketplace/management/tour) 上提供的基于文本的报告相同。有关更多信息，请参阅 [使用 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` 的参数。


**数据集参数**  

| **字段** | **描述** | 
| --- | --- | 
| 数据集类型 | 此数据集将作为请求的结果返回。 | 
| 数据集发布日期  | 发布数据集的日期。<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 主题 ARN |  在发布数据集或者出现错误时，需要通知的 Amazon SNS 主题的 ARN。 | 

## 响应
<a name="responses"></a>

AWS Marketplace Commerce Analytics Service 返回两个响应。第一个是立即返回的同步响应，第二个是使用 Amazon SNS 返回的异步响应。同步响应类似于此示例。


**数据集参数**  

| **字段** | **描述** | 
| --- | --- | 
| 数据集请求 ID  | 表示对服务的特定请求的唯一标识符。此标识符可用于将请求与 Amazon SNS 主题上的通知关联。 | 

异步响应是 JSON 格式的文档，发布到 Amazon SNS 主题，与此示例类似。


**数据集参数**  

|  **字段**  |  **描述**  | 
| --- | --- | 
| 数据集 S3 位置  | 已交付数据集的存储桶名称和密钥。 | 
| 数据集元数据 S3 位置  | 已交付数据集元数据文件的存储桶名称和密钥。 | 
| 数据集请求 ID  | 表示对服务的特定请求的唯一标识符。此标识符可用于将请求与 Amazon SNS 主题上的通知关联。 | 
| 成功  | 如果操作成功，则为 True；否则为 False。 | 
| 消息  | （可选）如果出现错误（例如，“Success”为“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 文件中的元数据字段。


**元数据字段**  

|  **字段**  |  **描述**  | 
| --- | --- | 
| 数据集请求 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)。