この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

紹介イベントの作成

支持者が友達を紹介したとき、または紹介された友達がサインアップや購入を行ったときに、紹介イベントレコードを作成します。

このアクションは、API バージョン 60.0 以降で、Referral Marketing ライセンスを所有するユーザーが使用できます。

サポートされている REST HTTP メソッド

URI
/services/data/vXX.X/actions/standard/processReferralEvent
形式
JSON
HTTP のメソッド
POST
認証
Authorization: Bearer token

入力

入力 詳細
activityDateTime
DateTime
説明
必須。紹介イベントが実行された日時。
eventType
String
説明
必須。紹介が完了したイベントの種別。可能な値は次のとおりです。
  • Refer
  • Enrollment
  • Purchase
externalReferenceNumber
String
説明
外部システムで生成される紹介イベントの番号。
referralCode
String
説明
必須。被紹介者が顧客としてサインアップしたり、購入したりする際に使用する紹介コード。紹介コードは、支持者の紹介コードとプロモーションコードをハイフンで区切って組み合わせたものです。
referralContactId
String
説明
顧客としてサインアップした、または購入のためにサインアップした被紹介者の取引先責任者 ID。
referralEmail
String
説明
顧客としてサインアップした、または購入のためにサインアップした被紹介者のメールアドレス。
referralFirstName
String
説明
顧客としてサインアップした、または購入のためにサインアップした被紹介者の名。
referralLastName
String
説明
顧客としてサインアップした、または購入のためにサインアップした被紹介者の姓。
productId
String
説明
被紹介者が購入した商品の ID。
purchaseAmount
String
説明
被紹介者が 1 つ以上の商品単位の購入に費やした金額。
purchaseQuantity
String
説明
被紹介者が購入した商品の単位数。

出力

出力 詳細
contactId
String
説明
紹介で作成された、または紹介を一意に識別する取引先責任者レコードの ID。
referralId
String
説明
紹介された人、または紹介イベントが処理された人の紹介レコードの ID。
referralStage
String
説明
紹介プロモーションにおける紹介の現在のフェーズ。可能な値は次のとおりです。
  • Promotion Launched (プロモーション開始済み)
  • Advocate Joins Promotion (支持者がプロモーションに参加)
  • Advocate Refers Friend (支持者が友達を紹介)
  • Friend Signs Up (友達がサインアップ)
  • Friend Completes First Purchase (友達が初回購入を完了)
transactionJournalIds
String
説明
紹介イベントを処理するために作成された取引記録の ID のカンマ区切りのリスト。
voucherId
String
説明
サインアップする被紹介者に発行されるバウチャーの ID や、被紹介者が購入を完了した後に支持者に発行されるバウチャーの ID。

要求サンプル

1{
2   "inputs":[
3      {
4         "referralCode":"referralCode-promotionCode",
5         "referralContactId":"003xx000004WkhEAAS",
6         "referralFirstName":"Michael",
7         "referralLastName":"Clare",
8         "referralEmail":"mclare@salesforce.com",
9         "activityDateTime":"2021-04-13T00:00:00",
10         "eventType":"Purchase",
11         "productId":"01txx0000006iGyAAI",
12         "purchaseAmount":40000,
13         "purchaseQuantity":34,
14         "externalReferenceNumber":"003xx00000000fxEAA"
15      }
16   ]
17}

応答サンプル

1[
2   {
3      "actionName":"processReferralEvent",
4      "errors":null,
5      "isSuccess":true,
6      "outputValues":{
7         "contactId":"003RM000008O9ZT",
8         "transactionJournalIds":[
9            "0lVRM0000002qtT",
10            "0lVRM0000002qtU"
11         ],
12         "referralId":"0wiRM0000004CPf",
13         "referralStage":"Friend Completes First Purchase",
14         "voucherId":"0kDRM0000004DZl2AM"
15      },
16      "version":1
17   }
18]