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

الطُرق

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