Google Workspace Alert Center API . v1beta1

Instance Methods

close()

Close httplib2 connections.

getSettings(customerId=None, x__xgafv=None)

Returns customer-level settings.

updateSettings(body=None, customerId=None, x__xgafv=None)

Updates the customer-level settings.

Method Details

close()
Close httplib2 connections.
getSettings(customerId=None, x__xgafv=None)
Returns customer-level settings.

Args:
  customerId: string, Optional. The unique identifier of the Google Workspace account of the customer the alert settings are associated with. The `customer_id` must/ have the initial "C" stripped (for example, `046psxkn`). Inferred from the caller identity if not provided. [Find your customer ID](https://support.google.com/cloudidentity/answer/10070793).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Customer-level settings.
  "notifications": [ # The list of notifications.
    { # Settings for callback notifications. For more details see [Google Workspace Alert Notification](https://developers.google.com/admin-sdk/alertcenter/guides/notifications).
      "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. # A Google Cloud Pub/sub topic destination.
        "payloadFormat": "A String", # Optional. The format of the payload that would be sent. If not specified the format will be JSON.
        "topicName": "A String", # The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
      },
    },
  ],
}
updateSettings(body=None, customerId=None, x__xgafv=None)
Updates the customer-level settings.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Customer-level settings.
  "notifications": [ # The list of notifications.
    { # Settings for callback notifications. For more details see [Google Workspace Alert Notification](https://developers.google.com/admin-sdk/alertcenter/guides/notifications).
      "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. # A Google Cloud Pub/sub topic destination.
        "payloadFormat": "A String", # Optional. The format of the payload that would be sent. If not specified the format will be JSON.
        "topicName": "A String", # The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
      },
    },
  ],
}

  customerId: string, Optional. The unique identifier of the Google Workspace account of the customer the alert settings are associated with. The `customer_id` must have the initial "C" stripped (for example, `046psxkn`). Inferred from the caller identity if not provided. [Find your customer ID](https://support.google.com/cloudidentity/answer/10070793).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Customer-level settings.
  "notifications": [ # The list of notifications.
    { # Settings for callback notifications. For more details see [Google Workspace Alert Notification](https://developers.google.com/admin-sdk/alertcenter/guides/notifications).
      "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. # A Google Cloud Pub/sub topic destination.
        "payloadFormat": "A String", # Optional. The format of the payload that would be sent. If not specified the format will be JSON.
        "topicName": "A String", # The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
      },
    },
  ],
}