Class ImageButton

ImageButton

이미지가 표시된 ImageButton

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

var imageButton = CardService.newImageButton()
    .setAltText("An image button with an airplane icon.")
    .setIcon(CardService.Icon.AIRPLANE)
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://airplane.com"));

방법

메서드반환 유형간략한 설명
setAltText(altText)ImageButton접근성을 위해 버튼의 대체 텍스트를 설정합니다.
setAuthorizationAction(action)ImageButton객체를 클릭하면 승인 흐름의 URL을 여는 승인 작업을 설정합니다.
setComposeAction(action, composedEmailType)ImageButton객체를 클릭하면 초안 이메일을 작성하는 작업을 설정합니다.
setIcon(icon)ImageButton버튼에 표시할 사전 정의된 Icon를 설정합니다.
setIconUrl(url)ImageButton이 버튼의 아이콘으로 사용할 이미지의 URL을 설정합니다.
setOnClickAction(action)ImageButton객체를 클릭할 때 실행되는 작업을 설정합니다.
setOnClickOpenLinkAction(action)ImageButton객체를 클릭하면 탭에서 URL을 여는 작업을 설정합니다.
setOpenLink(openLink)ImageButton객체를 클릭하면 열릴 URL을 설정합니다.

자세한 문서

setAltText(altText)

접근성을 위해 버튼의 대체 텍스트를 설정합니다. 필수 항목입니다.

매개변수

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

리턴

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


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

리턴

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


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작성된 초안이 독립형인지 답장 초안인지 지정하는 열거형 값입니다.

리턴

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


setIcon(icon)

버튼에 표시할 사전 정의된 Icon를 설정합니다. 이 메서드 또는 setIconUrl(url)는 버튼 이미지를 정의하는 데 사용해야 합니다.

매개변수

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

리턴

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


setIconUrl(url)

이 버튼의 아이콘으로 사용할 이미지의 URL을 설정합니다. 이 메서드 또는 setIcon(icon)를 사용하여 버튼 이미지를 정의해야 합니다.

매개변수

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

리턴

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


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이 요소를 클릭하면 수행할 작업입니다.

리턴

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


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

리턴

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


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

매개변수

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

리턴

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