* Prerequisites: Follow the on-boarding guide: {URL OR SOMETHING} *
* Fill in your AWS access credentials in the provided credentials file * template, and be sure to move the file to the default location * (~/.aws/credentials) where the sample code will load the credentials from. *
* WARNING: To avoid accidental leakage of your credentials, DO NOT keep * the credentials file in your source directory. *
* http://aws.amazon.com/security-credentials */ public class MarketplaceCommerceAnalyticsSample { public static void main(String[] args) throws ParseException { /* * The ProfileCredentialsProvider will return your [default] * credential profile by reading from the credentials file located at * (~/.aws/credentials). */ AWSCredentials credentials = null; try { credentials = new ProfileCredentialsProvider().getCredentials(); } catch (Exception e) { throw new AmazonClientException("Cannot load the credentials from the credential profiles " + "file. Make sure that your credentials file is at the correct " + "location (~/.aws/credentials), and is in valid format.", e); } AWSMarketplaceCommerceAnalyticsClient client = new AWSMarketplaceCommerceAnalyticsClient(credentials); Region usEast1 = Region.getRegion(Regions.US_EAST_1); client.setRegion(usEast1); System.out.println("==============================================================="); System.out.println("Getting Started with AWS Marketplace Commerce Analytics Service"); System.out.println("===============================================================\n"); // Create a data set request with the desired parameters GenerateDataSetRequest request = new GenerateDataSetRequest(); request.setDataSetType("customer_subscriber_hourly_monthly_subscriptions"); request.setDataSetPublicationDate(convertIso8601StringToDateUtc("2014-06-09T00:00:00Z")); request.setRoleNameArn("arn:aws:iam::864545609859:role/MarketplaceCommerceAnalyticsRole"); request.setDestinationS3BucketName("awsmp-goldmine-seller"); request.setDestinationS3Prefix("java-sdk-test"); request.setSnsTopicArn("arn:aws:sns:us-west-2:864545609859:awsmp-goldmine-seller-topic"); System.out.println( String.format("Creating a request for data set %s for publication date %s.", request.getDataSetType(), request.getDataSetPublicationDate())); try { // Make the request to the service GenerateDataSetResult result = client.generateDataSet(request); // The Data Set Request ID is a unique identifier that you can use to correlate the // request with responses on your Amazon SNS topic System.out.println("Request successful, unique ID: " + result.getDataSetRequestId()); } catch (AmazonServiceException ase) { System.out.println("Caught an AmazonServiceException, which means your request made it " + "to the AWS Marketplace Commerce Analytics service, but was rejected with an " + "error response for some reason."); System.out.println("Error Message: " + ase.getMessage()); System.out.println("HTTP Status Code: " + ase.getStatusCode()); System.out.println("AWS Error Code: " + ase.getErrorCode()); System.out.println("Error Type: " + ase.getErrorType()); System.out.println("Request ID: " + ase.getRequestId()); } catch (AmazonClientException ace) { System.out.println("Caught an AmazonClientException, which means the client encountered " + "a serious internal problem while trying to communicate with the AWS Marketplace" + "Commerce Analytics service, such as not being able to access the " + "network."); System.out.println("Error Message: " + ace.getMessage()); } } private static Date convertIso8601StringToDateUtc(String dateIso8601) throws ParseException { TimeZone utcTimeZone = TimeZone.getTimeZone("UTC"); DateFormat utcDateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssX"); utcDateFormat.setTimeZone(utcTimeZone); return utcDateFormat.parse(dateIso8601); } } ``` 正常な結果はこの例に似たものとなります。 ``` =============================================================== Getting Started with AWS Marketplace Commerce Analytics Service =============================================================== Creating a request for data set customer_subscriber_hourly_monthly_subscriptions for publication date Sun Jun 08 17:00:00 PDT 2014. Request successful, unique ID: c59aff81-6875-11e5-a6d8-fd5dbcaa74ab ``` # AWS Marketplace Commerce Analytics Service を使用したデータセットの生成 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` 個のパラメータ AWS Marketplace Commerce Analytics Service では、1 つのメソッド `GenerateDataSet` が公開されます。このメソッドを使用すると、Amazon S3 バケットにデータセットの公開をリクエストできます。次の表に `GenerateDataSet` のパラメータの一覧を示します。 **データセットのパラメータ** | **フィールド** | **説明** | | --- | --- | | Data Set Type | このデータセットはリクエストの結果として返されます。 | | Data Set Publication Date | データセットの発行日。 日別データセットでは、該当日の日付が日単位の粒度で提供されます。 月別データセットでは、該当月の日付が月単位の粒度で提供されます。日付の値は無視されます。 | | Role Name ARN | ロールの ARN の後に、リソースへのアクセス権を持つサービスを提供するアクセス権限ポリシーが続いています。 | | Destination Amazon S3 Bucket Name | 送信先 Amazon S3 バケットの名前 (ARN ではなくフレンドリ名)。データセットはこの場所に発行されます。 | | Destination Amazon S3 Prefix | (オプション) データセットの発行先である Amazon S3 のプレフィックス。標準ファイルシステムのディレクトリパスに似ています。 例えば、バケットの名前が `mybucket` であり、プレフィックスが `myprefix/mydatasets` の場合、出力ファイルは `s3://amzn-s3-demo-bucket/myprefix/mydatasets/outputfile` に発行されます。 プレフィックスのディレクトリ構造が存在しない場合は作成されます。 プレフィックスを指定しないと、データセットの発行先は Amazon S3 バケットのルートになります。 | | SNS トピックの ARN | データセットの発行時またはエラーの発生時に通知先となる Amazon SNS トピックの ARN。 | ## レスポンス 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 リクエストが成功すると、リクエストしたデータセットは .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)を参照してください。 # Commerce Analytics Service AWS Marketplace のトラブルシューティング Commerce Analytics Service AWS Marketplace の問題をトラブルシューティングできます。このサービスでは、製品と顧客のデータをプログラムで提供します AWS Marketplace。エラーやその他の設定の問題が発生した場合は、Commerce Analytics Service のトラブルシューティングが必要になる場合があります。以下のセクションでは、Commerce Analytics Service でよくある問題を診断して解決する手順を説明するトラブルシューティングプロセスについて説明します。 **許可リストの問題のため、サービスにアクセスできません。** で販売者としてまだ登録していない場合は AWS Marketplace、 [AWS Marketplace 管理ポータル](https://aws.amazon.com/marketplace/management) にアクセスして登録します。販売者として登録済みの場合は AWS Marketplace、 [https://aws.amazon.com/marketplace/management/contact-us/](https://aws.amazon.com/marketplace/management/contact-us/) チームにお問い合わせください。 **過去の日付のデータセットをリクエストできません。ただし、SDK ドキュメントでは、この日付のデータが利用可能となっています。** 過去の特定の日付に関するデータセットが利用可能であると記載されていても、利用できるのは AWS Marketplaceに参加した時点以降のデータのみです。エラーが発生したと思われる場合は、[https://aws.amazon.com/marketplace/management/contact-us/](https://aws.amazon.com/marketplace/management/contact-us/) チームまでお問い合わせください。 **このサービスを呼び出すと、「Could not connect to the endpoint URL: https://marketplacecommerceanalytics.eu-central-1.amazonaws.com/」というエラーメッセージが表示されます。** Commerce Analytics Service AWS Marketplace は、米国東部 (バージニア北部) リージョンでのみ使用できます。Commerce Analytics Service へのすべての呼び出しは `us-east-1` エンドポイントに対して行う必要があります。 を使用している場合は AWS CLI、次の例に示すように、各呼び出しに`--region`「 フラグを追加し`us-east-1`、 を AWS リージョン として指定します。 ``` aws marketplacecommerceanalytics generate-data-set \ --data-set-type "customer_subscriber_hourly_monthly_subscriptions" \ --data-set-publication-date "2016-04-21T00:00:00Z" \ --role-name-arn "arn:aws:iam::138136086619:role/MarketplaceCommerceAnalyticsRole" \ --destination-s3-bucket-name "marketplace-analytics-service" \ --destination-s3-prefix "test-prefix" \ --sns-topic-arn "arn:aws:sns:eu-central-1:138136086619:Marketplace_Analytics_Service_Notice" \ --region us-east-1 ``` **オンボーディングプロセスで選択したのとは別の Amazon S3 バケットまたは別の Amazon SNS トピックを使用するにはどうすればいいですか。** Commerce Analytics Service AWS Marketplace に登録するときに、Amazon S3 バケットと Amazon SNS トピックを指定しました。オンボーディングプロセスでは、サービスがこれらの特定のリソースにのみアクセスできるように IAM 権限を設定します。別のリソースを使用するには、IAM ポリシーを変更する必要があります。 1. にサインイン AWS マネジメントコンソール し、[https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/) で IAM コンソールを開きます。 1. IAM コンソールの左側にある [**ロール**] を選択します。 1. [**MarketplaceCommerceAnalyticsRole**] を選択します。 1. [**Inline Roles (インラインロール)**] セクションが展開されていない場合は展開します。 1. *oneClick\$1MarketplaceCommerceAnalyticsRole* で始まる名前のポリシーを探し、**[Edit Policy]** を選択します。 1. そのポリシードキュメントで、変更するサービスに関連するアクションが指定されているセクションを見つけます。例えば、Amazon S3 バケットを変更するには、**s3:** で始まるアクションが含まれているセクションを見つけ、各**リソース**の選択肢を新しい Amazon S3 バケットに変更します。 IAM ポリシーの詳細については、「[https://docs.aws.amazon.com/IAM/latest/UserGuide/access\$1policies.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 **`GenerateDataSet` アクションを呼び出すと、`AccessDeniedException` エラーが表示される** これは、`GenerateDataSet` を呼び出すために必要なアクセス許可がユーザーにない場合に発生することがあります。以下の手順は、IAM コンソールを使用してこれらの権限を持つ IAM ポリシーを作成し、ユーザー、グループ、またはロールにアクセス許可を追加するために必要な手順の概要を示しています。 **JSON ポリシーエディタでポリシーを作成するには** 1. にサインイン AWS マネジメントコンソール し、[https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/) で IAM コンソールを開きます。 1. 左側のナビゲーションペインで、**[ポリシー]** を選択します。 初めて **[ポリシー]** を選択する場合には、**[管理ポリシーにようこそ]** ページが表示されます。**今すぐ始める** を選択します。 1. ページの上部で、**[ポリシーを作成]** を選択します。 1. **ポリシーエディタ** セクションで、**JSON** オプションを選択します。 1. 次の JSON ポリシードキュメントを入力します。 ``` { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "marketplacecommerceanalytics:GenerateDataSet", "Resource": "*" } ] } ``` 1. **次へ** を選択します。 **注記** いつでも **Visual** と **JSON** エディタオプションを切り替えることができます。ただし、**[ビジュアル]** エディタで **[次へ]** に変更または選択した場合、IAM はポリシーを再構成してビジュアルエディタに合わせて最適化することがあります。詳細については、*IAM ユーザーガイド* の [ポリシーの再構成](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_policies.html#troubleshoot_viseditor-restructure) を参照してください。 1. **確認と作成** ページで、作成するポリシーの **ポリシー名** と **説明** (オプション) を入力します。**このポリシーで定義されているアクセス許可** を確認して、ポリシーによって付与されたアクセス許可を確認します。 1. **ポリシーを作成** をクリックして、新しいポリシーを保存します。 アクセス権限を付与するにはユーザー、グループ、またはロールにアクセス許可を追加します。 + 以下のユーザーとグループ AWS IAM アイデンティティセンター: アクセス許可セットを作成します。「*AWS IAM アイデンティティセンター ユーザーガイド*」の「[アクセス許可セットを作成する](https://docs.aws.amazon.com//singlesignon/latest/userguide/howtocreatepermissionset.html)」の手順に従ってください。 + IAM 内で、ID プロバイダーによって管理されているユーザー: ID フェデレーションのロールを作成します。詳細については *IAM ユーザーガイド* の [サードパーティー ID プロバイダー (フェデレーション) 用のロールを作成する](https://docs.aws.amazon.com//IAM/latest/UserGuide/id_roles_create_for-idp.html) を参照してください。 + IAM ユーザー: + ユーザーが担当できるロールを作成します。手順については *IAM ユーザーガイド* の [IAM ユーザーのロールの作成](https://docs.aws.amazon.com//IAM/latest/UserGuide/id_roles_create_for-user.html) を参照してください。 + (お奨めできない方法) ポリシーをユーザーに直接アタッチするか、ユーザーをユーザーグループに追加します。*IAM ユーザーガイド* の [ユーザー (コンソール) へのアクセス許可の追加](https://docs.aws.amazon.com//IAM/latest/UserGuide/id_users_change-permissions.html#users_change_permissions-add-console) の指示に従います。 **ここに記載されていない問題。** [https://aws.amazon.com/marketplace/management/contact-us/](https://aws.amazon.com/marketplace/management/contact-us/) チームまでお問い合わせください。