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)

معرّف الموارد المنتظم للصفحة الرئيسية لتطبيقك. يؤدي ملء معرّف الموارد المنتظم في هذا الحقل إلى السلوك نفسه تمامًا الذي يؤدي إليه ملء معرّف الموارد المنتظم في linksModuleData (عند عرض عنصر، يتم عرض رابط إلى الصفحة الرئيسية في ما يُعتبر عادةً قسم linksModuleData من العنصر).
locations[]
(deprecated)

object (LatLongPoint)

ملاحظة: لا يمكن حاليًا استخدام هذا الحقل لتشغيل الإشعارات الجغرافية.
reviewStatus

enum (ReviewStatus)

مطلوب. حالة الفئة. يمكن ضبط هذا الحقل على draft أو underReview باستخدام طلبات بيانات الإدراج أو التعديل أو التحديث من واجهة برمجة التطبيقات. بعد تغيير حالة المراجعة من draft، قد لا يمكن تغييرها مرة أخرى إلى draft.

يجب ضبط هذا الحقل على draft عندما يكون الصف قيد التطوير. لا يمكن استخدام فئة draft لإنشاء أي عنصر.

يجب ضبط هذا الحقل على underReview عندما تعتقد أنّ الفئة جاهزة للاستخدام. ستضبط المنصة هذا الحقل تلقائيًا على approved ويمكن استخدامه على الفور لإنشاء عناصر أو نقلها.

عند تعديل فئة approved، يجب مواصلة ضبط هذا الحقل على underReview.
review

object (Review)

تعليقات المراجعة التي تحدّدها المنصة عند وضع علامة approved أو rejected على الصف
infoModuleData
(deprecated)

object (InfoModuleData)

تمّ الإيقاف. استخدِم textModulesData بدلاً من ذلك.
imageModulesData[]

object (ImageModuleData)

بيانات وحدة الصور الحد الأقصى لعدد هذه الحقول المعروضة هو حقل واحد من مستوى الكائن وحقل واحد من مستوى كائن الفئة.
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)

سلاسل مُترجَمة لسمة issuerName الحد الأقصى المقترَح هو 20 حرفًا لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

لتحديد ما إذا كان سيتم حفظ العنصر نفسه الذي يشير إلى هذه الفئة من قِبل مستخدمين وأجهزة متعددة.
callbackOptions

object (CallbackOptions)

خيارات طلب معاودة الاتصال التي سيتم استخدامها للاتصال بالمُصدِر عند كل حفظ أو حذف عنصر من هذا النوع من قِبل المستخدم النهائي. جميع عناصر هذه الفئة مؤهَّلة للاتصال الخلفي.
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

عمليات التعداد
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

علامة للسماح للمستخدمين بإجراء مكالمة التفعيل من جهاز مختلف يتيح ذلك للعملاء عرض زر التفعيل مفعّلاً حتى إذا كانت حالة التفعيل هي "مفعّل" ولكن الجهاز المطلوب مختلف عن الجهاز الحالي.

الطُرق

addmessage

 تُضيف رسالة إلى فئة النقل العام المُشار إليها بمعرّف الفئة المحدّد.

get

 لعرض فئة النقل العام التي تحمل معرّف الفئة المحدّد

insert

 تُدرج فئة نقل عام باستخدام رقم التعريف والخصائص المحدّدة.

list

 تعرِض هذه الدالة قائمة بجميع فئات النقل العام لمعرّف جهة إصدار معيّن.

patch

 تعديل فئة النقل العام المُشار إليها برقم تعريف الفئة المحدَّد

update

 تعديل فئة النقل العام المُشار إليها برقم تعريف الفئة المحدَّد