ServiceDesk Plus のデータでGoogle Sheets を拡張

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

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

API Server の設定

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

ServiceDesk Plus への接続

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

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

5. OAuth 認証の設定

   ServiceDeskPlus は、安全な認証のために Zoho OAuth 2.0 を使用します。OAuth アクセスをセットアップするには、以下のステップで進めます：

   1. https://api-console.zoho.com の Zoho Developer Console でアプリケーションを登録します
   2. アプリケーション構成に合わせてリダイレクト URI を設定します
   3. アプリケーション設定から Client ID と Client Secret を控えておきます

   以下の接続プロパティを設定して接続を確立してください：

   • AuthScheme：OAuth に設定します。
   • OAuthClientId：Zoho アプリケーションの Client ID に設定します。
   • OAuthClientSecret：Zoho アプリケーションの Client Secret に設定します。
   • Scope：必要な ServiceDeskPlus の権限に設定します（デフォルトでは requests、problems、assets、projects への読み取りアクセスが含まれます）。
   • Domain：ServiceDeskPlus のドメインに設定します。
   • Portal：ServiceDeskPlus のポータルに設定します。

   接続文字列の例

   Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;
   

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

OAuth 認証の設定

ServiceDeskPlus は、安全な認証のために Zoho OAuth 2.0 を使用します。OAuth アクセスをセットアップするには、以下のステップで進めます：

1. https://api-console.zoho.com の Zoho Developer Console でアプリケーションを登録します
2. アプリケーション構成に合わせてリダイレクト URI を設定します
3. アプリケーション設定から Client ID と Client Secret を控えておきます

以下の接続プロパティを設定して接続を確立してください：

• AuthScheme：OAuth に設定します。
• OAuthClientId：Zoho アプリケーションの Client ID に設定します。
• OAuthClientSecret：Zoho アプリケーションの Client Secret に設定します。
• Scope：必要な ServiceDeskPlus の権限に設定します（デフォルトでは requests、problems、assets、projects への読み取りアクセスが含まれます）。
• Domain：ServiceDeskPlus のドメインに設定します。
• Portal：ServiceDeskPlus のポータルに設定します。

接続文字列の例

Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;

API Server のユーザー設定

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

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

ServiceDesk Plus 用のAPI エンドポイントの作成

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

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

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

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

ServiceDesk Plus のデータを取得する

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

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

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

  row=2;
  for(var i in announcementcomments){
    for (var j in announcementcomments[i]) {
      switch (j) {
        case "Id":
          a1.offset(row,0).setValue(account[i][j]);
          break;
        case "":
          a1.offset(row,1).setValue(account[i][j]);
          break;
        case "":
          a1.offset(row,2).setValue(account[i][j]);
          break;
        case "AnnouncementId":
          a1.offset(row,3).setValue(account[i][j]);
          break;
      }
    }
    row++;
  }
}

次のステップに従って、開いたタイミングでスプレッドシートに入力するインストール可能なトリガーを追加します。

1. 「Resources」->「Current Project's Triggers」->「Add a New Trigger」とクリックします。
2. 「Run」メニューで「retrieve」を選択します。
3. 「From Spreadsheet」を選択します。
4. 「On open」を選択します。

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

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