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

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

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

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

4. تأكَّد من استخدام بيانات الاعتماد الصحيحة. اطّلِع على دليل إعداد تطبيقك للحصول على تفاصيل عن إنشاء بيانات اعتماد المصادقة. يمكنك أيضًا تمرير رمز الوصول إلى نقطة نهاية tokeninfo في Google OAuth2 API للتأكّد من أنّه تم إصداره لمشروع واجهة برمجة التطبيقات الصحيح وتم تفويضه بالنطاقات الصحيحة:

   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 ، من المحتمل أنّ الخطأ ليس من Display & Video 360 API. يُرجى الرجوع إلى قسم مراجعة الأساسيات قبل المتابعة.

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

البحث عن الأخطاء

1. راجِع قسم الأخطاء الشائعة الذي يقدّم تفاصيل عن بعض الأخطاء الأكثر شيوعًا.

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

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

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

تحديد السبب الأساسي

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

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

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

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

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

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

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

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

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

حلّ المشكلة

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