関連付けv3

関連付けは、HubSpotのCRM上のさまざまなオブジェクトとアクティビティー間の関係を表します。関連付けエンドポイントを使用することで、関連付けを一括で作成、取得、または削除できます。以下のオブジェクトまたはエンゲージメントを関連付けることも可能です。

• Contacts
• Companies
• Deals
• Tickets
• Calls
• Quotes
• Line_items
• Meetings
• Products
• Feedback_submissions
• Custom objects（カスタムオブジェクトの名前に置き換えます）

オブジェクト、レコード、プロパティー、および関連付けAPIの詳細については、「CRMについて」のガイドをご確認ください。HubSpotのオブジェクトとレコードに関する一般的な情報については、CRMデータベースを管理する方法をご参照ください。

関連付けは、オブジェクトと方向によって定義されます。関連付けのタイプは一方向なので、関連元のオブジェクトタイプに応じて異なる定義を使用する必要があります。例：

• あるコンタクトに関連する全てのチケットを確認するには、リクエストURL /crm/v3/associations/Contacts/Tickets/batch/readのように関連付けを定義します。コンタクトは、リクエスト本文中のobjectIdで識別します。この例では、Contactsは「fromObjectType」で、Ticketsは「toObjectType」です。
• コンタクトレコードをカスタム オブジェクト レコードに関連付けるには、カスタムオブジェクトがPetsの場合、リクエストURL /crm/v3/associations/Pets/Contacts/batch/createのように関連付けを定義します。関連付けるコンタクトとペットのレコードは、リクエスト本文中のobjectIdsで指定します。この例では、Petsは「fromObjectType」で、Contactsは「toObjectType」です。

定義されている、オブジェクト間の関連付けタイプの全てを確認するには、GETリクエストを/crm/v3/associations/{fromObjectType}/{toObjectType}/typesに送信します。

HubSpot内のレコードを関連付けるには、POSTリクエストを/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/createに送信します。リクエストには、関連付けるレコードのid値と、そのレコードが属する関連付けのtypeを含めます。

例えば、コンタクトを会社に関連付ける場合、リクエストURLは/crm/v3/associations/Contacts/Companies/batch/createの形式になり、リクエストの内容は次のようになります。

関連付けられたレコードを取得するには、POSTリクエストを/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/readに送信します。リクエストには、fromObjectTypeの特定のレコードのidを含めることができます。レスポンスでは、toObjectTypeで関連付けられた全てのレコードのid値が返されます。

例えば、会社に関連付けられている全ての取引を取得する場合、リクエストURLは/crm/v3/associations/Companies/Deals/batch/readのようになります。レスポンスには、関連付けられている全ての取引のid値が含まれます。

レコード間の関連付けを削除するには、POSTリクエストを/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/archiveに送信します。