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

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

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

string

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

object (Image)

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

object (Image)

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

boolean

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

string

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

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

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

object (SecurityAnimation)

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

object (ActivationOptions)

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

enum (ViewUnlockRequirement)

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

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

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

TransitType

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

כתובת אימייל חלופית מדור קודם של BUS. הוצא משימוש.
RAIL
rail

כתובת אימייל חלופית מדור קודם של RAIL. הוצא משימוש.
TRAM
tram

כתובת אימייל חלופית מדור קודם של TRAM. הוצא משימוש.
FERRY
ferry

כתובת אימייל חלופית מדור קודם של FERRY. הוצא משימוש.
OTHER
other

כתובת אימייל חלופית מדור קודם של OTHER. הוצא משימוש.

ActivationOptions

ActivationOptions של הכיתה

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

string

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

boolean

דגל שמאפשר למשתמשים לבצע שיחת הפעלה ממכשיר אחר. כך הלקוח יכול להציג את לחצן ההפעלה כפעיל גם אם הערך של activationStatus הוא ACTIVATED אבל המכשיר המבוקש שונה מהמכשיר הנוכחי.

Methods

addmessage

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

get

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

insert

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

list

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

patch

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

update

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