> ## Documentation Index > Fetch the complete documentation index at: https://developers.hubspot.jp/docs/llms.txt > Use this file to discover all available pages before exploring further. # CRM API | インポート export const postmanIcon = ; export const ScopesList = ({scopes = [], description = "この API には、次のいずれかのスコープが必要です。"}) => { if (!scopes || scopes.length === 0) { return null; } const sortedScopes = scopes.sort((a, b) => a.localeCompare(b)); return

{description}

{sortedScopes.map((scope, index) =>


              {scope}

)}

; };

# インポート

インポートAPIは、コンタクト、会社、コメントなどのCRMレコードとアクティビティーをHubSpotアカウントにインポートする際に使用します。インポートが完了した後は、レコードとアクティビティーへのアクセスおよび更新は、[コンタクトAPI、](/guides/crm/understanding-the-crm)[関連付け](/api-reference/crm-associations-v4/guide)API、[エンゲージメントAPI](/api-reference/overview)などの各種CRM APIエンドポイントを通じて行えます。また、[HubSpotのガイド付きインポートツールを使用してレコードとアクティビティーをインポートする](https://knowledge.hubspot.com/ja/import-and-export/import-objects)こともできます。インポートを開始する前に、次のナレッジベース記事をご確認ください。 * [ファイル要件](https://knowledge.hubspot.com/ja/import-and-export/set-up-your-import-file#file-requirements-and-technical-limits) * [レコードとアクティビティーのインポートに必要なプロパティー](https://knowledge.hubspot.com/ja/import-and-export/set-up-your-import-file#required-properties) * [マーケティングイベント参加者のインポートに必要なプロパティー](https://knowledge.hubspot.com/ja/integrations/import-marketing-event-participants#prepare-your-import-file) ### 注：カスタムイベントを作成する、またはイベントをレコードに関連付けるには、インポートではなく[カスタムイベントAPI](https://developers.hubspot.jp/docs/api-reference/events-send-event-completions-v3/guide)をご使用ください。 ## インポートを開始するインポートを開始するには、`POST`リクエストを`/crm/v3/imports`に送信します。その際、インポートファイルの列をHubSpot上の関連するプロパティーに割り当てる方法をリクエスト本文で指定します。 APIインポートはform-dataタイプのリクエストとして送信され、リクエスト本文には次のフィールドが含まれます。 * [importRequest](#format-the-importrequest-data)：リクエストのJSONを格納するテキストフィールド。 * [files](#map-file-columns-to-hubspot-properties)：インポートファイルを格納するファイルフィールド。リクエストヘッダーには、`multipart/form-data`の値が含まれる`Content-Type`ヘッダーを追加します。以下のスクリーンショットは、Postmanなどのアプリを使用したリクエストの例です応答がないpostmanインポートリクエスト

### importRequestデータを書式設定するリクエストでは、インポートファイルの詳細（スプレッドシートの列のHubSpotデータに対するマッピングなど）を定義します。また、次のフィールドを含める必要があります。 * **name**：インポートの名前。これはHubSpot上で、リストなどの他のツールで参照できる名前で、[インポートツールにも表示される](https://knowledge.hubspot.com/ja/import-and-export/view-and-analyze-previous-imports)名前です。 * **importOperations**：この任意指定のフィールドを使用して、インポートで特定のオブジェクトやアクティビティーの[レコードの作成と更新、作成のみ、または更新のみ](https://knowledge.hubspot.com/ja/import-and-export/import-objects#choose-how-to-import)のいずれを行うかを指示します。オブジェクト／アクティビティーの`objectTypeId`を指定し、レコードの`UPSERT`（作成と更新）、`CREATE`、または`UPDATE`を行いたいかどうかを指定します。例えばリクエストのフィールドは次のようになります：`"importOperations": {"0-1": "CREATE"}`このフィールドを含めない場合、インポートに使用されるデフォルト値は`UPSERT`です。 * **dateFormat**：ファイルに含まれる日付の形式。これは既定では`MONTH_DAY_YEAR`に設定されていますが、`DAY_MONTH_YEAR`または`YEAR_MONTH_DAY`も使用できます。 * **marketableContactImport**：インポートファイルに含まれるコンタクトの[マーケティングステータス](https://knowledge.hubspot.com/ja/records/marketing-contacts)を示す任意指定のフィールド。これは、[マーケティングコンタクトの利用](https://knowledge.hubspot.com/ja/records/marketing-contacts#check-your-access-to-marketing-contacts)が可能なアカウントにコンタクトをインポートする場合にのみ使用します。ファイル内のコンタクトをマーケティング対象として設定するには、`true`の値を使用します。ファイル内のコンタクトをマーケティング対象外として設定するには、`false`の値を使用します。 * **createContactListFromImport**：インポートから[コンタクトの静的リストを作成](https://knowledge.hubspot.com/ja/import-and-export/import-objects#create-list-from-import)するための任意指定のフィールド。ファイルからリストを作成するには、`true`の値を使用します。 * **files**：インポートファイルの情報を格納する配列。 * **fileName**：インポートファイルの名前。 * **fileFormat**：インポートファイルの形式。CSVファイルの場合に使用する値は`CSV`です。Excelファイルの場合に使用する値は`SPREADSHEET`です。 * **fileImportPage**：インポートファイルのデータをHubSpotデータにマッピングするために必要な`columnMappings`配列が含まれます。列のマッピングの詳細については、以下で説明しています。 ### HubSpotプロパティーにファイルの列をマッピングする `columnMappings`配列内には、スプレッドシートの列ヘッダーの順序に合わせて、インポートファイルの各列に対応するエントリーを含めます。各列には、次のフィールドを格納します。 * **columnObjectTypeId**: データが属するオブジェクトまたはアクティビティーの名前または`objectTypeId`値。`objectTypeId`値の一覧については、[こちらの記事](/guides/crm/understanding-the-crm#object-type-id)をご覧ください。 * **columnName**: 列ヘッダーの名前。これは、ファイルの列ヘッダーの名前に完全一致する必要があります。 * **propertyName**: データのマッピング先となるHubSpotプロパティーの内部名。`toColumnObjectTypeId`フィールドが使用されている場合、[複数ファイルのインポート](#import-multiple-files)で共通する列では、`propertyName`が`null`である必要があります。 * **columnType**：これを使用して、列に[固有IDプロパティー](https://knowledge.hubspot.com/ja/import-and-export/understand-the-import-tool#unique-identifiers)が含まれることを指定します。インポートのプロパティーと目標に応じて、次のいずれかの値を使用します。 * **HUBSPOT\_OBJECT\_ID**: レコードのID。例えば、コンタクトのインポートファイルに、コンタクトに関連付けられる会社のIDを格納する「レコードID」列を含めるケースが考えられます。\_ \_ * **HUBSPOT\_ALTERNATE\_ID**: レコードID以外の固有ID。例えば、コンタクトのインポートファイルに、コンタクトのEメールアドレスを格納した「Eメール」列を含めるケースが考えられます。\_ \_ * **FLEXIBLE\_ASSOCIATION\_LABEL**：関連付けラベルが列に含まれることを示すには、この列タイプを含めます。 * **ASSOCIATION\_KEYS**：同じオブジェクト関連付けインポートの場合にのみ、関連付けられる同じオブジェクトレコードの固有IDにこの列タイプを含めます。例えば、連絡先の関連付けをインポートするリクエストでは、「Associated contact \[email/Record ID]」列の`columnType`を`ASSOCIATION_KEYS`にする必要があります。\_ \_詳しくは、[同じオブジェクト関連付けインポート用にインポートファイルを設定する](https://knowledge.hubspot.com/ja/import-and-export/set-up-your-import-file#same-object-association-imports)方法についてご確認ください。 * **toColumnObjectTypeId**：[複数のファイル](#import-multiple-files)または複数のオブジェクトをインポートする場合の、[共通する列](https://knowledge.hubspot.com/ja/import-and-export/set-up-your-import-file#import-associations-in-two-files)プロパティーまたは関連付けラベルが属するオブジェクトの名前または`objectTypeId`。プロパティーが属していないオブジェクトのファイルに共通する列プロパティー用にこのフィールドを含めます。例えば、共通する列として［Eメール］コンタクトプロパティーを持つ2つのファイルのコンタクトと会社を関連付ける場合、会社ファイルの「Eメール」列用に`toColumnObjectTypeId`を含めます。\_ \_\_ \_ * **foreignKeyType**：`associationTypeId`と`associationCategory`で指定された、共通の列が使用する関連付けのタイプ（[複数ファイルのインポート](#import-multiple-files)の場合のみ）。プロパティーが属していないオブジェクトのファイルに共通する列プロパティー用にこのフィールドを含めます。例えば、共通する列として［Eメール］コンタクトプロパティーを持つ2つのファイルのコンタクトと会社を関連付ける場合、会社ファイルの「Eメール」列用に`foreignKeyType`を含めます。\_ \_\_ \_ * **associationIdentifierColumn**：レコードを関連付けるために共通の列で使用されるプロパティーを示します（[複数ファイルのインポート](#import-multiple-files)の場合のみ）。プロパティーが属しているオブジェクトのファイルに共通する列プロパティー用にこのフィールドを含めます。例えば、共通する列として［Eメール］コンタクトプロパティーを持つ2つのファイルのコンタクトと会社を関連付ける場合、会社ファイルの「Eメール」列について`associationIdentifierColumn`を`true`に設定します。\_ \_\_ \_ ## 1つのオブジェクトを含む1つのファイルをインポートする以下は、1つのファイルをインポートしてコンタクトを作成するためのリクエスト本文の例です。 ```json example.json theme={null} // Example POST to https://api.hubspot.com/crm/v3/imports // Content-Type header set to multipart/form-data { "name": "November Marketing Event Leads", "importOperations": { "0-1": "CREATE" }, "dateFormat": "DAY_MONTH_YEAR", "files": [ { "fileName": "Nov-event-leads.csv", "fileFormat": "CSV", "fileImportPage": { "hasHeader": true, "columnMappings": [ { "columnObjectTypeId": "0-1", "columnName": "First Name", "propertyName": "firstname" }, { "columnObjectTypeId": "0-1", "columnName": "Last Name", "propertyName": "lastname" }, { "columnObjectTypeId": "0-1", "columnName": "Email", "propertyName": "email", "columnType": "HUBSPOT_ALTERNATE_ID" } ] } } ] } ``` ```python example.py theme={null} # This example a local file named 'test_import.csv' # This file contains a list of contact records to import. import requests import json import os url = "https://api.hubapi.com/crm/v3/imports" YOUR_ACCESS_TOKEN = 'xxxxxxx'; # Content-Type header will be set automatically by the requests library headers = { 'authorization': 'Bearer %s' % YOUR_ACCESS_TOKEN } data = { "name": "November Marketing Event Leads", "importOperations": { "0-1": "CREATE" }, "dateFormat": "DAY_MONTH_YEAR", "files": [ { "fileName": "Nov-event-leads.csv", "fileFormat": "CSV", "fileImportPage": { "hasHeader": True, "columnMappings": [ { "columnObjectTypeId": "0-1", "columnName": "First Name", "propertyName": "firstname" }, { "columnObjectTypeId": "0-1", "columnName": "Last Name", "propertyName": "lastname" }, { "columnObjectTypeId": "0-1", "columnName": "Email", "propertyName": "email", "columnType": "HUBSPOT_ALTERNATE_ID" } ] } } ] } datastring = json.dumps(data) payload = {"importRequest": datastring} current_dir = os.path.dirname(__file__) relative_path = "./test_import.csv" absolute_file_path = os.path.join(current_dir, relative_path) files = [ ('files', open(absolute_file_path, 'rb')) ] print(files) response = requests.request("POST", url, data=payload, files=files, headers=headers) print(response.text.encode('utf8')) print(response.status_code) ``` ```text シェルスクリプト.txt theme={null} # Using this endpoint requires using sending multi-part form encoded data. Here is an example curl request: # importing a file named import_file.csv # create a variable for the importRequest JSON myJSON=$(cat < 別の例として、1つのファイルをインポートし、マーケティングイベント参加者を作成および更新するものを示します。 ```json theme={null} // Example POST to https://api.hubspot.com/crm/v3/imports // Content-Type header set to multipart/form-data { "name": "Marketing Events Import Example", "marketingEventObjectId": 377224141223, "importOperations": { "0-1": "UPSERT", "0-54": "CREATE" }, "dateFormat": "YEAR_MONTH_DAY", "timeZone": "America/New_York", "files": [ { "fileName": "Marketing Events Import Example.csv", "fileFormat": "CSV", "fileImportPage": { "hasHeader": true, "columnMappings": [ { "columnName": "First Name", "columnObjectTypeId": "0-1", "propertyName": "firstname", "columnType": "STANDARD" }, { "columnName": "Last Name", "columnObjectTypeId": "0-1", "propertyName": "lastname", "columnType": "STANDARD" }, { "columnName": "Email", "columnObjectTypeId": "0-1", "propertyName": "email", "columnType": "HUBSPOT_ALTERNATE_ID" }, { "columnName": "Registered", "columnObjectTypeId": "0-54", "columnType": "EVENT_TIMESTAMP", "marketingEventSubmissionType": "REGISTERED" }, { "columnName": "Attended", "columnObjectTypeId": "0-54", "columnType": "EVENT_TIMESTAMP", "marketingEventSubmissionType": "JOINED" }, { "columnName": "Left", "columnObjectTypeId": "0-54", "columnType": "EVENT_TIMESTAMP", "marketingEventSubmissionType": "LEFT" }, { "columnName": "Cancelled", "columnObjectTypeId": "0-54", "columnType": "EVENT_TIMESTAMP", "marketingEventSubmissionType": "CANCELLED" } ] } } ] } ``` ## 複数のオブジェクトを含む1つのファイルをインポートする以下は、1つのファイル内のコンタクトと会社をインポートしてラベルに関連付けるためのリクエスト本文の例です。 ```json theme={null} // Example POST to https://api.hubspot.com/crm/v3/imports // Content-Type header set to multipart/form-data { "name": "Association Label Import", "dateFormat": "DAY_MONTH_YEAR", "files": [ { "fileName": "association label example.xlsx", "fileFormat": "SPREADSHEET", "fileImportPage": { "hasHeader": true, "columnMappings": [ { "columnObjectTypeId": "0-1", "columnName": "Email", "propertyName": "email" }, { "columnObjectTypeId": "0-2", "columnName": "Domain", "propertyName": "domain" }, { "columnName": "Association Label", "columnType": "FLEXIBLE_ASSOCIATION_LABEL", "columnObjectTypeId": "0-1", "toColumnObjectTypeId": "0-2" } ] } } ] } ``` ## 複数のファイルをインポートする以下は、2つのファイル内のコンタクトと会社をインポートして関連付けるためのリクエスト本文の例です。コンタクトプロパティー［Eメール］\_\_がファイル内の共通の列です。 ```json theme={null} // Example POST to https://api.hubspot.com/crm/v3/imports // Content-Type header set to multipart/form-data { "name": "Contact Company import", "dateFormat": "YEAR_MONTH_DAY", "files": [ { "fileName": "contact-import-file.csv", "fileFormat": "CSV", "fileImportPage": { "hasHeader": true, "columnMappings": [ { "columnObjectTypeId": "0-1", "columnName": "First name", "propertyName": "firstname" }, { "columnObjectTypeId": "0-1", "columnName": "Last name", "propertyName": "lastname" }, { "columnObjectTypeId": "0-1", "columnName": "Email", "propertyName": "email", "associationIdentifierColumn": true } ] } }, { "fileName": "company-import-file.csv", "fileFormat": "CSV", "fileImportPage": { "hasHeader": true, "columnMappings": [ { "columnObjectTypeId": "0-2", "columnName": "Company name", "propertyName": "name" }, { "columnObjectTypeId": "0-2", "columnName": "Company domain name", "propertyName": "domain", "columnType": "HUBSPOT_ALTERNATE_ID" }, { "columnObjectTypeId": "0-2", "toColumnObjectTypeId": "0-1", "columnName": "Email", "propertyName": null, "foreignKeyType": { "associationTypeId": 280, "associationCategory": "HUBSPOT_DEFINED" } } ] } } ] } ``` リクエストが成功すると、インポートの取得またはキャンセルに使用できる`importId`を含むレスポンスが返されます。完了すると、[インポートをHubSpotで表示](https://knowledge.hubspot.com/ja/import-and-export/view-and-analyze-previous-imports)できますが、ビュー、リスト、レポート、またはワークフローでインポートを基準にレコードを絞り込む際には、API経由で完了したインポートをオプションとして使用することはできません。 ## 以前のインポートを取得する HubSpotアカウントから全てのインポートを取得するには、`/crm/v3/imports/`に`GET`リクエストを送信します。特定のインポートの情報を取得するには、`/crm/v3/imports/{importId}`に`GET`リクエストを送信します。インポートを取得すると、インポートの名前、ソース、ファイル形式、言語、日付形式、列マッピングなどの情報が返されます。また、インポートの`state`も返されます。これは次のいずれかである可能性があります。 * `STARTED`：HubSpotはインポートが存在することを認識していますが、インポートの処理はまだ開始されていません。 * `PROCESSING`：インポートがアクティブに処理されています。 * `DONE`：インポートは完了済みです。全てのオブジェクト、アクティビティー、または関連付けが更新または作成されました。 * `FAILED`：インポートの開始時に検出されなかったエラーがありました。インポートは完了しませんでした。 * `CANCELED`：エクスポートが`STARTED`、`PROCESSING`、`DEFERRED`のいずれかの状態だったときに、ユーザーがエクスポートをキャンセルしました。 * `DEFERRED`：最大数（3件）のインポートが同時に処理されています。他のインポートの1つの処理が終了すると、インポートが開始されます。結果のページ処理と制限について詳しくは、[リファレンスドキュメント](https://developers.hubspot.jp/docs/api-reference/crm-imports-v3/guide)をご確認ください。 ### 注：インポートを取得する際、レスポンスには同じアプリによって実行されたインポートのみが含まれます。HubSpotまたは別のアプリを介して完了したインポートは返されません。 ## インポートをキャンセルするインポートをキャンセルするには、`/crm/v3/imports/{importId}/cancel`に`POST`リクエストを送信します。 ## インポートエラーの意味とトラブルシューティング特定のインポートのエラーを表示するには、`/crm/v3/imports/{importId}/errors`に`GET`リクエストを送信します。[典型的なインポートエラーとその解決方法](https://knowledge.hubspot.com/ja/import-and-export/troubleshoot-import-errors)で詳細をご確認ください。「列数が正しくありません」、「JSONを解析できません」」、「このURLは解析できません」、「404 text/htmlは受け付けられません」などのエラーが返された場合は、次のようにします。 * ファイル内の各列に列ヘッダーがあり、リクエスト本文に各列の`columnMapping`エントリが含まれていることを確認します。次の条件を満たしている必要があります。 * リクエスト本文とインポートファイルの列の順序は一致していなければなりません。列の順序が一致しない場合、自動的な並べ替えの試行に失敗し、インポートの開始時にエラーが発生する可能性があります。 * 全ての列がマッピングされていなければなりません。列がマッピングされていない場合でもインポートリクエストは成功する可能性がありますが、インポートの開始時に「列数が正しくありません」というエラーが発生する場合もあります。 * ファイルの名前がリクエストのJSONの`fileName`フィールドと一致していて、`fileName`フィールドにファイル拡張子が含まれていることを確かめてください（例：*import\_name.csv*）。 * `multipart/form-data`の値のある`Content-Type`がヘッダーが含まれていることを確かめます。 ```json example.json theme={null} Example POST URL: https://api.hubapi.com/crm/v3/imports? Example importRequest JSON data: This example contains 3 columns: - First name, mapped to the firstname contact property - Email, mapped to the email contact property - Company ID, which contains a list of company record IDs that the contact will be assocated with. { "name": "test_import", "files": [ { "fileName": "final_emails.csv", "fileImportPage": { "hasHeader": true, "columnMappings": [ { "ignored": false, "columnName": "First Name", "idColumnType": null, "propertyName": "firstname", "foreignKeyType": null, "columnObjectType": "CONTACT", "associationIdentifierColumn": false }, { "ignored": false, "columnName": "Email", "idColumnType": "HUBSPOT_ALTERNATE_ID", "propertyName": "email", "foreignKeyType": null, "columnObjectType": "CONTACT", "associationIdentifierColumn": false }, { "ignored": false, "columnName": "Company ID", "idColumnType": "HUBSPOT_OBJECT_ID", "propertyName": null, "foreignKeyType": { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 1 }, "columnObjectType": "CONTACT", "associationIdentifierColumn": false } ] } } ] } ``` ```python example.py theme={null} # This example a local file named 'final_emails.csv' # This file contains a list of contact records to import. # Each row in the file contains a column named "Company ID" that contains the companyId # that the contact should be associated with. import requests import json post_url = 'http://api.hubapi.com/crm/v3/imports?hapikey=4324...5432' importRequest = { "name": "test_import", "files": [ { "fileName": "final_emails.csv", "fileImportPage": { "hasHeader": True, "columnMappings": [ { "ignored": False, "columnName": "First Name", "idColumnType": None, "propertyName": "firstname", "foreignKeyType": None, "columnObjectType": "CONTACT", "associationIdentifierColumn": False }, { "ignored": False, "columnName": "Email", "idColumnType": "HUBSPOT_ALTERNATE_ID", "propertyName": "email", "foreignKeyType": None, "columnObjectType": "CONTACT", "associationIdentifierColumn": False }, { "ignored": False, "columnName": "Company ID", "idColumnType": "HUBSPOT_OBJECT_ID", "propertyName": None, "foreignKeyType": { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 1 }, "columnObjectType": "CONTACT", "associationIdentifierColumn": False } ] } } ] ``` ```php example.php theme={null} $csv_file, "importRequest" => $config_json ); $ch = curl_init(); @curl_setopt($ch, CURLOPT_POST, true); @curl_setopt($ch, CURLOPT_URL, $post_url); @curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data); $response = @curl_exec($ch); //Log the response from HubSpot as needed. $status_code = @curl_getinfo($ch, CURLINFO_HTTP_CODE); //Log the response status code @curl_close($ch); echo $status_code . " " . $response; ?> ``` ```text シェルスクリプト.txt theme={null} # Using this endpoint requires using sending multi-part form encoded data. Here is an example curl request: # importing a file named import_file.csv # create a variable for the importRequest JSON myJSON=$(cat < ### 注：エラーが発生する場合は、`Content-Type`などの重複するヘッダーがあるかどうかを確認してください。これが発生する可能性があるのは、Postmanを使用しているか、PythonスクリプトのヘッダーにPostmanが含まれている場合です。リクエストを完了する前に重複を削除してください。 ## 上限インポートAPIを使用すると、1日あたり最大80,000,000行をインポートできます。ただし、個々のインポートファイルの上限として、1,048,576行または512MBのうち最初に到達した条件が適用されます。リクエストが行制限またはサイズ制限のいずれかを超えた場合、HubSpotから429 HTTPエラーが返されます。このような上限に近づいたら、インポートを複数のリクエストに分割することをお勧めします。