מעבר לגרסה חדשה

אנחנו משיקים באופן קבוע גרסאות חדשות של ה-Campaign Manager 360 API. ככל שנשיק גרסאות חדשות, גרסאות ישנות יותר יצאו משימוש ובסופו של דבר יצאו משימוש. כשגרסה מושבתת, כל הבקשות לגרסה הזו יתחילו להחזיר שגיאות.

אם הגרסה של ה-API שבה אתם משתמשים הוצאה משימוש, תצטרכו לעבור לגרסה חדשה יותר לפני תאריך ההוצאה משימוש שנקבע. המדריך הזה מסביר איך לבדוק אם גרסת ה-API שבה אתם משתמשים הוצאה משימוש ומספקת את שלבי ההעברה המומלצים.

שלב 1: בודקים באיזו גרסה משתמשים

אם אתם מטמיעים אפליקציה שאתם חושדים שהיא משתמשת בגרסה שהוצאה משימוש של ה-API של Campaign Manager 360, תחילה מומלץ לוודא באיזו גרסה ספציפית אתם משתמשים. ברוב המקרים, הגישה לממשק ה-API תתבצע דרך אחת מספריות הלקוח הספציפיות לשפה, או באמצעות שילוב רשמי. הוראות לאיתור גרסת ה-API שנמצאות בשימוש בספריות הלקוח ובשילובים שלהן מופיעות בהמשך:

עורך Apps Script חדש

פרטי הגרסה של Apps Script נחשפים בתיבת הדו-שיח 'שירותים מתקדמים':

  1. בעורך Apps Script, לוחצים על הוספת שירות .
  2. מאתרים את ה-API של Campaign Manager 360 ברשימת השירותים הזמינים.
  3. הערך שנבחר בתפריט הנפתח של הגרסה הוא גרסת ה-API של Campaign Manager 360 שנמצאת כעת בשימוש.

עורך Apps Script מדור קודם

פרטי הגרסה של Apps Script נחשפים בתיבת הדו-שיח 'שירותים מתקדמים':

  1. מעורך Apps Script, עוברים אל Resources > Advanced Google services (משאבים > שירותי Google מתקדמים).
  2. מאתרים את ה-API של Campaign Manager 360 ברשימת השירותים הזמינים.
  3. הערך שנבחר בתפריט הנפתח של הגרסה הוא גרסת ה-API של Campaign Manager 360 שנמצאת כעת בשימוש.

C#‎

מידע על גרסאות של ספריית הלקוח Google Apps for .NET גלוי במקומות הבאים:

  1. כלול בשם החבילה ב-nuget ומרחב השמות של השירות. 
    Google.Apis.Dfareporting.v3_4
  2. נחשף דרך נכס ציבורי של DfareportingService. 
    Console.WriteLine(DfareportingService.Version);

Java

מידע על הגרסה של ספריית הלקוחות ב-Google API ל-Java חשוף במקומות הבאים:

  1. שצוין ב-aventartifactId. 
    <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 עבור PHP נחשפים דרך נכס ציבורי של Google_Service_Dfareporting: 

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

Python

ספריית הלקוחות של Google API ל-Python לא משתנה. גרסת ה-API שבה רוצים להשתמש מצוינת כארגומנט בכלי ליצירת גילויים: 

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

Ruby

ספריית הלקוחות של Google API עבור גרסאות 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 לגרסאות Ruby >= 0.9, הגרסה גלויה במרחב השמות של השירות: 

Google.Apis.DfareportingV3_4

יש לרשום את הגרסה שבה נעשה שימוש, כי יהיה צורך במידע הזה בהמשך.

שלב 2: קובעים את הסטטוס של הגרסה

תזמון ההוצאה משימוש מפרט את הסטטוס של כל גרסה שנתמכת כרגע. מחפשים את הגרסה שלכם ברשימה וקובעים את הסטטוס שלה:

  1. אם אין תאריכים רשומים בעמודות תאריך ההוצאה משימוש ותאריך הפסקת השימוש, סימן שאתם משתמשים בגרסה שנתמכת באופן מלא.
  2. אם מצוינים תאריכים, הגרסה שבה אתם משתמשים הוצאה משימוש ותצא משימוש בתאריך שצוין.
  3. אם הגרסה שלכם לא מופיעה ברשימה, סימן שהיא הוצאה משימוש ואינה נתמכת יותר.

אם עוברים ל-#2 או ל-#3 למעלה, צריך לעבור לגרסה חדשה יותר כדי להימנע משיבושים בשירות. מומלץ לעבור לגרסה העדכנית ביותר, שמופיעה בחלק העליון של טבלת לוח הזמנים להוצאה משימוש (לא כולל גרסאות בטא). כך יהיה לך זמן מקסימלי בין השדרוגים.

שלב 3: שדרוג גרסאות

אם החלטת שעליך לבצע העברה, השלב הבא הוא לעדכן את האינטגרציה שלך או לקבל גרסה מעודכנת של ספריית הלקוח המועדפת עליך. חשוב לזכור שספריות לקוח מסוימות עשויות לספק רק גרסת build אחת שפועלת עם כל גרסת API, אבל לחלק מהגרסאות יהיו גרסאות build נפרדות לכל גרסה. ברשימה הבאה מפורט מידע כללי על השדרוג של הספריות והשילובים של הלקוחות הנפוצים ביותר.

עורך Apps Script חדש

Google Apps Script תומך בכל הגרסאות של ה-API של Campaign Manager 360 ומאפשר לבחור את הגרסה לשימוש על בסיס של כל סקריפט בנפרד. כדי לשנות את הגרסה שבה נעשה שימוש בסקריפט מסוים:

  1. בעורך Apps Script, לוחצים על הוספת שירות .
  2. מאתרים את ה-API של Campaign Manager 360 ברשימת השירותים הזמינים.
  3. משנים את גרסת ה-API של Campaign Manager 360 שנמצאת בשימוש דרך התפריט הנפתח של הגרסה.
  4. לוחצים על הוספה כדי לשמור את השינויים.

עורך Apps Script מדור קודם

Google Apps Script תומך בכל הגרסאות של ה-API של Campaign Manager 360 ומאפשר לבחור את הגרסה לשימוש על בסיס של כל סקריפט בנפרד. כדי לשנות את הגרסה שבה נעשה שימוש בסקריפט מסוים:

  1. מעורך Apps Script, עוברים אל Resources > Advanced Google services (משאבים > שירותי Google מתקדמים).
  2. מאתרים את ה-API של Campaign Manager 360 ברשימת השירותים הזמינים.
  3. משנים את גרסת ה-API של Campaign Manager 360 שנמצאת בשימוש דרך התפריט הנפתח של הגרסה.
  4. כדי לשמור את השינויים, לוחצים על אישור.

C#‎

ספריית הלקוח Google API עבור .NET מספקת גרסאות build נפרדות לכל גרסה של ה-Campaign Manager 360 API, שמופצת באמצעות Nuget.

לקבלת הוראות מפורטות להתקנה או אפשרויות הורדה חלופיות, יש לעיין בתיעוד של ספריית הלקוח.

Java

ספריית הלקוח Google API ל-Java מספקת גרסאות build נפרדות לכל גרסה של ה-Campaign Manager 360 API, שמופצת דרך Maven.

לקבלת הוראות מפורטות להתקנה או אפשרויות הורדה חלופיות, יש לעיין בתיעוד של ספריית הלקוח.

PHP

ספריית הלקוח ב-Google API ל-PHP מספקת גרסאות build נפרדות לכל גרסה של ה-Campaign Manager 360 API, שמופצת דרך Packagist.

לקבלת הוראות מפורטות להתקנה או אפשרויות הורדה חלופיות, יש לעיין בתיעוד של ספריית הלקוח.

Python

כל מבנה של ספריית הלקוח Google API עבור Python תומך בכל הגרסאות של ה-API של Campaign Manager 360. צריך פשוט לעדכן את מחרוזת הגרסה שמועברת כארגומנט בכלי ליצירת גילויים: 

discovery.build('dfareporting', 'v3.4', http=http)
לקבלת הוראות מפורטות להתקנה או לאפשרויות הורדה חלופיות, אפשר לעיין בתיעוד של ספריית הלקוח.

Ruby

ספריית הלקוחות של Google API ל-Ruby v0.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 עבור Ruby v0.9+ מספקת גרסאות build נפרדות לכל גרסה של Campaign Manager 360 API, המופצת דרך RubyGems. לקבלת הוראות מפורטות להתקנה או אפשרויות הורדה חלופיות, יש לעיין בתיעוד של ספריית הלקוח.

שלב 4: טיפול בהבדלים בין גרסאות

אנו שואפים להפוך את הגרסאות החדשות שלנו לתאימות לאחור, כלומר, מעבר בין גרסאות API לא יחייב שינויים בקוד שלך. כשהפעולה הזו אינה אפשרית, אנחנו מכריזים על השינויים שמחייבים פעולה של מפתחים (שנקראים גם מבזקי חדשות) בנתוני הגרסה.

בשלב זה עליך לבדוק את נתוני הגרסה שלנו, המתחילים עם הגרסה שאחרי הגרסה שממנה התחלת (שפרסמת בה את ההערה בקטע קודם) והמשך לכלול את הגרסה שאתה משדרג אליה. יש לפרש את הקטעים של נתוני הגרסה כך:

  • תכונות חדשות – פונקציונליות חדשה נוספה.
  • שקיעה – פונקציונליות שהוסרה מה-API. בקטע הזה נסביר על הפונקציות החלופיות.
  • בעיות ידועות - שינויים שאינם הוספות או הסרות. לדוגמה, הקטע הזה עשוי לכלול שדות או שיטות שהשם שלהם השתנה או לוגיקת אימות ששונתה.

הפונקציונליות של תכונות חדשות לא תדרוש שינויים בקוד, וניתן להתעלם ממנה בשלב זה. אפשר לחזור לקטע הזה מאוחר יותר כדי לנסות משהו שהוספנו.

עם זאת, אם אתם רואים שינויים בקטעים שקיעה או בעיות ידועות, ייתכן שתצטרכו לבצע פעולה כלשהי. עליך לחפש את הקוד כדי לבדוק אם היישום שלך כולל פונקציונליות שהוסרה או שונתה. במקרה כזה, תצטרכו לבצע עדכונים בקוד כדי לטפל בשינויים האלה.

הישאר מעודכן

כפי שצוין קודם, השקות ומהדורות של Campaign Manager 360 API מתרחשות באופן קבוע. עדכונים על גרסאות חדשות, אפליקציות שהוצאו משימוש ושקיעות יפורסמו בערוצים הבאים:

מומלץ להירשם לאחד או יותר מהערוצים האלה כדי להתעדכן בחדשות ה-API האחרונות.