نسخه‌گذاری معنایی
Google Ads API از نسخه‌بندی معنایی با شماره نسخه اصلی و
فرعی پیروی می‌کند. نسخه‌ها به‌صورت MAJOR.MINOR یا vMAJOR.MINOR نوشته می‌شوند.
برای مثال، v26.0 (یا v26) نسخه عمده است، درحالی‌که v26.1 نسخه جزئی است.
برای جزئیات نسخه‌های فعلی و گذشته، یادداشت‌های انتشار را ببینید.
نسخه‌های عمده
نسخه‌های پخش اصلی تغییرات ناسازگار با نسخه‌های قبلی را معرفی می‌کنند. انتشار اولیه نسخه عمده به صفر ختم می‌شود (vX.0 یا vX، که X شماره نسخه عمده است).
هر نسخه عمده دارای مسیر نقطه پایانی REST و gRPC جداگانه (vX) است که شامل پسوند نسخه جزئی نمی‌شود. در نشانی وب زیر، X شماره نسخه عمده است (برای مثال، v26):
https://googleads.googleapis.com/vX
اگر از نسخه عمده قدیمی‌تر ارتقا می‌دهید، ممکن است کد شما هنگام جابه‌جایی به نقطه پایانی نسخه عمده جدید نیاز به تغییر داشته باشد. اگر از کتابخانه‌های کارخواه ما استفاده می‌کنید، به نسخه کتابخانه کارخواه که از نسخه عمده جدید پشتیبانی می‌کند ارتقا دهید. وقتی نسخه عمده‌ای منتشر می‌شود، راهنمای ارتقایی ارائه می‌دهیم تا به شما کمک کنیم هرگونه تغییر مختل‌کننده را در کدتان برطرف کنید.
نمونه‌هایی از تغییرات ناسازگار عبارت‌اند از:
- برداشتن یا تغییر نام سرویس، میانا، فیلد، روش، یا مقدار شمارشی.
- تغییر نوع فیلد.
- تغییر قالب نام منبع.
- تغییر قالب نشانی وب در تعریف HTTP.
- تغییر قالب‌های خروجی، مانند تغییر مقادیر پیش‌فرض.
- تغییر دلیل خطای برگردانده‌شده از A به B.
نسخه‌های جزئی
نسخه‌های جزئی فقط تغییرات سازگار با نسخه قدیمی را معرفی می‌کنند. برای نسخه جزئی،
vMAJOR.MINOR دارای عدد MINOR بزرگ‌تر از صفر است (برای مثال،
v26.1).
وقتی نسخه جزئی منتشر می‌شود، نقطه پایانی نسخه عمده موجود (https://googleads.googleapis.com/vX) به‌طور خودکار در محل به‌روز می‌شود. لازم نیست مسیر نسخه را در نشانی‌های وب نقطه پایانی‌تان تغییر دهید و کد موجود بدون وقفه به کار خود ادامه می‌دهد.
نسخه‌های جزئی ویژگی‌ها یا به‌روزرسانی‌هایی را اضافه می‌کنند که بر کد موجود شما تأثیر نمی‌گذارند. برای استفاده از فیلدها یا ویژگی‌های نسخه جزئی با کتابخانه کارخواه، کتابخانه کارخواه خود را به نسخه‌ای ارتقا دهید که شامل تعاریف نسخه جزئی باشد.
منسوخ شدن و پایان کار
به‌طور دوره‌ای، نسخه‌های قدیمی‌تر Google Ads API منسوخ می‌شوند و سپس ازکار می‌افتند:
- منسوخ‌شده: وقتی نسخه عمده‌ای (مثل
v26) منتشر می‌شود، همه نسخه‌های عمده قبلی به‌عنوان منسوخ‌شده علامت‌گذاری می‌شوند. فراخوانی‌های میانای برنامه‌سازی کاربردی به نسخه‌های منسوخ‌شده تا تاریخ پایان پشتیبانی آن‌ها همچنان موفقیت‌آمیز خواهد بود و نسخه‌های کتابخانه کارخواه موجود همچنان از آن‌ها پشتیبانی می‌کنند، اگرچه نسخه‌های بعدی کتابخانه کارخواه نسخه‌های منسوخ‌شده میانای برنامه‌سازی کاربردی را برای کاهش اندازه بسته حذف می‌کنند. - پایان عمر: نسخه در تاریخ پایان عمرش غیرفعال می‌شود و همه فراخوانی‌های میانای برنامه‌سازی کاربردی به نقطه پایانی آن ناموفق خواهد بود.
پیش‌از منسوخ شدن نسخه‌ها، اعلامیه‌هایی را در وبلاگ توسعه‌دهنده پست می‌کنیم. زمان‌بندی منسوخ شدن و توقف را برای تاریخ‌های فعال، منسوخ‌شده، و توقف زمان‌بندی‌شده بررسی کنید.