REST Resource: flightobject

Recurso: FlightObject

Representación 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)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Campos
kind
(deprecated)

string

Identifica qué tipo de recurso es. Valor: la cadena fija "walletobjects#flightObject".

classReference

object (FlightClass)

Es una copia de los campos heredados de la clase superior. Estos campos se recuperan durante un GET.

passengerName

string

Obligatorio. Nombre del pasajero tal como aparece en la tarjeta de embarque

p. ej., "Dave M Gahan", "Gahan/Dave" o "GAHAN/DAVEM"

boardingAndSeatingInfo

object (BoardingAndSeatingInfo)

Información específica para los pasajeros sobre el embarque y los asientos.

reservationInfo

object (ReservationInfo)

Obligatorio. Información sobre la reserva de vuelos.

hexBackgroundColor

string

El color de fondo de la tarjeta Si no se establece, se usa el color dominante de la imagen hero y, si no se establece ninguna imagen hero, se usa el color dominante del logotipo. El formato es #rrggbb, en el que rrggbb es un triplete RGB hexadecimal, como #ffcc00. También puedes usar la versión abreviada del triplete RGB, que es #rgb, como #fc0.

id

string

Obligatorio. Es el identificador único de un objeto. Este ID debe ser único para todos los objetos de un emisor. Este valor debe seguir el formato issuer ID.identifier, donde Google emite el primero y tú eliges el segundo. El identificador único solo debe incluir caracteres alfanuméricos, ".", "_" o "-".

classId

string

Obligatorio. La clase asociada con este objeto. La clase debe ser del mismo tipo que este objeto, ya debe existir y debe aprobarse.

Los IDs de clase deben seguir el formato issuer ID.identifier, donde Google emite el primero y tú eliges el segundo.

version
(deprecated)

string (int64 format)

Obsoleto

state

enum (State)

Obligatorio. Es el estado del objeto. Este campo se usa para determinar cómo se muestra un objeto en la app. Por ejemplo, un objeto inactive se mueve a la sección "Pasos vencidos".

barcode

object (Barcode)

El tipo y valor del código de barras.

messages[]

object (Message)

Es un array de mensajes que se muestran en la app. Todos los usuarios de este objeto recibirán los mensajes asociados. La cantidad máxima de estos campos es 10.

validTimeInterval

object (TimeInterval)

Es el período durante el cual este objeto será active y se puede usar. El estado de un objeto cambiará a expired cuando haya transcurrido este período.

locations[]
(deprecated)

object (LatLongPoint)

Nota: Por el momento, este campo no se admite para activar notificaciones geográficas.

hasUsers

boolean

Indica si el objeto tiene usuarios. La plataforma establece este campo.

smartTapRedemptionValue

string

El valor que se transmitirá a un terminal certificado por Smart Tap mediante NFC para este objeto. Los campos a nivel de la clase enableSmartTap y redemptionIssuers también deben configurarse correctamente para que el pase admita el Toque inteligente. Solo se admiten caracteres ASCII.

hasLinkedDevice

boolean

Indica si este objeto está vinculado a un solo dispositivo. La plataforma establece este campo cuando un usuario guarda el objeto y lo vincula a su dispositivo. Está destinado a socios seleccionados. Comunícate con el equipo de asistencia para obtener más información.

disableExpirationNotification

boolean

Indica si se deben suprimir las notificaciones de forma explícita. Si se establece este campo como verdadero, independientemente del campo messages, se suprimirán las notificaciones de vencimiento que envíe al usuario. De forma predeterminada, este campo se establece como "false".

Por el momento, solo se puede configurar para Vuelos.

infoModuleData

object (InfoModuleData)

Obsoleta. En su lugar, usa textModulesData.

imageModulesData[]

object (ImageModuleData)

Datos del módulo de imagen. La cantidad máxima de estos campos que se muestran es 1 desde el nivel de objeto y 1 para el nivel de objeto de clase.

textModulesData[]

object (TextModuleData)

Datos del módulo de texto Si los datos del módulo de texto también se definen en la clase, se mostrarán ambos. La cantidad máxima de estos campos que se muestran es de 10 del objeto y 10 de la clase.

rotatingBarcode

object (RotatingBarcode)

El tipo y el valor del código de barras rotativo.

heroImage

object (Image)

Es la imagen de banner opcional que se muestra en la parte frontal de la tarjeta. Si no hay ninguno, se mostrará la imagen principal de la clase, si está presente. Si tampoco está presente la imagen hero de la clase, no se mostrará nada.

groupingInfo

object (GroupingInfo)

Es la información que controla cómo se agrupan los pases.

passConstraints

object (PassConstraints)

Pasa las restricciones del objeto. Incluye la limitación de los comportamientos de NFC y capturas de pantalla.

saveRestrictions

object (SaveRestrictions)

Son restricciones sobre el objeto que se deben verificar antes de que el usuario intente guardar el pase. Ten en cuenta que estas restricciones solo se aplicarán durante el tiempo de ahorro. Si las restricciones cambiaron después de que un usuario guardó el pase, las nuevas restricciones no se aplicarán a un pase que ya se haya guardado.

linkedObjectIds[]

string

linkedObjectIds es una lista de otros objetos, como entradas para eventos, lealtad, ofertas, genéricos, tarjetas de regalo, transporte público y tarjetas de embarque, que se deben adjuntar automáticamente a este objeto de vuelo. Si un usuario guardó la tarjeta de embarque, estos linkedObjectIds se enviarán automáticamente a su billetera (a menos que hayan desactivado el parámetro de configuración para recibir los pases vinculados).

Asegúrate de que los objetos presentes en linkedObjectIds ya estén insertados. De lo contrario, las llamadas fallarán. Una vez vinculados, los objetos vinculados no se pueden desvincular. No puedes vincular objetos que pertenecen a otro emisor. Existe un límite para la cantidad de objetos que se pueden vincular a un solo objeto. Una vez alcanzado el límite, los objetos vinculados nuevos de la llamada se ignorarán en silencio.

Los IDs de objetos deben seguir el formato issuer ID.identifier, donde Google emite el primero y tú eliges el segundo.

notifyPreference

enum (NotificationSettingsForUpdates)

Establece si las actualizaciones de campo de este objeto deben activar notificaciones o no. Cuando se establece en NOTIFY, intentaremos activar una notificación de actualización de campo para los usuarios. Estas notificaciones solo se enviarán a los usuarios si el campo forma parte de una lista de entidades permitidas. Si se establece en DO_NOT_NOTIFY o NOTIFICATION_SETTINGS_UNSPECIFIED, no se activará ninguna notificación. Este parámetro de configuración es efímero y se debe establecer con cada solicitud PATCH o UPDATE. De lo contrario, no se activará una notificación.

valueAddedModuleData[]

object (ValueAddedModuleData)

Datos opcionales del módulo de valor agregado. Máximo de diez en el objeto.

BoardingAndSeatingInfo

Representación 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 qué tipo de recurso es. Valor: la cadena fija "walletobjects#boardingAndSeatingInfo".

boardingGroup

string

Es el valor del grupo de embarque (o zona) con el que debe abordar este pasajero.

p. ej., "B"

La etiqueta de este valor la determinará el campo boardingPolicy en el flightClass al que hace referencia este objeto.

seatNumber

string

Es el valor del asiento para pasajeros. Si no hay un identificador específico, usa seatAssignment en su lugar.

p. ej., "25A"

seatClass

string

Es el valor de la clase de asiento.

p. ej., "Económica" o "Económica superior"

boardingPrivilegeImage

object (Image)

Es una imagen pequeña que se muestra sobre el código de barras de embarque. Las aerolíneas pueden usarlo para comunicar cualquier privilegio de embarque especial. En el caso de que también se establezca el logotipo del programa de seguridad, esta imagen podría renderizarse junto con el logotipo de ese programa de seguridad.

boardingPosition

string

Es el valor de la posición de embarque.

p. ej., "76"

sequenceNumber

string

El número de secuencia de la tarjeta de embarque Por lo general, coincide con la secuencia en la que los pasajeros se registraron. La aerolínea puede usar el número para el embarque manual y las etiquetas de equipaje.

p. ej.: "49"

boardingDoor

enum (BoardingDoor)

Establece este campo solo si el vuelo aborda más de una puerta o un puente, y quieres imprimir de forma explícita la ubicación de la puerta en la tarjeta de embarque. La mayoría de las aerolíneas dirigen a sus pasajeros a la puerta o al puente correctos haciendo referencia a las puertas o los puentes por el seatClass. En esos casos, no se debe establecer boardingDoor.

seatAssignment

object (LocalizedString)

La asignación del asiento del pasajero Se usa cuando no hay un identificador específico para usar en seatNumber.

p. ej., "asignado en la puerta"

BoardingDoor

Enumeraciones
BOARDING_DOOR_UNSPECIFIED
FRONT
front

Es el alias heredado de FRONT. Obsoleta.

BACK
back

Es el alias heredado de BACK. Obsoleta.

ReservationInfo

Representación JSON
{
  "kind": string,
  "confirmationCode": string,
  "eticketNumber": string,
  "frequentFlyerInfo": {
    object (FrequentFlyerInfo)
  }
}
Campos
kind
(deprecated)

string

Identifica qué tipo de recurso es. Valor: la cadena fija "walletobjects#reservationInfo".

confirmationCode

string

Código de confirmación necesario para hacer el check-in de este vuelo.

Es el número que el pasajero ingresaría en un kiosco del aeropuerto para buscar el vuelo y, luego, imprimir una tarjeta de embarque.

eticketNumber

string

Número de la entrada electrónica

frequentFlyerInfo

object (FrequentFlyerInfo)

Información sobre las membresías de viajero frecuente.

FrequentFlyerInfo

Representación JSON
{
  "kind": string,
  "frequentFlyerProgramName": {
    object (LocalizedString)
  },
  "frequentFlyerNumber": string
}
Campos
kind
(deprecated)

string

Identifica qué tipo de recurso es. Valor: la cadena fija "walletobjects#frequentFlyerInfo".

frequentFlyerProgramName

object (LocalizedString)

Es el nombre del programa de pasajero frecuente. p. ej., "Lufthansa Miles & More".

frequentFlyerNumber

string

Número de pasajero frecuente

Es obligatorio para cada objeto anidado de tipo walletobjects#frequentFlyerInfo.

Métodos

addmessage

Agrega un mensaje al objeto de vuelo al que hace referencia el ID de objeto determinado.

get

Muestra el objeto de vuelo con el ID de objeto determinado.

insert

Inserta un objeto de vuelo con el ID y las propiedades determinados.

list

Muestra una lista de todos los objetos de vuelo para un ID de emisor determinado.

patch

Actualiza el objeto de vuelo al que hace referencia el ID de objeto determinado.

update

Actualiza el objeto de vuelo al que hace referencia el ID de objeto determinado.