REST Resource: accounts.alerts

  • An Alert represents a message with a specific severity and type, providing localized information that may include HTML.

  • Alerts have a defined severity level which can be unspecified, informational, a warning, or severe.

  • You can list all the alerts available in an account using the provided method.

Resource: Alert

Representation of an alert.

JSON representation
{
  "name": string,
  "severity": enum (Severity),
  "message": string,
  "type": string
}
Fields
name

string

Output only. Resource name of the alert. Format: accounts/{account}/alerts/{alert}

severity

enum (Severity)

Output only. Severity of this alert.

message

string

Output only. The localized alert message. This may contain HTML markup, such as phrase elements or links.

type

string

Output only. Type of alert.

This identifies the broad type of this alert, and provides a stable machine-readable identifier that will not be translated.

For example, "payment-hold".

Severity

Severity of an alert.

Enums
SEVERITY_UNSPECIFIED Unspecified severity.
INFO Info.
WARNING Warning.
SEVERE Severe.

Methods

list

Lists all the alerts available in an account.