このページは Cloud Translation API によって翻訳されました。

Class Image

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

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

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)`	`Image`	URL またはデータ文字列を指定して、使用する画像を設定します。
`setOnClickAction(action)`	`Image`	オブジェクトがクリックされたときに実行されるアクションを設定します。
`setOnClickOpenLinkAction(action)`	`Image`	オブジェクトをクリックしたときにタブの URL を開くアクションを設定します。
`setOpenLink(openLink)`	`Image`	オブジェクトがクリックされたときに開く URL を設定します。

詳細なドキュメント

`setAltText(altText)`

ユーザー補助機能向けに画像の代替テキストを設定します。必須。

パラメータ

Name	型	説明
`altText`	`String`	この画像に割り当てる代替テキスト。

リターン

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

パラメータ

Name	型	説明
`action`	`AuthorizationAction`	この要素がクリックされたときに行う承認アクションを指定するオブジェクト。

リターン

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

`setComposeAction(action, composedEmailType)`

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

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

注: このメソッドでは、作成 UI の拡張に使用される作成アクションは設定されません。このメソッドは、Actionこの UI 要素を Apps Script で下書きメッセージを作成し操作完了時に Gmail で開きます。

// ...

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

パラメータ

Name	型	説明
`action`	`Action`	この要素がクリックされたときに行う作成アクションを指定するオブジェクト。
`composedEmailType`	`ComposedEmailType`	作成された下書きが単独の下書きか返信の下書きかを指定する列挙値。

リターン

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

パラメータ

Name	型	説明
`url`	`String`	使用するホストされている画像の 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();
}

パラメータ

Name	型	説明
`action`	`Action`	この要素がクリックされたときに行うアクション。

リターン

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

パラメータ

Name	型	説明
`action`	`Action`	この要素がクリックされたときに行う、リンクを開くアクションを指定するオブジェクト。

リターン

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

`setOpenLink(openLink)`

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

パラメータ

Name	型	説明
`openLink`	`OpenLink`	開く URL を記述する `OpenLink` オブジェクト。

リターン

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