Resource: Subscription
A subscription to receive events about a Google Workspace resource. To learn more about subscriptions, see the Google Workspace Events API overview.
JSON representation |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
Fields | |
---|---|
name |
Identifier. Resource name of the subscription. Format: |
uid |
Output only. System-assigned unique identifier for the subscription. |
targetResource |
Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the full resource name. To learn about target resources and the events that they support, see Supported 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 an |
eventTypes[] |
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, see Supported Google Workspace events. By default, you also receive events about the lifecycle 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 HTTP |
payloadOptions |
Optional. Options about what data to include in the event payload. Only supported for Google Chat events. |
notificationEndpoint |
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic. |
state |
Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint. |
suspensionReason |
Output only. The error that suspended the subscription. To reactivate the subscription, resolve the error and call the |
authority |
Output only. The user who authorized the creation of the subscription. Format: For Google Workspace users, the |
createTime |
Output only. The time when the subscription is created. |
updateTime |
Output only. The last time that the subscription is updated. |
reconciling |
Output only. If |
etag |
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. |
Union field The maximum expiration time depends on whether your subscription includes resource data in event payloads (specified in the
After a subscription expires, it's deleted automatically. You receive lifecycle events to the To prevent a subscription from expiring, you can use the |
|
expireTime |
Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input. |
ttl |
Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to |
PayloadOptions
Options about what data to include in the event payload. Only supported for Google Chat events.
JSON representation |
---|
{ "includeResource": boolean, "fieldMask": string } |
Fields | |
---|---|
includeResource |
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 the |
fieldMask |
Optional. If If you specify a field that doesn't exist for the resource, the system ignores the field. |
NotificationEndpoint
The endpoint where the subscription delivers events.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
pubsubTopic |
Immutable. The Cloud Pub/Sub topic that receives events for the subscription. Format: You must create the topic in the same Google Cloud project where you create this subscription. When the topic receives events, the events are encoded as Cloud Pub/Sub messages. For details, see the Google Cloud Pub/Sub Protocol Binding for CloudEvents. |
State
Possible states for the subscription.
Enums | |
---|---|
STATE_UNSPECIFIED |
Default value. This value is unused. |
ACTIVE |
The subscription is active and can receive and deliver events to its notification endpoint. |
SUSPENDED |
The subscription is unable to receive events due to an error. To identify the error, see the field. |
DELETED |
The subscription is deleted. |
ErrorType
Possible errors for a subscription.
Enums | |
---|---|
ERROR_TYPE_UNSPECIFIED |
Default value. This value is unused. |
USER_SCOPE_REVOKED |
The authorizing user has revoked the grant of one or more OAuth scopes. To learn more about authorization for Google Workspace, see Configure the OAuth consent screen. |
RESOURCE_DELETED |
The target resource for the subscription no longer exists. |
USER_AUTHORIZATION_FAILURE |
The user that authorized the creation of the subscription no longer has access to the subscription's target resource. |
ENDPOINT_PERMISSION_DENIED |
The Google Workspace application doesn't have access to deliver events to your subscription's notification endpoint. |
ENDPOINT_NOT_FOUND |
The subscription's notification endpoint doesn't exist, or the endpoint can't be found in the Google Cloud project where you created the subscription. |
ENDPOINT_RESOURCE_EXHAUSTED |
The subscription's notification endpoint failed to receive events due to insufficient quota or reaching rate limiting. |
OTHER |
An unidentified error has occurred. |
Methods |
|
---|---|
|
Creates a Google Workspace subscription. |
|
Deletes a Google Workspace subscription. |
|
Gets details about a Google Workspace subscription. |
|
Lists Google Workspace subscriptions. |
|
Updates or renews a Google Workspace subscription. |
|
Reactivates a suspended Google Workspace subscription. |