拡張 Gmail サービス

高度な Gmail サービスを使用すると、Google Apps Script で Gmail API を使用できます。Apps Script の組み込み Gmail サービスと同様に、この API を使用すると、スクリプトで Gmail メールボックス内のスレッド、メッセージ、ラベルを検索して変更できます。ほとんどの場合、組み込みサービスの方が使いやすいですが、この高度なサービスでは、Gmail コンテンツに関する詳細情報にアクセスできるほか、いくつかの追加機能を利用できます。

これは、使用する前に 有効にする必要がある高度なサービスです。

リファレンス

このサービスの詳細については、 Gmail API のリファレンス ドキュメントをご覧ください。Apps Script のすべての高度なサービスと同様に、高度な Gmail サービスでは、公開 API と同じオブジェクト、メソッド、パラメータを使用します。詳細については、 「 メソッドのシグネチャの決定方法」をご覧ください。

問題を報告したり、その他のサポートを利用したりするには、 Gmail サポートガイドをご覧ください。

サンプルコード

次のサンプルコードでは、API のバージョン 1 を使用します。

ラベル情報を一覧表示する

次の例は、ユーザーのすべてのラベル情報を一覧表示する方法を示しています。 これには、ラベル名、タイプ、ID、表示設定が含まれます。

advanced/gmail.gs
/**
 * Lists the user's labels, including name, type,
 * ID and visibility information.
 */
function listLabelInfo() {
  try {
    const response = Gmail.Users.Labels.list("me");
    for (let i = 0; i < response.labels.length; i++) {
      const label = response.labels[i];
      console.log(JSON.stringify(label));
    }
  } catch (err) {
    console.log(err);
  }
}

受信トレイのスニペットを一覧表示する

次の例は、ユーザーの受信トレイ内の各スレッドに関連付けられたテキスト スニペットを一覧表示する方法を示しています。結果の完全なリストにアクセスするためにページトークンを使用していることに注意してください。

advanced/gmail.gs
/**
 * Lists, for each thread in the user's Inbox, a
 * snippet associated with that thread.
 */
function listInboxSnippets() {
  try {
    let pageToken;
    do {
      const threadList = Gmail.Users.Threads.list("me", {
        q: "label:inbox",
        pageToken: pageToken,
      });
      if (threadList.threads && threadList.threads.length > 0) {
        for (const thread of threadList.threads) {
          console.log(`Snippet: ${thread.snippet}`);
        }
      }
      pageToken = threadList.nextPageToken;
    } while (pageToken);
  } catch (err) {
    console.log(err);
  }
}

最近の履歴を一覧表示する

次の例は、最近のアクティビティ履歴をロギングする方法を示しています。 具体的には、この例では、ユーザーが最後に送信したメッセージに関連付けられた履歴レコード ID を復元し、その時点から変更されたすべてのメッセージのメッセージ ID をロギングします。変更されたメッセージは、履歴レコード内の変更イベントの数に関係なく、1 回だけロギングされます。結果の完全なリストにアクセスするためにページトークンを使用していることに注意してください。

advanced/gmail.gs
/**
 * Gets a history record ID associated with the most
 * recently sent message, then logs all the message IDs
 * that have changed since that message was sent.
 */
function logRecentHistory() {
  try {
    // Get the history ID associated with the most recent
    // sent message.
    const sent = Gmail.Users.Threads.list("me", {
      q: "label:sent",
      maxResults: 1,
    });
    if (!sent.threads || !sent.threads[0]) {
      console.log("No sent threads found.");
      return;
    }
    const historyId = sent.threads[0].historyId;

    // Log the ID of each message changed since the most
    // recent message was sent.
    let pageToken;
    const changed = [];
    do {
      const recordList = Gmail.Users.History.list("me", {
        startHistoryId: historyId,
        pageToken: pageToken,
      });
      const history = recordList.history;
      if (history && history.length > 0) {
        for (const record of history) {
          for (const message of record.messages) {
            if (changed.indexOf(message.id) === -1) {
              changed.push(message.id);
            }
          }
        }
      }
      pageToken = recordList.nextPageToken;
    } while (pageToken);

    for (const id of changed) {
      console.log("Message Changed: %s", id);
    }
  } catch (err) {
    console.log(err);
  }
}

メッセージの一覧表示

次の例は、Gmail ユーザーの未読メッセージを一覧表示する方法を示しています。

advanced/gmail.gs
/**
 * Lists unread messages in the user's inbox using the advanced Gmail service.
 */
function listMessages() {
  // The special value 'me' indicates the authenticated user.
  const userId = "me";

  // Define optional parameters for the request.
  const options = {
    maxResults: 10, // Limit the number of messages returned.
    q: "is:unread", // Search for unread messages.
  };

  try {
    // Call the Gmail.Users.Messages.list method.
    const response = Gmail.Users.Messages.list(userId, options);
    const messages = response.messages;
    console.log("Unread Messages:");

    for (const message of messages) {
      console.log(`- Message ID: ${message.id}`);
    }
  } catch (err) {
    // Log any errors to the Apps Script execution log.
    console.log(`Failed with error: ${err.message}`);
  }
}