Class Image

Image

Widżet pokazujący pojedynczy obraz.

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

Metody

MetodaZwracany typKrótki opis
setAltText(altText)ImageUstawia alternatywny tekst obrazu na potrzeby ułatwień dostępu.
setAuthorizationAction(action)ImageUstawia działanie autoryzacji, które po kliknięciu obiektu otwiera adres URL procesu autoryzacji.
setComposeAction(action, composedEmailType)ImageUstawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu.
setImageUrl(url)ImageUstawia obraz do użycia, podając jego adres URL lub ciąg danych.
setOnClickAction(action)ImageUstawia działanie wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)ImageUstawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie.
setOpenLink(openLink)ImageUstawia URL otwierany po kliknięciu obiektu.

Szczegółowa dokumentacja

setAltText(altText)

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

Parametry

NazwaTypOpis
altTextStringTekst alternatywny do przypisania do tego obrazu.

Zwróć

Image – ten obiekt do łańcucha.


setAuthorizationAction(action)

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

Obiekt interfejsu może mieć ustawiony tylko jeden z tych atrybutó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

NazwaTypOpis
actionAuthorizationActionObiekt, który określa działanie autoryzacji wykonywane po kliknięciu tego elementu.

Zwróć

Image – ten obiekt do łańcucha.


setComposeAction(action, composedEmailType)

Ustawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu. Obiekt interfejsu 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 ComposeActionResponse skonfigurowany za pomocą ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

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

NazwaTypOpis
actionActionObiekt określający działanie tworzenia wiadomości po kliknięciu tego elementu.
composedEmailTypeComposedEmailTypeWartość wyliczeniowa, która określa, czy stworzona wersja robocza jest wersją samodzielną czy roboczą odpowiedzi.

Zwróć

Image – ten obiekt do łańcucha.


setImageUrl(url)

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

Podany URL może być adresem URL dostępnym publicznie lub zakodowanym w formacie base64. Aby uzyskać ten drugi ciąg, możesz użyć poniższego kodu, aby utworzyć zakodowany ciąg znaków z obrazu na Dysku Google, a następnie zapisać go do późniejszego użycia w setImageUrl(url). Ta metoda zapobiega potrzebie dostępu dodatku do publicznego 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

NazwaTypOpis
urlStringAdres URL hostowanego obrazu lub zakodowany ciąg znaków.

Zwróć

Image – ten obiekt do łańcucha.


setOnClickAction(action)

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

NazwaTypOpis
actionActionDziałanie, które ma zostać wykonane po kliknięciu tego elementu.

Zwróć

Image – ten obiekt do łańcucha.


setOnClickOpenLinkAction(action)

Ustawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie. Używaj tej funkcji, gdy musisz utworzyć adres URL lub wykonać dodatkowe działania, aby utworzyć obiekt OpenLink. Obiekt interfejsu może mieć ustawiony tylko 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

NazwaTypOpis
actionActionObiekt, który określa działanie linku otwartego po kliknięciu tego elementu.

Zwróć

Image – ten obiekt do łańcucha.


Ustawia URL otwierany po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już znany i tylko trzeba go otworzyć. Obiekt interfejsu może mieć ustawiony tylko setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametry

NazwaTypOpis
openLinkOpenLinkObiekt OpenLink opisujący adres URL, który ma zostać otwarty.

Zwróć

Image – ten obiekt do łańcucha.