Class ImageButton

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。
ImageButton

画像が表示された ImageButton

var imageButton = CardService.newImageButton()
    .setAltText("An image button with an airplane icon.")
    .setIcon(CardService.Icon.AIRPLANE)
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://airplane.com"));

Methods

方法戻り値の型概要
setAltText(altText)ImageButtonユーザー補助機能のボタンの代替テキストを設定します。
setAuthorizationAction(action)ImageButtonオブジェクトがクリックされたときに承認フローの URL を開く認可アクションを設定します。
setComposeAction(action, composedEmailType)ImageButtonオブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setIcon(icon)ImageButtonボタンに表示する事前定義の Icon を設定します。
setIconUrl(url)ImageButtonこのボタンのアイコンとして使用する画像の URL を設定します。
setOnClickAction(action)ImageButtonオブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)ImageButtonオブジェクトがクリックされたときに、タブで URL を開くアクションを設定します。
setOpenLink(openLink)ImageButtonオブジェクトがクリックされたときに開く URL を設定します。

詳細なドキュメント

setAltText(altText)

ユーザー補助機能のボタンの代替テキストを設定します。必須。

パラメータ

名前説明
altTextStringこのボタンに割り当てる代替テキスト。

戻る

ImageButton - チェーン用のオブジェクト。


setAuthorizationAction(action)

オブジェクトがクリックされたときに承認フローの URL を開く認可アクションを設定します。URL が新しいウィンドウで開きます。ユーザーが認証フローを終了してアプリケーションに戻ると、アドオンが再読み込みされます。

UI オブジェクトには、setOpenLink(openLink)setOnClickAction(action)setOnClickOpenLinkAction(action)setAuthorizationAction(action)setComposeAction(action, composedEmailType) のいずれかのみを設定できます。

// ...

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

パラメータ

名前説明
actionAuthorizationActionこの要素がクリックされたときに実行する認証アクションを指定するオブジェクト。

戻る

ImageButton - チェーン用のオブジェクト。


setComposeAction(action, composedEmailType)

オブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。UI オブジェクトには、setOpenLink(openLink)setOnClickAction(action)setOnClickOpenLinkAction(action)setAuthorizationAction(action)setComposeAction(action, composedEmailType) のいずれかのみを設定できます。

Action パラメータには、ComposeActionResponseBuilder.setGmailDraft(draft) を使用して構成された ComposeActionResponse オブジェクトを返すコールバック関数を指定する必要があります。

// ...

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

パラメータ

名前説明
actionActionこの要素がクリックされたときに実行する作成アクションを指定するオブジェクト。
composedEmailTypeComposedEmailType作成された下書きがスタンドアロンまたは返信の下書きのどちらであるかを指定する列挙値。

戻る

ImageButton - チェーン用のオブジェクト。


setIcon(icon)

ボタンに表示する事前定義の Icon を設定します。ボタン画像を定義するには、このボタンまたは setIconUrl(url) を使用する必要があります。

パラメータ

名前説明
iconIcon事前定義の Icon 値のいずれか。

戻る

ImageButton - チェーン用のオブジェクト。


setIconUrl(url)

このボタンのアイコンとして使用する画像の URL を設定します。ボタン画像を定義するには、これまたは setIcon(icon) を使用する必要があります。

パラメータ

名前説明
urlStringこのボタンのアイコンとして使用するホスト画像の URL アドレス。

戻る

ImageButton - チェーン用のオブジェクト。


setOnClickAction(action)

オブジェクトがクリックされたときに実行されるアクションを設定します。UI オブジェクトには、setOpenLink(openLink)setOnClickAction(action)setOnClickOpenLinkAction(action)setAuthorizationAction(action)setComposeAction(action, composedEmailType) のいずれかのみを設定できます。

Action パラメータでは、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();
}

パラメータ

名前説明
actionActionこの要素がクリックされたときに実行するアクション。

戻る

ImageButton - チェーン用のオブジェクト。


setOnClickOpenLinkAction(action)

オブジェクトがクリックされたときに、タブで URL を開くアクションを設定します。この関数は、URL を作成する必要がある場合や、OpenLink オブジェクトを作成するために他のアクションを行う必要がある場合に使用します。UI オブジェクトには、setOpenLink(openLink)setOnClickAction(action)setOnClickOpenLinkAction(action)setAuthorizationAction(action)setComposeAction(action, composedEmailType) のいずれか 1 つのみを設定できます。

Action パラメータには、ActionResponseBuilder.setOpenLink(openLink) を使用して構成された ActionResponse オブジェクトを返すコールバック関数を指定する必要があります。

// ...

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

パラメータ

名前説明
actionActionこの要素がクリックされたときに実行するオープンリンク アクションを指定するオブジェクト。

戻る

ImageButton - チェーン用のオブジェクト。


オブジェクトがクリックされたときに開く URL を設定します。この関数は、URL がすでにわかっているため開く必要がある場合にのみ使用します。UI オブジェクトには、setOpenLink(openLink)setOnClickAction(action)setOnClickOpenLinkAction(action)setAuthorizationAction(action)setComposeAction(action, composedEmailType) のいずれか 1 つのみを設定できます。

パラメータ

名前説明
openLinkOpenLink開く URL を記述する OpenLink オブジェクト。

戻る

ImageButton - チェーン用のオブジェクト。