拡張 Gmail サービス

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

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

リファレンス

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

注: パフォーマンスを向上させるため、Gmail API では多くの場合、list リクエストから返される情報の量をスレッド ID、メッセージ ID、ラベル ID などのシンプルな情報に制限しています。特定のスレッド、メッセージ、ラベルの詳細情報を取得するには、関連する ID を使用してフォローアップ get リクエストを送信します。

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

サンプルコード

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

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

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

advanced/gmail.gs

GitHub で表示

/**
 * 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

GitHub で表示

/**
 * 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) {
        threadList.threads.forEach(function(thread) {
          console.log('Snippet: %s', thread.snippet);
        });
      }
      pageToken = threadList.nextPageToken;
    } while (pageToken);
  } catch (err) {
    console.log(err);
  }
}

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

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

advanced/gmail.gs

GitHub で表示

/**
 * 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) {
        history.forEach(function(record) {
          record.messages.forEach(function(message) {
            if (changed.indexOf(message.id) === -1) {
              changed.push(message.id);
            }
          });
        });
      }
      pageToken = recordList.nextPageToken;
    } while (pageToken);

    changed.forEach(function(id) {
      console.log('Message Changed: %s', id);
    });
  } catch (err) {
    console.log(err);
  }
}