بهترین شیوه ها

ویدیو: سخنرانی بهترین شیوه‌ها را از کارگاه ۲۰۱۹ ببینید

این راهنما برخی از بهترین شیوه‌هایی را که می‌توانید برای بهینه‌سازی کارایی و عملکرد برنامه‌های خود پیاده‌سازی کنید، پوشش می‌دهد.

تعمیر و نگهداری مداوم

برای اطمینان از اینکه برنامه شما بدون وقفه اجرا می‌شود:

  • ایمیل تماس توسعه‌دهنده خود را در مرکز API به‌روز نگه دارید. این نام مستعاری است که ما برای تماس با شما استفاده می‌کنیم. اگر نتوانیم در مورد رعایت شرایط و ضوابط API با شما تماس بگیریم، ممکن است دسترسی API شما بدون اطلاع قبلی شما لغو شود. از استفاده از آدرس ایمیل شخصی مرتبط با یک حساب کاربری شخصی یا بدون نظارت خودداری کنید. برای مشاهده مرکز API، باید به حساب کاربری مدیریت خود وارد شوید.

  • برای اطلاع از مسائلی مانند تغییرات محصول، زمان‌های از کارافتادگی تعمیر و نگهداری، تاریخ‌های انقضا و غیره، در خبرنامه ما عضو شوید.

  • برنامه خود را با شرایط و ضوابط API تبلیغات گوگل (T&C) مطابقت دهید. در صورت لزوم، تیم بررسی و انطباق توکن با استفاده از ایمیل شما با شما تماس خواهد گرفت. اگر در مورد شرایط و ضوابط سؤال یا نگرانی دارید، می‌توانید با پاسخ به ایمیلی که هنگام بررسی درخواست توکن توسعه‌دهنده برای شما ارسال کرده‌اند، با تیم بررسی تماس بگیرید.

بهینه‌سازی

شما می‌توانید برنامه خود را با اجرای عملیات دسته‌ای و در صورت لزوم، ارسال اشیاء پراکنده (sparse objects) بهینه کنید.

عملیات دسته‌ای

ارسال درخواست به API مستلزم تعدادی هزینه ثابت، مانند تأخیر شبکه رفت و برگشت، پردازش سریال‌سازی و حذف سریال‌سازی، و فراخوانی به سیستم‌های back-end است. برای کاهش تأثیر این هزینه‌های ثابت و افزایش عملکرد کلی، اکثر روش‌های mutate در API به گونه‌ای طراحی شده‌اند که مجموعه‌ای از عملیات را بپذیرند. با دسته‌بندی چندین عملیات در هر درخواست، می‌توانید تعداد درخواست‌های خود و هزینه‌های ثابت مرتبط را کاهش دهید. در صورت امکان، از ارسال درخواست‌هایی با تنها یک عملیات خودداری کنید.

برای مثال، فرض کنید که شما در حال اضافه کردن ۵۰،۰۰۰ کلمه کلیدی به یک کمپین در چندین گروه تبلیغاتی هستید. به جای ایجاد ۵۰،۰۰۰ درخواست با ۱ کلمه کلیدی برای هر کدام، ۱۰۰ درخواست با ۵۰۰ کلمه کلیدی برای هر کدام یا حتی ۱۰ درخواست با ۵۰۰۰ کلمه کلیدی برای هر کدام ایجاد کنید. محدودیت‌هایی در تعداد عملیات مجاز در یک درخواست وجود دارد، بنابراین ممکن است لازم باشد اندازه دسته خود را برای دستیابی به عملکرد بهینه تنظیم کنید.

ارسال اشیاء پراکنده

وقتی اشیاء به API ارسال می‌شوند، فیلدها باید deserialize، اعتبارسنجی و در پایگاه داده ذخیره شوند. ارسال اشیاء کامل وقتی فقط می‌خواهید چند فیلد را به‌روزرسانی کنید، می‌تواند منجر به زمان پردازش اضافی و کاهش عملکرد شود. برای کاهش این مشکل، API تبلیغات گوگل از به‌روزرسانی‌های پراکنده پشتیبانی می‌کند و به شما این امکان را می‌دهد که فقط فیلدهایی را در یک شیء که نیاز به تغییر یا ضروری بودن دارند، پر کنید. به‌روزرسانی‌های پراکنده سریع‌تر پردازش می‌شوند و احتمال کمتری برای ایجاد خطا دارند. فیلدهایی که در update_mask (همچنین به عنوان FieldMask شناخته می‌شوند) نیستند، بدون تغییر باقی می‌مانند.

برای مثال، برنامه‌ای که پیشنهادات سطح کلمات کلیدی را به‌روزرسانی می‌کند، می‌تواند از به‌روزرسانی‌های پراکنده بهره‌مند شود، زیرا فقط فیلدهای شناسه گروه تبلیغاتی، شناسه معیار و پیشنهادات باید پر شوند.

مدیریت و کنترل خطا

در طول توسعه، احتمالاً با خطاهایی روبرو خواهید شد. این بخش ملاحظات و استراتژی‌هایی را برای ایجاد مدیریت خطا در برنامه شما شرح می‌دهد. علاوه بر این بخش، برای اطلاعات بیشتر در مورد مدیریت خطاها، از راهنمای عیب‌یابی نیز دیدن کنید.

منابع درخواست را متمایز کنید

برخی از برنامه‌ها عمدتاً تعاملی هستند و مستقیماً در پاسخ به اقدامات آغاز شده توسط کاربر در رابط کاربری، فراخوانی‌های API را انجام می‌دهند. برخی دیگر عمدتاً به صورت آفلاین کار می‌کنند و فراخوانی‌های API را به عنوان بخشی از یک فرآیند دوره‌ای back-end انجام می‌دهند. بسیاری از برنامه‌ها این دو را با هم ترکیب می‌کنند. هنگام فکر کردن به مدیریت خطا، تشخیص این انواع مختلف درخواست می‌تواند مفید باشد.

برای درخواست‌های آغاز شده توسط کاربر، دغدغه اصلی شما باید ارائه یک تجربه خوب برای کاربرانتان باشد. از خطای خاصی که رخ داده است استفاده کنید تا تا حد امکان زمینه را در رابط کاربری در اختیار کاربر قرار دهید. مراحل ساده‌ای را که می‌توانند برای حل خطا انجام دهند، ارائه دهید (به پیشنهادات زیر توجه کنید).

برای درخواست‌هایی که از سمت بک‌اند (back end) آغاز می‌شوند، برای انواع مختلف خطاهایی که برنامه شما ممکن است با آنها مواجه شود، هندلرهایی (handler) پیاده‌سازی کنید. همیشه یک هندلر پیش‌فرض برای رسیدگی به خطاهای نادر یا قبلاً ناشناخته در نظر بگیرید. یک رویکرد خوب برای یک هندلر پیش‌فرض، اضافه کردن عملیات ناموفق و خطا به صف است تا یک اپراتور انسانی آن را بررسی و راه‌حل مناسبی را تعیین کند.

تشخیص انواع خطا

دانستن تفاوت‌های بین انواع خطا در API گوگل ادز هنگام ساخت یک سیستم مدیریت خطای قوی بسیار مهم است. برخی از رایج‌ترین انواع خطا عبارتند از:

  1. خطاهای احراز هویت
  2. خطاهای قابل تکرار
  3. خطاهای اعتبارسنجی
  4. خطاهای مربوط به همگام‌سازی

برای جزئیات بیشتر به انواع خطا و خطاهای رایج مراجعه کنید.

همگام‌سازی بک‌اندها

اگر کاربران برنامه شما به صورت دستی به حساب‌های گوگل ادز دسترسی داشته باشند، ممکن است تغییراتی ایجاد کنند که برنامه شما از آنها آگاه نباشد و باعث شود پایگاه داده محلی برنامه شما از همگام‌سازی خارج شود. همانطور که در راهنمای انواع خطا ذکر شد، می‌توانید خطاهای مربوط به همگام‌سازی را در صورت بروز به صورت واکنشی برطرف کنید، اما می‌توانید به صورت پیشگیرانه نیز از آنها جلوگیری کنید. یک استراتژی پیشگیرانه این است که یک کار همگام‌سازی شبانه را روی تمام حساب‌های خود اجرا کنید، اشیاء گوگل ادز را در حساب‌های خود بازیابی کنید و با پایگاه داده محلی خود مقایسه کنید.

خطاهای ثبت

تمام خطاها باید ثبت شوند تا اشکال‌زدایی و نظارت بر آنها تسهیل شود. حداقل، شناسه درخواست، عملیاتی که باعث خطا شده‌اند و خود خطا را ثبت کنید. سایر اطلاعات برای ثبت شامل شناسه مشتری، سرویس API، تأخیر درخواست رفت و برگشت، تعداد تلاش‌های مجدد و درخواست و پاسخ خام است.

حتماً روند خطاهای API را زیر نظر داشته باشید تا بتوانید مشکلات برنامه خود را شناسایی و برطرف کنید. ساخت راهکار خودتان یا استفاده از یکی از ابزارهای تجاری موجود که می‌توانند از گزارش‌های شما برای تولید داشبوردهای تعاملی و ارسال هشدارهای خودکار استفاده کنند را در نظر بگیرید.

توسعه

در طول توسعه از حساب‌های آزمایشی استفاده کنید.

استفاده از حساب‌های آزمایشی

حساب‌های آزمایشی، حساب‌های گوگل ادز هستند که در واقع تبلیغاتی ارائه نمی‌دهند. شما می‌توانید از یک حساب آزمایشی برای آزمایش API گوگل ادز استفاده کنید و بررسی کنید که اتصال برنامه، منطق مدیریت کمپین یا سایر پردازش‌ها مطابق انتظار کار می‌کنند یا خیر. توکن توسعه‌دهنده شما برای استفاده در یک حساب آزمایشی نیازی به تأیید ندارد، بنابراین می‌توانید بلافاصله پس از درخواست توکن توسعه‌دهنده، حتی قبل از بررسی برنامه خود، شروع به توسعه با API گوگل ادز کنید.