REST Resource: transitclass

Recurso: TransitClass

Representação JSON 
{
  "transitOperatorName": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "transitType": enum (TransitType),
  "watermark": {
    object (Image)
  },
  "languageOverride": string,
  "customTransitTerminusNameLabel": {
    object (LocalizedString)
  },
  "customTicketNumberLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsDetailsLabel": {
    object (LocalizedString)
  },
  "customTimeRestrictionsLabel": {
    object (LocalizedString)
  },
  "customOtherRestrictionsLabel": {
    object (LocalizedString)
  },
  "customPurchaseReceiptNumberLabel": {
    object (LocalizedString)
  },
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "customPurchaseFaceValueLabel": {
    object (LocalizedString)
  },
  "customPurchasePriceLabel": {
    object (LocalizedString)
  },
  "customDiscountMessageLabel": {
    object (LocalizedString)
  },
  "customCarriageLabel": {
    object (LocalizedString)
  },
  "customSeatLabel": {
    object (LocalizedString)
  },
  "customCoachLabel": {
    object (LocalizedString)
  },
  "customPlatformLabel": {
    object (LocalizedString)
  },
  "customZoneLabel": {
    object (LocalizedString)
  },
  "customFareClassLabel": {
    object (LocalizedString)
  },
  "customConcessionCategoryLabel": {
    object (LocalizedString)
  },
  "customFareNameLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "enableSingleLegItinerary": boolean,
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "activationOptions": {
    object (ActivationOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideLogo": {
    object (Image)
  }
}
Campos
transitOperatorName

object (LocalizedString)

O nome do operador de transporte público.
transitType

enum (TransitType)

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

object (Image)

Imagem de marca-d'água a ser exibida no dispositivo do usuário.
languageOverride

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 BCP 47. Exemplos de valores são "en-US", "en-GB", "de" ou "de-AT".
customTransitTerminusNameLabel

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

Um rótulo personalizado para usar como valor de detalhes das restrições de horário (transitObject.ticketRestrictions.timeRestrictions).
customOtherRestrictionsLabel

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

Um rótulo personalizado para usar como valor da localização do assento (transitObject.ticketLeg.ticketSeat.seat).
customCoachLabel

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (ClassTemplateInfo)

Informações do modelo sobre como a classe deve ser exibida. Se ela não for definida, o Google usará um conjunto padrão de campos para exibir.
enableSingleLegItinerary

boolean

Controla a exibição do itinerário de trecho único para esta classe. Por padrão, um itinerário só é exibido para viagens de vários trechos.
id

string

Obrigatório. O identificador exclusivo de uma classe. Esse 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ê. Seu identificador exclusivo deve incluir apenas caracteres alfanuméricos, ".", "_" ou "-".
version
(deprecated)

string (int64 format)

Descontinuado
issuerName

string

Obrigatório. O nome do emissor. O comprimento máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores.
messages[]

object (Message)

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

boolean

Obsoleto. Use multipleDevicesAndHoldersAllowedStatus
homepageUri

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

object (LatLongPoint)

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

enum (ReviewStatus)

Obrigatório. O status da classe. Este campo pode ser definido como draft ou underReview usando as chamadas de API insert, patch ou update. Depois que o estado da revisão for alterado de draft, ele não poderá ser alterado de volta para draft.

Mantenha esse campo como draft quando a classe estiver em desenvolvimento. Uma classe draft não pode ser usada para criar objetos.

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

Ao atualizar uma classe que já approved, continue definindo este campo como underReview.
review

object (Review)

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

object (InfoModuleData)

Obsoleto. Use textModulesData.
imageModulesData[]

object (ImageModuleData)

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

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

string (int64 format)

Identifica quais emissores de resgate podem resgatar o cartão pelo Toque inteligente. Os emissores de resgate são identificados por seu ID de emissor. Os emissores de resgate precisam ter pelo menos uma chave do Toque inteligente configurada.

Os campos enableSmartTap e smartTapRedemptionLevel no nível do objeto também precisam ser configurados corretamente para que um cartão seja compatível com o Toque inteligente.
countryCode

string

Código de país usado para exibir o país do cartão (quando o usuário não está nesse país), bem como para mostrar conteúdo localizado quando o conteúdo não está disponível na localidade do usuário.
heroImage

object (Image)

Imagem opcional do banner exibida na frente do cartão. Se nenhum estiver presente, nada será exibido. A imagem será exibida com 100% de largura.
wordMark
(deprecated)

object (Image)

Obsoleto.
enableSmartTap

boolean

Identifica se essa classe é compatível com o Toque inteligente. Os campos redemptionIssuers e smartTapRedemptionLevel no nível do objeto também precisam ser configurados corretamente para que um cartão seja compatível com o Toque inteligente.
hexBackgroundColor

string

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

object (LocalizedString)

Strings traduzidas do emissorName. O comprimento máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Identifica se vários usuários e dispositivos salvarão o mesmo objeto que referencia esta classe.
callbackOptions

object (CallbackOptions)

Opções de callback a serem usadas para chamar o emissor de volta para cada salvamento/exclusão de um objeto desta classe pelo usuário final. Todos os objetos dessa classe são qualificados para o callback.
securityAnimation

object (SecurityAnimation)

Informações opcionais sobre a animação de segurança. Se isso for definido, uma animação de segurança vai ser renderizada nos detalhes do cartão.
activationOptions

object (ActivationOptions)

Opções de ativação de um tíquete ativado.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Consulte as opções do requisito de desbloqueio para o cartão de transporte público.

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.

ActivationOptions

ActivationOptions para a classe

Representação JSON 
{
  "activationUrl": string,
  "allowReactivation": boolean
}
Campos
activationUrl

string

URL HTTPS compatível com a semântica REST. Será usado para solicitar a ativação de parceiros para dados valiosos, acionados pelos usuários.
allowReactivation

boolean

Sinalização para permitir que os usuários façam chamadas de ativação em outro dispositivo. Isso permite que o cliente renderize o botão de ativação ativado mesmo se o triggerStatus estiver ATIVADO, mas o dispositivo solicitado for diferente do dispositivo atual.

Métodos

addmessage

 Adiciona uma mensagem à classe de transporte público indicada pelo ID de classe fornecido.

get

 Retorna a classe de transporte público com o ID de classe fornecido.

insert

 Insere uma classe de transporte público com o ID e as propriedades fornecidos.

list

 Retorna uma lista de todas as classes de transporte público de um determinado ID de emissor.

patch

 Atualiza a classe de transporte público indicada pelo ID de classe fornecido.

update

 Atualiza a classe de transporte público indicada pelo ID de classe fornecido.