Freshbooks

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

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

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

準備

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

• Google Cloud プロジェクトで次の操作を行います。
  • 次のサービスを有効にします。
    • secretmanager.googleapis.com（Secret Manager API）
    • connectors.googleapis.com（Connectors API）

    サービスを有効にする方法については、サービスを有効にするをご覧ください。

  以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

コネクタを構成する

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

1. Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。

   [接続] ページに移動

2. [+ 新規作成] をクリックして [接続の作成] ページを開きます。
3. [ロケーション] セクションで、接続のロケーションを選択します。
   1. リージョン: プルダウン リストからロケーションを選択します

      コネクタをサポートしているリージョンは次のとおりです。

      サポートされているすべてのリージョンのリストについては、ロケーションをご覧ください。

   2. [Next] をクリックします。
4. [接続の詳細] セクションで、次の操作を行います。
   1. コネクタ: 使用可能なコネクタのプルダウン リストから [Freshbooks] を選択します。
   2. コネクタのバージョン: 使用可能なバージョンのプルダウン リストからコネクタのバージョンを選択します。
   3. [接続名] フィールドに、接続インスタンスの名前を入力します。

      接続名は次の条件を満たす必要があります。

      • 接続名には英字、数字、ハイフンを使用できます。
      • 文字は小文字のみを使用できます。
      • 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
      • 接続名は 63 文字以内で指定してください。
   4. 必要に応じて、接続インスタンスの [説明] を入力します。
   5. サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
   6. 必要に応じて、接続ノードの設定を構成します。
      • ノードの最小数: 接続ノードの最小数を入力します。
      • ノードの最大数: 接続ノードの最大数を入力します。

      ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。

   注: 接続ノード値をカスタマイズできるのは、従量課金制のお客様のみです。
   7. アカウント ID: 接続先のアカウント ID。値が指定されていない場合は、最初に返される値が使用されます。
   8. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
   9. [Next] をクリックします。
5. [認証] セクションで、認証の詳細を入力します。
   1. [認証タイプ] を選択し、関連する詳細を入力します。

      Freshbooks 接続でサポートされる認証タイプは次のとおりです。

      • OAuth 2.0 認証コードの付与

   これらの認証タイプの構成方法については、認証を構成するをご覧ください。

   2. [Next] をクリックします。
6. レビュー: 接続と認証の詳細を確認します。
7. [Create（作成）] をクリックします。

認証を構成する

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

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

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

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

注: コネクタタスクで、コネクタのエンティティ、オペレーション、アクションを表示できます。

• エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。

  ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。

• オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
  • リスト
  • 取得
  • 作成
  • 更新
  • 削除

  使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがどのエンティティ オペレーションもサポートしていない場合、サポートされていないオペレーションは Operations リストに表示されません。

• アクション: コネクタ インターフェースを介して統合で使用できる最初のクラス関数です。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

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

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

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

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

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

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

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

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

   ここで、2009015 は Expense Categories エンティティの主キー値です。

例 - 請求書を作成する

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

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Invoices を選択します。
3. [Create] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {"CustomerId": 68039.0,
   "FirstName": "John",
   "CreateDate": "2023-09-13"
   }

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

   {
   "Id": "49594.0"
   }

例 - 請求書の更新

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

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Invoices を選択します。
3. [Update] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
   "FirstName": "James"
   }

5. [entityId] をクリックし、[デフォルト値] フィールドに「36741.0」と入力します。

   [entityId] を指定する代わりに、[filterClause] を 36741.0 に設定することもできます。

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

   {
   "Id": "36741.0"
   }

例 - レコードを削除する

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

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Payments を選択します。
3. [Delete] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタ] タスクの [タスク入力] セクションで [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 フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。

次のステップ

• 接続を一時停止して再開する方法を確認する。
• コネクタの使用状況をモニタリングする方法を確認する。
• コネクタログを表示する方法を確認する。