REST Resource: forms.watches

리소스: 보기

양식의 이벤트를 감시합니다. 지정된 이벤트가 발생하면 지정된 대상에 알림이 게시됩니다. 알림의 속성에는 감시 양식의 ID가 있는 formId 키와 해당 유형의 문자열이 있는 eventType 키가 포함됩니다.

메일은 최소 1회 전송되도록 전송되고 특별한 상황에서만 삭제됩니다. 일반적으로 모든 알림은 몇 초 내에 안정적으로 전달되어야 합니다. 하지만 경우에 따라 알림이 지연될 수 있습니다.

watches.renew로 갱신하지 않으면 시계 생성 후 7일이 지나면 만료됩니다.

JSON 표현 
{
  "id": string,
  "target": {
    object (WatchTarget)
  },
  "eventType": enum (EventType),
  "createTime": string,
  "expireTime": string,
  "errorType": enum (ErrorType),
  "state": enum (State)
}
필드
id

string

출력 전용입니다. 이 시계의 ID입니다. CreateWatchRequest.watch_id에서 메모를 확인하세요.
target

object (WatchTarget)

필수 항목입니다. 알림을 보낼 위치입니다.
eventType

enum (EventType)

필수 항목입니다. 감시할 이벤트 유형.
createTime

string (Timestamp format)

출력 전용입니다. 생성된 시점의 타임스탬프입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
expireTime

string (Timestamp format)

출력 전용입니다. 만료될 시간의 타임스탬프입니다. 각 watches.renew 호출은 이후 7일로 재설정됩니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
errorType

enum (ErrorType)

출력 전용입니다. 전송 시도의 최근 오류 유형입니다. 양식을 다시 시청하려면 watches.renew를 호출하여 이 오류 정보도 삭제할 수 있습니다.
state

enum (State)

출력 전용입니다. 시계의 현재 상태입니다. 정지된 시계에 관한 추가 세부정보는 errorType에서 확인할 수 있습니다.

WatchTarget

알림 전달 대상입니다.

JSON 표현 
{

  // Union field target can be only one of the following:
  "topic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field target.
}
필드
통합 필드 target. 필수 항목입니다. 알림 전달 대상입니다. target은 다음 중 하나여야 합니다.
topic

object (CloudPubsubTopic)

Pub/Sub 주제 알림을 받으려면 주제에서 Forms 서비스 계정(serviceAccount:forms-notifications@system.gserviceaccount.com)에 게시 권한을 부여해야 합니다. 주제를 소유한 프로젝트만 이 주제로 시계를 만들 수 있습니다.

Pub/Sub 전송 보장을 고려해야 합니다.

CloudPubsubTopic

Pub/Sub 주제

JSON 표현 
{
  "topicName": string
}
필드
topicName

string

필수 항목입니다. 이벤트를 게시할 정규화된 Pub/Sub 주제 이름입니다. 이 주제는 호출하는 프로젝트에서 소유해야 하며 Pub/Sub에 이미 있어야 합니다.

EventType

시청할 수 있는 가능한 이벤트 유형입니다.

열거형
EVENT_TYPE_UNSPECIFIED 지정되지 않은 이벤트 유형입니다. 이 값을 사용해서는 안 됩니다.
SCHEMA 스키마 이벤트 유형입니다. 이 이벤트 유형의 시계는 양식 콘텐츠 및 설정 변경에 관한 알림을 받습니다.
RESPONSES 응답 이벤트 유형입니다. 양식 응답이 제출되면 이 이벤트 유형의 시계에 알림이 전송됩니다.

ErrorType

가능한 오류 유형

열거형
ERROR_TYPE_UNSPECIFIED 지정되지 않은 오류 유형입니다.
PROJECT_NOT_AUTHORIZED 클라우드 프로젝트가 감시 중인 양식에 액세스할 수 없습니다. 이는 사용자가 프로젝트에서 양식에 액세스할 수 있는 권한을 취소한 경우에 발생합니다. 이 오류가 있는 시계는 다시 시도하지 않습니다. 양식을 다시 시청하려면 watches.renew에 호출하면 됩니다.
NO_USER_ACCESS 액세스 권한을 부여한 사용자는 더 이상 감시 중인 양식에 액세스할 수 없습니다. 이 오류가 있는 시계는 다시 시도하지 않습니다. 양식을 다시 시청하려면 watches.renew에 호출하면 됩니다.
OTHER_ERRORS 다른 유형의 오류가 발생했습니다. 알림의 지속 여부는 시계 state에 따라 다릅니다.

주

가능한 시계 상태

열거형
STATE_UNSPECIFIED 지정되지 않은 상태.
ACTIVE 시계가 활성 상태입니다.
SUSPENDED 해결될 수 있는 오류로 인해 시계가 정지되었습니다. 시계는 만료될 때까지 계속 사용할 수 있습니다. 시계를 다시 활성화하려면 watches.renew에 전화를 걸어야 합니다.

메서드

create

 새 시계를 만듭니다.

delete

 시계를 삭제합니다.

list

 호출하는 프로젝트에서 소유한 시계 목록을 반환합니다.

renew

 기존 워치를 7일 동안 갱신합니다.