Class Image

Obraz

Widżet wyświetlający pojedynczy obraz. Informacje o przycinaniu obrazów znajdziesz w sekcji 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

MetodaZwracany typKrótki opis
setAltText(altText)ImageUstawia tekst alternatywny obrazu na potrzeby ułatwień dostępu.
setAuthorizationAction(action)ImageUstawia działanie autoryzacji, które otwiera adres URL w procesie autoryzacji, gdy obiekt kliknięto.
setComposeAction(action, composedEmailType)ImageUstawia działanie tworzące wersję roboczą e-maila po kliknięciu obiektu.
setImageUrl(url)ImageOkreśla 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 adres URL otwierany po kliknięciu obiektu.

Szczegółowa dokumentacja

setAltText(altText)

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

Parametry

NazwaTypOpis
altTextStringTekst alternatywny do przypisania do tego obrazu.

Powrót

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


setAuthorizationAction(action)

Ustawia działanie autoryzacji, które otwiera adres URL w procesie autoryzacji, gdy obiekt kliknięto. Spowoduje to otwarcie adresu URL w nowym oknie. Gdy użytkownik zakończy proces autoryzacji powróci do aplikacji, dodatek zostanie załadowany ponownie.

Obiekt interfejsu może mieć tylko jedną z wartości: 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, które ma zostać wykonane, gdy ten element jest kliknięto.

Powrót

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


setComposeAction(action, composedEmailType)

Ustawia działanie tworzące wersję roboczą e-maila po kliknięciu obiektu. Obiekt interfejsu może mieć tylko mają jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), Ustawiono 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, który określa działanie tworzenia, które ma być wykonywane, gdy ten element jest kliknięto.
composedEmailTypeComposedEmailTypeWartość wyliczeniowa, która określa, czy tworzona wersja robocza to samodzielnej lub roboczej odpowiedzi.

Powrót

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


setImageUrl(url)

Określa 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 znaków obrazu zakodowanym w formacie base64. Aby uzyskać ten drugi kod, możesz użyć podanego niżej kodu do utworzenia zakodowanego ciągu obrazu z na Dysku Google, a następnie zapisać ten ciąg znaków do późniejszego użycia w setImageUrl(url). Ta metoda zapobiega sytuacji, w której dodatek musi mieć dostęp do dostępny adres 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, który ma zostać użyty, lub zakodowany ciąg znaków obrazu.

Powrót

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


setOnClickAction(action)

Ustawia działanie wykonywane po kliknięciu obiektu. Obiekt interfejsu użytkownika może mieć tylko jedną z tych wartości: Ustawiono 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, jakie ma zostać wykonane po kliknięciu tego elementu.

Powrót

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


setOnClickOpenLinkAction(action)

Ustawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie. Użyj tej funkcji, gdy Musisz utworzyć adres URL lub wykonać inne działania oprócz utworzenia obiektu OpenLink. Obiekt UI może mieć tylko jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub Ustawiono 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 otwarcia linku, które ma zostać wykonane, gdy ten element jest kliknięto.

Powrót

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


Ustawia adres URL otwierany po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już i trzeba go tylko otworzyć. Obiekt UI może mieć tylko jedną z tych wartości: 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.

Powrót

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