Pacote google.walletobjects.v1.transit

Índice

TransitClassService

AddMessage

rpc AddMessage(TransitClassAddMessageRequest) returns (TransitClassAddMessageResponse)

Adiciona uma mensagem à classe de transporte público indicada pelo código de classe fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(TransitClassGetRequest) returns (TransitClass)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(TransitClassInsertRequest) returns (TransitClass)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(TransitClassListRequest) returns (TransitClassListResponse)

Retorna uma lista de todas as classes de transporte público de um determinado código de emissor.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(TransitClassPatchRequest) returns (TransitClass)

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.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(TransitClassUpdateRequest) returns (TransitClass)

Atualiza a classe de transporte público indicada pelo código de classe fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer

TransitObjectService

AddMessage

rpc AddMessage(TransitObjectAddMessageRequest) returns (TransitObjectAddMessageResponse)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(TransitObjectGetRequest) returns (TransitObject)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(TransitObjectInsertRequest) returns (TransitObject)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(TransitObjectListRequest) returns (TransitObjectListResponse)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(TransitObjectPatchRequest) returns (TransitObject)

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.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(TransitObjectUpdateRequest) returns (TransitObject)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer

PurchaseDetails

Campos
purchase_receipt_number

string

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

purchase_date_time

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 seria 20 minutos e 50,52 segundos após as 23h 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 19ª hora de 12 de abril de 1985, 4 horas antes do UTC (no mesmo instante que o 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 seria 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.

account_id

string

Código da conta usada para comprar a passagem.

confirmation_code

string

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

ticket_cost

TicketCost

O custo da passagem.

TicketCost

Campos
face_value

Money

O valor nominal da passagem.

purchase_price

Money

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

discount_message

LocalizedString

Uma mensagem que descreve qualquer tipo de desconto aplicado.

TicketLeg

Campos
origin_station_code

string

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

origin_name

LocalizedString

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

destination_station_code

string

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

destination_name

LocalizedString

O nome do destino.

departure_date_time

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 seria 20 minutos e 50,52 segundos após as 23h 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 19ª hora de 12 de abril de 1985, 4 horas antes do UTC (no mesmo instante que o 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 seria 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 do dia 5 de junho de 2018 na estação de origem, a parte de data e 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, 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.

arrival_date_time

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 seria 20 minutos e 50,52 segundos após as 23h 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 19ª hora de 12 de abril de 1985, 4 horas antes do UTC (no mesmo instante que o 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 seria 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 do dia 5 de junho de 2018 na estação de destino, a parte de data e 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 informações de compensação, talvez alguns recursos avançados não fiquem disponíveis.

fare_name

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.

ticket_seat

TicketSeat

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

ticket_seats[]

TicketSeat

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

transit_operator_name

LocalizedString

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

transit_terminus_name

LocalizedString

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

TicketRestrictions

Campos
route_restrictions

LocalizedString

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

route_restrictions_details

LocalizedString

Mais detalhes sobre as routeRestrictions acima.

time_restrictions

LocalizedString

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

other_restrictions

LocalizedString

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

TicketSeat

Campos
fare_class

FareClass

A classe de tarifa do assento da passagem.

custom_fare_class

LocalizedString

Uma classe de tarifa específica a ser usada se nenhuma fareClass for aplicável. Não é possível definir os dois (fareClass e customFareClass), apenas um deles.

coach

string

O identificador do vagão ou ônibus 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.

seat_assignment

LocalizedString

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

TransitClass

Campos
transit_operator_name

LocalizedString

O nome do operador do transporte público.

transit_type

TransitType

Obrigatório. O tipo de transporte público representado por esta classe, como "ônibus".

watermark

Image

Imagem de marca-d'água a exibir no dispositivo do usuário.

language_override

string

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

LocalizedString

Um rótulo personalizado para usar como valor do nome do terminal de transporte público (transitObject.ticketLeg.transitTerminusName).

custom_ticket_number_label

LocalizedString

Um rótulo personalizado para usar como valor do número do bilhete (transitObject.ticketNumber).

custom_route_restrictions_label

LocalizedString

Um rótulo personalizado para usar como valor das restrições de rota (transitObject.ticketRestrictions.routeRestrictions).

custom_route_restrictions_details_label

LocalizedString

Um rótulo personalizado para usar como valor dos detalhes de restrições de rota (transitObject.ticketRestrictions.routeRestrictionsDetails).

custom_time_restrictions_label

LocalizedString

Um rótulo personalizado para usar como valor dos detalhes de restrições de tempo (transitObject.ticketRestrictions.timeRestrictions).

custom_other_restrictions_label

LocalizedString

Um rótulo personalizado para usar como valor de outras restrições (transitObject.ticketRestrictions.otherRestrictions).

custom_purchase_receipt_number_label

LocalizedString

Um rótulo personalizado para usar como valor do número do comprovante de compra (transitObject.purchaseDetails.purchaseReceiptNumber).

custom_confirmation_code_label

LocalizedString

Um rótulo personalizado para usar como valor do código de confirmação (transitObject.purchaseDetails.confirmationCode).

custom_purchase_face_value_label

LocalizedString

Um rótulo personalizado para usar como valor de face da compra (transitObject.purchaseDetails.ticketCost.faceValue).

custom_purchase_price_label

LocalizedString

Um rótulo personalizado para usar como valor do preço de compra (transitObject.purchaseDetails.ticketCost.purchasePrice).

custom_discount_message_label

LocalizedString

Um rótulo personalizado para usar como valor da mensagem de desconto do transporte público (transitObject.purchaseDetails.ticketCost.discountMessage).

custom_carriage_label

LocalizedString

Um rótulo personalizado para usar como valor do transporte (transitObject.ticketLeg.carriage).

custom_seat_label

LocalizedString

Um rótulo personalizado para usar como valor do assento (transitObject.ticketLeg.ticketSeat.seat).

custom_coach_label

LocalizedString

Um rótulo personalizado para usar como valor do vagão (transitObject.ticketLeg.ticketSeat.coach).

custom_platform_label

LocalizedString

Um rótulo personalizado para usar como valor da plataforma de embarque (transitObject.ticketLeg.platform).

custom_zone_label

LocalizedString

Um rótulo personalizado para usar como valor da zona de embarque (transitObject.ticketLeg.zone).

custom_fare_class_label

LocalizedString

Um rótulo personalizado para usar como valor da classe de tarifa (transitObject.ticketLeg.ticketSeat.fareClass).

custom_concession_category_label

LocalizedString

Um rótulo personalizado para usar como valor da categoria de concessão de transporte público (transitObject.concessionCategory).

custom_fare_name_label

LocalizedString

Um rótulo personalizado para usar como valor do nome da tarifa de transporte público (transitObject.ticketLeg.fareName).

class_template_info

ClassTemplateInfo

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

bool

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

string

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
(deprecated)

int64

Obsoleto

issuer_name

string

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[]

Message

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
(deprecated)

bool

Obsoleto. Use multipleDevicesAndHoldersAllowedStatus.

homepage_uri

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[]

LatLongPoint

review_status

ReviewStatus

Obrigatório. O status da classe. Este campo pode ser definido como draft ou underReview usando as chamadas de inserção, correção ou atualização de API. Depois que o estado da revisão for alterado de draft, ele não será alterado novamente para draft.

Você precisa manter esse campo como draft quando a classe estiver em desenvolvimento. Não é possível usar uma classe draft para criar nenhum objeto.

Quando acreditar que a classe está pronta para uso, defina este campo como underReview. A plataforma definirá automaticamente esse campo como approved, e ele poderá ser usado imediatamente para criar ou migrar objetos.

Ao atualizar uma classe já approved, é preciso continuar configurando este campo como underReview.

review

Review

Os comentários de revisão definidos pela plataforma quando uma classe é marcada como approved ou rejected.

info_module_data
(deprecated)

InfoModuleData

Obsoleto. Use textModulesData.

image_modules_data[]

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.

text_modules_data[]

TextModuleData

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.

redemption_issuers[]

int64

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

country_code

string

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

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
(deprecated)

Image

Obsoleto.

enable_smart_tap

bool

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

hex_background_color

string

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 #ffcc00. Também é possível usar a versão abreviada do trio RGB, que é #rgb, como #fc0.

localized_issuer_name

LocalizedString

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

MultipleDevicesAndHoldersAllowedStatus

Identifica se vários usuários e dispositivos salvarão o mesmo objeto que faz referência a esta classe.

callback_options

CallbackOptions

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 BUS. Obsoleto.

RAIL
rail

Alias legado de RAIL. Obsoleto.

TRAM
tram

Alias legado de TRAM. Obsoleto.

FERRY
ferry

Alias legado de FERRY. Obsoleto.

OTHER
other

Alias legado de OTHER. Obsoleto.

TransitClassAddMessageRequest

Campos
resource_id

string

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

AddMessageRequest

Corpo da solicitação.

TransitClassAddMessageResponse

Campos
resource

TransitClass

O recurso classe de transporte público atualizado.

TransitClassGetRequest

Campos
resource_id

string

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

TransitClass

Corpo da solicitação.

TransitClassListRequest

Campos
issuer_id

int64

O ID do emissor autorizado a listar classes.

token

string

Usado para conseguir o próximo conjunto de resultados se maxResults for especificado, mas mais classes maxResults estiverem disponíveis em uma lista. Por exemplo, se você tiver uma lista de 200 classes e chamar a lista com maxResults definido como 20, a lista retornará as primeiras 20 classes e um token. Chame a lista novamente com maxResults definido como 20 e o token para receber as 20 próximas classes.

max_results

int32

Identifica o número máximo de resultados retornados por uma lista. Todos os resultados serão retornados se maxResults não estiver definido.

TransitClassListResponse

Campos
resources[]

TransitClass

Recursos correspondentes à solicitação de lista.

pagination

Pagination

Paginação da resposta.

TransitClassPatchRequest

Campos
resource_id

string

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

TransitClass

Corpo da solicitação.

TransitClassUpdateRequest

Campos
resource_id

string

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

TransitClass

Corpo da solicitação.

TransitObject

Campos
class_reference

TransitClass

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

ticket_number

string

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

passenger_type

PassengerType

O número de passageiros.

passenger_names

string

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

trip_id

string

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

ticket_status

TicketStatus

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

custom_ticket_status

LocalizedString

Um status personalizado para usar como valor do status da passagem quando ticketStatus não fornece a opção correta. Não é possível definir os dois (ticketStatus e customTicketStatus), apenas um deles.

concession_category

ConcessionCategory

A categoria de concessão da passagem.

custom_concession_category

LocalizedString

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

ticket_restrictions

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.

purchase_details

PurchaseDetails

Detalhes da compra desta passagem.

ticket_leg

TicketLeg

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

ticket_legs[]

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 os dois (ticketLeg e ticketLegs), apenas um deles.

hex_background_color

string

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 #ffcc00. Também é possível usar a versão abreviada do trio RGB, que é #rgb, como #fc0.

trip_type

TripType

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

string

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

string

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
(deprecated)

int64

Obsoleto

state

State

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

barcode

Barcode

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

messages[]

Message

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

TimeInterval

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

locations[]

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 por sua vez modificam os locais no ID do Google Places.

has_users

bool

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

smart_tap_redemption_value

string

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

has_linked_device

bool

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

bool

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

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

info_module_data

InfoModuleData

Obsoleto. Use textModulesData.

image_modules_data[]

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.

text_modules_data[]

TextModuleData

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.

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.

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.

TripType

Enums
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

Alias legado de ROUND_TRIP. Obsoleto.

ONE_WAY
oneWay

Alias legado de ONE_WAY. Obsoleto.

TransitObjectAddMessageRequest

Campos
resource_id

string

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

AddMessageRequest

Corpo da solicitação.

TransitObjectAddMessageResponse

Campos
resource

TransitObject

O recurso TransitObject atualizado.

TransitObjectGetRequest

Campos
resource_id

string

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

TransitObject

Corpo da solicitação.

TransitObjectListRequest

Campos
class_id

string

O ID da classe que terá objetos listados.

token

string

Usado para conseguir o próximo conjunto de resultados se maxResults for especificado, mas mais de maxResults objetos estiverem disponíveis em uma lista. Por exemplo, se você tiver uma lista de 200 objetos e chamar a lista com maxResults definido como 20, a lista retornará os primeiros 20 objetos e um token. Chame a lista novamente com maxResults definido como 20 e o token para receber os próximos 20 objetos.

max_results

int32

Identifica o número máximo de resultados retornados por uma lista. Todos os resultados serão retornados se maxResults não estiver definido.

TransitObjectListResponse

Campos
resources[]

TransitObject

Recursos correspondentes à solicitação de lista.

pagination

Pagination

Paginação da resposta.

TransitObjectPatchRequest

Campos
resource_id

string

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

TransitObject

Corpo da solicitação.

TransitObjectUpdateRequest

Campos
resource_id

string

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

TransitObject

Corpo da solicitação.