Class Image

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

単一の画像を表示するウィジェット。

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

Methods

方法戻り値の型概要
setAltText(altText)Image画像の代替テキストを設定します。
setAuthorizationAction(action)Imageオブジェクトがクリックされたときに承認フローの URL を開く認可アクションを設定します。
setComposeAction(action, composedEmailType)Imageオブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setImageUrl(url)ImageURL またはデータ文字列を指定して、使用する画像を設定します。
setOnClickAction(action)Imageオブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)Imageオブジェクトがクリックされたときに、タブで URL を開くアクションを設定します。
setOpenLink(openLink)Imageオブジェクトがクリックされたときに開く URL を設定します。

詳細なドキュメント

setAltText(altText)

画像の代替テキストを設定します。必須。

パラメータ

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

戻る

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


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この要素がクリックされたときに実行する認証アクションを指定するオブジェクト。

戻る

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


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作成された下書きがスタンドアロンまたは返信の下書きのどちらであるかを指定する列挙値。

戻る

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


setImageUrl(url)

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).

パラメータ

名前説明
urlStringホストされている画像の URL アドレスか、エンコードされた画像文字列です。

戻る

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


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この要素がクリックされたときに実行するアクション。

戻る

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


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この要素がクリックされたときに実行するオープンリンク アクションを指定するオブジェクト。

戻る

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


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

パラメータ

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

戻る

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