Class ImageButton

ImageButton

이미지가 표시된 ImageButton

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

const 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을 설정합니다.
setImageButtonStyle(imageButtonStyle)	ImageButton	버튼 스타일을 설정합니다.
setMaterialIcon(icon)	ImageButton	Material Design 아이콘을 설정합니다.
setOnClickAction(action)	ImageButton	객체가 클릭될 때 실행되는 작업을 설정합니다.
setOnClickOpenLinkAction(action)	ImageButton	객체를 클릭할 때 탭에서 URL을 여는 작업을 설정합니다.
setOpenLink(openLink)	ImageButton	객체를 클릭할 때 열 URL을 설정합니다.
setOverflowMenu(menu)	ImageButton	객체를 클릭할 때 열리는 팝업 메뉴를 설정합니다.

자세한 문서

setAltText(altText)

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

매개변수

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

리턴

ImageButton - 체이닝을 위한 객체입니다.

---

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

리턴

ImageButton - 체이닝을 위한 객체입니다.

---

setComposeAction(action, composedEmailType)

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

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

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

// ...

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

// ...

function composeEmailCallback() {
  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 값입니다.

리턴

ImageButton - 체이닝을 위한 객체입니다.

---

setIcon(icon)

버튼에 표시할 사전 정의된 Icon를 설정합니다. 버튼 이미지를 정의하려면 이 속성 또는 setIconUrl(url)를 사용해야 합니다.

매개변수

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

리턴

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

---

setIconUrl(url)

이 버튼의 아이콘으로 사용할 이미지의 URL을 설정합니다. 버튼 이미지를 정의하려면 이 속성 또는 setIcon(icon)를 사용해야 합니다.

매개변수

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

리턴

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

---

setImageButtonStyle(imageButtonStyle)

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

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

const imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

매개변수

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

리턴

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

---

setMaterialIcon(icon)

Material Design 아이콘을 설정합니다.

const imageButton = CardService.newImageButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

매개변수

이름	유형	설명
icon	MaterialIcon	Material Design 아이콘

리턴

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

---

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

리턴

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

---

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

리턴

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

---

setOpenLink(openLink)

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

매개변수

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

리턴

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

---

setOverflowMenu(menu)

객체를 클릭할 때 열리는 팝업 메뉴를 설정합니다. 메뉴의 각 항목을 클릭하면 트리거될 작업을 지정할 수 있습니다. 중첩된 메뉴는 지원되지 않으며 메뉴 항목의 작업은 더보기 메뉴를 지정해서는 안 됩니다.

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

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

매개변수

이름	유형	설명
menu	OverflowMenu	이 요소를 클릭할 때 표시할 오버플로 메뉴를 지정하는 객체입니다.

리턴

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