REST Resource: transitclass

Kaynak: TransitClass

JSON gösterimi
{
  "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)
    }
  ]
}
Alanlar
transitOperatorName

object (LocalizedString)

Toplu taşıma operatörünün adı.

transitType

enum (TransitType)

Zorunlu. Bu sınıfın temsil ettiği toplu taşıma türü (ör. "otobüs").

watermark

object (Image)

Kullanıcının cihazında gösterilecek filigran resmi.

languageOverride

string

Bu alan mevcutsa kullanıcının cihazına sunulan toplu taşıma biletleri her zaman bu dilde olur. BCP 47 dil etiketini temsil eder. Örnek değerler: "en-US", "en-GB", "de" veya "de-AT".

customTransitTerminusNameLabel

object (LocalizedString)

Toplu taşıma terminali adı değeri (transitObject.ticketLeg.transitTerminusName) için kullanılacak özel etiket.

customTicketNumberLabel

object (LocalizedString)

Bilet numarası değeri (transitObject.ticketNumber) için kullanılacak özel etiket.

customRouteRestrictionsLabel

object (LocalizedString)

Rota kısıtlamaları değeri (transitObject.ticketRestrictions.routeRestrictions) için kullanılacak özel etiket.

customRouteRestrictionsDetailsLabel

object (LocalizedString)

Rota kısıtlamaları ayrıntıları değeri (transitObject.ticketRestrictions.routeRestrictionsDetails) için kullanılacak özel etiket.

customTimeRestrictionsLabel

object (LocalizedString)

Zaman kısıtlamaları ayrıntıları değeri (transitObject.ticketRestrictions.timeRestrictions) için kullanılacak özel etiket.

customOtherRestrictionsLabel

object (LocalizedString)

Diğer kısıtlamalar değeri (transitObject.ticketRestrictions.otherRestrictions) için kullanılacak özel etiket.

customPurchaseReceiptNumberLabel

object (LocalizedString)

Satın alma makbuzu numarası değeri (transitObject.purchaseDetails.purchaseReceiptNumber) için kullanılacak özel etiket.

customConfirmationCodeLabel

object (LocalizedString)

Onay kodu değeri (transitObject.purchaseDetails.confirmationCode) için kullanılacak özel bir etiket.

customPurchaseFaceValueLabel

object (LocalizedString)

Satın alma orijinal değeri için kullanılacak özel etiket (transitObject.purchaseDetails.ticketCost.faceValue).

customPurchasePriceLabel

object (LocalizedString)

Satın alma fiyatı değeri (transitObject.purchaseDetails.ticketCost.purchasePrice) için kullanılacak özel etiket.

customDiscountMessageLabel

object (LocalizedString)

Toplu taşıma indirimi mesaj değeri için kullanılacak özel etiket (transitObject.purchaseDetails.ticketCost.discountMessage).

customCarriageLabel

object (LocalizedString)

Satır değeri (transitObject.ticketLeg.carriage) için kullanılacak özel etiket.

customSeatLabel

object (LocalizedString)

Koltuk konumu değeri (transitObject.ticketLeg.ticketSeat.seat) için kullanılacak özel etiket.

customCoachLabel

object (LocalizedString)

Koç değeri (transitObject.ticketLeg.ticketSeat.coach) için kullanılacak özel etiket.

customPlatformLabel

object (LocalizedString)

Biniş platformu değeri (transitObject.ticketLeg.platform) için kullanılacak özel etiket.

customZoneLabel

object (LocalizedString)

Biniş bölgesi değeri (transitObject.ticketLeg.zone) için kullanılacak özel etiket.

customFareClassLabel

object (LocalizedString)

Ücret sınıfı değeri (transitObject.ticketLeg.ticketSeat.fareClass) için kullanılacak özel etiket.

customConcessionCategoryLabel

object (LocalizedString)

Toplu taşıma imtiyazı kategorisi değeri (transitObject.concessionCategory) için kullanılacak özel etiket.

customFareNameLabel

object (LocalizedString)

Toplu taşıma ücreti adı değeri (transitObject.ticketLeg.fareName) için kullanılacak özel etiket.

classTemplateInfo

object (ClassTemplateInfo)

Sınıfın nasıl gösterileceğiyle ilgili şablon bilgileri. Politika ayarlanmazsa Google, gösterilecek varsayılan bir grup alana döner.

enableSingleLegItinerary

boolean

Bu sınıf için tek ayaklı seyahat planının gösterilmesini kontrol eder. Seyahat planı varsayılan olarak yalnızca çok ayaklı geziler için gösterilir.

id

string

Zorunlu. Sınıfın benzersiz tanımlayıcısı. Bu kimlik, bir kartı veren kuruluşa ait tüm sınıflarda benzersiz olmalıdır. Bu değer issuer ID biçiminde olmalıdır.identifier. Bunlardan ilki Google tarafından verilir, ikincisi ise sizin tarafınızdan seçilir. Benzersiz tanımlayıcınız yalnızca alfanümerik karakterler, ".", "_" veya "-" işaretlerini içermelidir.

version
(deprecated)

string (int64 format)

Kullanımdan kaldırıldı

issuerName

string

Zorunlu. Kartı veren kuruluşun adı. Dizenin tamamının daha küçük ekranlarda gösterilmesi için önerilen maksimum uzunluk 20 karakterdir.

messages[]

object (Message)

Uygulamada gösterilen bir mesaj dizisi. Bu nesnenin tüm kullanıcıları, ilişkili mesajları alır. Bu alanlar en fazla 10 tane olabilir.

allowMultipleUsersPerObject
(deprecated)

boolean

Kullanımdan kaldırıldı. Bunun yerine multipleDevicesAndHoldersAllowedStatus politikasını kullanın.

homepageUri

object (Uri)

Uygulamanızın ana sayfasının URI'si. Bu alandaki URI'nin doldurulması, linksModuleData alanındaki URI'nin doldurulmasıyla tam olarak aynı davranışa neden olur (bir nesne oluşturulduğunda, genellikle nesnenin linksModuleData bölümü olarak düşünülen yerde ana sayfanın bağlantısı gösterilir).

locations[]
(deprecated)

object (LatLongPoint)

Not: Şu anda bu alan, coğrafi bildirimleri tetiklemek için desteklenmemektedir.

reviewStatus

enum (ReviewStatus)

Zorunlu. Sınıfın durumu. Bu alan; ekleme, yama veya güncelleme API çağrıları kullanılarak draft ya da underReview olarak ayarlanabilir. İnceleme durumu draft olarak değiştirildikten sonra draft olarak geri değiştirilemez.

Sınıf, geliştirme aşamasındayken bu alanı draft olarak tutmanız gerekir. draft sınıfı, herhangi bir nesne oluşturmak için kullanılamaz.

Sınıfın kullanıma hazır olduğunu düşündüğünüzde bu alanı underReview olarak ayarlamanız gerekir. Platform bu alanı otomatik olarak approved olarak ayarlar ve nesne oluşturmak veya taşımak için hemen kullanılabilir.

Zaten approved sınıfı olan bir sınıfı güncellerken bu alanı underReview olarak ayarlamaya devam etmeniz gerekir.

review

object (Review)

Bir sınıf approved veya rejected olarak işaretlendiğinde platform tarafından ayarlanan inceleme yorumları.

infoModuleData
(deprecated)

object (InfoModuleData)

Kullanımdan kaldırıldı. Bunun yerine textModulesData parametresini kullanın.

imageModulesData[]

object (ImageModuleData)

Resim modülü verileri. Bu alanların gösterilen maksimum sayısı, nesne düzeyinde 1 ve sınıf nesnesi düzeyinde 1'dir.

textModulesData[]

object (TextModuleData)

Metin modülü verileri. Sınıfta metin modülü verileri de tanımlanmışsa her ikisi de gösterilir. Bu alanların gösterilen maksimum sayısı, nesneden 10 ve sınıftan 10'dur.

redemptionIssuers[]

string (int64 format)

Akıllı Dokunma üzerinden geçişi hangi ödeme kartı sağlayıcılarının kullanabileceğini tanımlar. Kullanım kodu verenler, veren kimlikleriyle tanımlanır. Kullanım için ödeme yapanların en az bir Smart Tap anahtarı yapılandırılmış olmalıdır.

Kartın Akıllı Ödeme'yi desteklemesi için enableSmartTap ve nesne düzeyinde smartTapRedemptionLevel alanlarının da doğru şekilde ayarlanması gerekir.

countryCode

string

Kartın ülkesini (kullanıcı o ülkede değilken) görüntülemek ve içerik kullanıcının yerel dilinde mevcut olmadığında yerelleştirilmiş içerik görüntülemek için kullanılan ülke kodu.

heroImage

object (Image)

Kartın ön tarafında görüntülenen isteğe bağlı banner resmi. Hiçbiri yoksa hiçbir şey görüntülenmez. Resim %100 genişlikte gösterilir.

wordMark
(deprecated)

object (Image)

Kullanımdan kaldırıldı.

enableSmartTap

boolean

Bu sınıfın Akıllı Dokunma'yı destekleyip desteklemediğini belirtir. Bir geçişin Akıllı Dokunma'yı desteklemesi için redemptionIssuers ve nesne düzeyi smartTapRedemptionLevel alanları da doğru şekilde ayarlanmalıdır.

hexBackgroundColor

string

Kartın arka plan rengi. Ayarlanmadan önce hero resmin baskın rengi kullanılır ve hero resim ayarlanmadıysa logonun baskın rengi kullanılır. Biçim #rrggbb şeklindedir. Burada rrggbb, #ffcc00 gibi bir onaltılık RGB üçlüsüdür. Ayrıca, RGB üçlüsünün #rgb olan kısa sürümünü de kullanabilirsiniz (ör. #fc0).

localizedIssuerName

object (LocalizedString)

Veren ismi için çevrilen dizeler. Dizenin tamamının daha küçük ekranlarda gösterilmesi için önerilen maksimum uzunluk 20 karakterdir.

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Birden fazla kullanıcının ve cihazın, bu sınıfa referans veren aynı nesneyi kaydedip kaydetmeyeceğini belirler.

callbackOptions

object (CallbackOptions)

Son kullanıcı tarafından bu sınıftaki bir nesnenin her kaydedildiğinde/silindiğinde kartı vereni geri çağırmak için kullanılan geri arama seçenekleri. Bu sınıftaki tüm nesneler geri çağırma için uygundur.

securityAnimation

object (SecurityAnimation)

Güvenlik animasyonu hakkında isteğe bağlı bilgiler. Bu ayar etkinleştirilirse geçiş ayrıntılarında bir güvenlik animasyonu oluşturulur.

activationOptions

object (ActivationOptions)

Etkinleştirilebilir bilet için etkinleştirme seçenekleri.

viewUnlockRequirement

enum (ViewUnlockRequirement)

Toplu taşıma bileti için Kilit Açma Şartı seçeneklerini görüntüleyin.

notifyPreference

enum (NotificationSettingsForUpdates)

Bu sınıftaki alan güncellemelerinin bildirimleri tetikleyip tetiklemeyeceğini belirler. BİLDİRİM olarak ayarlandığında kullanıcılara bir alan güncelleme bildirimi göndermeyi deneriz. Bu bildirimler yalnızca ilgili alan bir izin verilenler listesinde yer alıyorsa kullanıcılara gönderilir. DO_NOT_NOTIFY veya NOTIFICATION_SETTINGS_UNSPECIFIED olarak ayarlanırsa bildirim tetiklenmez. Bu ayar geçicidir ve her PATCH veya UPDATE isteğiyle birlikte ayarlanması gerekir. Aksi takdirde bildirim tetiklenmez.

valueAddedModuleData[]

object (ValueAddedModuleData)

İsteğe bağlı katma değer modülü verileri. Sınıfta en fazla on karakter olabilir. Bir geçiş için yalnızca on tane gösterilir ve nesnedekilere öncelik verilir.

TransitType

Sıralamalar
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

BUS için eski takma ad. Kullanımdan kaldırıldı.

RAIL
rail

RAIL için eski takma ad. Kullanımdan kaldırıldı.

TRAM
tram

TRAM için eski takma ad. Kullanımdan kaldırıldı.

FERRY
ferry

FERRY için eski takma ad. Kullanımdan kaldırıldı.

OTHER
other

OTHER için eski takma ad. Kullanımdan kaldırıldı.

ActivationOptions

Sınıf için ActivationOptions

JSON gösterimi
{
  "activationUrl": string,
  "allowReactivation": boolean
}
Alanlar
activationUrl

string

REST anlamlarını destekleyen HTTPS URL'si. Kullanıcılar tarafından tetiklenen, değerli belirtilen durumlarda iş ortaklarından etkinleştirme isteğinde bulunmak için kullanılır.

allowReactivation

boolean

Kullanıcıların farklı cihazlardan etkinleştirme araması yapmasına izin vermek için işaretleyin. Bu, activationStatus etkinleştirilmiş olsa bile istenen cihaz mevcut cihazdan farklı olsa bile istemcinin etkinleştirme düğmesini etkin olarak oluşturmasına olanak tanır.

Yöntemler

addmessage

Belirtilen sınıf kimliğinin referansta bulunduğu geçiş sınıfına bir ileti ekler.

get

Belirtilen sınıf kimliğine sahip taşıma sınıfını döndürür.

insert

Belirtilen kimliğe ve özelliklere sahip bir toplu taşıma sınıfı ekler.

list

Belirli bir kart veren kimliği için tüm toplu taşıma sınıflarının listesini döndürür.

patch

Belirtilen sınıf kimliğinin referans verdiği toplu taşıma sınıfını günceller.

update

Belirtilen sınıf kimliğinin referans verdiği toplu taşıma sınıfını günceller.