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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
الحقول
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 (عند عرض كائن، يظهر رابط إلى الصفحة الرئيسية فيما يُنظر إليه عادةً على أنّه قسم linkModuleData في الكائن).

locations[]

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)

بيانات وحدة الصورة الحدّ الأقصى لعدد هذه الحقول المعروضة هو 1 من مستوى العنصر و1 لمستوى عنصر الفئة.

textModulesData[]

object (TextModuleData)

بيانات الوحدة النصية. وإذا تم تحديد بيانات الوحدة النصية أيضًا في الفئة، سيتم عرض كلتيهما. الحد الأقصى لعدد هذه الحقول المعروضة هو 10 حقول من الكائن و10 من الفئة.

redemptionIssuers[]

string (int64 format)

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

يجب أيضًا إعداد الحقلَين enableSmartTap وsmartTapRedemptionLevel على مستوى العنصر بشكلٍ صحيح لكي تكون البطاقة متوافقة مع ميزة "الدفع الذكي".

countryCode

string

رمز البلد المستخدَم لعرض بلد البطاقة (عندما لا يكون المستخدم مقيمًا في ذلك البلد)، بالإضافة إلى عرض محتوى مترجَم عندما لا يكون المحتوى متاحًا بلغة المستخدم

heroImage

object (Image)

صورة بانر اختيارية معروضة في الجهة الأمامية من البطاقة. وفي حال عدم توفّرها، لن يتم عرض أي شيء. سيتم عرض الصورة بنسبة عرض تبلغ 100%.

wordMark
(deprecated)

object (Image)

تمّ الإيقاف.

enableSmartTap

boolean

تحدِّد ما إذا كانت هذه الفئة تتيح الدفع الذكي. يجب أيضًا إعداد الحقلَين redemptionIssuers وsmartTapRedemptionLevel على مستوى العنصر بشكلٍ صحيح لكي تكون البطاقة متوافقة مع ميزة "الدفع الذكي".

hexBackgroundColor

string

لون خلفية البطاقة إذا لم يتم تعيين اللون السائد لصورة الجزء الرئيسي، وإذا لم يتم تعيين صورة الجزء الرئيسي، فسيتم استخدام اللون السائد في الشعار. التنسيق هو رقم rrggbb، حيث يكون rrggbb عبارة عن ثلاثي بنموذج أحمر أخضر أزرق سداسي، مثل #ffcc00. يمكنك أيضًا استخدام النسخة المختصرة للنموذج الثلاثي أحمر أخضر أزرق، وهو رقم rgb، مثل #fc0.

localizedIssuerName

object (LocalizedString)

سلاسل مترجمة لـ publisherName يبلغ الحد الأقصى المقترَح للطول 20 حرفًا لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

securityAnimation

object (SecurityAnimation)

معلومات اختيارية حول الحركة الأمنية. في حال ضبط هذا الإعداد، ستظهر صورة متحركة أمنية على تفاصيل البطاقة.

activationOptions

object (ActivationOptions)

خيارات تفعيل تذكرة قابلة للتفعيل

viewUnlockRequirement

enum (ViewUnlockRequirement)

الاطّلاع على خيارات "متطلبات فتح القفل" الخاصة بتذكرة النقل العام

TransitType

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

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

الطُرق

addmessage

يضيف هذا الخيار رسالة إلى فئة النقل العام التي يشير إليها رقم تعريف الفئة.

get

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

insert

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

list

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

patch

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

update

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