Node.js からSmartsheet のデータをクエリ

加藤龍彦
加藤龍彦
デジタルマーケティング
API Server は、データを外部に公開します。CData API Server のOData エンドポイントを使って、Node.js からSmartsheet へのCRUD クエリを実行します。



CData API Server とADO.NET Provider for Smartsheet(もしくは250+ の他のADO.NET Providers)を使って、Smartsheet をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたSmartsheet のデータをNode.js でリクエストする方法を説明します。

Smartsheet データ連携について

CData は、Smartsheet のライブデータにアクセスし、統合するための最も簡単な方法を提供します。お客様は CData の接続機能を以下の目的で使用しています:

  • 添付ファイル、カラム、コメント、ディスカッションの読み取りと書き込みができます。
  • 個々のセルのデータを表示したり、セルの履歴をレポートしたりできます。
  • 添付ファイルの削除やダウンロード、シートの作成・コピー・削除・移動、行の別のシートへの移動やコピーなど、Smartsheet 固有のアクションを実行できます。

ユーザーは、Tableau、Crystal Reports、Excel などの分析ツールと Smartsheet を統合しています。また、当社のツールを活用して Smartsheet データをデータベースやデータウェアハウスにレプリケートしているお客様もいます。


はじめに


API Server の設定

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

Smartsheet への接続

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

  1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。 接続を追加
  2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Smartsheet」を選択します。
  3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
    CData コネクタの追加方法はこちら >>
  4. それでは、Smartsheet への接続設定を行っていきましょう! 接続設定
  5. 個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得する方法は次のとおりです。

    • Smartsheet にログインします。
    • 「アカウント」をクリックして「個人用の設定」を選択します。
    • 「API アクセス」をクリックし、フォームを使用して新しいアクセストークンを生成するか、既存のアクセストークンを管理します。

    その後、OAuthAccessToken を生成したトークンに設定します。

  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得する方法は次のとおりです。

  • Smartsheet にログインします。
  • 「アカウント」をクリックして「個人用の設定」を選択します。
  • 「API アクセス」をクリックし、フォームを使用して新しいアクセストークンを生成するか、既存のアクセストークンを管理します。

その後、OAuthAccessToken を生成したトークンに設定します。

API Server のユーザー設定

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

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

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

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

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

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

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

Node.js からSmartsheet OData フィードを利用

OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。

以下のコードはSheet_Event_Plan_Budget データに対して認証されたリクエストを行います。 以下のURL の例では、Assigned カラムの値がAna Trujilo のレコードを検索する単純なフィルターを適用しています。

var http = require('http');
http.get({
  protocol: "http:",
  hostname:"MyServer.com",
  port:MyPort,
  path: "/api.rsc/Sheet_Event_Plan_Budget?$filter=" + encodeURIComponent("Assigned eq 'Ana Trujilo'"),
  auth:'MyUser:MyAuthtoken'
},
function(res) {
  var body = '';
  res.on('data', function(chunk) {
    body += chunk;
  });
  res.on('end', function() {
    console.log(body);
    var jsonData = JSON.parse(body);
  });
}).on('error', function(e) {
  console.log("Error: ", e);
});

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

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

CData API Server お問い合わせ