AlloyDB のデータでGoogle Sheets を拡張

古川えりか
コンテンツスペシャリスト

Google Apps Script からAPI Server に呼び出しを発行。

マクロ、カスタム関数、アドオンを使用してGoogle スプレッドシートからAlloyDB のデータとやり取りします。CData API Server は、ADO.NET Provider for AlloyDB（またはその他の250+ ADO.NET Providers）と組み合わせることで、Google Sheets のようなクラウドベースのモバイルアプリケーションからAlloyDB のデータに接続できるようになります。API Server は、AlloyDB およびCData ADO.NET Providers にサポートされるすべてのソースのOData サービスを生成する軽量のWeb アプリケーションです。

Google Apps Script（GAS）は、これらのOData サービスをJSON 形式で利用できます。この記事では、Google スプレッドシートにOrders データを取り込み、変更を加えたときにAlloyDB のデータの更新を実行するシンプルなアドオンを作成する方法を説明します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなAlloyDB OData サービスを作成していきましょう。

AlloyDB への接続

GAS からAlloyDB のデータを操作するには、まずAlloyDB への接続を作成・設定します。

API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「AlloyDB」を選択します。
事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >>
それでは、AlloyDB への接続設定を行っていきましょう！
AlloyDB 接続プロパティの取得・設定方法

AlloyDB に接続するには、次の接続プロパティが必要です。
- Server：AlloyDB データベースをホスティングしているサーバーのホスト名またはIP アドレス。
- Port（オプション）：AlloyDB データベースをホスティングしているサーバーのポート。このプロパティはデフォルトで5432に設定されます。
- User：AlloyDB サーバーに認証する際に使われるユーザー。
- Password：AlloyDB サーバーに認証する際に使われるパスワード。
- Database（オプション）：AlloyDB サーバーに接続する場合のデータベース。設定されていない場合は、ユーザーのデフォルトデータベースが使用されます。
AlloyDB への認証

標準認証
標準認証（事前に提供されたユーザーとパスワードの組み合わせを使用）は、デフォルトの認証形式です。
標準認証で接続する場合は、これ以上のアクションは必要ありません。

pg_hba.conf 認証スキーム

CData 製品がサポートしている他の認証方法では、AlloyDB サーバー上のpg_hba.conf ファイルで有効化する必要があります。

AlloyDB サーバーでの認証の設定については、こちらを参照してください。
MD5
pg_hba.conf ファイルのauth-method をmd5 に設定すると、MD5 パスワード検証を使用して認証できます。
SASL
CData 製品は、SASL（特にSCRAM-SHA-256）でパスワードを検証することで認証できます。
この認証方法を使用するには、pg_hba.conf ファイルのauth-method をscram-sha-256 に設定します。
Kerberos

Kerberos 認証は、CData 製品が接続を試行している際にAlloyDB サーバーで開始されます。この認証方法を有効化するには、AlloyDB サーバーでKerberos を設定します。AlloyDB サーバーでのKerberos 認証の設定を完了したら、CData 製品からKerberos 認証を行う方法については、ヘルプドキュメントの「Kerberos の使用」セクションを参照してください。
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

AlloyDB 接続プロパティの取得・設定方法

AlloyDB に接続するには、次の接続プロパティが必要です。

Server：AlloyDB データベースをホスティングしているサーバーのホスト名またはIP アドレス。
Port（オプション）：AlloyDB データベースをホスティングしているサーバーのポート。このプロパティはデフォルトで5432に設定されます。
User：AlloyDB サーバーに認証する際に使われるユーザー。
Password：AlloyDB サーバーに認証する際に使われるパスワード。
Database（オプション）：AlloyDB サーバーに接続する場合のデータベース。設定されていない場合は、ユーザーのデフォルトデータベースが使用されます。

AlloyDB への認証

標準認証

標準認証（事前に提供されたユーザーとパスワードの組み合わせを使用）は、デフォルトの認証形式です。

標準認証で接続する場合は、これ以上のアクションは必要ありません。

pg_hba.conf 認証スキーム

CData 製品がサポートしている他の認証方法では、AlloyDB サーバー上のpg_hba.conf ファイルで有効化する必要があります。

AlloyDB サーバーでの認証の設定については、こちらを参照してください。

MD5

pg_hba.conf ファイルのauth-method をmd5 に設定すると、MD5 パスワード検証を使用して認証できます。

SASL

CData 製品は、SASL（特にSCRAM-SHA-256）でパスワードを検証することで認証できます。

この認証方法を使用するには、pg_hba.conf ファイルのauth-method をscram-sha-256 に設定します。

Kerberos

Kerberos 認証は、CData 製品が接続を試行している際にAlloyDB サーバーで開始されます。この認証方法を有効化するには、AlloyDB サーバーでKerberos を設定します。AlloyDB サーバーでのKerberos 認証の設定を完了したら、CData 製品からKerberos 認証を行う方法については、ヘルプドキュメントの「Kerberos の使用」セクションを参照してください。

API Server のユーザー設定

次に、API Server 経由でAlloyDB にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

AlloyDB 用のAPI エンドポイントの作成

ユーザーを作成したら、AlloyDB のデータ用のAPI エンドポイントを作成していきます。

まず、「API」ページに移動し、「テーブルを追加」をクリックします。
アクセスしたい接続を選択し、次へをクリックします。
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でAlloyDB への接続を設定してユーザーを作成し、API Server でAlloyDB データのAPI を追加しました。これで、OData 形式のAlloyDB データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

AlloyDB のデータを取得する

「Tools」->「Script Editor」とクリックして、スプレッドシートからScript Editor を開きます。Script Editor で次の機能を追加し、スプレッドシートにOData クエリの結果を入力します。


function retrieve(){
  var url = "https://MyUrl/api.rsc/Orders?select=Id,ShipName,ShipCity,ShipCountry";
  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 orders = JSON.parse(json).value;

  var cols = [["Id","ShipName","ShipCity","ShipCountry"]];
  sheet.getRange(1,1,1,4).setValues(cols);

  row=2;
  for(var i in orders){
    for (var j in orders[i]) {
      switch (j) {
        case "Id":
          a1.offset(row,0).setValue(account[i][j]);
          break;
        case "ShipName":
          a1.offset(row,1).setValue(account[i][j]);
          break;
        case "ShipCity":
          a1.offset(row,2).setValue(account[i][j]);
          break;
        case "ShipCountry":
          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」を選択します。

ダイアログを閉じると、アプリケーションへのアクセスを許可するように要求されます。

AlloyDB のデータへの変更を追加する

以下の関数を追加し、セルへの変更をAPI Server に追加します。


function buildReq(e){
  var sheet = SpreadsheetApp.getActiveSheet();
  var changes = e.range;
  var id = sheet.getRange(changes.getRow(),1).getValue();
  var col = sheet.getRange(1,changes.getColumn()).getValue();

  var url = "http://MyServer/api.rsc/Orders("+id+")";
  var putdata = "{\"@odata.type\" : \"CDataAPI.Orders\",  \""+col+"\": \""+changes.getValue()+"\"}";;
  UrlFetchApp.fetch(url,{
    method: "put",
    contentType: "application/json",
    payload: putdata,
    headers: {"Authorization":"Basic " + Utilities.base64Encode("MyUser:MyAuthtoken")}
  });

}

下記の手順に従って、アップデートトリガーを追加します。

「Resources」->「Current Project's Triggers」とクリックします。
「Run」メニューで「buildReqe」を選択します。
「From Spreadsheet」を選択します。
「On edit」を選択します。

「Publish」->「Test as Add-On」とクリックすることで、スクリプトを確認できます。バージョン、インストールタイプ、およびスプレッドシートを選択し、テストの構成を作成します。作成したら、選択して実行できます。

セルを変更すると、API Server はAlloyDB のデータのアップデートを実行します。

はじめる準備はできましたか？

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server お問い合わせ

AlloyDB のデータでGoogle Sheets を拡張

API Server の設定