如何为Gmail Watch推送通知API配置过滤器及发送额外数据

Great question! Let’s tackle your two issues one by one:

1. Filtering Notifications for Specific Senders/Subjects #

The Gmail watch API doesn’t support direct filtering by sender or subject in its request, but pairing it with Gmail’s filter and label system lets you achieve exactly this. Here’s how to set it up:

• Step 1: Create a dedicated label and filter
  First, you need a filter that applies a unique label to emails matching your criteria (specific sender, subject, etc.). You can do this either manually or via the API:

  • Manual setup: Head to Gmail’s Settings > Filters and Blocked Addresses > Create new filter. Define your rules (e.g., from: specific-sender@example.com or subject: "Urgent Alert"), then select "Apply the label" and create a new label (like TargetNotifications).
  • API setup: First create the label programmatically, then the filter:

    // Create a new label
    axios.post(`https://www.googleapis.com/gmail/v1/users/me/labels`, {
      name: "TargetNotifications",
      labelListVisibility: "labelShow",
      messageListVisibility: "show"
    }, util.authHeader(token))
    

    Then create a filter that applies this label to matching emails:

    // Create filter for specific sender/subject
    axios.post(`https://www.googleapis.com/gmail/v1/users/me/settings/filters`, {
      criteria: {
        from: "specific-sender@example.com",
        subject: "Urgent Alert" // Optional, add if filtering by subject
      },
      action: {
        addLabelIds: ["INSERT_YOUR_LABEL_ID_HERE"] // Grab this ID from the label creation response
      }
    }, util.authHeader(token))
    

• Step 2: Update your watch request to monitor only this label
  Modify your existing watch call to include the labelIds parameter. This tells Gmail to only send notifications when emails with your target label are added:

  axios.post(`https://www.googleapis.com/gmail/v1/users/me/watch`, {
    "topicName": "projects/gpubsub/topics/subcription",
    "labelIds": ["YOUR_LABEL_ID"] // Use the ID of the label you created
  }, util.authHeader(token))
  

  Now only emails that meet your filter criteria (and get the label) will trigger a push notification—just like the Microsoft Flow setup you mentioned!

2. Sending Extra Data in the Watch Request #

Unfortunately, the Gmail watch API’s request body doesn’t support custom fields—Google only accepts the officially documented parameters (topicName, labelIds, labelFilterAction, id). But there are practical workarounds to associate extra data with your notifications:

• Option 1: Attach metadata to your Pub/Sub subscription
  If you control the Pub/Sub subscription linked to your topic, you can add custom attributes to the subscription itself. When your server receives the push notification, you can pull these attributes from the Pub/Sub metadata to access your extra data.

• Option 2: Store extra data in your backend database
  Save your extra data alongside a unique identifier (like the user’s Gmail ID or the label ID you’re monitoring) in your own database. When you get a push notification, use the historyId or user ID from the notification payload to look up the associated data in your DB.

• Option 3: Use context-rich Pub/Sub topic names
  If your use case allows, create a dedicated Pub/Sub topic for each set of extra data (e.g., projects/gpubsub/topics/alerts-user-123). Your server can parse the topic name to extract context (like the user ID) when receiving notifications.

内容的提问来源于stack exchange，提问作者Sam