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)
  }
}
Alanlar
classReference

object (TransitClass)

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

ticketNumber

string

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

passengerType

enum (PassengerType)

Yolcu sayısı.

passengerNames

string

Biletin atandığı yolcuların adları. Yukarıdaki passengerType alanı, Google'a bu alanla ilgili bilgi vermek içindir.

tripId

string

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

ticketStatus

enum (TicketStatus)

Bilet durumu. Ekranı etkileyen eyaletler 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. Hem ticketStatus hem de customTicketStatus ayarlanmamış olabilir.

concessionCategory

enum (ConcessionCategory)

Bilet için ayrıcalık kategorisi.

customConcessionCategory

object (LocalizedString)

concessionCategory doğru seçeneği sunmadığında kullanılacak özel bir avantaj kategorisi. Hem concessionCategory hem de customConcessionCategory ayarlanmamış olabilir.

ticketRestrictions

object (TicketRestrictions)

Bu destek kaydının kullanımıyla ilgili kısıtlamalar hakkında bilgi. Örneğin, haftanın hangi günlerinde kullanılması gerektiği veya hangi rotalara izin verildiği.

purchaseDetails

object (PurchaseDetails)

Bu biletle ilgili satın alma bilgileri.

ticketLeg

object (TicketLeg)

Tek bilet ayağı, biniş ve oturma bilgilerinin yanı sıra kalkış ve varış bilgilerini içerir. Birden fazla bacak belirtilmelidir. Bunun yerine ticketLegs alanını kullanın. Hem ticketLeg hem de ticketLegs ayarlanmamış olabilir.

ticketLegs[]

object (TicketLeg)

Her bilet bir veya daha fazla ayak içerebilir. Her bir bölümde, biniş ve oturma bilgilerinin yanı sıra kalkış ve varış bilgileri yer alır. Yalnızca tek bir bacak belirtilecekse bunun yerine ticketLeg alanını kullanın. Hem ticketLeg hem de ticketLegs ayarlanmamış olabilir.

hexBackgroundColor

string

Kartın arka plan rengi. Ayarlanmazsa hero resmin baskın rengi kullanılır ve hero resim ayarlanmamışsa logoda baskın renk kullanılır. Biçim, rrggbb. sıradadır; burada rrggbb, onaltılık bir RGB üçlüsüdür (ör. #ffcc00). RGB üçlüsünün rgb numarada olan (örneğin #fc0) kısaltılmış halini de kullanabilirsiniz.

tripType

enum (TripType)

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

id

string

Zorunlu. Bir nesnenin benzersiz tanımlayıcısıdır. Bu kimlik, bir verenin tüm nesneleri genelinde benzersiz olmalıdır. Bu değer issuer ID biçiminde olmalıdır.identifier: İlk sertifika Google tarafından verilir, ikincisini siz seçersiniz. Benzersiz tanımlayıcı sadece alfanümerik karakterler, '.', '_' veya '-' içermelidir.

classId

string

Zorunlu. Bu nesneyle ilişkilendirilen sınıf. Sınıf bu nesne ile aynı türde olmalı, hâlihazırda mevcut olmalı ve onaylanmalıdır.

Sınıf kimlikleri issuer ID biçiminde olmalıdır.identifier: İlk sertifika Google tarafından verilir, ikincisini siz seçersiniz.

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 dolan kartlar" bölümüne taşınır.

barcode

object (Barcode)

Barkod türü ve değeri.

messages[]

object (Message)

Uygulamada görüntülenen mesaj dizisi. Bu nesnenin tüm kullanıcıları, ilgili mesajları alacaktır. Bu alanların maksimum sayısı 10'dur.

validTimeInterval

object (TimeInterval)

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

locations[]

object (LatLongPoint)

Not: Şu anda bu alanın coğrafi bildirimleri tetiklemesi desteklenmemektedir.

hasUsers

boolean

Nesnede kullanıcı olup olmadığını gösterir. Bu alan, platform tarafından ayarlanır.

smartTapRedemptionValue

string

Bu nesne için NFC üzerinden Akıllı Dokunma onaylı bir terminale iletilecek değer. Kartın Akıllı Dokunma'yı desteklemesi için enableSmartTap ve redemptionIssuers sınıf düzeyindeki alanları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, kullanıcı nesneyi kaydedip cihazına bağladığında platform tarafından ayarlanır. Belirli iş ortaklarının kullanması için tasarlanmıştır. Ek 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 geçerlilik sonu bildirimleri gizlenir. Varsayılan olarak, bu alan "false" (yanlış) değerine ayarlanır.

Bu ayar şu anda 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 alanlardan en fazla 1 tanesi nesne düzeyinde, 1'i sınıf nesne düzeyinde gösterilir.

textModulesData[]

object (TextModuleData)

Metin modülü verileri. Sınıfta metin modülü verileri de tanımlanmışsa her ikisi de gösterilir. Bu alanlardan en fazla 10 tanesi nesneden, 10'u ise sınıftan görüntülenebilir.

activationStatus

object (ActivationStatus)

Nesnenin etkinleştirme durumu. Sınıfta activationOptions ayarlanmışsa zorunludur.

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 kısmında gösterilen isteğe bağlı banner resmi. Herhangi bir sınıf yoksa sınıfın hero resmi (varsa) gösterilir. Sınıfa ait hero resim de yoksa hiçbir şey görüntülenmez.

groupingInfo

object (GroupingInfo)

Kartların nasıl gruplandırılacağını kontrol eden bilgiler.

passConstraints

object (PassConstraints)

Nesne için kısıtlamaları geçirin. Sınırlayıcı NFC ve ekran görüntüsü davranışlarını içerir.

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 arazisinde ayrılmış trenler" dizesi olabilir.

routeRestrictionsDetails

object (LocalizedString)

Yukarıdaki routeRestrictions ile ilgili daha fazla bilgi.

timeRestrictions

object (LocalizedString)

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

otherRestrictions

object (LocalizedString)

"Rota" veya "süre" kategorilerine girmeyen ekstra kısıtlamalar.

PurchaseDetails

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

string

Bilet satın alımını, bileti satan gövde aracılığıyla izlemek için kullanılan makbuz numarası/tanımlayıcı.

purchaseDateTime

string

Biletin satın alındığı tarih/saat.

Bu değer, ofseti olan veya olmayan, ISO 8601 genişletilmiş biçiminde bir tarih/saattir. Zaman, nanosaniye hassasiyete kadar belirtilebilir. Zaman farkı, saniye hassasiyetiyle belirtilebilir (ofsetteki saniye değeri, ISO 8601'in bir parçası olmasa bile).

Örneğin:

1985-04-12T23:20:50.52Z değeri, UTC olarak 12 Nisan 1985'in 23.saatinden sonra 20 dakika 50,52 saniye olur.

1985-04-12T19:20:50.52-04:00 değeri, 12 Nisan 1985'te 19.saatten sonra, UTC'den 4 saat önce (yukarıdaki örnekle aynı anda) 20 dakika 50,52 saniye olur. Etkinlik New York'ta gerçekleştiyse bu, Doğu Yaz Saati'ne (EDT) eşdeğer olur. ofsetin, yılın saatine bağlı olarak Yaz Saati (veya Yaz Saati) uygulamasının uygulandığı bölgelere göre farklılık gösterebileceğini unutmayın.

1985-04-12T19:20:50.52, 12 Nisan 1985'te 19.saatten sonra 20 dakika 50,52 saniye olur ve ofset bilgisi içermez.

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 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ı.

purchasePrice

object (Money)

Biletin vergi ve/veya indirimlerden sonraki gerçek satış fiyatı.

discountMessage

object (LocalizedString)

Uygulanan herhangi bir indirim türünü açıklayan bir ileti.

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ış istasyonunun kodu. destinationStationCode mevcutsa veya originName mevcut değilse bu gereklidir.

originName

object (LocalizedString)

Kalkış istasyonunun adı. desinationName mevcutsa veya originStationCode mevcut değilse bu gereklidir.

destinationStationCode

string

Hedef istasyon kodu.

destinationName

object (LocalizedString)

Hedef adı.

departureDateTime

string

Kalkış tarihi/saati. Taşıma nesnesinde geçerlilik süresi ayarlanmamışsa bu gereklidir.

Bu değer, ofseti olan veya olmayan, ISO 8601 genişletilmiş biçiminde bir tarih/saattir. Zaman, nanosaniye hassasiyete kadar belirtilebilir. Zaman farkı, saniye hassasiyetiyle belirtilebilir (ofsetteki saniye değeri, ISO 8601'in bir parçası olmasa bile).

Örneğin:

1985-04-12T23:20:50.52Z değeri, UTC olarak 12 Nisan 1985'in 23.saatinden sonra 20 dakika 50,52 saniye olur.

1985-04-12T19:20:50.52-04:00 değeri, 12 Nisan 1985'te 19.saatten sonra, UTC'den 4 saat önce (yukarıdaki örnekle aynı anda) 20 dakika 50,52 saniye olur. Etkinlik New York'ta gerçekleştiyse bu, Doğu Yaz Saati'ne (EDT) eşdeğer olur. ofsetin, yılın saatine bağlı olarak Yaz Saati (veya Yaz Saati) uygulamasının uygulandığı bölgelere göre farklılık gösterebileceğini unutmayın.

1985-04-12T19:20:50.52, 12 Nisan 1985'te 19.saatten sonra 20 dakika 50,52 saniye olur ve ofset bilgisi içermez.

Ofset içermeyen tarih/saat kısmı, "yerel tarih/saat" olarak kabul edilir. Bu, kalkış istasyonundaki yerel tarih/saat olmalıdır. Örneğin, kalkış istasyonunda 5 Haziran 2018'in 20. saatinde kalkış yapılırsa yerel tarih/saat kısmı 2018-06-05T20:00:00 olmalıdır. Kalkış istasyonundaki yerel tarih/saat UTC'den 4 saat önceyse -04:00 farkı eklenebilir.

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

arrivalDateTime

string

Varış tarihi/saatidir.

Bu değer, ofseti olan veya olmayan, ISO 8601 genişletilmiş biçiminde bir tarih/saattir. Zaman, nanosaniye hassasiyete kadar belirtilebilir. Zaman farkı, saniye hassasiyetiyle belirtilebilir (ofsetteki saniye değeri, ISO 8601'in bir parçası olmasa bile).

Örneğin:

1985-04-12T23:20:50.52Z değeri, UTC olarak 12 Nisan 1985'in 23.saatinden sonra 20 dakika 50,52 saniye olur.

1985-04-12T19:20:50.52-04:00 değeri, 12 Nisan 1985'te 19.saatten sonra, UTC'den 4 saat önce (yukarıdaki örnekle aynı anda) 20 dakika 50,52 saniye olur. Etkinlik New York'ta gerçekleştiyse bu, Doğu Yaz Saati'ne (EDT) eşdeğer olur. ofsetin, yılın saatine bağlı olarak Yaz Saati (veya Yaz Saati) uygulamasının uygulandığı bölgelere göre farklılık gösterebileceğini unutmayın.

1985-04-12T19:20:50.52, 12 Nisan 1985'te 19.saatten sonra 20 dakika 50,52 saniye olur ve ofset bilgisi içermez.

Ofset içermeyen tarih/saat kısmı, "yerel tarih/saat" olarak kabul edilir. Hedef istasyondaki yerel tarih/saat olmalıdır. Örneğin, etkinlik 5 Haziran 2018'in 20. saatinde hedef istasyonda gerçekleşirse yerel tarih/saat kısmı 2018-06-05T20:00:00 olmalıdır. Hedef istasyondaki yerel tarih/saat UTC'den 4 saat önceyse -04:00 farkı eklenebilir.

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

fareName

object (LocalizedString)

Seyahatin bu ayağı için ücretin kısa açıklaması/adı. Ör. "Her Zaman Tek Kullanımlık".

carriage

string

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

platform

string

Yolcunun vagona binebileceği platform veya kapı.

zone

string

Platformdaki biniş alanı.

ticketSeat

object (TicketSeat)

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

ticketSeats[]

object (TicketSeat)

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

transitOperatorName

object (LocalizedString)

Gezinin bu ayağını işleten toplu taşıma operatörünün adı.

transitTerminusName

object (LocalizedString)

Terminus istasyonu veya tren/otobüs/vb. varış noktaları

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ıdır.

customFareClass

object (LocalizedString)

fareClass geçerli değilse kullanılacak özel ücret sınıfıdır. Hem fareClass hem de customFareClass ayarlanmamış olabilir.

coach

string

Biletli koltuğun bulunduğu tren vagonu 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 değerini kullanın.

seatAssignment

object (LocalizedString)

Yolcu koltuğunun ataması. Ör. "belirli bir koltuk yok". seat içinde kullanılacak belirli bir tanımlayıcı olmadığında kullanılmalıdı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. Bu alanda, değerli olması durumunda etkinleştirme durumu yer alır.

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

enum (State)

Eyalet

Sıralamalar
UNKNOWN_STATE
NOT_ACTIVATED Etkinleştirilmedi, varsayılan durum budur
not_activated

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

ACTIVATED Etkin
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, bir kullanıcının cihazını izlemek için sabit bir tanımlayıcı olarak kullanılmamalıdır. Aynı cihazın farklı geçiş kartlarında, hatta aynı cihazda yapılan farklı etkinleştirmelerde bile değişiklik gösterebilir. Bu ayar yapılırken arayanların, etkinleştirilmekte olan nesnede hasLinkedDevice'i de ayarlaması gerekir.

Yöntemler

addmessage

Belirtilen nesne kimliği tarafından başvurulan geçiş nesnesine bir ileti ekler.

get

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

insert

Verilen kimliğe ve özelliklere sahip bir taşıma nesnesi ekler.

list

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

patch

Belirtilen nesne kimliğinin başvurduğu geçiş nesnesini günceller.

update

Belirtilen nesne kimliğinin başvurduğu geçiş nesnesini günceller.