REST Resource: flightobject

Recurso: FlightObject

Representação JSON
{
  "kind": string,
  "classReference": {
    object (FlightClass)
  },
  "passengerName": string,
  "boardingAndSeatingInfo": {
    object (BoardingAndSeatingInfo)
  },
  "reservationInfo": {
    object (ReservationInfo)
  },
  "securityProgramLogo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "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)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  }
}
Campos
kind
(deprecated)

string

Identifica o tipo de recurso. Valor: a string fixa "walletobjects#flightObject".

classReference

object (FlightClass)

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

passengerName

string

Obrigatório. Nome do passageiro como apareceria no cartão de embarque.

Por exemplo: "Dave M Gahan". ou "Gahan/Dave" ou "GAHAN/DAVEM"

boardingAndSeatingInfo

object (BoardingAndSeatingInfo)

Informações específicas para os passageiros sobre o embarque e assentos.

reservationInfo

object (ReservationInfo)

Obrigatório. Informações sobre reserva de voos.

hexBackgroundColor

string

A cor de fundo do cartão. Se não estiver 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.

id

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

classId

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

version
(deprecated)

string (int64 format)

Suspenso

state

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.

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 vão receber as mensagens associadas. O número máximo desses campos é 10.

validTimeInterval

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.

locations[]

object (LatLongPoint)

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

hasUsers

boolean

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

smartTapRedemptionValue

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.

hasLinkedDevice

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.

disableExpirationNotification

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

infoModuleData

object (InfoModuleData)

Obsoleto. Use textModulesData.

imageModulesData[]

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.

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.

rotatingBarcode

object (RotatingBarcode)

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

heroImage

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.

groupingInfo

object (GroupingInfo)

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

passConstraints

object (PassConstraints)

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

BoardingAndSeatingInfo

Representação JSON
{
  "kind": string,
  "boardingGroup": string,
  "seatNumber": string,
  "seatClass": string,
  "boardingPrivilegeImage": {
    object (Image)
  },
  "boardingPosition": string,
  "sequenceNumber": string,
  "boardingDoor": enum (BoardingDoor),
  "seatAssignment": {
    object (LocalizedString)
  }
}
Campos
kind
(deprecated)

string

Identifica o tipo de recurso. Valor: a string fixa "walletobjects#boardingAndSeatingInfo".

boardingGroup

string

O valor do grupo (ou zona) de embarque em que o passageiro deve embarcar.

Por exemplo: "B"

O rótulo para este valor será determinado pelo campo boardingPolicy no flightClass indicado por este objeto.

seatNumber

string

O valor do assento do passageiro. Se não houver um identificador específico, use seatAssignment.

Por exemplo: "25A"

seatClass

string

O valor da classe de assento.

Por exemplo: "Econômica" ou "Economy Plus"

boardingPrivilegeImage

object (Image)

Uma pequena imagem mostrada acima do código de barras do embarque. As companhias aéreas podem usá-lo para informar privilégios especiais de embarque. Caso o logotipo do programa de segurança também esteja definido, essa imagem poderá ser renderizada ao lado do logotipo do programa de segurança.

boardingPosition

string

O valor da posição de embarque.

Por exemplo: "76"

sequenceNumber

string

O número de sequência no cartão de embarque. Geralmente corresponde à sequência em que os passageiros fizeram check-in. A companhia aérea pode usar esse número para o embarque manual e as etiquetas de bagagens.

Por exemplo: "49"

boardingDoor

enum (BoardingDoor)

Defina este campo apenas se o embarque do voo for feito por mais de uma porta ou ponte e se você quiser imprimir explicitamente o local do portão no cartão de embarque. A maioria das companhias aéreas direciona seus passageiros para a porta ou ponte correta, se referindo a portas/pontes pelo seatClass. Nesses casos, não defina boardingDoor.

seatAssignment

object (LocalizedString)

A atribuição do assento do passageiro. Para ser usado quando não houver um identificador específico para usar em seatNumber.

Por exemplo: "atribuído no portão"

BoardingDoor

Enums
BOARDING_DOOR_UNSPECIFIED
FRONT
front

Alias legado de FRONT. Obsoleto.

BACK
back

Alias legado de BACK. Obsoleto.

ReservationInfo

Representação JSON
{
  "kind": string,
  "confirmationCode": string,
  "eticketNumber": string,
  "frequentFlyerInfo": {
    object (FrequentFlyerInfo)
  }
}
Campos
kind
(deprecated)

string

Identifica o tipo de recurso. Valor: a string fixa "walletobjects#reservationInfo".

confirmationCode

string

Código de confirmação necessário para fazer o check-in no voo.

Esse é o número que o passageiro digitaria em um quiosque no aeroporto para procurar o voo e imprimir um cartão de embarque.

eticketNumber

string

Número do bilhete eletrônico.

frequentFlyerInfo

object (FrequentFlyerInfo)

Informações da assinatura do programa de milhagem.

FrequentFlyerInfo

Representação JSON
{
  "kind": string,
  "frequentFlyerProgramName": {
    object (LocalizedString)
  },
  "frequentFlyerNumber": string
}
Campos
kind
(deprecated)

string

Identifica o tipo de recurso. Valor: a string fixa "walletobjects#frequentFlyerInfo".

frequentFlyerProgramName

object (LocalizedString)

Nome do programa de milhagem. Por exemplo: "Lufthansa Miles & Mais"

frequentFlyerNumber

string

Número do programa de milhagem.

Obrigatório para cada objeto aninhado do tipo walletobjects#frequentFlyerInfo.

Métodos

addmessage

Adiciona uma mensagem ao objeto de voo indicado pelo ID de objeto fornecido.

get

Retorna o objeto de voo com o ID de objeto fornecido.

insert

Insere um objeto de voo com o código e as propriedades fornecidos.

list

Retorna uma lista de todos os objetos de voo de um determinado ID de emissor.

patch

Atualiza o objeto de voo indicado pelo ID de objeto fornecido.

update

Atualiza o objeto de voo indicado pelo ID de objeto fornecido.