Class Image

Image

Widżet wyświetlający pojedynczy obraz. Informacje o przycinaniu obrazów: ImageCropStyle.

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

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

Metody

Metoda	Typ zwracanej wartości	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 po kliknięciu obiektu otwiera adres URL w procesie autoryzacji.
setComposeAction(action, composedEmailType)	Image	Ustawia działanie tworzące wersję roboczą e-maila po kliknięciu obiektu.
setImageUrl(url)	Image	Ustawia używany obraz, podając jego adres URL lub ciąg danych.
setOnClickAction(action)	Image	Ustawia działanie wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)	Image	Ustawia działanie, które otwiera adres URL na karcie po kliknięciu obiektu.
setOpenLink(openLink)	Image	Ustawia adres URL, który otwiera się po kliknięciu obiektu.

Szczegółowa dokumentacja

setAltText(altText)

Ustawia tekst alternatywny obrazu na potrzeby ułatwień dostępu. To pole jest wymagane.

Parametry

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

Powroty

Image – ten obiekt do tworzenia łańcuchów.

---

setAuthorizationAction(action)

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

Obiekt UI może mieć ustawiony tylko jeden z tych elementów setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

// ...

var 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 być wykonywane po kliknięciu tego elementu.

Powroty

Image – ten obiekt do tworzenia łańcuchów.

---

setComposeAction(action, composedEmailType)

Ustawia działanie tworzące wersję roboczą e-maila po kliknięciu obiektu. Obiekt UI może mieć ustawiony tylko jeden z tych elementó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 ComposeActionResponse skonfigurowany za pomocą ComposeActionResponseBuilder.setGmailDraft(draft).

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

// ...

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

Parametry

Nazwa	Typ	Opis
action	Action	Obiekt określający czynność tworzenia, która ma być wykonywana po kliknięciu tego elementu.
composedEmailType	ComposedEmailType	Wartość wyliczenia, która określa, czy stworzona wersja robocza jest samodzielną wersją roboczą, czy wersją odpowiedzi.

Powroty

Image – ten obiekt do tworzenia łańcuchów.

---

setImageUrl(url)

Ustawia używany obraz, podając jego adres URL lub ciąg danych. To pole jest wymagane.

Podany adres URL może być publicznie dostępnym adresem URL lub ciągiem znaków obrazu zakodowanym w standardzie base64. Aby uzyskać ten drugi ciąg, możesz utworzyć zakodowany ciąg obrazu z obrazu na Dysku Google, korzystając z poniższego kodu, a następnie zapisać ten ciąg do późniejszego użycia w funkcji setImageUrl(url). Ta metoda zapobiega konieczności uzyskania 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.
var imageBytes = DriveApp.getFileById(imageID).getBlob().getBytes();
var 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 obrazu.

Powroty

Image – ten obiekt do tworzenia łańcuchów.

---

setOnClickAction(action)

Ustawia działanie wykonywane po kliknięciu obiektu. Obiekt UI może mieć ustawiony 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.

// ...

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

Parametry

Nazwa	Typ	Opis
action	Action	Działanie, jakie ma być wykonywane po kliknięciu tego elementu.

Powroty

Image – ten obiekt do tworzenia łańcuchów.

---

setOnClickOpenLinkAction(action)

Ustawia działanie, które otwiera adres URL na karcie po kliknięciu obiektu. Użyj tej funkcji, gdy trzeba skompilować adres URL lub gdy trzeba wykonać inne działania oprócz utworzenia obiektu OpenLink. Obiekt UI może mieć ustawiony tylko jeden z tych elementó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).

// ...

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

Parametry

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

Powroty

Image – ten obiekt do tworzenia łańcuchów.

---

setOpenLink(openLink)

Ustawia adres URL, który otwiera się po kliknięciu obiektu. Tej funkcji należy używać, gdy adres URL jest już znany i tylko trzeba go otworzyć. Obiekt UI może mieć ustawiony tylko jeden z tych elementó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.

Powroty

Image – ten obiekt do tworzenia łańcuchów.