Class Button

Button

Tüm düğmeler için temel bir sınıf.

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

Yöntemler

YöntemDönüş türüKısa açıklama
setAuthorizationAction(action)ButtonNesne tıklandığında yetkilendirme akışına yönelik bir URL'yi açan yetkilendirme işlemi ayarlar.
setComposeAction(action, composedEmailType)ButtonNesne tıklandığında e-posta taslağı oluşturan bir işlem ayarlar.
setOnClickAction(action)ButtonNesne tıklandığında yürütülecek bir işlem ayarlar.
setOnClickOpenLinkAction(action)ButtonNesne tıklandığında bir URL'yi sekmede açan bir işlem ayarlar.
setOpenLink(openLink)ButtonNesne tıklandığında açılacak bir URL ayarlar.
setOverflowMenu(menu)ButtonNesne tıklandığında açılacak bir pop-up menü ayarlar.

Ayrıntılı belgeler

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

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

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

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

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

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


setOverflowMenu(menu)

Nesne tıklandığında açılacak bir pop-up menü ayarlar. Menüdeki her öğe, tıklandığında tetiklenecek bir işlem belirtebilir. İç içe yerleştirilmiş menüler desteklenmez. Menü öğeleri için işlemler taşma menüsü belirtmemelidir.

Google Chat uygulamalarında kullanılabilir. Google Workspace eklentileri için geliştirici önizlemesinde.

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

Parametreler

AdTürAçıklama
menuOverflowMenuBu öğe tıklandığında görüntülenecek taşma menüsünü belirten nesne.

Return

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