cluster・ワールド内課金者ランキング機能を作る！【実例コードあり！】

//参考資料
//https://creator.cluster.mu/2024/08/29/purchase-supportbox/

//課金用のID
const productId = "cluster公式Webサイトのワールド編集ページで設定した商品のID";
//ワールドID
const worldId = "あなたのワールドIDを入力しよう";
//価値(coin数など)
const billingAmountValue = 100;
//取得するランキング数
const top = 3;


// 名前と点数(Amount)を表示するText View
const names = [$.subNode("Name_1"), $.subNode("Name_2"), $.subNode("Name_3")];
const scores = [$.subNode("Score_1"), $.subNode("Score_2"), $.subNode("Score_3")];

$.onStart(() => {
  // 購入通知を購読する
  $.subscribePurchase(productId);

  //現在の課金ランキングを取得する
  let request = {type: "ranking", records: [], top: top};

  //サーバーに送信する
  $.callExternal(JSON.stringify(request), "ranking_only");

  $.log("onStart end");
});

$.onUpdate(deltaTime => {
  // 10秒に1回、定期的にスペース内にいるすべてのプレイヤーの購入状況を確認する
  let timer = $.state.timer ?? 0;
  timer -= deltaTime;
  if (timer <= 0) {
    timer += 10;
    //スペースに居るユーザの情報を取得する
    const allPlayers = $.getPlayersNear(new Vector3(), Infinity);
    $.getOwnProducts(productId, allPlayers, "");
  }
  $.state.timer = timer;
});

$.onInteract(player => {
    //課金リクエスト
    $.log("onInteract player");
    $.log(player.userDisplayName);
    player.requestPurchase(productId, "");
});

$.onPurchaseUpdated((player, productId) => {
  // 商品が購入された場合、スペース内にいるすべてのプレイヤーの購入状況を確認する
  const allPlayers = $.getPlayersNear(new Vector3(), Infinity);
  //https://docs.cluster.mu/script/interfaces/ClusterScript.html#getOwnProducts
  $.getOwnProducts(productId, allPlayers, "");
});

$.onGetOwnProducts((ownProducts, meta, errorReason) => {
  //  商品の所持状況を取得したとき
  let total = 0;
  for (let ownProduct of ownProducts) {
    // スペース内での商品所持数の合計を計算
    total += ownProduct.plusAmount - ownProduct.minusAmount;
  }
  // スペース内での商品所持数の合計数を表示
  $.subNode("Text").setText("みんなのサポート数: " + total);
});

$.onRequestPurchaseStatus((meta, status, errorReason, player) => {
  if (status == PurchaseRequestStatus.Purchased) {
      // Play Audio Source Gimmickがついたアイテムにシグナルを送る

      $.log("onRequestPurchaseStatus player");
      $.log(player.userDisplayName);
      $.sendSignalCompat("this", "SupportSE");

      //課金ユーザの情報をサーバーに送信する
      let records = [];

      //ユーザの情報、課金情報
      record = {name: player.userDisplayName, idfc:player.idfc, userId:player.userId, worldId:worldId, productId:productId, billingAmountValue:billingAmountValue};
      records.push(record);
      let request = {type: "rankingInsert", records: records, top: top};

      //サーバーに送信する
      $.callExternal(JSON.stringify(request), "syncRanking");


  }
});



// callExternal実行後、サーバーからの応答を受け取ったときに呼び出される処理
$.onExternalCallEnd((response, meta, errorReason) =>
  {
      // サーバーとの通信でエラーが発生した場合にその理由を表示
      if (response == null) {
          $.log("callExternal ERROR: " + errorReason);
          return;
      }
  
      $.log("通信結果が戻ってきた meta:" + meta);
  
      // metaを照合して処理を分岐
      // metaの値はcallExternalの第2引数に渡したもの
      if (meta === "syncRanking" || meta === "ranking_only") {
          $.log("データ着たぞ");
          $.log(response);
          $.log(errorReason);
          

          // サーバーからのresponseのJSONをパース
          let parsedResponse = JSON.parse(response);
         
          // responseの情報でtextViewを更新
          for(let i = 0; i < top; i++)
          {
              names[i].setText(parsedResponse.rankers[i].name);
              scores[i].setText(parsedResponse.rankers[i].score);
          }
      
      }
  });

//参考資料
//https://creator.cluster.mu/2024/03/01/callexternal-textview/


function doPostTest() {
  //GASからの起動用テスト実行用(doPost関数を直接実行できないため)

  //テストコード
  let e = {
    "records": [{
      "name": "俺様だよ",
      "idfc": "idfc_value",
      "userId": "userId_value",
      "worldId": "worldId_value",
      "productId": "productId_value",
      "billingAmountValue": 100,
    }],
    "type":"rankingInsert",
    "top":3,
  };

  r = rankingMain(e);
  Logger.log(r);
}

function doPost(e){
  //サーバーサイドから受け取る方


  // 受け取ったデータを取得
  var params = JSON.parse(e.postData.getDataAsString());

  // 受け取ったデータからrequestの内容を取得
  var request = JSON.parse(params.request);


  return rankingMain(request)


}


function rankingMain(request) {
  //ランキングのメイン処理
  //課金したタイミング（request.type === "rankingInsert"）で、呼ばれる場合は、購入情報もスプシに追加する

  // 受け取ったデータを取得
  //var params = JSON.parse(e.postData.getDataAsString());

  // 受け取ったデータからrequestの内容を取得
  //var request = JSON.parse(params.request);


  //パラメータの確認
  Logger.log("リクエスト内容");
  Logger.log(request);

  var response = "";
 
  // requestの内容に応じて処理を分岐
  if (request.type === "rankingInsert") {
    //課金が発生したときのみ実行
    //新しいデータを追加する


    // データ保存用のスプレッドシートを取得
    const file = SpreadsheetApp.getActiveSpreadsheet();
    const sheet = file.getSheetByName("RankingSampleSheet");


    // スプレッドシートのデータがある一番下の行
    var row = sheet.getLastRow();
    Logger.log("row:" + row)

    if(row == 0){
      //ヘッダーを書き込む
      row = 1;
      sheet.getRange(row, 1).setValue("date");
      sheet.getRange(row, 2).setValue("name");
      sheet.getRange(row, 3).setValue("idfc");
      sheet.getRange(row, 4).setValue("userId");
      sheet.getRange(row, 5).setValue("worldId");
      sheet.getRange(row, 6).setValue("productId");
      sheet.getRange(row, 7).setValue("billingAmountValue");

    }

    //時間を取り出す
    const date = new Date();


    // 新しいレコードをスプレッドシートの下に追加
    request.records.forEach(function(record){
      //var name = record.name;
      //var score = record.score;


      row += 1;
      sheet.getRange(row, 1).setValue(date);
      sheet.getRange(row, 2).setValue(record.name);
      sheet.getRange(row, 3).setValue(record.idfc);
      sheet.getRange(row, 4).setValue(record.userId);
      sheet.getRange(row, 5).setValue(record.worldId);
      sheet.getRange(row, 6).setValue(record.productId);
      sheet.getRange(row, 7).setValue(record.billingAmountValue);

    });
  

  }


  //ランキング計算をする
  var topRankersInSheet = calculateAndSortBillingAmounts();

  //topの数までに限定する
  var topRankersInSheet = topRankersInSheet.length > request.top ? topRankersInSheet.slice(0, request.top) : topRankersInSheet;

  var topRankers = topRankersInSheet.map((ranker) => ({name: ranker[0], score: ranker[2]}));
  var data = {rankers: topRankers};

  response = JSON.stringify(data);

  Logger.log("response:" + response);


  // 返信用のデータを作成
  var output = ContentService.createTextOutput();
  output.setMimeType(ContentService.MimeType.JSON);


  // Cluster Creator Kitで発行されたトークン
  var token = PropertiesService.getScriptProperties().getProperty('token');


  // 返信の内容にstringにしたデータと認証用のトークンを設定
  output.setContent(JSON.stringify({ response: response, verify: token }));
 
  return output;
}

function calculateAndSortBillingAmounts() {
  //ランキングの集計

  // アクティブなスプレッドシートとデータを取得
  var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('RankingSampleSheet');
  var dataRange = sheet.getDataRange();
  var data = dataRange.getValues();
  
  // userIdごとのbillingAmountValueの合計とnameを格納するオブジェクト
  var userBillingTotals = {};

  // データの最初の行はヘッダーなので、2行目から開始
  for (var i = 1; i < data.length; i++) {
    var name = data[i][1];  // nameは2列目 (インデックス1)
    //var userId = data[i][3];  // userIdは4列目 (インデックス3)
    var userId = data[i][2];  // idfcは3列目 (インデックス2)
    var billingAmountValue = data[i][6];  // billingAmountValueは7列目 (インデックス6)
    
    if (userBillingTotals[userId]) {
      userBillingTotals[userId].billingAmountTotal += billingAmountValue;  // 既存のuserIdの場合、値を加算
    } else {
      userBillingTotals[userId] = {
        name: name,
        billingAmountTotal: billingAmountValue
      };  // 新しいuserIdの場合、nameとスコアを初期化
    }
  }

  // 結果を配列に変換し、billingAmountValueの合計で降順ソート
  var sortedBillingAmounts = [];
  for (var userId in userBillingTotals) {
    sortedBillingAmounts.push([userBillingTotals[userId].name, userId, userBillingTotals[userId].billingAmountTotal]);
  }

  // 合計金額で降順にソート
  sortedBillingAmounts.sort(function(a, b) {
    return b[2] - a[2];
  });

  // 結果を新しいシートに出力する
  var resultSheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('結果');
  if (!resultSheet) {
    resultSheet = SpreadsheetApp.getActiveSpreadsheet().insertSheet('結果');
  } else {
    resultSheet.clear();  // 既存のデータをクリア
  }
  
  // ヘッダーを追加
  resultSheet.appendRow(['name', 'userId', '合計billingAmountValue']);
  
  // ソートされた結果を出力
  for (var j = 0; j < sortedBillingAmounts.length; j++) {
    resultSheet.appendRow(sortedBillingAmounts[j]);
  }

  return sortedBillingAmounts;
}