scopes

スコープス

Get Checkout Session APIでどのようなbuyer情報を取得するかを指定するためのものです。
Amazon Payボタンのレンダリングスクリプトの中に設定します。

tip

Amazon Payの決済セッション (Checkout Session)では、お届け先や支払い方法をAmazonから連携しますが、それ以外にbuyer情報も連携することができます。

サポートされている値:

'name' - 購入者の氏名
'email' - 購入者のメールアドレス
'phoneNumber' - 既定の請求先住所に紐づく電話番号
'billingAddress' - 既定の請求先住所

scopesの中にいずれかの値 (1つ以上)を設定することで、Get Checkout Session APIのレスポンスの中に以下のような形で情報が含まれてきます（以下はすべての値を指定した場合のレスポンスサンプルです）。

"buyer": {
    "buyerId": "buyerId",
    "name": "name-1",
    "email": "name@amazon.com",
    "phoneNumber": "800-000-0000",
    "primeMembershipTypes": null
},
"billingAddress":{
    "name": "Work",
    "addressLine1": "440 Terry Ave",
    "addressLine2": "",
    "addressLine3": "",
    "city": "Seattle",
    "county": "King",    
    "district": "Seattle",
    "stateOrRegion": "WA",
    "postalCode": "98121",
    "countryCode": "US",
    "phoneNumber": "800-000-0000"
}

scopesを指定しない場合は、以下の値が返ります。

PayAndShipの場合

name
email

PayOnlyの場合

name
email
phoneNumber
billindAddress

caution

scopesの設定にかかわらず購入者がお支払い方法としてギフトカードのみを選択した場合には、phoneNumberとbillingAddressを取得できませんので、phoneNumberおよびbillingAddressを利用する実装を行う場合はご注意ください。
buyer情報を一つも取得しないという設定はありません。

基本的に必ず１つ以上の値をscopesに設定してください。