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

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 URL do procesu autoryzacji po kliknięciu obiektu.
setComposeAction(action, composedEmailType)ImagePo kliknięciu obiektu ustawia działanie, które tworzy wersję roboczą e-maila.
setImageUrl(url)ImageUstawia obraz do użycia, podając jego adres URL lub ciąg danych.
setOnClickAction(action)ImageOkreśla działanie, które jest wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)ImageUstawia działanie, które otwiera URL w karcie po kliknięciu obiektu.
setOpenLink(openLink)ImageUstawia 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

NazwaTypOpis
altTextStringTekst alternatywny do przypisania do tego obrazu.

Powrót

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 powró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

NazwaTypOpis
actionAuthorizationActionObiekt 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 ustawioną wartość 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).

// ...

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

NazwaTypOpis
actionActionObiekt określający działanie, które ma zostać wykonane po kliknięciu tego elementu.
composedEmailTypeComposedEmailTypeWartość wyliczeniowa określająca, czy utworzona wersja robocza jest samodzielną wersją roboczą czy 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ć adresem URL dostępnym publicznie lub ciągiem znaków obrazu zakodowanym w formacie base64. 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

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

Powrót

Image – ten obiekt do łańcucha.


setOnClickAction(action)

Ustawia działanie 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

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

Powrót

Image – ten obiekt do łańcucha.


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 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

NazwaTypOpis
actionActionObiekt określający działanie otwierania linku, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

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


Ustawia adres URL, który zostanie otwarty po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już znany, ale 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

NazwaTypOpis
openLinkOpenLinkObiekt OpenLink opisujący adres URL do otwarcia.

Powrót

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