משאב: TransitClass
ייצוג ב-JSON |
---|
{ "transitOperatorName": { object ( |
שדות | |
---|---|
transitOperatorName |
השם של החברה המפעילה את התחבורה הציבורית. |
logo |
חובה. תמונת הלוגו של הכרטיס. התמונה הזו מוצגת בתצוגת פרטי הכרטיס של האפליקציה. |
transitType |
חובה. סוג התחבורה הציבורית שמייצגת את הכיתה הזו, למשל 'אוטובוס'. |
watermark |
תמונה של סימן מים שמוצגת במכשיר של המשתמש. |
languageOverride |
אם השדה הזה קיים, כרטיסי התחבורה הציבורית שיוצגו במכשיר של המשתמש תמיד יהיו בשפה הזו. מייצג את תג השפה BCP 47. דוגמאות לערכים: 'en-US', 'en-GB', 'de' או 'de-AT'. |
customTransitTerminusNameLabel |
תווית בהתאמה אישית לשימוש בערך של שם טרמינל התחבורה הציבורית ( |
customTicketNumberLabel |
תווית בהתאמה אישית לשימוש בערך של מספר הכרטיס ( |
customRouteRestrictionsLabel |
תווית מותאמת אישית לשימוש בערך של מגבלות המסלול ( |
customRouteRestrictionsDetailsLabel |
תווית מותאמת אישית לשימוש בערך של פרטי מגבלות המסלול ( |
customTimeRestrictionsLabel |
תווית מותאמת אישית לשימוש בערך הפרטים של הגבלות הזמן ( |
customOtherRestrictionsLabel |
תווית מותאמת אישית לשימוש בערך של המגבלות האחרות ( |
customPurchaseReceiptNumberLabel |
תווית מותאמת אישית לשימוש בערך של מספר הקבלה על הרכישה ( |
customConfirmationCodeLabel |
תווית בהתאמה אישית לשימוש בערך של קוד האישור ( |
customPurchaseFaceValueLabel |
תווית מותאמת אישית לשימוש בערך הנקוב של הרכישה ( |
customPurchasePriceLabel |
תווית מותאמת אישית לשימוש בערך של מחיר הרכישה ( |
customDiscountMessageLabel |
תווית בהתאמה אישית לשימוש בערך של הודעת ההנחה על משלוח ( |
customCarriageLabel |
תווית מותאמת אישית לשימוש בערך של המשלוח ( |
customSeatLabel |
תווית בהתאמה אישית לשימוש בערך של מיקום המושב ( |
customCoachLabel |
תווית מותאמת אישית לשימוש בערך של אמצעי התחבורה הספציפי ( |
customPlatformLabel |
תווית בהתאמה אישית לשימוש בערך של פלטפורמת העלייה ( |
customZoneLabel |
תווית בהתאמה אישית לשימוש בערך של אזור העלייה למטוס ( |
customFareClassLabel |
תווית מותאמת אישית לשימוש בערך של סוג התעריף ( |
customConcessionCategoryLabel |
תווית בהתאמה אישית לשימוש בערך של קטגוריית ההנחה בתחבורה הציבורית ( |
customFareNameLabel |
תווית בהתאמה אישית לשימוש בערך של שם התעריף בתחבורה הציבורית ( |
classTemplateInfo |
פרטי התבנית לגבי אופן הצגת הכיתה. אם לא תגדירו את השדה, Google תשתמש בקבוצת שדות ברירת מחדל להצגה. |
enableSingleLegItinerary |
קובעת אם המסלול עם מקטע אחד יוצג עבור הכיתה הזו. כברירת מחדל, מסלול יוצג רק בנסיעות עם כמה שלבים. |
id |
חובה. המזהה הייחודי של הכיתה. המזהה הזה חייב להיות ייחודי בכל הכיתות של מנפיק. הערך צריך להיות בפורמט issuer ID.identifier, כאשר המזהה הראשון מונפק על ידי Google והשני נבחר על ידכם. המזהה הייחודי צריך לכלול רק תווים אלפאנומריים, '.', '_' או '-'. |
version |
הוצא משימוש |
issuerName |
חובה. שם המנפיק. האורך המקסימלי המומלץ הוא 20 תווים, כדי שהמחרוזת תוצג במלואה במסכים קטנים יותר. |
messages[] |
מערך של הודעות שמוצגות באפליקציה. כל המשתמשים באובייקט הזה יקבלו את ההודעות המשויכות אליו. המספר המקסימלי של השדות האלה הוא 10. |
allowMultipleUsersPerObject |
הוצא משימוש. במקום זאת, אתם צריכים להשתמש ב- |
homepageUri |
ה-URI של דף הבית של האפליקציה. האכלוס של ה-URI בשדה הזה גורם לאותו התנהגות בדיוק כמו האכלוס של ה-URI ב-linksModuleData (כשאובייקט מנוהל, קישור לדף הבית מוצג במקום שנחשב בדרך כלל לקטע linksModuleData של האובייקט). |
locations[] |
הערה: בשלב הזה אין תמיכה בהפעלת התראות גיאוגרפיות באמצעות השדה הזה. |
reviewStatus |
חובה. הסטטוס של הכיתה. אפשר להגדיר את השדה הזה לערך כשהשיעור נמצא בפיתוח, צריך להשאיר את השדה הזה עם הערך צריך להגדיר את השדה הזה ל- כשמעדכנים כיתה שכבר מוגדרת כ- |
review |
תגובות הבדיקה שמוגדרות על ידי הפלטפורמה כשכיתה מסומנת בסטטוס |
infoModuleData |
הוצא משימוש. במקום זאת, צריך להשתמש ב-textModulesData. |
imageModulesData[] |
נתוני מודול התמונה. המספר המקסימלי של השדות האלה שמוצגים הוא 1 ברמת האובייקט ו-1 ברמת אובייקט הכיתה. |
textModulesData[] |
נתונים של מודול טקסט. אם מוגדרים גם נתונים של מודול טקסט בכיתה, יוצגו שניהם. המספר המקסימלי של השדות האלה שמוצגים הוא 10 מהאובייקט ו-10 מהכיתה. |
linksModuleData |
נתוני המודול 'קישורים'. אם הנתונים של מודול הקישורים מוגדרים גם באובייקט, יוצגו שניהם. |
redemptionIssuers[] |
מזהה את מנפיקי השוברים שיכולים לממש את הכרטיס באמצעות Smart Tap. מנפיקי שוברי המימוש מזוהים לפי מזהה המנפיק שלהם. למנפיקים של שוברי מימוש צריך להיות מוגדר לפחות מפתח אחד של Smart Tap. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר גם את השדות |
countryCode |
קוד המדינה שמשמש להצגת המדינה של הכרטיס (כשהמשתמש לא נמצא במדינה הזו), וגם להצגת תוכן מותאם כשהתוכן לא זמין באזור הגיאוגרפי של המשתמש. |
heroImage |
תמונה אופציונלית של באנר שמוצגת בחזית הכרטיס. אם לא תהיה כותרת, לא יוצג דבר. התמונה תוצג ב-100% רוחב. |
wordMark |
הוצא משימוש. |
enableSmartTap |
האפשרות הזו קובעת אם הכיתה תומכת בהקשה חכמה. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר גם את השדות |
hexBackgroundColor |
צבע הרקע של הכרטיס. אם לא תגדירו צבע, המערכת תשתמש בצבע השולט בתמונה הראשית. אם לא תגדירו תמונה ראשית, המערכת תשתמש בצבע השולט בלוגו. הפורמט הוא #rrggbb, כאשר rrggbb הוא טריופל RGB ב-hex, למשל |
localizedIssuerName |
מחרוזות מתורגמות של השדה issuerName. האורך המקסימלי המומלץ הוא 20 תווים, כדי שהמחרוזת תוצג במלואה במסכים קטנים יותר. |
multipleDevicesAndHoldersAllowedStatus |
האפשרות הזו קובעת אם מספר משתמשים ומכשירים ישמרו את אותו אובייקט שמפנה לכיתה הזו. |
callbackOptions |
אפשרויות קריאה חוזרת (callback) שישמשו לקריאה חוזרת למנפיק בכל פעם שמשתמש הקצה שומר או מחק אובייקט מהסוג הזה. כל האובייקטים מהסוג הזה עומדים בדרישות להפעלת פונקציית ה-callback. |
securityAnimation |
מידע אופציונלי על אנימציית האבטחה. אם ההגדרה הזו מוגדרת, תופעל אנימציית אבטחה בפרטי הכרטיס. |
activationOptions |
אפשרויות ההפעלה של כרטיס שניתן להפעיל. |
viewUnlockRequirement |
הצגת האפשרויות של דרישת הנעילה לכרטיס התחבורה הציבורית. |
wideLogo |
הלוגו הרחב של הכרטיס. אם תספקו תמונה, היא תוצג במקום הלוגו בפינה הימנית העליונה של תצוגת הכרטיס. |
notifyPreference |
אם עדכוני שדות בכיתה הזו יפעילו התראות או לא. כשהערך מוגדר ל-NOTIFY, אנחנו מנסים להפעיל התראה למשתמשים על עדכון השדה. ההתראות האלה יישלחו למשתמשים רק אם השדה נכלל ברשימת ההיתרים. אם הערך מוגדר כ-DO_NOT_NOTIFY או כ-NOTIFICATION_SETTINGS_UNSPECIFIED, לא תופעל התראה. ההגדרה הזו היא זמנית וצריך להגדיר אותה בכל בקשת PATCH או UPDATE, אחרת לא תופעל התראה. |
appLinkData |
קישור אופציונלי לאפליקציה או לאתר שיוצג כלחצן בחזית הכרטיס. אם מציינים את AppLinkData לאובייקט המתאים, המערכת תשתמש בו במקום זאת. |
valueAddedModuleData[] |
נתונים אופציונליים של מודול עם ערך מוסף. עד עשרה תלמידים בכיתה. לגבי כרטיס, יוצגו רק עשרה, והעדיפות תהיה לנתונים מהעצם. |
TransitType
טיפוסים בני מנייה (enum) | |
---|---|
TRANSIT_TYPE_UNSPECIFIED |
|
BUS |
|
bus |
כתובת אימייל חלופית מדור קודם של |
RAIL |
|
rail |
כתובת אימייל חלופית מדור קודם של |
TRAM |
|
tram |
כתובת אימייל חלופית מדור קודם של |
FERRY |
|
ferry |
כתובת אימייל חלופית מדור קודם של |
OTHER |
|
other |
כתובת אימייל חלופית מדור קודם של |
ActivationOptions
ActivationOptions של הכיתה
ייצוג ב-JSON |
---|
{ "activationUrl": string, "allowReactivation": boolean } |
שדות | |
---|---|
activationUrl |
כתובת URL מסוג HTTPS שתומכת בסמינטיקה של REST. ישמש לבקשת הפעלה מהשותפים עבור פריט בעל ערך נתון, שהמשתמשים הפעילו. |
allowReactivation |
דגל שמאפשר למשתמשים לבצע שיחת הפעלה ממכשיר אחר. כך הלקוח יכול להציג את לחצן ההפעלה כפעיל גם אם הערך של activationStatus הוא ACTIVATED אבל המכשיר המבוקש שונה מהמכשיר הנוכחי. |
Methods |
|
---|---|
|
הוספת הודעה לכיתה המעבר שמופיעה במזהה הכיתה הנתון. |
|
הפונקציה מחזירה את סוג התחבורה הציבורית עם מזהה הכיתה הנתון. |
|
הוספה של סוג תחבורה ציבורית עם המזהה והמאפיינים שצוינו. |
|
הפונקציה מחזירה רשימה של כל סוגי התחבורה הציבורית למזהה מנפיק נתון. |
|
עדכון של סוג התחבורה הציבורית שמשויך למזהה הכיתה הנתון. |
|
עדכון של סוג התחבורה הציבורית שמשויך למזהה הכיתה הנתון. |