CRM API | 関連付けv4

​

HubSpotで定義されている関連付けタイプ

• **プライマリー：**他のレコードが関連付けられるメインの会社。プライマリー関連付けは、リストやワークフローなどのHubSpotツールで使用できます。複数の会社が関連付けられたレコードの場合、このAPIでは、プライマリーと見なされる会社の変更がサポートされます。
• ラベルなし：コンタクト、会社、取引、チケット、またはカスタムオブジェクトのレコードが関連付けられたときに追加される関連付けタイプ。このタイプは関連付けが存在することを示し、レスポンスでラベルの値が常にnullと返されます。レコードにプライマリー関連付けまたはカスタム関連付けラベルがある場合、これらのタイプは、ラベルなし関連付けタイプの横に表示されます。

​

単一のラベルとペアのラベル

• **単一：**関係における両方のレコードに適用される1つのラベル。例えば「友人」、「同僚」などです。
• ペア：1組のラベル。関連付けられたレコードのそれぞれの側の関係性を表すために異なる語が使用される場合です。例えば「親」と「子」、「雇用主**」と「従業員**」などです。ペアのラベルを作成するには、リクエストにinverseLabelフィールドを含めて、ペアの2番目のラベルを指定する必要があります。

​

関連付けタイプを作成する

• name：関連付けタイプの内部名。この値にハイフンを含めたり、値の先頭を数字にしたりすることはできません。
• label：HubSpotで表示される関連付けラベルの名前。
• inverseLabel（ペアラベルのみ）：ラベルのペアにおける2番目のラベルの名前。

​

関連付けタイプを取得する

• **category：**関連付けタイプがHubSpotとユーザーのどちらによって作成されたか（HUBSPOT_DEFINEDまたはUSER_DEFINED）を示します。
• **typeId：**その関連付けタイプの数値ID。これを使用して、レコードを関連付けるときにラベルを設定します。HubSpotで定義されている全てのtypeId値については、このリストを参照してください。
• **label：**英数字のラベル。「ラベルなし」関連付けタイプの場合、これはnullになります。

​

レコードを関連付ける

​

ラベルなしでレコードを関連付ける

• fromObjectType**：**関連付けるオブジェクトのID。ID値を見つけるには、このオブジェクトタイプIDのリストを参照してください。コンタクト、会社、取引、チケット、メモには、オブジェクト名（contact、companyなど）を使用できます。
• fromObjectId**：**関連付けるレコードのID。
• toObjectType**：**レコードの関連付け先となるオブジェクトのID。ID値を見つけるには、このオブジェクトタイプIDのリストを参照してください。コンタクト、会社、取引、チケット、メモには、オブジェクト名（contact、companyなど）を使用できます。
• toObjectId**：**関連付け先となるレコードのID。

​

ラベル付きでレコードを関連付ける

/// Example request body
[
  {
    "associationCategory": "USER_DEFINED",
    "associationTypeId": 36
  }
]

​

関連付けの制限を設定および管理する

​

関連付けの制限を作成または更新する

• 制限を作成するには、POSTリクエストをcrm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType}/batch/createに送信します。
• 既存の制限を更新するには、POSTリクエストをcrm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType}/batch/updateに送信します。

//Example request POST crm/v4/associations/definitions/configurations/deal/contact/batch/create
{
  "inputs": [
    {
      "category": "HUBSPOT_DEFINED",
      "typeId": 3,
      "maxToObjectIds": 5
    },
    {
      "category": "USER_DEFINED",
      "typeId": 35,
      "maxToObjectIds": 1
    }
  ]
}

​

関連付け制限を取得する

• 定義されている全ての関連付け制限を読み取るには、GETリクエストを/crm/v4/associations/definitions/configurations/allに送信します。これにより、全てのオブジェクトで定義されているカスタム関連付け制限が返されます。
• 特定の2つのオブジェクト間の関連付け制限を読み取るには、GETリクエストを/crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType}に送信します。

//Example response GET crm/v4/associations/definitions/configurations/deal/contact
{
  "results": [
    {
      "category": "HUBSPOT_DEFINED",
      "typeId": 3,
      "userEnforcedMaxToObjectIds": 5,
      "label": null
    }
  ]
}

​

関連付けの制限を削除する

//Example request POST crm/v4/associations/definitions/configurations/deal/contact/batch/purge
{
  "inputs": [
    {
      "category": "USER_DEFINED",
      "typeId": 35
    }
  ]
}

​

高い関連付け使用率に関するレポート

​

関連付けタイプID値

​

v1関連付け（レガシー）