Class KeyValue

지원 중단되었습니다. 이 클래스는 지원 중단되었으며 새 스크립트에서 사용해서는 안 됩니다.

이 클래스는 지원 중단되었습니다. 대신 DecoratedText를 사용하세요.

메서드

메서드반환 유형간략한 설명
setAuthorizationAction(action)KeyValue객체를 클릭할 때 승인 흐름으로 연결되는 URL을 여는 승인 작업을 설정합니다.
setComposeAction(action, composedEmailType)KeyValue객체를 클릭할 때 이메일 초안을 작성하는 작업을 설정합니다.
setOnClickAction(action)KeyValue객체가 클릭될 때 실행되는 작업을 설정합니다.
setOnClickOpenLinkAction(action)KeyValue객체를 클릭할 때 탭에서 URL을 여는 작업을 설정합니다.
setOpenLink(openLink)KeyValue객체를 클릭할 때 열릴 URL을 설정합니다.
메서드반환 유형간략한 설명
setBottomLabel(text)KeyValue키로 사용할 라벨 텍스트를 설정합니다.
setButton(button)KeyValue컨텍스트 오른쪽에 표시되는 Button를 설정합니다.
setContent(text)KeyValue값으로 사용할 텍스트를 설정합니다.
setIcon(icon)KeyValue키로 사용할 아이콘을 설정합니다.
setIconAltText(altText)KeyValue아이콘의 대체 텍스트를 설정합니다.
setIconUrl(url)KeyValue키로 사용할 아이콘의 URL을 설정합니다.
setMultiline(multiline)KeyValue값 텍스트를 한 줄에 표시할지 여러 줄에 표시할지 설정합니다.
setSwitch(switchToSet)KeyValue콘텐츠 오른쪽에 표시되는 Switch를 설정합니다.
setTopLabel(text)KeyValue키로 사용할 라벨 텍스트를 설정합니다.

자세한 문서

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이 요소가 클릭될 때 취할 승인 작업을 지정하는 객체입니다.

리턴

KeyValue: 연결을 위한 객체입니다.


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 값입니다.

리턴

KeyValue: 연결을 위한 객체입니다.


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이 요소를 클릭할 때 취할 작업입니다.

리턴

KeyValue: 연결을 위한 객체입니다.


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이 요소가 클릭될 때 실행할 링크 열기 작업을 지정하는 객체입니다.

리턴

KeyValue: 연결을 위한 객체입니다.


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

매개변수

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

리턴

KeyValue: 연결을 위한 객체입니다.

지원 중단된 메서드

지원 중단되었습니다. 이 함수는 지원 중단되었으며 새 스크립트에서 사용해서는 안 됩니다.

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

매개변수

이름유형설명
textString라벨 텍스트입니다. 참고: 기본 HTML 형식은 지원되지 않습니다.

리턴

KeyValue: 연결을 위한 객체입니다.


지원 중단되었습니다. 이 함수는 지원 중단되었으며 새 스크립트에서 사용해서는 안 됩니다.

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

매개변수

이름유형설명
buttonButton추가 버튼

리턴

KeyValue: 연결을 위한 객체입니다.


지원 중단되었습니다. 이 함수는 지원 중단되었으며 새 스크립트에서 사용해서는 안 됩니다.

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

매개변수

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

리턴

KeyValue: 연결을 위한 객체입니다.


지원 중단되었습니다. 이 함수는 지원 중단되었으며 새 스크립트에서 사용해서는 안 됩니다.

키로 사용할 아이콘을 설정합니다.

매개변수

이름유형설명
iconIcon사전 정의된 Icon 값 중 하나입니다.

리턴

KeyValue: 연결을 위한 객체입니다.


지원 중단되었습니다. 이 함수는 지원 중단되었으며 새 스크립트에서 사용해서는 안 됩니다.

아이콘의 대체 텍스트를 설정합니다.

매개변수

이름유형설명
altTextString아이콘의 대체 텍스트입니다.

리턴

KeyValue: 연결을 위한 객체입니다.


지원 중단되었습니다. 이 함수는 지원 중단되었으며 새 스크립트에서 사용해서는 안 됩니다.

키로 사용할 아이콘의 URL을 설정합니다.

매개변수

이름유형설명
urlString아이콘으로 사용할 호스팅된 이미지의 URL 주소입니다.

리턴

KeyValue: 연결을 위한 객체입니다.


지원 중단되었습니다. 이 함수는 지원 중단되었으며 새 스크립트에서 사용해서는 안 됩니다.

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

매개변수

이름유형설명
multilineBoolean여러 줄 설정

리턴

KeyValue: 연결을 위한 객체입니다.


지원 중단되었습니다. 이 함수는 지원 중단되었으며 새 스크립트에서 사용해서는 안 됩니다.

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

매개변수

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

리턴

KeyValue: 연결을 위한 객체입니다.


지원 중단되었습니다. 이 함수는 지원 중단되었으며 새 스크립트에서 사용해서는 안 됩니다.

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

매개변수

이름유형설명
textString라벨 텍스트입니다. 참고: 기본 HTML 형식은 지원되지 않습니다.

리턴

KeyValue: 연결을 위한 객체입니다.