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

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

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

مرحله ۱: مشخص کنید از کدام نسخه استفاده می‌کنید

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

ویرایشگر جدید اسکریپت برنامه‌ها

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

1. از ویرایشگر اسکریپت برنامه‌ها، روی سرویس کلیک کنید.
2. API مربوط به Campaign Manager 360 را در فهرست سرویس‌های موجود پیدا کنید.
3. مقداری که در منوی کشویی نسخه انتخاب شده است، نسخه API مورد استفاده در Campaign Manager 360 است.

ویرایشگر قدیمی اسکریپت برنامه‌ها

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

1. از ویرایشگر اسکریپت برنامه‌ها، به مسیر Resources > Advanced Google services بروید.
2. API مربوط به Campaign Manager 360 را در فهرست سرویس‌های موجود پیدا کنید.
3. مقداری که در منوی کشویی نسخه انتخاب شده است، نسخه API مورد استفاده در Campaign Manager 360 است.

سی شارپ

اطلاعات نسخه کتابخانه کلاینت API گوگل برای دات نت در مکان‌های زیر قرار دارد:

1. در نام بسته NuGet و فضای نام سرویس گنجانده شده است.

   Google.Apis.Dfareporting.v3_4

2. با استفاده از یک ویژگی عمومی از DfareportingService افشا شده است.

   Console.WriteLine(DfareportingService.Version);

جاوا

اطلاعات نسخه کتابخانه کلاینت API گوگل برای جاوا در مکان‌های زیر قرار دارد:

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);

پی اچ پی

اطلاعات نسخه کتابخانه کلاینت API گوگل برای PHP با استفاده از یک ویژگی عمومی از Google_Service_Dfareporting نمایش داده می‌شود:

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

پایتون

کتابخانه کلاینت API گوگل برای پایتون (نسخه ۱/۲) نسخه‌بندی نشده است. نسخه API مورد استفاده به عنوان آرگومان برای سازنده اکتشاف مشخص می‌شود:

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

روبی

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

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

برای کتابخانه کلاینت API گوگل برای نسخه‌های Ruby >= 0.9، نسخه در فضای نام سرویس قرار دارد:

Google.Apis.DfareportingV3_4

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

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

اگر نسخه شما در لیست وجود دارد، ستون‌های Deprecation Date و Sunset Date را بررسی کنید:

• اگر هیچ تاریخی وجود ندارد، نسخه شما کاملاً پشتیبانی می‌شود.
• اگر تاریخ‌ها وجود داشته باشند، نسخه شما منسوخ شده و در تاریخ مشخص شده منقضی خواهد شد.

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

مرحله ۳: ارتقاء نسخه‌ها

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

ویرایشگر جدید اسکریپت برنامه‌ها

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

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

ویرایشگر قدیمی اسکریپت برنامه‌ها

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

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

سی شارپ

کتابخانه کلاینت API گوگل برای دات‌نت، برای هر نسخه از API کمپین منیجر ۳۶۰ که از طریق NuGet توزیع شده است، نسخه‌های جداگانه‌ای ارائه می‌دهد. نسخه کتابخانه کلاینت را به نسخه‌ای از به‌روزرسانی کنید که با نسخه API مورد نظر شما مطابقت دارد.

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

جاوا

کتابخانه کلاینت API گوگل برای جاوا، برای هر نسخه از API مدیریت کمپین ۳۶۰ که از طریق Maven توزیع شده است، نسخه‌های جداگانه‌ای ارائه می‌دهد. نسخه کتابخانه کلاینت را به نسخه‌ای از آن به‌روزرسانی کنید که با نسخه API مورد نظر شما مطابقت دارد.

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

پی اچ پی

کتابخانه کلاینت API گوگل برای PHP، برای هر نسخه از API مدیریت کمپین ۳۶۰ که از طریق Packagist توزیع شده است، نسخه‌های جداگانه‌ای ارائه می‌دهد. نسخه کتابخانه کلاینت را به نسخه‌ای از به‌روزرسانی کنید که با نسخه API مورد نظر شما مطابقت دارد.

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

پایتون

هر نسخه از کتابخانه کلاینت API گوگل برای پایتون (نسخه ۱/۲) از تمام نسخه‌های API کمپین مدیر ۳۶۰ پشتیبانی می‌کند. برای مهاجرت به نسخه جدید API کمپین مدیر ۳۶۰، رشته نسخه‌ای که به عنوان آرگومان به سازنده اکتشاف ارسال می‌شود را به‌روزرسانی کنید:

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

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

روبی

کتابخانه کلاینت API گوگل برای Ruby نسخه ۰.۸ و پایین‌تر، از تمام نسخه‌های API کمپین مدیر ۳۶۰ پشتیبانی می‌کند. برای مهاجرت به نسخه جدید API کمپین مدیر ۳۶۰، رشته نسخه‌ای که به عنوان آرگومان به سازنده سرویس ارسال می‌شود را به‌روزرسانی کنید:

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

کتابخانه کلاینت API گوگل برای Ruby نسخه ۰.۹+، برای هر نسخه از API مدیریت کمپین ۳۶۰ که از طریق RubyGems توزیع شده است، نسخه‌های جداگانه‌ای ارائه می‌دهد. نسخه کتابخانه کلاینت را به نسخه‌ای از به‌روزرسانی کنید که با نسخه API مورد نظر شما مطابقت دارد. برای دستورالعمل‌های نصب دقیق یا گزینه‌های دانلود جایگزین، به مستندات کتابخانه کلاینت مراجعه کنید.

استراحت

اگر مستقیماً با استفاده از HTTPS API را فراخوانی می‌کنید، نقطه پایانی درخواست‌های خود را به‌روزرسانی کنید تا از شماره نسخه جدید API استفاده کنند.

برای مثال، هنگام مهاجرت از v4 به v5 ، آدرس پایه را به صورت زیر تغییر می‌دهید:

https://dfareporting.googleapis.com/dfareporting/v4/...

به:

https://dfareporting.googleapis.com/dfareporting/v5/...

مرحله ۴: تفاوت‌های نسخه‌ها را بررسی کنید

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

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

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

اگر برنامه شما از قابلیت‌های ذکر شده در بخش‌های «غروب آفتاب» یا «مسائل شناخته‌شده» استفاده می‌کند، باید کد خود را برای رسیدگی به این تغییرات به‌روزرسانی کنید.

مطلع بمانید

مرتباً وبلاگ توسعه‌دهندگان گوگل ادز را رصد کنید تا اولین نفری باشید که از انتشارها، منسوخ شدن‌ها و انقضاهای API مطلع می‌شود.