단일 이미지를 표시하는 위젯입니다. 이미지 자르기에 대한 자세한 내용은 Image를 참고하세요.
Google Workspace 부가기능 및 Google Chat 앱에서 사용할 수 있습니다.
const image = CardService.newImage() .setAltText('A nice image') .setImageUrl('https://image.png');
메서드
| 메서드 | 반환 유형 | 간략한 설명 |
|---|---|---|
add | Widget | 위젯에서 실행할 수 있는 이벤트 작업을 추가합니다. |
set | Image | 접근성을 위해 이미지의 대체 텍스트를 설정합니다. |
set | Image | 객체를 클릭할 때 승인 흐름으로 URL을 여는 승인 작업을 설정합니다. |
set | Image | 객체를 클릭할 때 이메일 초안을 작성하는 작업을 설정합니다. |
set | Widget | 변형할 위젯을 식별하는 데 사용되는 할당된 고유 ID를 설정합니다. |
set | Image | URL 또는 데이터 문자열을 제공하여 사용할 이미지를 설정합니다. |
set | Image | 객체를 클릭할 때 실행되는 작업을 설정합니다. |
set | Image | 객체를 클릭할 때 탭에서 URL을 여는 작업을 설정합니다. |
set | Image | 객체를 클릭할 때 열릴 URL을 설정합니다. |
set | Widget | 위젯의 공개 상태를 설정합니다. |
자세한 문서
add Event Action(eventAction)
위젯에서 실행할 수 있는 이벤트 작업을 추가합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
event | Event | 추가할 Event입니다. |
리턴
Widget - 연결을 위한 객체입니다.
set Alt Text(altText)
접근성을 위해 이미지의 대체 텍스트를 설정합니다. 필수 항목입니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
alt | String | 이 이미지에 할당할 대체 텍스트입니다. |
리턴
Image - 연결을 위한 이 객체
set Authorization Action(action)
객체를 클릭할 때 승인 흐름으로 URL을 여는 승인 작업을 설정합니다. 그러면 새 창에서 URL이 열립니다. 사용자가 승인 흐름을 완료하고 애플리케이션으로 돌아오면 부가기능이 다시 로드됩니다.
UI 객체에는 set, set, set, set 또는 set 중 하나만 설정할 수 있습니다.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
action | Authorization | 이 요소를 클릭할 때 실행할 승인 작업을 지정하는 객체입니다. |
리턴
Image - 연결을 위한 이 객체
set Compose Action(action, composedEmailType)
객체를 클릭할 때 이메일 초안을 작성하는 작업을 설정합니다. UI 객체에는 set, set, set, set 또는 set 중 하나만 설정할 수 있습니다.
Action 매개변수는 Compose를 사용하여 구성된 Compose 객체를 반환하는 콜백 함수를 지정해야 합니다.
// ... 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(); }
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
action | Action | 이 요소를 클릭할 때 실행할 컴포즈 작업을 지정하는 객체입니다. |
composed | Composed | 작성된 초안이 독립형 초안인지 답장 초안인지 지정하는 enum 값입니다. |
리턴
Image - 연결을 위한 이 객체
set Id(id)
변형할 위젯을 식별하는 데 사용되는 할당된 고유 ID를 설정합니다. 위젯 변형은 부가기능에서만 지원됩니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | String | 위젯의 ID입니다. 64자(영문 기준)로 제한되며 `[a-zA-Z0-9-]+` 형식입니다. |
리턴
Widget - 연결을 위한 이 객체
set Image Url(url)
URL 또는 데이터 문자열을 제공하여 사용할 이미지를 설정합니다. 필수 항목입니다.
제공된 URL은 공개적으로 액세스 가능한 URL 또는 base64 인코딩 이미지 문자열일 수 있습니다.
후자를 얻으려면 다음 코드를 사용하여 Google Drive의 이미지에서 인코딩된 이미지 문자열을 만든 다음 set와 함께 나중에 사용할 수 있도록 해당 문자열을 저장하면 됩니다. 이 방법을 사용하면 부가기능이 공개적으로 제공되는 이미지 URL에 액세스할 필요가 없습니다.
// The following assumes you have the image to use in Google Drive and have its // ID. const imageBytes = DriveApp.getFileById('123abc').getBlob().getBytes(); const encodedImageURL = `data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`; // You can store encodeImageURL and use it as a parameter to // Image.setImageUrl(url).
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
url | String | 사용할 호스팅 이미지의 URL 주소 또는 인코딩된 이미지 문자열입니다. |
리턴
Image - 연결을 위한 이 객체
set On Click Action(action)
객체를 클릭할 때 실행되는 작업을 설정합니다. UI 객체에는 set, set, set, set 또는 set 중 하나만 설정할 수 있습니다.
Action 매개변수는 Action 객체를 반환하는 콜백 함수를 지정해야 합니다.
// ... 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 | 이 요소를 클릭할 때 취할 작업입니다. |
리턴
Image - 연결을 위한 이 객체
set On Click Open Link Action(action)
객체를 클릭할 때 탭에서 URL을 여는 작업을 설정합니다. URL을 빌드해야 하거나 Open 객체를 만드는 것 외에 다른 작업을 수행해야 하는 경우 이 함수를 사용하세요. UI 객체에는 set, set, set, set 또는 set 중 하나만 설정할 수 있습니다.
Action 매개변수는 Action를 사용하여 구성된 Action 객체를 반환하는 콜백 함수를 지정해야 합니다.
// ... 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 | 이 요소를 클릭할 때 실행할 링크 열기 작업을 지정하는 객체입니다. |
리턴
Image - 연결을 위한 이 객체
set Open Link(openLink)
객체를 클릭할 때 열릴 URL을 설정합니다. URL을 이미 알고 있으며 열기만 하면 되는 경우 이 함수를 사용하세요. UI 객체에는 set, set, set, set 또는 set 중 하나만 설정할 수 있습니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
open | Open | 열 URL을 설명하는 Open 객체입니다. |
리턴
Image - 연결을 위한 이 객체
set Visibility(visibility)
위젯의 공개 상태를 설정합니다. 기본값은 `VISIBLE`입니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
visibility | Visibility | 위젯의 Visibility입니다. |
리턴
Widget - 연결을 위한 객체입니다.