製品をチェック

FreshBooks Cmdlets の30日間無償トライアルをダウンロード

 ダウンロードはこちら

製品の詳細

FreshBooks アイコン FreshBooks Cmdlets 相談したい

PowerShell Cmdlets は、FreshBooks へのリアルタイム連携機能を提供します。Cmdlets を使って、データに直接連携し、読み書き更新をDB と同感覚で行うことができます。

PowerShell からFreshBooks データに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法

CData PowerShell Cmdlets を使って、FreshBooks データに接続、データの取得・更新・挿入・削除・CSV エクスポートを実行する方法を紹介します。

加藤龍彦
ウェブデベロッパー

最終更新日:2023-09-26
freshbooks ロゴ

CData

powershell ロゴ画像
PowerShell ロゴ

こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData Cmdlets for FreshBooks を使えば、PowerShell からFreshBooks に手軽に連携して、データのCRUD やエクスポートを実行できます。

本記事では、FreshBooks への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。

FreshBooks への接続を設定

それでは、まずはFreshBooks への接続設定からはじめていきましょう。接続設定にはCData FreshBooks Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。

インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。

    Import-Module FreshBooksCmdlets;

Connect-FreshBooks コマンドを使ってFreshBooks との接続を設定します。各接続プロパティの取得方法は次に説明します。

    $conn = Connect-FreshBooks  -CompanyName "$CompanyName" -Token "$Token"

FreshBooks はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。

詳細はヘルプドキュメントの「はじめに」を参照してください。

これで接続設定は完了です。

FreshBooks データを取得してCSV にパイプライン

接続が完了したので、Clients テーブルデータを取得して結果をCSV ファイルにエクスポートします。

Select-FreshBooks -Connection $conn -Table Clients | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myClientsData.csv -NoTypeInformation

このコードでは、Select-FreshBooks から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。

それでは、続いてデータの削除や挿入・更新を実行してみます。

データの削除

以下のように、フィルタリングで合致するレコードを削除することができます。

Select-FreshBooks -Connection $conn -Table Clients -Where "Email = Captain Hook" | Remove-FreshBooks

データの挿入と更新

データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。

Import-Csv -Path C:\MyClientsUpdates.csv | %{
  $record = Select-FreshBooks -Connection $FreshBooks -Table Clients -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-FreshBooks -Connection $freshbooks -Table Clients -Columns ("Username","Credit") -Values ($_.Username, $_.Credit) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-FreshBooks -Connection $freshbooks -Table Clients -Columns ("Username","Credit") -Values ($_.Username, $_.Credit)
  }
}

おわりに

このように、CData Cmdlets を使えばPowerShell でのFreshBooks データへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。