نسخه‌سازی در Search Ads 360 Reporting API

Search Ads 360 Reporting API از نسخه‌سازی معنایی استفاده می‌کند.

نسخه های اصلی و فرعی وجود دارد که به صورت v MAJOR _ MINOR فرمت شده اند. به عنوان مثال، v0_0 اولین نسخه اصلی و v0_1 اولین نسخه کوچک است. پسوند شماره نسخه نشان دهنده نوع نسخه است: برای نسخه های اصلی همیشه صفر است و برای نسخه های کوچک همیشه بزرگتر از صفر است.

نسخه های اصلی

نسخه های اصلی تغییرات شکسته ای را ایجاد می کنند، یعنی تغییراتی که با عقب سازگار نیستند.

هر نسخه اصلی یک نقطه پایان جداگانه دارد، به عنوان مثال:

https://searchads360.googleapis.com/v0

https://searchads360.googleapis.com/v1

هنگام ارتقاء از یک نسخه اصلی به نسخه دیگر، ممکن است لازم باشد قبل از تغییر به نقطه پایانی نسخه اصلی جدید، کد خود را تغییر دهید.

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

نمونه هایی از تغییرات شکسته عبارتند از:

  • حذف یا تغییر نام یک سرویس، رابط، فیلد، روش یا مقدار enum.
  • تغییر نوع فیلد
  • تغییر قالب نام منبع
  • تغییر فرمت URL در تعریف HTTP.
  • تغییر فرمت های خروجی، مانند تغییر 0 به -- به عنوان مقدار پیش فرض.
  • تغییر دلیل خطا از A به B برگردانده شد.

نسخه های کوچک

نسخه های کوچک فقط تغییرات سازگار با عقب را ارائه می دهند.

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

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

غروب

هنگامی که یک نسخه قدیمی‌تر Search Ads 360 Reporting API برای غروب برنامه‌ریزی شده است، ما اعلامیه‌ای را در گروه searchads-api-announcements Google پست می‌کنیم.