本記事ではAPI Driver for Excelの利用手順を解説します。
なお、API Driver for Excelはデスクトップ版のExcelにてご利用いただける製品です。Excel Onlineではご利用いただけませんのでご留意ください。
API Driver for Excelのダウンロードとインストール
1.下記よりAPI Driver for Excelをダウンロードし、インストールウィザードの指示にしたがってインストールを行います。
https://jp.cdata.com/apidriver/download/
API Profileのダウンロード
2.下記より利用したいデータソース(API)のAPI Profileをダウンロードします(本記事では例として「freee Accounting API Profile」を利用します)。
https://jp.cdata.com/apidriver/download/
※API Profileとは?
API Driverを介してSQLでクエリ(問い合わせ)したいAPIのスキーマ(データ構造)などをまとめた定義ファイルのサンプルです。
定義ファイルは
ご自身で作成いただくことも可能ですが、弊社ではいくつかのAPIについてAPI Profileという形であらかじめご用意しております。
3.2でダウンロードしましたAPI ProfileをExcel(デスクトップ版)からアクセス可能なフォルダ(例:C:\API Profiles)に保存(移動)します。
データソースとの接続(含む接続テスト)
4.Excelを開きます。
5.タブ[CData]>[データの取得]>[取得元:API]をクリックします。
6.[Profile]に3で保存(移動)したAPI Profileのフルパス(例:C:\API Profiles\freeeAccounting.apip)を入力します。
7.[接続プロパティ]のその他の項目へ接続に必要な情報を入力していきます。
必要な接続情報については、下記のような流れで各API Profileのオンラインヘルプページにてご確認いただけますが、接続情報はデータソース側であらかじめ設定したり、確認や取得を行ったりといった事前作業が必要となり、その手順はデータソースごとに異なります。
ですので、入力情報の設定や確認、取得方法が不明な場合は、画面右上の「お問い合わせ」などからお気軽にお問い合わせください。
7-1.API Profileのオンラインヘルプページを開きます。
オンラインヘルプページは、例えば下記ページのデータソース名 > ヘルプドキュメントより開くことが可能です。
https://jp.cdata.com/apidriver/
7-2.オンラインヘルプページの項目「Connecting to XX」を開きます。
例えば、データソース=freee Accountingの場合、接続方法は「Using OAuth Authentication(OAuth認証)」であることがわかります。
また、必要な情報の取得方法などが記載されていることが確認できます。
設定可能なオプションについての情報も確認できます。
7-3.7-2で確認した情報を用いて、[接続プロパティ]の各項目へ接続に必要な情報を入力していきます。
(例)データソース=freee Accountingの場合
7-2で確認した情報を踏まえると、CompanyId、Authscheme、OAuthClientID、OAuthClientSecret、CallbackURL、InitiateOAuthの入力が必要となりますが、CompanyIdについては「And, You get CompanyId from Comapnies view.(そして、CompanyIdはCompaniesビューから取得します。)」と、freee Accountingとの接続が確立した後に取得可能なデーブル・ビューの方で確認するよう指示されているので、まずはCompanyId以外の情報を入力します。
8.[接続テスト]をクリックします。
9.表示される指示にしたがって必要な設定をすすめます。データソースによっては、このステップが生じない場合もあります。
(例)データソース=freee Accountingの場合
(1)Webブラウザが立ち上がり、アクセスの許可を実施します。
(2)下記のページが表示されたらWebブラウザを右上の「✕」などで閉じます。
10.メッセージ「サーバーに接続できました」が表示されたら[OK]をクリックし、メッセージを閉じます。
11.[OK]をクリックします。
データを取得する
12.[選択]をクリックします。
13.テーブル・ビューの一覧が表示されるので、利用したいテーブル・ビューを選択し、[OK]をクリックします。
※データソース=freee Accountingの場合は、最終的に「CompanyId」情報の確認が必要になりますので、13では「Companies」を選択してください。
14.必要に応じてフィルタなどを設定し、[OK]をクリックします。
15.Sheetにデータが取得されますので、あとはいつも通りデータの集計など実施いただけます。
※データソース=freee Accountingの場合は、Sheetに取得した「Companies」にてId(CompanyId)を確認し、以下の手順にて接続設定をメンテナンスください。
(1)[CData]>[接続マネージャー]> CData Excel Add-In for APIの項目にある4~11の手順で作成した接続を選択し、[編集]をクリックします。

(2)[ProfileSettings]に「CompanyId=」につづけて、確認したIdを入力します。

※[ProfileSettings]に複数のプロパティを入れる必要がある場合は「;(セミコロン)」で区切りながら入力してください。
(例)CompanyId=1234567;XXXXX=XXXXX;
(3)[切断]をクリックしてください。

(4)[接続テスト]をクリックします。

(5)メッセージ「サーバーに接続できました」が表示されたら各[OK]をクリックし、メッセージや接続エディタウィンドウを閉じます。

(6)既存の接続ウィンドウも[閉じる]をクリックし、閉じます。

16.さらに追加でテーブル・ビューのデータを取得したい場合は、タブ[CData]>[データの取得]>[取得元:API]より4~11の手順で作成した接続をクリックします。
17.あとは手順12~15の要領でデータを取得ください。
さいごに
API Driver for Excelの基本の利用の流れは以上のとおりです。
特に手順の7のあたりは、接続したいデータソースの種類により手順の詳細が異なる部分ですので、ご不明な場合はお気軽にお問い合わせフォームなどからおたずねください!