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)
    }
  ]
}
فیلدها
transit Operator Name

object ( LocalizedString )

نام اپراتور حمل و نقل.

transit Type

enum ( TransitType )

مورد نیاز. نوع حمل و نقلی که این کلاس نشان می دهد، مانند "اتوبوس".

watermark

object ( Image )

تصویر واترمارک برای نمایش در دستگاه کاربر.

language Override

string

اگر این فیلد وجود داشته باشد، بلیط های حمل و نقلی که به دستگاه کاربر ارائه می شود همیشه به این زبان خواهد بود. نشان دهنده برچسب زبان BCP 47 است. مقادیر مثال "en-US"، "en-GB"، "de" یا "de-AT" هستند.

custom Transit Terminus Name Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای مقدار نام پایانه حمل‌ونقل ( transitObject.ticketLeg.transitTerminusName ).

custom Ticket Number Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای مقدار شماره بلیط ( transitObject.ticketNumber ).

custom Route Restrictions Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای مقدار محدودیت مسیر ( transitObject.ticketRestrictions.routeRestrictions ).

custom Route Restrictions Details Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای مقدار جزئیات محدودیت‌های مسیر ( transitObject.ticketRestrictions.routeRestrictionsDetails ).

custom Time Restrictions Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای مقدار جزئیات محدودیت‌های زمانی ( transitObject.ticketRestrictions.timeRestrictions ).

custom Other Restrictions Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای مقدار محدودیت‌های دیگر ( transitObject.ticketRestrictions.otherRestrictions ).

custom Purchase Receipt Number Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای مقدار شماره رسید خرید ( transitObject.purchaseDetails.purchaseReceiptNumber ).

custom Confirmation Code Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای مقدار کد تأیید ( transitObject.purchaseDetails.confirmationCode ).

custom Purchase Face Value Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای ارزش اسمی خرید ( transitObject.purchaseDetails.ticketCost.faceValue ).

custom Purchase Price Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای ارزش قیمت خرید ( transitObject.purchaseDetails.ticketCost.purchasePrice ).

custom Discount Message Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای ارزش پیام تخفیف حمل و نقل ( transitObject.purchaseDetails.ticketCost.discountMessage ).

custom Carriage Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای ارزش حمل ( transitObject.ticketLeg.carriage ).

custom Seat Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای مقدار مکان صندلی ( transitObject.ticketLeg.ticketSeat.seat ).

custom Coach Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای مقدار مربی ( transitObject.ticketLeg.ticketSeat.coach ).

custom Platform Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای مقدار سکوی سوار شدن ( transitObject.ticketLeg.platform ).

custom Zone Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای مقدار منطقه سوار شدن ( transitObject.ticketLeg.zone ).

custom Fare Class Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای مقدار کلاس کرایه ( transitObject.ticketLeg.ticketSeat.fareClass ).

custom Concession Category Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای ارزش دسته امتیاز حمل و نقل ( transitObject.concessionCategory ).

custom Fare Name Label

object ( LocalizedString )

یک برچسب سفارشی برای استفاده برای مقدار نام کرایه حمل‌ونقل ( transitObject.ticketLeg.fareName ).

class Template Info

object ( ClassTemplateInfo )

اطلاعات الگو در مورد نحوه نمایش کلاس. اگر تنظیم نشود، Google به مجموعه ای از فیلدهای پیش فرض برای نمایش بازگشته است.

enable Single Leg Itinerary

boolean

نمایش برنامه سفر تک مرحله ای این کلاس را کنترل می کند. به طور پیش فرض، یک برنامه سفر فقط برای سفرهای چند مرحله ای نمایش داده می شود.

id

string

مورد نیاز. شناسه منحصر به فرد برای یک کلاس. این شناسه باید در همه کلاس‌ها از یک صادرکننده منحصربه‌فرد باشد. این مقدار باید از issuer ID قالب پیروی کند. identifier جایی که اولی توسط Google صادر می شود و دومی توسط شما انتخاب می شود. شناسه منحصر به فرد شما باید فقط شامل کاراکترهای الفبایی، '.'، '_' یا '-' باشد.

version
(deprecated)

string ( int64 format)

منسوخ شده است

issuer Name

string

مورد نیاز. نام صادر کننده. حداکثر طول توصیه شده 20 کاراکتر است تا اطمینان حاصل شود که رشته کامل در صفحه های کوچکتر نمایش داده می شود.

messages[]

object ( Message )

مجموعه ای از پیام ها در برنامه نمایش داده می شود. همه کاربران این شیء پیام های مرتبط با آن را دریافت خواهند کرد. حداکثر تعداد این فیلدها 10 عدد می باشد.

allowMultipleUsersPerObject
(deprecated)

boolean

منسوخ شده است. به جای آن از multipleDevicesAndHoldersAllowedStatus استفاده کنید.

homepage Uri

object ( Uri )

URI صفحه اصلی برنامه شما. پر کردن URI در این فیلد دقیقاً همان رفتار پر کردن یک URI را در linksModuleData انجام می دهد (زمانی که یک شی رندر می شود، پیوندی به صفحه اصلی در قسمتی که معمولاً به عنوان بخش linksModuleData از شی در نظر گرفته می شود نشان داده می شود).

locations[]
(deprecated)

object ( LatLongPoint )

توجه: این فیلد در حال حاضر برای فعال کردن اعلان‌های جغرافیایی پشتیبانی نمی‌شود.

review Status

enum ( ReviewStatus )

مورد نیاز. وضعیت کلاس. با استفاده از درج، وصله یا به‌روزرسانی فراخوان‌های API، می‌توان این فیلد را روی draft یا underReview تنظیم کرد. هنگامی که وضعیت بررسی از draft تغییر کرد، نمی توان آن را به draft تغییر داد.

وقتی کلاس در حال توسعه است، باید این فیلد را برای draft نگه دارید. یک کلاس draft را نمی توان برای ایجاد هر شی استفاده کرد.

زمانی که فکر می کنید کلاس برای استفاده آماده است، باید این فیلد را روی underReview تنظیم کنید. پلتفرم به طور خودکار این فیلد را روی approved تنظیم می کند و می توان بلافاصله از آن برای ایجاد یا انتقال اشیا استفاده کرد.

هنگام به‌روزرسانی کلاسی که قبلاً approved ، باید این فیلد را روی underReview تنظیم کنید.

review

object ( Review )

نظرات مروری که توسط پلتفرم تنظیم می‌شوند، زمانی که یک کلاس approved یا rejected است.

infoModuleData
(deprecated)

object ( InfoModuleData )

منسوخ شده است. به جای آن از textModulesData استفاده کنید.

image Modules Data[]

object ( ImageModuleData )

داده های ماژول تصویر حداکثر تعداد این فیلدهای نمایش داده شده 1 از سطح شی و 1 برای سطح شیء کلاس است.

text Modules Data[]

object ( TextModuleData )

داده های ماژول متنی اگر داده های ماژول متنی نیز روی کلاس تعریف شده باشد، هر دو نمایش داده می شوند. حداکثر تعداد این فیلدهای نمایش داده شده 10 از شی و 10 از کلاس است.

redemption Issuers[]

string ( int64 format)

مشخص می کند کدام صادرکنندگان بازخرید می توانند مجوز را از طریق Smart Tap بازخرید کنند. صادرکنندگان بازخرید با شناسه صادرکننده آنها شناسایی می شوند. صادرکنندگان بازخرید باید حداقل یک کلید Smart Tap پیکربندی شده باشند.

فیلدهای enableSmartTap و سطح شیء smartTapRedemptionLevel نیز باید به درستی تنظیم شوند تا پاس از Smart Tap پشتیبانی کند.

country Code

string

کد کشوری که برای نمایش کشور کارت (زمانی که کاربر در آن کشور نیست) و همچنین برای نمایش محتوای بومی سازی شده زمانی که محتوا در منطقه کاربر در دسترس نیست، استفاده می شود.

hero Image

object ( Image )

تصویر بنر اختیاری در جلوی کارت نمایش داده می شود. اگر هیچ کدام وجود نداشته باشد، چیزی نمایش داده نمی شود. تصویر با عرض 100% نمایش داده می شود.

wordMark
(deprecated)

object ( Image )

منسوخ شده است.

enable Smart Tap

boolean

تشخیص می دهد که آیا این کلاس از Smart Tap پشتیبانی می کند یا خیر. فیلدهای redemptionIssuers و سطح شیء smartTapRedemptionLevel نیز باید به درستی تنظیم شوند تا مجوز از Smart Tap پشتیبانی کند.

hex Background Color

string

رنگ پس زمینه کارت اگر تنظیم نشده باشد از رنگ غالب تصویر قهرمان استفاده می شود و اگر تصویر قهرمان تنظیم نشده باشد از رنگ غالب لوگو استفاده می شود. قالب # rrggbb است که در آن rrggbb یک سه گانه RGB هگز است، مانند #ffcc00 . همچنین می توانید از نسخه کوتاه سه گانه RGB که # rgb است، مانند #fc0 استفاده کنید.

localized Issuer Name

object ( LocalizedString )

رشته های ترجمه شده برای صادرکنندهName. حداکثر طول توصیه شده 20 کاراکتر است تا اطمینان حاصل شود که رشته کامل در صفحه های کوچکتر نمایش داده می شود.

multiple Devices And Holders Allowed Status

enum ( MultipleDevicesAndHoldersAllowedStatus )

مشخص می کند که آیا چندین کاربر و دستگاه یک شیء مشابه را با ارجاع به این کلاس ذخیره می کنند یا خیر.

callback Options

object ( CallbackOptions )

گزینه‌های Callback برای فراخوانی مجدد صادرکننده برای هر ذخیره/حذف یک شی برای این کلاس توسط کاربر نهایی استفاده می‌شود. همه اشیاء این کلاس واجد شرایط بازگشت به تماس هستند.

security Animation

object ( SecurityAnimation )

اطلاعات اختیاری در مورد انیمیشن امنیتی. اگر این تنظیم باشد، یک انیمیشن امنیتی در جزئیات پاس نمایش داده می شود.

activation Options

object ( ActivationOptions )

گزینه های فعال سازی برای یک بلیط قابل فعال سازی

view Unlock Requirement

enum ( ViewUnlockRequirement )

مشاهده گزینه های مورد نیاز باز کردن قفل برای بلیط حمل و نقل.

notify Preference

enum ( NotificationSettingsForUpdates )

اینکه آیا به‌روزرسانی‌های فیلد این کلاس باید اعلان‌ها را راه‌اندازی کند یا خیر. وقتی روی NOTIFY تنظیم شود، سعی می کنیم یک اعلان به روز رسانی فیلد را برای کاربران فعال کنیم. این اعلان‌ها تنها در صورتی برای کاربران ارسال می‌شوند که این قسمت بخشی از یک لیست مجاز باشد. اگر روی DO_NOT_NOTIFY یا NOTIFICATION_SETTINGS_UNSPECIFIED تنظیم شود، هیچ اعلانی فعال نخواهد شد. این تنظیم زودگذر است و باید با هر درخواست PATCH یا UPDATE تنظیم شود، در غیر این صورت اعلانی راه اندازی نمی شود.

value Added Module Data[]

object ( ValueAddedModuleData )

داده های ماژول ارزش افزوده اختیاری. حداکثر ده نفر در کلاس برای یک پاس فقط ده نمایش داده خواهد شد، با اولویت دادن به موارد موجود در شی.

TransitType

Enums
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
}
فیلدها
activation Url

string

URL HTTPS که از معنای REST پشتیبانی می کند. برای درخواست فعال‌سازی از شرکا برای موارد ارزشمندی که توسط کاربران ایجاد می‌شود، استفاده می‌شود.

allow Reactivation

boolean

پرچم‌گذاری کنید تا کاربران بتوانند تماس فعال‌سازی را از دستگاه‌های مختلف برقرار کنند. این به مشتری اجازه می‌دهد تا دکمه فعال‌سازی را فعال کند، حتی اگر وضعیت فعال‌سازی ACTIVIATED باشد اما دستگاه درخواستی متفاوت از دستگاه فعلی باشد.

روش ها

addmessage

 یک پیام به کلاس حمل و نقل که توسط شناسه کلاس داده شده ارجاع داده شده است اضافه می کند.

get

 کلاس ترانزیت را با شناسه کلاس داده شده برمی گرداند.

insert

 یک کلاس ترانزیت با شناسه و ویژگی های داده شده درج می کند.

list

 فهرستی از تمام کلاس‌های حمل‌ونقل را برای شناسه صادرکننده معین برمی‌گرداند.

patch

 کلاس ترانزیت ارجاع شده توسط شناسه کلاس داده شده را به روز می کند.

update

 کلاس ترانزیت ارجاع شده توسط شناسه کلاس داده شده را به روز می کند.