REST Resource: transitobject

Kaynak: TransitObject

JSON gösterimi
{
  "classReference": {
    object (TransitClass)
  },
  "ticketNumber": string,
  "passengerType": enum (PassengerType),
  "passengerNames": string,
  "tripId": string,
  "ticketStatus": enum (TicketStatus),
  "customTicketStatus": {
    object (LocalizedString)
  },
  "concessionCategory": enum (ConcessionCategory),
  "customConcessionCategory": {
    object (LocalizedString)
  },
  "ticketRestrictions": {
    object (TicketRestrictions)
  },
  "purchaseDetails": {
    object (PurchaseDetails)
  },
  "ticketLeg": {
    object (TicketLeg)
  },
  "ticketLegs": [
    {
      object (TicketLeg)
    }
  ],
  "hexBackgroundColor": string,
  "tripType": enum (TripType),
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "activationStatus": {
    object (ActivationStatus)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "deviceContext": {
    object (DeviceContext)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
Alanlar
classReference

object (TransitClass)

Üst sınıfın devralınan alanlarının bir kopyası. Bu alanlar bir GET sırasında alınır.

ticketNumber

string

Bilet numarası. Bu, toplu taşıma operatörünün sistemindeki biletin benzersiz tanımlayıcısıdır.

passengerType

enum (PassengerType)

Yolcu sayısı.

passengerNames

string

Biletin atandığı yolcuların adları. Yukarıdaki passengerType alanı, Google'a bu alanla ilgili bağlam bilgisi verir.

tripId

string

Bu kimlik, kullanıcı aynı seyahat için birden fazla bilet kaydettiyse biletleri birlikte gruplandırmak için kullanılır.

ticketStatus

enum (TicketStatus)

Biletin durumu. Görüntüyü etkileyen durumlar için bunun yerine state alanını kullanın.

customTicketStatus

object (LocalizedString)

ticketStatus doğru seçeneği sunmadığında bilet durumu değeri için kullanılacak özel bir durum. ticketStatus ve customTicketStatus ayarlanmamış olabilir.

concessionCategory

enum (ConcessionCategory)

Bilet için özel indirim kategorisi.

customConcessionCategory

object (LocalizedString)

concessionCategory doğru seçeneği sunmadığında kullanılacak özel bir imtiyaz kategorisi. concessionCategory ve customConcessionCategory ayarlanmamış olabilir.

ticketRestrictions

object (TicketRestrictions)

Bu biletin kullanımıyla ilgili ne tür kısıtlamalar olduğu hakkında bilgi. Örneğin, haftanın hangi günleri kullanılması gerektiğini veya hangi rotaların kullanılmasına izin verildiğini belirleyebilirsiniz.

purchaseDetails

object (PurchaseDetails)

Bu biletin satın alma ayrıntıları.

ticketLeg

object (TicketLeg)

Tek bilet ayağında kalkış ve varış bilgilerinin yanı sıra biniş ve oturma yeri bilgileri yer alır. Birden fazla ayak belirtilecekse bunun yerine ticketLegs alanını kullanın. ticketLeg ve ticketLegs ayarlanmamış olabilir.

ticketLegs[]

object (TicketLeg)

Her bilette bir veya daha fazla ayak olabilir. Her ayakta kalkış ve varış bilgilerinin yanı sıra biniş ve oturma yeri bilgileri yer alır. Yalnızca tek bir ayak belirtilecekse bunun yerine ticketLeg alanını kullanın. ticketLeg ve ticketLegs ayarlanmamış olabilir.

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 onaltılık bir RGB üçlü bileşenidir. Ayrıca, RGB üçlüsünün #rgb olan kısa sürümünü de kullanabilirsiniz (ör. #fc0).

tripType

enum (TripType)

Zorunlu. Bu toplu taşıma nesnesinin temsil ettiği seyahat türü. Kalkış ve varış noktaları arasında kullanılacak kart başlığını ve/veya hangi simgenin kullanılacağını belirlemek için kullanılır.

id

string

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

classId

string

Zorunlu. Bu nesneyle ilişkilendirilen sınıf. Sınıfın bu nesne ile aynı türde olması, zaten mevcut olması ve onaylanması gerekir.

Sınıf kimlikleri issuer ID biçiminde olmalıdır.identifier burada Google tarafından verilir, ikincisi ise sizin tarafınızdan seçilir.

version
(deprecated)

string (int64 format)

Kullanımdan kaldırıldı

state

enum (State)

Zorunlu. Nesnenin durumu. Bu alan, bir nesnenin uygulamada nasıl görüntüleneceğini belirlemek için kullanılır. Örneğin, bir inactive nesnesi "Süresi dolmuş kartlar"a taşınır bölümüne ekleyin.

barcode

object (Barcode)

Barkod türü ve değeri.

messages[]

object (Message)

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

validTimeInterval

object (TimeInterval)

Bu nesnenin active olacağı ve nesnenin kullanılabileceği dönem. Bu dönem geçtikten sonra bir nesnenin durumu expired olarak değiştirilir.

locations[]

object (LatLongPoint)

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

hasUsers

boolean

Nesnenin kullanıcı olup olmadığını belirtir. Bu alan platform tarafından ayarlanır.

smartTapRedemptionValue

string

Bu nesne için NFC üzerinden Smart Tap sertifikalı bir terminale iletilecek değer. Kartın Akıllı Ödeme'yi desteklemesi için enableSmartTap ve redemptionIssuers sınıf düzeyi alanlarının da doğru şekilde ayarlanması gerekir. Yalnızca ASCII karakterler desteklenir.

hasLinkedDevice

boolean

Bu nesnenin şu anda tek bir cihaza bağlı olup olmadığı. Bu alan, bir kullanıcı nesneyi kaydettiğinde ve cihazı cihazına bağladığında platform tarafından ayarlanır. Belirli iş ortaklarının kullanımına yöneliktir. Daha fazla bilgi için destek ekibiyle iletişime geçin.

disableExpirationNotification

boolean

Bildirimlerin açıkça engellenip engellenmeyeceğini belirtir. Bu alan doğru değerine ayarlanırsa messages alanından bağımsız olarak kullanıcıya gönderilen süre sonu bildirimleri atlanır. Bu alan varsayılan olarak "yanlış" değerine ayarlanır.

Şu anda bu ayar yalnızca fırsatlar için ayarlanabilir.

infoModuleData

object (InfoModuleData)

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

imageModulesData[]

object (ImageModuleData)

Resim modülü verileri. Bu alanlar, nesne düzeyinde 1'i, sınıf nesnesi düzeyinde ise 1'i gösterebilir.

textModulesData[]

object (TextModuleData)

Metin modülü verileri. Metin modülü verileri de sınıfta tanımlanmışsa her ikisi de gösterilir. Bu alanlar, nesneden en fazla 10 ve sınıftan en fazla 10 adet alanda görüntülenir.

activationStatus

object (ActivationStatus)

Nesnenin etkinleştirme durumu. Sınıfın activationOptions ayarı varsa gereklidir.

rotatingBarcode

object (RotatingBarcode)

Dönen barkod türü ve değeri.

deviceContext

object (DeviceContext)

Nesneyle ilişkilendirilen cihaz bağlamı.

heroImage

object (Image)

Kartın ön tarafında görüntülenen isteğe bağlı banner resmi. Yoksa, varsa sınıfın hero resmi gösterilir. Sınıfın hero resmi de yoksa hiçbir şey gösterilmez.

groupingInfo

object (GroupingInfo)

Kartların birlikte nasıl gruplandırılacağını belirleyen bilgiler.

passConstraints

object (PassConstraints)

Nesne için kısıtlamaları aktarın. NFC ve ekran görüntüsü alma davranışlarını sınırlandırır.

saveRestrictions

object (SaveRestrictions)

Kullanıcının kartı kaydetmeye çalışmadan önce doğrulanması gereken nesneyle ilgili kısıtlamalar. Bu kısıtlamaların yalnızca programdan yararlanma süresi boyunca geçerli olacağını unutmayın. Kullanıcı kartı kaydettikten sonra kısıtlamalar değişirse yeni kısıtlamalar daha önce kaydedilmiş kartlara uygulanmaz.

PassengerType

Sıralamalar
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

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

MULTIPLE_PASSENGERS
multiplePassengers

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

TicketStatus

Sıralamalar
TICKET_STATUS_UNSPECIFIED
USED
used

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

REFUNDED
refunded

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

EXCHANGED
exchanged

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

ConcessionCategory

Sıralamalar
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

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

CHILD
child

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

SENIOR
senior

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

TicketRestrictions

JSON gösterimi
{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}
Alanlar
routeRestrictions

object (LocalizedString)

Kullanılabilecek rotalarla ilgili kısıtlamalar. Örneğin, bu "Yalnızca rezerve edilmiş CrossCountry trenleri" dizesi olabilir.

routeRestrictionsDetails

object (LocalizedString)

Yukarıdaki routeRestrictions hakkında daha fazla bilgi.

timeRestrictions

object (LocalizedString)

Bu biletin kullanılabileceği zamanlarla ilgili kısıtlamalar.

otherRestrictions

object (LocalizedString)

"Rota" kapsamına girmeyen ekstra kısıtlamalar veya "time" (zaman) tıklayın.

PurchaseDetails

JSON gösterimi
{
  "purchaseReceiptNumber": string,
  "purchaseDateTime": string,
  "accountId": string,
  "confirmationCode": string,
  "ticketCost": {
    object (TicketCost)
  }
}
Alanlar
purchaseReceiptNumber

string

Bileti satan kuruluş aracılığıyla yapılan bilet satın alımını takip etmek için kullanılan makbuz numarası/tanımlayıcı.

purchaseDateTime

string

Biletin satın alma tarihi/saati.

Bu, ofseti olan veya olmayan, ISO 8601 genişletilmiş tarih/saat biçimindedir. Nanosaniye hassasiyete kadar zaman belirtilebilir. Kaydırmalar saniye hassasiyetiyle belirtilebilir (ayırma saniyesi ISO 8601'in parçası olmasa bile).

Örneğin:

1985-04-12T23:20:50.52Z, 12 Nisan 1985'in 23.saatinden (UTC) sonra 20 dakika 50,52 saniye olur.

1985-04-12T19:20:50.52-04:00 değeri, 12 Nisan 1985'teki 19 saat sonra, UTC'den 4 saat önce 20 dakika 50,52 saniye olur (yukarıdaki örnekle aynı zamanda). Etkinlik New York'ta olsaydı bu, Doğu Yaz Saati'ne (EDT) eşit olurdu. Ofsetin, yılın zamanına bağlı olarak Yaz Saati (veya Yaz Saati) uygulamasının geçerli olduğu bölgelerde değiştiğini unutmayın.

1985-04-12T19:20:50.52, ofset bilgisi olmadan 12 Nisan 1985'in 19.saatinden sonraki 20 dakika 50,52 saniye olur.

Ofset bilgileri olmadan bazı zengin özellikler kullanılamayabilir.

accountId

string

Bileti satın almak için kullanılan hesabın kimliği.

confirmationCode

string

Satın alma işleminin onay kodu. Bu, birden fazla farklı bilet için aynı olabilir ve biletleri birlikte gruplandırmak için kullanılır.

ticketCost

object (TicketCost)

Biletin maliyeti.

TicketCost

JSON gösterimi
{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}
Alanlar
faceValue

object (Money)

Biletin orijinal fiyatıdır.

purchasePrice

object (Money)

Biletin, vergi ve/veya indirimlerden sonraki gerçek satın alma fiyatı.

discountMessage

object (LocalizedString)

Uygulanan indirim türlerini açıklayan bir mesaj.

TicketLeg

JSON gösterimi
{
  "originStationCode": string,
  "originName": {
    object (LocalizedString)
  },
  "destinationStationCode": string,
  "destinationName": {
    object (LocalizedString)
  },
  "departureDateTime": string,
  "arrivalDateTime": string,
  "fareName": {
    object (LocalizedString)
  },
  "carriage": string,
  "platform": string,
  "zone": string,
  "ticketSeat": {
    object (TicketSeat)
  },
  "ticketSeats": [
    {
      object (TicketSeat)
    }
  ],
  "transitOperatorName": {
    object (LocalizedString)
  },
  "transitTerminusName": {
    object (LocalizedString)
  }
}
Alanlar
originStationCode

string

Kalkış istasyonu kodu. destinationStationCode mevcutsa veya originName yoksa bu gereklidir.

originName

object (LocalizedString)

Kalkış istasyonunun adı. desinationName mevcutsa veya originStationCode yoksa bu gereklidir.

destinationStationCode

string

Varış istasyonunun kodu.

destinationName

object (LocalizedString)

Hedef adı.

departureDateTime

string

Kalkış tarihi/saati. Bu, geçiş nesnesinde geçerlilik zaman aralığı ayarlanmamışsa gereklidir.

Bu, ofseti olan veya olmayan, ISO 8601 genişletilmiş tarih/saat biçimindedir. Nanosaniye hassasiyete kadar zaman belirtilebilir. Kaydırmalar saniye hassasiyetiyle belirtilebilir (ayırma saniyesi ISO 8601'in parçası olmasa bile).

Örneğin:

1985-04-12T23:20:50.52Z, 12 Nisan 1985'in 23.saatinden (UTC) sonra 20 dakika 50,52 saniye olur.

1985-04-12T19:20:50.52-04:00 değeri, 12 Nisan 1985'teki 19 saat sonra, UTC'den 4 saat önce 20 dakika 50,52 saniye olur (yukarıdaki örnekle aynı zamanda). Etkinlik New York'ta olsaydı bu, Doğu Yaz Saati'ne (EDT) eşit olurdu. Ofsetin, yılın zamanına bağlı olarak Yaz Saati (veya Yaz Saati) uygulamasının geçerli olduğu bölgelerde değiştiğini unutmayın.

1985-04-12T19:20:50.52, ofset bilgisi olmadan 12 Nisan 1985'in 19.saatinden sonraki 20 dakika 50,52 saniye olur.

Ofset içermeyen tarih/saat bölümü, "yerel tarih/saat" olarak kabul edilir. Bu, kalkış istasyonundaki yerel tarih/saat olmalıdır. Örneğin, kalkış istasyonu 5 Haziran 2018'in 20. saatinde başlıyorsa yerel tarih/saat bölümü 2018-06-05T20:00:00 olmalıdır. Kalkış istasyonundaki yerel tarih/saat, UTC'den 4 saat öncesine aitse -04:00 ofseti eklenebilir.

Ofset bilgileri olmadan bazı zengin özellikler kullanılamayabilir.

arrivalDateTime

string

Varış tarihi/saati.

Bu, ofseti olan veya olmayan, ISO 8601 genişletilmiş tarih/saat biçimindedir. Nanosaniye hassasiyete kadar zaman belirtilebilir. Kaydırmalar saniye hassasiyetiyle belirtilebilir (ayırma saniyesi ISO 8601'in parçası olmasa bile).

Örneğin:

1985-04-12T23:20:50.52Z, 12 Nisan 1985'in 23.saatinden (UTC) sonra 20 dakika 50,52 saniye olur.

1985-04-12T19:20:50.52-04:00 değeri, 12 Nisan 1985'teki 19 saat sonra, UTC'den 4 saat önce 20 dakika 50,52 saniye olur (yukarıdaki örnekle aynı zamanda). Etkinlik New York'ta olsaydı bu, Doğu Yaz Saati'ne (EDT) eşit olurdu. Ofsetin, yılın zamanına bağlı olarak Yaz Saati (veya Yaz Saati) uygulamasının geçerli olduğu bölgelerde değiştiğini unutmayın.

1985-04-12T19:20:50.52, ofset bilgisi olmadan 12 Nisan 1985'in 19.saatinden sonraki 20 dakika 50,52 saniye olur.

Ofset içermeyen tarih/saat bölümü, "yerel tarih/saat" olarak kabul edilir. Bu, hedef istasyondaki yerel tarih/saat değeri olmalıdır. Örneğin, etkinlik 5 Haziran 2018'in 20'sinde hedef istasyonda gerçekleşirse yerel tarih/saat bölümü 2018-06-05T20:00:00 olmalıdır. Hedef istasyondaki yerel tarih/saat, UTC'den 4 saat önceyse -04:00 ofseti eklenebilir.

Ofset bilgileri olmadan bazı zengin özellikler kullanılamayabilir.

fareName

object (LocalizedString)

Bu seyahat ayağı için ücretin kısa açıklaması/adı. Ör. "Herhangi Bir Zaman Tek Kullanımlık".

carriage

string

Yolcunun binmesi gereken tren veya gemi adı/numarası.

platform

string

Yolcunun vagona binebileceği platform veya kapı.

zone

string

Platform içindeki biniş bölgesi.

ticketSeat

object (TicketSeat)

Yolcular için ayrılmış koltuk. Birden fazla lisans belirtilecekse bunun yerine ticketSeats alanını kullanın. ticketSeat ve ticketSeats ayarlanmamış olabilir.

ticketSeats[]

object (TicketSeat)

Yolcular için ayrılmış koltuk. Yalnızca bir lisans belirtilecekse bunun yerine ticketSeat alanını kullanın. ticketSeat ve ticketSeats ayarlanmamış olabilir.

transitOperatorName

object (LocalizedString)

Seyahatin bu ayağını yürüten toplu taşıma operatörünün adı.

transitTerminusName

object (LocalizedString)

Terminal veya tren/otobüs durağı vb.

TicketSeat

JSON gösterimi
{
  "fareClass": enum (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}
Alanlar
fareClass

enum (FareClass)

Biletli koltuğun ücret sınıfı.

customFareClass

object (LocalizedString)

fareClass geçerli değilse kullanılacak bir özel ücret sınıfı. fareClass ve customFareClass ayarlanmamış olabilir.

coach

string

Biletli koltuğun bulunduğu vagon veya otobüsün tanımlayıcısı. Ör. "10"

seat

string

Biletli koltuğun bulunduğu yerin tanımlayıcısı. Ör. "42". Belirli bir tanımlayıcı yoksa bunun yerine seatAssigment kullanın.

seatAssignment

object (LocalizedString)

Yolcunun koltuk ataması. Ör. "koltuk yok". seat içinde kullanılacak belirli bir tanımlayıcı olmadığında kullanılır.

FareClass

Sıralamalar
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

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

FIRST
first

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

BUSINESS
business

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

TripType

Sıralamalar
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

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

ONE_WAY
oneWay

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

ActivationStatus

Nesnenin etkinleştirme durumu. Değer, etkinleştirmeyi destekliyorsa bu alan, etkinleştirme durumunu içerir.

JSON gösterimi
{
  "state": enum (State)
}
Alanlar
state

enum (State)

Eyalet

Sıralamalar
UNKNOWN_STATE
NOT_ACTIVATED Etkin değil, bu varsayılan durumdur.
not_activated

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

ACTIVATED Etkinleştirildi
activated

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

DeviceContext

Nesneyle ilişkilendirilen cihaz bağlamı.

JSON gösterimi
{
  "deviceToken": string
}
Alanlar
deviceToken

string

Ayarlanırsa teklifi kullanma bilgileri yalnızca nesnenin etkinleştirilmesinin ardından belirtilen cihaza döndürülür. Bu kimlik, bir kullanıcının cihazını izlemek için kararlı bir tanımlayıcı olarak kullanılmamalıdır. Aynı cihazdaki farklı kartlarda veya aynı cihazın farklı etkinleştirmelerinde bile değişebilir. Bunu ayarlarken, arayanların etkinleştirilmekte olan nesnede hasLinkedDevice ayarını da yapması gerekir.

Yöntemler

addmessage

Belirtilen nesne kimliğinin referansta bulunduğu geçiş nesnesine bir mesaj ekler.

get

Belirtilen nesne kimliğine sahip geçiş nesnesini döndürür.

insert

Verilen kimliğe ve özelliklere sahip bir geçiş nesnesi ekler.

list

Belirli bir veren kimliği için tüm geçiş nesnelerinin listesini döndürür.

patch

Belirtilen nesne kimliğinin referansta bulunduğu geçiş nesnesini günceller.

update

Belirtilen nesne kimliğinin referansta bulunduğu geçiş nesnesini günceller.