REST Resource: organizations.locations.notifications

Stay organized with collections Save and categorize content based on your preferences.

Resource: Notification

A notification object for notifying customers about security and privacy issues.

JSON representation
{
  "name": string,
  "subject": {
    object (Subject)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "createTime": string
}
Fields
name

string

The resource name of the notification. Format: organizations/{organization}/locations/{location}/notifications/{notification}.

subject

object (Subject)

The subject line of the notification.

messages[]

object (Message)

A list of messages in the notification.

createTime

string (Timestamp format)

Output only. Time the notification was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Subject

A subject line of a notification.

JSON representation
{
  "text": {
    object (Text)
  }
}
Fields
text

object (Text)

The text content.

Text

A text object containing the English text and its localized copies.

JSON representation
{
  "enText": string,
  "localizedText": string,
  "localizationState": enum (LocalizationState)
}
Fields
enText

string

The English copy.

localizedText

string

The requested localized copy (if applicable).

localizationState

enum (LocalizationState)

Status of the localization.

LocalizationState

Status of localized text.

Enums
LOCALIZATION_STATE_UNSPECIFIED Not used.
LOCALIZATION_STATE_NOT_APPLICABLE Localization is not applicable for requested language. This can happen when:
- The requested language was not supported by Advisory Notifications at the time of localization (including notifications created before the localization feature was launched).
- The requested language is English, so only the English text is returned.
LOCALIZATION_STATE_PENDING Localization for requested language is in progress, and not ready yet.
LOCALIZATION_STATE_COMPLETED Localization for requested language is completed.

Message

A message which contains notification details.

JSON representation
{
  "body": {
    object (Body)
  },
  "attachments": [
    {
      object (Attachment)
    }
  ],
  "createTime": string,
  "localizationTime": string
}
Fields
body

object (Body)

The message content.

attachments[]

object (Attachment)

The attachments to download.

createTime

string (Timestamp format)

The Message creation timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

localizationTime

string (Timestamp format)

Time when Message was localized

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Body

A message body containing text.

JSON representation
{
  "text": {
    object (Text)
  }
}
Fields
text

object (Text)

The text content of the message body.

Attachment

Attachment with specific information about the issue.

JSON representation
{
  "displayName": string,

  // Union field data can be only one of the following:
  "csv": {
    object (Csv)
  }
  // End of list of possible types for union field data.
}
Fields
displayName

string

The title of the attachment.

Union field data. Data type of the attachment. data can be only one of the following:
csv

object (Csv)

A CSV file attachment. Max size is 10 MB.

Csv

A representation of a CSV file attachment, as a list of column headers and a list of data rows.

JSON representation
{
  "headers": [
    string
  ],
  "dataRows": [
    {
      object (CsvRow)
    }
  ]
}
Fields
headers[]

string

The list of headers for data columns in a CSV file.

dataRows[]

object (CsvRow)

The list of data rows in a CSV file, as string arrays rather than as a single comma-separated string.

CsvRow

A representation of a single data row in a CSV file.

JSON representation
{
  "entries": [
    string
  ]
}
Fields
entries[]

string

The data entries in a CSV file row, as a string array rather than a single comma-separated string.

Methods

get

Gets a notification.

list

Lists notifications under a given parent.