索引
ComposeTrigger
(メッセージ)ComposeTrigger.DraftAccess
(列挙型)ContextualTrigger
(メッセージ)GmailAddOnManifest
(メッセージ)UnconditionalTrigger
(メッセージ)UniversalAction
(メッセージ)
Compose トリガー
ユーザーがメールを作成したときに起動するトリガー。
フィールド | |
---|---|
actions[] |
作成時間アドオンの一連のアクションを定義します。ユーザーが作成時間のアドオンでトリガーできるアクションは以下のとおりです。 |
draftAccess |
作成時間のアドオンがトリガーされたときのデータアクセスのレベルを定義します。 |
下書きアクセス
Compose トリガーに必要なデータアクセスのレベルを定義する列挙型。
列挙型 | |
---|---|
UNSPECIFIED |
draftAccess に何も設定されていない場合のデフォルト値。 |
NONE |
Compose アドオンがトリガーされたときに、Compose トリガーが下書きのデータにアクセスできなくなります。 |
METADATA |
Compose アドオンがトリガーされたときに、Compose トリガーに下書きのメタデータへのアクセス権を付与します。これには、下書きメッセージの [宛先] や [Cc] リストなどのオーディエンス リストが含まれます。 |
コンテキスト トリガー
開封メールが特定の条件を満たしている場合に配信されるトリガーを定義します。トリガーが発生すると、通常、新しいカードを作成して UI を更新するために、特定のエンドポイントを実行します。
フィールド | |
---|---|
onTriggerFunction |
必須。メッセージがトリガーと一致するときに呼び出すエンドポイントの名前。 |
共用体フィールド trigger 。トリガーの種類によって、Gmail でアドオンが表示される条件が決まります。trigger は次のいずれかになります。 |
|
unconditional |
無条件トリガーは、メール メッセージが開かれたときに実行されます。 |
Gmail アドオン マニフェスト
Gmail のアドオンの外観と実行をカスタマイズするプロパティ。
フィールド | |
---|---|
homepageTrigger |
宣言されたコンテキスト トリガーに一致しないコンテキストで実行されるエンドポイントを定義します。このアドオンで生成されるカードは、常にユーザーが利用できますが、このアドオンでよりターゲットを絞ったトリガーが宣言されると、コンテキスト コンテンツによって除外されることがあります。
|
contextualTriggers[] |
アドオンをトリガーする条件のセットを定義します。 |
universalActions[] |
アドオンのユニバーサル アクションのセットを定義します。ユーザーがアドオン ツールバー メニューからユニバーサル アクションをトリガーします。 |
composeTrigger |
作成時間アドオンの作成時間トリガーを定義します。このトリガーは、ユーザーがメールを作成したときにアクションを実行します。作成日時のアドオンには、下書きを編集できない場合でも |
authorizationCheckFunction |
サードパーティの API をプローブすることで、必要なサードパーティの承認がアドオンにすべてあることを検証するエンドポイントの名前。プローブが失敗した場合、関数は例外をスローして、承認フローを開始します。スムーズなユーザー エクスペリエンスを実現するため、アドオンを呼び出すたびにこの関数が呼び出されます。 |
無条件トリガー
メール メッセージが開かれたときに配信されるトリガー。
ユニバーサル アクション
メッセージのコンテキストに関係なく、アドオン ツールバー メニューで常に実行できるアクション。
フィールド | |
---|---|
text |
必須。ユーザーが操作できるテキスト(「新しい連絡先を追加」など)。 |
共用体フィールド action_type 。操作の種類によって、ユーザーが操作を呼び出すときの Gmail の動作が決まります。action_type は次のいずれかになります。 |
|
openLink |
ユーザーが操作を行ったときに Gmail で開かれるリンク。 |
runFunction |
ユーザーが操作を行ったときに呼び出されるエンドポイント。詳しくは、ユニバーサル アクション ガイドをご覧ください。 |