ניהול גרסאות סמנטי
Google Ads API פועל לפי ניהול גרסאות סמנטי עם מספר גרסה ראשית ומספר גרסה משנית. הגרסאות נכתבות כך: MAJOR.MINOR או vMAJOR.MINOR.
לדוגמה, v26.0 (או v26) היא גרסה ראשית, ו-v26.1 היא גרסה משנית.
בנתוני הגרסה מפורטים פרטים על הגרסאות הנוכחיות והקודמות.
גרסאות ראשיות
גרסאות הפצה ראשיות כוללות שינויים משמעותיים שלא תואמים לדורות קודמים. הגרסה הראשונית של גרסה ראשית מסתיימת באפס (vX.0 או vX, כאשר X הוא מספר הגרסה הראשית).
לכל גרסה ראשית יש נתיב נפרד לנקודת קצה מסוג REST ו-gRPC (vX), שלא כולל את הסיומת של הגרסה המשנית. בכתובת ה-URL הבאה, X הוא מספר הגרסה הראשית (לדוגמה, v26):
https://googleads.googleapis.com/vX
אם אתם משדרגים מגרסה ראשית ישנה יותר, יכול להיות שתצטרכו לשנות את הקוד כשתעברו לנקודת הקצה של הגרסה הראשית החדשה. אם אתם משתמשים בספריות הלקוח שלנו, שדרגו לגרסה של ספריית הלקוח שתומכת בגרסה הראשית החדשה. כשיוצאת גרסה ראשית, אנחנו מספקים מדריך שדרוג כדי לעזור לכם לפתור שינויים בקוד שעלולים לגרום לכשל.
דוגמאות לשינויי תוכנה שעלולים לגרום לכשל:
- הסרה או שינוי שם של שירות, ממשק, שדה, שיטה או ערך enum.
- שינוי סוג השדה.
- שינוי הפורמט של שם המשאב.
- שינוי הפורמט של כתובת ה-URL בהגדרת ה-HTTP.
- שינוי פורמטים של פלט, כמו שינוי ערכי ברירת מחדל.
- שינוי סיבת השגיאה שמוחזרת מ-A ל-B.
גרסאות משניות
גרסאות משניות כוללות רק שינויים שתואמים לדורות קודמים. בגרסה משנית, הערך של vMAJOR.MINOR הוא מספר MINOR שגדול מאפס (לדוגמה, v26.1).
כשיוצאת גרסה משנית, נקודת הקצה של הגרסה הראשית הקיימת (https://googleads.googleapis.com/vX) מתעדכנת באופן אוטומטי. אין צורך לשנות את נתיב הגרסה בכתובות ה-URL של נקודות הקצה, והקוד הקיים ממשיך לפעול בלי להשתבש.
גרסאות משניות מוסיפות תכונות או עדכונים שלא משפיעים על הקוד הקיים. כדי להשתמש בשדות או בתכונות מגרסה משנית עם ספריית לקוח, צריך לשדרג את ספריית הלקוח לגרסה שכוללת את ההגדרות של הגרסה המשנית.
הוצאה משימוש והוצאה סופית משימוש
מדי פעם, גרסאות ישנות יותר של Google Ads API יוצאות משימוש ובהמשך מושבתות:
- הוצאה משימוש: כשגרסה ראשית (כמו
v26) יוצאת, כל הגרסאות הראשיות הקודמות מסומנות כגרסאות שהוצאו משימוש. קריאות ל-API לגרסאות שהוצאו משימוש ממשיכות לפעול עד לתאריך ההוצאה משימוש, וגרסאות קיימות של ספריות לקוח ממשיכות לתמוך בהן, אבל גרסאות חדשות של ספריות לקוח לא כוללות גרסאות API שהוצאו משימוש כדי להקטין את גודל החבילה. - הוצאה משימוש: גרסה מושבתת בתאריך ההוצאה משימוש, וכל הקריאות ל-API לנקודת הקצה שלה נכשלות.
אנחנו מפרסמים הודעות בבלוג למפתחים לפני שאנחנו מוציאים גרסאות משימוש. בלוח הזמנים של ההוצאה משימוש וההפסקה של התמיכה מפורטים התאריכים של הגרסאות הפעילות, הגרסאות שהוצאו משימוש והגרסאות שהתמיכה בהן תופסק.