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)
  }
}
الحقول
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 في linkModuleData (عند عرض كائن، يظهر رابط إلى الصفحة الرئيسية في ما يُعرَف عادةً باسم قسم 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) وهو رقم rgb، مثل #fc0.

localizedIssuerName

object (LocalizedString)

سلاسل مُترجَمة لـ providerName الحد الأقصى المقترَح للطول هو 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

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