Google sheet(+Google apps script) 만으로 손쉽게 슬랙 생일축하 봇 만들기. Slack Birthday message bot via Googlesheet(+Google apps script)

안녕하세요.

제가 비전공자이기 때문에 비전공자도 가능한 방법입니다.

저희 회사는 Birthdaybot 이라는 Slack app을 사용해왔는데, 최근에 아래와 같이 free plan limit 이 끝났다는 메시지를 받게 되었습니다.. 흑..

20%할인을 해준다고 하지만.. 인당 0.99 달러~ 1.99 달러를 지불하고 사용하느니 직접 만들어봐야겠다고 생각해서 도전했습니다. (이 블로그를 참고했는데 오류나는 코드를 일부 수정하고 기능을 추가했습니다. Chavo님 감사합니다!!)

먼저 결과물은 이렇게 됩니다. 저희 회사는 기본언어가 영어라 영어로 했지만 한글로 바꾸시면 됩니다!

자 그럼, 멤버의 생일이 되면 특정 슬랙 채널에 메시지를 작성하면서 생일자를 부르면서 축하해는데,

이 때 생일 축하 메시지도 고정되어 있는게 아니라 여러개를 등록해서 랜덤하게 출력하는 봇을 만들어 볼게요.

전체적인 진행 순서는 아래와 같습니다.

1. 슬랙 incoming webhook 페이지에 가서 (https://slack.com/apps/A0F7XDUAZ-incoming-webhooks)

2. 알림이 가길 원하는 채널 선택 후 추가, webhook URL을 복사

3. 구글 시트에서 apps-script 코드를 추가

4. 트리거 설정하면 끝!

1번부터 차례대로 해봅시다. https://slack.com/apps/A0F7XDUAZ-incoming-webhooks 에 방문하면 로그인을 해야합니다. 로그인 후 Add to Slack을 누릅니다.

2. 그 다음, 적절한 채널 명을 지정하고 add incoming webhooks integration 버튼을 누릅니다.

그리고 빨간글씨의 URL을 복사해서 잘 어디 메모장 같은 곳에 둡니다.

아래로 스크롤해서 내리면 봇의 이름과 아이콘을 지정할 수 있습니다. 원하는 봇 이름과 아이콘으로 바꿔주세요!

3. 구글시트로 갑니다. 구글시트 양식의 형태는 이렇게 해줍니다. 브라우저에서 구글시트의 URL주소를 잘 보시면 d/ 부터 다음 / 까지가 구글시트의 id값인데 복사해서 잘 둡니다.

여기서 잠깐!

SlackUID가 뭔가 싶으실거예요!. 결과물에서 보실 수 있듯 저는 생일자를 슬랙에서 @이름 으로 어싸인해서 알리고, 그 스레드에 누군가가 축하메시지를 남겼을 때 생일자가 볼 수 있게 하기 위해서 이렇게 구성했습니다만, 필요없으신 분은 그냥 이름으로만 하셔도 됩니다. 저처럼 Slack UID를 써서 알림을 주고싶은 경우에는 이 글 끝에서 추가로 방법 알려드릴게요!

구글시트 상단 메뉴 Extentions > Apps Script 를 누르면 새창이 뜹니다.

Code.gs 부분에 아래 코드를 추가합니다.

// 구글 스프레드시트 ID 설정
const spreadsheetId = "복사해뒀던 구글스프레드시트 ID를 넣어주세요";

// Slack에 메시지를 보낼 Webhook URL 설정
const webhookURL = "복사해뒀던 webhook URL을 넣어주세요.";

// 스프레드시트에서 생일 정보를 읽어올 범위 설정. 구글시트 탭 이름을 수정해주시고 범위도 A1:B열이 아니라면
// 수정해주세요!
const range = SpreadsheetApp.openById(spreadsheetId).getRange("시트이름!A1:B");

// 날짜가 유효한지 검증하는 함수
function isValidDate(d) {
  if (Object.prototype.toString.call(d) !== "[object Date]")
    return false;
  return !isNaN(d.getTime());
}

// 생일 정보를 맵 형태로 가져오는 함수
function getBirthdayMap() {
  const birthdayMap = {}

  const rowNum = range.getNumRows();
  for (let i = 2; i <= rowNum; i++) {
    const nameCell = range.getCell(i, 1);
    if (nameCell.isBlank()) {
      break;
    }

    const date = range.getCell(i, 2).getValue();

    if (isValidDate(date)) {
      const dateKey = date.toLocaleDateString(undefined, {
        month: "2-digit",
        day: "2-digit"
      });

      if (birthdayMap[dateKey]) {
        birthdayMap[dateKey].push(i)
      } else {
        birthdayMap[dateKey] = [i];
      }
    }
  }

  return birthdayMap;
}

// Slack에 메시지를 보내는 함수
function sendMessageToSlack(today, birthdayMembers) {
  const todayDateKey = Utilities.formatDate(today, "KST", "yyyy-MM-dd");

  let text = "";

// 축하 메시지 목록 (문구를 수정하고, 여러개를 추가하셔도 됩니다!! 각 행 사이의 ','가 필수이고
// 마지막 항목에는 ','를 넣지 않습니다.)
  let congrats_msg_list = [
    "🎉 Happy Birthday! Today is all about you!",
    "🎈 Wishing you all the happiness on your special day!",
    "🍰 Another year older, another year wiser! Happy Birthday!",
    "🎁 Celebrate big! It's your special day!",
    "I’ve got a big favor to ask ... Drop what you’re doing and celebrate with us! Happy Birthday! It’s a special day for an awesome person! 🥳🥳🥳"
  ];

  // 랜덤 메시지 선택
  let randomIndex = Math.floor(Math.random() * congrats_msg_list.length);
  let randomCongratsMsg = congrats_msg_list[randomIndex];

  if (birthdayMembers)
    text = birthdayMembers.reduce((acc, rowNum) => acc + "<@" + range.getCell(rowNum, 1).getValue().toString() + "> ", "");
  else
    return;

  // Slack 메시지 포맷 설정, 랜덤 메시지 적용
  const message = {
    "attachments": [
      {
        "color": "#2eb8",
        "fields": [
          {
            "title": `${randomCongratsMsg} (${todayDateKey})`,
            "value": `${text}\n\n 🎉🎉🎉`,
            "short": false
          }
        ]
      }
    ]
  };

  var options = {
    'method': 'post',
    'contentType': 'application/json',
    'payload': JSON.stringify(message)
  };

  // Webhook을 통해 Slack에 메시지 전송
  UrlFetchApp.fetch(webhookURL, options);
}

// 오늘 생일인 사람들에게 메시지를 보내는 함수
function sendBirthdayMessage() {
  const birthdayMap = getBirthdayMap();

  const today = new Date();

  const todayDateKey = Utilities.formatDate(today, "KST", "MM/dd");

  const birthdayMembers = birthdayMap[todayDateKey];

  sendMessageToSlack(today, birthdayMembers);
   Logger.log("Today's Date: " + today);
  Logger.log("Birthday Members: " + birthdayMembers);
}

그 다음 위에 디스켓 모양버튼을 눌러 저장합니다.

좌측 슬라이드 메뉴에서 Triggers 를 누르고 아래와 같이 설정한 뒤 Save 버튼을 누릅니다.

권한승인을 위해 로그인을 하라고 하는 경우 제가 참고한 블로거분 글 처럼 Advanced > Go To ExampleOfSendBirthdayMessage (unsafe) 를 클릭해서 마저 권한을 얻습니다.

잘 작동하는지를 테스트 하려면, Select type of time base trigger 부분을 specitic time 으로 하고 1분 뒤로 지정해서 확인하면 좋습니다.

(Optional)

슬랙에 가입되어있는 이메일 주소를 구글시트에 적어놓으면, 이를 기반으로 SlackUID를 찾아서 같은 구글시트에 정기적으로 입력되도록 할 수 있습니다.

저의 경우엔 Zapier 보다 가격이 저렴하고 무료로도 사용이 가능한 Make 라는 서비스를 이용했습니다.

전체적으로는 일단 아래와 같이 시나리오가 구성됩니다.

(구글시트와 슬랙 모듈을 추가할 때 최초 시도시에는 구글과 슬랙 계정 로그인 및 권한부여를 해줘야 합니다.)

먼저 구글시트로 다시 돌아가서, 위에서 제시한 구글시트 템플릿 기준 A열에 email을 넣어주세요. 이러면 Google Apps Script에서 지정했던 열도 추가로 수정해주셔야 합니다!

그 다음 Make에서 Google sheets - Get Range Values 모듈을 추가하고,

한글로 설명해놓은 각 항목에 적절한 값을 넣어주세요. Range 는 email 주소가 들어있는 A2:A로 할게요.

Slack - Search for User 모듈을 추가하고, 녹색 A열을 선택해줍니다.

다음으로 Google sheet - Update a Row 모듈을 추가해서 아래와 같이 구성합니다.

다음으로는 아래 Tools 에서 ignore 모듈도 하나 추가합니다.

(이건 에러가 발생했을 때 무시하는 용도인데, 안전을 위해서 추가하는겁니다. ㅎㅎ)

ignore 모듈과 Slack 모듈 사이 줄(?) 을 클릭하면 filter 를 설정할 수 있는데 무시하는 조건을 아래처럼 "슬랙에서 에러가 발생해서 에러메시지가 있는 경우" 로 설정해주시면 됩니다.

마지막으로,

Google sheet - Get Range Values 모듈에 시계모양을 클릭하면 어떻게 이 시나리오를 실행할지에 대해서 설정할 수 있는데, 저는 구글시트+Google Apps Script로 슬랙 알림메시지가 발송되는 트리거를 9AM~10AM으로 설정 했기에 그 전에 SlackUID를 모두 정기적으로 업데이트 할 수 있도록 매 평일 아침 8시 50분으로 설정했습니다.