オブジェクトAPI
オブジェクトAPIは、レコードとアクティビティーへのアクセスを提供します。サポートされるオブジェクトについては、オブジェクトエンドポイントを使用して、リクエストURLの{objectTypeId}を目的のオブジェクトに置き換えることができます。例えば、コンタクトを作成するにはPOSTリクエストをcrm/v3/objects/0-1に送信し、コースを作成するにはcrm/v3/objects/0-410に送信します。さまざまなオブジェクト用にオブジェクトエンドポイントを使用する方法については、こちらの記事をご参照ください。
オブジェクトタイプID
CRM APIやその他のAPIを使用する場合は、objectTypeIdフィールドを使用する必要があります。これは、各オブジェクトに割り当てられる固有の数値です。例えば、レコードを取得するにはGETリクエストを/crm/v3/objects/{objectTypeId}に送信し、オブジェクトのプロパティーを作成するときにはPOSTリクエストを/crm/v3/properties/{objectTypeId}に送信します。オブジェクトタイプIDの値を以下の表に示します。
数値タイプのID値はいつでも使用できますが、コンタクト、会社、取引、チケット、メモはオブジェクト名を使用できる場合もあります。以下に例を示します。
- インポートAPIでインポートを開始するときは、ファイル内のデータがどのオブジェクトに属するかを
columnObjectTypeIdに指定します。コンタクトのデータをインポートするには、columnObjectTypeIdの値としてcontactまたは0-1を使用できます。 - 関連付けAPIを使用するときは、
fromObjectTypeとtoObjectTypeの値でオブジェクトと関連付けの方向を指定します。コンタクトと会社との関連付けタイプを確認するには、GETリクエストURLとしてcrm/v4/associations/contact/company/labelsまたはcrm/v4/associations/0-1/0-2/labelsを使用できます。
固有IDとレコードID
固有IDとは、CRM内のあるレコードを別のレコードと（仮にID以外の情報が同一であっても）区別するための値です。例えば、データベース内に名前が同じ2人の山田太郎さんのレコードが存在するとします。誤って他方の山田太郎さんに送金されることがないように、各レコードには「レコードID」として番号が割り当てられます。 HubSpotでレコードが作成されると、その「レコードID」（hs_object_id）が自動的に生成され、文字列として扱われます。レコードIDはオブジェクト内で一意です。したがって、コンタクトと会社のIDが同じになる場合があります。コンタクトと会社には、コンタクトのEメール（email）や会社のドメイン名（domain）など、他にも固有のIDがあります。また、カスタムの固有IDプロパティーを作成することもできます。
CRM APIでは固有のID値を使用して特定のレコードを識別し、管理します。レコードのhs_object_id値は常に使用できますが、idPropertyパラメーターで指定された特定のエンドポイントに対してカスタムの固有IDプロパティーを使用することもできます。例えば、コンタクトを編集するにはPATCHリクエストを/crm/v3/objects/0-1/{contactId}または/crm/v3/objects/0-1/{contactEmail}?idProperty=emailに送信します。HubSpotで重複の削除が処理される方法については、ナレッジベースをご確認ください。
関連付けAPI
HubSpotでは、オブジェクトがどのように相互に関連しているかを示すために、レコードを関連付けることができます。例えば、複数のコンタクトを会社に関連付けて、会社および関連するコンタクトを取引に関連付けることができます。 関連付けAPIエンドポイントを使用するときには、リクエストURLとリクエスト本文の中の{toObjectTypeId}や{fromObjectTypeId}をオブジェクトに置き換えることができます。オブジェクト間でレコードを関連付ける前に、どのオブジェクトを相互に関連付けることができるかを理解するために、関連付けタイプを取得できます。例えば、コンタクトをほとんどのオブジェクトに関連付けることができますが、請求書を関連付けることができるのはコンタクト、会社、取引、商品項目、割引、手数料、および税金だけです。ご使用のサブスクリプションに応じて、関係ラベルを使用してレコード間の特定の関係の種類を記述できます。アカウントによっては、他の標準的なオブジェクトに関連付けることのできる追加のカスタムオブジェクトが存在することがあります。オブジェクト関係について、また関連付けエンドポイントによる関連付けの管理について詳しくご確認ください。
HubSpotアカウントへのアクセス権をお持ちの場合は、データモデルツールに移動して、アカウント固有のオブジェクト関係を確認することもできます。
プロパティーAPI
レコードに関する情報は、プロパティーと呼ばれるフィールドに格納された後、グループに分類されます。HubSpotでは、各オブジェクトにデフォルトのプロパティーセットが用意されています。オブジェクトごとのデフォルトのプロパティーに加え、カスタムプロパティーを作成することによって、カスタムのデータを格納できます。 プロパティーAPIを使用する場合は、エンドポイント内でオブジェクトに置き換えて、オブジェクトのプロパティーを作成および管理できます。例えば、コンタクトプロパティーの場合は/crm/v3/properties/0-1、チケットプロパティーの場合は/crm/v3/properties/0-5です。プロパティーAPIの使用について詳しくは、この記事をご確認ください。
検索API
プロパティーと関連付けに基づいてレコードやアクティビティーのフィルタリングおよび並び替えを行うには、検索APIを使用できます。検索エンドポイントを使用する場合は、{objectTypeId}の値を検索したいオブジェクトに置き換えます。例えば、コールを検索するにはPOSTリクエストを/crm/v3/objects/0-48/searchに送信します。CRM検索APIの詳しい使用方法については、こちらの記事をご参照ください。