Postmark のデータでGoogle Sheets を拡張
マクロ、カスタム関数、アドオンを使用してGoogle スプレッドシートからPostmark のデータとやり取りします。CData API Server は、ADO.NET Provider for API（またはその他の240+ ADO.NET Providers）と組み合わせることで、Google Sheets のようなクラウドベースのモバイルアプリケーションからPostmark のデータに接続できるようになります。API Server は、Postmark およびCData ADO.NET Providers にサポートされるすべてのソースのOData サービスを生成する軽量のWeb アプリケーションです。
Google Apps Script（GAS）は、これらのOData サービスをJSON 形式で利用できます。この記事では、Google スプレッドシートにBounces データを取り込みシンプルなアドオンを作成する方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなPostmark OData サービスを作成していきましょう。
Postmark への接続
GAS からPostmark のデータを操作するには、まずPostmark への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Postmark」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Postmark への接続設定を行っていきましょう！
-
API キー認証の設定
Postmark は、リクエストの認証にサーバー API トークンを使用します。各 Postmark サーバーは独自の API トークンを持ち、そのサーバーに関連付けられたメッセージ、バウンス、テンプレート、統計情報へのアクセスを制御します。
Server API Token を取得するには、Postmark アカウントにログインし、接続したいサーバーに移動します。サーバー設定の API Tokens に移動して、Server API token というラベルのトークンをコピーしてください。
以下の接続プロパティを設定して接続を確立してください：
- AuthScheme：APIKey に設定します。
- APIKey：Postmark の Server API Token に設定します。この値は、すべてのリクエストで X-Postmark-Server-Token ヘッダーとして送信されます。
接続文字列の例：
Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"
Postmark への接続
認証を設定すると、Postmark に接続して、OutboundMessages、Bounces、Templates などの利用可能なテーブルからデータをクエリできます。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
API キー認証の設定
Postmark は、リクエストの認証にサーバー API トークンを使用します。各 Postmark サーバーは独自の API トークンを持ち、そのサーバーに関連付けられたメッセージ、バウンス、テンプレート、統計情報へのアクセスを制御します。
Server API Token を取得するには、Postmark アカウントにログインし、接続したいサーバーに移動します。サーバー設定の API Tokens に移動して、Server API token というラベルのトークンをコピーしてください。
以下の接続プロパティを設定して接続を確立してください：
- AuthScheme：APIKey に設定します。
- APIKey：Postmark の Server API Token に設定します。この値は、すべてのリクエストで X-Postmark-Server-Token ヘッダーとして送信されます。
接続文字列の例：
Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"
Postmark への接続
認証を設定すると、Postmark に接続して、OutboundMessages、Bounces、Templates などの利用可能なテーブルからデータをクエリできます。
API Server のユーザー設定
次に、API Server 経由でPostmark にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Postmark 用のAPI エンドポイントの作成
ユーザーを作成したら、Postmark のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でPostmark への接続を設定してユーザーを作成し、API Server でPostmark データのAPI を追加しました。これで、OData 形式のPostmark データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Postmark のデータを取得する
「Tools」->「Script Editor」とクリックして、スプレッドシートからScript Editor を開きます。Script Editor で次の機能を追加し、スプレッドシートにOData クエリの結果を入力します。
function retrieve(){
var url = "https://MyUrl/api.rsc/Bounces?select=Id,,,";
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 bounces = JSON.parse(json).value;
var cols = [["Id","","",""]];
sheet.getRange(1,1,1,4).setValues(cols);
row=2;
for(var i in bounces){
for (var j in bounces[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 "":
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」を選択します。
ダイアログを閉じると、アプリケーションへのアクセスを許可するように要求されます。
「Publish」->「Test as Add-On」とクリックすることで、スクリプトを確認できます。バージョン、インストールタイプ、およびスプレッドシートを選択し、テストの構成を作成します。作成したら、選択して実行できます。