Class TextButton

TextButton

텍스트 라벨이 있는 TextButton. 배경 색상을 설정하고 필요한 경우 버튼을 비활성화할 수 있습니다.

Google Workspace 부가기능 및 Google Chat 앱에서 사용할 수 있습니다.

var textButton = CardService.newTextButton()
    .setText("Open Link")
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://www.google.com"));

방법

메서드반환 유형간략한 설명
setAltText(altText)TextButton접근성을 위해 버튼의 대체 텍스트를 설정합니다.
setAuthorizationAction(action)TextButton객체를 클릭하면 승인 흐름의 URL을 여는 승인 작업을 설정합니다.
setBackgroundColor(backgroundColor)TextButtonTextButtonStyle.FILLED 버튼의 배경 색상을 설정합니다.
setComposeAction(action, composedEmailType)TextButton객체를 클릭하면 초안 이메일을 작성하는 작업을 설정합니다.
setDisabled(disabled)TextButton버튼을 사용 중지할지 여부를 설정합니다.
setOnClickAction(action)TextButton객체를 클릭할 때 실행되는 작업을 설정합니다.
setOnClickOpenLinkAction(action)TextButton객체를 클릭하면 탭에서 URL을 여는 작업을 설정합니다.
setOpenLink(openLink)TextButton객체를 클릭하면 열릴 URL을 설정합니다.
setText(text)TextButton버튼에 표시할 텍스트를 설정합니다.
setTextButtonStyle(textButtonStyle)TextButton버튼 스타일을 설정합니다.

자세한 문서

setAltText(altText)

접근성을 위해 버튼의 대체 텍스트를 설정합니다. 설정하지 않으면 기본적으로 버튼에 표시되는 텍스트로 설정됩니다.

매개변수

이름유형설명
altTextString이 버튼에 할당할 대체 텍스트입니다.

리턴

TextButton: 체이닝용 객체입니다.


setAuthorizationAction(action)

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

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

// ...

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

매개변수

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

리턴

TextButton: 체이닝용 객체입니다.


setBackgroundColor(backgroundColor)

TextButtonStyle.FILLED 버튼의 배경 색상을 설정합니다. TextButtonStyle.FILLED 버튼에 설정하지 않으면 버튼은 부가기능 매니페스트에 정의된 보조 색상을 사용합니다. 이 메서드는 TextButtonStyle.TEXT 버튼에 작동하지 않습니다.

매개변수

이름유형설명
backgroundColorString#rgb 형식의 색상입니다.

리턴

TextButton: 체이닝용 객체입니다.


setComposeAction(action, composedEmailType)

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

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

// ...

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

// ...

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

매개변수

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

리턴

TextButton: 체이닝용 객체입니다.


setDisabled(disabled)

버튼을 사용 중지할지 여부를 설정합니다. 비활성화된 버튼은 비활성화되어 있으며 클릭할 수 없습니다.

매개변수

이름유형설명
disabledBoolean사용 중지 상태입니다.

리턴

TextButton: 체이닝용 객체입니다.


setOnClickAction(action)

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

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

// ...

var 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();
}

매개변수

이름유형설명
actionAction이 요소를 클릭하면 수행할 작업입니다.

리턴

TextButton: 체이닝용 객체입니다.


setOnClickOpenLinkAction(action)

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

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

// ...

var 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();
}

매개변수

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

리턴

TextButton: 체이닝용 객체입니다.


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

매개변수

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

리턴

TextButton: 체이닝용 객체입니다.


setText(text)

버튼에 표시할 텍스트를 설정합니다.

매개변수

이름유형설명
textString버튼에 표시되는 텍스트입니다.

리턴

TextButton: 체이닝용 객체입니다.


setTextButtonStyle(textButtonStyle)

버튼 스타일을 설정합니다. 설정하지 않으면 기본값은 TextButtonStyle.TEXT 버튼입니다.

매개변수

이름유형설명
textButtonStyleTextButtonStyle버튼 스타일입니다.

리턴

TextButton: 체이닝용 객체입니다.