Procore のデータでGoogle Sheets を拡張
マクロ、カスタム関数、アドオンを使用してGoogle スプレッドシートからProcore のデータとやり取りします。CData API Server は、ADO.NET Provider for API(またはその他の250+ ADO.NET Providers)と組み合わせることで、Google Sheets のようなクラウドベースのモバイルアプリケーションからProcore のデータに接続できるようになります。API Server は、Procore およびCData ADO.NET Providers にサポートされるすべてのソースのOData サービスを生成する軽量のWeb アプリケーションです。
Google Apps Script(GAS)は、これらのOData サービスをJSON 形式で利用できます。この記事では、Google スプレッドシートにCompanies データを取り込みシンプルなアドオンを作成する方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなProcore OData サービスを作成していきましょう。
Procore への接続
GAS からProcore のデータを操作するには、まずProcore への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Procore」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Procore への接続設定を行っていきましょう!
-
まず、Profile 接続プロパティにProcore プロファイルのディスク上の場所を設定します(例:C:\profiles\Procore.apip)。次に、ProfileSettings 接続プロパティにProcore の接続文字列を設定します(以下を参照)。
Procore API プロファイル設定
Procore に認証し、自分のデータに接続したり、他のユーザーが自分のデータに接続できるようにするには、OAuth 標準を使用できます。
まず、Procore にOAuth アプリケーションを登録します。Developer Account にログインし、Create New App に移動することで登録できます。アプリを登録するために必要なすべてのステップに従います。まずSandbox Manifest の新しいバージョンを作成し、Production に昇格させてProduction Credentials を取得します。OAuth アプリケーションにはclient id とclient secret が割り当てられます。
以下の接続プロパティを設定すると、接続の準備が整います:
- AuthScheme:OAuth に設定します。
- InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId:アプリ設定で指定されているclient_id を設定します。
- OAuthClientSecret:アプリ設定で指定されているclient_secret を設定します。
- CallbackURL:アプリ設定で指定されているRedirect URI を設定します。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
まず、Profile 接続プロパティにProcore プロファイルのディスク上の場所を設定します(例:C:\profiles\Procore.apip)。次に、ProfileSettings 接続プロパティにProcore の接続文字列を設定します(以下を参照)。
Procore API プロファイル設定
Procore に認証し、自分のデータに接続したり、他のユーザーが自分のデータに接続できるようにするには、OAuth 標準を使用できます。
まず、Procore にOAuth アプリケーションを登録します。Developer Account にログインし、Create New App に移動することで登録できます。アプリを登録するために必要なすべてのステップに従います。まずSandbox Manifest の新しいバージョンを作成し、Production に昇格させてProduction Credentials を取得します。OAuth アプリケーションにはclient id とclient secret が割り当てられます。
以下の接続プロパティを設定すると、接続の準備が整います:
- AuthScheme:OAuth に設定します。
- InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId:アプリ設定で指定されているclient_id を設定します。
- OAuthClientSecret:アプリ設定で指定されているclient_secret を設定します。
- CallbackURL:アプリ設定で指定されているRedirect URI を設定します。
API Server のユーザー設定
次に、API Server 経由でProcore にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Procore 用のAPI エンドポイントの作成
ユーザーを作成したら、Procore のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でProcore への接続を設定してユーザーを作成し、API Server でProcore データのAPI を追加しました。これで、OData 形式のProcore データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Procore のデータを取得する
「Tools」->「Script Editor」とクリックして、スプレッドシートからScript Editor を開きます。Script Editor で次の機能を追加し、スプレッドシートにOData クエリの結果を入力します。
function retrieve(){
var url = "https://MyUrl/api.rsc/Companies?select=Id,Id,Name,IsActive";
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 companies = JSON.parse(json).value;
var cols = [["Id","Id","Name","IsActive"]];
sheet.getRange(1,1,1,4).setValues(cols);
row=2;
for(var i in companies){
for (var j in companies[i]) {
switch (j) {
case "Id":
a1.offset(row,0).setValue(account[i][j]);
break;
case "Id":
a1.offset(row,1).setValue(account[i][j]);
break;
case "Name":
a1.offset(row,2).setValue(account[i][j]);
break;
case "IsActive":
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」とクリックすることで、スクリプトを確認できます。バージョン、インストールタイプ、およびスプレッドシートを選択し、テストの構成を作成します。作成したら、選択して実行できます。