REST Resource: transitobject

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

object (TransitClass)

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

string

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

enum (PassengerType)

O número de passageiros.

string

Os nomes dos passageiros a que a passagem é atribuída. O campo passengerType acima tem como objetivo fornecer contexto ao Google nesse campo.

string

Esse ID é usado para agrupar passagens, caso o usuário tenha salvo várias passagens para a mesma viagem.

enum (TicketStatus)

O status do tíquete. Para estados que afetam a exibição, use o campo state.

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.

enum (ConcessionCategory)

A categoria de concessão da passagem.

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.

object (TicketRestrictions)

Informações sobre os tipos de restrições ao uso do ingresso. Por exemplo, quais dias da semana ele precisa ser usado ou quais trajetos podem ser feitos.

object (PurchaseDetails)

Detalhes da compra desta passagem.

object (TicketLeg)

Uma única passagem 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. Não é possível definir ticketLeg e 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.

string

A cor de fundo do cartão. Se não for definida, será usada a cor dominante da imagem principal e, se nenhuma imagem principal estiver definida, a cor predominante do logotipo será usada. O formato é #rrggbb, em que rrggbb é um trio RGB hexadecimal, como #ffcc00. Você também pode usar a versão abreviada do trio RGB, que é o número rgb, como #fc0.

enum (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.

string

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 precisa incluir apenas caracteres alfanuméricos, ".", "_" ou "-".

string

Obrigatório. A classe associada a este 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ê.

string (int64 format)

Suspenso

enum (State)

Obrigatório. O estado do objeto. Esse campo é usado para determinar como um objeto é exibido no app. Por exemplo, um objeto inactive é movido para a página "Cartões expirados". nesta seção.

object (Barcode)

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

object (Message)

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

object (TimeInterval)

O período em que este objeto será active e o objeto poderá ser usado. O estado de um objeto será alterado para expired quando esse período tiver passado.

object (LatLongPoint)

Observação: no momento, este campo não é suportado para acionar notificações geográficas.

boolean

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

string

O valor que será transmitido para um terminal certificado pelo Toque inteligente por NFC para esse objeto. Os campos no nível da turma enableSmartTap e redemptionIssuers também precisam ser configurados corretamente para que o cartão seja compatível com o Toque inteligente. Somente caracteres ASCII são aceitos.

boolean

Indica se esse objeto está vinculado a um único dispositivo no momento. Esse 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.

boolean

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

No momento, isso só pode ser definido para ofertas.

object (InfoModuleData)

Obsoleto. Use textModulesData.

object (ImageModuleData)

Dados do módulo de imagem. O número máximo de campos exibidos é 1 no nível do objeto e 1 no nível do objeto da classe.

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 desses campos exibidos é 10 para o objeto e 10 para a classe.

object (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.

object (AppLinkData)

Link opcional do app ou site que vai aparecer como um botão na frente do cartão. Se AppLinkData for fornecido para o objeto somente de classe correspondente, AppLinkData será exibido.

object (ActivationStatus)

O status de ativação do objeto. Obrigatório se a classe tiver activationOptions definido.

object (RotatingBarcode)

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

object (DeviceContext)

Contexto do dispositivo associado ao objeto.

object (Image)

Imagem do banner opcional exibida na parte frontal do cartão. Se nenhuma estiver presente, a imagem principal da turma, se houver, será exibida. Se a imagem principal da turma também não estiver presente, nada será exibido.

object (GroupingInfo)

Informações que controlam como os cartões são agrupados.

object (PassConstraints)

Restrições de transmissão para o objeto. Inclui a limitação de comportamentos de NFC e captura de tela.

object (SaveRestrictions)

Restrições no objeto que precisam ser verificadas antes que o usuário tente salvar o cartão. Essas restrições serão aplicadas apenas durante o horário de funcionamento. Se as restrições mudarem depois que o usuário salvar o cartão, as novas restrições não serão aplicadas a um cartão já salvo.

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

object (LocalizedString)

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

object (LocalizedString)

Mais detalhes sobre o routeRestrictions acima.

object (LocalizedString)

Restrições sobre os horários em que este ingresso pode ser usado.

object (LocalizedString)

Restrições extras que não se enquadram na "rota" ou "tempo" categorias.

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

string

Número/identificador do comprovante para rastrear a compra da passagem pelo órgão que a vendeu.

string

A data/hora da compra da passagem.

É uma data/hora em formato estendido ISO 8601, com ou sem deslocamento. A hora pode ser especificada com precisão de nanossegundos. Os deslocamentos podem ser especificados com precisão de segundos, mesmo que os segundos de deslocamento não façam parte da norma ISO 8601.

Exemplo:

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

1985-04-12T19:20:50.52-04:00 seria 20 minutos e 50, 52 segundos após a 19a 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 (EDT). Lembre-se de que a compensação varia em regiões que observam o horário de verão, dependendo da época do ano.

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

Sem as informações de compensação, alguns recursos avançados podem não estar disponíveis.

string

ID da conta usada para comprar a passagem.

string

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

object (TicketCost)

O custo da passagem.

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

object (Money)

O valor nominal do ingresso.

object (Money)

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

object (LocalizedString)

Uma mensagem descrevendo qualquer tipo de desconto aplicado.

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

string

O código da estação de origem. Isso será necessário se destinationStationCode estiver presente ou se originName não estiver presente.

object (LocalizedString)

O nome da estação de origem. Isso será necessário se desinationName estiver presente ou se originStationCode não estiver presente.

string

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

object (LocalizedString)

O nome do destino.

string

A data/hora de partida. Obrigatório se não houver um intervalo de tempo de validade definido no objeto de transporte público.

É uma data/hora em formato estendido ISO 8601, com ou sem deslocamento. A hora pode ser especificada com precisão de nanossegundos. Os deslocamentos podem ser especificados com precisão de segundos, mesmo que os segundos de deslocamento não façam parte da norma ISO 8601.

Exemplo:

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

1985-04-12T19:20:50.52-04:00 seria 20 minutos e 50, 52 segundos após a 19a 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 (EDT). Lembre-se de que a compensação varia em regiões que observam o horário de verão, dependendo da época do ano.

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

A parte da data/hora sem o deslocamento é considerada a "data/hora local". Deve ser 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 precisará ser 2018-06-05T20:00:00. Se a data/hora local na estação de origem for 4 horas antes do UTC, poderá ser anexada uma compensação de -04:00.

Sem as informações de compensação, alguns recursos avançados podem não estar disponíveis.

string

A data/hora de chegada.

É uma data/hora em formato estendido ISO 8601, com ou sem deslocamento. A hora pode ser especificada com precisão de nanossegundos. Os deslocamentos podem ser especificados com precisão de segundos, mesmo que os segundos de deslocamento não façam parte da norma ISO 8601.

Exemplo:

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

1985-04-12T19:20:50.52-04:00 seria 20 minutos e 50, 52 segundos após a 19a 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 (EDT). Lembre-se de que a compensação varia em regiões que observam o horário de verão, dependendo da época do ano.

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

A parte da data/hora sem o deslocamento é 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 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 as informações de compensação, alguns recursos avançados podem não estar disponíveis.

object (LocalizedString)

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

string

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

string

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

string

A zona de embarque dentro da plataforma.

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.

object (TicketSeat)

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

object (LocalizedString)

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

object (LocalizedString)

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

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

enum (FareClass)

A classe de tarifa do assento da passagem.

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.

string

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

string

O identificador de onde o assento da passagem está localizado. Por exemplo: "42". Se não houver um identificador específico, use seatAssigment.

object (LocalizedString)

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

{
  "state": enum (State)
}

enum (State)

{
  "deviceToken": string
}

string

Se definido, as informações de resgate só serão retornadas ao dispositivo especificado após a 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 essa opção, os autores da chamada também precisam definir hasLinkedDevice no objeto que está sendo ativado.