Google Workspace アドオンでは、リンクされたアクションを持つウィジェットを作成できます。アクションを使用して新しいメールの下書きを作成し、必要に応じてアドオンの UI に入力された情報や開いているメールの情報を使用して下書きを作成できます。たとえば、アドオンのメッセージ UI に、アドオンの情報が事前入力された現在開いているメッセージに返信するボタンを表示できます。
メール作成アクションがトリガーされると、Gmail はコールバック関数を実行して下書きをビルドして返します。Gmail の UI にある標準のメール作成ウィンドウの下書きが表示され、ユーザーは必要に応じて編集や送信を行えます。
下書きメールを作成するアクションを設定する
選択されたときにドラフト作成アクションを開始するようにウィジェットを構成するには、次のことを行う必要があります。
マニフェストに
action.compose
スコープが含まれていることを確認します。https://www.googleapis.com/auth/gmail.addons.current.action.compose
代わりに、より制限の緩いスコープを使用できますが、そのスコープが絶対に必要な場合にのみ使用してください。
ウィジェットの
setComposeAction()
ウィジェット ハンドラ関数を呼び出し、Action
オブジェクトを指定し、ComposeEmailType
を指定します。ドラフト作成アクションを実行するコールバック関数を実装します。この関数には、引数としてイベント オブジェクトを指定します。このコールバック関数は次のことを行う必要があります。
GmailDraft
オブジェクトを作成します。ComposeActionResponseBuilder
クラスとGmailDraft
オブジェクトを使用して、ComposeActionResponse
オブジェクトを作成します。- ビルドされた
ComposeActionResponse
を返します。
コールバック関数で作成した GmailDraft
には、受信者、件名、メール本文、添付ファイルを設定できます。ドラフトに入力するデータは任意のソースから取得できますが、通常は、アドオン自体に提供した情報、オープン メッセージ内の情報、サードパーティ サービスから収集された情報から導出されます。コールバック関数に渡されるイベント オブジェクトには、オープンなメッセージ ID と、下書きの事前入力に使用できるその他のアドオン情報が含まれています。
下書きは、新しいスタンドアロン メッセージ、または既存のメッセージへの返信として作成できます。これは、setComposeAction()
に指定される ComposeEmailType
列挙型によって制御されます。返信の下書きは、1 つの返信メールまたは「全員に返信」メッセージとして作成できます。
スタンドアロンの下書き
スタンドアロンの下書きは新しいスレッドを開始しますが、既存のメッセージへの返信にはなりません。次のいずれかの Gmail サービス機能を使用して、スタンドアロンの下書きを作成できます。
GmailApp.createDraft(recipient, subject, body)
GmailApp.createDraft(recipient, subject, body, options)
返信の下書き
返信の下書きは、既存のメッセージ スレッドの一部です。返信の下書きは、メッセージの送信者にのみ送信される単一の返信か、そのメッセージを受信した全員に返信する「全員に返信」の下書きです。返信の下書きは、次の Gmail サービスの関数のいずれかを使用して作成できます。
GmailMessage.createDraftReply(body)
GmailMessage.createDraftReply(body, options)
GmailMessage.createDraftReplyAll(body)
GmailMessage.createDraftReplyAll(body, options)
GmailThread.createDraftReply(body)
GmailThread.createDraftReply(body, options)
GmailThread.createDraftReplyAll(body)
GmailThread.createDraftReplyAll(body, options)
例
次のコード スニペットは、返信の下書きを作成するアクションをボタンに割り当てる方法を示しています。
var composeAction = CardService.newAction()
.setFunctionName('createReplyDraft');
var composeButton = CardService.newTextButton()
.setText('Compose Reply')
.setComposeAction(
composeAction,
CardService.ComposedEmailType.REPLY_AS_DRAFT);
// ...
/**
* Creates a draft email (with an attachment and inline image)
* as a reply to an existing message.
* @param {Object} e An event object passed by the action.
* @return {ComposeActionResponse}
*/
function createReplyDraft(e) {
// Activate temporary Gmail scopes, in this case to allow
// a reply to be drafted.
var accessToken = e.gmail.accessToken;
GmailApp.setCurrentMessageAccessToken(accessToken);
// Creates a draft reply.
var messageId = e.gmail.messageId;
var message = GmailApp.getMessageById(messageId);
var draft = message.createDraftReply('',
{
htmlBody: "Kitten! <img src='cid:kitten'/>",
attachments: [
UrlFetchApp.fetch('https://example.com/images/myDog.jpg')
.getBlob()
],
inlineImages: {
"kitten": UrlFetchApp.fetch('https://example.com/images/myKitten.jpg')
.getBlob()
}
}
);
// Return a built draft response. This causes Gmail to present a
// compose window to the user, pre-filled with the content specified
// above.
return CardService.newComposeActionResponseBuilder()
.setGmailDraft(draft).build();
}