HubSpotカスタムオブジェクトでは、カスタムオブジェクトAPIを使用して、ビジネスニーズに応じてデータを表示、編成できます。
crm/v3/schemas
に対してPOST
リクエストを送信します。リクエスト本文に、オブジェクトスキーマの定義(オブジェクトの名前、プロパティー、関連付け)を含めます。
カスタムオブジェクトに名前を付ける際は、次の点に留意してください。
secondaryDisplayProperties
にリストされる最初のプロパティーは、そのタイプが以下のいずれかの場合、オブジェクト一覧ページにも4つ目のフィルターとして追加されます。
string
number
enumeration
boolean
datetime
type
プロパティーはstring
に設定され、fieldType
プロパティーはtext
に設定されます。以下の値を使用して、さまざまなタイプのプロパティーを作成できます。
type | 説明 | 有効なfieldType 値 |
---|---|---|
enumeration | 一連のオプションを表す文字列。各オプションをセミコロンで区切って入力します。 | booleancheckbox 、checkbox 、radio 、select |
date | 特定の年、月、日を表すISO 8601形式の値。 | date |
dateTime | 特定の年、月、日、時刻を表すISO 8601形式の値。HubSpotアプリ上には時刻は表示されません。 | date |
string | プレーンテキスト文字列。文字数の上限は65,536文字です。 | file 、text 、textarea |
number | 小数第1位までの数値。 | number |
fieldType | 説明 |
---|---|
booleancheckbox | ユーザーが「はい」または「いいえ」のいずれかを選択できる入力。フォーム内で使用する場合、1つのチェックボックスとして表示されます。 |
checkbox | プロパティー内で使用可能な選択肢の中からユーザーが複数選択できるチェックボックスのリスト。 |
date | 日付値。日付入力として表示されます。 |
file | フォームへのファイルのアップロードが可能。ファイルへのURLリンクとして格納および表示されます。 |
number | 10進数または科学的表記で記述された、数字の文字列または数値。 |
radio | プロパティーで使用可能な選択肢の中からユーザーがいずれか1つを選択できる入力。フォーム内で使用する場合、一連のラジオボタンとして表示されます。 |
select | プロパティーで許容される選択肢の中からユーザーがいずれか1つを選択できるドロップダウンの入力。 |
text | プレーンテキスト文字列。単行テキスト入力として表示されます。 |
textarea | プレーンテキスト文字列。単行テキスト入力として表示されます。 |
objectTypeId
値を使用してカスタムオブジェクトを識別します。例:
/crm/v3/schemas
に対してGET
リクエストを送信します。
特定のカスタムオブジェクトを取得する場合は、次のエンドポイントのいずれかに対してGET
リクエストを送信します。
/crm/v3/schemas/{objectTypeId}
/crm/v3/schemas/p_{object_name}
/crm/v3/schemas/{fullyQualifiedName}
オブジェクトのスキーマに含まれる
fullyQualifiedName
は、そのオブジェクトのスキーマに含まれます。これは、p{portal_id}_{object_name}
から派生したものです。アカウント情報APIを使用して、アカウントのポータルIDを確認できます。
1234
で、lender
という名前のオブジェクトを持つアカウントの場合、リクエストURLは次のようになります。
https://api.hubapi.com/crm/v3/schemas/2-3465404
https://api.hubapi.com/crm/v3/schemas/p_lender
https://api.hubapi.com/crm/v3/schemas/p1234_lende
crm/v3/objects/{objectType}/{recordId}
に対してGET
リクエストを送信します。パラメーター | 説明 |
---|---|
properties | レスポンスで返されるプロパティーのカンマ区切りリスト。リクエスト対象のカスタムオブジェクトレコードで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。 |
propertiesWithHistory | レスポンスで返される現在および過去のプロパティーのカンマ区切りリスト。リクエスト対象のカスタムオブジェクトレコードで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。 |
associations | 関連付けられたIDを取得する対象のオブジェクトのカンマ区切りリスト。存在しない関連付けを指定した場合、その関連付けはレスポンスで返されません。詳しくは関連付けAPIをご参照ください。 |
crm/v3/objects/{objectType}/batch/read
に対してPOST
リクエストを送信します。このバッチエンドポイントは関連付けを取得できません。詳しくは、関連付けAPIを使用して関連付けを一括読み取りする方法をご参照ください。hs_object_id
)またはカスタムの固有のIDプロパティーを取得できます。デフォルトで、リクエストのid
値はレコードIDを参照するため、レコードIDを使って取得するときにはidProperty
パラメーターは不要です。カスタムの固有の値のプロパティーを使用する場合は、idProperty
パラメーターを含める必要があります。
例えば、カスタムオブジェクトレコードを一括で取得する場合のリクエストは、次のいずれかのようになります。
https://api.hubapi.com/crm/v3/schemas/{objectTypeId}
に対してPATCH
リクエストを送信します。
カスタムオブジェクトを定義した後は、以下の点にご留意ください。
requiredProperties
、searchableProperties
、primaryDisplayProperty
、secondaryDisplayProperties
は、オブジェクトのスキーマを更新することで変更できます。新しいプロパティーを、必須プロパティー、検索可能プロパティー、または表示プロパティーとして設定するには、スキーマを更新する前にそのプロパティーを作成する必要があります。/crm/v3/schemas/_{objectTypeId}_/associations
に対してPOST
リクエストを送信します。
カスタムオブジェクトには、標準のHubSpotオブジェクト(「コンタクト」「会社」「取引」「チケット」など)または他のカスタムオブジェクトを関連付けることができます。toObjectTypeId
フィールドで、カスタムオブジェクトはそのobjectTypeId
値で識別し、標準のオブジェクトはその名前で識別します。以下に例を示します。
/crm/v3/schemas/{objectType}
に対してDELETE
リクエストを送信します。
削除したオブジェクトと同じ名前で新しいカスタムオブジェクトを作成する必要がある場合は、/crm/v3/schemas/{objectType}?archived=true
にDELETE
リクエストを送信して、スキーマのハード(物理)削除を行う必要があります。カスタムオブジェクトタイプの削除は、そのタイプの全てのオブジェクトインスタンス、関連付け、カスタムオブジェクトのプロパティーの削除後のみでしか行えません。
secondaryDisplayProperties
)の更新
/crm/v3/schemas
に対してPOST
リクエストを送信します。このリクエストの本文は次のように設定します。
{objectTypeId}
フィールドの値を確認します。後でオブジェクトを取得および更新する際にこの値を使用するためです。必要に応じて、{fullyQualifiedName}
の値を使用することもできます。POST
リクエストを/crm/v3/objects/2-3465404
に対して送信します。
id
値を使用して、車両に既存のコンタクトを関連付けることができます。
https://api.hubapi.com/crm/v3/objects/2-3465404/181308?portalId=1234567&properties=year&properties=make&properties=model
に対してGET
リクエストを送信します。181308
)と別のレコードのIDを使用して、カスタムオブジェクトレコードを別のオブジェクトのレコードに関連付けることができます。
関連付けを作成するには、/crm/v3/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}/{associationType}
に対してPUT
リクエストを送信します。オブジェクトの関係がすでに定義されている場合、associationType
値を判別するには、crm/v3/schemas/{objectType}
に対してGET
リクエストを送信します。
例えば、コンタクトID51
と関連付けタイプ75
を使用して、CarSpotは車両レコードにコンタクトを関連付けることができます。上記のIDを使用して、次のリクエストURLが作成されます。
https://api.hubspot.com/crm/v3/objects/2-3465404/181308/associations/contacts/51/75
POST
リクエストを**/crm/v3/schemas/2-3465404/associations
**に対して送信して、新しい関連付けを作成します。
POST
リクエストを/crm/v3/properties/2-3465404
に送信します。このリクエストの本文は次のようになります。
PATCH
リクエストを/crm/v3/schemas/2-3465404
に送信して、このプロパティーをsecondaryDisplayProperties
に追加します。