Class KeyValue

KeyValue

非推奨。このクラスは非推奨であるため、新しいスクリプトでは使用しないでください。

このクラスは非推奨になりました。代わりに、DecoratedText を使用してください。

メソッド

メソッド	戻り値の型	概要
setAuthorizationAction(action)	KeyValue	オブジェクトがクリックされたときに、認可フローの URL を開く認可アクションを設定します。
setComposeAction(action, composedEmailType)	KeyValue	オブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setOnClickAction(action)	KeyValue	オブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)	KeyValue	オブジェクトがクリックされたときにタブで URL を開くアクションを設定します。
setOpenLink(openLink)	KeyValue	オブジェクトがクリックされたときに開く URL を設定します。

サポート終了のメソッド

メソッド	戻り値の型	概要
setBottomLabel(text)	KeyValue	キーとして使用するラベルテキストを設定します。
setButton(button)	KeyValue	コンテキストの右側に表示される Button を設定します。
setContent(text)	KeyValue	値として使用するテキストを設定します。
setIcon(icon)	KeyValue	キーとして使用するアイコンを設定します。
setIconAltText(altText)	KeyValue	アイコンの代替テキストを設定します。
setIconUrl(url)	KeyValue	キーとして使用するアイコンの URL を設定します。
setMultiline(multiline)	KeyValue	値のテキストを 1 行に表示するか複数行に表示するかを設定します。
setSwitch(switchToSet)	KeyValue	コンテンツの右側に表示される Switch を設定します。
setTopLabel(text)	KeyValue	キーとして使用するラベルテキストを設定します。

詳細なドキュメント

setAuthorizationAction(action)

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

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

// ...

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

パラメータ

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

戻る

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

---

setComposeAction(action, composedEmailType)

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

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

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

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

パラメータ

名前	型	説明
action	Action	この要素がクリックされたときに実行するコンポーズ アクションを指定するオブジェクト。
composedEmailType	ComposedEmailType	作成された下書きがスタンドアロンか返信の下書きかを指定する列挙型値。

戻る

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

---

setOnClickAction(action)

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

Action パラメータには、ActionResponse オブジェクトを返すコールバック関数を指定する必要があります。

// ...

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

パラメータ

名前	型	説明
action	Action	この要素がクリックされたときに実行するアクション。

戻る

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

---

setOnClickOpenLinkAction(action)

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

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

// ...

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

パラメータ

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

戻る

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

---

setOpenLink(openLink)

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

パラメータ

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

戻る

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

サポート終了のメソッド

setBottomLabel(text)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

キーとして使用するラベルテキストを設定します。テキスト コンテンツの下に表示されます。

パラメータ

名前	型	説明
text	String	ラベルのテキスト。注: 基本的な HTML の書式設定はサポートされていません。

戻る

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

---

setButton(button)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

コンテキストの右側に表示される Button を設定します。KeyValue は、1 つのボタン、1 つのスイッチ、または 1 つのアイコンのみをサポートできます。

パラメータ

名前	型	説明
button	Button	追加ボタン。

戻る

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

---

setContent(text)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

値として使用するテキストを設定します。基本的な HTML の書式設定がサポートされています。必須。

パラメータ

名前	型	説明
text	String	このウィジェットのテキスト コンテンツ。

戻る

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

---

setIcon(icon)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

キーとして使用するアイコンを設定します。

パラメータ

名前	型	説明
icon	Icon	事前定義された Icon 値のいずれか。

戻る

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

---

setIconAltText(altText)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

アイコンの代替テキストを設定します。

パラメータ

名前	型	説明
altText	String	アイコンの代替テキスト。

戻る

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

---

setIconUrl(url)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

キーとして使用するアイコンの URL を設定します。

パラメータ

名前	型	説明
url	String	アイコンとして使用するホストされている画像の URL アドレス。

戻る

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

---

setMultiline(multiline)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

値のテキストを 1 行に表示するか複数行に表示するかを設定します。

パラメータ

名前	型	説明
multiline	Boolean	複数行の設定。

戻る

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

---

setSwitch(switchToSet)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

コンテンツの右側に表示される Switch を設定します。KeyValue は、1 つのボタン、1 つのスイッチ、または 1 つのアイコンのみをサポートできます。

パラメータ

名前	型	説明
switchToSet	Switch	追加するスイッチ。

戻る

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

---

setTopLabel(text)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

キーとして使用するラベルテキストを設定します。テキスト コンテンツの上に表示されます。

パラメータ

名前	型	説明
text	String	ラベルのテキスト。注: 基本的な HTML の書式設定はサポートされていません。

戻る

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