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

Package google.apps.script.type.gmail

ComposeTrigger

ユーザーがメールを作成しているときに有効になるトリガー。

フィールド

フィールド
`actions[]`	`MenuItemExtensionPoint` 作成時アドオンの一連のアクションを定義します。ユーザーが作成時のアドオンでトリガーできる操作です。
`draftAccess`	`DraftAccess` 作成時アドオンがトリガーされたときのデータアクセスレベルを定義します。

actions[]

MenuItemExtensionPoint

作成時アドオンの一連のアクションを定義します。ユーザーが作成時のアドオンでトリガーできる操作です。

draftAccess

DraftAccess

作成時アドオンがトリガーされたときのデータアクセスレベルを定義します。

DraftAccess

Compose トリガーに必要なデータアクセスレベルを定義する列挙型。

列挙型
`UNSPECIFIED`	draftAccess に何も設定されていない場合のデフォルト値。
`NONE`	作成アドオンがトリガーされた場合、作成トリガーは下書きのデータにアクセスできません。
`METADATA`	作成アドオンがトリガーされたときに、下書きのメタデータにアクセスする権限を Compose トリガーに付与します。これには、下書きメールの To リストや Cc リストなどのオーディエンスリストも含まれます。

ContextualTrigger

開封メールが特定の条件を満たしたときに配信されるトリガーを定義します。トリガーが発動すると、通常は新しいカードの作成と UI の更新のために特定のエンドポイントが実行されます。

フィールド

フィールド
`onTriggerFunction`	`string` 必須。メッセージがトリガーに一致するときに呼び出すエンドポイントの名前。
共用体フィールド `trigger`。トリガーの種類によって、Gmail でアドオンの表示に使用される条件が決まります。`trigger` は次のいずれかになります。
`unconditional`	`UnconditionalTrigger` メールメッセージが開かれると、無条件トリガーが実行されます。

onTriggerFunction

string

必須。メッセージがトリガーに一致するときに呼び出すエンドポイントの名前。

共用体フィールド trigger。トリガーの種類によって、Gmail でアドオンの表示に使用される条件が決まります。trigger は次のいずれかになります。

unconditional

UnconditionalTrigger

メールメッセージが開かれると、無条件トリガーが実行されます。

GmailAddOnManifest

Gmail アドオンの外観と実行をカスタマイズするプロパティ。

フィールド
`homepageTrigger`	`HomepageExtensionPoint` 宣言されたコンテキストトリガーと一致しないコンテキストで実行されるエンドポイントを定義します。この関数で生成されたカードは常にユーザーが利用できますが、このアドオンでよりターゲットを絞ったトリガーが宣言されている場合、コンテキストコンテンツによって隠れる可能性があります。存在する場合、`addOns.common.homepageTrigger` の構成がオーバーライドされます。
`contextualTriggers[]`	`ContextualTrigger` アドオンをトリガーする一連の条件を定義します。
`universalActions[]`	`UniversalAction` アドオンの一連のユニバーサルアクションを定義します。アドオンのツールバーメニューからユニバーサルアクションをトリガーする。
`composeTrigger`	`ComposeTrigger` 作成時アドオンの作成時間トリガーを定義します。このトリガーにより、ユーザーがメールを作成しているときにアドオンでアクションが実行されます。下書きを編集しない可能性がある場合でも、作成時アドオンには `gmail.addons.current.action.compose` スコープが必要です。
`authorizationCheckFunction`	`string` サードパーティ API を調査して、アドオンに必要なサードパーティ承認がすべて揃っていることを確認するエンドポイントの名前。プローブが失敗した場合、関数は例外をスローして認可フローを開始します。この関数は、スムーズなユーザーエクスペリエンスを実現するため、アドオンが呼び出される前に呼び出されます。

UnconditionalTrigger

このタイプにはフィールドがありません。

メールメッセージが開かれたときに配信されるトリガー。

UniversalAction

メッセージのコンテキストにかかわらず、アドオンのツールバーメニューで常に使用できる操作です。

フィールド
`text`	`string` 必須。ユーザーに表示される、操作を説明するテキスト（「新しい連絡先を追加」など）。
共用体フィールド `action_type`。アクションの種類によって、ユーザーがアクションを呼び出したときの Gmail の動作が決まります。`action_type` は次のいずれかになります。
`openLink`	`string` ユーザーが操作をトリガーしたときに Gmail によって開かれるリンク。
`runFunction`	`string` ユーザーがアクションをトリガーしたときに呼び出されるエンドポイント。詳しくは、ユニバーサルアクションのガイドをご覧ください。