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)
  }
}
שדות
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 ב- linksModuleData (כשאובייקט עובר עיבוד, מוצג קישור לדף הבית במה שנחשב בדרך כלל כמקטע linksModuleData של האובייקט).
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)

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

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

string

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

object (Image)

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

object (Image)

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

boolean

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

string

צבע הרקע של הכרטיס. אם לא מגדירים את הצבע הדומיננטי של התמונה הראשית, ואם לא מוגדרת תמונה ראשית, נעשה שימוש בצבע הדומיננטי של הלוגו. הפורמט הוא #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

טיפוסים בני מנייה (enums)
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

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

שיטות

addmessage

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

get

 מחזירה את מחלקת התחבורה הציבורית עם מזהה המחלקה הנתון.

insert

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

list

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

patch

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

update

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