Class TextButton

ユーザー補助機能用のボタンの代替テキストを設定します。未設定のままにした場合は、デフォルトでボタンに表示されるテキストが使用されます。

パラメータ

リターン

TextButton - このオブジェクト（チェーン用）。

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

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

// ...

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

パラメータ

リターン

TextButton - このオブジェクト（チェーン用）。

TextButtonStyle.FILLED ボタンの背景色を設定します。TextButtonStyle.FILLED ボタンで設定されていない場合、ボタンにはアドオンのマニフェストで定義されているセカンダリ カラーが使用されます。 このメソッドは、TextButtonStyle.TEXT ボタンには影響しません。

パラメータ

リターン

TextButton - このオブジェクト（チェーン用）。

オブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。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();
}

パラメータ

リターン

TextButton - このオブジェクト（チェーン用）。

ボタンを無効にするかどうかを設定します。無効になっているボタンはグレー表示され、クリックできません。

パラメータ

リターン

TextButton - このオブジェクト（チェーン用）。

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

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

パラメータ

リターン

TextButton - このオブジェクト（チェーン用）。

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

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

パラメータ

リターン

TextButton - このオブジェクト（チェーン用）。

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

パラメータ

リターン

TextButton - このオブジェクト（チェーン用）。

ボタンに表示するテキストを設定します。

パラメータ

リターン

TextButton - このオブジェクト（チェーン用）。

ボタンのスタイルを設定します。設定しない場合、デフォルトの TextButtonStyle.TEXT ボタンになります。

パラメータ

リターン

TextButton - このオブジェクト（チェーン用）。