Class DecoratedText

장식된텍스트

선택적 장식과 함께 텍스트를 표시하는 위젯입니다. 가능한 키에는 아이콘, 위쪽 라벨, 아래쪽 라벨이 포함됩니다. setText(text)DecoratedText, DecoratedText, setTopLabel(text) 또는 setBottomLabel(text) 중 하나를 사용하여 텍스트 콘텐츠와 키 중 하나를 설정해야 합니다. 이 클래스는 KeyValue를 대체하기 위한 것입니다.

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

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

메서드

메서드반환 유형간략한 설명
addEventAction(eventAction)Widget위젯에서 실행할 수 있는 이벤트 작업을 추가합니다.
setAuthorizationAction(action)DecoratedText객체를 클릭할 때 승인 흐름으로 URL을 여는 승인 작업을 설정합니다.
setBottomLabel(text)DecoratedText키로 사용되고 텍스트 콘텐츠 아래에 표시될 라벨 텍스트를 설정합니다.
setButton(button)DecoratedText텍스트 오른쪽에 표시되는 Button를 설정합니다.
setComposeAction(action, composedEmailType)DecoratedText객체를 클릭할 때 이메일 초안을 작성하는 작업을 설정합니다.
setEndIcon(endIcon)DecoratedText콘텐츠 오른쪽에 표시되는 선택적 IconImage를 설정합니다.
setId(id)Widget변형할 위젯을 식별하는 데 사용되는 할당된 고유 ID를 설정합니다.
setOnClickAction(action)DecoratedText객체를 클릭할 때 실행되는 작업을 설정합니다.
setOnClickOpenLinkAction(action)DecoratedText객체를 클릭할 때 탭에서 URL을 여는 작업을 설정합니다.
setOpenLink(openLink)DecoratedText객체를 클릭할 때 열릴 URL을 설정합니다.
setStartIcon(startIcon)DecoratedText텍스트 콘텐츠 앞에 표시할 선택적 IconImage를 설정합니다.
setSwitchControl(switchToSet)DecoratedText콘텐츠 오른쪽에 표시되는 Switch를 설정합니다.
setText(text)DecoratedText값으로 사용할 텍스트를 설정합니다.
setTopLabel(text)DecoratedText키로 사용되고 텍스트 콘텐츠 위에 표시될 라벨 텍스트를 설정합니다.
setVisibility(visibility)Widget위젯의 공개 상태를 설정합니다.
setWrapText(wrapText)DecoratedText값 텍스트를 한 줄로 표시할지 여러 줄로 표시할지 설정합니다.

자세한 문서

addEventAction(eventAction)

위젯에서 실행할 수 있는 이벤트 작업을 추가합니다.

매개변수

이름유형설명
eventActionEventAction추가할 EventAction입니다.

리턴

Widget - 연결을 위한 객체입니다.


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);

매개변수

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

리턴

DecoratedText - 연결을 위한 이 객체


setBottomLabel(text)

라벨 텍스트를 키로 사용하도록 설정하며 텍스트 콘텐츠 아래에 표시됩니다.

매개변수

이름유형설명
textString라벨 텍스트입니다.

리턴

DecoratedText - 연결을 위한 이 객체


setButton(button)

텍스트 오른쪽에 표시되는 Button를 설정합니다. DecoratedText는 버튼 하나 또는 스위치 하나만 지원할 수 있습니다.

매개변수

이름유형설명
buttonButton추가할 버튼입니다.

리턴

DecoratedText - 연결을 위한 이 객체


setComposeAction(action, composedEmailType)

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

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

// ...

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

매개변수

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

리턴

DecoratedText - 연결을 위한 이 객체


setEndIcon(endIcon)

콘텐츠 오른쪽에 표시되는 선택적 IconImage를 설정합니다. DecoratedText는 버튼, 스위치 또는 아이콘 하나만 지원할 수 있습니다.

매개변수

이름유형설명
endIconIconImage추가할 아이콘입니다.

리턴

DecoratedText - 연결을 위한 이 객체


setId(id)

변형할 위젯을 식별하는 데 사용되는 할당된 고유 ID를 설정합니다. 위젯 변형은 부가기능에서만 지원됩니다.

매개변수

이름유형설명
idString위젯의 ID입니다. 64자(영문 기준)로 제한되며 `[a-zA-Z0-9-]+` 형식입니다.

리턴

Widget - 연결을 위한 이 객체


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

매개변수

이름유형설명
actionAction이 요소를 클릭할 때 취할 작업입니다.

리턴

DecoratedText - 연결을 위한 이 객체


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

매개변수

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

리턴

DecoratedText - 연결을 위한 이 객체


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

매개변수

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

리턴

DecoratedText - 연결을 위한 이 객체


setStartIcon(startIcon)

텍스트 콘텐츠 앞에 표시할 선택적 IconImage를 설정합니다.

매개변수

이름유형설명
startIconIconImage표시할 아이콘입니다.

리턴

DecoratedText - 연결을 위한 이 객체


setSwitchControl(switchToSet)

콘텐츠 오른쪽에 표시되는 Switch를 설정합니다. DecoratedText는 버튼 하나 또는 스위치 하나만 지원할 수 있습니다.

매개변수

이름유형설명
switchToSetSwitch추가할 스위치입니다.

리턴

DecoratedText - 연결을 위한 이 객체


setText(text)

값으로 사용할 텍스트를 설정합니다. 기본 HTML 형식을 지원합니다. 필수 항목입니다.

매개변수

이름유형설명
textString이 위젯의 텍스트 콘텐츠입니다.

리턴

DecoratedText - 연결을 위한 이 객체


setTopLabel(text)

키로 사용되고 텍스트 콘텐츠 위에 표시될 라벨 텍스트를 설정합니다.

매개변수

이름유형설명
textString라벨 텍스트입니다.

리턴

DecoratedText - 연결을 위한 이 객체


setVisibility(visibility)

위젯의 공개 상태를 설정합니다. 기본값은 `VISIBLE`입니다.

매개변수

이름유형설명
visibilityVisibility위젯의 Visibility입니다.

리턴

Widget - 연결을 위한 객체입니다.


setWrapText(wrapText)

값 텍스트를 한 줄로 표시할지 여러 줄로 표시할지 설정합니다.

매개변수

이름유형설명
wrapTextBooleantrue인 경우 텍스트가 줄 바꿈되어 여러 줄에 표시됩니다. 그렇지 않으면 텍스트가 잘립니다.

리턴

DecoratedText - 연결을 위한 이 객체