各製品の資料を入手。
詳細はこちら →
製品をチェック
PowerShell からHubSpot のデータに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法
CData PowerShell Cmdlets を使って、HubSpot のデータに接続、データの取得・更新・挿入・削除・CSV エクスポートを実行する方法を紹介します。
最終更新日：2023-09-26
この記事で実現できるHubSpot 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
CData Cmdlets for HubSpot を使えば、PowerShell からHubSpot に手軽に連携して、データのCRUD やエクスポートを実行できます。
本記事では、HubSpot への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。
HubSpot への接続を設定
それでは、まずはHubSpot への接続設定からはじめていきましょう。接続設定にはCData HubSpot Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。
インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。
Import-Module HubSpotCmdlets;
Connect-HubSpot コマンドを使ってHubSpot との接続を設定します。各接続プロパティの取得方法は次に説明します。
$conn = Connect-HubSpot
HubSpot 接続プロパティの取得・設定方法
HubSpot はOAuth 認証 およびPrivateAppToken ベース認証をサポートします。
OAuth
HubSpot は埋め込みOAuth 認証情報を提供しており、デスクトップアプリケーションまたはヘッドレスマシンから簡単に接続できます。 Web アプリケーションから接続するには、カスタムOAuth アプリケーションを作成する必要があります。 OAuth 経由で接続するには、すべての認証フローでAuthScheme をOAuth に設定します。 ヘルプドキュメントでは、利用可能なOAuth フローでのHubSpot への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、「カスタムOAuth アプリケーションの作成」セクション を参照してください。
また、PrivateAppToken ベース認証についてはヘルプドキュメントの「接続の確立」セクションを参照してください。
これで接続設定は完了です。
HubSpot のデータを取得してCSV にパイプライン
接続が完了したので、Prospects テーブルデータを取得して結果をCSV ファイルにエクスポートします。
Select-HubSpot -Connection $conn -Table Prospects | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myProspectsData.csv -NoTypeInformation
このコードでは、Select-HubSpot から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。
それでは、続いてデータの削除や挿入・更新を実行してみます。
データの削除
以下のように、フィルタリングで合致するレコードを削除することができます。
Select-HubSpot -Connection $conn -Table Prospects -Where "Region = ONTARIO" | Remove-HubSpot
データの挿入と更新
データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。
Import-Csv -Path C:\MyProspectsUpdates.csv | %{
$record = Select-HubSpot -Connection $HubSpot -Table Prospects -Where ("Id = `'"+$_.Id+"`'")
if($record){
Update-HubSpot -Connection $hubspot -Table Prospects -Columns ("Slug","PageViews") -Values ($_.Slug, $_.PageViews) -Where ("Id = `'"+$_.Id+"`'")
}else{
Add-HubSpot -Connection $hubspot -Table Prospects -Columns ("Slug","PageViews") -Values ($_.Slug, $_.PageViews)
}
}
おわりに
このように、CData Cmdlets を使えばPowerShell でのHubSpot のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。
関連コンテンツ
