المرجع: الاشتراك
تمثيل JSON |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
الحقول | |
---|---|
name |
اختياريّ. غير قابل للتغيير. المُعرّف. اسم مورد الاشتراك. تنسيق الملف: |
uid |
النتائج فقط. المعرّف الفريد الذي يحدّده النظام للاشتراك. |
targetResource |
مطلوبة. غير قابل للتغيير. مورد Google Workspace الذي يتم مراقبته للأحداث، ويكون منسَّقًا على أنّه الاسم الكامل للمورد. للتعرّف على الموارد المستهدفة والأحداث التي تدعمها، يُرجى الاطّلاع على أحداث Google Workspace المتوفّرة. يمكن للمستخدم منح الإذن لتطبيقك بإنشاء اشتراك واحد فقط لمورد مستهدف محدّد. إذا حاول تطبيقك إنشاء اشتراك آخر باستخدام بيانات اعتماد المستخدم نفسها، سيعرض الطلب رسالة الخطأ |
eventTypes[] |
مطلوبة. غير قابل للتغيير. قائمة بدون ترتيب. حقل إدخال البيانات لإنشاء اشتراك وبخلاف ذلك، يتم الناتج فقط. نوع واحد أو أكثر من الأحداث التي تريد تلقّيها حول المورد المستهدَف يتم تنسيقها وفقًا لمواصفات CloudEvent. تعتمد أنواع الأحداث المتوافقة على المورد المستهدَف لاشتراكك. لمعرفة التفاصيل، يُرجى الاطّلاع على أحداث Google Workspace المتوفّرة. ستتلقّى أيضًا بشكلٍ تلقائي أحداثًا عن مراحل نشاط اشتراكك. ولا تحتاج إلى تحديد أحداث مراحل نشاط لهذا الحقل. إذا حدّدت نوع حدث غير متوفّر للمورد الهدف، يعرض الطلب رمز حالة HTTP |
payloadOptions |
اختياريّ. خيارات بشأن البيانات المطلوب تضمينها في حمولة الحدث هذه الميزة متاحة فقط لأحداث Google Chat. |
notificationEndpoint |
مطلوبة. غير قابل للتغيير. نقطة النهاية التي يعرض فيها الاشتراك أحداثًا، مثل موضوع النشر/الاشتراك. |
state |
النتائج فقط. حالة الاشتراك تحدِّد ما إذا كان يمكن للاشتراك تلقّي الأحداث وتسليمها إلى نقطة نهاية الإشعار. |
suspensionReason |
النتائج فقط. الخطأ الذي أدى إلى تعليق الاشتراك. لإعادة تفعيل الاشتراك، عليك حلّ الخطأ والاتصال بالطريقة |
authority |
النتائج فقط. المستخدِم الذي فوَّض لإنشاء الاشتراك. تنسيق الملف: بالنسبة إلى مستخدمي Google Workspace، تكون القيمة |
createTime |
النتائج فقط. الوقت الذي تم فيه إنشاء الاشتراك. |
updateTime |
النتائج فقط. تاريخ آخر تعديل للاشتراك. |
reconciling |
النتائج فقط. إذا كان |
etag |
اختياريّ. يحسب الخادم هذا المجموع الاختباري بناءً على قيمة الحقول الأخرى، ويمكن إرساله عند طلبات التحديث لضمان حصول العميل على قيمة حديثة قبل المتابعة. |
حقل الاتحاد يعتمد الحد الأقصى لوقت انتهاء الصلاحية على ما إذا كان اشتراكك يتضمّن بيانات موارد في حمولات بيانات الأحداث (المحدد في الحقل
وبعد انتهاء صلاحية الاشتراك، يتم حذفه تلقائيًا. تتلقّى أحداث مراحل النشاط حتى لمنع انتهاء صلاحية الاشتراك، يمكنك استخدام طريقة |
|
expireTime |
القيمة التلقائية غير فارغة. الطابع الزمني بالتوقيت العالمي المنسق (UTC) عند انتهاء صلاحية الاشتراك. يتم عرضه دائمًا عند الإدخال، بغض النظر عمّا تم استخدامه عند الإدخال. |
ttl |
الإدخال فقط. مدة البقاء (TTL) أو مدة الاشتراك في حال عدم تحديد قيمة أو ضبطها على |
PayloadOptions
خيارات بشأن البيانات المطلوب تضمينها في حمولة الحدث هذه الميزة متاحة فقط لأحداث Google Chat.
تمثيل JSON |
---|
{ "includeResource": boolean, "fieldMask": string } |
الحقول | |
---|---|
includeResource |
اختياريّ. ما إذا كانت حمولة الحدث تتضمن بيانات عن المورد الذي تم تغييره على سبيل المثال، بالنسبة إلى حدث تم إنشاء رسالة Google Chat فيه، ما إذا كانت الحمولة تحتوي على بيانات عن مورد |
fieldMask |
اختياريّ. إذا تم ضبط إذا حدَّدت حقلاً غير متوفّر للمصدر، سيتجاهل النظام هذا الحقل. |
NotificationEndpoint
نقطة النهاية التي يعرض الاشتراك فيها الأحداث.
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الاتحاد يمكن أن يكون الحقل " |
|
pubsubTopic |
غير قابل للتغيير. موضوع Cloud Pub/Sub الذي يتلقّى أحداث الاشتراك. تنسيق الملف: عليك إنشاء الموضوع في المشروع نفسه على Google Cloud الذي تنشئ فيه هذا الاشتراك. وعندما يتلقّى الموضوع الأحداث، يتم ترميز الأحداث كرسائل Cloud Pub/Sub. لمعرفة التفاصيل، يُرجى الاطّلاع على ربط بروتوكول Google Cloud Pub/Sub لـ CloudEvent. |
الحالة
الحالات المحتملة للاشتراك.
عمليات التعداد | |
---|---|
STATE_UNSPECIFIED |
القيمة التلقائية. هذه القيمة غير مستخدمة. |
ACTIVE |
الاشتراك نشِط، ويمكن استقبال الأحداث وإرسالها إلى نقطة نهاية الإشعارات. |
SUSPENDED |
يتعذّر على الاشتراك تلقّي الأحداث بسبب حدوث خطأ. لتحديد الخطأ، اطّلِع على الحقل . |
DELETED |
تم حذف الاشتراك. |
ErrorType
الأخطاء المحتملة لأحد الاشتراكات.
عمليات التعداد | |
---|---|
ERROR_TYPE_UNSPECIFIED |
القيمة التلقائية. هذه القيمة غير مستخدمة. |
USER_SCOPE_REVOKED |
أبطل المستخدم المفوَّض منح نطاق OAuth واحد أو أكثر. للاطّلاع على مزيد من المعلومات عن التفويض في Google Workspace، يُرجى الاطّلاع على مقالة ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth. |
RESOURCE_DELETED |
لم يعد المورد الهدف للاشتراك متوفرًا. |
USER_AUTHORIZATION_FAILURE |
لم يعُد بإمكان المستخدم الذي سمح بإنشاء الاشتراك الوصول إلى المورد المستهدَف للاشتراك. |
ENDPOINT_PERMISSION_DENIED |
لا يملك تطبيق Google Workspace إذن الوصول لتسليم الأحداث إلى نقطة نهاية إشعارات الاشتراك. |
ENDPOINT_NOT_FOUND |
نقطة نهاية إشعار الاشتراك غير متوفرة أو لا يمكن العثور على نقطة النهاية في مشروع Google Cloud الذي أنشأت فيه الاشتراك. |
ENDPOINT_RESOURCE_EXHAUSTED |
تعذّر على نقطة نهاية إشعارات الاشتراك تلقّي الأحداث بسبب عدم توفّر مساحة كافية للحصة أو بلوغ الحدّ الأقصى للمعدّل. |
OTHER |
حدث خطأ غير معروف. |
الطُرق |
|
---|---|
|
ينشئ اشتراك Google Workspace. |
|
حذف اشتراك Google Workspace |
|
احصل على تفاصيل حول اشتراك Google Workspace. |
|
يسرد اشتراكات Google Workspace. |
|
تعديلات على اشتراك Google Workspace أو تجديده |
|
إعادة تفعيل اشتراك معلّق في Google Workspace |