Neo4J のデータでGoogle Sheets を拡張
マクロ、カスタム関数、アドオンを使用してGoogle スプレッドシートからNeo4J のデータとやり取りします。CData API Server は、ADO.NET Provider for Neo4j(またはその他の250+ ADO.NET Providers)と組み合わせることで、Google Sheets のようなクラウドベースのモバイルアプリケーションからNeo4J のデータに接続できるようになります。API Server は、Neo4J およびCData ADO.NET Providers にサポートされるすべてのソースのOData サービスを生成する軽量のWeb アプリケーションです。
Google Apps Script(GAS)は、これらのOData サービスをJSON 形式で利用できます。この記事では、Google スプレッドシートにProductCategory データを取り込みシンプルなアドオンを作成する方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなNeo4J OData サービスを作成していきましょう。
Neo4J への接続
GAS からNeo4J のデータを操作するには、まずNeo4J への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Neo4J」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Neo4J への接続設定を行っていきましょう!
-
Neo4j に接続するには、次の接続プロパティを設定します。
- Server:Neo4j インスタンスをホスティングしているサーバー。
- Port:Neo4j サービスが稼働しているポート。プロバイダーは、デフォルトでHTTP (7474) ポートに接続します。
- User:Neo4j インスタンスを使用しているユーザーのユーザー名。
- Password:Neo4j インスタンスを使用しているユーザーのパスワード。
- Database:Neo4j インスタンスで対象とするデータベース。デフォルトは"neo4j" です。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
Neo4j に接続するには、次の接続プロパティを設定します。
- Server:Neo4j インスタンスをホスティングしているサーバー。
- Port:Neo4j サービスが稼働しているポート。プロバイダーは、デフォルトでHTTP (7474) ポートに接続します。
- User:Neo4j インスタンスを使用しているユーザーのユーザー名。
- Password:Neo4j インスタンスを使用しているユーザーのパスワード。
- Database:Neo4j インスタンスで対象とするデータベース。デフォルトは"neo4j" です。
API Server のユーザー設定
次に、API Server 経由でNeo4J にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Neo4J 用のAPI エンドポイントの作成
ユーザーを作成したら、Neo4J のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でNeo4J への接続を設定してユーザーを作成し、API Server でNeo4J データのAPI を追加しました。これで、OData 形式のNeo4J データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Neo4J のデータを取得する
「Tools」->「Script Editor」とクリックして、スプレッドシートからScript Editor を開きます。Script Editor で次の機能を追加し、スプレッドシートにOData クエリの結果を入力します。
function retrieve(){
var url = "https://MyUrl/api.rsc/ProductCategory?select=Id,CategoryId,CategoryName,CategoryOwner";
var response = UrlFetchApp.fetch(url,{
headers: {"Authorization":"Basic " + Utilities.base64Encode("MyUser:MyAuthtoken")}
});
var json = response.getContentText();
var sheet = SpreadsheetApp.getActiveSheet();
var a1 = sheet.getRange('a1');
var index=1;
var productcategory = JSON.parse(json).value;
var cols = [["Id","CategoryId","CategoryName","CategoryOwner"]];
sheet.getRange(1,1,1,4).setValues(cols);
row=2;
for(var i in productcategory){
for (var j in productcategory[i]) {
switch (j) {
case "Id":
a1.offset(row,0).setValue(account[i][j]);
break;
case "CategoryId":
a1.offset(row,1).setValue(account[i][j]);
break;
case "CategoryName":
a1.offset(row,2).setValue(account[i][j]);
break;
case "CategoryOwner":
a1.offset(row,3).setValue(account[i][j]);
break;
}
}
row++;
}
}
次のステップに従って、開いたタイミングでスプレッドシートに入力するインストール可能なトリガーを追加します。
- 「Resources」->「Current Project's Triggers」->「Add a New Trigger」とクリックします。
- 「Run」メニューで「retrieve」を選択します。
- 「From Spreadsheet」を選択します。
- 「On open」を選択します。
ダイアログを閉じると、アプリケーションへのアクセスを許可するように要求されます。
「Publish」->「Test as Add-On」とクリックすることで、スクリプトを確認できます。バージョン、インストールタイプ、およびスプレッドシートを選択し、テストの構成を作成します。作成したら、選択して実行できます。