Class Image

Resim

Tek bir resim gösteren widget. Görüntüleri kırpma hakkında bilgi için ImageCropStyle başlıklı makaleyi inceleyin.

Google Workspace eklentileri ve Google Chat uygulamaları için kullanılabilir. 

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

Yöntemler

YöntemDönüş türüKısa açıklama
addEventAction(eventAction)WidgetWidget'ta gerçekleştirilebilecek etkinlik işlemini ekler.
setAltText(altText)ImageErişilebilirlik için resmin alternatif metnini ayarlar.
setAuthorizationAction(action)ImageNesne tıklandığında yetkilendirme akışına yönelik bir URL'yi açan yetkilendirme işlemi ayarlar.
setComposeAction(action, composedEmailType)ImageNesne tıklandığında e-posta taslağı oluşturan bir işlem ayarlar.
setId(id)WidgetDeğiştirilecek widget'ı tanımlamak için kullanılan benzersiz kimliği ayarlar.
setImageUrl(url)ImageURL'sini veya veri dizesini sağlayarak kullanılacak resmi ayarlar.
setOnClickAction(action)ImageNesne tıklandığında yürütülecek bir işlem ayarlar.
setOnClickOpenLinkAction(action)ImageNesne tıklandığında bir URL'yi sekmede açan bir işlem ayarlar.
setOpenLink(openLink)ImageNesne tıklandığında açılacak bir URL ayarlar.
setVisibility(visibility)WidgetWidget'ın görünürlüğünü ayarlar.

Ayrıntılı belgeler

addEventAction(eventAction)

Widget'ta gerçekleştirilebilecek etkinlik işlemini ekler.

Parametreler

AdTürAçıklama
eventActionEventActionEklenecek EventAction.

Return

Widget: Zincirleme için kullanılan nesne.

setAltText(altText)

Erişilebilirlik için resmin alternatif metnini ayarlar. Zorunlu.

Parametreler

AdTürAçıklama
altTextStringBu resme atanacak alternatif metin.

Return

Image: Zincirleme için kullanılan bu nesne.

setAuthorizationAction(action)

Nesne tıklandığında yetkilendirme akışına yönelik bir URL'yi açan yetkilendirme işlemi ayarlar. Bu işlem, URL'yi yeni bir pencerede açar. Kullanıcı yetkilendirme akışını tamamlayıp uygulamaya döndüğünde eklenti yeniden yüklenir.

Bir kullanıcı arayüzü nesnesinde yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) ayarlanabilir. 

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parametreler

AdTürAçıklama
actionAuthorizationActionBu öğe tıklandığında yapılacak yetkilendirme işlemini belirten nesne.

Return

Image: Zincirleme için kullanılan bu nesne.

setComposeAction(action, composedEmailType)

Nesne tıklandığında e-posta taslağı oluşturan bir işlem ayarlar. Bir kullanıcı arayüzü nesnesinde yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) ayarlanabilir.

Action parametresi, ComposeActionResponseBuilder.setGmailDraft(draft) kullanılarak yapılandırılmış bir ComposeActionResponse nesnesi döndüren bir geri çağırma işlevi belirtmelidir. 

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Parametreler

AdTürAçıklama
actionActionBu öğe tıklandığında gerçekleştirilecek e-posta oluşturma işlemini belirten nesne.
composedEmailTypeComposedEmailTypeOluşturulan taslağın bağımsız mı yoksa yanıt taslağı mı olduğunu belirten bir enum değeri.

Return

Image: Zincirleme için kullanılan bu nesne.

setId(id)

Değiştirilecek widget'ı tanımlamak için kullanılan benzersiz kimliği ayarlar. Widget mutasyonu yalnızca eklentilerde desteklenir.

Parametreler

AdTürAçıklama
idString64 karakterle sınırlı ve "[a-zA-Z0-9-]+" biçiminde olan widget'ın kimliği.

Return

Widget: Zincirleme için kullanılan bu nesne.

setImageUrl(url)

URL'sini veya veri dizesini sağlayarak kullanılacak resmi ayarlar. Zorunlu.

Sağlanan URL, herkese açık bir URL veya Base64 olarak kodlanmış bir resim dizesi olabilir. İkincisini elde etmek için Google Drive'ınızdaki bir resimden kodlanmış bir resim dizesi oluşturmak üzere aşağıdaki kodu kullanabilir, ardından bu dizeyi setImageUrl(url) ile daha sonra kullanmak üzere saklayabilirsiniz. Bu yöntem, eklentinizin herkese açık bir resim URL'sine erişmesini engeller: 

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById('123abc').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).

Parametreler

AdTürAçıklama
urlStringKullanılacak barındırılan resmin URL adresi veya kodlanmış resim dizesi.

Return

Image: Zincirleme için kullanılan bu nesne.

setOnClickAction(action)

Nesne tıklandığında yürütülecek bir işlem ayarlar. Bir kullanıcı arayüzü nesnesinde yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) ayarlanabilir.

Action parametresi, ActionResponse nesnesi döndüren bir geri çağırma işlevi belirtmelidir. 

// ...

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

Parametreler

AdTürAçıklama
actionActionBu öğe tıklandığında yapılacak işlem.

Return

Image: Zincirleme için kullanılan bu nesne.

setOnClickOpenLinkAction(action)

Nesne tıklandığında bir URL'yi sekmede açan bir işlem ayarlar. URL'nin oluşturulması gerektiğinde veya OpenLink nesnesini oluşturmanın yanı sıra başka işlemler yapmanız gerektiğinde bu işlevi kullanın. Bir kullanıcı arayüzü nesnesinde yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) ayarlanabilir.

Action parametresi, ActionResponseBuilder.setOpenLink(openLink) kullanılarak yapılandırılmış bir ActionResponse nesnesi döndüren bir geri çağırma işlevi belirtmelidir. 

// ...

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

Parametreler

AdTürAçıklama
actionActionBu öğe tıklandığında gerçekleştirilecek açık bağlantı işlemini belirten nesne.

Return

Image: Zincirleme için kullanılan bu nesne.

Nesne tıklandığında açılacak bir URL ayarlar. URL zaten biliniyorsa ve yalnızca açılması gerekiyorsa bu işlevi kullanın. Bir kullanıcı arayüzü nesnesinde yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) ayarlanabilir.

Parametreler

AdTürAçıklama
openLinkOpenLinkAçılacak URL'yi açıklayan bir OpenLink nesnesi.

Return

Image: Zincirleme için kullanılan bu nesne.

setVisibility(visibility)

Widget'ın görünürlüğünü ayarlar. Varsayılan değer "VISIBLE"dır.

Parametreler

AdTürAçıklama
visibilityVisibilityWidget'ın Visibility.

Return

Widget: Zincirleme için kullanılan nesne.