インポートは、営業、マーケティング、およびサービスのさまざまなツールで活用できるオブジェクトデータをHubSpotアカウントに取り込むために使用されます。
POST
リクエストを/crm/v3/imports
に送信します。その際、インポートファイルの列をHubSpot上の関連するプロパティーに割り当てる方法をリクエスト本文で指定します。
APIインポートはform-dataタイプのリクエストとして送信され、リクエスト本文には次のフィールドが含まれます。
multipart/form-data
の値が含まれるContent-Type
ヘッダーを追加します。
以下のスクリーンショットは、Postmanなどのアプリを使用したリクエストの例です
objectTypeId
を指定し、レコードのUPSERT
(作成と更新)、CREATE
、またはUPDATE
を行いたいかどうかを指定します。例えばリクエストのフィールドは次のようになります:"importOperations": {"0-1": "CREATE"}
このフィールドを含めない場合、インポートに使用されるデフォルト値はUPSERT
です。MONTH_DAY_YEAR
に設定されていますが、DAY_MONTH_YEAR
またはYEAR_MONTH_DAY
も使用できます。true
の値を使用します。ファイル内のコンタクトをマーケティング対象外として設定するには、false
の値を使用します。true
の値を使用します。CSV
です。Excelファイルの場合に使用する値はSPREADSHEET
です。columnMappings
配列が含まれます。列のマッピングの詳細については、以下で説明しています。columnMappings
配列内には、スプレッドシートの列ヘッダーの順序に合わせて、インポートファイルの各列に対応するエントリーを含めます。
各列には、次のフィールドを格納します。
objectTypeId
値。objectTypeId
値の一覧については、こちらの記事をご覧ください。toColumnObjectTypeId
フィールドが使用されている場合、複数ファイルのインポートで共通する列では、propertyName
がnull
である必要があります。columnType
をASSOCIATION_KEYS
にする必要があります。_ _詳しくは、同じオブジェクト関連付けインポート用にインポートファイルを設定する方法についてご確認ください。objectTypeId
。プロパティーが属していないオブジェクトのファイルに共通する列プロパティー用にこのフィールドを含めます。例えば、共通する列として[Eメール]コンタクトプロパティーを持つ2つのファイルのコンタクトと会社を関連付ける場合、会社ファイルの「Eメール」列用にtoColumnObjectTypeId
を含めます。_ __ _associationTypeId
とassociationCategory
で指定された、共通の列が使用する関連付けのタイプ(複数ファイルのインポートの場合のみ)。プロパティーが属していないオブジェクトのファイルに共通する列プロパティー用にこのフィールドを含めます。例えば、共通する列として[Eメール]コンタクトプロパティーを持つ2つのファイルのコンタクトと会社を関連付ける場合、会社ファイルの「Eメール」列用にforeignKeyType
を含めます。_ __ _associationIdentifierColumn
をtrue
に設定します。_ __ _importId
を含むレスポンスが返されます。完了すると、インポートをHubSpotで表示できますが、ビュー、リスト、レポート、またはワークフローでインポートを基準にレコードを絞り込む際には、API経由で完了したインポートをオプションとして使用することはできません。
/crm/v3/imports/
にGET
リクエストを送信します。特定のインポートの情報を取得するには、/crm/v3/imports/{importId}
にGET
リクエストを送信します。
インポートを取得すると、インポートの名前、ソース、ファイル形式、言語、日付形式、列マッピングなどの情報が返されます。また、インポートのstate
も返されます。これは次のいずれかである可能性があります。
STARTED
:HubSpotはインポートが存在することを認識していますが、インポートの処理はまだ開始されていません。PROCESSING
:インポートがアクティブに処理されています。DONE
:インポートは完了済みです。全てのオブジェクト、アクティビティー、または関連付けが更新または作成されました。FAILED
:インポートの開始時に検出されなかったエラーがありました。インポートは完了しませんでした。CANCELED
:エクスポートがSTARTED
、PROCESSING
、DEFERRED
のいずれかの状態だったときに、ユーザーがエクスポートをキャンセルしました。DEFERRED
:最大数(3件)のインポートが同時に処理されています。他のインポートの1つの処理が終了すると、インポートが開始されます。/crm/v3/imports/{importId}/cancel
にPOST
リクエストを送信します。
/crm/v3/imports/{importId}/errors
にGET
リクエストを送信します。典型的なインポートエラーとその解決方法で詳細をご確認ください。
「列数が正しくありません」、「JSONを解析できません」」、「このURLは解析できません」、「404 text/htmlは受け付けられません」などのエラーが返された場合は、次のようにします。
columnMapping
エントリが含まれていることを確認します。次の条件を満たしている必要があります。
fileName
フィールドと一致していて、fileName
フィールドにファイル拡張子が含まれていることを確かめてください(例:import_name.csv)。multipart/form-data
の値のあるContent-Type
がヘッダーが含まれていることを確かめます。Content-Type
などの重複するヘッダーがあるかどうかを確認してください。これが発生する可能性があるのは、Postmanを使用しているか、PythonスクリプトのヘッダーにPostmanが含まれている場合です。リクエストを完了する前に重複を削除してください。