Package google.apps.script.type.gmail

インデックス

ComposeTrigger

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

フィールド
actions[]

MenuItemExtensionPoint

コンポーズ時間アドオンのアクション セットを定義します。これらは、ユーザーが作成時にアドオンでトリガーできるアクションです。
draftAccess

DraftAccess

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

DraftAccess

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

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

ContextualTrigger

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

フィールド
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 は次のいずれかになります。
runFunction

string

ユーザーがアクションをトリガーしたときに呼び出されるエンドポイント。詳しくは、ユニバーサル アクション ガイドをご覧ください。