سناریوهای زیادی وجود دارد که ممکن است هنگام کار با Display & Video 360 API با خطا مواجه شوید. اینها ممکن است مربوط به یک اشکال در کد شما، ورودی نامعتبر کاربر، یا حتی مشکل با خود API باشد. به هر دلیلی، دانستن نحوه عیب یابی خطاها بخش مهمی از فرآیند توسعه است. این راهنما برخی از بهترین نکات عملی را برای شروع شما ارائه می دهد.
بررسی اصول اولیه
- راهنمای پیش نیازها را مرور کنید. اطمینان حاصل کنید که به Display & Video 360 و یک پروژه API به درستی پیکربندی شده دسترسی دارید.
- اگر پاسخ شما حاوی خطاهای HTTP است، مطمئن شوید که آنها را به دقت بررسی کرده و اطمینان حاصل کنید که درخواست به API و سرویس صحیح ارسال شده است.
- راهنمای مجوز را مرور کنید. اطمینان حاصل کنید که درخواست شما حاوی مدارک لازم OAuth 2.0 است.
بررسی کنید که از اعتبارنامه صحیح استفاده می کنید. برای جزئیات بیشتر در مورد ایجاد اعتبارنامه احراز هویت ، راهنمای تنظیم برنامه خود را ببینید. همچنین می‌توانید رمز دسترسی خود را به نقطه پایانی Tokeninfo API 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": ... }
درک خطاها
هنگامی که API با یک خطا مواجه می شود، معمولاً یک پاسخ JSON حاوی یک شی error را برمی گرداند. این شی زمینه اضافی را در مورد خطای خاصی که با آن مواجه شده است فراهم می کند.
{
"error": {
"code": 404,
"message": "Resource type LINE_ITEM does not exist: advertisers/1/lineItems/1",
"status": "NOT_FOUND"
}
}
معمولاً محتویات شی error حاوی اطلاعات کافی است تا به شما کمک کند تشخیص دهید چه چیزی اشتباه است. اگر نه، ممکن است لازم باشد تحقیقات بیشتری انجام دهید تا بفهمید خطا به چه معناست.
تحقیق در مورد خطاها
به بخش خطاهای رایج مراجعه کنید، که جزئیات برخی از خطاهای رایج را ارائه می دهد.
اگر خطا در بخش خطاهای رایج پوشش داده نشده است، به مستندات مرجع مراجعه کنید و سعی کنید کد خطا، وضعیت و پیام را جستجو کنید.
اگر با خطاهایی مواجه شدید که مستند نشده است، لطفاً به ما اطلاع دهید.
شناسایی علت اصلی
در این مرحله شما خطا را شناسایی کرده اید و معنی آن را درک کرده اید. اگر نه، به درک خطاها برگردید یا اگر فکر می‌کنید با خطای API مواجه شده‌اید که نمی‌توانید خودتان آن را برطرف کنید، به دنبال کمک باشید .
قبل از اینکه بتوانید خطا را برطرف کنید، باید علت آن را شناسایی کنید. اغلب این یک اشکال در کد شما یا یک مقدار ورودی نامعتبر است.
برای تعیین اینکه آیا مشکل مربوط به یک اشکال در کد شما است، ابتدا باید بررسی کنید که کد شما مطابق با خواسته شما کار می کند. به عنوان اولین قدم، بخشی از کد را که مسئول ایجاد درخواست ناموفق است، بررسی کنید تا مشکلات واضح را بررسی کنید. در برخی موارد ممکن است لازم باشد از یک ابزار اشکال زدایی برای عبور از کد خط به خط برای اطمینان از عملکرد صحیح آن استفاده کنید.
بررسی درخواست های HTTP روش مفید دیگری برای شناسایی اشکالات احتمالی و همچنین موارد ورودی نامعتبر است. بسیاری از کتابخانه های رسمی مشتری را می توان برای ثبت درخواست ها و پاسخ های HTTP پیکربندی کرد. برای جزئیات بیشتر، اسناد مربوط به کتابخانه انتخابی خود را بررسی کنید. یک پروکسی HTTP مانند Charles ، Squid ، یا Fiddler نیز می‌تواند برای گرفتن گزارش‌های درخواست و پاسخ استفاده شود. هنگامی که این گزارش ها را به دست آوردید، آنها را بررسی کنید تا مطمئن شوید که مقادیر پارامتر درخواست ارائه شده توسط برنامه شما صحیح است و با آنچه انتظار دارید مطابقت دارد.
هنگامی که اشکال یا ورودی نامعتبر مسئول ایجاد خطا را شناسایی کردید، امیدواریم رفع آن واضح باشد. با این حال، اگر گیر کرده‌اید یا مطمئن نیستید که چگونه می‌توانید مشکل را برطرف کنید، می‌توانید هنگام دریافت کمک از اطلاعاتی که تاکنون جمع‌آوری کرده‌اید استفاده کنید.
کمک گرفتن
اگر خودتان نمی‌توانید خطا را برطرف کنید، می‌توانید از طریق این فرم که در مرکز راهنمای Display & Video 360 قرار دارد با تیم پشتیبانی ما تماس بگیرید.
هنگام پر کردن این فرم، باید تا حد امکان اطلاعات بیشتری در مورد مشکلی که با آن روبرو هستید و مراحل عیب‌یابی که قبلا انجام داده‌اید درج کنید. اطلاعات مفیدی که شامل:
- گزارش درخواست و پاسخ HTTP. اطمینان حاصل کنید که اطلاعات حساس مانند نشانه‌های دسترسی OAuth 2.0، آدرس‌های ایمیل و غیره را ویرایش کنید.
- قطعه کد. اگر می‌توانید مشکل را در بخش خاصی از کد جدا کنید یا مشکوک هستید که مشکل مربوط به زبان خاص است، یک قطعه کوچک برای نشان دادن کاری که انجام می‌دهید اضافه کنید.
- اطلاعات اضافی، مانند نسخه زمان اجرا/مترجم و پلتفرم، که ممکن است برای دیگرانی که سعی در بازتولید مشکل دارند مفید باشد.
رفع مشکل
هنگامی که علت مشکل را شناسایی کردید و راه حلی برای آن پیدا کردید، نوبت به اجرای یک راه حل می رسد. هر زمان ممکن است، قبل از استقرار در تولید، اصلاح خود را در یک محیط کنترل‌شده (مانند شریک یا تبلیغ‌کننده‌ای که به‌طور خاص برای آزمایش پیکربندی شده است) در برابر طیفی از ورودی‌های خوب و بد آزمایش کنید.