Class Image

Obraz

Widżet, który wyświetla pojedynczy obraz. Więcej informacji o przycinaniu obrazów znajdziesz w artykule ImageCropStyle.

Dostępne w przypadku dodatków do Google Workspace i aplikacji do Google Chat.

const image = CardService.newImage()
                  .setAltText('A nice image')
                  .setImageUrl('https://image.png');

Metody

Metoda	Zwracany typ	Krótki opis
addEventAction(eventAction)	Widget	Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie.
setAltText(altText)	Image	Ustawia tekst alternatywny obrazu na potrzeby ułatwień dostępu.
setAuthorizationAction(action)	Image	Ustawia działanie autoryzacji, które otwiera adres URL do procedury autoryzacji po kliknięciu obiektu.
setComposeAction(action, composedEmailType)	Image	Ustawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu.
setId(id)	Widget	Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmodyfikowany.
setImageUrl(url)	Image	Ustawia obraz do użycia, podając jego adres URL lub ciąg danych.
setOnClickAction(action)	Image	Ustawia działanie, które jest wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)	Image	Ustawia działanie, które otwiera URL w karcie po kliknięciu obiektu.
setOpenLink(openLink)	Image	Ustawia adres URL, który ma się otworzyć po kliknięciu obiektu.
setVisibility(visibility)	Widget	Ustawia widoczność widżetu.

Szczegółowa dokumentacja

addEventAction(eventAction)

Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie.

Parametry

Nazwa	Typ	Opis
eventAction	EventAction	EventAction do dodania.

Powrót

Widget – obiekt do łączenia.

---

setAltText(altText)

Ustawia tekst alternatywny obrazu na potrzeby ułatwień dostępu. Wymagane.

Parametry

Nazwa	Typ	Opis
altText	String	Tekst alternatywny, który ma być przypisany do tego obrazu.

Powrót

Image – ten obiekt do łączenia.

---

setAuthorizationAction(action)

Ustawia działanie autoryzacji, które otwiera adres URL do procedury autoryzacji po kliknięciu obiektu. URL otworzy się w nowym oknie. Gdy użytkownik zakończy proces autoryzacji i wróci do aplikacji, dodatek zostanie ponownie załadowany.

Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parametry

Nazwa	Typ	Opis
action	AuthorizationAction	Obiekt określający działanie autoryzacji, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

Image – ten obiekt do łączenia.

---

setComposeAction(action, composedEmailType)

Ustawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt ComposeActionResponse skonfigurowany za pomocą parametru ComposeActionResponseBuilder.setGmailDraft(draft).

Uwaga: ta metoda nie ustawia działania tworzenia, które jest używane do rozszerzania interfejsu tworzenia. Ta metoda łączy element interfejsu z Action, który tworzy robocze wiadomości w Apps Script, które są otwierane w Gmailu po zakończeniu działania.

// ...

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

Parametry

Nazwa	Typ	Opis
action	Action	Obiekt określający działanie tworzenia, które ma zostać wykonane po kliknięciu tego elementu.
composedEmailType	ComposedEmailType	Wartość wyliczeniowa określająca, czy utworzona wersja robocza jest wersją roboczą samodzielną czy odpowiedzią.

Powrót

Image – ten obiekt do łączenia.

---

setId(id)

Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmodyfikowany. Zmiana widżetu jest obsługiwana tylko w dodatkach.

Parametry

Nazwa	Typ	Opis
id	String	Identyfikator widżetu, który może mieć maksymalnie 64 znaki i musi być zgodny z formatem `[a-zA-Z0-9-]+`.

Powrót

Widget – ten obiekt do łączenia.

---

setImageUrl(url)

Ustawia obraz do użycia, podając jego adres URL lub ciąg danych. Wymagane.

Podany adres URL może być publicznie dostępnym adresem URL lub ciągiem tekstowym obrazu zakodowanym w formacie base64. Aby uzyskać ten ciąg, możesz użyć poniższego kodu do utworzenia zakodowanego ciągu obrazu z obrazu na Dysku Google, a następnie zapisać ten ciąg do późniejszego użycia z setImageUrl(url). Ta metoda eliminuje konieczność uzyskiwania przez dodatek dostępu do publicznie dostępnego adresu URL obrazu:

// 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).

Parametry

Nazwa	Typ	Opis
url	String	Adres URL hostowanego obrazu do użycia lub zakodowany ciąg znaków obrazu.

Powrót

Image – ten obiekt do łączenia.

---

setOnClickAction(action)

Ustawia działanie, które jest wykonywane po kliknięciu obiektu. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt 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();
}

Parametry

Nazwa	Typ	Opis
action	Action	Działanie, które należy wykonać po kliknięciu tego elementu.

Powrót

Image – ten obiekt do łączenia.

---

setOnClickOpenLinkAction(action)

Ustawia działanie, które otwiera URL w karcie po kliknięciu obiektu. Użyj tej funkcji, gdy musisz utworzyć adres URL lub wykonać inne działania oprócz utworzenia obiektu OpenLink. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt ActionResponse skonfigurowany za pomocą parametru ActionResponseBuilder.setOpenLink(openLink).

// ...

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

Parametry

Nazwa	Typ	Opis
action	Action	Obiekt określający działanie otwierania linku, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

Image – ten obiekt do łączenia.

---

setOpenLink(openLink)

Ustawia adres URL, który ma się otworzyć po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już znany i wystarczy go otworzyć. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametry

Nazwa	Typ	Opis
openLink	OpenLink	Obiekt OpenLink opisujący adres URL do otwarcia.

Powrót

Image – ten obiekt do łączenia.

---

setVisibility(visibility)

Ustawia widoczność widżetu. Wartością domyślną jest „VISIBLE”.

Parametry

Nazwa	Typ	Opis
visibility	Visibility	Visibility widżetu.

Powrót

Widget – obiekt do łączenia.