CRM拡張機能を使用すると、HubSpotのコンタクト／会社／取引オブジェクトについて外部のシステムからの情報を表示できます。そのためにはカスタム タイムライン イベントを作成し、タイムライン イベント エンドポイントを使用します。ユーザーによるデータ編集を可能にする際に、ニーズを満たせるネイティブオブジェクトがない場合は、カスタムオブジェクトによってニーズを満たせるかどうかを検討してみてください。
使用例：自社とのやり取りやコンテンツに基づいて、コンタクトのセグメンテーションを強化したいとします。そのためには、さらに多くの情報が必要です。コンタクトとのやり取りに関して詳細なコンテキスト情報を示すカスタムイベント（最近のウェビナーへの登録のみで欠席したコンタクト、コンタクトが登録を完了したフローなど）を、アプリで作成することが考えられます。
タイムライン イベント テンプレートの削除に関する注意事項
テンプレートを削除すると、テンプレートを使用していた既存のイベントが、アプリが接続されているアカウントから完全に削除されます。そのタイプのイベントは新規に作成できなくなりますが、リストやレポートでは従来から存在しているタイプのイベントデータは確認できます。この変更がHubSpotに反映されるまでに数時間かかる場合があります。
タイムラインイベントの設定
タイムラインイベントの例を以下に示します。
1. イベントテンプレートの作成
イベントを作成するには、事前にイベントテンプレートを作成しておく必要があります。イベントテンプレートでは、HubSpotの中のコンタクト、会社、または取引オブジェクトのタイムラインにアプリが追加するアクションを記述します。アクションの例としては、動画表示、ウェビナー登録、アンケート記入などがあります。アプリごとに、最大750件のイベントテンプレートを作成できます。
既定では、イベントテンプレートはコンタクトに対して作成されますが、objectTypeフィールドを使用することによって会社や取引について作成することもできます。詳細は、タイムライン イベント テンプレートの作成に関する説明を参照してください。
イベントテンプレートごとに、トークンとテンプレートの固有のセットがあります。コンタクトに対して作成されたイベントは、新しいコンタクトリストまたはワークフローを作成する際の条件として使用できます。例：動画名にXYZが含まれる動画にいいね！を付けた全てのコンタクトのリストを作成する（イベントトークン「video name」が設定されたイベントテンプレート「Video Like」を作成）
APIによるイベントテンプレートの作成
この例では、新しいイベントテンプレート「Example Webinar Registration」を作成します。認証には開発者APIキーを使用します。
UIでのイベントテンプレートの作成
APIによるタイムライン イベント テンプレートの作成および管理に加えて、HubSpot開発者アカウントでイベントテンプレートを管理することもできます。
アプリの設定から［タイムラインイベント］に進み、［イベントタイプを作成］ボタンを使用してアプリ用の新しいイベントテンプレートを作成します。以前に作成したイベントテンプレートがある場合は、ここに表示されます。
新しいイベントテンプレートの下書きから始めます。イベントのオブジェクトタイプ、さらに詳細テンプレートとヘッダーテンプレートを設定したら、［作成］をクリックします。
イベントテンプレートの作成または編集を行う際には、使用するトークンを［データ］タブで設定します。
2. イベントトークンの定義
イベントテンプレートを定義したら、トークンも定義してみてください。イベント テンプレート トークンを使用することにより、カスタムデータをイベントに添付できます。カスタムデータは、タイムラインに表示したり、リストセグメンテーションに使用したりできます。1つのタイムライン イベント テンプレートにつき最大500件のトークンを作成できます。
APIによるイベントトークンの作成
ステップ1で作成したイベントテンプレートIDを使用して、コンタクトが登録しているウェビナーを特定するためのトークンを追加します。
#formatDateディレクティブの使用にも注目してください。ユーザーにとって分かりやすい日付形式にするために定義しています。
このようにコンタクトに関するイベントを作成すると（後述のイベントの作成を参照）、コンタクトのタイムラインに次のように表示されます。
［詳細を表示］をクリックすると、詳細テンプレートが表示されます。
イベントの横に表示されるアイコンを設定するには、後述のカスタムアイコンの設定を参照してください。
ここでの「Example App Name」というテキストはアプリの名前です。CRMタイムライン内では、アプリ単位でイベントを絞り込むことができます。
4. 1回の呼び出しでイベントテンプレートの全ての要素を定義する
ここまではイベントテンプレートの各要素を紹介してきましたが、1回のPOST呼び出しで全ての要素を定義できます。
これにより、a.test.contact@email.comのタイムライン上にイベントが生成されます（前述の「テンプレートの定義」のテンプレートがある前提で）。
開発者APIキーは開発者アカウントからの設定専用であるため、イベントの作成には使用できません。イベントを作成するためには、HubSpotアカウントから貴社のアプリにOAuth（英語）経由でアクセス権限を付与してもらう必要があります。アクセストークン（英語）を入手したら、アクセストークンを使用してアカウントのコンタクトにイベントを追加できます。
イベントタイムスタンプの設定
イベントがオブジェクト内のタイムラインに現れる位置は、イベントのタイムスタンプによって決まります。イベントタイムスタンプには、既定でPOSTコマンドの送信時刻が設定されます。イベント時刻は、タイムスタンププロパティーのリクエスト本文に明示することによりカスタマイズできます。
「View external data」リンクを含む、次のイベントが作成されます。
このリンクをクリックするとモーダルウィンドウが表示され、urlに設定されているページが表示されます。
8. CRMオブジェクトのプロパティーに対するイベントデータの付加
イベントを追加するコンタクト、会社、取引のプロパティーに、変更が必要になるケースは少なくありません。特に、イベントを追加することでコンタクトが作成される場合が該当します。Eメールアドレスとイベントだけのコンタクトを作成しないためにも、コンタクトの姓名のプロパティーを更新する必要があるはずです。
カスタム イベント トークンをコンタクト、会社、または取引のプロパティーにマッピングすることにより、イベントからの関連オブジェクトのデータを付加することができます。
カスタム イベント テンプレートを更新するための次のPUTの中で、objectPropertyNameフィールドに注目してください。
注：イベントトークンがカスタムプロパティーに付加される際に該当するカスタムプロパティーがHubSpotアカウント上に存在しない場合、イベントには値が設定されますが、対応するオブジェクト側では無視されます。
9. extraDataについて
イベント テンプレート トークンによって使用される「トークンと値」の単純な構造が適さない詳細なデータを、イベントに追加することが必要になるかもしれません。あるいは連携のイベントに、リストまたは階層状の内訳が必要になる場合も考えられます。こうした状況で役立つのがextraDataです。
extraData属性をイベントのJSON本文に追加することができます。このextraDataの値として、任意の有効なJSONを指定できます。例：
タイムラインイベントには次のように表示されます。
注：extraData属性は、イベントの詳細テンプレート内でのみ参照できます。ヘッダーテンプレートやリストセグメンテーションの中では使用できません。
10. カスタムアイコンの設定
タイムライン上の項目にビジュアル効果を付けるために、必要に応じてカスタムアイコンを追加できます。
アイコンには、次のような画像ファイルを使用してください。
- ほぼ正方形に近い形
- 背景を透過にする
- コンテンツをアイコンの中央に配置する
- 30×30ピクセルまで縮小可能
- ファイルサイズが5MB以下
タイムラインイベントに使用するアイコンを設定するには、［タイムラインイベント］に進みます。プレースホルダー画像または既存のアイコンをクリックして、設定または変更します。
設定したアイコンは、アプリに関連する全てのタイムラインイベントの横に表示されます。
