Method: activities.watch

계정 활동기록에 대한 알림 수신을 시작합니다. 자세한 내용은 푸시 알림 받기를 참조하세요.

HTTP 요청

POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
userKey or all

string

데이터를 필터링해야 하는 프로필 ID 또는 사용자 이메일을 나타냅니다. 모든 정보에 대해 all, 사용자의 고유한 Google Workspace 프로필 ID 또는 기본 이메일 주소의 경우 userKey일 수 있습니다. 삭제된 사용자가 아니어야 합니다. 삭제된 사용자의 경우 Directory API에서 showDeleted=true를 사용하여 users.list를 호출한 다음 반환된 ID를 userKey로 사용합니다.
applicationName

enum (ApplicationName)

이벤트를 가져올 애플리케이션 이름입니다.

쿼리 매개변수

매개변수
actorIpAddress

string

이벤트가 발생한 호스트의 인터넷 프로토콜 (IP) 주소입니다. 이는 보고된 활동이 있는 사용자의 IP 주소를 사용하여 보고서 요약을 필터링할 수 있는 또 다른 방법입니다. 이 IP 주소는 사용자의 실제 위치를 반영할 수도 있고, 그렇지 않을 수도 있습니다. 예를 들어 IP 주소는 사용자의 프록시 서버 주소 또는 가상 사설망 (VPN) 주소일 수 있습니다. 이 매개변수는 IPv4 및 IPv6 주소 버전을 모두 지원합니다.
customerId

string

데이터를 검색할 고객의 고유 ID입니다.
endTime

string

보고서에 표시되는 기간의 끝을 설정합니다. 날짜는 RFC 3339 형식입니다(예: 2010-10-28T10:26:35.000Z). 기본값은 API 요청의 대략적인 시간입니다. API 보고서에는 다음과 같은 세 가지 기본 시간 개념이 있습니다.

  • API의 보고서 요청 날짜: API가 보고서를 생성하고 검색한 날짜입니다.
  • 보고서의 시작 시간: 보고서에 표시되는 기간의 시작 시간입니다. startTime는 endTime (지정된 경우) 및 요청이 이루어진 현재 시간 이전이어야 합니다. 그렇지 않으면 API에서 오류를 반환합니다.
  • 보고서의 종료 시간: 보고서에 표시되는 기간의 종료 시간입니다. 예를 들어 보고서에 요약된 이벤트의 기간은 4월에 시작하고 5월에 끝날 수 있습니다. 보고서 자체는 8월에 요청할 수 있습니다.
endTime가 지정되지 않은 경우 보고서는 startTime부터 현재 시간까지의 모든 활동 또는 startTime이 지난 180일보다 오래된 경우 가장 최근 180일 동안의 활동을 반환합니다.
eventName

string

API에서 쿼리하는 이벤트의 이름입니다. 각 eventName은 API가 이벤트 유형으로 구성하는 특정 Google Workspace 서비스 또는 기능과 관련이 있습니다. 관리 콘솔 애플리케이션 보고서에 표시되는 Google Calendar 일정을 예로 들 수 있습니다. Calendar 설정 type 구조에는 API에서 보고하는 Calendar eventName 활동이 모두 있습니다. 관리자가 Calendar 설정을 변경하면 API는 이 활동을 캘린더 설정 type 및 eventName 매개변수에 보고합니다. eventName 쿼리 문자열 및 매개변수에 대한 자세한 내용은 위의 applicationName에서 다양한 애플리케이션에 대한 이벤트 이름 목록을 참조하세요.
filters

string

filters 쿼리 문자열은 관계 연산자로 조작되는 이벤트 매개변수로 구성된 쉼표로 구분된 목록입니다. 이벤트 매개변수의 형식은 {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...입니다.

이러한 이벤트 매개변수는 특정 eventName와 연결됩니다. 요청의 매개변수가 eventName에 속하지 않는 경우 빈 보고서가 반환됩니다. 각 애플리케이션에 사용 가능한 eventName 필드 및 관련 매개변수에 대한 자세한 내용을 보려면 ApplicationName 표로 이동한 다음 원하는 애플리케이션의 부록에 있는 활동 이벤트 페이지를 클릭하세요.

다음 Drive 활동 예시에서 반환된 목록은 doc_id 매개변수 값이 관계 연산자로 정의된 조건과 일치하는 모든 edit 이벤트로 구성됩니다. 첫 번째 예시에서 요청은 doc_id 값이 12345인 모든 수정된 문서를 반환합니다. 두 번째 예에서 보고서는 doc_id 값이 98765와 같지 않은 모든 수정된 문서를 반환합니다. <> 연산자는 요청의 쿼리 문자열 (%3C%3E)에 URL로 인코딩됩니다.

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

filters 쿼리는 다음과 같은 관계 연산자를 지원합니다.

  • ==—'같음'.
  • <>—'같지 않음'. URL 인코딩되어야 합니다 (%3C%3E).
  • <—'보다 작음'. URL 인코딩되어야 합니다 (%3C).
  • <=—'작거나 같음'. URL 인코딩되어야 합니다 (%3C=).
  • >—'초과'. URL 인코딩되어야 합니다 (%3E).
  • >=—'크거나 같음'. URL 인코딩되어야 합니다 (%3E=).

참고: API는 동일한 매개변수의 여러 값을 허용하지 않습니다. API 요청에서 매개변수가 두 번 이상 제공되면 API는 해당 매개변수의 마지막 값만 허용합니다. 또한 API 요청에 잘못된 매개변수가 제공되면 API는 해당 매개변수를 무시하고 나머지 유효한 매개변수에 해당하는 응답을 반환합니다. 매개변수가 요청되지 않으면 모든 매개변수가 반환됩니다.
maxResults

integer

각 응답 페이지에 표시되는 활동 기록 수를 결정합니다. 예를 들어 요청에서 maxResults=1를 설정하고 보고서에 활동이 2개 있으면 보고서에는 두 페이지가 표시됩니다. 응답의 nextPageToken 속성에는 두 번째 페이지 토큰이 있습니다. maxResults 쿼리 문자열은 요청에서 선택사항입니다. 기본값은 1,000입니다.
orgUnitID
(deprecated)

string

Deprecated 이 필드는 지원 중단되었으며 더 이상 지원되지 않습니다.

보고할 조직 단위의 ID입니다. 활동 기록은 지정된 조직 단위에 속한 사용자에 대해서만 표시됩니다.

pageToken

string

다음 페이지를 지정하는 토큰입니다. 여러 페이지가 있는 보고서의 응답에는 nextPageToken 속성이 있습니다. 보고서의 다음 페이지를 가져오기 위한 후속 요청에서 pageToken 검색어 문자열에 nextPageToken 값을 입력합니다.
startTime

string

보고서에 표시되는 기간의 시작을 설정합니다. 날짜는 RFC 3339 형식입니다(예: 2010-10-28T10:26:35.000Z). 보고서는 startTime부터 endTime까지 모든 활동을 반환합니다. startTime는 endTime (지정된 경우) 및 요청이 이루어진 현재 시간 이전이어야 합니다. 그렇지 않으면 API에서 오류를 반환합니다.
groupIdFilter

string

사용자 활동이 필터링되는 쉼표로 구분된 그룹 ID (난독화됨)입니다. 즉, 응답에는 여기에 언급된 그룹 ID 중 하나 이상에 속한 사용자의 활동만 포함됩니다. 형식: 'id:abc123,id:xyz456'

요청 본문

요청 본문에 SubscriptionChannel의 인스턴스가 포함됩니다.

응답 본문

리소스 변경사항을 감시하는 데 사용되는 알림 채널

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "id": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    string: string,
    ...
  },
  "resourceId": string,
  "resourceUri": string,
  "kind": string
}
필드
id

string

이 채널을 식별하는 UUID 또는 이와 유사한 고유한 문자열입니다.
token

string

이 채널을 통해 전송되는 각 알림과 함께 대상 주소로 전송되는 임의 문자열입니다. 선택사항입니다.
expiration

string (int64 format)

알림 채널 만료 날짜 및 시간으로, Unix 타임스탬프로 표현되는 밀리초 단위입니다. 선택사항입니다.
type

string

이 채널에 사용된 전송 메커니즘의 유형입니다. 값은 "web_hook"로 설정해야 합니다.
address

string

이 채널에 대한 알림이 전송되는 주소입니다.
payload

boolean

페이로드가 필요한지 여부를 나타내는 부울 값. 페이로드는 HTTP POST, PUT 또는 PATCH 메시지의 본문으로 전송되는 데이터이며 요청에 관한 중요한 정보를 포함합니다. 선택사항입니다.
params

map (key: string, value: string)

게재 채널 동작을 제어하는 추가 매개변수입니다. 선택사항입니다.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }
resourceId

string

이 채널에서 감시 중인 리소스를 식별하는 불투명 ID입니다. 여러 API 버전에서 안정화되었습니다.
resourceUri

string

감시된 리소스의 버전별 식별자입니다.
kind

string

리소스('api#channel')의 변경사항을 감시하는 데 사용되는 알림 채널로 식별합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/admin.reports.audit.readonly

자세한 내용은 승인 가이드를 참조하세요.

ApplicationName

이벤트를 가져올 애플리케이션 이름입니다.

열거형
access_transparency

Google Workspace 액세스 투명성 활동 보고서는 다양한 유형의 액세스 투명성 활동 이벤트에 대한 정보를 반환합니다.
admin

관리 콘솔 애플리케이션의 활동 보고서에는 다양한 유형의 관리자 활동 이벤트에 대한 계정 정보가 반환됩니다.
calendar

Google 캘린더 애플리케이션의 활동 보고서는 다양한 캘린더 활동 이벤트에 대한 정보를 반환합니다.
chat Chat 활동 보고서는 다양한 Chat 활동 이벤트에 대한 정보를 반환합니다.
drive

Google Drive 애플리케이션의 활동 보고서는 다양한 Google Drive 활동 이벤트에 대한 정보를 반환합니다. Drive 활동 보고서는 Google Workspace Business 및 Google Workspace Enterprise 고객에게만 제공됩니다.
gcp Google Cloud Platform 애플리케이션의 활동 보고서는 다양한 GCP 활동 이벤트에 대한 정보를 반환합니다.
gplus Google+ 애플리케이션의 활동 보고서는 다양한 Google+ 활동 이벤트에 대한 정보를 반환합니다.
groups

Google 그룹스 애플리케이션의 활동 보고서는 다양한 그룹스 활동 이벤트에 대한 정보를 반환합니다.
groups_enterprise

엔터프라이즈 그룹스 활동 보고서는 다양한 엔터프라이즈 그룹 활동 이벤트에 대한 정보를 반환합니다.
jamboard Jamboard 활동 보고서는 다양한 Jamboard 활동 이벤트에 관한 정보를 반환합니다.
login

로그인 애플리케이션의 활동 보고서는 다양한 유형의 로그인 활동 이벤트에 대한 계정 정보를 반환합니다.
meet Meet 감사 활동 보고서는 다양한 유형의 Meet 감사 활동 이벤트에 관한 정보를 반환합니다.
mobile 기기 감사 활동 보고서는 다양한 유형의 기기 감사 활동 이벤트에 대한 정보를 반환합니다.
rules

규칙 활동 보고서는 다양한 유형의 규칙 활동 이벤트에 대한 정보를 반환합니다.
saml

SAML 활동 보고서는 다양한 유형의 SAML 활동 이벤트에 대한 정보를 반환합니다.
token

토큰 애플리케이션의 활동 보고서는 다양한 유형의 토큰 활동 이벤트에 대한 계정 정보를 반환합니다.
user_accounts

사용자 계정 애플리케이션의 활동 보고서에는 다양한 유형의 사용자 계정 활동 이벤트에 대한 계정 정보가 반환됩니다.
context_aware_access

컨텍스트 인식 액세스 활동 보고서는 컨텍스트 인식 액세스 규칙으로 인해 액세스가 거부되었습니다.
chrome

Chrome 활동 보고서는 Chrome 브라우저 및 Chrome OS 이벤트에 대한 정보를 반환합니다.
data_studio 데이터 스튜디오 활동 보고서는 다양한 유형의 데이터 스튜디오 활동 이벤트에 대한 정보를 반환합니다.
keep Keep 애플리케이션의 활동 보고서는 다양한 Google Keep 활동 이벤트에 대한 정보를 반환합니다. Keep 활동 보고서는 Google Workspace Business 및 Enterprise 고객만 사용할 수 있습니다.