Product Support Connection - AWS Marketplace

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

Product Support Connection

AWS Marketplace製品Support 接続 (PSC) は、AWS Marketplace顧客が連絡先情報をAWS Marketplace製品サポートの取得とアクセスを目的としたウェブサイトAWS Marketplace販売者.AWS Marketplaceは、提供されたデータを API 経由で参加販売者に提供し、より良いサポート体験を実現します。顧客は、PSC 対応の AWS Marketplace 製品の購入中または購入後に連絡先の詳細を追加できます。販売者は、プルベースの API を呼び出すことによって、顧客の連絡先データを関連製品のサブスクリプションの詳細とともに取得できます。

スタッフはカスタマーSupport 資格ツールを使用してアクセスできます near-real-time製品に対する顧客のサブスクリプションに関する情報を提供し、高速でパーソナライズされたサービスを提供します。AWS Marketplace 管理ポータルによって簡単に開始できます。お客様の情報を入力してくださいAWS アカウントアカウントからサブスクリプションと使用情報を取得するための ID。

に製品を登録するオプションもありますAWS MarketplacePSC。PSCに登録されている製品については、AWS Marketplaceの顧客は連絡先情報 (名前、組織、E メールアドレス、電話番号など) を提供するように選択できますAWS Marketplace製品サポートの取得とアクセスを目的としたWebサイト。PSCに登録すると、AWS Marketplaceは、提供されたデータを API を介してユーザーと共有し、サポートエクスペリエンスをよりシームレスにすることができます。

注記

データ製品はこの機能をサポートしていません。

技術的な実装ガイド

このセクションでは、API 仕様の詳細および PSC 機能のオンボーディング方法について説明します。PSCstart-support-data-exportAPI オペレーションはAWS MarketplaceCommerce Analytics Service (CAS) PSC API と統合するには、まず CAS に登録する必要があります。CAS に登録済みの場合は、同じAWS Identity and Access Managementオンボーディング時に作成した (IAM) ロール。

PSC の IAM ポリシー

IAM ユーザーがAWS MarketplacePSC 機能では、次のインラインポリシーをユーザーにアタッチする必要があります。

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "marketplacecommerceanalytics:StartSupportDataExport", "Resource": "*" }, ] }

詳細については、次を参照してください。IAM コンソールでのポリシーの作成IAM ユーザーガイド

AWS CLI によるリクエストの作成

AWS CLI または AWS Software Development Kits (SDK) のいずれかを使用して、PSC データのエクスポートをリクエストできます。

CAS を既に使用してgenerate-data-setオペレーションでは、両方に同じ IAM ロールを使用する必要がありますgenerate-data-setそしてstart-support-data-export

Product Support Connection プログラムを介して利用可能な顧客の連絡先データのセキュリティを確保するために、用の Amazon Simple Storage Service (Amazon Simple Storage Service (Amazon S3) バケットは、start-support-data-export用の S3 バケットとは別にするgenerate-data-set。IAM ロールでのアクセス許可で、使用するすべての S3 バケットへのアクセスが許可されていることを確認します。

aws marketplacecommerceanalytics start-support-data-export --data-set-type "test_customer_support_contacts_data" \ --from-date “{START-DATE}” \ --role-name-arn "{YOUR-ROLE-NAME-ARN}” \ --destination-s3-bucket-name “{YOUR-S3-BUCKET}” \ --destination-s3-prefix “test-prefix” \ --sns-topic-arn “{YOUR-SNS-TOPIC-ARN}”

このサービスからの正常なレスポンスでは、dataSetRequestIdのリクエストの。

{ "dataSetRequestId": "646dd4ed-6806-11e5-a6d8-fd5dbcaa74ab" }

API のリクエストパラメータとレスポンス

StartSupportDataExport方法

StartSupportDataExport メソッドを使用すると、顧客が PSC 対応製品に対して送信した連絡先の詳細をリクエストできます。リクエストで指定した開始日から、リクエスト時刻の 15 分前までのデータがエクスポートされます。正常なリクエストでは、指定した Amazon Simple Storage Service (Amazon Simple Storage Service (Amazon S3 imple Stor

API をクエリして、test_customer_support_contacts_datadatasetは、実際の顧客データに該当しないデータを含む静的なテストデータセットをエクスポートします。このテストデータは、テストおよび統合に使用します。-customer_support_contacts_dataオプションは、PSC 対応製品の実際の顧客の連絡先データを表します。

パラメータのリクエスト

入力 説明
Data Set Type

エクスポートをリクエストするデータセットのタイプ。データセットで有効なオプションは次のとおりです。

test_customer_support_contacts_data

customer_support_contacts_data

開始日

エクスポートするデータの最も早い日付。エクスポートされるデータには、指定した From Date から、リクエストの時刻の最大 15 分前までのデータが含まれます。

From Date は、ISO 8601 の日付/時刻文字列として表現されている必要があります。

更新されたデータではなく完全なデータセットを受け取る場合は、プログラムに登録した日付より前の日付を指定します。前回のリクエスト以降の増分データのみを受け取るには、 endDateTimeからの dataSetCoverage前回のリクエストの結果として受け取ったメタデータ JSON ファイルからの範囲。メタデータ JSON ファイルの詳細については後述します。

Role Name ARN IAM ロールの Amazon リソースネーム (ARN) の後に、リソースへのアクセス権を持つサービスを提供するアクセス権限ポリシーが続いています。
Destination S3 Bucket Name 送信先 Amazon S3 バケットの名前 (ARN ではなくフレンドリ名)。この場所にデータセットが発行されます。
Destination S3 Prefix

(オプション) データセットの発行先のの Amazon S3 プレフィックス。標準ファイルシステムのディレクトリパスに似ています。標準ファイルシステムのディレクトリパスに似ています。標準ファイルシステム

たとえば、バケット名「」とプレフィックス「outputfile」を指定すると、出力ファイル「outputfile」は「outputfile」は「outputfile」は「outputfile」は「outputfile」で、出力ファイル「outputfile」DOC-EXAMPLE-BUCKET/myprefix/mydatasets/出力ファイル」。

プレフィックスのディレクトリ構造が存在しない場合は作成されます。

プレフィックスが指定されていない場合、データセットは Amazon S3 バケットのルートに発行されます。

SNS トピックの ARN データセットが発行されたとき、またはエラーが発生した場合に通知の送信先となる、Amazon SNS トピックの Amazon リソースネーム (ARN)。

レスポンス

この API を呼び出すと、Data Set Request ID が含まれているレスポンスがすぐに返されます。

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

メタデータが含まれている追加のレスポンスは、元のリクエストで指定した Amazon Simple Notification Service (Amazon SNS) トピックに指定されている Amazon Simple Notification Service ( 送信される内容を次の表に示します。

フィールド 説明
Data Set S3 Location 配信されたデータセットのバケット名とキー。
Data Set Meta Data S3 Location 配信されたデータセットのメタデータファイルのバケット名とキー。
Data Set Request ID サービスに対する特定のリクエストを表す一意の識別子。この識別子を使用して、リクエストを Amazon SNS トピックへの通知と関連付けることができます。
成功 オペレーションが成功した場合は「true」、それ以外の場合は「false」。
Message (オプション) エラーが発生した場合 (「Success」が「false」の場合など)、このメッセージは失敗に関する情報を示します。

メタデータファイルは JSON 形式で、次のフィールドが含まれています。

フィールド 説明
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 配信されたデータセットのメタデータファイルのバケット名とキー。
Request Received Date Time リクエストを受信した日時 (ISO 8601 形式)。
Request Completed Date Time リクエストを完了した日時 (ISO 8601 形式)。

例 JSON 形式のメタデータコンテンツ

{ "dataSetRequestId": "c3c84ee0-5aba-11e6-8d9c-235dc080841d", "dataSetCoverageRange": { "startDateTime": "2016-08-18T00:00:00.000Z", "endDateTime": "2016-08-05T03:14:50.334Z" }, "dataSetRequestParameters": { "fromDate": "2016-08-18T00:00:00.000Z", "dataSetType": "test_customer_support_contacts_data", "roleNameArn": "arn:aws:iam::123456789012:role/MarketplaceCommerceAnalyticsRole", "destinationS3BucketName": "mybucket", "destinationS3Prefix": "mydata", "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:mynotification" }, "dataSetS3Location": { "bucketName": "mybucket", "key": "mydata/test_customer_support_contacts_data_2015-01-18T00-00-00Z_to_2016-08-05T03-14-50Z.csv" }, "dataSetMetaDataS3Location": { "bucketName": "mybucket", "key": "mydata/test_customer_support_contacts_data_2015-01-18T00-00-00Z_to_2016-08-05T03-14-50Z.meta.json" }, "requestReceivedDateTime": "2016-08-05T03:14:50.108Z", "requestCompletedDateTime": "2016-08-05T03:14:50.334Z" }

出力データ形式

出力データには、顧客の連絡先レコード、製品コード、製品 ID、サブスクリプションの開始日付、およびAWS アカウント顧客の ID。フィールドの概要を次の表に示します。各出力ファイルには、カンマ区切りのヘッダーに続いて、顧客データおよびサブスクリプション情報のレコードが含まれています。各レコードには、API リクエストで指定された「From Date」以降にそのレコードが新規作成、更新、または削除されたことを表す「Create」、「Update」、「Delete」のいずれかのオペレーションタイプが含まれています。ファイル全体の形式は RFC4180 標準に準拠しています。

API リクエストの「from-date」パラメータで指定された期間内にレコードに対して複数のオペレーションが行われていた場合は、最新のデータのみが反映またはエクスポートされます。たとえば、顧客がレコードを作成した後に更新した場合、返されるレコードは、指定された「from-date」に応じて異なります。「from-date」が、レコードの作成日付より前である場合は、CREATE レコードのみが出力データセットに渡され、そのレコードには最後に入力された詳細情報が反映されます。「from-date」が、レコードの作成日付より後であり、更新される前である場合は、UPDATE レコードのみが出力データセットに渡されます。「from-date」がレコードの更新より後である場合は、レコードは渡されません。同様に、顧客がレコードを作成した後に削除した場合は、出力ファイルには DELETE レコードのみが存在します。

更新されたデータのセットだけではなく、データセット全体を受け取る場合は、プログラムに登録した日付より前の日付を指定します。前回のリクエスト以降の増分データのみを受け取るには、前回のリクエストの結果として受け取ったメタデータ JSON ファイルの dataSetCoverageRangeendDateTime を指定します。

フィールド [Format] (形式) 説明
製品 ID 36 文字の 16 進文字列。

AWS Marketplace における製品の一意の識別子 (GUID)。

必須フィールドであり、各レコードに必ず含まれています。

製品コード 25 文字の英数字の文字列。

請求に関連付けられていて、Amazon EElastic Compute Cloud (Amazon EC2) インスタンスメタデータで利用可能な、製品の一意の識別子。請求に関連付けられ

必須フィールドであり、各レコードに必ず含まれています。

Customer Guid 36 文字の 16 進文字列。

顧客の連絡先データレコードを識別する一意の GUID。この値は、出力ファイル内の各レコードで一意です。

必須フィールドであり、各レコードに必ず含まれています。

Subscription Guid 36 文字の 16 進文字列。

顧客の製品サブスクリプションに対応する一意の GUID。顧客は、1 つの製品に対して複数のサブスクリプションを持つことができます。

必須フィールドであり、各レコードに必ず含まれています。

サブスクリプション開始日

ISO 8601 形式の日時 (UTC タイムゾーン)。

「YYYY-MM-DDTHH:mm:ss.nnnZ」の形式です。ここで、YYYY は年、MM は月、DD は日、HH は時間 (00~23)、mm は分 (00~59)、ss は秒 (00~59)、nnn はミリ秒 (000~999) です (例: "2016-04-07T14:05:15.275Z")。

顧客の製品サブスクリプションの開始日付。

必須フィールドであり、各レコードに必ず含まれています。

組織 255 文字以内の文字列

顧客が指定した組織名。

オペレーションタイプが「Update」または「Create」のレコードには必ず存在します。オペレーションタイプが「Delete」のレコードには存在しません。

AWS カスタマー ID 12 桁の数値文字列 (12 桁未満の場合は先頭にゼロが入っている)

製品をサブスクライブしている顧客の AWS カスタマー ID。

必須フィールドであり、各レコードに必ず含まれています。

[Given Name] (名) 100 文字以内の文字列

顧客が指定した連絡先の名前。

オペレーションタイプが「Update」または「Create」のレコードには必ず存在します。オペレーションタイプが「Delete」のレコードには存在しません。

100 文字以内の文字列

顧客が指定した連絡先の姓。

オペレーションタイプが「Update」または「Create」のレコードには必ず存在します。オペレーションタイプが「Delete」のレコードには存在しません。

Telephone Number 25 文字以内の文字列。国際電話番号が含まれている場合があります。

顧客が指定した電話番号。

オペレーションタイプが「Update」または「Create」のレコードには必ず存在します。オペレーションタイプが「Delete」のレコードには存在しません。

Email(メール) 254 文字以内の文字列

顧客が指定したメールアドレス。

オペレーションタイプが「Update」または「Create」のレコードには必ず存在します。オペレーションタイプが「Delete」のレコードには存在しません。

[Title] (タイトル) 255 文字以内の文字列

顧客が指定した役職名。

オプションのフィールド。オペレーションタイプが「Update」または「Create」のレコードには存在することがあります。オペレーションタイプが「Delete」のレコードには存在しません。

国コード 2 文字の ISO 3166 国コード

顧客が指定した国コード。

オプションのフィールド。オペレーションタイプが「Update」または「Create」のレコードには存在することがあります。オペレーションタイプが「Delete」のレコードには存在しません。

ZIP コード 5 桁の文字列

顧客が指定した郵便番号 (米国のみに適用)。

オプションのフィールド。オペレーションタイプが「Update」または「Create」のレコードには存在することがあります。オペレーションタイプが「Delete」のレコードには存在しません。

Operation Time ISO 8601 形式の日時 (UTC タイムゾーン)。「YYYY-MM-DDTHH:mm:ss.nnnZ」の形式です。ここで、YYYY は年、MM は月、DD は日、HH は時間 (00~23)、mm は分 (00~59)、ss は秒 (00~59)、nnn はミリ秒 (000~999) です (例: "2016-04-07T14:05:15.275Z")。

このレコードを顧客が作成、更新、または削除した直近の日時を表します。

必須フィールドであり、各レコードに必ず含まれています。

オペレーションのタイプ 文字列。この値は「CREATE」、「UPDATE」、「DELETE」のいずれかです

作成: このレコードが、API リクエストで指定した from-date 以降に新しく新しく作成されたことを表します。

更新: このレコードが、API リクエストで指定した from-date 以降に更新されたことを表します。

削除: このレコードが、API リクエストで指定した from-date 以降に削除されたことを表します。

必須フィールドであり、各レコードに必ず含まれています。

出力ファイル形式の例を次に示します。

Product Id,Product Code,Customer Guid,Subscription Guid,Subscription Start Date,Organization,AWS Customer Id,Given Name,Surname,Telephone Number,Email,Title,Country Code,ZIP Code,Operation Time,Operation Type

4b898955-84fa-4cfb-8f43-98287ad69c06,4gzp2symm0v9zidfrn9f854w6,ba1d75cc-d984-4f07-bb14-ae04b952afbc,cad371fb-6f2c-4537-a054-1a7afc6312fd,2016-05-27T00:00:00.000Z,Example Inc -- Service Division,000011112222,Eugene,Thietmar,555-947-8228,eugethi@example.org,,,,2016-05-12T03:54:46.143Z,CREATE

4b898955-84fa-4cfb-8f43-98287ad69c06,4gzp2symm0v9zidfrn9f854w6,1b4a2b5f-2c5d-4779-b0c7-2878b0f45cfc,cad371fb-6f2c-4537-a054-1a7afc6312fd,2016-05-19T00:00:00.000Z,Example Inc -- Service Division,000011112222,Angela,Doe,555-294-4528,adoe@example.com,,US,02201,2016-05-19T18:21:06.834Z,CREATE

cade58ff-ff82-4770-b84b-0bd399bf1c6d,c0dcyyqczbk5uc62acmp6450t,6c83ff14-5167-43cc-bb9f-24865a78db72,c2f40319-8fc2-409a-884b-2f85adf9e29c,2015-12-01T00:00:00.000Z,Example Inc -- European Sales Division,111122223333,Ravi,Smith,555-111-1010,ravis@example.com,Head of IT,ES,,2016-04-07T14:05:15.145Z,CREATE

4b898955-84fa-4cfb-8f43-98287ad69c06,4gzp2symm0v9zidfrn9f854w6,1b4a2b5f-2c5d-4779-b0c7-2878b0f45cfc,cad371fb-6f2c-4537-a054-1a7afc6312fd,2016-05-01T00:00:00.000Z,,000011112222,,,,,,,,2016-04-22T14:36:24.054Z,DELETE

3f4300eb-bfa0-4610-8d68-d8ba71-baa50,3qtU9XYDXLD1c5jyldy1lqo,91c1c7://にせよ 5-11-30t 00:00:00 .000Z, Example Inc — デザイン部門、333344445555、ネイサン、ジェノユアン、555-2222-10://にせよ nathanz@example.com作成

3f4300eb-bfa0-4610-8d68-d8ba71baaa50,3qtu9xydxldrj8c5jyldy1lqo,2ae0be12-7397-4fdb-a1c7-ead17967002c,d118eb96-55ce-4752-909c-eedcfdcd6647,2016-05-01T00:00:00.000Z,Example Inc -- Design Division,333344445555,Abdul,Alves,555-676-8989,abdal@example.com,,,,2016-05-11T05:26:51.000Z,UPDATE

...

注記

顧客が PSC プログラムから連絡先情報を削除すると、出力の .csv ファイルに「DELETE」オペレーションタイプを示すレコードが表示されます。顧客がデータを削除すると、API は連絡先情報 (名前、電話番号、メールアドレスなど) を送信しなくなります。各 DELETE レコードは、削除するレコードを一意に識別するのに必要なデータで構成されています。DELETE レコードには、製品 ID、製品コード、顧客 GUID、サブスクリプション GUID、サブスクリプション開始日、AWS カスタマー ID、オペレーション時刻、オペレーションタイプが含まれています。

顧客が連絡先情報を削除することで Product Support Connection をオプトアウトした場合は、お客様のレコードから連絡先情報を削除する必要があります。顧客の連絡先データは DELETE レコードには含まれないため、システムでレコードを検索するには一意の顧客 GUID を使用する必要があります。

DELETE レコードは、顧客がサブスクリプションを終了した場合にも送信されます。

AWS Marketplace Product Support Connection に関する不明点や詳細については、AWS Marketplace Seller Operations チームまでお問い合わせください。