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

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

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

  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 وعناوين البريد الإلكتروني وما إلى ذلك
  • مقتطف الرمز فإذا تمكنت من عزل المشكلة في قسم معين من أو الاشتباه في أن المشكلة متعلقة باللغة، فيمكنك تضمين مقتطف صغير لتوضيح ما تفعله.
  • معلومات إضافية، مثل النظام الأساسي لبيئة التشغيل أو أداة الترجمة الفورية والذي قد يكون مفيدًا للآخرين الذين يحاولون إعادة إنتاج الخطأ

حلّ المشكلة

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