【GAS】Slackで自分が参加しているチャンネル一覧を取得する

/**
 * global定数
 */
const SLACK_API_USER_TOKEN          = PropertiesService.getScriptProperties().getProperty('SLACK_API_USER_TOKEN');
const API_URL_CONVERSATIONS_LIST    = 'https://slack.com/api/conversations.list';
const API_URL_USERS_LIST            = 'https://slack.com/api/users.list';
const API_URL_CONVERSATIONS_INVITE  = 'https://slack.com/api/conversations.invite';
const API_URL_CONVERSATIONS_MEMBERS = 'https://slack.com/api/conversations.members';
const CHANNEL_SHEET_HEADER          = ['チャンネル名', 'チャンネルID', '種類', 'セレクト'];
const USER_SHEET_HEADER             = ['表示名', 'ユーザーID', '種別', 'セレクト'];

/**
 * メニューバーに機能を追加する
 */
function onOpen(){
  let ui = SpreadsheetApp.getUi();
  ui.createMenu('GASメニュー')
    // .addSubMenu(SpreadsheetApp.getUi().createMenu('チャンネル作成')
    .addItem('チャンネル名取得', 'exportSlackChannelsToSheet')
  .addToUi();
}

/*
  Bot Token：アプリが追加されているプライベートチャンネルのみ取得できる。
  User Token：GAS実行ユーザーが入っているプライベートチャンネルのみ取得できる。
*/

/**
 * メイン関数
 */
function exportSlackChannelsToSheet() {
  // パブリックとプライベートのチャンネルを取得する
  const slackChannels = fetchAllSlackChannels_(['public_channel', 'private_channel']);
  
  // 取得したチャンネルをシートに出力する
  writeChannelsToSheet_(slackChannels);
}

/**
 * すべてのチャンネルを取得する
 * @param {Array} channelTypes - 取得するチャンネルの種類の配列
 * @return {Array} すべてのチャンネル情報の配列
 */
function fetchAllSlackChannels_(channelTypes) {
  // チャンネルを格納するための空の配列を用意する
  let allChannels = [];
  
  // チャンネルタイプごとにチャンネルを取得する
  channelTypes.forEach(type => {
    allChannels = allChannels.concat(fetchSlackChannels_(type));
  });
  
  // 取得したチャンネルを返す
  return allChannels;
}

/**
 * 指定した種類のチャンネルを取得する
 * @param {string} channelType - 取得するチャンネルの種類（public_channelまたはprivate_channel）
 * @return {Array} チャンネル情報の配列
 */
function fetchSlackChannels_(channelType) {
  let allChannels = []; // 取得した全チャンネル情報を格納する配列
  let cursor = '';      // 次のページを示すカーソル

  // ページネーションを考慮してチャンネル情報を取得
  do {
    const response = fetchChannelsByType_(channelType, cursor); // 現在のカーソルを使ってチャンネル情報を取得
    allChannels = allChannels.concat(response.channels);        // 取得したチャンネル情報をすべてのチャンネル配列に追加
    cursor = response.nextCursor;                               // 次のページのカーソルを更新
  } while (cursor);                                             // カーソルが存在する限りループを継続

  return allChannels;                                           // すべてのチャンネル情報を返す
}

/**
 * Slack APIを呼び出してチャンネル情報を取得する
 * @param {string} channelType - 取得するチャンネルの種類
 * @param {string} cursor - 次のページのカーソル
 * @return {Object} チャンネル情報のオブジェクト（channels: チャンネル情報の配列, nextCursor: 次のページのカーソル）
 */
function fetchChannelsByType_(channelType, cursor) {
  // APIリクエストのURLを作成
  let url = `${API_URL_CONVERSATIONS_LIST}?exclude_archived=true&types=${channelType}`;
  if (cursor) {
    url += `&cursor=${cursor}`;
  }
  
  // APIリクエストのパラメータを設定
  const params = {
    method: 'get',
    headers: {
      'Authorization': `Bearer ${SLACK_API_USER_TOKEN}`
    },
    muteHttpExceptions: true
  };
  
  try {
    // APIリクエストを送信
    const response = UrlFetchApp.fetch(url, params);
    const jsonResponse = JSON.parse(response.getContentText());
    
    // リクエストが成功しなかった場合にエラーを投げる
    if (!jsonResponse.ok) {
      throw new Error('Failed to fetch Slack channels: ' + jsonResponse.error);
    }
    
    // 次のページのカーソルを取得
    const nextCursor = jsonResponse.response_metadata ? jsonResponse.response_metadata.next_cursor : '';
    
    // チャンネル情報と次のページのカーソルを返す
    return {
      channels: jsonResponse.channels,
      nextCursor: nextCursor
    };
  } catch (error) {
    // エラーが発生した場合にログを記録し、空の結果を返す
    Logger.log('Error fetching Slack channels: ' + error.message);
    return {
      channels: [],
      nextCursor: ''
    };
  }
}

/**
 * チャンネル情報をスプレッドシートに書き込む
 * @param {Array} channels - チャンネル情報の配列
 */
function writeChannelsToSheet_(channels) {
  // アクティブなスプレッドシートの「チャンネル名取得」シートを取得
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('チャンネル名取得');
  
  // シートをクリア
  sheet.clear();

  // 既存のフィルターを解除
  if (sheet.getFilter()) {
    sheet.getFilter().remove();
  }
  
  // ヘッダーとデータを含む配列を作成
  const data = [CHANNEL_SHEET_HEADER].concat(channels.map(channel => [
    channel.name,                              // チャンネル名
    channel.id,                                // チャンネルID
    channel.is_private ? 'Private' : 'Public', // チャンネルのタイプ（パブリックかプライベートか）
    ''                                         // チェックボックス列（この要素は一見削除してもよさそうだが、HEADERの要素が4つあるので、残しておく必要がある）
  ]));

  // データを書き込む
  sheet.getRange(1, 1, data.length, data[0].length).setValues(data);

  // チェックボックスを設定
  const checkBoxRange = sheet.getRange(2, 4, channels.length);
  checkBoxRange.insertCheckboxes();

  // フィルターを設定
  const range = sheet.getRange(1, 1, data.length, data[0].length);
  range.createFilter();
}