Subscriptions

Mirror API به شما امکان می دهد در اعلان هایی مشترک شوید که زمانی که کاربر اقدامات خاصی را روی یک آیتم جدول زمانی انجام می دهد یا زمانی که مکان کاربر به روز شده است ارسال می شود.

برای لیست روش های این منبع، انتهای این صفحه را ببینید.

بازنمایی منابع

اشتراک رویدادهای یک مجموعه. 

{
  "kind": "mirror#subscription",
  "id": string,
  "updated": datetime,
  "collection": string,
  "operation": [
    string
  ],
  "callbackUrl": string,
  "verifyToken": string,
  "userToken": string,
  "notification": {
    "collection": string,
    "itemId": string,
    "operation": string,
    "userActions": [
      {
        "type": string,
        "payload": string
      }
    ],
    "verifyToken": string,
    "userToken": string
  }
}
نام ملک ارزش توضیحات یادداشت ها
callbackUrl string نشانی اینترنتی که اعلان‌ها باید در آن ارسال شوند (باید با https:// شروع شود). قابل نوشتن
collection string مجموعه ای که باید در آن مشترک شوید. مقادیر مجاز عبارتند از:
  • timeline - تغییرات در جدول زمانی از جمله درج، حذف و به روز رسانی.
  • locations - به روز رسانی مکان.
  • settings - به روز رسانی تنظیمات.
 قابل نوشتن
id string شناسه اشتراک.
kind string نوع منبع. این همیشه mirror#subscription است.
notification nested object شی کانتینر برای اعلان ها. این در منبع Subscription پر نشده است.
notification. collection string مجموعه ای که اعلان را ایجاد کرده است.
notification. itemId string شناسه موردی که اعلان را ایجاد کرده است.
notification. operation string نوع عملیاتی که اعلان را ایجاد کرد.

مقادیر قابل قبول عبارتند از:
  • " DELETE "
  • " INSERT "
  • " MENU_ACTION "
  • " UPDATE "
notification. userActions[] list لیستی از اقدامات انجام شده توسط کاربر که باعث ایجاد اعلان شده است.
notification.userActions[]. payload string محموله اختیاری برای اقدام.

برای اقدامات از نوع CUSTOM ، این شناسه مورد منوی سفارشی انتخاب شده است.
notification.userActions[]. type string نوع عمل. ارزش این می تواند باشد:
  • SHARE - کاربر یک مورد را به اشتراک گذاشته است.
  • REPLY - کاربر به یک مورد پاسخ داده است.
  • REPLY_ALL - کاربر به همه گیرندگان یک مورد پاسخ داد.
  • CUSTOM - کاربر یک آیتم منوی سفارشی را در مورد خط زمانی انتخاب کرده است.
  • DELETE - کاربر مورد را حذف کرد.
  • PIN - کاربر مورد را پین کرده است.
  • UNPIN - کاربر پین مورد را برداشت.
  • LAUNCH - کاربر یک فرمان صوتی را آغاز کرد.
در آینده، انواع دیگری ممکن است اضافه شود. UserAction با انواع ناشناخته باید نادیده گرفته شود.
notification. userToken string توکن کاربر ارائه شده توسط سرویس هنگام اشتراک برای اعلان ها.
notification. verifyToken string رمز تأیید مخفی ارائه شده توسط سرویس هنگام ثبت نام برای اعلان‌ها.
operation[] list فهرستی از عملیاتی که باید مشترک شوند. یک لیست خالی نشان می دهد که همه عملیات روی مجموعه باید مشترک شوند. مقادیر مجاز عبارتند از:
  • UPDATE - مورد به روز شده است.
  • INSERT - یک مورد جدید درج شده است.
  • DELETE - مورد حذف شده است.
 قابل نوشتن
updated datetime زمانی که آخرین بار این اشتراک اصلاح شد، مطابق با RFC 3339 قالب‌بندی شده است.
userToken string یک توکن غیر شفاف در اعلان ها برای مشترک ارسال می شود تا بتواند شناسه کاربر را تعیین کند. قابل نوشتن
verifyToken string یک رمز مخفی در اعلان‌ها برای مشترک ارسال می‌شود تا بتواند تأیید کند که اعلان توسط Google ایجاد شده است. قابل نوشتن

روش ها

حذف کنید
اشتراک را حذف می کند.
درج کنید
یک اشتراک جدید ایجاد می کند.
فهرست
فهرستی از اشتراک‌ها را برای کاربر و سرویس احراز هویت شده بازیابی می‌کند.
به روز رسانی کنید
اشتراک موجود را در محل به روز می کند.