- المرجع: 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 مجموعة سداسية عشرية من قيم RGB، مثل |
tripType |
مطلوب. نوع الرحلة التي يمثّلها عنصر النقل هذا تُستخدَم لتحديد عنوان البطاقة و/أو الرمز الذي سيتم استخدامه بين نقطة الانطلاق والوجهة. |
id |
مطلوب. المعرّف الفريد للعنصر يجب أن يكون هذا المعرّف فريدًا في جميع العناصر الصادرة عن جهة إصدار. يجب أن تكون هذه القيمة بالتنسيق issuer ID.identifier حيث يتم إصدار الأول من Google ويتم اختيار الثاني من قِبلك. يجب أن يتضمّن المعرّف الفريد أحرفًا أبجدية رقمية فقط أو النقطة أو الشرطة السفلية أو الواصلة. |
classId |
مطلوب. الصفّ المرتبط بهذا الكائن يجب أن يكون الصف من النوع نفسه مثل هذا العنصر، ويجب أن يكون متوفّرًا، ويجب أن تتم الموافقة عليه. يجب أن تتّبع أرقام تعريف الصفوف التنسيق issuer ID.identifier حيث يتم إصدار الأول من Google ويتم اختيار الثاني من قِبلك. |
version |
منهي العمل به |
state |
مطلوب. حالة العنصر يُستخدَم هذا الحقل لتحديد كيفية عرض عنصر في التطبيق. على سبيل المثال، يتم نقل عنصر |
barcode |
نوع الرمز الشريطي وقيمته |
messages[] |
صفيف من الرسائل المعروضة في التطبيق. سيتلقّى جميع مستخدمي هذا العنصر الرسائل المرتبطة به. الحدّ الأقصى لعدد هذه الحقول هو 10. |
validTimeInterval |
الفترة الزمنية التي سيكون فيها هذا الكائن |
locations[] |
ملاحظة: لا يمكن حاليًا استخدام هذا الحقل لتشغيل الإشعارات الجغرافية. |
hasUsers |
تشير إلى ما إذا كان العنصر يتضمّن مستخدمين. تضبط المنصة هذا الحقل. |
smartTapRedemptionValue |
القيمة التي سيتم إرسالها إلى محطة دفع معتمَدة من Smart Tap عبر NFC لهذا العنصر. يجب أيضًا ضبط الحقلين |
hasLinkedDevice |
ما إذا كان هذا العنصر مرتبطًا حاليًا بجهاز واحد يضبط النظام الأساسي هذا الحقل عندما يحفظ المستخدم العنصر ويربطه بجهازه. مخصّص للاستخدام من قِبل شركاء محدّدين. يُرجى التواصل مع فريق الدعم للحصول على معلومات إضافية. |
disableExpirationNotification |
يشير إلى ما إذا كان يجب إيقاف الإشعارات صراحةً. في حال ضبط هذا الحقل على "صحيح"، سيتم حظر إرسال إشعارات انتهاء الصلاحية إلى المستخدم بغض النظر عن حقل لا يمكن حاليًا ضبط هذه القيمة إلا للعروض. |
infoModuleData |
تمّ الإيقاف. استخدِم textModulesData بدلاً من ذلك. |
imageModulesData[] |
بيانات وحدة الصور الحد الأقصى لعدد هذه الحقول المعروضة هو حقل واحد من مستوى الكائن وحقل واحد من مستوى كائن الفئة. |
textModulesData[] |
بيانات وحدة النصوص إذا تمّ أيضًا تحديد بيانات وحدة النص في الفئة، سيتم عرض كليهما. الحد الأقصى لعدد هذه الحقول المعروضة هو 10 حقول من العنصر و10 حقول من الفئة. |
linksModuleData |
ربط بيانات الوحدة إذا تمّ أيضًا تحديد بيانات وحدة الروابط في الصف، سيتم عرض كليهما. |
appLinkData |
رابط اختياري للتطبيق أو الموقع الإلكتروني سيتم عرضه كزر على الجهة الأمامية من البطاقة في حال توفّر AppLinkData للفئة المقابلة، سيتم عرض عنصر AppLinkData فقط. |
activationStatus |
حالة التفعيل للعنصر. مطلوبة إذا تم ضبط |
rotatingBarcode |
نوع الرمز الشريطي المتغيّر وقيمته |
deviceContext |
سياق الجهاز المرتبط بالعنصر |
heroImage |
صورة بانر اختيارية تظهر على واجهة البطاقة في حال عدم توفّر أيّ منها، سيتم عرض صورة رئيسية للفئة، إذا كانت متوفّرة. إذا لم تكن صورة العرض للصف متوفّرة أيضًا، لن يتم عرض أي محتوى. |
groupingInfo |
المعلومات التي تتحكّم في كيفية تجميع البطاقات معًا |
passConstraints |
نقْل القيود للعنصر ويشمل ذلك الحدّ من سلوكيات NFC ولقطات الشاشة. |
saveRestrictions |
القيود المفروضة على العنصر التي يجب التحقّق منها قبل أن يحاول المستخدم حفظ البطاقة يُرجى العلم أنّ هذه القيود لن يتم تطبيقها إلا خلال وقت الحفظ. إذا تغيّرت القيود بعد أن يحفظ المستخدم البطاقة، لن يتم تطبيق القيود الجديدة على بطاقة سبق حفظها. |
linkedObjectIds[] |
تمثل linkedObjectIds قائمة بعناصر أخرى، مثل تذكرة حضور فعالية أو بطاقة ولاء أو عرض أو بطاقة عامة أو بطاقة هدايا أو بطاقة نقل عام أو بطاقة صعود طائرة، والتي يجب إرفاقها تلقائيًا بعنصر النقل العام هذا. إذا حفظ مستخدم بطاقة النقل العام هذه، سيتم تلقائيًا إرسال معرّفات linkedObjectIds هذه إلى محفظة المستخدم (ما لم يوقف الإعداد لتلقّي البطاقات المرتبطة هذه). تأكَّد من أنّه سبق إدراج العناصر المتوفّرة في linkedObjectIds، وإلا ستتعذّر عمليات الاستدعاء. بعد ربط العناصر، لا يمكن إلغاء ربطها. لا يمكنك ربط عناصر تابعة لمُصدِر آخر. هناك حدّ أقصى لعدد العناصر التي يمكن ربطها بعنصر واحد. بعد بلوغ الحدّ الأقصى، سيتم تجاهل الكائنات الجديدة المرتبطة في المكالمة بدون إشعار. يجب أن تتّبع معرّفات العناصر التنسيق issuer ID.identifier حيث تُصدر Google المعرّف الأول ويمكنك اختيار المعرّف الثاني. |
notifyPreference |
ما إذا كان يجب أن تؤدي تعديلات الحقل على هذا العنصر إلى إرسال إشعارات أم لا عند ضبط القيمة على NOTIFY (إشعار)، سنحاول إرسال إشعار إلى المستخدمين بشأن تعديل الحقل. ولن يتم إرسال هذه الإشعارات إلى المستخدمين إلا إذا كان الحقل جزءًا من قائمة مسموح بها. في حال ضبط القيمة على DO_NOT_NOTIFY أو NOTIFICATION_SETTINGS_UNSPECIFIED، لن يتم تشغيل أي إشعار. هذا الإعداد مؤقت ويجب ضبطه مع كل طلب PATCH أو UPDATE، وإلا لن يتم تشغيل إشعار. |
valueAddedModuleData[] |
بيانات اختيارية لمكوّنات القيمة المضافة عشرة عناصر كحد أقصى على الجسم |
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). على سبيل المثال: سيكون سيكون سيكون بدون معلومات البدء، قد لا تتوفّر بعض الميزات الغنية. |
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). على سبيل المثال: سيكون سيكون سيكون يُعتبر الجزء من التاريخ/الوقت بدون المدة الزمنية "التاريخ/الوقت المحلي". يجب أن يكون هذا التاريخ/الوقت هو التاريخ/الوقت المحلي في المحطة الأصلية. على سبيل المثال، إذا كان موعد المغادرة في الساعة 20 من يوم 5 حزيران (يونيو) 2018 في المحطة الأصلية، يجب أن يكون جزء التاريخ/الوقت المحلي بدون معلومات البدء، قد لا تتوفّر بعض الميزات الغنية. |
arrivalDateTime |
تاريخ/وقت الوصول هذا هو تاريخ/وقت بتنسيق ISO 8601 الموسّع، مع أو بدون مدة زمنية. يمكن تحديد الوقت بدقة تصل إلى النانو ثانية. يمكن تحديد البادئات بدقة الثواني (على الرغم من أنّ الثواني في البادئة ليست جزءًا من معيار ISO 8601). على سبيل المثال: سيكون سيكون سيكون يُعتبر الجزء من التاريخ/الوقت بدون المدة الزمنية "التاريخ/الوقت المحلي". يجب أن يكون هذا هو التاريخ أو الوقت المحلي في المحطة المقصودة. على سبيل المثال، إذا حدثت الفعالية في الساعة 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 على العنصر الذي يتم تفعيله. |
الطُرق |
|
---|---|
|
تُضيف رسالة إلى عنصر النقل المُشار إليه بمعرّف العنصر المحدّد. |
|
تعرِض هذه الدالة عنصر النقل الذي يحمل رقم تعريف العنصر المحدّد. |
|
تُدرج عنصرًا للنقل العام باستخدام رقم التعريف والسمات المحدّدة. |
|
تعرِض هذه الدالة قائمة بجميع عناصر النقل لمعرّف جهة إصدار معيّن. |
|
تعديل عنصر النقل المُشار إليه بمعرّف العنصر المحدّد |
|
تعديل عنصر النقل المُشار إليه بمعرّف العنصر المحدّد |