REST Resource: forms.watches

리소스: Watch

양식의 이벤트를 감시합니다. 지정된 이벤트가 발생하면 지정된 대상에 알림이 게시됩니다. 알림의 속성에는 감시하는 양식의 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)

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

생성된 출력은 항상 Z-정규화되고 소수점 이하 자릿수가 0, 3, 6 또는 9인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
expireTime

string (Timestamp format)

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

생성된 출력은 항상 Z-정규화되고 소수점 이하 자릿수가 0, 3, 6 또는 9인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
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일 동안 갱신합니다.