Excel Online

Excel Online コネクタを使用して、Excel Online でオペレーションを実行します。

始める前に

Google Cloud プロジェクトを構成し、OAuth アプリケーションを作成し、必要な権限を付与します。

Google Cloud プロジェクトを構成する。

Excel Online コネクタを使用する前に、Google Cloud プロジェクトで次の作業を行います。

次のサービスを有効にします。
- secretmanager.googleapis.com（Secret Manager API）
- connectors.googleapis.com（Connectors API）
サービスを有効にする方法については、サービスを有効にするをご覧ください。

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

カスタム OAuth アプリケーションを作成する - Azure AD

Azure ポータルにログインします。
左側のナビゲーションパネルで、[Azure Active Directory]、[applicationRegistrations] の順に選択します。
[新規登録] をクリックします。
アプリケーションの名前を入力します。
必要なテナント設定（単一テナントまたはマルチテナント、公開または限定公開）を選択します。

デフォルトオプションの [Accounts in this organizational directory only] を選択した場合、Microsoft Excel Online 用 CData JDBC ドライバとの接続を確立するときに、AzureTenant 接続プロパティを Azure AD テナントの ID に設定する必要があります。そうでない場合、認証の試行はエラーで失敗します。
アプリケーションを限定公開でのみ使用する場合は、[Accounts in this organization directory only] を指定します。
アプリケーションを配布する場合は、マルチテナントオプションのいずれかを選択します。

リダイレクト URL を http://localhost:33333（ドライバのデフォルト）に設定するか、別のポートを指定して、定義した正確な Reply URL に CallbackURL を設定します。
[登録] をクリックして、新しいアプリケーションを登録します。アプリ管理画面が表示されます。アプリケーション（クライアント）ID の値を OAuthClientId として、ディレクトリ（テナント）ID を AzureTenant としてメモします。
[Certificates & Secrets] に移動し、アプリケーションの認証タイプを定義します。使用できる認証には、証明書（推奨）とクライアントシークレットの 2 種類があります。

証明書認証の場合: [Certificates & Secrets] で [証明書をアップロード] を選択し、ローカルマシンから証明書をアップロードします。
新しいクライアントシークレットを作成する場合: [Certificates & Secrets] で、アプリケーションの新しいクライアントシークレットを選択し、有効期間を指定します。クライアントシークレットが保存されると、Microsoft Excel Online にキー値が表示されます。この値は一度しか表示されないため、コピーしておいてください。この値が OAuthClientSecret になります。

[API 権限] > [追加] > [Delegated permissions] を選択します。
次のアプリケーション権限を追加します。Sites.Read.All、Files.Read、Files.Read.All、Files.Read.Selected、Files.ReadWrite、Files.ReadWrite.All、Files.ReadWrite.AppFolder、Files.ReadWrite.Selected、offline_access。
変更を保存します。
管理者の同意が必要な権限（アプリケーション権限など）の使用を指定している場合は、現在のテナントの [API 権限] ページで権限を付与できます。

カスタム OAuth アプリケーションを作成する - Azure サービスプリンシパル

検索バーを使用して、定期購入サービスを見つけます。
[サブスクリプション] ページを開きます。
アプリケーションを割り当てるサブスクリプションを選択します。
[アクセス制御（IAM）] を開きます。
[追加] > [Add role assignment] を選択します。Microsoft Excel Online で、[Add role assignment] ページが開きます。
カスタム Azure AD アプリケーションにオーナーのロールを割り当てます。

アプリケーションにロールを割り当てる

サブスクリプションのリソースにアクセスするには、アプリケーションにロールを割り当てる必要があります。
検索バーでサブスクリプションサービスを検索して選択し、[サブスクリプション] ページを開きます。
アプリケーションを割り当てるサブスクリプションを選択します。
[アクセス制御（IAM）] を開き、[追加] > [Add role assignment] を選択して、[Add role assignment] ページを開きます。
作成した Azure AD アプリに割り当てるロールとして、[オーナー] を選択します。

Azure ポータルにログインします。
[App Registrations] に移動し、作成したカスタム OAuth アプリケーションを見つけます。
[API 権限] で [Grant Consent] をクリックします。

クライアント認証情報の権限を付与する

Azure ポータルにログインします。
[App Registrations] に移動します。
作成したアプリケーションを見つけて、[API 権限] を開きます。
Microsoft Graph の権限を選択します。権限には、委任権限とアプリケーション権限の 2 つの異なるセットがあります。
[Application Permissions] で、統合に必要な権限を選択します。

コネクタを構成する

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

Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
[接続] ページに移動
[+ 新規作成] をクリックして [接続の作成] ページを開きます。
[ロケーション] セクションで、接続のロケーションを選択します。
1. リージョン: プルダウンリストからロケーションを選択します
  コネクタをサポートしているリージョンは次のとおりです。
  サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。
2. [次へ] をクリックします。
[接続の詳細] セクションで、次の操作を行います。
1. コネクタ: 使用可能なコネクタのプルダウンリストから [Excel Online] を選択します。
2. コネクタのバージョン: 使用可能なバージョンのプルダウンリストからコネクタのバージョンを選択します。
3. [接続名] フィールドに、接続インスタンスの名前を入力します。
  接続名は次の条件を満たす必要があります。
  - 接続名には英字、数字、ハイフンを使用できます。
  - 文字は小文字のみを使用できます。
  - 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
  - 接続名は 49 文字以内で指定してください。
4. 必要に応じて、接続インスタンスの [説明] を入力します。
5. 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
6. サービスアカウント: 必要なロールを持つサービスアカウントを選択します。
7. 必要に応じて、接続ノードの設定を構成します。
  - ノードの最小数: 接続ノードの最小数を入力します。
  - ノードの最大数: 接続ノードの最大数を入力します。
  ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。
8. Azure テナント: データへのアクセスに使用されている Microsoft Online テナント。指定しない場合は、デフォルトのプロジェクトが使用されます。
9. ドライブ: ドライブの ID。[ドライブ] ビューと [SharePointSites] ビューを使用すると、アクセス権のあるすべてのサイトとドライブを表示できます。
10. SharePoint URL: SharePoint サーバーのベース URL。
11. 共有ドキュメントを表示する: 共有ドキュメントを表示するかどうか。
12. ワークブック: ワークブックの名前または ID。
13. ヘッダー: 最初の行から列名を検出するかどうかを指定します。
14. テーブル: ワークシートのセル範囲を含むテーブルへの接続を制限します。形式: [{ワークブック名}_{ワークシート名}!{範囲}]
15. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
16. [次へ] をクリックします。
1. [認証] セクションで、認証の詳細を入力します。これらの認証情報の構成方法については、認証を構成するをご覧ください。
2. [次へ] をクリックします。
Review: 接続と認証の詳細を確認します。
[作成] をクリックします。

認証を構成する

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

クライアント ID: アクセストークンのリクエストに使用されるクライアント ID。
スコープ: 必要なスコープのカンマ区切りのリスト。
クライアントシークレット: アクセストークンのリクエストに使用されるクライアントシークレット。
認証 URL: クライアントの作成時に生成された認証 URL

Excel Online - ウェブ接続の種類

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

フィールド名	詳細
ロケーション	us-central1
コネクタ	Excelonline
コネクタのバージョン	1
接続名	excelonline-gcp
サービスアカウント	SERVICE_ACCOUNT_NAME@serviceaccount
Azure テナント	9b****----*******12
ドライブ	b!p_648NCXwk6hJ1pfyn0SeFaithFnRM1JmYNur9asmHAs2k8qe5UsR5a1cX6luuD0
SharePoint の URL	https://*****.sharepoint.com/
共有ドキュメントを表示	True
ノードの最小数	2
ノードの最大数	50
クライアント ID	e89***----*******b6
スコープ	https://graph.microsoft.com/.default
クライアントシークレット	CLIENT_SECRET
シークレットのバージョン	1
認証 URL	https://login.microsoftonline.com/{Azure-Tenant}/oauth2/v2.0/authorize

接続作成後の追加手順

認証に OAuth 2.0 - Authorization code を選択した場合は、接続の作成後に次の追加の手順を行う必要があります。

接続ページで、新しく作成された接続を見つけます。
新しいコネクタの [ステータス] は [承認が必要] になります。
[承認が必要] をクリックします。
これにより、[承認の編集] ペインが表示されます。
[リダイレクト URI] の値を外部アプリケーションにコピーします。
認可の詳細を確認します。
[Authorize（承認）] をクリックします。
認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。

認証コードの再認可

Authorization code 認証タイプを使用しているユーザーが、Azure Synapse アプリケーションの構成を変更した場合は、Azure Synapse 接続を再認可する必要があります。接続を再認可するには、次の手順を行います。

[接続] ページで必要な接続をクリックします。
これにより、[接続の詳細] ページが開きます。
[編集] をクリックして、接続の詳細を編集します。
[認証] セクションで [OAuth 2.0 - 認証コード] の詳細を確認します。
必要に応じて必要な変更を加えます。
[保存] をクリックします。接続の詳細ページに移動します。
[認証] セクションで [承認の編集] をクリックします。これにより、[承認] ペインが表示されます。
[Authorize（承認）] をクリックします。
認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。

システムの上限

Excel Online コネクタで処理できる Excel ファイルの最大サイズは 25 MB です。

Excel Online コネクタは、ノードごとに 1 秒あたり 3 件のトランザクションを処理することができ、この上限を超えるトランザクションはすべてスロットルされます。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

注: Integration Connectors ノードの数は、使用状況に応じて動的に自動スケーリングされます。ただし、自動スケーリングを待たずに大量の容量を確保する場合は、接続の最小ノード値を調整できます。1 つの接続により多くのトランザクションを処理するには、より多くのノードが必要です。逆に、接続が処理するトランザクションが少ない場合は、必要なノードの数が少なくなります。ノードの値を構成するには、次の手順を行います。

従量課金制をご利用のお客様は、接続の編集ページでノードの最小値と最大値を構成します。
サブスクリプションベースで利用されているお客様は、サポートにお問い合わせください。

ノードが処理できる最大トランザクションは、さまざまな要因によって異なります。そのため、スループットを高めるために最小ノードを調整する前に、バックエンドシステムが必要なトラフィックを処理するために最適に設定されているかどうかを確認することをおすすめします。

統合で Excel Online 接続を使用する

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

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

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

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

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

アクション

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

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

Add Worksheet アクション

既存の Excel Online ワークブックにワークシートを追加します。

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

パラメータ名	データ型	必須	説明
タイトル	文字列	True	ワークシートの名前。
WorkbookId	文字列	True	ワークブックの ID。この ID は、現在の接続プロパティでアクセス可能なドライブに属している必要があります。

AddWorksheet アクションの出力パラメータ

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

例

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

アクションの例

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

例 - AddWorksheet アクションを実行する

この例では、既存の Excel Online ワークブックにワークシートを追加します。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[AddWorksheet ] アクションを選択してから、[完了] をクリックします。
[データマッピング] セクションで Open Data Mapping Editor をクリックし、Input フィールドに次のような値を入力します。
```
{   
"WorkbookId": "01M7ENMYA2QJVY77NPOFD3WQIJ6PNNX5VL",
"Title": "Worksheet_SP1"
}
```

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

[{
  "Success": "true",
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#workbookWorksheet",
  "@odata.type": "#microsoft.graph.workbookWorksheet",
  "@odata.id": "/drives('b%21p_648NCXwk6hJ1pfyn0SeFaithFnRM1JmYNur9asmHAs2k8qe5UsR5a1cX6luuD0')/items('01M7ENMYA2QJVY77NPOFD3WQIJ6PNNX5VL')/workbook/worksheets(%27%7BD9372F53-CB1B-4082-9E13-02E65C2FC233%7D%27)",
  "id": "{D9372F53-CB1B-4082-9E13-02E65C2FC233}",
  "name": "Worksheet_SP1",
  "position": "1",
  "visibility": "Visible"
}]

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

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

例 - すべてのドライブを一覧参照する

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity リストから [ドライブ] を選択します。
[List] オペレーションを選択してから、[完了] をクリックします。

例 - すべての SharedDocument を一覧参照する

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity リストから SharedDocuments を選択します。
[List] オペレーションを選択してから、[完了] をクリックします。

例 - すべてのワークブックを一覧参照する

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity リストから [Workbooks] を選択します。
[List] オペレーションを選択してから、[完了] をクリックします。

例 - ドライブを取得する

[Configure connector task] ダイアログで、[Entities] をクリックします。

Entity

[Get] オペレーションを選択してから、[完了] をクリックします。
エンティティ ID を「Get single Drives」に設定します。エンティティ ID を設定するには、[データマッピング] の [データマッパー] セクションで [データマッピングエディタを開く] をクリックし、[入力値] フィールドに「b!ZETdEU1T_UOBEzbgDmsvcubxvUaXbcJNrrNPM4LqokkwLC3zCRPiQLi2PBfCs9-v」を入力し、EntityId をローカル変数として選択します。

例 - SharedDocument を取得する

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity リストから SharedDocuments を選択します。
[Get] オペレーションを選択してから、[完了] をクリックします。
エンティティ ID を「Get single SharedDocument」に設定します。エンティティ ID を設定するには、[データマッピング] の [データマッパー] セクションで [データマッピングエディタを開く] をクリックし、[入力値] フィールドに「01BDTL6TS3OQ3HDXCKGREILDYKY47S7LEI」を入力し、EntityId をローカル変数として選択します。

例 - ワークブックを取得する

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity リストから [Workbooks] を選択します。
[Get] オペレーションを選択してから、[完了] をクリックします。
エンティティ ID を「Get single Workbooks」に設定します。エンティティ ID を設定するには、[データマッピング] の [データマッパー] セクションで [データマッピングエディタを開く] をクリックし、[入力値] フィールドに「01M7ENMYA2QJVY77NPOFD3WQIJ6PNNX5VL」を入力し、EntityId をローカル変数として選択します。

例 - ブックからデータを削除する

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity リストから Book 4567_Sheet1 を選択します。
[Delete] オペレーションを選択してから、[完了] をクリックします。
エンティティ ID を「Delete Book 4567_Sheet1」に設定します。エンティティ ID を設定するには、[データマッピング] の [データマッパー] セクションで [データマッピングエディタを開く] をクリックし、[入力値] フィールドに「5.0」と入力し、EntityId をローカル変数として選択します。

例 - Formulae_Sheet_List の数式を作成する

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity リストから Formulae_Sheet_List を選択します。
[Create] オペレーションを選択し、[完了] をクリックします。

[タスク] の [データマッパー] セクションで、OpenDataMapping エディタをクリックし、field: に次のような値を入力します。

 {
  "Excel_Sheet": "Old_Excel",
  "B": "=SUM(C8:D8)",
  "C": "6",
  "D": "6"
  }
  Running this example, returns a response similar to the following in the Connector
  task's connectorOutputPayload output variable:
  {
  "Id": 8.0
  }

Example - Create With_Headers

In the Configure connector task dialog, click Entities.

Select Book 4567_Book4567_Sheet1 from the Entity list.

Select the Create operation, and then click Done.

In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:

{ "Name": "workbooknew", "Type": "newly created", "Sl no": 5.0 }

Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

{
  "Id": 6.0
  }

Example - Create Without_Headers

In the Configure connector task dialog, click Entities.

Select Book 4567_Book4567_Sheet1 from the Entity list.

Select the Create operation, and then click Done.

In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:

{ "A": "6", "B": "Halo", "C": "Stardust" }

Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

{
  "Id": 7.0
  }

Example - Update an Formula for Formulae_Sheet_List

In the Configure connector task dialog, click Entities.

Select Formulae_Sheet_List from the Entity list.

Select the Update operation, and then click Done.

Set the entity ID to Update a Formulae_Sheet_List. To set the entity ID, in the Data mapper section of the Tasks, click entityId and then enter 8.0 in the given field.
In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:
```
 
  {
  "B": "=MAX(C8:D8)",
  "C": "7",
  "D": "10"
  } 
  
```

この例を実行すると、コネクタタスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

 
  {   
  "Id": 8.0
  }

例 - Without_Header を更新する

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity リストからブック「4567_Book4567_Sheet1」を選択します。
[Update] オペレーションを選択し、[完了] をクリックします。
エンティティ ID を設定して、ブック「4567_Book4567_Sheet1」を更新します。エンティティ ID を設定するには、[タスク] の [データマッパー] セクションで [entityId] をクリックし、該当するフィールドに「7.0」と入力します。
[タスク] の [データマッパー] セクションで、OpenDataMapping エディタをクリックし、field: に次のような値を入力します。
```
 
   {
    "B": "cosmically",
    "C": "interlinked"
  }  
  
```

この例を実行すると、コネクタタスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

 
  {   
  "Id": 7.0
  }

例 - Update_With_Header

[Configure connector task] ダイアログで、[Entities] をクリックします。

Entity

[Update] オペレーションを選択し、[完了] をクリックします。
エンティティ ID を「Update a Book 4567_Book4567_Sheet1」に設定します。エンティティ ID を設定するには、[タスク] の [データマッパー] セクションで [entityId] をクリックし、指定されたフィールドに「6.0」と入力します。
[タスク] の [データマッパー] セクションで、OpenDataMapping エディタをクリックし、field: に次のような値を入力します。
```
 
   {
    "Name": "updated",
    "Type": "newupdate"
  }
  
```

この例を実行すると、コネクタタスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

 
  {   
  "Id": 6.0
  }

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

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

Excel Online

始める前に

Google Cloud プロジェクトを構成する。

カスタム OAuth アプリケーションを作成する - Azure AD

カスタム OAuth アプリケーションを作成する - Azure サービス プリンシパル

アプリケーションにロールを割り当てる

管理者の同意を付与する

クライアント認証情報の権限を付与する

コネクタを構成する

認証を構成する

Excel Online - ウェブ接続の種類

接続作成後の追加手順

認証コードの再認可

システムの上限

統合で Excel Online 接続を使用する

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

アクション

Add Worksheet アクション

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

AddWorksheet アクションの出力パラメータ

例

アクションの例

例 - AddWorksheet アクションを実行する

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

例 - すべてのドライブを一覧参照する

例 - すべての SharedDocument を一覧参照する

例 - すべてのワークブックを一覧参照する

例 - ドライブを取得する

例 - SharedDocument を取得する

例 - ワークブックを取得する

例 - ブックからデータを削除する

例 - Formulae_Sheet_List の数式を作成する

Example - Create With_Headers

Example - Create Without_Headers

Example - Update an Formula for Formulae_Sheet_List

例 - Without_Header を更新する

例 - Update_With_Header

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

次のステップ

カスタム OAuth アプリケーションを作成する - Azure サービスプリンシパル

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