REST Resource: forms.watches

منبع: تماشا کنید

یک ساعت برای رویدادها برای یک فرم. هنگامی که رویداد تعیین شده رخ می دهد، یک اعلان برای هدف مشخص شده منتشر می شود. ویژگی‌های اعلان شامل یک کلید formId با شناسه فرم تماشا شده و یک کلید eventType است که رشته آن نوع را دارد.

پیام ها حداقل با یک بار تحویل ارسال می شوند و فقط در شرایط فوق العاده حذف می شوند. معمولاً همه اعلان‌ها باید در عرض چند ثانیه به‌طور قابل اعتماد تحویل داده شوند. با این حال، در برخی شرایط ممکن است اعلان ها با تاخیر انجام شود.

یک ساعت هفت روز پس از ایجاد منقضی می شود، مگر اینکه با watches.renew تمدید شود

نمایندگی JSON
{
  "id": string,
  "target": {
    object (WatchTarget)
  },
  "eventType": enum (EventType),
  "createTime": string,
  "expireTime": string,
  "errorType": enum (ErrorType),
  "state": enum (State)
}
زمینه های
id

string

فقط خروجی شناسه این ساعت به یادداشت‌ها در CreateWatchRequest.watch_id مراجعه کنید.

target

object ( WatchTarget )

ضروری. اعلان را کجا ارسال کنیم.

eventType

enum ( EventType )

ضروری. کدام نوع رویداد را تماشا کنیم.

createTime

string ( Timestamp format)

فقط خروجی مهر زمانی از زمان ایجاد این.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

expireTime

string ( Timestamp format)

فقط خروجی مُهر زمانی برای زمان منقضی شدن این. هر تماس watches.renew این را به هفت روز آینده بازنشانی می‌کند.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "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. برای دریافت اعلان‌ها، موضوع باید به serviceAccount:forms-notifications@system.gserviceaccount.com . فقط پروژه ای که موضوعی دارد می تواند با آن ساعت بسازد.

ضمانت های تحویل Pub/Sub باید در نظر گرفته شود.

CloudPubsubTopic

یک موضوع Pub/Sub.

نمایندگی JSON
{
  "topicName": string
}
زمینه های
topicName

string

ضروری. نام موضوع Pub/Sub کاملا واجد شرایط برای انتشار رویدادها. این موضوع باید متعلق به پروژه فراخوان باشد و از قبل در Pub/Sub وجود داشته باشد.

نوع رویداد

انواع رویدادهای احتمالی قابل مشاهده

Enums
EVENT_TYPE_UNSPECIFIED نوع رویداد نامشخص این مقدار نباید استفاده شود.
SCHEMA نوع رویداد طرحواره. ساعتی با این نوع رویداد از تغییرات در محتوا و تنظیمات فرم مطلع خواهد شد.
RESPONSES نوع رویداد پاسخ ها زمانی که پاسخ‌های فرم ارسال شود، ساعتی با این نوع رویداد مطلع می‌شود.

نوع خطا

انواع خطاهای احتمالی

Enums
ERROR_TYPE_UNSPECIFIED نوع خطای نامشخص
PROJECT_NOT_AUTHORIZED پروژه ابری به فرم در حال تماشا دسترسی ندارد. این در صورتی رخ می دهد که کاربر مجوز پروژه شما را برای دسترسی به فرم(های) خود لغو کرده باشد. ساعت های دارای این خطا دوباره امتحان نمی شوند. برای شروع دوباره تماشای فرم می توان با watches.renew تماس گرفت
NO_USER_ACCESS کاربری که اجازه دسترسی داده است دیگر به فرم در حال تماشا دسترسی ندارد. ساعت های دارای این خطا دوباره امتحان نمی شوند. برای شروع دوباره تماشای فرم می توان با watches.renew تماس گرفت
OTHER_ERRORS نوع دیگری از خطا رخ داده است. ادامه یافتن اعلان‌ها به state ساعت بستگی دارد.

حالت

وضعیت های احتمالی دیده بان

Enums
STATE_UNSPECIFIED وضعیت نامشخص
ACTIVE ساعت فعال است
SUSPENDED ساعت به دلیل خطایی که ممکن است برطرف شود معلق است. این ساعت تا زمانی که منقضی شود به حیات خود ادامه خواهد داد. برای تلاش برای فعال کردن مجدد ساعت می توان با watches.renew تماس گرفت

مواد و روش ها

create

 یک ساعت جدید ایجاد کنید.

delete

 یک ساعت را حذف کنید

list

 فهرستی از ساعت‌های متعلق به پروژه فراخوانی را برگردانید.

renew

 یک ساعت موجود را به مدت هفت روز تمدید کنید.