Redshift のデータでGoogle Sheets を拡張

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

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

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

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

API Server の設定

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

Redshift への接続

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

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

それでは、早速Amazon Redshift に接続していきましょう。データに接続するには、以下の接続パラメータを指定します。
- Server：Amazon Redshift データベースをホスティングしているサーバーのホスト名またはIP アドレス
- Database：Amazon Redshift クラスター用に作成したデータベース
- Port（オプション）：Amazon Redshift データベースをホスティングしているサーバーのポート。デフォルトは5439です
これらの値は、以下のステップでAWS マネージメントコンソールから取得できます。
1. Amazon Redshift コンソールを開きます（http://console.aws.amazon.com/redshift）
2. Clusters ページで、クラスター名をクリックしてください
3. Configuration タブの"Cluster Database Properties" セクションからプロパティを取得します。接続プロパティの値は、ODBC URL で設定された値と同じになります
Amazon Redshiftへの認証
CData 製品では幅広い認証オプションに対応しています。標準認証情報からIAM クレデンシャル、ADFS、Ping Federate、Microsoft Entra ID（Azure AD）、Azure AD PKCE まで利用可能です。
標準認証
ログイン資格情報を使用してAmazon Redshift に接続するには、以下のプロパティを設定してみましょう。
- AuthScheme：Basic
- User：認証するユーザーのログイン情報
- Password：認証するユーザーのパスワード
その他の認証方法については、ヘルプドキュメントをご確認ください。
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Amazon Redshift への接続

それでは、早速Amazon Redshift に接続していきましょう。データに接続するには、以下の接続パラメータを指定します。

Server：Amazon Redshift データベースをホスティングしているサーバーのホスト名またはIP アドレス
Database：Amazon Redshift クラスター用に作成したデータベース
Port（オプション）：Amazon Redshift データベースをホスティングしているサーバーのポート。デフォルトは5439です

これらの値は、以下のステップでAWS マネージメントコンソールから取得できます。

Amazon Redshift コンソールを開きます（http://console.aws.amazon.com/redshift）
Clusters ページで、クラスター名をクリックしてください
Configuration タブの"Cluster Database Properties" セクションからプロパティを取得します。接続プロパティの値は、ODBC URL で設定された値と同じになります

Amazon Redshiftへの認証

CData 製品では幅広い認証オプションに対応しています。標準認証情報からIAM クレデンシャル、ADFS、Ping Federate、Microsoft Entra ID（Azure AD）、Azure AD PKCE まで利用可能です。

標準認証

ログイン資格情報を使用してAmazon Redshift に接続するには、以下のプロパティを設定してみましょう。

AuthScheme：Basic
User：認証するユーザーのログイン情報
Password：認証するユーザーのパスワード

その他の認証方法については、ヘルプドキュメントをご確認ください。

API Server のユーザー設定

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

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

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

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

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

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

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

Redshift のデータを取得する

「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」を選択します。

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

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

以下の関数を追加し、セルへの変更を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 はRedshift のデータのアップデートを実行します。

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

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

CData API Server お問い合わせ

Redshift のデータでGoogle Sheets を拡張

API Server の設定

Redshift への接続

Amazon Redshift への接続

Amazon Redshiftへの認証

標準認証

Amazon Redshift への接続

Amazon Redshiftへの認証

標準認証

API Server のユーザー設定

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

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

Redshift のデータを取得する

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

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

この記事の内容

関連記事