GETリクエストを処理したい（`doGet`）

function doGet(e) {

    // https://script.google.com/macros/s/スクリプトID/exec?name=John へのアクセス

    // クエリから値を取得（?name=John）
    const name = e.parameter.name;

    // コンテンツを作成
    const message = "Hello, " + (name ? name : "world") + "!";

    // レスポンスを返す
    return ContentService.createTextOutput(message).setMimeType(ContentService.MimeType.TEXT);
}

doGet関数は、GASでGETリクエストを処理するための関数です。レスポンスはContentService.createTextOutputなどで生成し、ウェブアプリとしてデプロイできます。

上のサンプルでは、あるシートに紐づいたdoGet関数を定義しています。 GETリクエストは https://script.google.com/macros/s/スクリプトID/exec?name=John を想定しています。クエリが?name=Johnとなっているので、 e.parameter.nameでJohnという値を取得できます。

またnameを使ってmessageの文字列を作成しています。そしてContentService.createTextOutputを使ってレスポンスを作成しています。今回はただのテキスト情報なので、MIMEタイプをTEXTにしています。

クエリを?name=Smithに変更すると、レスポンスも変わることが想像できると思います。

デプロイしたい

GASのエディターからデプロイできます。

[デプロイ] > [新しいデプロイ]
種類の選択: ウェブアプリ
説明: （アプリの説明）
次のユーザーとして実行: [自分]
アクセスできるユーザー: [全員]

テストしたい

function testDoGetParameters() {
    const e = {
        "parameter": {
            "name": "John"
        }
    };
    const response = doGet(e);
    const content = response.getContent();
    Logger.log(`content: ${content}`);
}

function testDoGetURL() {
    const baseUrl = ScriptApp.getService().getUrl();
    Logger.log(`Base URL: ${baseUrl}`);
    const query = "?name=John";
    Logger.log(`Query: ${query}`);

    const url = baseUrl + query;

    const options = {
        "method": "GET",
        "followRedirects": true,
    };
    const response = UrlFetchApp.fetch(url, options);
    Logger.log(`response: ${response}`);
}

UrlFetchAppで、doGet関数の動作確認ができます。

シート名ごとに処理したい

function doGet(e) {

    // クエリからシート名を取得
    const sheetName = e.parameter.sheetName;

    // クエリが見つからない場合
    if (!sheetName) {
        const msg = "シート名が指定されていません";
        return ContentService.createTextOutput(msg).setMimeType(ContentService.MimeType.TEXT);
    }

    // スプレッドシートを取得
    const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
    const sheet = spreadsheet.getSheetByName(sheetName);

    // シート名が見つからない場合
    if (!sheet) {
        const msg = `指定されたシートが存在しません: ${sheetName}`;
        return ContentService.createTextOutput(msg).setMimeType(ContentService.MimeType.TEXT);
    }

    // シートの内容をJSON形式に変換する
    const values = sheet.getDataRange().getValues();
    const headers = values[0];
    const rows = values.slice(1);
    const records = rows.map(row =>
        Object.fromEntries(headers.map((h, i) => [h, row[i]]))
    );

    return ContentService.createTextOutput(JSON.stringify(records))
        .setMimeType(ContentService.MimeType.JSON);
}

doGet関数の実用的なサンプルです。ここでは、あるスプレッドシートに複数のシートがある場合を想定しています。そして、シートごとに内容をJSON形式で公開し、外部からデータ処理できるようにしたいと考えています。

GASで公開したウェブアプリは https://script.google.com/macros/s/スクリプトID/exec でアクセスできるようになります。クエリに?sheetName=シート名とすることで、該当するシートのコンテンツにアクセスできます。

複数の処理を切り替えたい

const actionMap = {
    "action1": doGetOne,
    "action2": doGetTwo,
    "action3": doGetThree,
};

function doGet(e) {
    const action = e.parameter.action;
    return actionMap[action](e);
}

function doGetOne(e) {
    return ContentService.createTextOutput("action1です");
}

function doGetTwo(e) {
    return ContentService.createTextOutput("action2です");
}

function doGetThree(e) {
    return ContentService.createTextOutput("action3です");
}

doGet関数は、ひとつのプロジェクトで、ひとつしか定義できない、特殊な関数です。しかし、スタンドアロンなプロジェクトから、複数のプロジェクトを操作したいこともあります。その場合、クエリーを使って分岐させます。

GETリクエストを処理したい（doGet）

デプロイしたい

テストしたい

シート名ごとに処理したい

複数の処理を切り替えたい

GETリクエストを処理したい（`doGet`）