REST Resource: subscriptions

{
  "name": string,
  "uid": string,
  "targetResource": string,
  "eventTypes": [
    string
  ],
  "payloadOptions": {
    object (PayloadOptions)
  },
  "notificationEndpoint": {
    object (NotificationEndpoint)
  },
  "state": enum (State),
  "suspensionReason": enum (ErrorType),
  "authority": string,
  "createTime": string,
  "updateTime": string,
  "reconciling": boolean,
  "etag": string,

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}

string

اختياريّ. غير قابل للتغيير. المُعرّف. اسم مورد الاشتراك

تنسيق الملف: subscriptions/{subscription}

string

النتائج فقط. معرّف فريد يحدّده النظام للاشتراك

string

مطلوب. غير قابل للتغيير. مرجع Google Workspace الذي تتم مراقبته للأحداث، ويتم تنسيقه على أنّه اسم المورد الكامل. للتعرّف على الموارد المستهدفة والأحداث التي تتيحها، يُرجى الاطّلاع على أحداث Google Workspace المتوافقة.

يمكن للمستخدم تفويض تطبيقك لإنشاء اشتراك واحد فقط لمورد مستهدف محدّد. وإذا حاول تطبيقك إنشاء اشتراك آخر باستخدام بيانات اعتماد المستخدم نفسها، سيعرض الطلب خطأ ALREADY_EXISTS.

string

مطلوب. غير قابل للتغيير. قائمة بدون ترتيب. حقل إدخال لإنشاء الاشتراك في الحالات الأخرى، يتم عرض الناتج فقط. نوع واحد أو أكثر من الأحداث التي يتم تلقّيها حول المورد المستهدف. يتم تنسيقها وفقًا لمواصفات Cloudالأحداث.

تعتمد أنواع الأحداث المتوافقة على المورد المستهدف لاشتراكك. لمعرفة التفاصيل، يُرجى الاطّلاع على أحداث Google Workspace المتوافقة.

ستتلقّى أيضًا تلقائيًا الأحداث حول دورة حياة اشتراكك. لست بحاجة إلى تحديد أحداث مراحل النشاط لهذا الحقل.

إذا حددت نوع حدث غير متوفّر للمورد الهدف، سيعرض الطلب رمز حالة HTTP 400 Bad Request.

object (PayloadOptions)

اختياريّ. خيارات البيانات المطلوب تضمينها في حمولة الحدث لا تتوفَّر هذه الميزة إلا لأحداث Google Chat.

object (NotificationEndpoint)

مطلوب. غير قابل للتغيير. نقطة النهاية التي يوفّر الاشتراك فيها الأحداث، مثل موضوع النشر/الاشتراك.

enum (State)

النتائج فقط. حالة الاشتراك. تحدِّد هذه السياسة ما إذا كان يمكن للاشتراك في خدمة تلقّي الأحداث وتسليمها إلى نقطة نهاية الإشعار.

enum (ErrorType)

النتائج فقط. الخطأ الذي أدّى إلى تعليق الاشتراك.

لإعادة تفعيل الاشتراك، عليك حلّ الخطأ والاتصال بطريقة subscriptions.reactivate.

string

النتائج فقط. المستخدم الذي سمح بإنشاء الاشتراك

تنسيق الملف: users/{user}

بالنسبة إلى مستخدمي Google Workspace، تكون القيمة {user} هي الحقل user.id من واجهة برمجة تطبيقات الدليل.

string (Timestamp format)

النتائج فقط. الوقت الذي يتم فيه إنشاء الاشتراك

string (Timestamp format)

النتائج فقط. آخر مرة تم فيها تحديث الاشتراك.

boolean

النتائج فقط. إذا كان true، يعني ذلك أنّ الاشتراك قيد التعديل.

string

اختياريّ. يحسب الخادم هذا المجموع الاختباري استنادًا إلى قيمة الحقول الأخرى، وقد يتم إرساله بناءً على طلبات التحديث للتأكد من أن العميل لديه قيمة محدَّثة قبل المتابعة.

string (Timestamp format)

حقل تلقائي غير فارغ. الطابع الزمني بالتوقيت العالمي المنسّق (UTC) لانتهاء صلاحية الاشتراك. يتم عرضه دائمًا عند الإخراج، بغض النظر عما تم استخدامه في الإدخال.

string (Duration format)

الإدخال فقط. مدة البقاء (TTL) أو مدة الاشتراك في حال عدم تحديد هذه السمة أو ضبطها على 0، يتم استخدام أقصى مدة ممكنة.

{
  "includeResource": boolean,
  "fieldMask": string
}

boolean

اختياريّ. ما إذا كانت حمولة الحدث تتضمن بيانات عن المورد الذي تم تغييره أم لا. بالنسبة إلى حدث تم إنشاء رسالة Google Chat فيه مثلاً، ما إذا كانت الحمولة تحتوي على بيانات حول مورد Message. إذا كانت القيمة "false"، لن تتضمّن حمولة الحدث سوى اسم المورد الذي تم تغييره.

string (FieldMask format)

اختياريّ. إذا تم ضبط includeResource على true، ستظهر قائمة الحقول المطلوب تضمينها في حمولة الحدث. افصل بين الحقول بفاصلة. على سبيل المثال، لتضمين مُرسِل رسالة Google Chat وإنشاء الوقت، أدخِل message.sender,message.createTime. في حال حذفها، ستتضمّن الحمولة جميع حقول المورد.

في حال تحديد حقل غير موجود للمورد، سيتجاهل النظام هذا الحقل.

{

  // Union field endpoint can be only one of the following:
  "pubsubTopic": string
  // End of list of possible types for union field endpoint.
}

string

غير قابل للتغيير. موضوع Cloud Pub/Sub الذي يتلقّى أحداث الاشتراك.

تنسيق الملف: projects/{project}/topics/{topic}

يجب إنشاء الموضوع في المشروع نفسه على Google Cloud الذي أنشأت فيه هذا الاشتراك.

عندما يتلقّى الموضوع أحداثًا، يتم ترميز الأحداث كرسائل Cloud Pub/Sub. لمعرفة التفاصيل، يُرجى الاطّلاع على ربط بروتوكول Google Cloud Pub/Sub Protocol for Cloudالأحداث.