エクスポート

概要エンドポイント

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

エクスポートを開始する

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

ビューとリストのどちらのエクスポートの場合も、リクエストに以下のフィールドを含めることができます。

Use this table to describe parameters / fields
ParameterDescription
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。関連付けられたオブジェクトを含める場合、エクスポートにはそのオブジェクトの関連付けられたレコードIDと、レコードのプライマリー表示プロパティー値（名前など）が含まれます。エクスポートできるのは、1回のリクエストにつき1つの関連付けられたオブジェクトのみです。

objectProperties

エクスポートに含めるプロパティーのリスト。

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

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

Use this table to describe parameters / fields
ParameterDescription
publicCrmSearchRequest

特定のプロパティー値と検索クエリーに基づいてエクスポートするデータを示します。オブジェクト内に以下を含めることができます。

filters：レコードのフィルタリングに使用するプロパティーとプロパティー値。
sorts：プロパティーの値の並べ替え順序（昇順の場合にはASC、降順の場合にはDES）。
query：レコードの値を検索する文字列。

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

///Example request body { "exportType": "VIEW", "exportName": "All contacts", "format": "xlsx", "language": "DE", "objectType": "CONTACT", "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にします。また、次のフィールドを使用して、エクスポートするリストを指定することも必要です。

Use this table to describe parameters / fields
ParameterDescription
listId

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

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

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

エクスポートを取得する

エクスポートが正常に完了すると、レスポンスでエクスポートのidが返されます。HubSpotアカウントからエクスポートを取得する場合、GETリクエストを/crm/v3/exports/export/async/tasks/{exportId}/statusに送信します。

エクスポートを取得すると、エクスポートのstatusも返されます。返される可能性があるステータスは、COMPLETE、PENDING、PROCESSING、またはCANCELEDです。エクスポートのステータスがCOMPLETEの場合、エクスポートしたファイルをダウンロードするために使用できるURLが返されます。ダウンロードURLは、リクエストが完了してから5分後に期限切れになります。期限切れになると、別のGETリクエストを実行して、新しい一意のURLを生成できます。

Please note: prior to expiration, an export's download URL can be accessed without any additional authorization. To protect your data, proceed with caution when sharing a URL or integrating with HubSpot via this API.

制限

エクスポートエンドポイントには、次の制限が適用されます。

  • エクスポートのフィルターを設定する際、最大3つのfilterGroupsを含めることができ、各グループに最大3つのfiltersを含めることができます。
  • 24時間以内に最大10回のエクスポートを実行できます。一度に実行できるエクスポートは1つのみです。追加のエクスポートは、前回のエクスポートが完了するまでキューに入れられます。
参考になりましたか？
こちらのフォームではドキュメントに関するご意見をご提供ください。HubSpotがご提供しているヘルプはこちらでご確認ください。