Class Image

Obraz

Widżet pokazujący pojedynczy obraz. Informacje o przycinaniu obrazów znajdziesz w artykule ImageCropStyle.

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

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

Metody

Metoda	Zwracany typ	Krótki opis
setAltText(altText)	Image	Ustawia tekst alternatywny obrazu na potrzeby ułatwień dostępu.
setAuthorizationAction(action)	Image	Ustawia działanie autoryzacji, które otwiera URL do procesu autoryzacji po kliknięciu obiektu.
setComposeAction(action, composedEmailType)	Image	Po kliknięciu obiektu ustawia działanie, które tworzy wersję roboczą e-maila.
setImageUrl(url)	Image	Ustawia obraz do użycia, podając jego adres URL lub ciąg danych.
setOnClickAction(action)	Image	Określa 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 zostanie otwarty po kliknięciu obiektu.

Szczegółowa dokumentacja

setAltText(altText)

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

Parametry

Nazwa	Typ	Opis
altText	String	Tekst alternatywny do przypisania do tego obrazu.

Powrót

Image – ten obiekt do łańcucha.

---

setAuthorizationAction(action)

Ustawia działanie autoryzacji, które otwiera URL do procesu autoryzacji po kliknięciu obiektu. Spowoduje to otwarcie adresu URL w nowym oknie. Gdy użytkownik zakończy proces autoryzacji i wróci do aplikacji, wtyczka zostanie ponownie załadowana.

Obiekt interfejsu może mieć tylko jeden z tych parametrów: 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 autoryzacyjne, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

Image – ten obiekt do łańcucha.

---

setComposeAction(action, composedEmailType)

Po kliknięciu obiektu ustawia działanie, które tworzy wersję roboczą e-maila. Obiekt interfejsu może mieć tylko jedną z tych przeglądarek: 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ą ComposeActionResponseBuilder.setGmailDraft(draft).

Uwaga: ta metoda nie ustawia działania tworzenia, które służy do rozszerzania interfejsu tworzenia. Zamiast tego łączy ten element interfejsu użytkownika z funkcją Action, która tworzy kopie robocze wiadomości w Apps Script, które po zakończeniu działania są otwierane w Gmailu.

// ...

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

Parametry

Nazwa	Typ	Opis
action	Action	Obiekt określający działanie, które ma zostać wykonane po kliknięciu tego elementu.
composedEmailType	ComposedEmailType	Wartość typu enumeracji określająca, czy skomponowany projekt jest samodzielny czy jest odpowiedzią na inny projekt.

Powrót

Image – ten obiekt do łańcucha.

---

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 zakodowanym w formacie base64 ciągiem znaków obrazu. Aby uzyskać ten kod, możesz użyć poniższego kodu, aby utworzyć zakodowany ciąg znaków obrazu z obrazu na Dysku Google, a następnie zapisać ten ciąg znaków na potrzeby późniejszego użycia w funkcji setImageUrl(url). Dzięki tej metodzie dodatek nie będzie musiał mieć 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(imageID).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 lub zakodowany ciąg znaków obrazu.

Powrót

Image – ten obiekt do łańcucha.

---

setOnClickAction(action)

Określa działanie, które jest wykonywane po kliknięciu obiektu. Obiekt interfejsu może mieć tylko jeden z tych parametrów: 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 ma być wykonywane po kliknięciu tego elementu.

Powrót

Image – ten obiekt do łańcucha.

---

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 gdy oprócz utworzenia obiektu OpenLink musisz wykonać inne czynności. Obiekt interfejsu może mieć tylko jeden z tych parametrów: 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ą 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 polegające na otwarciu linku, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

Image – ten obiekt do łańcucha.

---

setOpenLink(openLink)

Ustawia adres URL, który zostanie otwarty po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już znany i trzeba go tylko otworzyć. Obiekt interfejsu może mieć tylko jeden z tych parametrów: 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 łańcucha.