Class Image

画像

1 つの画像を表示するウィジェット。画像の切り抜きについて詳しくは、ImageCropStyle をご覧ください。

Google Workspace アドオンと Google Chat アプリでご利用いただけます。

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

メソッド

メソッド戻り値の型概要
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) のいずれか 1 つのみを設定できます。

// ...

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 オブジェクトを返すコールバック関数を指定する必要があります。

<ph type="x-smartling-placeholder">

// ...

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 でエンコードされた画像文字列のいずれかです。 後者を取得するには、次のコードを使用して、エンコードされた画像文字列を 保存して、後で 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) セットしました。

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) を設定します。

パラメータ

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

戻る

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