PHP のOData SDK を使用したSmartsheet のデータのクエリ

加藤龍彦
加藤龍彦
デジタルマーケティング
API Server とOData PHP SDK を使用して、エンティティをオブジェクトとしてモデリングすることでPHP でSmartsheet エンティティを手軽に使用。



CData API Server は、ADO.NET Provider for Smartsheet（またはその他の250+ ADO.NET Providers のデータ）と組み合わせることでWeb サービスとしてSmartsheet のデータを公開します。下記の手順に従って、Smartsheet のデータをオブジェクトとして使用します。

Smartsheet データ連携について

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

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

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


はじめに


API Server の設定

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

Smartsheet への接続

PHP から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 のエンドポイントを表示およびコピーできます。

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

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

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

さらに、OData SDK for PHP との互換性のためにAPI Server を構成します。「Settings」をクリックし、OData セクションで「デフォルトバージョン」を2.0 に設定します。

API Server に接続するユーザーの認証トークンを取得

作成するOData サービスを決定したら、「Users」をクリックして任意のユーザーをクリックし、ユーザーの認証トークンを取得します。API Server は、認証トークンベースの認証を使用して、主要な認証スキームをサポートします。SSL を使用すれば、接続の認証だけでなく、暗号化も可能です。IP アドレスを使用してアクセスを制限することも可能です。デフォルトでは、ローカルマシンからの接続のみが許可されます。

わかりやすくするために、URL に認証トークンを設定してAPI Server への認証を行います。これはデフォルトでは有効になっていないため、API Server の構成ファイルであるsettings.cfg に以下の行を追加する必要があります。 

[Application]
AllowAuthTokenInUrl = true

settings.cfg ファイルはデータディレクトリに配置されています。.NET 版では、www の下のapp_data フォルダがデータディレクトリになっています。Java 版でのデータディレクトリの位置は、OS によって変わります。

  • Windows：C:\ProgramData\CData\Smartsheet\
  • Unix or Mac OS X：~/cdata/Smartsheet/

Smartsheet エンティティをPHP オブジェクトとして使用する

以下のステップに従ってOData PHP SDK を使用し、API Server によって公開されるWeb サービスに接続するプロキシクラスを作成します。

  1. 以下のようなコマンドにURL を渡します。 

    php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\SmartsheetEntities.php

    上記のコマンドは、OData エンドポイントからのレスポンスで返されたメタデータからクラスを定義し、指定したフォルダにクラス定義を出力します。

    API Server とOData SDK for PHP は、フォーム認証とWindows 認証をサポートします。API Server は、認証トークンを使用してOData エンドポイントへのアクセスを許可されたユーザーを認証します。HTTP Basic 認証で認証トークを指定するか、OData URL に追加することができます。

    許可されたユーザーは、API Server の「Users」セクションで設定できます。

  2. PHP のオブジェクト指向インターフェースを使用して、Smartsheet のデータへのアクセスを開始できます。以下のコードは、Sheet_Event_Plan_Budget テーブルのレコードを作成し、リアルタイムデータを取得して、新しく作成されたレコードを表示します。 

    require_once 'SmartsheetEntities.php';
try{
  $svc = new CData();
  $sheet_event_plan_budget = new Sheet_Event_Plan_Budget();
  $sheet_event_plan_budget->Assigned = 'Ana Trujilo';
  $svc->AddToSheet_Event_Plan_Budget($sheet_event_plan_budget);
  $svc->SetSaveChangesOptions(SaveChangesOptions::None);
  $svc->SaveChanges();
  $response = $svc->sheet_event_plan_budget()->Execute();
  foreach($response->Result as $sheet_event_plan_budget)
    echo $sheet_event_plan_budget->TaskName."";
} catch (Exception $e) {    //catch errors from the API Server
  echo $e->getError(), "\n";
}

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

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

CData API Server お問い合わせ

この記事の内容

関連記事