Referral Event Input | Referral Marketing 開発者ガイド

次の例は、既存メンバーが友人の Michael Clare を紹介するイベントのペイロードです。

1{
2   "referralCode":"2G11QW4G-PROMOCODE2809",
3   "firstName":"Michael",
4   "lastName":"Clare",
5   "email":"mclare@salesforce.com",
6   "activityDateTime":"2023-09-13T00:00:00",
7   "eventType":"Refer",
8   "referralAdditionalAttributes":{
9      "attributes":{
10         "phoneNumber":"1234567890",
11         "emailOptOut":true
12      }
13   }
14}

次の例は、Michael Clare が紹介プログラムにサインアップするイベントのペイロードです。

1{
2   "referralCode":"2G11QW4G-PROMOCODE2809",
3   "contactId":"003xx000004WkhEAAS",
4   "activityDateTime":"2023-09-13T00:00:00",
5   "eventType":"Enrollment"
6}

次の例は、Michael Clare が商品を購入するイベントのペイロードです。

1{
2   "referralCode":"2G11QW4G-PROMOCODE2809",
3   "contactId":"003xx000004WkhEAAS",
4   "activityDateTime":"2023-09-13T00:00:00",
5   "eventType":"Purchase",
6   "productId":"01txx0000006iGyAAI",
7   "purchaseAmount":40000,
8   "purchaseQuantity":34,
9   "referralAdditionalAttributes":{
10      "attributes":{
11         "phoneNumber":"1234567890",
12         "emailOptOut":true
13      }
14   },
15   "transactionJournalAdditionalAttributes":{
16      
17   }
18}

次の例は、既存メンバーが複数の友人を紹介するイベントのペイロードです。

1{
2   "referralCode":"0UGUXMNA-promotiontest098",
3   "referralEmails":{
4      "emails":[
5         "kit.ryan@salesforce.com",
6         "amy.sh@salesforce.com"
7      ]
8   },
9   "activityDateTime":"2024-02-12T00:00:00",
10   "eventType":"Refer",
11   "referralAdditionalAttributes":{
12      "attributes":{
13         
14      }
15   },
16   "transactionJournalAdditionalAttributes":{
17      
18   }
19}

名前	型	説明	必須か省略可能	使用可能なバージョン
`activityDateTime`	String	紹介イベントが実行された日時。	省略可能この項目は、参加日が要求で指定されていない場合にのみ必須です。	59.0
`contactId`	String	紹介された友達の取引先責任者 ID。	省略可能紹介レコードが存在する場合は必須。	59.0
`email`	String	紹介された友達のメールアドレス。	省略可能紹介された友達の取引先責任者が存在しない場合のみ必須。	59.0
`eventType`	String	紹介された友達または支持者によって完了されたイベントの種別。可能な値は次のとおりです。 `Enrollment` `Purchase` `Refer`	必須	59.0
`firstName`	String	紹介された友達の名。	省略可能紹介された友達の取引先責任者が存在しない場合のみ必須。	59.0
`joiningDate`	String	紹介された友達が新規顧客として参加した日付。この項目は非推奨になりました。API バージョン 59.0 以降は、新しい `activityDateTime` 項目を使用してください。	省略可能この項目は、活動日時が要求で指定されていない場合にのみ必須です。	59.0
`lastName`	String	紹介された友達の姓。	省略可能紹介された友達の取引先責任者が存在しない場合のみ必須。	59.0
`orderReferenceId`	String	外部の購入注文 ID。この項目は、イベント種別が `Purchase` の場合に適用されます。	省略可能	59.0
`productId`	String	紹介によって購入された商品の ID。この項目は、イベント種別が `Purchase` の場合に適用されます。	省略可能	59.0
`purchaseAmount`	Double	紹介された友達によって購入された商品の価格。この項目は、イベント種別が `Purchase` の場合に適用されます。	省略可能	59.0
`purchaseQuantity`	Integer	紹介された友達が購入した数量。この項目は、イベント種別が `Purchase` の場合に適用されます。	省略可能	59.0
`referralAdditionalAttributes`	Map<String, String>	紹介された友達に関する追加情報のキーと値のペア。	省略可能	59.0
`referralCode`	String	紹介された友達がサインアップや購入を行う際に使用する紹介コード。紹介コードとプロモーションコードを組み合わせたもので、`referralCode-promotionCode` の形式になります。	必須	59.0
`referralEmails`	String[]	紹介された友達のメールアドレス。	省略可能	59.0
`transactionJournalAdditionalAttributes`	Map<String, String>	イベントに対して作成される取引記録の追加の詳細。	省略可能	59.0