UM SaaS Cloud のデータでGoogle Sheets を拡張

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

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

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

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

API Server の設定

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

UM SaaS Cloud への接続

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

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

デフォルトでは、CData 製品は本番環境に接続します。UMSaaSCloud sandbox アカウントを使用するには、UseSandbox をtrue に設定します。ユーザー / パスワード認証を使用している場合は、User にsandbox のユーザー名を設定してください。

UM SaaS Cloud への認証

UM SaaS Cloud は、Basic、OAuth、OAuthJWT（コンシューマーキー）など、複数の認証方式をサポートしています。ここではBasic 認証について説明します。認証情報の詳しい取得方法や他の認証方法については、ヘルプドキュメントの「はじめに」セクションを参照してください。

Basic 認証

Basic 認証は、セキュリティトークンとユーザー資格情報の使用に基づきます。Basic 認証を使用するには、AuthScheme をBasic に、User とPassword をログイン資格情報に設定し、SecurityToken を設定します。
デフォルトではSecurityToken が必要ですが、UM SaaS Cloud で信頼できるIP アドレスの範囲を設定することで、オプションにすることができます。
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

UM SaaS Cloud 接続プロパティの取得・設定方法

デフォルトでは、CData 製品は本番環境に接続します。UMSaaSCloud sandbox アカウントを使用するには、UseSandbox をtrue に設定します。ユーザー / パスワード認証を使用している場合は、User にsandbox のユーザー名を設定してください。

UM SaaS Cloud への認証

UM SaaS Cloud は、Basic、OAuth、OAuthJWT（コンシューマーキー）など、複数の認証方式をサポートしています。ここではBasic 認証について説明します。認証情報の詳しい取得方法や他の認証方法については、ヘルプドキュメントの「はじめに」セクションを参照してください。

Basic 認証

Basic 認証は、セキュリティトークンとユーザー資格情報の使用に基づきます。Basic 認証を使用するには、AuthScheme をBasic に、User とPassword をログイン資格情報に設定し、SecurityToken を設定します。

デフォルトではSecurityToken が必要ですが、UM SaaS Cloud で信頼できるIP アドレスの範囲を設定することで、オプションにすることができます。

API Server のユーザー設定

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

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

UM SaaS Cloud 用のAPI エンドポイントの作成

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

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

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

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

UM SaaS Cloud のデータを取得する

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


function retrieve(){
  var url = "https://MyUrl/api.rsc/Account?select=Id,BillingState,Name,Industry";
  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 account = JSON.parse(json).value;

  var cols = [["Id","BillingState","Name","Industry"]];
  sheet.getRange(1,1,1,4).setValues(cols);

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

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

UM SaaS Cloud のデータへの変更を追加する

以下の関数を追加し、セルへの変更を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/Account("+id+")";
  var putdata = "{\"@odata.type\" : \"CDataAPI.Account\",  \""+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 はUM SaaS Cloud のデータのアップデートを実行します。

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

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

CData API Server お問い合わせ

UM SaaS Cloud のデータでGoogle Sheets を拡張

API Server の設定