روال‌های مطلوب

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

نگهداری از برنامه

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

  • مطمئن شوید که فهرست مالکان و ویرایشگران پروژه Google Cloud شما به‌روز است. درصورت بروز هرگونه شرایط اضطراری یا موضوعات مربوط به رعایت «شرایط خدمات میانای برنامه‌سازی کاربردی»، با این کاربران تماس خواهیم گرفت. اگر نتوانیم درباره رعایت «شرایط خدمات» API با شما تماس بگیریم، ممکن است دسترسی شما به API کاهش یابد یا لغو شود.

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

  • برنامه‌تان را با شرایط خدمات Google Ads API مطابقت دهید. درصورت لزوم، تیم رعایت مقررات API با مالکان و ویرایشگران پروژه Google Cloud شما که دسترسی API دارند تماس خواهد گرفت. اگر درباره «شرایط خدمات» سؤال یا نگرانی دارید، می‌توانید با پاسخ دادن به ایمیلی که تیم رعایت مقررات هنگام بررسی درخواست دسترسی به میانای برنامه‌سازی کاربردی برایتان ارسال کرده است، با آن‌ها تماس بگیرید.

بهینه‌سازی

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

عملیات گروهی

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

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

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

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

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

مدیریت و رسیدگی به خطا

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

تشخیص منابع درخواست

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

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

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

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

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

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

همگام‌سازی زیرینه‌ها

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

خطاهای گزارش

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

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

توسعه

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

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

حساب‌های آزمایشی حساب‌های Google Ads هستند که درواقع آگهی ارائه نمی‌کنند. می‌توانید از حساب آزمایشی برای آزمایش کردن «میانای برنامه‌سازی کاربردی Google Ads» و آزمایش کردن اتصال‌پذیری برنامه، منطق مدیریت پویش، یا پردازش‌های دیگر استفاده کنید تا مطمئن شوید که طبق انتظار کار می‌کنند. پروژه Google Cloud شما فقط به دسترسی «آزمایشی» نیاز دارد تا در حساب آزمایشی استفاده شود، بنابراین می‌توانید بلافاصله توسعه با Google Ads API را شروع کنید و درحالی‌که منتظر می‌مانید Google درخواستتان را برای سطوح دسترسی بالاتر به API بررسی کند.