More than 3 years have passed since last update.

ChallongeとGASによるトーナメント運営の自動化

GoogleAppsScript

Last updated at 2020-12-10Posted at 2020-12-10

これはSupershipグループ Advent Calendar 2020の10日目の記事です。

はじめに

Supershipには部活動制度が存在し、多くの社員が自主的に参加しています。私は内定者アルバイトの頃からボードゲーム部に参加しており、その活動が楽しみのひとつになっていました。しかしながら、昨今の情勢から社員がひとところに集まる機会が少なくなり、ボードゲーム部は従来の形で活動することが困難になりました。

ボードゲーム部の新たな活動の形として、例えばオンライントーナメントを開催することが考えられます。そこでこの記事ではChallongeとGoogle Apps Script (GAS)を用いたトーナメント運営の手軽な自動化について紹介します。

Challongeの準備

Challongeはトーナメントを自動作成、公開できるWebアプリケーションで、オンラインゲームでの利用例が多くあります。また、トーナメントの参加者登録、結果入力などの操作がWeb上のダッシュボードのほかにREST APIであるChallonge API経由でも可能で、運営の自動化に向いたサービスになっています。

準備としてChallongeのアカウントを取得し、Single Elimination形式¹のトーナメントを作成しておきます。このとき、「基本情報 - URL」部分に表示される文字列がAPI操作時に必要になるのでメモしておきましょう。²

また、テスト用に作成する場合は最下部の「Advanced Options - Permissions」の「イベントを検索エンジンやChallongeの表示可能なリストから除外する」にチェックを入れておくと良いでしょう。

「保存して続行」をクリックするとトーナメントが作成されますが、参加者が登録されていないのでまだトーナメント表は表示されません。参加者はダッシュボードの「参加者」タブから手動で登録することもできますが、まだ行いません。

最後に、アカウント設定の「デベロッパーAPI」からAPIキーの発行を受けます。

参加者登録

参加者登録用のフォームをGoogle Formで作成し、参加者登録用のフォームを作成します。フォーム送信時にスクリプトからChallonge API経由で参加者の表示名を登録し、Challonge上で用いられる参加者IDをSpreadsheetに記録します。

最初にChallonge上での表示名を記入させるフォームと回答集計用のSpreadsheetを作成しておきます。

Spreadsheetのスクリプトエディタを開き、例えば以下のようなコードを書いて「スプレッドシートから - フォーム送信時」イベントで関数 register が実行されるようにしておきます。このとき、アプリケーションの承認が必要になることがあります。

このスクリプトではリクエスト POST https://api.challonge.com/v1/tournaments/{TOURNAMENT_ID}/participants.json を送信して参加者登録を行い、そのレスポンスから参加者IDを得ています。置き換えが必要な変数は以下の通りです。

CHALLONGE_API_KEY: Challongeで発行されたAPIキーで置き換えます。
TOURNAMENT_ID: 「Challongeの準備」の節でメモしたURLで置き換えます。
REGISTER_SPREADSHEET_ID: 参加者登録用のSpreadsheetのIDで置き換えます。

const CHALLONGE_API_KEY = "----------------------------------------";
const TOURNAMENT_ID = "--------";
const REGISTER_SPREADSHEET_ID = "--------------------------------------------";
function register(e) {
  const register_sheet = SpreadsheetApp.openById(REGISTER_SPREADSHEET_ID).getSheets()[0];
  const challonge_name = register_sheet.getRange(register_sheet.getLastRow(), 2).getValue();
  const challonge_id = JSON.parse(UrlFetchApp.fetch("https://api.challonge.com/v1/tournaments/" + TOURNAMENT_ID + "/participants.json", {
    "muteHttpExceptions": true,
    "contentType": "application/json",
    "method": "post",
    "payload": JSON.stringify({
      "api_key": CHALLONGE_API_KEY,
      "participant": {
        "name": challonge_name
      }
    })
  }))["participant"]["id"];
  register_sheet.getRange(register_sheet.getLastRow(), 3).setValue(challonge_id);
}

この段階でフォームから参加者の情報を送信すると、自動的にChallongeへの参加者登録が行われ、Spreadsheetに集められた回答の表示名の隣の列にChallonge上での参加者IDが記録されます。

2人以上の参加者を登録するとChallonge上でトーナメント表が作成され、player1, player2, player3, player4の4人を登録するとSpreadsheetとChallonge上の表示は例えばこのようになります。

参加者が出そろったらダッシュボードから「トーナメントの開始」ボタンを押しましょう。これを押すまでは試合結果の入力はできません。

試合結果の報告

試合結果の報告もGoogle Form経由で行えるようにします。参加者登録フォームと同じように、結果報告用のフォームと回答集計用のSpreadsheetを作成します。

Spreadsheetのスクリプトエディタを開き、以下のようなコードを書いて「スプレッドシートから - フォーム送信時」イベントで関数 submitResult が実行されるようにしておきます。

このスクリプトでは、まずChallonge APIから試合結果の入力が可能な試合³のJSON配列を得て、結果報告フォームの回答と参加者登録フォームの回答を突き合わせて得た参加者IDをもとに結果を入力すべき試合を決定し、実際に入力を行います。置き換えが必要な変数は以下の通りです。

CHALLONGE_API_KEY: Challongeで発行されたAPIキーで置き換えます。
TOURNAMENT_ID: 「Challongeの準備」の節でメモしたURLで置き換えます。
REGISTER_SPREADSHEET_ID: 参加者登録用のSpreadsheetのIDで置き換えます。
RESULT_SPREADSHEET_ID: 結果報告用のSpreadsheetのIDで置き換えます。

submitResult.gs

const CHALLONGE_API_KEY = "----------------------------------------";
const TOURNAMENT_ID = "--------";
const REGISTER_SPREADSHEET_ID = "--------------------------------------------";
const RESULT_SPREADSHEET_ID = "--------------------------------------------";

function submitResult(e) {
  const sheet = SpreadsheetApp.openById(RESULT_SPREADSHEET_ID).getSheets()[0];
  const winner = sheet.getRange(sheet.getLastRow(), 2).getValue();
  const loser = sheet.getRange(sheet.getLastRow(), 3).getValue();
  const lookup_sheet = SpreadsheetApp.openById(REGISTER_SPREADSHEET_ID).getSheets()[0];
  const arr = lookup_sheet.getDataRange().getValues();
  var winner_challonge_id = 0;
  var loser_challonge_id = 0;
  for (let i = 1; i < arr.length; i++) {
    if (arr[i][1] === winner) {
      winner_challonge_id = arr[i][2];
    } else if (arr[i][1] === loser) {
      loser_challonge_id = arr[i][2];
    }
  }
  Logger.log(winner_challonge_id);
  Logger.log(loser_challonge_id);
  const challonge_matches = JSON.parse(UrlFetchApp.fetch("https://api.challonge.com/v1/tournaments/" + TOURNAMENT_ID + "/matches.json?state=open&api_key=" + CHALLONGE_API_KEY, {
    "method": "get"
  }).getContentText());
  for (let i = 0; i < challonge_matches.length; i++) {
    if (challonge_matches[i]["match"]["player1_id"] == winner_challonge_id && challonge_matches[i]["match"]["player2_id"] == loser_challonge_id) {
      var challonge_match_id = challonge_matches[i]["match"]["id"];
      sheet.getRange(sheet.getLastRow(), 4).setValue(challonge_match_id);
      const challonge_status = JSON.parse(UrlFetchApp.fetch("https://api.challonge.com/v1/tournaments/" + TOURNAMENT_ID + "/matches/" + challonge_match_id + ".json", {
        "method": "put",
        "contentType": "application/json",
        "payload": JSON.stringify({
          "api_key": CHALLONGE_API_KEY,
          "match": {
            "scores_csv": "1-0",
            "winner_id": winner_challonge_id
          }
        })
      }).getContentText());
      break;
    } else if (challonge_matches[i]["match"]["player2_id"] == winner_challonge_id && challonge_matches[i]["match"]["player1_id"] == loser_challonge_id) {
      var challonge_match_id = challonge_matches[i]["match"]["id"];
      sheet.getRange(sheet.getLastRow(), 4).setValue(challonge_match_id);
      const challonge_status = JSON.parse(UrlFetchApp.fetch("https://api.challonge.com/v1/tournaments/" + TOURNAMENT_ID + "/matches/" + challonge_match_id + ".json", {
        "method": "put",
        "contentType": "application/json",
        "payload": JSON.stringify({
          "api_key": CHALLONGE_API_KEY,
          "match": {
            "scores_csv": "0-1",
            "winner_id": winner_challonge_id
          }
        })
      }).getContentText());
      break;
    }
  }
}