- Recurso: TransitObject
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
- (link em inglês)
- Representação JSON
- PurchaseDetails
- TicketCost (em inglês)
- TicketLeg
- (link em inglês)
- Representação JSON
- TicketSeat (link em inglês)
- FareClass
- TripType
- ActivationStatus
- Estado
- DeviceContext
- Métodos
Recurso: TransitObject
Representação JSON |
---|
{ "classReference": { object ( |
Campos | |
---|---|
classReference |
Uma cópia dos campos herdados da classe mãe. Esses campos são recuperados durante um GET. |
ticketNumber |
O número do ingresso. Esse é um identificador exclusivo da passagem no sistema do operador de transporte público. |
passengerType |
O número de passageiros. |
passengerNames |
Os nomes dos passageiros a quem a passagem está atribuída. O campo |
tripId |
Este ID é usado para agrupar passagens se o usuário salvou várias passagens para a mesma viagem. |
ticketStatus |
Status do tíquete. Para estados que afetam a exibição, use o campo |
customTicketStatus |
Um status personalizado a ser usado como valor do status da passagem quando |
concessionCategory |
A categoria de concessão da passagem. |
customConcessionCategory |
Uma categoria de concessão personalizada a ser usada quando |
ticketRestrictions |
Informações sobre os tipos de restrições ao uso deste ingresso. Por exemplo, em quais dias da semana ele precisa ser usado ou quais rotas podem ser seguidas. |
purchaseDetails |
Detalhes da compra da passagem. |
ticketLeg |
Uma passagem única contém informações de partida e chegada, além de informações sobre embarque e assento. Se mais de um trecho for especificado, use o campo |
ticketLegs[] |
Cada ingresso pode conter um ou mais trechos. Cada trecho contém informações de partida e chegada, além de informações sobre embarque e assento. Se apenas um trecho for especificado, use o campo |
hexBackgroundColor |
A cor de fundo do cartão. Se ela não estiver definida, a cor dominante da imagem principal será usada. Se não houver uma imagem principal definida, a cor dominante do logotipo será usada. O formato é #rrggbb, em que rrggbb é um trio hexadecimal RGB, como |
tripType |
Obrigatório. O tipo de viagem representado por este objeto de transporte público. Usado para determinar o título do cartão e/ou qual símbolo usar entre a origem e o destino. |
id |
Obrigatório. O identificador exclusivo de um objeto. Esse ID precisa ser exclusivo entre todos os objetos de um emissor. Esse valor precisa seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos, ".", "_" ou "-". |
classId |
Obrigatório. A classe associada a esse objeto. A classe precisa ser do mesmo tipo que este objeto, já deve existir e ser aprovada. Os IDs de classe precisam seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. |
version |
Descontinuado |
state |
Obrigatório. O estado do objeto. Esse campo é usado para determinar como um objeto é exibido no app. Por exemplo, um objeto |
barcode |
O tipo e o valor do código de barras. |
messages[] |
Uma matriz de mensagens exibidas no app. Todos os usuários desse objeto vão receber as mensagens associadas. O número máximo destes campos é 10. |
validTimeInterval |
O período em que este objeto será |
locations[] |
Observação: no momento, esse campo não é suportado para acionar notificações geográficas. |
hasUsers |
Indica se o objeto tem usuários. Este campo é definido pela plataforma. |
smartTapRedemptionValue |
O valor que será transmitido para um terminal certificado de Toque inteligente por NFC para este objeto. Os campos de nível de classe |
hasLinkedDevice |
Se este objeto está atualmente vinculado a um único dispositivo. Este campo é definido pela plataforma quando um usuário salva o objeto, vinculando-o ao dispositivo. Destinado ao uso por parceiros selecionados. Entre em contato com o suporte para mais informações. |
disableExpirationNotification |
Indica se as notificações devem ser explicitamente suprimidas. Se esse campo for definido como verdadeiro, independentemente do campo No momento, isso só pode ser definido para ofertas. |
infoModuleData |
Obsoleto. Use textModulesData. |
imageModulesData[] |
Dados do módulo de imagem. O número máximo destes campos exibidos é 1 no nível do objeto e 1 no nível do objeto da classe. |
textModulesData[] |
Dados do módulo de texto. Se os dados do módulo de texto também estiverem definidos na classe, ambos serão exibidos. O número máximo desses campos exibidos é 10 para o objeto e 10 para a classe. |
linksModuleData |
Dados do módulo de links. Se os dados do módulo de links também estiverem definidos na classe, ambos serão exibidos. |
appLinkData |
Link opcional do app ou site que será exibido como botão na frente do cartão. Se AppLinkData for fornecido para o objeto da classe correspondente, somente o objeto AppLinkData será exibido. |
activationStatus |
O status de ativação do objeto. Obrigatório se a classe tiver |
rotatingBarcode |
O tipo e o valor do código de barras rotativo. |
deviceContext |
Contexto do dispositivo associado ao objeto. |
heroImage |
Imagem opcional do banner exibida na frente do cartão. Se nenhuma estiver presente, será exibida a imagem principal da turma. Se a imagem principal da classe também não estiver presente, nada será exibido. |
groupingInfo |
Informações que controlam como os cartões são agrupados. |
passConstraints |
Restrições de transmissão para o objeto. Inclui a limitação de comportamentos de NFC e de capturas de tela. |
PassengerType
Tipos enumerados | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
Alias legado de |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
Alias legado de |
TicketStatus
Tipos enumerados | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
Alias legado de |
REFUNDED |
|
refunded |
Alias legado de |
EXCHANGED |
|
exchanged |
Alias legado de |
ConcessionCategory
Tipos enumerados | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
Alias legado de |
CHILD |
|
child |
Alias legado de |
SENIOR |
|
senior |
Alias legado de |
TicketRestrictions
Representação JSON |
---|
{ "routeRestrictions": { object ( |
Campos | |
---|---|
routeRestrictions |
Restrições sobre rotas que podem ser seguidas. Por exemplo, pode ser a string "Somente trens reservados entre países". |
routeRestrictionsDetails |
Mais detalhes sobre o |
timeRestrictions |
Restrições sobre os horários em que esta passagem pode ser usada. |
otherRestrictions |
Restrições extras que não se enquadram nas categorias "trajeto" ou "horário". |
PurchaseDetails
Representação JSON |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
Campos | |
---|---|
purchaseReceiptNumber |
Número/identificador para rastrear a compra da passagem pelo órgão que a vendeu. |
purchaseDateTime |
A data/hora da compra do ingresso. É uma data/hora em formato estendido ISO 8601, com ou sem compensação. O horário pode ser especificado com precisão de nanossegundos. Os deslocamentos podem ser especificados com precisão de segundos, mesmo que os segundos de compensação não façam parte da ISO 8601. Exemplo:
Sem as informações de compensação, alguns recursos avançados podem não estar disponíveis. |
accountId |
ID da conta usada para comprar a passagem. |
confirmationCode |
O código de confirmação da compra. Pode ser o mesmo para vários ingressos diferentes e é usado para agrupar ingressos. |
ticketCost |
Custo da passagem. |
TicketCost
Representação JSON |
---|
{ "faceValue": { object ( |
Campos | |
---|---|
faceValue |
O valor nominal do ingresso. |
purchasePrice |
O preço real de compra da passagem, após impostos e/ou descontos. |
discountMessage |
Uma mensagem descrevendo qualquer tipo de desconto aplicado. |
TicketLeg
Representação JSON |
---|
{ "originStationCode": string, "originName": { object ( |
Campos | |
---|---|
originStationCode |
O código da estação de origem. Isso é necessário se |
originName |
O nome da estação de origem. Isso é necessário se |
destinationStationCode |
O código da estação de destino. |
destinationName |
O nome do destino. |
departureDateTime |
A data/hora da partida. Isso é necessário quando não há um intervalo de tempo de validade definido no objeto de transporte público. É uma data/hora em formato estendido ISO 8601, com ou sem compensação. O horário pode ser especificado com precisão de nanossegundos. Os deslocamentos podem ser especificados com precisão de segundos, mesmo que os segundos de compensação não façam parte da ISO 8601. Exemplo:
A parte da data/hora sem a compensação é considerada a "data/hora local". É a data/hora local na estação de origem. Por exemplo, se a partida ocorrer na 20a hora de 5 de junho de 2018 na estação de origem, a parte de data/hora local deverá ser Sem as informações de compensação, alguns recursos avançados podem não estar disponíveis. |
arrivalDateTime |
A data/hora de chegada. É uma data/hora em formato estendido ISO 8601, com ou sem compensação. O horário pode ser especificado com precisão de nanossegundos. Os deslocamentos podem ser especificados com precisão de segundos, mesmo que os segundos de compensação não façam parte da ISO 8601. Exemplo:
A parte da data/hora sem a compensação é considerada a "data/hora local". É a data/hora local na estação de destino. Por exemplo, se o evento ocorrer na 20a hora de 5 de junho de 2018 na estação de destino, a parte de data/hora local deverá ser Sem as informações de compensação, alguns recursos avançados podem não estar disponíveis. |
fareName |
Breve descrição/nome da tarifa para este trecho da viagem. Por exemplo, "Uso único a qualquer momento". |
carriage |
O nome/número do trem ou navio em que o passageiro precisa embarcar. |
platform |
A plataforma ou portão em que o passageiro pode embarcar no transporte. |
zone |
A zona de embarque dentro da plataforma. |
ticketSeat |
O assento reservado para os passageiros. Se for necessário especificar mais de um assento, use o campo |
ticketSeats[] |
O assento reservado para os passageiros. Se for especificar apenas um assento, use o campo |
transitOperatorName |
O nome do operador do transporte público que está operando este trecho de uma viagem. |
transitTerminusName |
Estação terminal ou destino do trem/ônibus/etc. |
TicketSeat
Representação JSON |
---|
{ "fareClass": enum ( |
Campos | |
---|---|
fareClass |
A classe de tarifa do assento da passagem. |
customFareClass |
Uma classe de tarifa de cliente a ser usada se nenhum |
coach |
O identificador do vagão ou ônibus em que o assento da passagem está localizado. Por exemplo: "10" |
seat |
O identificador da localização do assento na passagem. Por exemplo: "42". Se não houver um identificador específico, use |
seatAssignment |
A atribuição do assento do passageiro. Por exemplo: "nenhum assento específico". A ser usado quando não houver um identificador específico para usar em |
FareClass
Tipos enumerados | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
Alias legado de |
FIRST |
|
first |
Alias legado de |
BUSINESS |
|
business |
Alias legado de |
TripType
Tipos enumerados | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
Alias legado de |
ONE_WAY |
|
oneWay |
Alias legado de |
ActivationStatus
O status de ativação do objeto. Este campo inclui o status da ativação, caso ele seja valioso.
Representação JSON |
---|
{
"state": enum ( |
Campos | |
---|---|
state |
|
Estado
Tipos enumerados | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
Não ativado, esse é o status padrão |
not_activated |
Alias legado de |
ACTIVATED |
Ativada em |
activated |
Alias legado de |
DeviceContext
Contexto do dispositivo associado ao objeto.
Representação JSON |
---|
{ "deviceToken": string } |
Campos | |
---|---|
deviceToken |
Se este campo for definido, as informações de resgate só serão retornadas para o dispositivo especificado depois da ativação do objeto. Ele não deve ser usado como um identificador estável para rastrear o dispositivo de um usuário. Ele pode mudar em diferentes cartões para o mesmo dispositivo ou até mesmo em diferentes ativações para o mesmo dispositivo. Ao definir este campo, os autores das chamadas também precisam definir hasLinkedDevice no objeto que está sendo ativado. |
Métodos |
|
---|---|
|
Adiciona uma mensagem ao objeto de transporte público indicado pelo código de objeto fornecido. |
|
Retorna o objeto de transporte público com o ID de objeto fornecido. |
|
Insere um objeto de transporte público com o ID e as propriedades fornecidos. |
|
Retorna uma lista de todos os objetos de transporte público de um determinado ID de emissor. |
|
Atualiza o objeto de transporte público indicado pelo ID de objeto fornecido. |
|
Atualiza o objeto de transporte público indicado pelo ID de objeto fornecido. |