ZohoBooks

ZohoBooks コネクタを使用すると、ZohoBooks システムに対して SQL オペレーションを実行できます。

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

このコネクタは、Zoho Books API V3 を利用して、Zoho Books データへの双方向アクセスを可能にします。

準備

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

Google Cloud プロジェクトで次の操作を行います。
- ネットワーク接続が設定されていることを確認します。ネットワークパターンの詳細については、ネットワーク接続をご覧ください。
- コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
- コネクタに使用するサービスアカウントに、次の IAM ロールを付与します。
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  サービスアカウントは特別なタイプの Google アカウントで、Google API のデータにアクセスするのに認証を受ける必要がある人間以外のユーザーを表します。サービスアカウントがない場合は、サービスアカウントを作成する必要があります。詳細については、サービスアカウントを作成するをご覧ください。
- 次のサービスを有効にします。
  - secretmanager.googleapis.com（Secret Manager API）
  - connectors.googleapis.com（Connectors API）
  サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

コネクタを構成する

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

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

認証を構成する

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

OAuth 2.0 認証コード付与
- クライアント ID: 作成したアプリ用にコネクタから提供されたクライアント ID。
- クライアントシークレット: 作成した接続されているアプリのクライアントシークレットを含む Secret Manager のシークレットです。
- アクセストークン: 作成した接続済みアプリに提供された OAuth アクセストークンを含む Secret Manager の Secret。

ZohoBooks の認証を構成する

以降のセクションでは、ZohoBooks コネクタの構成方法について説明します。

ZohoBooks アカウントを設定する

ZohoBooks アカウントの設定の詳細については、アカウントの作成をご覧ください。

デベロッパーアカウントを設定してクライアントアプリを作成する

ZohoBooks デベロッパーアカウントとクライアントアプリの作成については、クライアントアプリの作成をご覧ください。

認証の設定

認証を設定するには、次の操作を行います。

Cloud コンソールの [Integration Connectors] ページに移動します。
特定の接続の詳細を表示するには、既存の接続の表で接続名をクリックします。
[認証] セクションで、[接続を承認] をクリックして承認プロセスを開始します。
リダイレクト URI をコピーする
ZohoBooks デベロッパーコンソールに移動します。
[Service based application client authorized redirect URI] セクションに、リダイレクト URI を追加します。
[Integration Connectors] ページで、リダイレクト URI をコピーした ZohoBooks 接続ページに移動し、[承認] をクリックします。

ZohoBooks サイトにリダイレクトされ、承認を求められます。

接続構成のサンプル

このセクションでは、Zoho Books 接続の作成時に構成するさまざまなフィールドのサンプル値を示します。

ウェブ接続の種類

フィールド名	詳細
リージョン	us-east4
コネクタ	ZohoBooks
コネクタのバージョン	1
接続名	zohobooks-google-cloud-conn
サービスアカウント	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
アカウントサーバー	https://books.zoho.in
組織 ID	ORGANIZATION_ID
読み上げの詳細設定	5
ノードの最小数	2
ノードの最大数	50
クライアント ID	CLIENT_ID
スコープ	ZohoBooks.fullaccess.all
クライアントシークレット	CLIENT_SECRET
シークレットのバージョン	1

統合で ZohoBooks 接続を使用する

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

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

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

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

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

アクション

このセクションでは、Zoho Books 接続でサポートされているアクションを一覧表示します。アクションの構成方法については、アクションの例をご覧ください。

注: すべてのアクションの結果は、統合を実行した後に Connectors タスクの connectorOutputPayload レスポンスパラメータで JSON レスポンスとして利用できます。

ImportCreditCardStatement アクション

このアクションにより、クレジットカートの明細書をインポートできます。

ImportCreditCardStatement アクションの入力パラメータ

パラメータ名	データ型	必須	説明
AccountId	文字列	×	銀行 / クレジットカードのアカウントの ID
TransactionsTransactionDebitOrCredit	文字列	×	トランザクションがデビットかクレジットかを示します。
TransactionsTransactionAmount	文字列	×	トランザクションに関連する金額。
TransactionsTransactionDescription	文字列	×	トランザクションの説明。
TransactionsTransactionDate	文字列	×	トランザクションの日付。

ImportCreditCardStatement アクションの構成方法については、例をご覧ください。

アクションの例

このセクションでは、このコネクタでいくつかのアクションを実行する方法について説明します。

例 - クレジットカード明細書をインポートする

この例では、クレジットカード明細書をインポートします。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[ImportCreditCardStatement] アクションを選択してから、[完了] をクリックします。

[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

{
  "AccountId": "1470449000000023015",
  "TransactionsTransactionDebitOrCredit": "credit",
  "TransactionsTransactionAmount": "200",
  "TransactionsTransactionDescription": "Transaction done from Google account",
  "TransactionsTransactionDate": "2023-05-05"
}

アクションが成功すると、ImportCreditCardStatement タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Status": "Your bank statement has been imported."
}]

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

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

例 - すべての見積もりを表示する

この例では、Estimates エンティティ内のすべてのレコードを一覧表示します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から Estimates を選択します。
[List] オペレーションを選択し、[完了] をクリックします。
必要に応じて、コネクタタスクの [タスク入力] セクションでフィルタ句を指定して、結果セットをフィルタリングできます。論理演算子を使用して複数のフィルタ条件を指定することもできます。

例 - 販売注文を取得する

この例では、SalesOrder エンティティから指定した販売注文を取得します。

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

例 - 銀行取引を作成する

この例では、BankTransactions エンティティに銀行取引レコードを作成します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から BankTransactions を選択します。
[Create] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"TransactionType": "transfer_fund",
"FromAccountId": "1470449000000000459",
"ToAccountId": "1470449000000110001",
"Amount": 45.0,
"CurrencyId": "1470449000000000064"
}
```
統合に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。
```
{
"TransactionId": "1470449000000231005"
}
```

例 - 顧客の連絡先情報を更新する

この例では、CustomerContacts エンティティ内の指定された顧客レコードを更新します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から CustomerContacts を選択します。
[Update] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"Department": "Development",
"ContactId": "1470449000000038003"
}
```
[コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに 1470449000000038005 を入力します。

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

{
"CustomerContactId": "1470449000000038005"
}

例 - 請求書レコードを削除する

この例では、InvoiceDetails エンティティ内の指定された請求書レコードを削除します。

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

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

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