حلّ الأخطاء وإعادة تفعيل اشتراك Google Workspace

توضّح هذه الصفحة كيفية إعادة تفعيل اشتراك معلَّق في Google Workspace من خلال حلّ الأخطاء أو تحديد المشاكل وحلّها واستدعاء طريقة subscriptions.reactivate.

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

يمكنك التعرّف على الاشتراك المعلّق بالطرق التالية:

  • يتلقّى تطبيقك حدثًا يتم في مراحل النشاط بشأن التعليق. إذا تم تعليق اشتراكك بسبب خطأ في نقطة النهاية، قد لا تتلقّى حدثًا يتم في مراحل النشاط.
  • استخدِم الطريقتَين subscriptions.get أو subscriptions.list لمعرفة ما إذا كان الحقل state الخاص بالاشتراك مضبوطًا على SUSPENDED.
  • يتم إعلامك بفشل التسليم إلى نقطة نهاية الإشعارات. للتعرّف على كيفية مراقبة حالات تعذُّر التسليم إلى مواضيع Google Cloud Pub/Sub، يُرجى الاطّلاع على مقالة التعامل مع حالات تعذُّر تسليم الرسائل.

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

برمجة التطبيقات

  • اشتراك Google Workspace لإنشاء اشتراك، يُرجى الاطّلاع على إنشاء اشتراك.

  • مشروع "برمجة تطبيقات Google":
    • استخدِم مشروعك على Google Cloud بدلاً من المشروع التلقائي الذي يتم إنشاؤه تلقائيًا بواسطة "برمجة تطبيقات Google".
    • بالنسبة إلى جميع النطاقات التي أضفتها لإعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth، عليك أيضًا إضافة النطاقات إلى ملف appsscript.json في مشروع "برمجة تطبيقات Google". على سبيل المثال، إذا حدّدت النطاق chat.messages، أضِف ما يلي: 
      • "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages"
]
    • فعِّل خدمة Google Workspace Events المتقدّمة.

Python

  • الإصدار 3.6 أو الإصدارات الأحدث من Python
  • أداة إدارة الحزم pip
  • أحدث مكتبات برامج Google للغة Python لتثبيت هذه الحزم أو تعديلها، نفِّذ الأمر التالي في واجهة سطر الأوامر: 
      pip3 install --upgrade google-api-python-client google-auth-oauthlib

تحديد الأخطاء وحلّها

لتحديد الخطأ في اشتراك، راجِع الحقل suspensionReason الخاص بالاشتراك. يمكنك العثور على هذا الحقل عند تلقّي حدث دورة الحياة المتعلّق بالتعليق، أو باستخدام طريقة subscriptions.get لمراجعة جميع حقول الاشتراك.

يعرض الجدول التالي الأخطاء المحتملة في الاشتراك، وكيفية حلّها عند الإمكان. إذا لم تتمكّن من حلّ المشكلة، يمكنك حذف الاشتراك أو الانتظار إلى أن تنتهي صلاحيته. يحذف Google Workspace Events API الاشتراكات المنتهية الصلاحية تلقائيًا.

خطأ الوصف طرق حلّ المشكلة

USER_SCOPE_REVOKED

ألغى المستخدم المفوَّض منح إذن الوصول إلى نطاق واحد أو أكثر من نطاقات OAuth المطلوبة للاشتراك. الحصول على رمز دخول آخر للاطّلاع على التفاصيل، يُرجى الانتقال إلى مقالة الحصول على رمز دخول من خادم منح الأذونات في Google.

RESOURCE_DELETED

تم حذف المورد المستهدف للاشتراك. إذا تمت استعادة المورد، استدعِ الطريقة reactivate. في ما عدا ذلك، ليس عليك اتّخاذ أي إجراء، لأنّه لا يمكنك إعادة تفعيل اشتراك بدون المورد المستهدف الأصلي.

USER_AUTHORIZATION_FAILURE

لم يعُد بإمكان المستخدم الذي منح الإذن الوصول إلى المورد الخاص بالاشتراك. ليس عليك اتّخاذ أي إجراء. لا يمكنك إعادة تفعيل الاشتراك لأنّ المستخدم الذي منح الإذن لا يمكنه الوصول إلى المورد المستهدف.

ENDPOINT_PERMISSION_DENIED

لا يمكن لتطبيق Google Workspace إرسال الأحداث إلى نقطة نهاية الإشعارات. منح إذن الوصول إلى حساب الخدمة لتطبيق Google Workspace الذي يقدّم الأحداث

حسابات الخدمة:
  • أحداث Google Chat: chat-api-push@system.gserviceaccount.com
  • أحداث Google Drive: drive-api-event-push@system.gserviceaccount.com
  • أحداث Google Meet: meet-api-event-push@system.gserviceaccount.com

بالنسبة إلى مواضيع Pub/Sub، امنح حساب الخدمة دور ناشر Pub/Sub (roles/pubsub.publisher) ).

ENDPOINT_NOT_FOUND

نقطة نهاية الإشعارات غير متوفّرة أو يتعذّر العثور عليها. تأكَّد من أنّ نقطة النهاية لا تزال نشطة وتعمل. لتحديد المشاكل وحلّها في مواضيع Pub/Sub، راجِع مستندات تحديد المشاكل وحلّها.

ENDPOINT_RESOURCE_EXHAUSTED

تعذّر على نقطة نهاية الإشعارات تلقّي الأحداث بسبب عدم توفّر حصة كافية أو بلوغ حدّ السعر الأقصى المسموح به. قدِّم طلبًا لزيادة الحصة.

APP_SCOPE_REVOKED

ألغى مشرف النطاق منح إذن الوصول إلى نطاق واحد أو أكثر من نطاقات OAuth لتطبيق Chat. الحصول على موافقة المشرف

APP_AUTHORIZATION_FAILURE

لم يعُد تطبيق Chat الذي منح الإذن بإنشاء الاشتراك يملك إذن الوصول إلى المورد المستهدف للاشتراك. استعادة إذن الوصول إلى المرجع المستهدف على سبيل المثال، إذا كان المورد المستهدف هو مساحة في Chat، قد يحتاج تطبيق Chat إلى عضوية في المساحة.

إعادة تفعيل اشتراك

بعد حلّ الخطأ الذي أدّى إلى تعليق اشتراكك، استخدِم طريقة reactivate للسماح للاشتراك بتلقّي الأحداث مرة أخرى. تتحقّق الطريقة من حلّ جميع الأخطاء وتغيّر قيمة الحقل state في اشتراكك من SUSPENDED إلى ACTIVE.

لإعادة تفعيل اشتراك Google Workspace، اتّبِع الخطوات التالية:

برمجة التطبيقات

  1. في مشروع "برمجة تطبيقات Google"، أنشئ ملف نص برمجي جديدًا باسم reactivateSubscription وأضِف الرمز التالي:

    function reactivateSubscription() {
  // The name of the subscription to reactivate.
  const name = 'subscriptions/SUBSCRIPTION_ID';

  // Call the Workspace Events API using the advanced service.
  const response = WorkspaceEvents.Subscriptions.reactivate({}, name);
  console.log(response);
}

    غيِّر القيم في السلسلة على الشكل التالي:

    • ‫SUBSCRIPTION_ID: رقم تعريف الاشتراك. للحصول على المعرّف، يمكنك استخدام أيّ مما يلي:
      • قيمة الحقل uid
      • معرّف اسم المرجع الممثّل في الحقل name على سبيل المثال، إذا كان اسم المورد هو subscriptions/subscription-123، استخدِم subscription-123.

  2. لإعادة تفعيل اشتراك Google Workspace، شغِّل الدالة reactivateSubscription في مشروع "برمجة تطبيقات Google".

Python

  1. في دليل العمل، أنشئ ملفًا باسم reactivate_subscription.py وأضِف الرمز التالي:

    """Reactivate subscription."""

from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = [SCOPES]

# Authenticate with Google Workspace and get user authentication.
flow = InstalledAppFlow.from_client_secrets_file('credentials.json', SCOPES)
CREDENTIALS = flow.run_local_server()

# Call the Workspace Events API using the service endpoint.
service = build(
    'workspaceevents',
    'v1',
    credentials=CREDENTIALS,
)

NAME = 'subscriptions/SUBSCRIPTION_ID'
response = service.subscriptions().reactivate(name=NAME).execute()
print(response)

    غيِّر القيم في السلسلة على الشكل التالي:

    • SCOPES: نطاق واحد أو أكثر من نطاقات OAuth التي تتيح كل نوع من أنواع الأحداث للاشتراك. يتم تنسيقه كصفيف من السلاسل. لإدراج نطاقات متعددة، افصل بينها بفواصل. على سبيل المثال، 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
    • ‫SUBSCRIPTION_ID: رقم تعريف الاشتراك. للحصول على المعرّف، يمكنك استخدام أيّ مما يلي:
      • قيمة الحقل uid
      • معرّف اسم المرجع الممثّل في الحقل name على سبيل المثال، إذا كان اسم المورد هو subscriptions/subscription-123، استخدِم subscription-123.

  2. في دليل العمل، تأكَّد من تخزين بيانات اعتماد معرّف عميل OAuth وتسمية الملف credentials.json. تستخدم عينة التعليمات البرمجية ملف JSON هذا للمصادقة مع Google Workspace والحصول على بيانات اعتماد المستخدم. للاطّلاع على التعليمات، راجِع مقالة إنشاء بيانات اعتماد معرّف عميل OAuth.

  3. لإعادة تفعيل اشتراك Google Workspace، نفِّذ ما يلي في نافذة الأوامر:

    python3 reactivate_subscription.py
تعرض واجهة برمجة التطبيقات Google Workspace Events API عملية طويلة الأمد تحتوي على مثيل المورد Subscription.

إذا تعذّر تنفيذ الطلب، يُرجى الاطّلاع على القسم التالي لتحديد المشاكل وحلّ الأخطاء الإضافية.

إعادة تفعيل اشتراك كتطبيق Chat

يمكنك إعادة تفعيل اشتراك في أحداث Chat كتطبيق Chat بدلاً من مستخدم. وتكون العملية مشابهة، باستثناء ما يلي:

  1. بدلاً من مصادقة المستخدم، يمكنك المصادقة كتطبيق Chat من خلال موافقة المشرف لمرة واحدة.

  2. حدِّد نطاقات التفويض التي تسمح لتطبيق Chat بالاشتراك في أحداث Chat. تبدأ نطاقات الأذونات هذه دائمًا بـ chat.app، وتشمل ما يلي:

    • https://www.googleapis.com/auth/chat.app.memberships: للاشتراك في أحداث أعضاء مساحة Chat
    • https://www.googleapis.com/auth/chat.app.memberships.readonly: للاشتراك في أحداث أعضاء مساحة Chat
    • ‫https://www.googleapis.com/auth/chat.app.messages.readonly: للاشتراك في أحداث الرسائل والتفاعلات في مساحة Chat
    • https://www.googleapis.com/auth/chat.app.spaces: للاشتراك في أحداث مساحة Chat
    • https://www.googleapis.com/auth/chat.app.spaces.readonly: للاشتراك في أحداث مساحة Chat

كتابة نص برمجي يستدعي Google Workspace Events API

تعيد عينة التعليمات البرمجية التالية تفعيل اشتراك Google Workspace لتطبيق Chat:

Python 

  """Reactivate subscription."""

  from google.oauth2 import service_account
  from apiclient.discovery import build

  # Specify required scopes.
  SCOPES = [SCOPES]

  # Specify service account details.
  CREDENTIALS = (
      service_account.Credentials.from_service_account_file('credentials.json')
      .with_scopes(SCOPES)
  )

  # Call the Workspace Events API using the service endpoint.
  service = build(
      'workspaceevents',
      'v1beta',
      credentials=CREDENTIALS,
  )

  NAME = 'subscriptions/SUBSCRIPTION_ID'
  response = service.subscriptions().reactivate(name=NAME).execute()
  print(response)

غيِّر القيم في السلسلة على الشكل التالي:

  • استبدِل SCOPES بنطاقات التفويض التي تسمح لتطبيق Chat بالاشتراك في أحداث Chat. تبدأ نطاقات الأذونات هذه دائمًا بـ chat.app، وتشمل ما يلي:

    • https://www.googleapis.com/auth/chat.app.memberships: للاشتراك في أحداث أعضاء مساحة Chat
    • https://www.googleapis.com/auth/chat.app.memberships.readonly: للاشتراك في أحداث أعضاء مساحة Chat
    • ‫https://www.googleapis.com/auth/chat.app.messages.readonly: للاشتراك في أحداث الرسائل والتفاعلات في مساحة Chat
    • https://www.googleapis.com/auth/chat.app.spaces: للاشتراك في أحداث مساحة Chat
    • https://www.googleapis.com/auth/chat.app.spaces.readonly: للاشتراك في أحداث مساحة Chat

  • ‫SUBSCRIPTION_ID: رقم تعريف الاشتراك. للحصول على المعرّف، يمكنك استخدام أيّ مما يلي:

    • قيمة الحقل uid
    • معرّف اسم المرجع الممثّل في الحقل name على سبيل المثال، إذا كان اسم المورد هو subscriptions/subscription-123، استخدِم subscription-123.

تحديد المشاكل في الأخطاء المتعددة وحلّها

إذا تم حلّ الخطأ الذي أدّى إلى تعليق الاشتراك وتعذّر استخدام طريقة الدفع reactivate، قد يكون حدث خطأ آخر بعد تعليق اشتراكك.

لتحديد أخطاء إضافية، راجِع الناتج من الطلب الذي تعذّر تنفيذه. يحتوي الناتج على أي أخطاء لا تزال موجودة.

عندما يتضمّن اشتراكك أخطاء متعددة، تستخدم قيمة الحقل suspensionReason دائمًا الخطأ الأصلي الذي أدّى إلى تعليق اشتراكك.