SurveyMonkey のデータでGoogle Sheets を拡張
マクロ、カスタム関数、アドオンを使用してGoogle スプレッドシートからSurveyMonkey のデータとやり取りします。CData API Server は、ADO.NET Provider for SurveyMonkey（またはその他の250+ ADO.NET Providers）と組み合わせることで、Google Sheets のようなクラウドベースのモバイルアプリケーションからSurveyMonkey のデータに接続できるようになります。API Server は、SurveyMonkey およびCData ADO.NET Providers にサポートされるすべてのソースのOData サービスを生成する軽量のWeb アプリケーションです。
Google Apps Script（GAS）は、これらのOData サービスをJSON 形式で利用できます。この記事では、Google スプレッドシートにMySurvey_Responses データを取り込みシンプルなアドオンを作成する方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなSurveyMonkey OData サービスを作成していきましょう。
SurveyMonkey への接続
GAS からSurveyMonkey のデータを操作するには、まずSurveyMonkey への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「SurveyMonkey」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、SurveyMonkey への接続設定を行っていきましょう！
-
SurveyMonkey はOAuth 2 認証標準を利用しています。SurveyMonkey がアンケートの回答を読むためにこれを必要とすることを考えると、アンケートを読むアカウントには有料プランのサブスクリプションが必要です。
SurveyMonkey への接続に使用できる認証方法は2つあります。
- プライベートoauth アプリケーションを登録するときに、パーソナルアクセストークンを使用します。
- パブリックoauth アプリケーションを登録するときに、OAuth を使用します。
パーソナルアクセストークンの使用
個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得するには、ヘルプの「Creating a Custom OAuth App」の手順に従って、次の接続プロパティを設定します。
- OAuthAccessToken：アプリケーション設定で生成されたAccessToken に設定。
- InitiateOAuth：OFF に設定。
OAuth の使用
CData 製品はすでにSurveyMonkey にOAuth アプリケーションとして登録されています。そのため、デフォルトでは、自動的に埋め込みクレデンシャルを使用して接続します。
独自のカスタムOAuth アプリを使用したい場合は、ヘルプのCustom Credentials を参照してください。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
SurveyMonkey はOAuth 2 認証標準を利用しています。SurveyMonkey がアンケートの回答を読むためにこれを必要とすることを考えると、アンケートを読むアカウントには有料プランのサブスクリプションが必要です。
SurveyMonkey への接続に使用できる認証方法は2つあります。
- プライベートoauth アプリケーションを登録するときに、パーソナルアクセストークンを使用します。
- パブリックoauth アプリケーションを登録するときに、OAuth を使用します。
パーソナルアクセストークンの使用
個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得するには、ヘルプの「Creating a Custom OAuth App」の手順に従って、次の接続プロパティを設定します。
- OAuthAccessToken：アプリケーション設定で生成されたAccessToken に設定。
- InitiateOAuth：OFF に設定。
OAuth の使用
CData 製品はすでにSurveyMonkey にOAuth アプリケーションとして登録されています。そのため、デフォルトでは、自動的に埋め込みクレデンシャルを使用して接続します。
独自のカスタムOAuth アプリを使用したい場合は、ヘルプのCustom Credentials を参照してください。
API Server のユーザー設定
次に、API Server 経由でSurveyMonkey にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
SurveyMonkey 用のAPI エンドポイントの作成
ユーザーを作成したら、SurveyMonkey のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でSurveyMonkey への接続を設定してユーザーを作成し、API Server でSurveyMonkey データのAPI を追加しました。これで、OData 形式のSurveyMonkey データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
SurveyMonkey のデータを取得する
「Tools」->「Script Editor」とクリックして、スプレッドシートからScript Editor を開きます。Script Editor で次の機能を追加し、スプレッドシートにOData クエリの結果を入力します。
function retrieve(){
var url = "https://MyUrl/api.rsc/MySurvey_Responses?select=Id,RespondentId,ChoiceId,ChoiceText";
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 mysurvey_responses = JSON.parse(json).value;
var cols = [["Id","RespondentId","ChoiceId","ChoiceText"]];
sheet.getRange(1,1,1,4).setValues(cols);
row=2;
for(var i in mysurvey_responses){
for (var j in mysurvey_responses[i]) {
switch (j) {
case "Id":
a1.offset(row,0).setValue(account[i][j]);
break;
case "RespondentId":
a1.offset(row,1).setValue(account[i][j]);
break;
case "ChoiceId":
a1.offset(row,2).setValue(account[i][j]);
break;
case "ChoiceText":
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」とクリックすることで、スクリプトを確認できます。バージョン、インストールタイプ、およびスプレッドシートを選択し、テストの構成を作成します。作成したら、選択して実行できます。