使用例：アプリマーケットプレイスに掲載する、バグ追跡用ソフトウェアの連携を構築しています。サポート担当者がユーザーに対応する際に参照できるよう、コンタクトレコードに追跡対象のバグが表示されるようにしたいと考えています。この情報は、貴社のアプリにカスタムカードを定義することで、HubSpotコンタクトレコード上に表示できます。
カードはアプリの機能設定の一部として定義できます。アプリをインストールしたユーザーがターゲットのCRMレコードを表示すると、HubSpotはアプリにリクエストを送信して関連するデータを取得し、レコードページ上のカードにそのデータを表示します。アプリには、この情報に基づいてユーザーが実行できるカスタムアクションを指定することもできます。例えば、HubSpot内でアプリ独自のUIを表示するためのモーダルを開くアクションをアプリに組み込むことができます。
アプリのCRMカードは、APIを介して作成することも、開発者アカウントでアプリを編集するという方法で作成することもできます。APIを介してカードを設定する方法について詳しくは、この記事の上部にある［エンドポイント］タブをクリックしてご確認ください。
HubSpotのUIを使用してCRMカードを作成するには、次の手順に従います。
- HubSpot開発者アカウントで、メインナビゲーションにある［アプリ］に移動します。
- カードを追加する対象のアプリを選択します。
- 左のサイドバーメニューで［CRMカード］を選択します。
- 右上の［CRMカードを作成］をクリックします。
以降のセクションで、各タブでの設定オプションについて詳しく説明します。
HubSpotユーザーが、CRMカードが設定されているCRMレコードを表示すると、HubSpotが連携にデータ取得リクエストを送信します。HubSpotが指定されたターゲットURLに送信するこのリクエストには、一連の既定のクエリーパラメーターの他に、カードの設定として指定されたプロパティーデータを含むパラメーターが追加されます。
-
［データ取得URL］フィールドに、データの取得元とするURLを入力します。APIでは、このURLが
targetUrlフィールドに追加されます。 - ［ターゲット レコード タイプ］セクションで、スイッチをクリックしてオンに切り替え、カードを表示するCRMレコードを選択します。次に、［HubSpotから送信されたプロパティー］ドロップダウンメニューを使用して、リクエストURLにクエリーパラメーターとして含めるHubSpotプロパティーを選択します。APIでは、各レコードタイプおよび対応するプロパティーが、
objectTypes配列にオブジェクトとして追加されます。
［カードプロパティー］タブで、HubSpotにCRMカード上に表示させるカスタムプロパティーを定義します。カスタムプロパティー定義すると、連携によってこれらのプロパティーがレスポンスに組み込まれ、値が取り込まれます。
-
- ［プロパティーを追加］をクリックし、カードに表示する新しいプロパティーを追加します。データ取得呼び出しに対して返すペイロードには、これら全てのプロパティーに値が設定されている必要があります。
- 右側のパネルで、プロパティーの一意の名前、表示ラベル、データタイプを設定します。データタイプとして、［通貨］、［日付］、［日時］、［Eメール］、［リンク］、［数値］、［ステータス］、［文字列］のいずれかを選択できます。拡張プロパティータイプの使用について詳細をご確認ください。
- ［追加］をクリックしてプロパティーを保存します。
HubSpotがデータリクエストを送信すると、連携によって、resultsに含まれる各オブジェクトの他の値に加え、レスポンス内でこれらのプロパティーに値が取り込まれます。このタブで設定されたプロパティーの他に、連携によって独自のカスタムプロパティーが追加される場合もあります。これらのプロパティーをカードの設定で定義する必要はありません。
例えば、以下のレスポンスに含まれるcreatedおよびpriorityは、どちらも［カードプロパティー］タブで定義されたものですが、properties配列では独自のプロパティー定義および値が送信されます。これらのオブジェクト固有のプロパティーは、オブジェクトごとに定義する必要があります。
リクエストには
X-HubSpot-Signatureヘッダーが含まれます。
詳細については、リクエスト署名をご確認ください。アクションURLは、アクションのuriフィールドでアクセスされます。データ取得リクエストと同様に、アクションフックには一連の既定のクエリーパラメーターが組み込まれます。他のクエリーパラメーターを追加するには、アクションにassociatedObjectPropertiesフィールドを含めます。