חלק מממשקי Business Profile API זמינים ביותר מגרסה אחת ובערוץ הפצה אחד. הגרסה היא החלק בכתובת ה-URL של הבקשה שמופיע אחרי שם המארח, כמו v1 או v1alpha. בדף הזה מוסבר איך הגרסאות ממוספרות, מהי רמת היציבות של כל ערוץ הפצה ואיך קוראים לערוץ אלפא.
מספור הגרסאות
לכל גרסת API יש מספר גרסה ראשית וסיומת ערוץ אופציונלית:
- גרסה ראשית (
v1,v2, …): גרסה יציבה שזמינה לכלל המשתמשים. גרסה ראשית מקבלת רק שינויים שתואמים לדורות קודמים, כמו שיטות חדשות, שדות חדשים או ערכי enum חדשים. שינויים שלא תואמים לדורות קודמים מתפרסמים בגרסה ראשית חדשה. - ערוץ אלפא (
v1alpha,v2alpha, ...): ערוץ טרום-השקה של גרסה ראשית. הוא כולל את כל מה שיש בגרסה הראשית, וגם תכונות שעדיין לא זמינות לכלל המשתמשים.
ערוצי הפצה
| ערוץ | יציבות | תוכן עניינים |
|---|---|---|
זמינות לכלל המשתמשים (v1) |
יציב. שינויים בגרסה ראשית תואמים לדורות קודמים. כשגרסה ראשית יוצאת משימוש, היא נשארת זמינה למשך 12 חודשים לפחות אחרי ההודעה על ההוצאה משימוש. הוצאה משימוש ותאריכי סיום מפורסמים בדף לוח הזמנים להוצאה משימוש. | תכונות שזמינות לכלל המשתמשים. |
אלפא (v1alpha) |
גרסת טרום-השקה, ללא התחייבות ליציבות וללא משך חיים מוגדר. תכונות בשלב אלפא עשויות להשתנות או להתבטל בהתראה של 30 יום לפחות. אל תשתמשו בתכונות בשלב אלפא בשילובים בסביבת הייצור. | כל מה שכלול ב-v1, וגם תכונות שעדיין לא זמינות לכלל המשתמשים. |
איך תכונות עוברות בין ערוצים
כשפיצ'ר עובר מ-v1alpha ל-v1, הוא עדיין זמין ב-v1alpha.
מדריכים ודפי עזר לתכונות שזמינות רק ב-v1alpha מסומנים כגרסת אלפא. אנחנו מודיעים על תכונות חדשות בשלב אלפא ועל תכונות שזמינות לכלל המשתמשים, וגם על שינויים בתכונות בשלב אלפא או על הסרה שלהן, בקטע העדכונים האחרונים וביומן השינויים של כל API.
שימוש בערוץ אלפא
כדי לקרוא לערוץ אלפא, מחליפים את v1 ב-v1alpha בכתובת ה-URL של הבקשה. לדוגמה:
GET https://mybusinessbusinessinformation.googleapis.com/v1alpha/locations/{locationId}?readMask={readMask}
שני הערוצים שייכים לאותו API, ולכן הם חולקים את המאפיינים הבאים:
- הפעלת ה-API במסוף Google Cloud.
- דרישות גישה והיקפי הרשאות של OAuth 2.0.
- שמות המשאבים, כמו
locations/{locationId}. - מכסה. בקשות ל-
v1ול-v1alphaנספרות באותה מכסה לכל פרויקט. פרטים נוספים זמינים במאמר מגבלות המכסות. - הנתונים העסקיים הבסיסיים. שינויים שתבצעו דרך
v1alphaיהיו גלויים דרךv1, ולהפך.
ספריות הלקוח וספריית ה-API הציבורית כוללות רק את v1. כדי להפעיל את v1alpha, שולחים בקשות REST ישירות.
שיטות מומלצות
- לשילובים בסביבת הייצור, השתמשו בגרסה היציבה, כמו
v1. - כדי להשתמש בתכונות חדשות לפני שהן זמינות לכלל המשתמשים, אתם יכולים להשתמש בערוץ אלפא, כמו
v1alpha. כדי לשלוח משוב, אפשר להיעזר בתמיכה. - צריך לוודא שהלקוח יכול להתמודד עם שדות וערכי enum שהוא לא מזהה.
- לפני שאתם משתמשים בתכונה בשלב אלפא, כדאי לבדוק במדריך וביומן השינויים שלה אם יש מגבלות ידועות.