مهاجرت به نسخه جدید

نسخه های جدید Campaign Manager 360 API به طور منظم منتشر می شود. با انتشار نسخه‌های جدید، نسخه‌های قدیمی‌تر منسوخ شده و در نهایت غروب می‌شوند. هنگامی که یک نسخه غروب می کند، تمام درخواست های مربوط به آن نسخه شروع به بازگشت خطا می کنند.

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

مرحله 1: تعیین کنید که از کدام نسخه استفاده می کنید

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

ویرایشگر جدید Apps Script

اطلاعات نسخه برای Apps Script در گفتگوی سرویس های پیشرفته نمایش داده می شود:

  1. از ویرایشگر Apps Script، روی Add a service کلیک کنید.
  2. Campaign Manager 360 API را در لیست خدمات موجود پیدا کنید.
  3. مقدار انتخاب شده در منوی کشویی نسخه، نسخه Campaign Manager 360 API است که در حال حاضر استفاده می شود.

ویرایشگر قدیمی Apps Script

اطلاعات نسخه برای Apps Script در گفتگوی سرویس های پیشرفته نمایش داده می شود:

  1. از ویرایشگر Apps Script، به Resources > Advanced Google Services بروید.
  2. Campaign Manager 360 API را در لیست خدمات موجود پیدا کنید.
  3. مقدار انتخاب شده در منوی کشویی نسخه، نسخه Campaign Manager 360 API است که در حال حاضر استفاده می شود.

سی شارپ

اطلاعات نسخه Google API Client Library برای دات نت در مکان های زیر نمایش داده می شود:

  1. در نام بسته nuget و فضای نام سرویس گنجانده شده است. 
    Google.Apis.Dfareporting.v3_4
  2. از طریق یک دارایی عمومی DfareportingService در معرض دید قرار گرفت. 
    Console.WriteLine(DfareportingService.Version);

جاوا

اطلاعات نسخه Google API Client Library برای جاوا در مکان‌های زیر نمایش داده می‌شود:

  1. در maven artifactId مشخص شده است. 
    <dependency>
  <groupId>com.google.apis</groupId>
  <artifactId>google-api-services-dfareporting</artifactId>
  <version>v3.4-rev1-1.21.0</version>
</dependency>
  2. در نام فایل JAR گنجانده شده است. 
    google-api-services-dfareporting-v3.4-rev1-1.21.0.jar
  3. از طریق یک دارایی عمومی Dfareporting در معرض دید قرار گرفت. 
    System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);

PHP

اطلاعات نسخه Google API Client Library برای PHP از طریق یک ویژگی عمومی Google_Service_Dfareporting در معرض دید قرار می گیرد:

$service = new Google_Service_Dfareporting($client)
print $service->version;

پایتون

کتابخانه Google API Client Library برای پایتون نسخه نشده است. نسخه API مورد استفاده به عنوان یک آرگومان برای سازنده Discovery مشخص شده است:

discovery.build('dfareporting', 'v3.4', http=http)

روبی

Google API Client Library برای نسخه‌های Ruby < 0.9 نسخه‌بندی نشده است. نسخه API مورد استفاده به عنوان یک آرگومان برای سازنده سرویس مشخص می شود:

service = Google::APIClient::Service.new("dfareporting", "v3.4",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)

برای Google API Client Library برای نسخه‌های Ruby >= 0.9، نسخه در فضای نام سرویس نمایش داده می‌شود:

Google.Apis.DfareportingV3_4

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

مرحله 2: وضعیت نسخه خود را تعیین کنید

برنامه Deprecation وضعیت هر نسخه ای را که در حال حاضر پشتیبانی می شود فهرست می کند. نسخه خود را در این لیست پیدا کنید و وضعیت آن را به صورت زیر تعیین کنید:

  1. اگر هیچ تاریخی در ستون‌های «تاریخ منسوخ» و «تاریخ غروب آفتاب» فهرست نشده است، از یک نسخه کاملاً پشتیبانی شده استفاده می‌کنید.
  2. اگر تاریخ ها فهرست شده باشند، نسخه ای که استفاده می کنید در حال حاضر منسوخ شده است و در تاریخ مشخص شده غروب می کند.
  3. اگر نسخه شما در لیست نیست، از قبل غروب شده است و دیگر پشتیبانی نمی شود.

اگر در شماره 2 یا 3 بالا قرار می گیرید، برای جلوگیری از وقفه در سرویس، باید به نسخه جدیدتر مهاجرت کنید. توصیه می شود به جدیدترین نسخه مهاجرت کنید، که در بالای جدول زمانبندی منسوخ (به استثنای نسخه های بتا) فهرست شده است. این به شما حداکثر زمان بین ارتقاء را می دهد.

مرحله 3: نسخه ها را ارتقا دهید

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

ویرایشگر جدید Apps Script

Google Apps Script از تمام نسخه‌های Campaign Manager 360 API پشتیبانی می‌کند و به شما امکان می‌دهد نسخه‌ای را برای استفاده بر اساس اسکریپت به اسکریپت انتخاب کنید. برای تغییر نسخه استفاده شده توسط یک اسکریپت خاص:

  1. از ویرایشگر Apps Script، روی Add a service کلیک کنید.
  2. Campaign Manager 360 API را در لیست خدمات موجود پیدا کنید.
  3. نسخه Campaign Manager 360 API در حال استفاده را از طریق کشویی نسخه تغییر دهید.
  4. برای ذخیره تغییرات خود روی Add کلیک کنید.

ویرایشگر قدیمی Apps Script

Google Apps Script از تمام نسخه‌های Campaign Manager 360 API پشتیبانی می‌کند و به شما امکان می‌دهد نسخه‌ای را برای استفاده بر اساس اسکریپت به اسکریپت انتخاب کنید. برای تغییر نسخه استفاده شده توسط یک اسکریپت خاص:

  1. از ویرایشگر Apps Script، به Resources > Advanced Google Services بروید.
  2. Campaign Manager 360 API را در لیست خدمات موجود پیدا کنید.
  3. نسخه Campaign Manager 360 API در حال استفاده را از طریق کشویی نسخه تغییر دهید.
  4. برای ذخیره تغییرات روی OK کلیک کنید.

سی شارپ

کتابخانه Google API Client Library برای دات نت ساخت‌های جداگانه‌ای را برای هر نسخه از Campaign Manager 360 API ارائه می‌کند که از طریق Nuget توزیع می‌شود.

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

جاوا

Google API Client Library برای جاوا ساخت‌های جداگانه‌ای برای هر نسخه از Campaign Manager 360 API ارائه می‌کند که از طریق Maven توزیع می‌شود.

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

PHP

Google API Client Library برای PHP ساخت‌های جداگانه‌ای برای هر نسخه از Campaign Manager 360 API ارائه می‌کند که از طریق Packagist توزیع می‌شود.

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

پایتون

هر ساختنی از Google API Client Library برای Python از تمام نسخه‌های Campaign Manager 360 API پشتیبانی می‌کند. به سادگی رشته نسخه ای را که به عنوان آرگومان به سازنده Discovery ارسال می شود، به روز کنید:

discovery.build('dfareporting', 'v3.4', http=http)
 برای دستورالعمل‌های نصب دقیق یا گزینه‌های دانلود جایگزین، به مستندات کتابخانه مشتری مراجعه کنید.

روبی

Google API Client Library برای Ruby نسخه 0.8 و پایین‌تر از همه نسخه‌های Campaign Manager 360 API پشتیبانی می‌کند. به سادگی رشته نسخه ای را که به عنوان آرگومان به سازنده سرویس ارسال می شود، به روز کنید:

service = Google::APIClient::Service.new("dfareporting", "v3.4",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)
 Google API Client Library برای Ruby v0.9+ ساخت‌های جداگانه‌ای برای هر نسخه از Campaign Manager 360 API ارائه می‌کند که از طریق RubyGems توزیع شده است. برای دستورالعمل‌های نصب دقیق یا گزینه‌های دانلود جایگزین، به مستندات کتابخانه مشتری مراجعه کنید.

مرحله 4: آدرس تفاوت نسخه

ما در تلاش هستیم تا نسخه‌های جدید خود را با نسخه‌های قبلی سازگار کنیم، به این معنی که انتقال بین نسخه‌های API نیازی به تغییر در کد شما نخواهد داشت. زمانی که این امکان پذیر نباشد، تغییراتی را که نیاز به اقدامی از سوی توسعه دهندگان دارند (که به عنوان شکستن تغییرات نیز شناخته می‌شود) را در یادداشت‌های انتشار خود اعلام می‌کنیم.

در این مرحله، باید یادداشت‌های انتشار ما را مرور کنید، از نسخه‌ای که از آن شروع کرده‌اید (که در بخش قبلی یادداشت کرده‌اید) شروع کنید و تا نسخه‌ای که در حال ارتقا به آن هستید ادامه دهید. بخش های یادداشت های انتشار باید به شرح زیر تفسیر شوند:

  • ویژگی های جدید - قابلیت های جدید اضافه شده است.
  • Sunsets - عملکردی که از API حذف شده است. در صورت موجود بودن، عملکرد جایگزینی در این بخش پوشش داده خواهد شد.
  • مسائل شناخته شده - تغییراتی که اضافه یا حذف نیستند. به عنوان مثال، این بخش ممکن است فیلدها یا روش هایی را که تغییر نام داده اند یا منطق اعتبار سنجی تغییر یافته را پوشش دهد.

عملکرد ویژگی های جدید نیازی به تغییر کد ندارد و فعلاً می توان آن را نادیده گرفت. اگر می‌خواهید چیزی را که ما اضافه کرده‌ایم آزمایش کنید، بعداً به این بخش بازگردید.

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

در جریان باشید

همانطور که قبلاً ذکر شد، انتشار و غروب آفتاب به طور منظم Campaign Manager 360 API رخ می دهد. به‌روزرسانی‌ها درباره نسخه‌های جدید، منسوخ‌شده‌ها و غروب‌های خورشید در کانال‌های زیر پست می‌شوند:

توصیه می‌شود برای به‌روز ماندن از آخرین اخبار API، مشترک یک یا چند کانال از این کانال‌ها شوید.