REST Resource: transitclass

משאב: TransitClass

ייצוג ב-JSON 
{
  "transitOperatorName": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "transitType": enum (TransitType),
  "watermark": {
    object (Image)
  },
  "languageOverride": string,
  "customTransitTerminusNameLabel": {
    object (LocalizedString)
  },
  "customTicketNumberLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsDetailsLabel": {
    object (LocalizedString)
  },
  "customTimeRestrictionsLabel": {
    object (LocalizedString)
  },
  "customOtherRestrictionsLabel": {
    object (LocalizedString)
  },
  "customPurchaseReceiptNumberLabel": {
    object (LocalizedString)
  },
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "customPurchaseFaceValueLabel": {
    object (LocalizedString)
  },
  "customPurchasePriceLabel": {
    object (LocalizedString)
  },
  "customDiscountMessageLabel": {
    object (LocalizedString)
  },
  "customCarriageLabel": {
    object (LocalizedString)
  },
  "customSeatLabel": {
    object (LocalizedString)
  },
  "customCoachLabel": {
    object (LocalizedString)
  },
  "customPlatformLabel": {
    object (LocalizedString)
  },
  "customZoneLabel": {
    object (LocalizedString)
  },
  "customFareClassLabel": {
    object (LocalizedString)
  },
  "customConcessionCategoryLabel": {
    object (LocalizedString)
  },
  "customFareNameLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "enableSingleLegItinerary": boolean,
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "activationOptions": {
    object (ActivationOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
שדות
transitOperatorName

object (LocalizedString)

השם של החברה המפעילה את התחבורה הציבורית.
transitType

enum (TransitType)

חובה. סוג התחבורה הציבורית שמייצגת את הכיתה הזו, למשל 'אוטובוס'.
watermark

object (Image)

תמונת סימן מים שתוצג במכשיר של המשתמש.
languageOverride

string

אם השדה הזה קיים, כרטיסי תחבורה ציבורית שיוצגו למכשיר של המשתמש תמיד יהיו בשפה הזו. מייצג את תג השפה BCP 47. דוגמאות לערכים: 'en-US',‏ 'en-GB',‏ 'de' או 'de-AT'.
customTransitTerminusNameLabel

object (LocalizedString)

תווית בהתאמה אישית לשימוש בערך של שם טרמינל התחבורה הציבורית (transitObject.ticketLeg.transitTerminusName).
customTicketNumberLabel

object (LocalizedString)

תווית בהתאמה אישית לשימוש בערך של מספר הכרטיס (transitObject.ticketNumber).
customRouteRestrictionsLabel

object (LocalizedString)

תווית מותאמת אישית לשימוש בערך של מגבלות המסלול (transitObject.ticketRestrictions.routeRestrictions).
customRouteRestrictionsDetailsLabel

object (LocalizedString)

תווית מותאמת אישית לשימוש בערך הפרטים של הגבלות המסלול (transitObject.ticketRestrictions.routeRestrictionsDetails).
customTimeRestrictionsLabel

object (LocalizedString)

תווית מותאמת אישית לשימוש בערך הפרטים של הגבלות הזמן (transitObject.ticketRestrictions.timeRestrictions).
customOtherRestrictionsLabel

object (LocalizedString)

תווית מותאמת אישית לשימוש בערך של המגבלות האחרות (transitObject.ticketRestrictions.otherRestrictions).
customPurchaseReceiptNumberLabel

object (LocalizedString)

תווית מותאמת אישית לשימוש בערך של מספר הקבלה על הרכישה (transitObject.purchaseDetails.purchaseReceiptNumber).
customConfirmationCodeLabel

object (LocalizedString)

תווית בהתאמה אישית לשימוש בערך של קוד האישור (transitObject.purchaseDetails.confirmationCode).
customPurchaseFaceValueLabel

object (LocalizedString)

תווית מותאמת אישית לשימוש בערך הנקוב של הרכישה (transitObject.purchaseDetails.ticketCost.faceValue).
customPurchasePriceLabel

object (LocalizedString)

תווית מותאמת אישית לשימוש בערך של מחיר הרכישה (transitObject.purchaseDetails.ticketCost.purchasePrice).
customDiscountMessageLabel

object (LocalizedString)

תווית מותאמת אישית לשימוש בערך ההודעה על ההנחה על נסיעות (transitObject.purchaseDetails.ticketCost.discountMessage).
customCarriageLabel

object (LocalizedString)

תווית מותאמת אישית לשימוש בערך לתחילת השורה (transitObject.ticketLeg.carriage).
customSeatLabel

object (LocalizedString)

תווית בהתאמה אישית לשימוש בערך של מיקום המושב (transitObject.ticketLeg.ticketSeat.seat).
customCoachLabel

object (LocalizedString)

תווית מותאמת אישית לשימוש בערך המאמן (transitObject.ticketLeg.ticketSeat.coach).
customPlatformLabel

object (LocalizedString)

תווית מותאמת אישית לשימוש בערך של פלטפורמת העלייה למטוס (transitObject.ticketLeg.platform).
customZoneLabel

object (LocalizedString)

תווית בהתאמה אישית לשימוש בערך של אזור העלייה למטוס (transitObject.ticketLeg.zone).
customFareClassLabel

object (LocalizedString)

תווית מותאמת אישית לשימוש בערך של סיווג התעריף (transitObject.ticketLeg.ticketSeat.fareClass).
customConcessionCategoryLabel

object (LocalizedString)

תווית בהתאמה אישית לשימוש בערך של קטגוריית ההנחה בתחבורה הציבורית (transitObject.concessionCategory).
customFareNameLabel

object (LocalizedString)

תווית מותאמת אישית לשימוש בערך השם של מחיר הנסיעה בתחבורה הציבורית (transitObject.ticketLeg.fareName).
classTemplateInfo

object (ClassTemplateInfo)

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

boolean

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

string

חובה. המזהה הייחודי של הכיתה. המזהה הזה חייב להיות ייחודי בכל המחלקות של המנפיק. הערך צריך להיות בפורמט issuer ID.identifier, כאשר המזהה הראשון מונפק על ידי Google והשני נבחר על ידכם. המזהה הייחודי צריך לכלול רק תווים אלפאנומריים, '.', '_' או '-'.
version
(deprecated)

string (int64 format)

הוצא משימוש
issuerName

string

חובה. שם המנפיק. האורך המקסימלי המומלץ הוא 20 תווים, כדי שהמחרוזת תוצג במלואה במסכים קטנים יותר.
messages[]

object (Message)

מערך של הודעות שמוצגות באפליקציה. כל המשתמשים באובייקט הזה יקבלו את ההודעות המשויכות אליו. המספר המקסימלי של השדות האלה הוא 10.
allowMultipleUsersPerObject
(deprecated)

boolean

הוצא משימוש. במקום זאת, אתם צריכים להשתמש ב-multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

ה-URI של דף הבית של האפליקציה. אכלוס ה-URI בשדה הזה מוביל לאותה התנהגות כמו אכלוס URI ב-linkModuleData (כשאובייקט עובר עיבוד, קישור לדף הבית מוצג באופן שבדרך כלל נחשב כ-LinkModuleData של האובייקט).
locations[]
(deprecated)

object (LatLongPoint)

הערה: השדה הזה לא נתמך כרגע להפעלת התראות גיאוגרפיות.
reviewStatus

enum (ReviewStatus)

חובה. הסטטוס של הכיתה. אפשר להגדיר את השדה הזה לערך draft או underReview באמצעות קריאות ה-API insert,‏ patch או update. אחרי שסטטוס הבדיקה משתנה מ-draft, אי אפשר לשנות אותו חזרה ל-draft.

צריך להשאיר את השדה הזה בשדה draft כשהכיתה בתהליך פיתוח. אי אפשר להשתמש במחלקה draft כדי ליצור אובייקטים.

צריך להגדיר את השדה הזה ל-underReview כשהקלאס מוכן לשימוש. הפלטפורמה תגדיר את השדה הזה באופן אוטומטי לערך approved ואפשר יהיה להשתמש בו באופן מיידי כדי ליצור או להעביר אובייקטים.

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

object (Review)

התגובות לבדיקה שהוגדרו על ידי הפלטפורמה כשכיתה מסומנת כ-approved או כ-rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

הוצא משימוש. במקומו צריך להשתמש ב-textModulesData.
imageModulesData[]

object (ImageModuleData)

נתוני מודול התמונה. המספר המקסימלי של השדות האלה שמוצג הוא 1 ברמת האובייקט ו-1 ברמת אובייקט המחלקה.
textModulesData[]

object (TextModuleData)

נתונים של מודול הטקסט. אם גם נתוני מודול הטקסט מוגדרים במחלקה, שניהם יוצגו. מספר השדות המקסימלי שמוצג הוא 10 מהאובייקט ו-10 מהמחלקה.
redemptionIssuers[]

string (int64 format)

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

כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר גם את השדות enableSmartTap ו-smartTapRedemptionLevel ברמת האובייקט.
countryCode

string

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

object (Image)

תמונה אופציונלית של באנר שמוצגת בחזית הכרטיס. אם לא תהיה כותרת, לא יוצג דבר. התמונה תוצג ברוחב של 100%.
wordMark
(deprecated)

object (Image)

הוצא משימוש.
enableSmartTap

boolean

מזהה אם הכיתה הזו תומכת בהקשה חכמה. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר גם את השדות redemptionIssuers ו-smartTapRedemptionLevel ברמת האובייקט.
hexBackgroundColor

string

צבע הרקע של הכרטיס. אם לא מגדירים את הצבע הדומיננטי של התמונה הראשית (Hero), משתמשים בתמונה הראשית (Hero) אם לא הגדרתם את הצבע הדומיננטי של הלוגו. הפורמט הוא #rrggbb, כאשר rrggbb הוא טריופל RGB ב-hex, למשל #ffcc00. אפשר גם להשתמש בגרסה המקוצרת של משולש ה-RGB שהיא #rgb, למשל #fc0.
localizedIssuerName

object (LocalizedString)

מחרוזות מתורגמות של השדה issuerName. האורך המקסימלי המומלץ הוא 20 תווים, כדי שהמחרוזת תוצג במלואה במסכים קטנים יותר.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

מזהה אם מספר משתמשים ומכשירים ישמרו את אותו אובייקט שמפנה למחלקה הזו.
callbackOptions

object (CallbackOptions)

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

object (SecurityAnimation)

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

object (ActivationOptions)

אפשרויות ההפעלה של כרטיס שניתן להפעיל.
viewUnlockRequirement

enum (ViewUnlockRequirement)

הצגת אפשרויות לגבי דרישות ביטול הנעילה של הכרטיס לתחבורה הציבורית.
notifyPreference

enum (NotificationSettingsForUpdates)

אם עדכוני שדות של הכיתה הזו יפעילו התראות או לא. אם הערך שמוגדר הוא NOTIFY, ננסה לשלוח למשתמשים התראה על עדכון שדות. ההתראות האלה יישלחו למשתמשים רק אם השדה נכלל ברשימת ההיתרים. אם הערך מוגדר כ-DO_NOT_NOTIFY או כ-NOTIFICATION_SETTINGS_UNSPECIFIED, לא תופעל התראה. ההגדרה הזו זמנית וצריך להגדיר אותה בכל בקשת PATCH או עדכון, אחרת לא תופעל התראה.
valueAddedModuleData[]

object (ValueAddedModuleData)

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

TransitType

טיפוסים בני מנייה (enum)
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

כינוי קודם של BUS. הוצא משימוש.
RAIL
rail

כינוי קודם של RAIL. הוצא משימוש.
TRAM
tram

כינוי מדור קודם של TRAM. הוצא משימוש.
FERRY
ferry

כינוי מדור קודם של FERRY. הוצא משימוש.
OTHER
other

כינוי מדור קודם של OTHER. הוצא משימוש.

ActivationOptions

אפשרויות הפעלה לכיתה

ייצוג ב-JSON 
{
  "activationUrl": string,
  "allowReactivation": boolean
}
שדות
activationUrl

string

כתובת URL מסוג HTTPS שתומכת בסמינטיקה של REST. ישמש לבקשת הפעלה מהשותפים עבור פריט בעל ערך נתון, שהמשתמשים הפעילו.
allowReactivation

boolean

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

שיטות

addmessage

 הוספת הודעה לכיתה התעבורה שמופיעה במזהה הכיתה הנתון.

get

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

insert

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

list

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

patch

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

update

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