au PAY Market のデータでGoogle Sheets を拡張

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

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

API Server の設定

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

au PAY Market への接続

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

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

5. au PAY マーケットに接続するには、ShopId およびApiKey が必要です。

   au PAY マーケットへのアクセスの設定

   ShopId およびApiKey を取得するには、以下の手順に従ってください。

   • Wow! manager サイトにログインして、「各種お申し込み」メニューの「API利用申請」に移動します。
   • API利用規約に同意します。
   • 「APIキーの発行はこちら」をクリックします。
   • 「発行」ボタンをクリックして、API キーを生成します。
   • 「接続元IPアドレスを登録」に、対象とするIP アドレスを入力します。
   • 「登録」ボタンをクリックして、設定を保存します。

   au PAY マーケットアカウントの認証

   次の接続プロパティを設定して接続します。

   • ShopId：接続先のau PAY マーケットShop ID を設定。
   • ApiKey：API キーを設定。au PAY マーケットストアアカウントから取得したAPI キーです。
   • UseSandbox：Sandbox 環境に接続する場合はTrue を設定。
6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

au PAY マーケットに接続するには、ShopId およびApiKey が必要です。

au PAY マーケットへのアクセスの設定

ShopId およびApiKey を取得するには、以下の手順に従ってください。

• Wow! manager サイトにログインして、「各種お申し込み」メニューの「API利用申請」に移動します。
• API利用規約に同意します。
• 「APIキーの発行はこちら」をクリックします。
• 「発行」ボタンをクリックして、API キーを生成します。
• 「接続元IPアドレスを登録」に、対象とするIP アドレスを入力します。
• 「登録」ボタンをクリックして、設定を保存します。

au PAY マーケットアカウントの認証

次の接続プロパティを設定して接続します。

• ShopId：接続先のau PAY マーケットShop ID を設定。
• ApiKey：API キーを設定。au PAY マーケットストアアカウントから取得したAPI キーです。
• UseSandbox：Sandbox 環境に接続する場合はTrue を設定。

API Server のユーザー設定

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

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

au PAY Market 用のAPI エンドポイントの作成

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

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

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

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

au PAY Market のデータを取得する

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

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

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

  row=2;
  for(var i in items){
    for (var j in items[i]) {
      switch (j) {
        case "Id":
          a1.offset(row,0).setValue(account[i][j]);
          break;
        case "ItemCode":
          a1.offset(row,1).setValue(account[i][j]);
          break;
        case "Price":
          a1.offset(row,2).setValue(account[i][j]);
          break;
        case "ItemCode":
          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」を選択します。

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

au PAY Market のデータへの変更を追加する

以下の関数を追加し、セルへの変更をAPI Server に追加します。

function buildReq(e){
  var sheet = SpreadsheetApp.getActiveSheet();
  var changes = e.range;
  var id = sheet.getRange(changes.getRow(),1).getValue();
  var col = sheet.getRange(1,changes.getColumn()).getValue();

  var url = "http://MyServer/api.rsc/Items("+id+")";
  var putdata = "{\"@odata.type\" : \"CDataAPI.Items\",  \""+col+"\": \""+changes.getValue()+"\"}";;
  UrlFetchApp.fetch(url,{
    method: "put",
    contentType: "application/json",
    payload: putdata,
    headers: {"Authorization":"Basic " + Utilities.base64Encode("MyUser:MyAuthtoken")}
  });

}

下記の手順に従って、アップデートトリガーを追加します。

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

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

セルを変更すると、API Server はau PAY Market のデータのアップデートを実行します。