REST Resource: flightclass

Resource: FlightClass

JSON representation 
{
  "kind": string,
  "localScheduledDepartureDateTime": string,
  "localEstimatedOrActualDepartureDateTime": string,
  "localBoardingDateTime": string,
  "localScheduledArrivalDateTime": string,
  "localEstimatedOrActualArrivalDateTime": string,
  "flightHeader": {
    object (FlightHeader)
  },
  "origin": {
    object (AirportInfo)
  },
  "destination": {
    object (AirportInfo)
  },
  "flightStatus": enum (FlightStatus),
  "boardingAndSeatingPolicy": {
    object (BoardingAndSeatingPolicy)
  },
  "localGateClosingDateTime": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "languageOverride": string,
  "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)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Fields
kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#flightClass".
localScheduledDepartureDateTime

string

Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway)

Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set localEstimatedOrActualDepartureDateTime.

This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision.

eg: 2027-03-05T06:30:00

This should be the local date/time at the airport (not a UTC time).

Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
localEstimatedOrActualDepartureDateTime

string

The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time.

This field should be set if at least one of the below is true:

  • It differs from the scheduled time. Google will use it to calculate the delay.
  • The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed.

This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision.

eg: 2027-03-05T06:30:00

This should be the local date/time at the airport (not a UTC time).

Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
localBoardingDateTime

string

The boarding time as it would be printed on the boarding pass.

This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision.

eg: 2027-03-05T06:30:00

This should be the local date/time at the airport (not a UTC time).

Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
localScheduledArrivalDateTime

string

The scheduled time the aircraft plans to reach the destination gate (not the runway).

Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set localEstimatedOrActualArrivalDateTime.

This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision.

eg: 2027-03-05T06:30:00

This should be the local date/time at the airport (not a UTC time).

Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport.
localEstimatedOrActualArrivalDateTime

string

The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate.

This field should be set if at least one of the below is true:

  • It differs from the scheduled time. Google will use it to calculate the delay.
  • The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate.

This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision.

eg: 2027-03-05T06:30:00

This should be the local date/time at the airport (not a UTC time).

Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport.
flightHeader

object (FlightHeader)

Required. Information about the flight carrier and number.
origin

object (AirportInfo)

Required. Origin airport.
destination

object (AirportInfo)

Required. Destination airport.
flightStatus

enum (FlightStatus)

Status of this flight.

If unset, Google will compute status based on data from other sources, such as FlightStats, etc.

Note: Google-computed status will not be returned in API responses.
boardingAndSeatingPolicy

object (BoardingAndSeatingPolicy)

Policies for boarding and seating. These will inform which labels will be shown to users.
localGateClosingDateTime

string

The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass.

This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision.

eg: 2027-03-05T06:30:00

This should be the local date/time at the airport (not a UTC time).

Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
classTemplateInfo

object (ClassTemplateInfo)

Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
languageOverride

string

If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
id

string

Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
version
(deprecated)

string (int64 format)

Deprecated
issuerName

string

Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
messages[]

object (Message)

An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
allowMultipleUsersPerObject
(deprecated)

boolean

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.
homepageUri

object (Uri)

The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
locations[]
(deprecated)

object (LatLongPoint)

Note: This field is currently not supported to trigger geo notifications.
reviewStatus

enum (ReviewStatus)

Required. The status of the class. This field can be set to draft or underReview using the insert, patch, or update API calls. Once the review state is changed from draft it may not be changed back to draft.

You should keep this field to draft when the class is under development. A draft class cannot be used to create any object.

You should set this field to underReview when you believe the class is ready for use. The platform will automatically set this field to approved and it can be immediately used to create or migrate objects.

When updating an already approved class you should keep setting this field to underReview.
review

object (Review)

The review comments set by the platform when a class is marked approved or rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

Deprecated. Use textModulesData instead.
imageModulesData[]

object (ImageModuleData)

Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
textModulesData[]

object (TextModuleData)

Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
redemptionIssuers[]

string (int64 format)

Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured.

The enableSmartTap and object level smartTapRedemptionLevel fields must also be set up correctly in order for a pass to support Smart Tap.
countryCode

string

Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
heroImage

object (Image)

Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
wordMark
(deprecated)

object (Image)

Deprecated.
enableSmartTap

boolean

Identifies whether this class supports Smart Tap. The redemptionIssuers and object level smartTapRedemptionLevel fields must also be set up correctly in order for a pass to support Smart Tap.
hexBackgroundColor

string

The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as #ffcc00. You can also use the shorthand version of the RGB triplet which is #rgb, such as #fc0.
localizedIssuerName

object (LocalizedString)

Translated strings for the issuerName. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Identifies whether multiple users and devices will save the same object referencing this class.
callbackOptions

object (CallbackOptions)

Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
securityAnimation

object (SecurityAnimation)

Optional information about the security animation. If this is set a security animation will be rendered on pass details.
viewUnlockRequirement

enum (ViewUnlockRequirement)

View Unlock Requirement options for the boarding pass.
notifyPreference

enum (NotificationSettingsForUpdates)

Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
valueAddedModuleData[]

object (ValueAddedModuleData)

Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.

FlightHeader

JSON representation 
{
  "kind": string,
  "carrier": {
    object (FlightCarrier)
  },
  "flightNumber": string,
  "operatingCarrier": {
    object (FlightCarrier)
  },
  "operatingFlightNumber": string,
  "flightNumberDisplayOverride": string
}
Fields
kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#flightHeader".
carrier

object (FlightCarrier)

Information about airline carrier. This is a required property of flightHeader.
flightNumber

string

The flight number without IATA carrier code. This field should contain only digits. This is a required property of flightHeader.

eg: "123"
operatingCarrier

object (FlightCarrier)

Information about operating airline carrier.
operatingFlightNumber

string

The flight number used by the operating carrier without IATA carrier code. This field should contain only digits.

eg: "234"
flightNumberDisplayOverride

string

Override value to use for flight number. The default value used for display purposes is carrier + flightNumber. If a different value needs to be shown to passengers, use this field to override the default behavior.

eg: "XX1234 / YY576"

FlightCarrier

JSON representation 
{
  "kind": string,
  "carrierIataCode": string,
  "carrierIcaoCode": string,
  "airlineName": {
    object (LocalizedString)
  },
  "airlineLogo": {
    object (Image)
  },
  "airlineAllianceLogo": {
    object (Image)
  },
  "wideAirlineLogo": {
    object (Image)
  }
}
Fields
kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#flightCarrier".
carrierIataCode

string

Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or carrierIcaoCode needs to be provided for carrier and operatingCarrier.

eg: "LX" for Swiss Air
carrierIcaoCode

string

Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or carrierIataCode needs to be provided for carrier and operatingCarrier.

eg: "EZY" for Easy Jet
airlineName

object (LocalizedString)

A localized name of the airline specified by carrierIataCode. If unset, issuerName or localizedIssuerName from FlightClass will be used for display purposes.

eg: "Swiss Air" for "LX"

AirportInfo

JSON representation 
{
  "kind": string,
  "airportIataCode": string,
  "terminal": string,
  "gate": string,
  "airportNameOverride": {
    object (LocalizedString)
  }
}
Fields
kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#airportInfo".
airportIataCode

string

Three character IATA airport code. This is a required field for origin and destination.

Eg: "SFO"
terminal

string

Terminal name. Eg: "INTL" or "I"
gate

string

A name of the gate. Eg: "B59" or "59"
airportNameOverride

object (LocalizedString)

Optional field that overrides the airport city name defined by IATA. By default, Google takes the airportIataCode provided and maps it to the official airport city name defined by IATA.

Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London".

If this field is not populated, Google would display "London".

However, populating this field with a custom name (eg: "London Luton") would override it.

FlightStatus

Enums
FLIGHT_STATUS_UNSPECIFIED
SCHEDULED Flight is on time, early, or delayed.
scheduled

Legacy alias for SCHEDULED. Deprecated.
ACTIVE Flight is in progress (taxiing, taking off, landing, airborne).
active

Legacy alias for ACTIVE. Deprecated.
LANDED Flight landed at the original destination.
landed

Legacy alias for LANDED. Deprecated.
CANCELLED Flight is cancelled.
cancelled

Legacy alias for CANCELLED. Deprecated.
REDIRECTED Flight is airborne but heading to a different airport than the original destination.
redirected

Legacy alias for REDIRECTED. Deprecated.
DIVERTED Flight has already landed at a different airport than the original destination.
diverted

Legacy alias for DIVERTED. Deprecated.

BoardingAndSeatingPolicy

JSON representation 
{
  "kind": string,
  "boardingPolicy": enum (BoardingPolicy),
  "seatClassPolicy": enum (SeatClassPolicy)
}
Fields
kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#boardingAndSeatingPolicy".
boardingPolicy

enum (BoardingPolicy)

Indicates the policy the airline uses for boarding. If unset, Google will default to zoneBased.
seatClassPolicy

enum (SeatClassPolicy)

Seating policy which dictates how we display the seat class. If unset, Google will default to cabinBased.

BoardingPolicy

Enums
BOARDING_POLICY_UNSPECIFIED
ZONE_BASED
zoneBased

Legacy alias for ZONE_BASED. Deprecated.
GROUP_BASED
groupBased

Legacy alias for GROUP_BASED. Deprecated.
BOARDING_POLICY_OTHER
boardingPolicyOther

Legacy alias for BOARDING_POLICY_OTHER. Deprecated.

SeatClassPolicy

Enums
SEAT_CLASS_POLICY_UNSPECIFIED
CABIN_BASED
cabinBased

Legacy alias for CABIN_BASED. Deprecated.
CLASS_BASED
classBased

Legacy alias for CLASS_BASED. Deprecated.
TIER_BASED
tierBased

Legacy alias for TIER_BASED. Deprecated.
SEAT_CLASS_POLICY_OTHER
seatClassPolicyOther

Legacy alias for SEAT_CLASS_POLICY_OTHER. Deprecated.

Methods

addmessage

 Adds a message to the flight class referenced by the given class ID.

get

 Returns the flight class with the given class ID.

insert

 Inserts an flight class with the given ID and properties.

list

 Returns a list of all flight classes for a given issuer ID.

patch

 Updates the flight class referenced by the given class ID.

update

 Updates the flight class referenced by the given class ID.