Índice
TransitClassService
(interface)TransitObjectService
(interface)PurchaseDetails
(mensagem)TicketCost
(mensagem)TicketLeg
(mensagem)TicketRestrictions
(mensagem)TicketSeat
(mensagem)TicketSeat.FareClass
(enum)TransitClass
(mensagem)TransitClass.TransitType
(enum)TransitClassAddMessageRequest
(mensagem)TransitClassAddMessageResponse
(mensagem)TransitClassGetRequest
(mensagem)TransitClassInsertRequest
(mensagem)TransitClassListRequest
(mensagem)TransitClassListResponse
(mensagem)TransitClassPatchRequest
(mensagem)TransitClassUpdateRequest
(mensagem)TransitObject
(mensagem)TransitObject.ConcessionCategory
(enum)TransitObject.PassengerType
(enum)TransitObject.TicketStatus
(enum)TransitObject.TripType
(enum)TransitObjectAddMessageRequest
(mensagem)TransitObjectAddMessageResponse
(mensagem)TransitObjectGetRequest
(mensagem)TransitObjectInsertRequest
(mensagem)TransitObjectListRequest
(mensagem)TransitObjectListResponse
(mensagem)TransitObjectPatchRequest
(mensagem)TransitObjectUpdateRequest
(mensagem)
TransitClassService
AddMessage | |
---|---|
Adiciona uma mensagem à classe de transporte público indicada pelo código de classe fornecido.
|
Get | |
---|---|
Retorna a classe de transporte público com o código de classe fornecido.
|
Insert | |
---|---|
Insere uma classe de transporte público com o código e as propriedades fornecidos.
|
List | |
---|---|
Retorna uma lista de todas as classes de transporte público de um determinado código de emissor.
|
Patch | |
---|---|
Atualiza a classe de transporte público indicada pelo código de classe fornecido. Este método é compatível com a semântica de patch.
|
Update | |
---|---|
Atualiza a classe de transporte público indicada pelo código de classe fornecido.
|
TransitObjectService
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. Este método é compatível com a semântica de patch.
|
Update | |
---|---|
Atualiza o objeto de transporte público indicado pelo código de objeto fornecido.
|
PurchaseDetails
Campos | |
---|---|
purchase_receipt_number |
Número/identificador de recibo para rastrear a compra da passagem por meio da entidade que a vendeu. |
purchase_date_time |
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:
Sem informações de compensação, talvez alguns recursos avançados não fiquem disponíveis. |
account_id |
Código da conta usada para comprar a passagem. |
confirmation_code |
O código de confirmação da compra. Pode ser igual para várias passagens diferentes e é usado para agrupar passagens. |
ticket_cost |
O custo da passagem. |
TicketCost
Campos | |
---|---|
face_value |
O valor nominal da passagem. |
purchase_price |
O preço de compra real da passagem, após impostos e/ou descontos. |
discount_message |
Uma mensagem que descreve qualquer tipo de desconto aplicado. |
TicketLeg
Campos | |
---|---|
origin_station_code |
O código da estação de origem. Isso será necessário se |
origin_name |
O nome da estação de origem. Isso será necessário se |
destination_station_code |
O código da estação de destino. |
destination_name |
O nome do destino. |
departure_date_time |
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:
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 do dia 5 de junho de 2018 na estação de origem, a parte de data e hora local deverá ser Sem informações de compensação, talvez alguns recursos avançados não fiquem disponíveis. |
arrival_date_time |
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:
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 do dia 5 de junho de 2018 na estação de destino, a parte de data e hora local deverá ser Sem informações de compensação, talvez alguns recursos avançados não fiquem disponíveis. |
fare_name |
Breve descrição/nome da tarifa deste trecho da viagem. Por exemplo, "Uso único quando quiser". |
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. |
ticket_seat |
O assento reservado para os passageiros. Se for preciso especificar mais de um assento, use o campo |
ticket_seats[] |
O assento reservado para os passageiros. Se for preciso especificar apenas um assento, use o campo |
transit_operator_name |
O nome do operador do transporte público que está operando este trecho da viagem. |
transit_terminus_name |
Estação terminal ou destino do trem/ônibus/etc. |
TicketRestrictions
Campos | |
---|---|
route_restrictions |
Restrições sobre rotas que podem ser tomadas. Por exemplo, pode ser a string "Somente trens reservados entre países". |
route_restrictions_details |
Mais detalhes sobre as |
time_restrictions |
Restrições sobre os horários em que esta passagem pode ser usada. |
other_restrictions |
Restrições extras que não se enquadram nas categorias "rota" ou "horário". |
TicketSeat
Campos | |
---|---|
fare_class |
A classe de tarifa do assento da passagem. |
custom_fare_class |
Uma classe de tarifa específica a ser usada se nenhuma |
coach |
O identificador do vagão ou ônibus em que o assento da passagem está localizado. Por exemplo: "10" |
seat |
O identificador do local em que está o assento da passagem. Por exemplo: "42". Se não houver um identificador específico, use |
seat_assignment |
A atribuição do assento do passageiro. Por exemplo: "sem assento específico". Para ser usada quando não houver um identificador específico para usar em |
FareClass
Enums | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
Alias legado de |
FIRST |
|
first |
Alias legado de |
BUSINESS |
|
business |
Alias legado de |
TransitClass
Campos | |
---|---|
transit_operator_name |
O nome do operador do transporte público. |
logo |
Obrigatório. A imagem do logotipo do ingresso. Essa imagem é exibida na visualização de detalhes do cartão do app. |
transit_type |
Obrigatório. O tipo de transporte público representado por esta classe, como "ônibus". |
watermark |
Imagem de marca-d'água a exibir no dispositivo do usuário. |
language_override |
Se este campo estiver presente, as passagens de transporte público exibidas no dispositivo de um usuário sempre estarão neste idioma. Representa a tag de idioma do BCP 47. Valores de exemplo: "en-US", "en-GB", "de" ou "de-AT". |
custom_transit_terminus_name_label |
Um rótulo personalizado para usar como valor do nome do terminal de transporte público ( |
custom_ticket_number_label |
Um rótulo personalizado para usar como valor do número do bilhete ( |
custom_route_restrictions_label |
Um rótulo personalizado para usar como valor das restrições de rota ( |
custom_route_restrictions_details_label |
Um rótulo personalizado para usar como valor dos detalhes de restrições de rota ( |
custom_time_restrictions_label |
Um rótulo personalizado para usar como valor dos detalhes de restrições de tempo ( |
custom_other_restrictions_label |
Um rótulo personalizado para usar como valor de outras restrições ( |
custom_purchase_receipt_number_label |
Um rótulo personalizado para usar como valor do número do comprovante de compra ( |
custom_confirmation_code_label |
Um rótulo personalizado para usar como valor do código de confirmação ( |
custom_purchase_face_value_label |
Um rótulo personalizado para usar como valor de face da compra ( |
custom_purchase_price_label |
Um rótulo personalizado para usar como valor do preço de compra ( |
custom_discount_message_label |
Um rótulo personalizado para usar como valor da mensagem de desconto do transporte público ( |
custom_carriage_label |
Um rótulo personalizado para usar como valor do transporte ( |
custom_seat_label |
Um rótulo personalizado para usar como valor do assento ( |
custom_coach_label |
Um rótulo personalizado para usar como valor do vagão ( |
custom_platform_label |
Um rótulo personalizado para usar como valor da plataforma de embarque ( |
custom_zone_label |
Um rótulo personalizado para usar como valor da zona de embarque ( |
custom_fare_class_label |
Um rótulo personalizado para usar como valor da classe de tarifa ( |
custom_concession_category_label |
Um rótulo personalizado para usar como valor da categoria de concessão de transporte público ( |
custom_fare_name_label |
Um rótulo personalizado para usar como valor do nome da tarifa de transporte público ( |
class_template_info |
Informações de modelo sobre como a classe deve ser exibida. Se não estiver definido, o Google usará como alternativa um conjunto padrão de campos a serem exibidos. |
enable_single_leg_itinerary |
Controla a exibição do itinerário de trecho único para esta classe. Por padrão, itinerários só são exibidos para viagens de vários trechos. |
id |
Obrigatório. O identificador exclusivo de uma classe. Este ID precisa ser exclusivo entre todas as classes 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 "-". |
version |
Obsoleto |
issuer_name |
Obrigatório. O nome do emissor. O tamanho máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores. |
messages[] |
Um conjunto de mensagens exibidas no app. Todos os usuários deste objeto receberão as mensagens associadas. O número máximo destes campos é 10. |
allow_multiple_users_per_object |
Obsoleto. Use |
homepage_uri |
O URI da página inicial do seu aplicativo. Preencher o URI neste campo resulta no mesmo comportamento que o preenchimento de um URI em linksModuleData: quando um objeto é renderizado, um link para a página inicial é mostrado no que normalmente seria considerado a seção linksModuleData do objeto. |
locations[] |
|
review_status |
Obrigatório. O status da classe. Este campo pode ser definido como Você precisa manter esse campo como Quando acreditar que a classe está pronta para uso, defina este campo como Ao atualizar uma classe já |
review |
Os comentários de revisão definidos pela plataforma quando uma classe é marcada como |
info_module_data |
Obsoleto. Use textModulesData. |
image_modules_data[] |
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. |
text_modules_data[] |
Dados do módulo de texto. Se esses dados também estiverem definidos na classe, ambos serão exibidos. O número máximo de campos exibidos é 10 para o objeto e 10 para a classe. |
links_module_data |
Dados do módulo de links. Se os dados do módulo de links também estiverem definidos no objeto, ambos serão exibidos. |
redemption_issuers[] |
Disponível apenas para parceiros que aceitam smart tap. Entre em contato com o suporte para mais orientações. |
country_code |
Código do país, usado para exibir o país do cartão (quando o usuário não está nesse país), bem como para exibir o conteúdo localizado quando o conteúdo não está disponível na localidade do usuário |
hero_image |
Imagem de banner opcional exibida na frente do cartão. Se não houver nenhuma, nada será exibido. A imagem será exibida com 100% de largura. |
word_mark |
Obsoleto. |
enable_smart_tap |
Disponível apenas para parceiros que aceitam smart tap. Entre em contato com o suporte para mais orientações. |
hex_background_color |
A cor de fundo do cartão. Se não estiver definida, a cor predominante da imagem principal será usada. Se não houver nenhuma imagem principal definida, a cor predominante do logotipo será usada. O formato é #rrggbb, em que rrggbb é um trio hexadecimal RGB, como |
localized_issuer_name |
Strings traduzidas do issuer_name. O tamanho máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores. |
multiple_devices_and_holders_allowed_status |
Identifica se vários usuários e dispositivos salvarão o mesmo objeto que faz referência a esta classe. |
callback_options |
Opções de callback a serem usadas para retornar ao emissor em cada salvamento/exclusão de um objeto desta classe pelo usuário final. Todos os objetos desta classe são qualificados para callback. |
TransitType
Enums | |
---|---|
TRANSIT_TYPE_UNSPECIFIED |
|
BUS |
|
bus |
Alias legado de |
RAIL |
|
rail |
Alias legado de |
TRAM |
|
tram |
Alias legado de |
FERRY |
|
ferry |
Alias legado de |
OTHER |
|
other |
Alias legado de |
TransitClassAddMessageRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de uma classe. Este ID precisa ser exclusivo entre todas as classes 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 "-". |
add_message_request |
Corpo da solicitação. |
TransitClassAddMessageResponse
Campos | |
---|---|
resource |
O recurso classe de transporte público atualizado. |
TransitClassGetRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de uma classe. Este ID precisa ser exclusivo entre todas as classes 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 "-". |
TransitClassInsertRequest
Campos | |
---|---|
resource |
Corpo da solicitação. |
TransitClassListRequest
Campos | |
---|---|
issuer_id |
O ID do emissor autorizado a listar classes. |
token |
Usado para conseguir o próximo conjunto de resultados se |
max_results |
Identifica o número máximo de resultados retornados por uma lista. Todos os resultados serão retornados se |
TransitClassListResponse
Campos | |
---|---|
resources[] |
Recursos correspondentes à solicitação de lista. |
pagination |
Paginação da resposta. |
TransitClassPatchRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de uma classe. Este ID precisa ser exclusivo entre todas as classes 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 "-". |
resource |
Corpo da solicitação. |
TransitClassUpdateRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de uma classe. Este ID precisa ser exclusivo entre todas as classes 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 "-". |
resource |
Corpo da solicitação. |
TransitObject
Campos | |
---|---|
class_reference |
Uma cópia dos campos herdados da classe pai. Estes campos são recuperados durante um GET. |
ticket_number |
O número da passagem. É um identificador exclusivo da passagem no sistema do operador de transporte público. |
passenger_type |
O número de passageiros. |
passenger_names |
Os nomes dos passageiros a quem a passagem está atribuída. O campo |
trip_id |
Este código é usado para agrupar passagens, caso o usuário tenha salvado várias passagens para a mesma viagem. |
ticket_status |
O status da passagem. Para estados que afetam a exibição, use o campo |
custom_ticket_status |
Um status personalizado para usar como valor do status da passagem quando |
concession_category |
A categoria de concessão da passagem. |
custom_concession_category |
Uma categoria de concessão personalizada a ser usada quando |
ticket_restrictions |
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. |
purchase_details |
Detalhes da compra desta passagem. |
ticket_leg |
Uma passagem única 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 |
ticket_legs[] |
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 |
hex_background_color |
A cor de fundo do cartão. Se não estiver definida, a cor predominante da imagem principal será usada. Se não houver nenhuma imagem principal definida, a cor predominante do logotipo será usada. O formato é #rrggbb, em que rrggbb é um trio hexadecimal RGB, como |
trip_type |
Obrigatório. 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 |
Obrigatório. O identificador exclusivo de um objeto. Este 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 "-". |
class_id |
Obrigatório. A classe associada a este objeto. É preciso que a classe seja do mesmo tipo que este objeto, já existente e 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 |
Obsoleto |
state |
Obrigatório. O estado do objeto. Este 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[] |
Um conjunto de mensagens exibidas no app. Todos os usuários deste objeto receberão as mensagens associadas. O número máximo destes campos é 10. |
valid_time_interval |
O período em que esse objeto fica |
locations[] |
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 por sua vez modificam os locais no ID do Google Places. |
has_users |
Indica se o objeto tem usuários. Este campo é definido pela plataforma. |
smart_tap_redemption_value |
Disponível apenas para parceiros que aceitam smart tap. Entre em contato com o suporte para mais orientações. |
has_linked_device |
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. |
disable_expiration_notification |
Indica se as notificações devem ser explicitamente suprimidas. Se esse campo estiver definido como verdadeiro, independentemente do campo Atualmente, só é possível definir isso para ofertas. |
info_module_data |
Obsoleto. Use textModulesData. |
image_modules_data[] |
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. |
text_modules_data[] |
Dados do módulo de texto. Se esses dados também estiverem definidos na classe, ambos serão exibidos. O número máximo de campos exibidos é 10 para o objeto e 10 para a classe. |
links_module_data |
Dados do módulo de links. Se os dados do módulo de links também estiverem definidos na classe, ambos serão exibidos. |
app_link_data |
Informações opcionais sobre o link do app do parceiro. |
ConcessionCategory
Enums | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
Alias legado de |
CHILD |
|
child |
Alias legado de |
SENIOR |
|
senior |
Alias legado de |
PassengerType
Enums | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
Alias legado de |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
Alias legado de |
TicketStatus
Enums | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
Alias legado de |
REFUNDED |
|
refunded |
Alias legado de |
EXCHANGED |
|
exchanged |
Alias legado de |
TripType
Enums | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
Alias legado de |
ONE_WAY |
|
oneWay |
Alias legado de |
TransitObjectAddMessageRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de um objeto. Este 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 "-". |
add_message_request |
Corpo da solicitação. |
TransitObjectAddMessageResponse
Campos | |
---|---|
resource |
O recurso TransitObject atualizado. |
TransitObjectGetRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de um objeto. Este 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 "-". |
TransitObjectInsertRequest
Campos | |
---|---|
resource |
Corpo da solicitação. |
TransitObjectListRequest
Campos | |
---|---|
class_id |
O ID da classe que terá objetos listados. |
token |
Usado para conseguir o próximo conjunto de resultados se |
max_results |
Identifica o número máximo de resultados retornados por uma lista. Todos os resultados serão retornados se |
TransitObjectListResponse
Campos | |
---|---|
resources[] |
Recursos correspondentes à solicitação de lista. |
pagination |
Paginação da resposta. |
TransitObjectPatchRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de um objeto. Este 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 "-". |
resource |
Corpo da solicitação. |
TransitObjectUpdateRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de um objeto. Este 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 "-". |
resource |
Corpo da solicitação. |