تحديد المشاكل وحلّها

هناك العديد من السيناريوهات التي قد تواجه فيها أخطاء عند استخدام واجهة برمجة التطبيقات الخاصة بـ "مساحة العرض والفيديو 360". وقد تكون هذه الأخطاء مرتبطة بخطأ في الرمز الخاص بك أو إدخال غير صالح للمستخدِم أو حتى مشكلة في واجهة برمجة التطبيقات نفسها. مهما كان السبب، تعد معرفة كيفية استكشاف الأخطاء وإصلاحها جزءًا مهمًا من عملية التطوير. سيقدم لك هذا الدليل بعض النصائح حول أفضل الممارسات للبدء.

مراجعة الأساسيات

  1. راجِع دليل المتطلبات الأساسية. تأكَّد من إمكانية وصولك إلى "مساحة العرض والفيديو 360" ومشروع واجهة برمجة تطبيقات تم إعداده بشكل صحيح.
  2. إذا كانت استجابتك تتضمن أخطاء في HTTP، فتأكد من مراجعة هذه الأخطاء بعناية والتأكد من إرسال الطلب إلى واجهة برمجة التطبيقات والخدمة الصحيحين.
  3. راجِع دليل التفويض. تأكَّد من احتواء طلبك على بيانات اعتماد OAuth 2.0 اللازمة.
  4. تحقق من أنك تستخدم بيانات الاعتماد الصحيحة. راجِع دليل إعداد تطبيقك للحصول على تفاصيل عن إنشاء بيانات اعتماد المصادقة. يمكنك أيضًا إدخال رمز الدخول إلى نقطة نهاية معلومات الرمز المميز لواجهة برمجة تطبيقات Google OAuth2 للتحقق من أنه تم إصداره إلى مشروع واجهة برمجة التطبيقات الصحيح وأنه تم تفويضه للنطاقات الصحيحة:

    POST https://www.googleapis.com/oauth2/v2/tokeninfo?access_token={YOUR_ACCESS_TOKEN}
    
    200 OK
    
    {
     "issued_to": "{API_PROJECT_CLIENT_ID}",
     "audience": "...",
     "scope": "{API_SCOPES}",
     "expires_in": ...
    }
    

فهم الأخطاء

عندما تواجه واجهة برمجة التطبيقات خطأً، تعرض عادةً استجابة JSON التي تحتوي على كائن error. يوفر هذا الكائن سياقًا إضافيًا حول الخطأ المحدد الذي حدث.

{
 "error": {
  "code": 404,
  "message": "Resource type LINE_ITEM does not exist: advertisers/1/lineItems/1",
  "status": "NOT_FOUND"
 }
}

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

أخطاء البحث

  1. ارجع إلى القسم المتعلق بالأخطاء الشائعة، الذي يوفر تفاصيل حول بعض الأخطاء الأكثر شيوعًا.

  2. إذا لم يكن الخطأ مُدرجًا في قسم الأخطاء الشائعة، راجِع المستندات المرجعية وحاوِل البحث عن رمز الخطأ والحالة والرسالة.

  3. إذا واجهت أيّ أخطاء غير موثقة، يُرجى إبلاغنا بها.

تحديد السبب الجذري

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

قبل أن تتمكن من إصلاح الخطأ، ينبغي لك تحديد سبب حدوثه. غالبًا ما يكون هذا خطأً في التعليمات البرمجية أو قيمة إدخال غير صالحة.

لتحديد ما إذا كانت المشكلة تتعلق بخطأ في التعليمات البرمجية الخاصة بك، يجب عليك أولاً التحقق من أن التعليمة البرمجية تعمل على النحو المنشود. كخطوة أولى، ننصحك بمراجعة قسم الرمز المسؤول عن إجراء الطلب الفشل للتحقق من وجود مشاكل واضحة. في بعض الحالات، قد يكون من الضروري استخدام أداة تصحيح الأخطاء لتخطي التعليمات البرمجية سطرًا تلو الآخر لضمان عملها بشكل صحيح.

فحص طلبات HTTP هو طريقة أخرى مفيدة لتحديد الأخطاء المحتملة، وكذلك حالات الإدخالات غير الصالحة. يمكن ضبط العديد من مكتبات العملاء الرسمية لتسجيل طلبات HTTP واستجاباتها. ويمكنك مراجعة المستندات الخاصة بمكتبتك التي تختارها للحصول على مزيد من التفاصيل. يمكن أيضًا استخدام خادم وكيل HTTP مثل Charles أو Squid أو Fiddler للحصول على سجلات الطلبات والاستجابة. بعد الحصول على هذه السجلّات، راجِعها للتأكّد من صحة قيم مَعلمات الطلب التي يقدّمها تطبيقك ومطابقتها لما تتوقعه.

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

الحصول على المساعدة

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

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

  • طلبات HTTP وسجلات الاستجابة احرص على إخفاء المعلومات الحساسة، مثل رموز الدخول عبر OAuth 2.0 وعناوين البريد الإلكتروني وما إلى ذلك.
  • مقتطف الرمز إذا كان بإمكانك عزل المشكلة إلى قسم معين من التعليمات البرمجية أو إذا اشتبهت في أن المشكلة خاصة بلغة معيّنة، أضِف مقتطفًا صغيرًا لتوضيح الإجراء الذي تفعله.
  • معلومات إضافية، مثل إصدار وقت التشغيل/الترجمة الفورية والنظام الأساسي، والتي قد تكون مفيدة للمستخدمين الآخرين الذين يحاولون إعادة إظهار المشكلة.

حلّ المشكلة

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