Recurso REST: transitobject

Recurso: TransitObject

Representação JSON

{
  "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)
  }
}
Campos
classReference

object (TransitClass)

Uma cópia dos campos herdados da classe pai. Estes campos são recuperados durante um GET.

ticketNumber

string

O número da passagem. É um identificador exclusivo da passagem no sistema do operador de transporte público.

passengerType

enum (PassengerType)

O número de passageiros.

passengerNames

string

Os nomes dos passageiros a quem a passagem está atribuída. O campo passengerType acima destina-se a contextualizar o Google neste campo.

tripId

string

Este código é usado para agrupar passagens, caso o usuário tenha salvo várias passagens para a mesma viagem.

ticketStatus

enum (TicketStatus)

O status da passagem. Para estados que afetam a exibição, use o campo state.

customTicketStatus

object (LocalizedString)

Um status personalizado a ser usado como valor do status da passagem quando ticketStatus não fornece a opção correta. Não é possível definir ticketStatus e customTicketStatus, apenas um deles.

concessionCategory

enum (ConcessionCategory)

A categoria de concessão da passagem.

customConcessionCategory

object (LocalizedString)

Uma categoria de concessão personalizada a ser usada quando concessionCategory não fornece a opção correta. Não é possível definir concessionCategory e customConcessionCategory, apenas um deles.

ticketRestrictions

object (TicketRestrictions)

Informações sobre tipo de restrições ao uso desta passagem. Por exemplo, quais dias da semana ele precisa ser usado ou quais rotas podem ser seguidas.

purchaseDetails

object (PurchaseDetails)

Detalhes da compra desta passagem.

ticketLeg

object (TicketLeg)

Uma única passagem contém informações sobre partida e chegada, além de informações sobre embarque e assento. Se mais de um trecho for especificado, use o campo ticketLegs. Não é possível definir ticketLeg e ticketLegs, apenas um deles.

ticketLegs[]

object (TicketLeg)

Cada passagem 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 ticketLeg. Não é possível definir ticketLeg e ticketLegs, apenas um deles.

hexBackgroundColor

string

A cor de fundo do cartão. Se não estiver definida, será usada a cor predominante da imagem principal e, se não houver nenhuma imagem principal definida, será usada a cor predominante do logotipo. O formato é #rrggbb, em que rrggbb é um trio RGB hexadecimal, como #ffcc00. Também é possível usar a versão abreviada do trio RGB, que é #rgb, como #fc0.

tripType

enum (TripType)

O tipo de viagem representado por este objeto de transporte público. Usado para determinar qual símbolo usar entre a origem e o destino.

id

string

O identificador exclusivo de um objeto. Este código precisa ser exclusivo entre todos os objetos de um emissor. Este valor deve seguir o formato código do emissor.identificador, em que o primeiro é emitido pelo Google e o último é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos: ".", "_" ou "-".

classId

string

A classe associada a este objeto. É preciso que a classe seja do mesmo tipo que este objeto, já existente e aprovada.

Os códigos de classe devem seguir o formato código do emissor.identificador, em que o primeiro é emitido pelo Google e o último é escolhido por você.

version
(deprecated)

string (int64 format)

Obsoleto

state

enum (State)

O estado do objeto. Este campo é usado para determinar como um objeto é exibido no app. Por exemplo, um objeto inactive não é mais exibido no app Google Pay.

barcode

object (Barcode)

O tipo e o valor do código de barras.

messages[]

object (Message)

Uma matriz de mensagens exibidas no app. Todos os usuários deste objeto receberão as mensagens associadas. O número máximo destes campos é 10.

validTimeInterval

object (TimeInterval)

O período em que este objeto fica active e pode ser usado. O estado de um objeto será alterado para expired quando este período se esgotar.

locations[]

object (LatLongPoint)

A lista de locais em que o objeto pode ser usado. A plataforma usa estas informações para acionar notificações de geolocalização para os usuários. Observe que os locais no objeto modificam os locais na classe, que modificam os locais no código do Google Places.

hasUsers

boolean

Indica se o objeto tem usuários. Este campo é definido pela plataforma.

smartTapRedemptionValue

string

Disponível apenas para parceiros que aceitam smart tap. Entre em contato com o suporte para mais orientações.

hasLinkedDevice

boolean

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

boolean

Indica se as notificações devem ser explicitamente suprimidas. Se este campo estiver definido como verdadeiro, independentemente do campo messages, as notificações de expiração enviadas ao usuário serão suprimidas. Por padrão, este campo é definido como falso.

Atualmente, só é possível definir isso para ofertas.

infoModuleData

object (InfoModuleData)

Obsoleto. Use textModulesData.

imageModulesData[]

object (ImageModuleData)

Dados do módulo de imagem. Se os dados dos módulos de imagem também estiverem definidos na classe, eles serão mesclados com os dados de imagem definidos no objeto. O número máximo destes campos (em combinação com a classe) é 1.

textModulesData[]

object (TextModuleData)

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 destes campos (em combinação com a classe) é 10.

PassengerType

Enums
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

Alias legado de SINGLE_PASSENGER. Obsoleto.

MULTIPLE_PASSENGERS
multiplePassengers

Alias legado de MULTIPLE_PASSENGERS. Obsoleto.

TicketStatus

Enums
TICKET_STATUS_UNSPECIFIED
USED
used

Alias legado de USED. Obsoleto.

REFUNDED
refunded

Alias legado de REFUNDED. Obsoleto.

EXCHANGED
exchanged

Alias legado de EXCHANGED. Obsoleto.

ConcessionCategory

Enums
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

Alias legado de ADULT. Obsoleto.

CHILD
child

Alias legado de CHILD. Obsoleto.

SENIOR
senior

Alias legado de SENIOR. Obsoleto.

TicketRestrictions

Representação JSON

{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}
Campos
routeRestrictions

object (LocalizedString)

Restrições sobre rotas que podem ser tomadas. Por exemplo, pode ser a string "Somente trens reservados entre países".

routeRestrictionsDetails

object (LocalizedString)

Mais detalhes sobre routeRestrictions acima.

timeRestrictions

object (LocalizedString)

Restrições sobre os horários em que esta passagem pode ser usada.

otherRestrictions

object (LocalizedString)

Restrições extras que não se enquadram nas categorias "rota" ou "horário".

PurchaseDetails

Representação JSON

{
  "purchaseReceiptNumber": string,
  "purchaseDateTime": string,
  "accountId": string,
  "confirmationCode": string,
  "ticketCost": {
    object (TicketCost)
  }
}
Campos
purchaseReceiptNumber

string

Número/identificador de recibo para rastrear a compra da passagem por meio da entidade que a vendeu.

purchaseDateTime

string

A data/hora da compra da passagem.

É uma data/hora em formato estendido ISO 8601, com ou sem compensação. O horário pode ser especificado com precisão de nanossegundos. As compensações podem ser especificadas com precisão de segundos, mesmo que os segundos de compensação não façam parte do padrão ISO 8601.

Exemplo:

1985-04-12T23:20:50.52Z seriam 20 minutos e 50,52 segundos após a 23ª hora de 12 de abril de 1985 no UTC.

1985-04-12T19:20:50.52-04:00 seriam 20 minutos e 50,52 segundos após a 19ª hora de 12 de abril de 1985, 4 horas antes do UTC (mesmo instante no tempo do exemplo acima). Se o evento fosse em Nova York, seria o equivalente ao horário de verão do leste dos EUA (EDT, na sigla em inglês). Lembre-se de que a compensação varia em regiões que seguem o horário de verão, dependendo da época do ano.

1985-04-12T19:20:50.52 seriam 20 minutos e 50,52 segundos após a 19ª hora de 12 de abril de 1985 sem informações de compensação.

Sem informações de compensação, talvez alguns recursos avançados não fiquem disponíveis.

accountId

string

Código da conta usada para comprar a passagem.

confirmationCode

string

O código de confirmação da compra. Pode ser igual para várias passagens diferentes e é usado para agrupar passagens.

ticketCost

object (TicketCost)

O custo da passagem.

TicketCost

Representação JSON

{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}
Campos
faceValue

object (Money)

O valor nominal da passagem.

purchasePrice

object (Money)

O preço de compra real da passagem, após impostos e/ou descontos.

discountMessage

object (LocalizedString)

Uma mensagem que descreve qualquer tipo de desconto aplicado.

TicketLeg

Representação JSON

{
  "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)
  }
}
Campos
originStationCode

string

O código da estação de origem. Isso é necessário quando destinationStationCode está presente ou originName não está presente.

originName

object (LocalizedString)

O nome da estação de origem. Isso é necessário quando desinationName está presente ou originStationCode não está presente.

destinationStationCode

string

O código da estação de destino.

destinationName

object (LocalizedString)

O nome do destino.

departureDateTime

string

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. As compensações podem ser especificadas com precisão de segundos, mesmo que os segundos de compensação não façam parte do padrão ISO 8601.

Exemplo:

1985-04-12T23:20:50.52Z seriam 20 minutos e 50,52 segundos após a 23ª hora de 12 de abril de 1985 no UTC.

1985-04-12T19:20:50.52-04:00 seriam 20 minutos e 50,52 segundos após a 19ª hora de 12 de abril de 1985, 4 horas antes do UTC (mesmo instante no tempo do exemplo acima). Se o evento fosse em Nova York, seria o equivalente ao horário de verão do leste dos EUA (EDT, na sigla em inglês). Lembre-se de que a compensação varia em regiões que seguem o horário de verão, dependendo da época do ano.

1985-04-12T19:20:50.52 seriam 20 minutos e 50,52 segundos após a 19ª hora de 12 de abril de 1985 sem informações de compensação.

A parte da data/hora sem a compensação é considerada "data/hora local". É a data/hora local na estação de origem. Por exemplo, se a partida ocorrer na 20ª hora de 5 de junho de 2018 na estação de origem, a parte da data/hora local deverá ser 2018-06-05T20:00:00. Se a data/hora local na estação de origem for 4 horas antes do UTC, pode ser acrescentada uma compensação de -04:00.

Sem informações de compensação, talvez alguns recursos avançados não fiquem disponíveis.

arrivalDateTime

string

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. As compensações podem ser especificadas com precisão de segundos, mesmo que os segundos de compensação não façam parte do padrão ISO 8601.

Exemplo:

1985-04-12T23:20:50.52Z seriam 20 minutos e 50,52 segundos após a 23ª hora de 12 de abril de 1985 no UTC.

1985-04-12T19:20:50.52-04:00 seriam 20 minutos e 50,52 segundos após a 19ª hora de 12 de abril de 1985, 4 horas antes do UTC (mesmo instante no tempo do exemplo acima). Se o evento fosse em Nova York, seria o equivalente ao horário de verão do leste dos EUA (EDT, na sigla em inglês). Lembre-se de que a compensação varia em regiões que seguem o horário de verão, dependendo da época do ano.

1985-04-12T19:20:50.52 seriam 20 minutos e 50,52 segundos após a 19ª hora de 12 de abril de 1985 sem informações de compensação.

A parte da data/hora sem a compensação é considerada "data/hora local". É a data/hora local na estação de destino. Por exemplo, se o evento ocorrer na 20ª hora de 5 de junho de 2018 na estação de destino, a parte da data/hora local será 2018-06-05T20:00:00. Se a data/hora local na estação de destino for 4 horas antes do UTC, poderá ser acrescentada uma compensação de -04:00.

Sem informações de compensação, talvez alguns recursos avançados não fiquem disponíveis.

fareName

object (LocalizedString)

Breve descrição/nome da tarifa deste trecho da viagem. Por exemplo, "Uso único quando quiser".

carriage

string

O nome/número do trem ou navio em que o passageiro precisa embarcar.

platform

string

A plataforma ou portão em que o passageiro pode embarcar no transporte.

zone

string

A zona de embarque dentro da plataforma.

ticketSeat

object (TicketSeat)

O assento reservado para os passageiros. Se for necessário especificar mais de um assento, use o campo ticketSeats. Não é possível definir ticketSeat e ticketSeats, apenas um deles.

ticketSeats[]

object (TicketSeat)

O assento reservado para os passageiros. Se for especificar apenas um assento, use o campo ticketSeat. Não é possível definir ticketSeat e ticketSeats, apenas um deles.

transitOperatorName

object (LocalizedString)

O nome do operador do transporte público que está operando este trecho de uma viagem.

transitTerminusName

object (LocalizedString)

Estação terminal ou destino do trem/ônibus/etc.

TicketSeat

Representação JSON

{
  "fareClass": enum (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}
Campos
fareClass

enum (FareClass)

A classe de tarifa do assento da passagem.

customFareClass

object (LocalizedString)

Uma classe de tarifa de cliente a ser usada se nenhum fareClass for aplicável. Não é possível definir fareClass e customFareClass, apenas um deles.

coach

string

O identificador do vagão ou trem em que o assento da passagem está localizado. Por exemplo, "10".

seat

string

O identificador do local em que está o assento da passagem. Por exemplo, "42". Se não houver um identificador específico, use seatAssigment.

seatAssignment

object (LocalizedString)

A atribuição do assento do passageiro. Por exemplo. "sem assento específico". A ser usado quando não houver um identificador específico para usar em seat.

FareClass

Enums
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

Alias legado de ECONOMY. Obsoleto.

FIRST
first

Alias legado de FIRST. Obsoleto.

BUSINESS
business

Alias legado de BUSINESS. Obsoleto.

TripType

Enums
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

Alias legado de ROUND_TRIP. Obsoleto.

ONE_WAY
oneWay

Alias legado de ONE_WAY. Obsoleto.

Métodos

addmessage

Adiciona uma mensagem ao objeto de transporte público indicado pelo código de objeto fornecido.

get

Retorna o objeto de transporte público com o código de objeto fornecido.

insert

Insere um objeto de transporte público com o código e as propriedades fornecidos.

list

Retorna uma lista de todos os objetos de transporte público de um determinado código de emissor.

patch

Atualiza o objeto de transporte público indicado pelo código de objeto fornecido.

update

Atualiza o objeto de transporte público indicado pelo código de objeto fornecido.