Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-137956179.1 KB
users

Set up or update a push notification watch on the given user mailbox. For more information, see Configure push notifications in Gmail API.

post/gmail/v1/users/{userId}/watch

Path parameters

userIdstring required

The user's email address. The special value me can be used to indicate the authenticated user.

Request body

labelIdsstring[]

List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.

topicNamestring

A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name must already exist in Cloud Pub/Sub and you must have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic naming format). Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request).

labelFilterAction'include' | 'exclude'

Filtering behavior of labelIds list specified. This field is deprecated because it caused incorrect behavior in some cases; use label_filter_behavior instead.

labelFilterBehavior'include' | 'exclude'

Filtering behavior of labelIds list specified. This field replaces label_filter_action; if set, label_filter_action is ignored.

Response

Successful response