string

Identifier. Resource name of the subscription.

Format:subscriptions/{subscription}

string

Output only. System-assigned unique identifier for the subscription.

string

Required. Immutable. The Google Workspace resource that's monitored for events, formatted as thefull resource name. To learn about target resources and the events that they support, seeSupported Google Workspace events.

A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns anALREADY_EXISTS error.

string

Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification.

The supported event types depend on the target resource of your subscription. For details, seeSupported Google Workspace events.

By default, you also receive events about thelifecycle of your subscription. You don't need to specify lifecycle events for this field.

If you specify an event type that doesn't exist for the target resource, the request returns an HTTP400 Bad Request status code.

object (PayloadOptions)

Optional. Options about what data to include in the event payload. Only supported for Google Chat and Google Drive events.

object (NotificationEndpoint)

Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.

enum (State)

Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint.

enum (ErrorType)

Output only. The error that suspended the subscription.

To reactivate the subscription, resolve the error and call thesubscriptions.reactivate method.

string

Output only. The user who authorized the creation of the subscription.

When a user authorizes the subscription, this field and theuserAuthority field have the same value and the format is:

Format:users/{user}

For Google Workspace users, the{user} value is theuser.id field from the Directory API.

When a Chat app authorizes the subscription, onlyserviceAccountAuthority field populates and this field is empty.

string (Timestamp format)

Output only. The time when the subscription is created.

string (Timestamp format)

Output only. The last time that the subscription is updated.

boolean

Output only. Iftrue, the subscription is in the process of being updated.

string

Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.

object (DriveOptions)

Optional. Features that are supported only for subscriptions on Drive resources.

string

Output only. The user who authorized the creation of the subscription. The user must be able to view thetargetResource.

For Google Workspace users, the{user} value is theuser.id field from the Directory API.

Format:users/{user}Developer Preview: Available as part of theGoogle Workspace Developer Preview Program, which grants early access to certain features.

string

Output only. The service account that was used to authorize the creation of the subscription. This service account must be owned by the same Google Cloud project where you create this subscription.

Format:projects/{projectId}/serviceAccounts/{service_account_id}Developer Preview: Available as part of theGoogle Workspace Developer Preview Program, which grants early access to certain features.

Union fieldexpiration. The time when the subscription expires.

The maximum expiration time depends on whether your subscription includes resource data in event payloads (specified in thePayloadOptions field):

• If payloads omit resource data, up to 7 days.
• If payloads include resource data, up to 4 hours. If your Google Workspace organization grants access to the resource throughdomain-wide delegation, you can extend the subscription's expiration time to up to 24 hours.

After a subscription expires, it's deleted automatically. You receive lifecycle events to thenotification_endpoint 12 hours and one hour before the subscription expires. For details, seeReceive and respond to lifecycle events.

To prevent a subscription from expiring, you can use theUpdateSubscription method to extend its expiration date. For details, seeUpdate or renew a subscription.expiration can be only one of the following:

string (Timestamp format)

Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.

string (Duration format)

Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to0, uses the maximum possible duration.

boolean

Optional. Immutable. For subscriptions to Google Drive events, whether to receive events about Drive files that are children of the target folder or shared drive.

• Iffalse, the subscription only receives events about changes to the folder or shared drive that's specified as thetargetResource.
• Iftrue, themimeType field of thefile resource must be set toapplication/vnd.google-apps.folder.

For details, seeGoogle Drive event types.

boolean

Optional. Whether the event payload includes data about the resource that changed. For example, for an event where a Google Chat message was created, whether the payload contains data about theMessage resource. If false, the event payload only includes the name of the changed resource.

string (FieldMask format)

Optional. IfincludeResource is set totrue, the list of fields to include in the event payload. Separate fields with a comma. For example, to include a Google Chat message's sender and create time, entermessage.sender,message.createTime. If omitted, the payload includes all fields for the resource.

If you specify a field that doesn't exist for the resource, the system ignores the field.

Union fieldendpoint.

endpoint can be only one of the following:

string

Immutable. The Pub/Sub topic that receives events for the subscription.

Format:projects/{project}/topics/{topic}

You must create the topic in the same Google Cloud project where you create this subscription.

Note: The Google Workspace Events API usesordering keys for the benefit of sequential events. If the Cloud Pub/Sub topic has amessage storage policy configured to exclude the nearest Google Cloud region, publishing events with ordering keys will fail.

When the topic receives events, the events are encoded as Pub/Sub messages. For details, see theGoogle Cloud Pub/Sub Protocol Binding for CloudEvents.