HubSpotのCRMは、顧客の関係性やデータを管理するためのシステムです。CRMオブジェクトと関連するCRM APIについて確認しましょう。
{objectTypeId}
を目的のオブジェクトに置き換えることができます。例えば、コンタクトを作成するにはPOST
リクエストをcrm/v3/objects/0-1
に送信し、コースを作成するにはcrm/v3/objects/0-410
に送信します。さまざまなオブジェクト用にオブジェクトエンドポイントを使用する方法については、こちらの記事をご参照ください。
{objectTypeId}
を目的のオブジェクトに置き換えます。objectTypeId
フィールドを使用する必要があります。これは、各オブジェクトに割り当てられる固有の数値です。例えば、レコードを取得するにはGET
リクエストを/crm/v3/objects/{objectTypeId}
に送信し、オブジェクトのプロパティーを作成するときにはPOST
リクエストを/crm/v3/properties/{objectTypeId}
に送信します。オブジェクトタイプIDの値を以下の表に示します。
タイプID | オブジェクト | 説明 |
---|---|---|
0-2 | 会社 | 企業や組織についての情報を格納します。詳細は会社APIをご確認ください。 |
0-1 | コンタクト | 個人に関する情報を格納します。コンタクトAPIを確認してください。 |
0-3 | 取引 | パイプラインステージを通じて追跡される営業の商談と取引を表します。詳細は取引APIをご確認ください。 |
0-5 | チケット | パイプラインステータスを通じて追跡される顧客からのサポート依頼を表します。詳細はチケットAPIをご確認ください。 |
0-421 | アポイントメント | 個人向けに予定されている会合やサービスを表します。詳細はオブジェクトAPIをご確認ください。 |
0-48 | コール | レコードに関連付けられている通話のやりとりを表すアクティビティーの一種です。詳細はコールAPIをご確認ください。 |
0-18 | コミュニケーション | レコードに関連付けられているSMS、LinkedIn、WhatsAppメッセージのやりとりを表すアクティビティーの一種です。コミュニケーションAPIを確認してください。 |
0-410 | コース | 構造化されたプログラムまたは一連のレッスン、トレーニング、または教育関連モジュールを表します。詳細はオブジェクトAPIをご確認ください。 |
2-XXX | カスタムオブジェクト | 既存のオブジェクトに適合しないデータを格納します。カスタムオブジェクトのobjectTypeId を確認するには、GET リクエストを/crm/v3/schemas に送信します。詳細はオブジェクトAPIをご確認ください。 |
0-49 | Eメール | レコードに関連付けられている1対1のEメールのやりとりを表すアクティビティーの一種です。詳細はEメールAPIをご確認ください。 |
0-19 | フィードバック送信 | フィードバックアンケートに送信された情報を格納します。フィードバック送信はコンタクトレコードに関連付けられます。詳細はフィードバック送信APIをご確認ください。 |
0-53 | 請求書 | 販売取引に関して送信された請求書を表します。請求書には、コンタクト、会社、取引、商品項目、割引、手数料、および税金を関連付けることができます。詳細は請求書APIをご確認ください。 |
0-136 | リード | 製品やサービスに関心を示した潜在顧客を表します。詳細はリードAPIをご確認ください。 |
0-8 | 商品項目 | 取引において販売する個々の製品とサービスを表します。商品項目は、製品ライブラリーに登録されている既存の製品から作成したり、単独で作成したりすることができます。詳細は商品項目APIをご確認ください。 |
0-420 | 掲載情報 | 購入、販売、賃貸する不動産や設備を表します。詳細はオブジェクトAPIをご確認ください。 |
0-54 | マーケティングイベント | マーケティング活動に関連するイベント、具体的には、接続した連携機能からのイベントなどを表します。コンタクトがマーケティングイベントに出席、参加登録、キャンセルしたかどうかを指定できます。詳細はマーケティングイベントAPIをご確認ください。 |
0-47 | ミーティング | レコードに関連付けられているミーティングのやりとりを表すアクティビティーの一種です。詳細はミーティングAPIをご確認ください。 |
0-46 | メモ | レコードに関連付けられたメモを表すアクティビティーの一種。詳細はメモAPIをご確認ください。 |
0-123 | 注文 | eコマース購入をHubSpotで表します。詳細は注文APIをご確認ください。 |
0-101 | 支払い | 請求書、支払いリンク、見積もりを通じて購入者が行う支払いです。支払いには、コンタクト、会社、取引、請求書、見積もり、商品項目、サブスクリプション、割引、手数料、および税金を関連付けることができます。詳細は支払いAPIをご確認ください。 |
0-116 | 郵便 | レコードに関連付けられた郵便物のやりとりを表すアクティビティーの一種です。詳細は郵便APIをご確認ください。 |
0-7 | 製品 | 販売する商品やサービスを表します。製品を他のCRMオブジェクトに関連付けることはできませんが、製品に基づいて商品項目を作成し、それらを取引や見積もりに関連付けることができます。詳細は製品APIを確認してください。 |
0-14 | 見積もり | 潜在顧客に共有する価格情報を表します。見積もりを取引、商品項目、見積もりテンプレート(0-64 )に関連付ける必要がありますが、見積もりをコンタクト、会社、割引、手数料、税金に関連付けることもできます。詳細は見積もりAPIをご確認ください。 |
0-162 | サービス | 顧客に提供される無形の製品を表します。例としては、導入支援やコンサルティング、修理やメンテナンス、パーソナルケアなどがあります。詳細はオブジェクトAPIをご確認ください。 |
0-69 | サブスクリプション | 支払いリンクと見積もりを通じて予定されている定期的な支払いを表します。サブスクリプションには、コンタクト、会社、取引、見積もり、商品項目、支払い、割引、手数料、および税金を関連付けることができます。詳細はサブスクリプションAPIをご確認ください。 |
0-27 | タスク | レコードに関連付けられるTo Doを表すアクティビティーの一種です。タスクAPIを確認してください。 |
0-115 | ユーザー | HubSpotアカウントのユーザーを表します。ユーザーを他のCRMオブジェクトに関連付けることはできませんが、APIを介して取得および更新することはできます。ユーザーの詳細APIを確認してください。 |
columnObjectTypeId
に指定します。コンタクトのデータをインポートするには、columnObjectTypeId
の値としてcontact
または0-1
を使用できます。fromObjectType
とtoObjectType
の値でオブジェクトと関連付けの方向を指定します。コンタクトと会社との関連付けタイプを確認するには、GET
リクエストURLとしてcrm/v4/associations/contact/company/labels
またはcrm/v4/associations/0-1/0-2/labels
を使用できます。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で重複の削除が処理される方法については、ナレッジベースをご確認ください。
{toObjectTypeId}
や{fromObjectTypeId}
をオブジェクトに置き換えることができます。オブジェクト間でレコードを関連付ける前に、どのオブジェクトを相互に関連付けることができるかを理解するために、関連付けタイプを取得できます。例えば、コンタクトをほとんどのオブジェクトに関連付けることができますが、請求書を関連付けることができるのはコンタクト、会社、取引、商品項目、割引、手数料、および税金だけです。ご使用のサブスクリプションに応じて、関係ラベルを使用してレコード間の特定の関係の種類を記述できます。アカウントによっては、他の標準的なオブジェクトに関連付けることのできる追加のカスタムオブジェクトが存在することがあります。オブジェクト関係について、また関連付けエンドポイントによる関連付けの管理について詳しくご確認ください。
HubSpotアカウントへのアクセス権をお持ちの場合は、データモデルツールに移動して、アカウント固有のオブジェクト関係を確認することもできます。
/crm/v3/properties/0-1
、チケットプロパティーの場合は/crm/v3/properties/0-5
です。プロパティーAPIの使用について詳しくは、この記事をご確認ください。
{objectTypeId}
の値を検索したいオブジェクトに置き換えます。例えば、コールを検索するにはPOSTリクエストを/crm/v3/objects/0-48/search
に送信します。CRM検索APIの詳しい使用方法については、こちらの記事をご参照ください。