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