プロパティー

HubSpotのCRMオブジェクトに関する詳細情報はプロパティーに保存されます。これは、グループに分類することができます。各オブジェクトの既定のプロパティーに加えて、カスタムプロパティーを作成して特殊なデータを保存できます。CRMプロパティーエンドポイントを使用すると、あらゆるオブジェクトを対象として、カスタムプロパティーを管理したり、既定のプロパティーの詳細を確認したりできます。

データの構築方法を考慮することは重要です。多くの場合、HubSpotのネイティブオブジェクト上にカスタムプロパティーを作成することで適切に対応できます。しかし場合によっては、独自のプロパティーを備えたカスタムオブジェクト(英語)を別途作成することが必要になります。

既定のプロパティー

CRMオブジェクトは、主なタイププロパティーセットによって定義されます。タイプごとに標準のプロパティーがあり、名前と値のペアのマップで表されます。 

オブジェクトごとの既定のプロパティーをご覧ください。

カスタムプロパティー

オブジェクトに特殊な情報を格納するには、カスタムプロパティーを作成します。カスタムプロパティーの管理は、CRMオブジェクトプロパティーのエンドポイント経由で行うことができます。

プロパティーグループ

プロパティーグループは、関連する複数のプロパティーをグループ化するために使用します。グループ化されたプロパティーは各HubSpotレコード上に隣接して表示されます。カスタムプロパティーを作成して連携を行う場合は、カスタムプロパティーのグループを活用することでデータの特定が容易になります。

typefieldTypeの値

プロパティーの作成または更新の際には、typefieldTypeの両方の値が必要です。typeの値により、プロパティーの型、つまり文字列か数値かが決まります。fieldTypeプロパティーによって、プレーンテキストフィールド、ドロップダウンメニュー、日付入力など、HubSpotでのプロパティーの表示形式が決まります。

以下の表(英語)に、typefieldTypeに利用可能な値を示します。また、特定のtypeに対して有効なfieldType値の情報を示すtypeの表(英語)も示します。

Valid values for type field and compatible fieldType values
type Description Valid fieldType values
enumeration A string representing a set of options, with options separated by a semicolon  booleancheckbox, checkbox, radio, select
date An ISO 8601 formatted value representing a specific day, month, and year. date
dateTime An ISO 8601 formatted value representing a specific day, month, year and time of day. The HubSpot app will not display the time of day. date
string A plain text strings, limited to 65,536 characters. file, text, textarea
number A number value containing numeric digits and at most one decimal. number
Valid values for fieldType field
fieldType Description
booleancheckbox An input that will allow users to select one of either Yes or No. When used in a form, it will be displayed as a single checkbox.
checkbox A list of checkboxes that will allow a user to select multiple options from a set of options allowed for the property.
date A date value, displayed as a date picker.
file Allows for a file to be uploaded to a form. Stored and displayed as a URL link to the file.
number A string of numerals or numbers written in decimal or scientific notation.
radio An input that will allow users to select one of a set of options allowed for the property. When used in a form, this will be displayed as a set of radio buttons.
select A dropdown input that will allow users to select one of a set of options allowed for the property.
text A plain text string, displayed in a single line text input.
textarea A plain text string, displayed as a multi-line text input.

参考になりましたか? *
こちらのフォームには開発者向けドキュメントに関するご意見をお聞かせください。なお、HubSpot製品に関するご意見は、アイデアフォーラム(英語)にお寄せください。