エクスポート

最終更新日: 2025年8月22日

エクスポートAPIを使用すると、HubSpotアカウントからのレコードやプロパティーデータのエクスポート、エクスポートファイルのダウンロードURL取得、およびエクスポートステータスの確認を行えます。また、HubSpotでは、レコードをエクスポートすることや、アカウントで過去のエクスポートのログを表示することもできます。

エクスポートを開始する

エクスポートを開始するには、POSTリクエストを/crm/v3/exports/export/asyncに送信します。リクエスト本文では、ファイル形式、エクスポートするオブジェクトとプロパティー、実行するエクスポートの種類（例：オブジェクトビューまたはリストのエクスポート）などの情報を指定する必要があります。特定の演算子に基づいてエクスポートするプロパティーデータを絞り込むこともできます。ビューとリストのどちらのエクスポートの場合も、リクエストに以下のフィールドを含めることができます。

パラメーター	説明
`exportType`	エクスポートのタイプ。`VIEW`（オブジェクトのインデックスページからビューをエクスポートする場合）または`LIST`（リストをエクスポートする場合）のどちらかを指定します。
`format`	ファイル形式。オプションは、`XLSX`、`CSV`、または`XLS`です。
`exportName`	エクスポートの名前。
`language`	エクスポートファイルの言語。オプションは、`DE`、`EN`、`ES`、`FI`、`FR`、`IT`、`JA`、`NL`、`PL`、`PT`、または`SV`です。詳細についてはHubSpotの対応言語をご確認ください。
`objectType`	エクスポートするオブジェクトの名前またはID。標準オブジェクトの場合はオブジェクトの名前（例：`CONTACT`）を使用できますが、カスタムオブジェクトの場合は`objectTypeId`値を使用する必要があります。この値は、`GET`リクエストを`/crm/v3/schemas`に送信することで取得できます。
`associatedObjectType`	エクスポートに含める関連付けられたオブジェクトの名前またはID。1回のリクエストにつき最大4つの関連付けられたオブジェクトをエクスポートできます。関連付けられたオブジェクトの場合、エクスポートにはそのオブジェクトに関連付けられたレコードIDが含まれます。関連付けられたオブジェクトを1つだけエクスポートするか、`includePrimaryDisplayPropertyForAssociatedObjects`フィールドを`true`に設定した場合、レコードのプライマリー表示プロパティー値もエクスポートされます（例：`name`会社）。
`objectProperties`	エクスポートに含めるプロパティーのリスト。デフォルトでは、プロパティーの名前と値は人間が判読できるラベルとして表示されますが、`exportInternalValuesOptions`パラメーターを使用して内部の名前と値を要求できます。
`includePrimaryDisplayPropertyForAssociatedObjects`	関連付けられた全てのレコードのプライマリー表示プロパティー値をエクスポートするには、このフィールドを値`true`とともに含めます（例：会社の場合は`name`）。関連付けられたオブジェクトを1つだけエクスポートする場合（`associatedObjectType`フィールドで示されます）、これはデフォルトで`true`に設定されます。複数の関連付けられたオブジェクトをエクスポートする場合、この値は既定で`false`に設定されます。
`includeLabeledAssociations`	このフィールドを値`true`と共に含めると、関連付けラベルをエクスポートして、関連付けられたレコード間の関係性を記述できます。
`exportInternalValuesOptions`	プロパティーの内部名や内部値をエクスポートするには、この配列を含めます。配列に、プロパティーの内部名（列ヘッダーとして表示されます）をエクスポートするための`NAMES`や、プロパティーの内部値（人間が判読できる日付ではなく、カスタムパイプラインステージやタイムスタンプの数値など）をエクスポートするための`VALUES`を含めます。
`overrideAssociatedObjectsPerDefinitionPerRowLimit`	デフォルトの1行当たり関連付け1,000件までの上限をオーバーライドするには、値を`true`にしてこのフィールドを含めます。

ビューをエクスポートする

インデックスページのビューをエクスポートする場合、exportTypeの値をVIEWに設定する必要があります。また、以下のフィールドを含めることで、エクスポートするレコードの絞り込みや並べ替えも行えます。

パラメーター説明

publicCrmSearchRequest 特定のプロパティー値と検索クエリーに基づいてエクスポートするデータを示します。このオブジェクトには、次のフィールドを含めることができます。
filters：レコードを絞り込む基準とするプロパティーとプロパティー値。
sorts：プロパティー値の並べ替え順。昇順（ASC）、降順（DES）のいずれかです。
query：レコードの値を検索するための文字列。

パラメーター	説明
`publicCrmSearchRequest`	特定のプロパティー値と検索クエリーに基づいてエクスポートするデータを示します。このオブジェクトには、次のフィールドを含めることができます。 `filters`：レコードを絞り込む基準とするプロパティーとプロパティー値。 `sorts`：プロパティー値の並べ替え順。昇順（`ASC`）、降順（`DES`）のいずれかです。 `query`：レコードの値を検索するための文字列。

例えば、コンタクトとコンタクトに関連付けられている会社レコードのビューを、emailプロパティーでフィルタリングして、プロパティーの内部名と内部値を含めてエクスポートする場合、リクエストは次のようになります。

JSON

///Example request body
{
"exportType": "VIEW",
"exportName": "All contacts",
"format": "xlsx",
"language": "DE",
"objectType": "CONTACT",
"exportInternalValuesOptions": ["NAMES", "VALUES"],
"objectProperties": ["email", "firstname", "lastname"],
"associatedObjectType": "COMPANY",
"publicCrmSearchRequest": {
"filters": [
{
"value": "hello@test.com",
"propertyName": "email",
"operator": "EQ"
}
],
"query": "hello",
"sorts": [
{
"propertyName": "email",
"order": "ASC"
}
]
}
}

リストをエクスポートする

リストをエクスポートする場合、exportTypeの値をLISTに設定する必要があります。また、次のフィールドを使用して、エクスポートするリストを指定する必要もあります。

パラメーター説明

listId エクスポートするリストのILSリストID。ILSリストIDの値は、HubSpotのリストの詳細から確認できます。［コンタクト］＞［リスト］の順に進み、表内のいずれかのリストにカーソルを合わせて、［詳細］をクリックします。右側のパネルで、ILSリストIDの値の横に表示される［リストIDをコピー］をクリックします。コンタクトリストには2つの異なるID値がありますが、リクエストではILSリストIDの値を使用することが必須です。

パラメーター	説明
`listId`	エクスポートするリストのILSリストID。ILSリストIDの値は、HubSpotのリストの詳細から確認できます。［コンタクト］＞［リスト］の順に進み、表内のいずれかのリストにカーソルを合わせて、［詳細］をクリックします。右側のパネルで、ILSリストIDの値の横に表示される［リストIDをコピー］をクリックします。コンタクトリストには2つの異なるID値がありますが、リクエストではILSリストIDの値を使用することが必須です。

例えば、コンタクトのEメールを含むリストをエクスポートする場合、リクエストは次のようになります。

JSON

///Example request body
{
"exportType": "LIST",
"listId": 1234567,
"exportName": "Marketing email contacts",
"format": "xlsx",
"language": "EN",
"objectType": "CONTACT",
"objectProperties": ["email"]
}