Resource: FlightClass
JSON representation |
---|
{ "kind": string, "localScheduledDepartureDateTime": string, "localEstimatedOrActualDepartureDateTime": string, "localBoardingDateTime": string, "localScheduledArrivalDateTime": string, "localEstimatedOrActualArrivalDateTime": string, "flightHeader": { object ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
localScheduledDepartureDateTime |
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 This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 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 |
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:
This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 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 |
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: 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 |
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 This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 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 |
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:
This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 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 |
Required. Information about the flight carrier and number. |
origin |
Required. Origin airport. |
destination |
Required. Destination airport. |
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 |
Policies for boarding and seating. These will inform which labels will be shown to users. |
localGateClosingDateTime |
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: 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 |
Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display. |
languageOverride |
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 |
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 |
issuerName |
Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. |
messages[] |
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. Use |
homepageUri |
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[] |
Note: This field is currently not supported to trigger geo notifications. |
reviewStatus |
Required. The status of the class. This field can be set to You should keep this field to You should set this field to When updating an already |
review |
The review comments set by the platform when a class is marked |
infoModuleData |
Deprecated. Use textModulesData instead. |
imageModulesData[] |
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level. |
textModulesData[] |
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. |
linksModuleData |
Links module data. If links module data is also defined on the object, both will be displayed. |
redemptionIssuers[] |
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 |
countryCode |
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 |
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. |
enableSmartTap |
Identifies whether this class supports Smart Tap. The |
hexBackgroundColor |
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 |
localizedIssuerName |
Translated strings for the issuerName. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. |
multipleDevicesAndHoldersAllowedStatus |
Identifies whether multiple users and devices will save the same object referencing this class. |
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 |
Optional information about the security animation. If this is set a security animation will be rendered on pass details. |
viewUnlockRequirement |
View Unlock Requirement options for the boarding pass. |
appLinkData |
Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead. |
FlightHeader
JSON representation |
---|
{ "kind": string, "carrier": { object ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
carrier |
Information about airline carrier. This is a required property of |
flightNumber |
The flight number without IATA carrier code. This field should contain only digits. This is a required property of eg: "123" |
operatingCarrier |
Information about operating airline carrier. |
operatingFlightNumber |
The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234" |
flightNumberDisplayOverride |
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 ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
carrierIataCode |
Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or eg: "LX" for Swiss Air |
carrierIcaoCode |
Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or eg: "EZY" for Easy Jet |
airlineName |
A localized name of the airline specified by carrierIataCode. If unset, eg: "Swiss Air" for "LX" |
airlineLogo |
A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view. |
airlineAllianceLogo |
A logo for the airline alliance, displayed below the QR code that the passenger scans to board. |
wideAirlineLogo |
The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view. |
AirportInfo
JSON representation |
---|
{
"kind": string,
"airportIataCode": string,
"terminal": string,
"gate": string,
"airportNameOverride": {
object ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
airportIataCode |
Three character IATA airport code. This is a required field for Eg: "SFO" |
terminal |
Terminal name. Eg: "INTL" or "I" |
gate |
A name of the gate. Eg: "B59" or "59" |
airportNameOverride |
Optional field that overrides the airport city name defined by IATA. By default, Google takes the 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 |
ACTIVE |
Flight is in progress (taxiing, taking off, landing, airborne). |
active |
Legacy alias for |
LANDED |
Flight landed at the original destination. |
landed |
Legacy alias for |
CANCELLED |
Flight is cancelled. |
cancelled |
Legacy alias for |
REDIRECTED |
Flight is airborne but heading to a different airport than the original destination. |
redirected |
Legacy alias for |
DIVERTED |
Flight has already landed at a different airport than the original destination. |
diverted |
Legacy alias for |
BoardingAndSeatingPolicy
JSON representation |
---|
{ "kind": string, "boardingPolicy": enum ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
boardingPolicy |
Indicates the policy the airline uses for boarding. If unset, Google will default to |
seatClassPolicy |
Seating policy which dictates how we display the seat class. If unset, Google will default to |
BoardingPolicy
Enums | |
---|---|
BOARDING_POLICY_UNSPECIFIED |
|
ZONE_BASED |
|
zoneBased |
Legacy alias for |
GROUP_BASED |
|
groupBased |
Legacy alias for |
BOARDING_POLICY_OTHER |
|
boardingPolicyOther |
Legacy alias for |
SeatClassPolicy
Enums | |
---|---|
SEAT_CLASS_POLICY_UNSPECIFIED |
|
CABIN_BASED |
|
cabinBased |
Legacy alias for |
CLASS_BASED |
|
classBased |
Legacy alias for |
TIER_BASED |
|
tierBased |
Legacy alias for |
SEAT_CLASS_POLICY_OTHER |
|
seatClassPolicyOther |
Legacy alias for |
Methods |
|
---|---|
|
Adds a message to the flight class referenced by the given class ID. |
|
Returns the flight class with the given class ID. |
|
Inserts an flight class with the given ID and properties. |
|
Returns a list of all flight classes for a given issuer ID. |
|
Updates the flight class referenced by the given class ID. |
|
Updates the flight class referenced by the given class ID. |