対象プランOFFLINEBUSINESSPRO
API連携を行う場合、以下のIDを利用する場合があります。各IDの簡単な取得方法をご紹介しますので、ご参考ください。
ID | 説明 |
eventKey | イベント毎に生成されるKey |
ticketId | [基本設定]>[チケット・フォーム]で作成したチケット・フォーム毎に生成されるID |
customFieldId | [基本設定]>[プロフィール項目]で作成したカスタム項目毎に設定するID |
questionnaireId | [アンケート]で作成したアンケート毎に生成されるID |
1. eventKey
該当イベント管理画面へアクセスした際にリンクバーに表示される英数字、もしくはログインページURL末尾に表示される英数字がeventKeyです。
例)https://cms.eventhub.jp/e/xxxxxxxxx/eventsetting
2. ticketId
[基本設定]>[チケット・フォーム]から作成したチケットフォームへアクセスした際にリンクバーに表示される英数字がticketIdです。
例)https://event.eventhub.jp/form/xxxxxxx-xxxx-xxxx-xxxxx-xxxxxxxxxx/formprofile?isTicketSelected=true
3. customFieldId
[基本設定]>[プロフィール項目]に表示される[項目ID]がcustomFieldIdです。
項目の作成時に、任意でIDを設定することができます。そのため、以下のようにイベントを跨いで固定のIDを作ることが可能です。同じ項目を複数イベントで利用する場合は、固定のIDを作るとMAとの連携がしやすくなります。
IDに設定できる文字列について
- 半角英数字20文字以下で、記号は使えません
- 数字のみは設定できません
- 先頭の文字が英字である必要があります
- 1つのイベントで同じIDの項目を複数作ることはできませんが、イベントを跨いで特定のIDを使い回すことが可能です
- 大文字小文字は区別して認識されます
customFieldIdの名称を変更した後に、初期値のcustomFieldIdを確認する方法
<attention>連携エラー時にエラー文言内に表示されるcustomFieldIdは、任意の文字列に変更いただいた場合でも、初期値のcustomFieldIdが表示されるケースがあります。
例:"message":"Required customFields missing: 23602"} </attention>
初期値のcustomFieldIdは、[基本設定]>[プロフィール項目]から表示したいプロフィール項目の鉛筆マークをクリックすると、モーダル内にてご確認いただけます。
4. questionnaireId
[アンケート]から作成したアンケートへアクセスした際にリンクバーに表示される英数字がquestionnaireIdです。
例)https://event.eventhub.jp/e/xxxxxxx/survey/xxxxx-xxxxxx-xxxxxx-xxxxxx