Class Image

ユーザー補助用の画像の代替テキストを設定します。必須。

パラメータ

戻る

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

オブジェクトがクリックされたときに承認フローの 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);

パラメータ

戻る

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

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

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

パラメータ

戻る

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

URL またはデータ文字列を指定して、使用する画像を設定します。必須。

指定する URL には、一般公開されている URL か、Base64 でエンコードされた画像文字列を指定できます。後者の場合、次のコードを使用して、Google ドライブ内の画像からエンコードされた画像文字列を作成し、後で使用するためにその文字列を保存します。setImageUrl(url)この方法では、アドオンが一般公開されている画像 URL にアクセスする必要がありません。

// The following assumes you have the image to use in Google Drive and have its ID.
var imageBytes = DriveApp.getFileById(imageID).getBlob().getBytes();
var encodedImageURL = "data:image/jpeg;base64," + Utilities.base64Encode(imageBytes);

// You can store encodeImageURL and use it as a parameter to Image.setImageUrl(url).

パラメータ

戻る

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

オブジェクトがクリックされたときに実行されるアクションを設定します。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();
}

パラメータ

戻る

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

オブジェクトがクリックされたときにタブで 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();
}

パラメータ

戻る

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

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

パラメータ

戻る

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