Settings
Stay organized with collections
Save and categorize content based on your preferences.
| JSON representation |
{
"notifications": [
{
object (Notification)
}
]
} |
| Fields |
notifications[] |
object (Notification)
The list of notifications.
|
Notification
| JSON representation |
{
// Union field destination can be only one of the following:
"cloudPubsubTopic": {
object (CloudPubsubTopic)
}
// End of list of possible types for union field destination.
} |
| Fields |
Union field destination. Exactly one destination to be specified. destination can be only one of the following: |
cloudPubsubTopic |
object (CloudPubsubTopic)
A Google Cloud Pub/sub topic destination.
|
CloudPubsubTopic
A reference to a Cloud Pubsub topic.
To register for notifications, the owner of the topic must grant alerts-api-push-notifications@system.gserviceaccount.com the projects.topics.publish permission.
| JSON representation |
{
"topicName": string,
"payloadFormat": enum (PayloadFormat)
} |
| Fields |
topicName |
string
The name field of a Cloud Pubsub Topic.
|
payloadFormat |
enum (PayloadFormat)
Optional. The format of the payload that would be sent. If not specified the format will be JSON.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# Settings\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [Notification](#Notification)\n - [JSON representation](#Notification.SCHEMA_REPRESENTATION)\n- [CloudPubsubTopic](#CloudPubsubTopic)\n - [JSON representation](#CloudPubsubTopic.SCHEMA_REPRESENTATION)\n- [PayloadFormat](#PayloadFormat)\n\nCustomer-level settings.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"notifications\": [ { object (/workspace/admin/alertcenter/reference/rest/v1beta1/Settings#Notification) } ] } ``` |\n\n| Fields ||\n|-------------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `notifications[]` | `object (`[Notification](/workspace/admin/alertcenter/reference/rest/v1beta1/Settings#Notification)`)` The list of notifications. |\n\nNotification\n------------\n\nSettings for callback notifications. For more details see [Google Workspace Alert Notification](https://developers.google.com/workspace/admin/alertcenter/guides/notifications).\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { // Union field `destination` can be only one of the following: \"cloudPubsubTopic\": { object (/workspace/admin/alertcenter/reference/rest/v1beta1/Settings#CloudPubsubTopic) } // End of list of possible types for union field `destination`. } ``` |\n\n| Fields ||\n|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Union field `destination`. Exactly one destination to be specified. `destination` can be only one of the following: ||\n| `cloudPubsubTopic` | `object (`[CloudPubsubTopic](/workspace/admin/alertcenter/reference/rest/v1beta1/Settings#CloudPubsubTopic)`)` A Google Cloud Pub/sub topic destination. |\n\nCloudPubsubTopic\n----------------\n\nA reference to a Cloud Pubsub topic.\n\nTo register for notifications, the owner of the topic must grant `alerts-api-push-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"topicName\": string, \"payloadFormat\": enum (/workspace/admin/alertcenter/reference/rest/v1beta1/Settings#PayloadFormat) } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `topicName` | `string` The `name` field of a Cloud Pubsub [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic). |\n| `payloadFormat` | `enum (`[PayloadFormat](/workspace/admin/alertcenter/reference/rest/v1beta1/Settings#PayloadFormat)`)` Optional. The format of the payload that would be sent. If not specified the format will be JSON. |\n\nPayloadFormat\n-------------\n\nThe format of the payload.\n\n| Enums ||\n|------------------------------|-------------------------------------------------------------|\n| `PAYLOAD_FORMAT_UNSPECIFIED` | Payload format is not specified (will use JSON as default). |\n| `JSON` | Use JSON. |"]]
