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
  }
}
اسم الموقع القيمة الوصف Notes
callbackUrl string عنوان URL الذي يجب إرسال الإشعارات إليه (يجب أن يبدأ بـ 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: بدأ المستخدم طلبًا صوتيًا.
في المستقبل، قد تتم إضافة أنواع أخرى. يجب تجاهل إجراءات UserActions ذات الأنواع غير المعروفة.
notification.userToken string الرمز المميّز للمستخدم الذي توفّره الخدمة عند الاشتراك في الإشعارات
notification.verifyToken string يشير هذا المصطلح إلى الرمز المميّز للتحقّق السري الذي توفّره الخدمة عند الاشتراك في خدمة تلقّي الإشعارات.
operation[] list قائمة بالعمليات التي يجب الاشتراك فيها. تشير القائمة الفارغة إلى أنه يجب الاشتراك في جميع العمليات في المجموعة. القيم المسموح بها هي:
  • UPDATE - تم تحديث السلعة.
  • INSERT - تم إدراج عنصر جديد.
  • DELETE - تم حذف السلعة.
 قابل للكتابة
updated datetime وقت آخر تعديل لهذا الاشتراك، والذي تم تنسيقه وفقًا لمعيار RFC 3339.
userToken string يشير ذلك المصطلح إلى رمز مميّز مبهم يتم إرساله إلى المشترك في الإشعارات حتى يتمكّن من تحديد رقم تعريف المستخدم. قابل للكتابة
verifyToken string يتم إرسال رمز مميّز سري إلى المشترك في الإشعارات ليتمكّن من التحقّق من أنّ Google أنشأت الإشعار. قابل للكتابة

الطُرق

حذف
لحذف اشتراك.
إدراج
إنشاء اشتراك جديد
list
استرداد قائمة باشتراكات المستخدم والخدمة التي تمت المصادقة عليها
تعديل
لتعديل اشتراك حالي