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

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

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

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

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

העורך החדש של Apps Script

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

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

הגרסה הקודמת של עורך Apps Script

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

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

C#‎

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

  1. כלול בשם חבילת NuGet ובמרחב השמות של השירות. 
    Google.Apis.Dfareporting.v3_4
  2. המאפיין הזה נחשף באמצעות מאפיין ציבורי של DfareportingService. 
    Console.WriteLine(DfareportingService.Version);

Java

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

  1. מוגדר ב-artifactId של Maven. 
    <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 (גרסה 1 או 2) לא כוללת ניהול גרסאות. גרסת ה-API שבה רוצים להשתמש מצוינת כארגומנט ב-discovery builder: 

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: קובעים את הסטטוס של הגרסה

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

אם הגרסה שלכם מופיעה ברשימה, בודקים את העמודות תאריך הוצאה משימוש ותאריך סיום התמיכה:

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

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

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

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

העורך החדש של Apps Script

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

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

הגרסה הקודמת של עורך Apps Script

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

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

C#‎

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

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

Java

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

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

PHP

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

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

Python

כל גרסה של ספריית הלקוח של Google API ל-Python‏ (v1/v2) תומכת בכל הגרסאות של Campaign Manager 360 API. כדי לעבור לגרסה חדשה של Campaign Manager 360 API, צריך לעדכן את מחרוזת הגרסה שמועברת כארגומנט ל-discovery builder: 

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

Ruby

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

REST

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

לדוגמה, כשעוברים מ-v4 ל-v5, צריך לשנות את כתובת ה-URL הבסיסית מ: 

https://dfareporting.googleapis.com/dfareporting/v4/...
 אל: 
https://dfareporting.googleapis.com/dfareporting/v5/...

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

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

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

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

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

הישאר מעודכן

כדאי לעקוב באופן קבוע אחרי Google Ads developer blog כדי לקבל עדכונים על גרסאות חדשות של API, על הוצאה משימוש ועל סגירה של API.