HTTPリクエストを送信したい（`UrlFetchApp`）

UrlFetchApp.fetch("URL", オプション);

UrlFetchApp.fetchで指定したURLに対してHTTPリクエスト（GET、POSTなど）できます。コンテンツタイプやHTTPヘッダーなどは、第2引数のオプション（Object）で設定します。

GETリクエストを送信したい

function fetchData() {
    // URLを指定する
    const url = "https://httpbin.org/get";

    // GETリクエストを送信する
    const response = UrlFetchApp.fetch(url);

    // レスポンスの内容を取得する
    const content = response.getContentText();
    Logger.log(`content: ${content}`);
}

指定したURLに対してGETリクエストを送信し、レスポンスを取得するサンプルです。

POSTリクエストを送信したい

function postData() {
    // URLを指定する
    const url = "https://httpbin.org/post";
    // オプションを設定する
    const options = {
        "method": "post",
        "payload": {
            "key1": "value1",
            "key2": "value2"
        }
    };

    // POSTリクエストを送信する
    const response = UrlFetchApp.fetch(url, options);

    // レスポンスの内容を取得する
    const content = response.getContentText();

    Logger.log(`content: ${content}`);
}

指定したURLに対してPOSTリクエストを送信し、レスポンスを取得するサンプルです。オプションで、ペイロード（＝送信するデータ）を設定できます。

ヘッダーを設定したい

function fetchWithHeaders() {
    // URLを指定する
    const url = "https://httpbin.org/get";

    // オプションでヘッダーを設定する
    const options = {
        "method": "get",
        "headers": {
            "Authorization": "Bearer ACCESS_TOKEN",
            "Accept": "application/json"
        }
    };

    // リクエストを送信
    const response = UrlFetchApp.fetch(url, options);

    // レスポンスの内容を取得する
    const content = response.getContentText();
    Logger.log(`content: ${content}`);

    const json = JSON.parse(content);
    Logger.log(`json: ${JSON.stringify(json)}`);
}

Bearerトークンを使った認証のサンプルです。その他のオプションは以下のとおりです。

const options = {
    "method": "get",  // "post", "put", "delete"
    "headers": {},
    "payload": {},
    "muteHttpExceptions": false,
    "followRedirects": true,
    "timeoutMs": 5000,  // 5 [sec]
    "validateHttpsCertificates": true,
    "contentType": "application/x-www-form-urlencoded",
    "escaping": true,
};

Slackに通知したい

function sendToSlack() {
    // Incoming Webhooksを有効にする
    const webhookUrl = "https://hooks.slack.com/services/トークン";

    // 通知する内容
    const message = {
        "channel" : "チャンネル名",
        "username": "通知ボットの名前",
        "attachments":[{
            //データ一式
        }],
        "icon_emoji": "絵文字コード",
    };

    // 通知内容をJSON形式に変換
    const payload = JSON.stringify(message);

    // リクエストのオプション
    // POST で payloadを追加
    const options = {
        "method" : "POST",
        "contentType": "application/json",
        "payload": payload,
        "muteHttpExceptions": true
    };
    // データをSlackにPOSTする
    const response = UrlFetchApp.fetch(webhookUrl, options);

    // レスポンスの内容で成功／失敗をチェックする
    const status = response.getResponseCode();
    Logger.log(`status: ${status}`);    // => 200 / 404
    const content = response.getContentText();
    Logger.log(`content: ${content}`);  // => ok  / No service
}

SlackのIncoming Webhooksアプリを使って、外部サービスからSlackに通知できるようになります。基本となる手順は以下の通りです。

通知する内容を作成する
JSON形式に変換する
POSTメソッドでリクエストを送信する

Incoming WebhooksのURLの作り方や、 messageに追加できる値については、それぞれ適切なドキュメントを参照してください。

Slackのメンバー数を取得したい

function getSlackMembers() {
    // Slack API Tokenをあらかじめ取得する
    // 以下のスコープが必要
    // - users:read
    // - users.read.email （メールアドレスを取得する場合）
    const token = "SlackのAPIトークン";

    // APIのエンドポイント -> JSON形式のデータが返ってくる
    const url = "https://slack.com/api/users.list";

    // リクエストのオプション
    // ヘッダーに認証情報を追加する
    const options = {
        "method": "get",
        "headers": {
            "Authorization": "Bearer " + token,
        }
    };

    // リクエスト
    const response = UrlFetchApp.fetch(url, options);
    const content = response.getContentText();
    const data = JSON.parse(content);

    if (!data.ok) {
        Logger.log(`Error: ${data.error}`);
        return [];
    }

    return data.members.map(member => ({
        "id": member.id,
        "name": member.name,
        "real_name": member.real_name,
        "email": member.profile.email || "no_mail",
        "is_bot": member.is_bot
    }));
}

function writeToSheet() {
    // 指定したスプレッドシートを取得
    const sheetId = "シートID";
    const book = SpreadsheetApp.openById(sheetId);

    // メンバー数を記録するシート
    let sheetCounter = book.getSheetByName("slackCounter");
    if (!sheetCounter) {
        sheetCounter = book.insertSheet("slackCounter");
        sheetCounter.appendRow(["更新日", "メンバー数"]);
    }

    // メンバー情報を記録するシート
    let sheetRoster = book.getSheetByName("slackRoster");
    if (!sheetRoster) {
        sheetRoster = book.insertSheet("slackRoster");
    }

    // Slackの情報を取得
    const members = getSlackMembers();
    if (!members || members.length === 0) {
        Logger.log("メンバー情報の取得に失敗");
        return;
    }

    // 見出し行を取得
    const headers = Object.keys(members[0]);

    // メンバー情報を2次元配列に変換
    const data = members.map(member => headers.map(header => member[header] || ""));

    // 1. 既存のシートにメンバー数を追記する
    // 実行した時刻を最終更新日とする
    const now = new Date();
    const lastUpdated = Utilities.formatDate(now, "JST", "yyyy-MM-dd HH:mm:ssZ");
    sheetCounter.appendRow([lastUpdated, members.length]);

    // 2. 現在のメンバー情報をシートに書き出す
    // 既存のシートをクリア
    sheetRoster.clear();
    sheetRoster.appendRow(headers);
    const nrows = data.length;
    const ncols = headers.length;
    const range = sheetRoster.getRange(2, 1, nrows, ncols);
    range.setValues(data);
}

Slack APIトークンのスコープは以下を設定します。

users:read
users:read.email（メールアドレスを取得する場合）

取得できるユーザー情報のサンプル

id
name
real_name
is_admin
is_owner
is_primary_owner
is_bot
updated
profile.email
profile.real_name (= real_name)
profile.display_name

dataの構造

{
    "ok": true,
    "members": [
        {
            "id": "ユーザーID",
            "team_id": "ワークスペースID",
            "name": "ユーザー名",
            ...
            "profile": {
                "email": "メールアドレス",
                ...
            },
            "is_bot": false,
            ...
        },
        {
            "id": "次のユーザーID",
            ...
        }
        // 他のメンバーの情報
    ]
}

GitLabにコミットしたい

function commitToGitLab(data) {
    // data: コミットしたい内容

    // GitLabのAPIエンドポイント
    const projectId = "プロジェクトID";
    const filePath = "ファイルパス";
    const url = `https://gitlab.com/api/v4/${projectId}/repository/files/${filePath}`;

    // GitLabのPersonal API Token (PAT)
    const token = "GitLabのPAT";

    const content = {
        branch: "main",
        commit_message: "Update from Google Sheets",
        content: data,
        encoding: "base64",
    };
    const payload = JSON.stringify(content);

    const options = {
        method: "put",
        headers: {
            "PRIVATE-TOKEN": token,
            "Content-Type": "application/json"
        },
        payload: payload,
    };

    const response = UrlFetchApp.fetch(url, options);
    const status = response.getResponseCode();
    Logger.log(`status: ${status}`);
}

GitLabにマージリクエストしたい

function pushDataToGitLabWithMR() {
    const projectId = "GitLabのプロジェクトID";
    const token = "GitLabのPAT";
    const data = "コミットしたい内容";
    const title = "マージリクエストのタイトル";
    const description = "マージリクエストの説明";

    // 実行時のタイムスタンプを使ってユニークなブランチ名を作成
    // シートの入力されたタイムスタンプでもいいかも
    const branchName = "update-from-google-sheet-" + new Date().getTime();

    const exists = checkBranchExists(projectId, branchName, token);
    if (!exists) {
        createNewBranch(projectId, branchName, "main", token);
    }
    commitToBranch(projectId, branchName, "data.csv", data, token);
    createMergeRequest(projectId, branchName, "main", title, description, token);
}

function createNewBranch(projectId, newBranchName, baseBranchName, token) {
    const url = `https://gitlab.com/api/v4/projects/${projectId}/repository/branches`;

    const payload = {
        branch: newBranchName,
        ref: baseBranchName
    };

    const options = {
        method: "post",
        headers: {
            "PRIVATE-TOKEN": token,
            "Content-Type": "application/json"
        },
        payload: JSON.stringify(payload)
    };

    const response = UrlFetchApp.fetch(url, options);
    const status = response.getResponseCode();
    const body = response.getContentText();
    Logger.log(`createNewBranch: ${status}: ${body}`);
}

function commitToBranch(projectId, branchName, filePath, fileContent, token) {
    const url = `https://gitlab.com/api/v4/projects/${projectId}/repository/files/${encodeURIComponent(filePath)}`;

    const payload = {
        branch: branchName,
        commit_message: "Googleシートのデータを追加",
        content: Utilities.base64Encode(fileContent),
        encoding: "base64"
    };

    const options = {
        method: "put",
        headers: {
            "PRIVATE-TOKEN": token,
            "Content-Type": "application/json"
        },
        payload: JSON.stringify(payload)
    };

    const response = UrlFetchApp.fetch(url, options);
    const status = response.getResponseCode();
    const body = response.getContentText();
    Logger.log(`commitToBranch: ${status}: ${body}`);
}

function createMergeRequest(projectId, sourceBranchName, targetBranchName, title, description, token) {
    const url = `https://gitlab.com/api/v4/projects/${projectId}/merge_requests`;
    const payload = {
        source_branch: sourceBranchName,
        target_branch: targetBranchName,
        title: title,
        description: description,
        remove_source_branch: true
    };

    const options = {
        method: "post",
        headers: {
            "PRIVATE-TOKEN": token,
            "Content-Type": "application/json"
        },
        payload: JSON.stringify(payload)
    };

    const response = UrlFetchApp.fetch(url, options);
    const status = response.getResponseCode();
    const body = response.getContentText();
    Logger.log(`createMergeRequest: ${status}: ${body}`);
}

function checkBranchExists(projectId, branchName, token) {
    const url = `https://gitlab.com/api/v4/projects/${projectId}/repository/branches/${encodeURIComponent(branchName)}`;
    const options = {
        method: "get",
        headers: {
            "PRIVATE-TOKEN": token
        },
        muteHttpExceptions: true
    };

    const response = UrlFetchApp.fetch(url, options);
    const status = response.getResponseCode();
    const body = response.getContentText();
    Logger.log(`checkBranchExists: ${status}: ${body}`);

    // ブランチが存在する場合はtrue、存在しない場合はfalse
    return status === 200;
}

GoogleシートのデータをGitLabに追加することを想定したサンプルです。 mainブランチに直接コミットするのではなく、マージリクエストを作成しています。

mainブランチから新規ブランチを作成する
作成したブランチにコミットする
マージリクエストを作成する

HTTPリクエストを送信したい（UrlFetchApp）