REST Resource: alerts

리소스: 알림

고객에게 영향을 미치는 알림입니다.

JSON 표현 
{
  "customerId": string,
  "alertId": string,
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "type": string,
  "source": string,
  "data": {
    "@type": string,
    field1: ...,
    ...
  },
  "securityInvestigationToolLink": string,
  "deleted": boolean,
  "metadata": {
    object (AlertMetadata)
  },
  "updateTime": string,
  "etag": string
}
필드
customerId

string

출력 전용입니다. 고객 Google Workspace 계정의 고유 식별자입니다.
alertId

string

출력 전용입니다. 알림의 고유 식별자입니다.
createTime

string (Timestamp format)

출력 전용입니다. 이 알림이 생성된 시간입니다.
startTime

string (Timestamp format)

필수 항목입니다. 이 알림을 발생시킨 이벤트가 시작되거나 감지된 시간입니다.
endTime

string (Timestamp format)

선택사항입니다. 이 알림을 발생시킨 이벤트가 비활성화된 시간입니다. 제공되는 경우 종료 시간은 시작 시간 이후여야 합니다. 제공되지 않으면 진행 중인 경보를 나타냅니다.
type

string

필수 항목입니다. 알림 유형입니다. 알림이 생성된 후에만 출력됩니다. 사용 가능한 알림 유형 목록은 Google Workspace 알림 유형을 참고하세요.
source

string

필수 항목입니다. 알림을 보고한 시스템의 고유 식별자입니다. 알림이 생성된 후에만 출력됩니다.

지원되는 소스는 다음 중 하나입니다.

  • Google 운영팀
  • 휴대기기 관리
  • Gmail 피싱
  • 데이터 손실 방지
  • 도메인 전체 테이크아웃
  • 국가가 후원하는 공격
  • Google ID
  • 앱 중단
data

object

선택사항입니다. 이 알림과 관련된 데이터입니다(예: google.apps.alertcenter.type.DeviceCompromised).
deleted

boolean

출력 전용입니다. 이 알림이 삭제로 표시된 경우 True입니다.
metadata

object (AlertMetadata)

출력 전용입니다. 이 알림과 연결된 메타데이터입니다.
updateTime

string (Timestamp format)

출력 전용입니다. 이 알림이 최종 업데이트된 시간입니다.
etag

string

선택사항입니다. etag는 동시에 발생한 알림 업데이트가 서로를 덮어쓰지 않도록 방지하는 낙관적 동시 실행 제어에 사용됩니다. 시스템이 읽기-수정-쓰기 주기에서 etag를 활용하여 경합 상태를 방지하기 위해 알림 업데이트를 수행하는 것이 좋습니다. 알림이 포함된 응답으로 etag가 반환되며 시스템은 알림 업데이트 요청에 이 etag를 넣어 변경사항이 동일한 알림 버전에 적용되도록 해야 합니다.

알림 업데이트 호출에 etag가 제공되지 않으면 기존 알림을 맹목적으로 덮어씁니다.

AlertMetadata

알림 메타데이터입니다.

JSON 표현 
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
필드
customerId

string

출력 전용입니다. 고객 Google Workspace 계정의 고유 식별자입니다.
alertId

string

출력 전용입니다. 알림 식별자입니다.
status

string

알림의 현재 상태입니다. 지원되는 값은 다음과 같습니다.

  • NOT_STARTED
  • IN_PROGRESS
  • 폐쇄됨
assignee

string

알림에 할당된 사용자의 이메일 주소입니다.
updateTime

string (Timestamp format)

출력 전용입니다. 이 메타데이터가 마지막으로 업데이트된 시간입니다.
severity

string

알림의 심각도 값입니다. 알림 센터에서는 알림 생성 시 이 필드를 설정하며, 확인할 수 없는 경우 기본값은 빈 문자열로 설정됩니다. 이 필드에서 지원되는 업데이트 작업 값은 다음과 같습니다.

  • 높음
  • 보통
  • 낮음
etag

string

선택사항입니다. etag는 알림 메타데이터의 동시 업데이트가 서로를 덮어쓰지 않도록 방지하는 낙관적 동시 실행 제어에 사용됩니다. 시스템은 경합 상태를 방지하기 위해 읽기-수정-쓰기 주기에서 etag를 활용하여 메타데이터 업데이트를 수행하는 것이 좋습니다. etag가 알림 메타데이터가 포함된 응답에 반환되며 시스템은 알림 메타데이터의 동일한 버전에 변경사항이 적용되도록 알림 메타데이터 업데이트 요청에 이 etag를 넣어야 합니다.

알림 메타데이터를 업데이트하는 호출에 etag를 제공하지 않으면 기존 알림 메타데이터를 무조건 덮어씁니다.

메서드

batchDelete

 알림에 대해 일괄 삭제 작업을 수행합니다.

batchUndelete

 알림에 대해 일괄 삭제 취소 작업을 수행합니다.

delete

 지정된 알림을 삭제로 표시합니다.

get

 지정된 알림을 가져옵니다.

getMetadata

 알림의 메타데이터를 반환합니다.

list

 알림을 나열합니다.

undelete

 지난 30일 이내에 삭제하도록 표시된 알림을 복원 또는 '삭제 취소'합니다.