翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# AWS Marketplace Commerce Analytics Service を使用したデータセットの生成
<a name="technical-documentation"></a>

AWS Marketplace Commerce Analytics Service に登録すると、AWS CLI と AWS SDK for Java を通じて使用状況レポート、サブスクリプションレポート、および請求レポートにアクセスできます。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](#outputs)

## `GenerateDataSet` 個のパラメータ
<a name="generate-data-set-parameters"></a>

AWS Marketplace Commerce Analytics Service では、1 つのメソッド `GenerateDataSet` が公開されます。このメソッドを使用すると、Amazon S3 バケットにデータセットの公開をリクエストできます。次の表に `GenerateDataSet` のパラメータの一覧を示します。


**データセットのパラメータ**  

| **フィールド** | **説明** | 
| --- | --- | 
| Data Set Type | このデータセットはリクエストの結果として返されます。 | 
| Data Set Publication Date  | データセットの発行日。<br />日別データセットでは、該当日の日付が日単位の粒度で提供されます。<br />月別データセットでは、該当月の日付が月単位の粒度で提供されます。日付の値は無視されます。 | 
| Role Name ARN | ロールの ARN の後に、リソースへのアクセス権を持つサービスを提供するアクセス権限ポリシーが続いています。 | 
| Destination Amazon S3 Bucket Name | 送信先 Amazon S3 バケットの名前 (ARN ではなくフレンドリ名)。データセットはこの場所に発行されます。 | 
| Destination Amazon S3 Prefix | (オプション) データセットの発行先である 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 の 2 つのレスポンスが返されます。1 つ目は同期で即座に返され、2 つ目は非同期でこれは Amazon SNS を使用して返されます。同期のレスポンスは次の例のようになります。


**データセットパラメータ**  

| **フィールド** | **説明** | 
| --- | --- | 
| Data Set Request ID  | サービスに対する特定のリクエストを表す一意の識別子。この識別子を使用して、リクエストを Amazon SNS トピックへの通知と関連付けることができます。 | 

非同期レスポンスが JSON 形式のドキュメントとして Amazon SNS トピックに書き込まれ、次の例のようになります。


**データセットのパラメータ**  

|  **フィールド**  |  **説明**  | 
| --- | --- | 
| Data Set S3 Location  | 配信されたデータセットのバケット名とキー。 | 
| Data Set Meta Data S3 Location  | 配信されたデータセットのメタデータファイルのバケット名とキー。 | 
| Data Set Request 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
 }
```

## Outputs
<a name="outputs"></a>

リクエストが成功すると、リクエストしたデータセットは .csv ファイルとして Amazon S3 バケットに配信されます。JSON 形式のメタデータファイルは、データセットファイルと同じ場所に発行されます。メタデータファイルは、データセットや元のリクエストのパラメータに関する有用な情報を提供します。メタデータファイル名は、データセットファイル名と同じですが、拡張子が .meta.json となります。次の表は、.csv ファイルのメタデータフィールドの一覧です。


**メタデータフィールド**  

|  **フィールド**  |  **説明**  | 
| --- | --- | 
| Data Set Request ID  | サービスに対する特定のリクエストを表す一意の識別子。この識別子を使用して、リクエストを Amazon SNS トピックへの通知と関連付けることができます。 | 
| Data Set Coverage Range  | データ範囲の開始日時と終了日時を定義します。これらの日時は ISO 8601 形式です。 | 
| Data Set Request Parameters  | GenerateDataSet メソッドへの元のリクエストパラメータ。 | 
| Data Set S3 Location  | 配信されたデータセットのバケット名とキー。 | 
| Data Set Meta Data S3 Location  | 配信されたデータセットのメタデータファイルのバケット名とキー。 | 

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)を参照してください。