Freshbooks

FreshBooks コネクタを使用すると、FreshBooks インスタンスに接続し、従来のデータベースとして FreshBooks データにアクセスできます。

サポート対象のバージョン

このコネクタは、FreshBooks Alpha API を SQL でクエリできるデータベースオブジェクトとしてモデル化します。

準備

Freshbooks コネクタを使用する前に、次の作業を行います。

Google Cloud プロジェクトで次の操作を行います。
- 次のサービスを有効にします。
  - secretmanager.googleapis.com（Secret Manager API）
  - connectors.googleapis.com（Connectors API）
  サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

アプリケーションを作成し、認証用のクライアント ID とクライアントシークレットを生成する方法については、FreshBooks API のスタートガイドをご覧ください。

コネクタを構成する

コネクタを構成するには、データソース（バックエンドシステム）への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
[接続] ページに移動
[+ 新規作成] をクリックして [接続の作成] ページを開きます。
[ロケーション] セクションで、接続のロケーションを選択します。
1. リージョン: プルダウンリストからロケーションを選択します
  コネクタをサポートしているリージョンは次のとおりです。
  サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。
2. [次へ] をクリックします。
[接続の詳細] セクションで、次の操作を行います。
1. コネクタ: 使用可能なコネクタのプルダウンリストから [Freshbooks] を選択します。
2. コネクタのバージョン: 使用可能なバージョンのプルダウンリストからコネクタのバージョンを選択します。
3. [接続名] フィールドに、接続インスタンスの名前を入力します。
  接続名は次の条件を満たす必要があります。
  - 接続名には英字、数字、ハイフンを使用できます。
  - 文字は小文字のみを使用できます。
  - 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
  - 接続名は 49 文字以内で指定してください。
4. 必要に応じて、接続インスタンスの [説明] を入力します。
5. 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
6. サービスアカウント: 必要なロールを持つサービスアカウントを選択します。
7. 必要に応じて、接続ノードの設定を構成します。
  - ノードの最小数: 接続ノードの最小数を入力します。
  - ノードの最大数: 接続ノードの最大数を入力します。
  ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。
8. アカウント ID: 接続するアカウント ID。値が指定されていない場合は、最初に返される値が使用されます。
9. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
10. [次へ] をクリックします。
[認証] セクションで、認証の詳細を入力します。
1. [認証タイプ] を選択し、関連する詳細を入力します。
  Freshbooks 接続でサポートされる認証タイプは次のとおりです。
  - OAuth 2.0 認証コード付与
2. [次へ] をクリックします。
Review: 接続と認証の詳細を確認します。
[作成] をクリックします。

認証を構成する

使用する認証に基づいて詳細を入力します。

OAuth 2.0 認証コード付与
- スコープ: 必要なスコープのカンマ区切りのリスト。
- クライアント ID: アクセストークンのリクエストに使用されるクライアント ID。
- クライアントシークレット: アクセストークンのリクエストに使用されるクライアントシークレット。

FreshBooks 接続を承認する手順は次のとおりです。

[接続] ページで、FreshBooks の接続をクリックします。
[認証] セクションで、[接続を承認] をクリックします。
[リダイレクト URI] セクションに移動してコピーします。
FreshBooks アプリケーションで、[リダイレクト URI] をクリックします。
FreshBooks 接続からコピーしたリダイレクト URI を貼り付け、[設定を保存] をクリックします。
FreshBooks 接続に戻り、認証セクションで [承認] をクリックします。
認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベースコネクタでは、テーブルがエンティティであり、ファイルサーバーコネクタでは、フォルダがエンティティです。また、メッセージングシステムコネクタでは、キューがエンティティです。
ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。
オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
- リスト
- 取得
- 作成
- 更新
- 削除
使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティオペレーションをご覧ください。ただし、コネクタがいずれかのエンティティオペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。
アクション: コネクタインターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

エンティティオペレーションの例

このセクションでは、このコネクタでエンティティオペレーションの一部を実行する方法について説明します。

例 - すべてのプロジェクトを一覧表示する

この例では、Projects エンティティ内のすべてのプロジェクトを一覧表示します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から Projects を選択します。
[List] オペレーションを選択してから、[完了] をクリックします。
必要に応じて、コネクタタスクの [タスク入力] セクションでフィルタ句を指定して、結果セットをフィルタリングできます。

例 - エンティティからレコードを取得する

この例では、Expense Categories エンティティから ID が 2009015 のレコードを取得します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から Expense Categories を選択します。
[Get] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで [entityId] をクリックし、[デフォルト値] フィールドに 2009015 を入力します。
ここで、2009015 は Expense Categories エンティティの主キー値です。

例 - 請求書を作成する

この例では、Invoices エンティティに請求書を作成します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から Invoices を選択します。
[Create] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{"CustomerId": 68039.0,
"FirstName": "John",
"CreateDate": "2023-09-13"
}
```
統合に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。
```
{
"Id": "49594.0"
}
```

例 - 請求書を更新する

この例では、Invoices エンティティ内の ID が 36741.0 の請求書を更新します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から Invoices を選択します。
[Update] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"FirstName": "James"
}
```
[entityId] をクリックし、[デフォルト値] フィールドに「36741.0」と入力します。
[entityId] を指定する代わりに、[filterClause] を 36741.0 に設定することもできます。

統合に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。
```
{
"Id": "36741.0"
}
```

例 - レコードを削除する

この例では、Payments エンティティ内の ID が 78 のレコードを削除します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から Payments を選択します。
[Delete] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで [entityId] をクリックし、[デフォルト値] フィールドに「78」と入力します。

Terraform を使用して接続を作成する

Terraform リソースを使用して、新しい接続を作成できます。

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。

接続作成用の Terraform テンプレートのサンプルを表示するには、サンプルテンプレートをご覧ください。

Terraform を使用してこの接続を作成する場合は、Terraform 構成ファイルで次の変数を設定する必要があります。

パラメータ名	データ型	必須	説明
account_id	STRING	True	接続するアカウント ID。値が指定されていない場合は、最初に返される値が使用されます。

統合で Freshbooks 接続を使用する

接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。