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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
שדות
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[]

object (LatLongPoint)

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

enum (ReviewStatus)

חובה. הסטטוס של הכיתה. אפשר להגדיר את השדה הזה לערך draft או לערך underReview באמצעות הוספה, תיקון או עדכון של קריאות ל-API. אחרי שמצב הבדיקה ישתנה מ-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, למשל #ffcc00. אפשר גם להשתמש בגרסה המקוצרת של משולש ה-RGB שהיא #rgb, למשל #fc0.
localizedIssuerName

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

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

object (SecurityAnimation)

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

object (ActivationOptions)

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

enum (ViewUnlockRequirement)

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

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

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