Class CardAction

CardAction

카드 헤더 메뉴에 추가되는 클릭 가능한 메뉴 항목입니다.

const action = CardService.newAction();
// Finish building the action...

const cardAction =
    CardService.newCardAction().setText('Card action').setOnClickAction(action);

메서드

메서드	반환 유형	간략한 설명
setAuthorizationAction(action)	CardAction	객체를 클릭할 때 승인 흐름의 URL을 여는 승인 작업을 설정합니다.
setComposeAction(action, composedEmailType)	CardAction	객체를 클릭할 때 초안 이메일을 작성하는 작업을 설정합니다.
setOnClickAction(action)	CardAction	객체를 클릭할 때 실행되는 작업을 설정합니다.
setOnClickOpenLinkAction(action)	CardAction	객체를 클릭할 때 탭에서 URL을 여는 작업을 설정합니다.
setOpenLink(openLink)	CardAction	객체를 클릭할 때 열릴 URL을 설정합니다.
setText(text)	CardAction	이 작업의 메뉴 텍스트를 설정합니다.

자세한 문서

setAuthorizationAction(action)

객체를 클릭할 때 승인 흐름의 URL을 여는 승인 작업을 설정합니다. URL이 새 창에서 열립니다. 사용자가 승인 흐름을 완료하고 애플리케이션으로 돌아가면 애드온이 다시 로드됩니다.

UI 객체에는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

매개변수

이름	유형	설명
action	AuthorizationAction	이 요소를 클릭할 때 실행할 승인 작업을 지정하는 객체입니다.

리턴

CardAction — 연결을 위한 이 객체입니다.

---

setComposeAction(action, composedEmailType)

객체를 클릭할 때 초안 이메일을 작성하는 작업을 설정합니다. UI 객체에는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

Action 매개변수는 ComposeActionResponse 객체를 반환하는 콜백 함수를 지정해야 합니다. ComposeActionResponseBuilder.setGmailDraft(draft)를 사용하여 구성됩니다.

참고: 이 메서드는 작성 UI를 확장하는 데 사용되는 작성 작업을 설정하지 않습니다. 대신 이 메서드는 이 UI 요소를 작업이 완료될 때 Gmail에서 열리는 Apps Script의 초안 메시지를 작성하는 Action에 연결합니다.

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

매개변수

이름	유형	설명
action	Action	이 요소를 클릭할 때 실행할 작성 작업을 지정하는 객체입니다.
composedEmailType	ComposedEmailType	작성된 초안이 독립형 초안인지 답장 초안인지 지정하는 enum 값입니다.

리턴

CardAction — 연결을 위한 이 객체입니다.

---

setOnClickAction(action)

객체를 클릭할 때 실행되는 작업을 설정합니다. UI 객체에는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

Action 매개변수는 ActionResponse 객체를 반환하는 콜백 함수를 지정해야 합니다.

// ...

const action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(
          CardService.newNotification().setText('Some info to display to user'),
          )
      .build();
}

매개변수

이름	유형	설명
action	Action	이 요소를 클릭할 때 실행할 작업입니다.

리턴

CardAction — 연결을 위한 이 객체입니다.

---

setOnClickOpenLinkAction(action)

객체를 클릭할 때 탭에서 URL을 여는 작업을 설정합니다. URL을 빌드해야 하거나 OpenLink 객체를 만드는 것 외에 다른 작업을 실행해야 하는 경우 이 함수를 사용합니다. UI 객체에는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

Action 매개변수는 ActionResponseBuilder.setOpenLink(openLink)를 사용하여 구성된 ActionResponse 객체를 반환하는 콜백 함수를 지정해야 합니다.

// ...

const action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton()
    .setText('Open Link')
    .setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com'))
      .build();
}

매개변수

이름	유형	설명
action	Action	이 요소를 클릭할 때 실행할 링크 열기 작업을 지정하는 객체입니다. 클릭했습니다.

리턴

CardAction — 연결을 위한 이 객체입니다.

---

setOpenLink(openLink)

객체를 클릭할 때 열릴 URL을 설정합니다. URL이 이미 알려져 있고 열기만 하면 되는 경우 이 함수를 사용합니다. UI 객체에는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

매개변수

이름	유형	설명
openLink	OpenLink	열 URL을 설명하는 OpenLink 객체입니다.

리턴

CardAction — 연결을 위한 이 객체입니다.

---

setText(text)

이 작업의 메뉴 텍스트를 설정합니다.

매개변수

이름	유형	설명
text	String	메뉴 항목 텍스트입니다.

리턴

CardAction — 연결을 위한 이 객체입니다.