インポートAPIは、コンタクト、会社などのCRMレコードをHubSpotアカウントにインポートする際に使用します。インポートされたレコードは、コンタクトAPIや関連付けAPIなどのCRM APIエンドポイント経由でのアクセスと更新が可能です。レコードのインポートには、HubSpotのガイド付きインポートツールを使用することもできます。
インポートを開始する
インポートの処理は、インポートファイルの列をHubSpot上のどのCRMプロパティーに割り当てるかをリクエスト本文に指定したPOSTリクエストを/crm/v3/importsに送信することで、開始できます。
APIインポートはform-dataタイプのリクエストとして送信され、リクエスト本文には次のフィールドが含まれます。
- importRequest：リクエストのJSONを格納するテキストフィールド。
- files：インポートファイルを格納するファイルフィールド。
以下のスクリーンショットに、Postmanなどのアプリを使用したリクエストの例を示します。
リクエストヘッダーについては、値multipart/form-dataが含まれるContent-Typeヘッダーを追加します。
importRequestデータの形式を整える
リクエストのJSONでは、インポートファイルの詳細（スプレッドシートの列のHubSpotデータに対するマッピングなど）を定義します。リクエストのJSONには次のフィールドを含める必要があります。
- name：インポートの名前。これはHubSpot上で、リストなどの他のツールで参照できる名前で、インポートツールにも表示される名前です。
- marketableContactImport：インポートファイルに含まれるコンタクトのマーケティングステータス。これは、マーケティングコンタクトの利用が可能なアカウントにコンタクトをインポートする場合にのみ、使用します。ファイル内のコンタクトをマーケティング対象として設定するには、
trueの値を使用します。ファイル内のコンタクトをマーケティング対象外として設定するには、falseの値を使用します。 - files：インポートファイルの情報を格納する配列。
- fileName：インポートファイルの名前。
- fileFormat：インポートファイルの形式。CSVファイルの場合に使用する値は
CSVです。Excelファイルの場合に使用する値はSPREADSHEETです。 - dateFormat：ファイルに含まれる日付の形式。これは、既定では
MONTH_DAY_YEARに設定されていますが、DAY_MONTH_YEARもYEAR_MONTH_DAYも使用できます。 - fileImportPage：インポートファイルのデータをHubSpotデータにマッピングするために必要な
columnMappings配列を格納します。列マッピングの詳細については、以下をご覧ください。
HubSpotプロパティーにファイルの列をマッピングする
columnMappings配列内には、スプレッドシート内の順序に従ってインポートファイル内の各列を格納します。各列には、次のフィールドを格納します。
- columnObjectTypeId：データが存在するオブジェクトのタイプのID。カスタムオブジェクトの値は、カスタムオブジェクトAPIを使用して取得できます。標準オブジェクトの場合は、次の値を使用します。
- コンタクト：
0-1 - 会社：
0-2 - 取引：
0-3 - チケット：
0-5 - 注：
0-4
- コンタクト：
- columnName：列ヘッダーの名前。
- idColumnType：プロパティーデータを格納する列の場合に使用する値は
nullです。固有IDを格納する列の場合に使用する値は、次のうちのいずれかです。- HUBSPOT_OBJECT_ID：レコードのID。例えば、コンタクトのインポートファイルに、コンタクトを関連付ける会社のIDを格納した「会社ID」列を含めるケースが考えられます。
- HUBSPOT_ALTERNATE_ID：レコードID以外の固有ID。例えば、コンタクトのインポートファイルに、コンタクトのEメールアドレスを格納した「Eメール」列を含めるケースが考えられます。
- propertyName：データのマッピング先のHubSpotプロパティー。
コンタクトをインポートする場合のリクエスト本文の例を以下に示します。