نسخهبندی معنایی
رابط برنامهنویسی کاربردی گوگل ادز (Google Ads API) از نسخهبندی معنایی پیروی میکند که در آن یک نسخه اصلی (major) و یک نسخه فرعی (minor) وجود دارد. فرمت نسخه MAJOR.MINOR یا vMAJOR_MINOR است. برای مثال، v23_0 یک نسخه اصلی است، در حالی که v23_1 یک نسخه فرعی است.
برای نسخههای قبلی به یادداشتهای انتشار مراجعه کنید.
نسخههای اصلی
نسخههای اصلی انتشار، برخی تغییرات اساسی و ناسازگار با نسخههای قبلی را معرفی میکنند. این نسخه با فرمت vX_0 به صفر ختم میشود که در آن X شماره نسخه اصلی است.
هر نسخه اصلی یک نقطه پایانی جداگانه دارد. در این URL مثال، X شماره نسخه اصلی است.
https://googleads.googleapis.com/vX
اگر از یک نسخه اصلی قدیمیتر ارتقا میدهید، ممکن است کد شما هنگام تغییر به نقطه پایانی نسخه اصلی جدید نیاز به تغییراتی داشته باشد. اگر از کتابخانههای کلاینت ما استفاده میکنید، به جدیدترین نسخه ارتقا دهید. هنگامی که یک نسخه اصلی منتشر شد، ما یک راهنمای مهاجرت ارائه میدهیم که باید آن را مطالعه کنید تا هرگونه تغییر مشکلساز در کد خود را برطرف کنید.
نمونههایی از تغییرات ناگهانی عبارتند از:
- حذف یا تغییر نام یک سرویس، رابط، فیلد، متد یا مقدار enum.
- تغییر نوع یک فیلد
- تغییر قالب نام منبع
- تغییر قالب URL در تعریف HTTP.
- تغییر قالبهای خروجی مانند تغییر از
0به--به عنوان مقدار پیشفرض. - تغییر دلیل خطای برگردانده شده از A به B.
نسخههای فرعی
نسخههای فرعی فقط تغییرات سازگار با نسخههای قبلی را ارائه میدهند. برای یک نسخه فرعی، vMAJOR_MINOR عدد MINOR بزرگتر از صفر خواهد داشت.
وقتی نسخه فرعی منتشر میشود، نقطه پایانی که از قبل در حال استفاده است به طور خودکار بهروزرسانی میشود. این باعث خرابی کد شما نمیشود. میتوانید به استفاده از کتابخانههای کلاینت موجود خود ادامه دهید.
نسخههای فرعی شامل ویژگیهای جدید یا بهروزرسانیهایی هستند که روی کد فعلی شما تأثیری ندارند. اگر میخواهید از این ویژگیهای جدید استفاده کنید، کتابخانههای کلاینت خود را به جدیدترین نسخه ارتقا دهید.
غروب خورشید
به صورت دورهای، نسخههای قدیمیتر API تبلیغات گوگل باید منسوخ شوند. وقتی نسخهای در شرف منسوخ شدن باشد، اطلاعیههایی را در وبلاگ توسعهدهندگان منتشر خواهیم کرد. برنامهی منسوخ شدن با تاریخهای انقضای آینده بهروزرسانی میشود.