- المورد: TransitObject
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
- PurchaseDetails
- TicketCost
- TicketLeg
- TicketSeat
- FareClass
- TripType
- ActivationStatus
- الولاية
- DeviceContext
- الطُرق
المورد: TransitObject
تمثيل JSON |
---|
{ "classReference": { object ( |
الحقول | |
---|---|
classReference |
نسخة من الحقول المكتسَبة من الفئة الرئيسية. يتم استرداد هذه الحقول أثناء GET. |
ticketNumber |
رقم التذكرة هذا معرّف فريد للتذكرة في نظام شركة النقل العام. |
passengerType |
عدد الركاب. |
passengerNames |
أسماء الركاب التي تم تعيين التذكرة لهم. يهدف الحقل |
tripId |
يتم استخدام هذا المعرّف لتجميع التذاكر معًا إذا كان المستخدم قد حفظ عدة تذاكر للرحلة نفسها. |
ticketStatus |
حالة التذكرة. وبالنسبة إلى الحالات التي تؤثر في العرض، استخدِم الحقل |
customTicketStatus |
حالة مخصّصة لاستخدامها مع قيمة حالة التذكرة عندما لا يوفر |
concessionCategory |
تمثّل هذه السمة فئة الامتياز للتذكرة. |
customConcessionCategory |
تشير هذه السمة إلى فئة امتياز مخصّصة يمكن استخدامها عندما لا توفّر السمة |
ticketRestrictions |
معلومات عن نوع القيود المفروضة على استخدام هذه التذكرة. على سبيل المثال، يمكنك تحديد أيام الأسبوع التي يجب استخدامها فيها أو المسارات المسموح بها. |
purchaseDetails |
تفاصيل شراء هذه التذكرة |
ticketLeg |
تحتوي محطة تذكرة واحدة على معلومات المغادرة والوصول، بالإضافة إلى معلومات صعود الطائرة والمقاعد. إذا أردت تحديد أكثر من ساق واحدة، استخدِم الحقل |
ticketLegs[] |
يمكن أن تحتوي كل تذكرة على ساق واحدة أو أكثر. وتحتوي كل محطة على معلومات المغادرة والوصول، بالإضافة إلى معلومات عن صعود الطائرة والمقاعد. إذا تم تحديد رجل واحدة فقط، استخدِم الحقل |
hexBackgroundColor |
لون خلفية البطاقة إذا لم يتم تعيين اللون السائد لصورة الجزء الرئيسي، وإذا لم يتم تعيين صورة الجزء الرئيسي، فسيتم استخدام اللون السائد للشعار. التنسيق هو #rrggbb حيث يكون rrggbb ثلاثي الأبعاد بنموذج أحمر أخضر أزرق، مثل |
tripType |
مطلوبة. نوع الرحلة الذي يمثله عنصر النقل العام هذا. تُستخدَم لتحديد عنوان البطاقة و/أو الرمز المطلوب استخدامه بين نقطة الانطلاق والوجهة. |
id |
مطلوبة. المعرّف الفريد لأحد العناصر. ويجب أن يكون هذا المعرّف فريدًا على مستوى كل العناصر التي تقدّمها جهة الإصدار. يجب أن تتبع هذه القيمة التنسيق issuer ID.identifier حيث تُصدر Google القيمة الأولى وتختار أنت الرقم الثاني. يجب أن لا يتضمن المعرّف الفريد سوى أحرف أبجدية رقمية أو "." أو "_" أو "-". |
classId |
مطلوبة. الفئة المرتبطة بهذا الكائن. ويجب أن تكون الفئة من نوع هذا الكائن نفسه، وأن تكون موجودة بالفعل، وأن تتم الموافقة عليها. يجب أن تكون أرقام تعريف الصفوف بالتنسيق issuer ID.identifier حيث تُصدر Google القيمة الأولى وتختار أنت الرقم الثاني. |
version |
منهي العمل به |
state |
مطلوبة. حالة العنصر يُستخدَم هذا الحقل لتحديد طريقة عرض عنصر في التطبيق. على سبيل المثال، يتم نقل عنصر |
barcode |
نوع الرمز الشريطي وقيمته |
messages[] |
مجموعة من الرسائل المعروضة في التطبيق. سيتلقّى جميع مستخدمي هذا العنصر الرسائل المرتبطة به. الحد الأقصى لعدد هذه الحقول هو 10. |
validTimeInterval |
وستكون الفترة الزمنية لهذا الكائن هي |
locations[] |
ملاحظة: هذا الحقل غير متاح حاليًا لتشغيل إشعارات الموقع الجغرافي. |
hasUsers |
يشير إلى ما إذا كان العنصر يحتوي على مستخدمين. يتم تعيين هذا الحقل بواسطة النظام الأساسي. |
smartTapRedemptionValue |
القيمة التي سيتم إرسالها إلى محطة دفع معتمَدة من خلال "الدفع الذكي" عبر تقنية NFC لهذا العنصر ويجب أيضًا إعداد الحقلَين |
hasLinkedDevice |
ما إذا كان هذا العنصر مرتبطًا حاليًا بجهاز واحد يتم ضبط هذا الحقل من خلال النظام الأساسي عندما يحفظ المستخدم العنصر ويربطه بجهازه. الجهاز مخصّص للاستخدام من قِبل شركاء محدّدين. يمكنك التواصل مع فريق الدعم للحصول على معلومات إضافية. |
disableExpirationNotification |
تشير هذه السمة إلى ما إذا كان يجب إيقاف الإشعارات بشكل صريح. في حال ضبط هذا الحقل على "صحيح" بغض النظر عن الحقل وفي الوقت الحالي، يمكن ضبط هذا الإعداد للعروض فقط. |
infoModuleData |
تمّ الإيقاف. استخدِم textModulesData بدلاً من ذلك. |
imageModulesData[] |
بيانات وحدة الصورة الحد الأقصى لعدد هذه الحقول المعروضة هو 1 من مستوى العنصر و1 لمستوى عنصر الفئة. |
textModulesData[] |
بيانات وحدة النص وإذا تمّ تحديد بيانات الوحدة النصية أيضًا في الفئة، سيتمّ عرض المجموعتَين. الحد الأقصى لعدد هذه الحقول المعروضة هو 10 من العنصر و10 من الفئة. |
linksModuleData |
بيانات وحدة الروابط. إذا تم تحديد بيانات وحدة الروابط أيضًا في الفئة، فسيتم عرض كليهما. |
appLinkData |
رابط اختياري للتطبيق أو الموقع الإلكتروني سيتم عرضه كزر في الجهة الأمامية من البطاقة في حال توفير AppLinkData للعنصر المقابل للفئة فقط، سيتم عرض AppLinkData. |
activationStatus |
حالة التفعيل للعنصر مطلوبة إذا كان الصف يحتوي على مجموعة |
rotatingBarcode |
نوع الرمز الشريطي المتغيّر وقيمته |
deviceContext |
سياق الجهاز المرتبط بالكائن |
heroImage |
صورة بانر اختيارية يتم عرضها على الجزء الأمامي من البطاقة. وفي حال عدم توفّر أي منها، سيتم عرض صورة الجزء الرئيسي للفئة، في حال توفّرها. إذا كانت صورة الجزء الرئيسي للفئة غير موجودة أيضًا، فلن يتم عرض أي شيء. |
groupingInfo |
معلومات تتحكّم في طريقة جمع البطاقات معًا. |
passConstraints |
تمرير قيود العنصر يشمل ذلك الحدّ من استخدام تقنية NFC ولقطات الشاشة. |
PassengerType
عمليات التعداد | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
الاسم المستعار القديم لـ |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
الاسم المستعار القديم لـ |
TicketStatus
عمليات التعداد | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
الاسم المستعار القديم لـ |
REFUNDED |
|
refunded |
الاسم المستعار القديم لـ |
EXCHANGED |
|
exchanged |
الاسم المستعار القديم لـ |
ConcessionCategory
عمليات التعداد | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
الاسم المستعار القديم لـ |
CHILD |
|
child |
الاسم المستعار القديم لـ |
SENIOR |
|
senior |
الاسم المستعار القديم لـ |
TicketRestrictions
تمثيل JSON |
---|
{ "routeRestrictions": { object ( |
الحقول | |
---|---|
routeRestrictions |
القيود المفروضة على المسارات التي قد يتم استخدامها. على سبيل المثال، قد تكون هذه السلسلة "قطارات CrossCountry محجوزة فقط". |
routeRestrictionsDetails |
مزيد من التفاصيل حول |
timeRestrictions |
القيود المفروضة على أوقات استخدام هذه التذكرة |
otherRestrictions |
القيود الإضافية التي لا تندرج ضمن فئة "المسار" أو "الوقت". |
PurchaseDetails
تمثيل JSON |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
الحقول | |
---|---|
purchaseReceiptNumber |
رقم الإيصال أو المعرّف لتتبّع عملية شراء التذكرة من خلال النص الأساسي الذي يبيعها للتذكرة. |
purchaseDateTime |
تاريخ/وقت شراء التذكرة هذا هو التاريخ/الوقت بتنسيق ISO 8601 الممتد، مع إزاحة أو بدون. يمكن تحديد الوقت بدقة تصل إلى نانو ثانية. يمكن تحديد الإزاحة بدقة بالثواني (على الرغم من أن ثواني الإزاحة ليست جزءًا من ISO 8601). مثلاً: بعد 12 نيسان (أبريل) 1985، ستستغرق عملية ستكون المدة ستكون قيمة السمة قد لا تتوفّر بعض الميزات المنسّقة بدون معلومات الإزاحة. |
accountId |
رقم تعريف الحساب المُستخدَم لشراء التذكرة. |
confirmationCode |
رمز تأكيد عملية الشراء. قد يكون نفس الشيء مع العديد من التذاكر المختلفة ويتم استخدامه لتجميع التذاكر معًا. |
ticketCost |
تكلفة التذكرة. |
TicketCost
تمثيل JSON |
---|
{ "faceValue": { object ( |
الحقول | |
---|---|
faceValue |
القيمة الاسمية للتذكرة. |
purchasePrice |
سعر الشراء الفعلي للتذكرة، بعد خصم الضريبة و/أو الخصومات. |
discountMessage |
رسالة تصف أي نوع من الخصم الذي تم تطبيقه. |
TicketLeg
تمثيل JSON |
---|
{ "originStationCode": string, "originName": { object ( |
الحقول | |
---|---|
originStationCode |
رمز محطة المصدر يجب توفير هذه السمة في حال استخدام السمة |
originName |
اسم محطة المنشأ. يجب توفير هذه السمة في حال استخدام السمة |
destinationStationCode |
رمز محطة الوجهة. |
destinationName |
اسم الوجهة |
departureDateTime |
تاريخ/وقت المغادرة يجب تنفيذ هذا الإجراء في حال عدم وجود فاصل زمني صالح على عنصر النقل العام. هذا هو التاريخ/الوقت بتنسيق ISO 8601 الممتد، مع إزاحة أو بدون. يمكن تحديد الوقت بدقة تصل إلى نانو ثانية. يمكن تحديد الإزاحة بدقة بالثواني (على الرغم من أن ثواني الإزاحة ليست جزءًا من ISO 8601). مثلاً: بعد 12 نيسان (أبريل) 1985، ستستغرق عملية ستكون المدة ستكون قيمة السمة ويتم اعتبار الجزء من التاريخ/الوقت بدون الإزاحة هو "التاريخ/الوقت المحلي". يجب إدخال التاريخ/الوقت المحلي في محطة المنشأ. على سبيل المثال، إذا كانت موعد المغادرة يقع في الساعة 20 من يوم 5 حزيران (يونيو) 2018 في محطة المصدر، يجب أن يكون جزء التاريخ/الوقت المحلي هو قد لا تتوفّر بعض الميزات المنسّقة بدون معلومات الإزاحة. |
arrivalDateTime |
تاريخ/وقت الوصول هذا هو التاريخ/الوقت بتنسيق ISO 8601 الممتد، مع إزاحة أو بدون. يمكن تحديد الوقت بدقة تصل إلى نانو ثانية. يمكن تحديد الإزاحة بدقة بالثواني (على الرغم من أن ثواني الإزاحة ليست جزءًا من ISO 8601). مثلاً: بعد 12 نيسان (أبريل) 1985، ستستغرق عملية ستكون المدة ستكون قيمة السمة ويتم اعتبار الجزء من التاريخ/الوقت بدون الإزاحة هو "التاريخ/الوقت المحلي". يجب إدخال التاريخ أو الوقت المحلي في محطة الوجهة. على سبيل المثال، إذا كانت الفعالية ستقام في الساعة 20 من يوم 5 حزيران (يونيو) 2018 في المحطة الوجهة، يجب أن يكون جزء التاريخ/الوقت المحلي هو قد لا تتوفّر بعض الميزات المنسّقة بدون معلومات الإزاحة. |
fareName |
وصف/اسم مختصر للسعر لهذه المرحلة من السفر. على سبيل المثال "استخدام فردي في أي وقت". |
carriage |
اسم/رقم القطار أو السفينة الذي يجب أن يركب فيه حامل البطاقة. |
platform |
المنصة أو البوابة التي يمكن للراكب من خلالها الصعود إلى العربة. |
zone |
تشير هذه السمة إلى منطقة صعود الطائرة على المنصة. |
ticketSeat |
المقعد المحجوز للركاب إذا تم تحديد أكثر من مقعد واحد، استخدِم الحقل |
ticketSeats[] |
المقعد المحجوز للركاب إذا تم تحديد مقعد واحد فقط، استخدِم الحقل |
transitOperatorName |
اسم شركة النقل العام التي تدير مرحلة الرحلة هذه. |
transitTerminusName |
المحطة النهائية أو وجهة القطار أو الحافلة أو غيرها |
TicketSeat
تمثيل JSON |
---|
{ "fareClass": enum ( |
الحقول | |
---|---|
fareClass |
فئة سعر المقعد الذي تم حجز تذاكر له. |
customFareClass |
فئة أسعار مخصّصة يجب استخدامها في حال عدم سريان |
coach |
تمثّل هذه السمة معرّف عربة القطار أو الحافلة التي يوجد فيها المقعد الذي يتضمّن تذاكر. على سبيل المثال: "10" |
seat |
تمثّل هذه السمة معرّف الموقع الجغرافي الذي يقع فيه المقعد الذي تم حجز تذاكره. على سبيل المثال: "42". وفي حال عدم توفُّر معرّف محدّد، استخدِم |
seatAssignment |
تعيين مقعد الراكب على سبيل المثال: "لا يوجد مقعد محدد". يمكن استخدامها عند عدم توفّر معرّف معيّن لاستخدامه في |
FareClass
عمليات التعداد | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
الاسم المستعار القديم لـ |
FIRST |
|
first |
الاسم المستعار القديم لـ |
BUSINESS |
|
business |
الاسم المستعار القديم لـ |
TripType
عمليات التعداد | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
الاسم المستعار القديم لـ |
ONE_WAY |
|
oneWay |
الاسم المستعار القديم لـ |
ActivationStatus
حالة تفعيل العنصر يتضمّن هذا الحقل حالة التفعيل إذا كانت القيمة تدعم التفعيل.
تمثيل JSON |
---|
{
"state": enum ( |
الحقول | |
---|---|
state |
|
الحالة
عمليات التعداد | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
غير مفعّل، هذه هي الحالة التلقائية |
not_activated |
الاسم المستعار القديم لـ |
ACTIVATED |
مفعَّلة |
activated |
الاسم المستعار القديم لـ |
DeviceContext
سياق الجهاز المرتبط بالكائن
تمثيل JSON |
---|
{ "deviceToken": string } |
الحقول | |
---|---|
deviceToken |
في حال ضبط السياسة، لن يتم إرجاع معلومات تحصيل القيمة إلا إلى الجهاز المحدّد بعد تفعيل العنصر. ويجب عدم استخدامه كمعرّف ثابت لتتبّع جهاز المستخدم. يمكن أن تتغير عملية التفعيل بين البطاقات المختلفة للجهاز نفسه أو حتى على مستوى عمليات التفعيل المختلفة للجهاز نفسه. عند ضبط هذا الإعداد، يجب على المتصلين أيضًا ضبط hasLinkedDevice على العنصر الذي يتم تفعيله. |
الطُرق |
|
---|---|
|
يضيف هذا الإعداد رسالة إلى عنصر النقل العام المُشار إليه باستخدام رقم تعريف العنصر. |
|
لعرض عنصر النقل العام باستخدام رقم تعريف الكائن المحدّد. |
|
لإدراج عنصر نقل عام برقم التعريف والخصائص المقدَّمة. |
|
تعرض قائمة بكل عناصر النقل العام لمعرّف جهة إصدار معيّن. |
|
تُعدِّل عنصر النقل العام المُشار إليه في رقم تعريف العنصر المحدّد. |
|
تُعدِّل عنصر النقل العام المُشار إليه في رقم تعريف العنصر المحدّد. |