Flightclass: patch

Requires authorization

Updates the flight class referenced by the given class ID. This method supports patch semantics.

Note about arrays: Patch requests that contain arrays replace the existing array with the one you provide. You cannot modify, add, or delete items in an array in a piecemeal fashion.

Request

HTTP request

PATCH https://www.googleapis.com/walletobjects/v1/flightClass/resourceId

Parameters

Parameter name Value Description
Path parameters
resourceId string 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 '-'.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/wallet_object.issuer

Request body

In the request body, supply the relevant portions of a Flightclass resource, according to the rules of patch semantics, with the following properties:

Property name Value Description Notes
Required Properties
reviewStatus string 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.

Acceptable values are:
  • "approved"
  • "draft"
  • "rejected"
  • "underReview"
writable
Optional Properties
allowMultipleUsersPerObject boolean Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead. writable
boardingAndSeatingPolicy nested object Policies for boarding and seating. These will inform which labels will be shown to users. writable
boardingAndSeatingPolicy.boardingPolicy string Indicates the policy the airline uses for boarding. If unset, Google will default to zoneBased.

Acceptable values are:
  • "boardingPolicyOther"
  • "groupBased"
  • "zoneBased"
writable
boardingAndSeatingPolicy.seatClassPolicy string Seating policy which dictates how we display the seat class. If unset, Google will default to cabinBased.

Acceptable values are:
  • "cabinBased"
  • "classBased"
  • "seatClassPolicyOther"
  • "tierBased"
writable
callbackOptions nested object 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. writable
callbackOptions.url string URL for the merchant endpoint that would be called for all user saves and deletes. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables. writable
classTemplateInfo nested object Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display. writable
classTemplateInfo.cardBarcodeSectionDetails nested object Specifies extra information to be displayed above and below the barcode. writable
classTemplateInfo.cardBarcodeSectionDetails.firstBottomDetail nested object Optional information to display below the barcode. writable
classTemplateInfo.cardBarcodeSectionDetails.firstBottomDetail.fieldSelector.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardBarcodeSectionDetails.firstBottomDetail.fieldSelector.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.cardBarcodeSectionDetails.firstTopDetail nested object Optional information to display above the barcode. If secondTopDetail is defined, this will be displayed to the start side of this detail section. writable
classTemplateInfo.cardBarcodeSectionDetails.firstTopDetail.fieldSelector.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardBarcodeSectionDetails.firstTopDetail.fieldSelector.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.cardBarcodeSectionDetails.secondTopDetail nested object Optional second piece of information to display above the barcode. If firstTopDetail is defined, this will be displayed to the end side of this detail section. writable
classTemplateInfo.cardBarcodeSectionDetails.secondTopDetail.fieldSelector.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardBarcodeSectionDetails.secondTopDetail.fieldSelector.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.cardTemplateOverride nested object Override for the card view. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[] list Template information for rows in the card view. At most two rows are allowed to be specified. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem nested object Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item nested object The item to be displayed in the row. This item will be automatically centered. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item.firstValue nested object A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item.firstValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item.firstValue.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item.predefinedItem string A predefined item to display. Only one of firstValue or predefinedItem may be set.

Acceptable values are:
  • "flightNumberAndOperatingFlightNumber"
  • "frequentFlyerProgramNameAndNumber"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item.secondValue nested object A reference to a field to display. This may only be populated if the firstValue field is populated. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item.secondValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item.secondValue.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems nested object Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem nested object The item to be displayed at the end of the row. This item will be aligned to the right. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem.firstValue nested object A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem.firstValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem.firstValue.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem.predefinedItem string A predefined item to display. Only one of firstValue or predefinedItem may be set.

Acceptable values are:
  • "flightNumberAndOperatingFlightNumber"
  • "frequentFlyerProgramNameAndNumber"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem.secondValue nested object A reference to a field to display. This may only be populated if the firstValue field is populated. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem.secondValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem.secondValue.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem nested object The item to be displayed in the middle of the row. This item will be centered between the start and end items. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem.firstValue nested object A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem.firstValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem.firstValue.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem.predefinedItem string A predefined item to display. Only one of firstValue or predefinedItem may be set.

Acceptable values are:
  • "flightNumberAndOperatingFlightNumber"
  • "frequentFlyerProgramNameAndNumber"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem.secondValue nested object A reference to a field to display. This may only be populated if the firstValue field is populated. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem.secondValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem.secondValue.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem nested object The item to be displayed at the start of the row. This item will be aligned to the left. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem.firstValue nested object A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem.firstValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem.firstValue.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem.predefinedItem string A predefined item to display. Only one of firstValue or predefinedItem may be set.

Acceptable values are:
  • "flightNumberAndOperatingFlightNumber"
  • "frequentFlyerProgramNameAndNumber"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem.secondValue nested object A reference to a field to display. This may only be populated if the firstValue field is populated. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem.secondValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem.secondValue.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems nested object Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem nested object The item to be displayed at the end of the row. This item will be aligned to the right. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem.firstValue nested object A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem.firstValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem.firstValue.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem.predefinedItem string A predefined item to display. Only one of firstValue or predefinedItem may be set.

Acceptable values are:
  • "flightNumberAndOperatingFlightNumber"
  • "frequentFlyerProgramNameAndNumber"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem.secondValue nested object A reference to a field to display. This may only be populated if the firstValue field is populated. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem.secondValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem.secondValue.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem nested object The item to be displayed at the start of the row. This item will be aligned to the left. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem.firstValue nested object A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem.firstValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem.firstValue.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem.predefinedItem string A predefined item to display. Only one of firstValue or predefinedItem may be set.

Acceptable values are:
  • "flightNumberAndOperatingFlightNumber"
  • "frequentFlyerProgramNameAndNumber"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem.secondValue nested object A reference to a field to display. This may only be populated if the firstValue field is populated. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem.secondValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem.secondValue.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.detailsTemplateOverride nested object Override for the details view (beneath the card view). writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[] list Information for the "nth" item displayed in the details list. writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item nested object The item to be displayed in the details list. writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item.firstValue nested object A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B". writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item.firstValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item.firstValue.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item.predefinedItem string A predefined item to display. Only one of firstValue or predefinedItem may be set.

Acceptable values are:
  • "flightNumberAndOperatingFlightNumber"
  • "frequentFlyerProgramNameAndNumber"
writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item.secondValue nested object A reference to a field to display. This may only be populated if the firstValue field is populated. writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item.secondValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item.secondValue.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.listTemplateOverride nested object Override for the passes list view. writable
classTemplateInfo.listTemplateOverride.firstRowOption nested object Specifies from a predefined set of options what the will be displayed in the first row. writable
classTemplateInfo.listTemplateOverride.secondRowOption nested object A reference to the field to be displayed in the second row.

This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display the departure date shared by all objects.

writable
classTemplateInfo.listTemplateOverride.secondRowOption.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.listTemplateOverride.secondRowOption.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
classTemplateInfo.listTemplateOverride.thirdRowOption nested object A reference to the field to be displayed in the third row.

This option is only displayed if there are not multiple user objects in a group. If there is a group, the third row will always display the number of objects in the group. Eg: "3 passes"
writable
classTemplateInfo.listTemplateOverride.thirdRowOption.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.listTemplateOverride.thirdRowOption.fields[].fieldPath string Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice". writable
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. writable
destination nested object Destination airport. writable
destination.airportIataCode string Three character IATA airport code. This is a required field for origin and destination.

Eg: "SFO"
writable
destination.airportNameOverride nested object 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.
writable
destination.airportNameOverride.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
destination.airportNameOverride.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
destination.airportNameOverride.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
destination.airportNameOverride.translatedValues[] list Contains the translations for the string. writable
destination.airportNameOverride.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
destination.airportNameOverride.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
destination.gate string A name of the gate. Eg: "B59" or "59" writable
destination.terminal string Terminal name. Eg: "INTL" or "I" writable
enableSmartTap boolean Available only to Smart Tap enabled partners. Contact support for additional guidance. writable
flightHeader nested object Information about the flight carrier and number. writable
flightHeader.carrier nested object Information about airline carrier. This is a required property of flightHeader. writable
flightHeader.carrier.airlineAllianceLogo.sourceUri nested object The URI for the image. writable
flightHeader.carrier.airlineAllianceLogo.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
flightHeader.carrier.airlineAllianceLogo.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.carrier.airlineAllianceLogo.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.carrier.airlineAllianceLogo.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
flightHeader.carrier.airlineAllianceLogo.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.carrier.airlineAllianceLogo.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.carrier.airlineLogo.sourceUri nested object The URI for the image. writable
flightHeader.carrier.airlineLogo.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
flightHeader.carrier.airlineLogo.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.carrier.airlineLogo.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.carrier.airlineLogo.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
flightHeader.carrier.airlineLogo.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.carrier.airlineLogo.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.carrier.airlineName nested object A localized name of the airline specified by carrierIataCode. If unset, the localizedIssuerName or issuerName will be used for display purposes. We strongly encourage you to set this field becaue issuer name might not be same as airline name.

eg: "Swiss Air" for "LX"
writable
flightHeader.carrier.airlineName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
flightHeader.carrier.airlineName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.carrier.airlineName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.carrier.airlineName.translatedValues[] list Contains the translations for the string. writable
flightHeader.carrier.airlineName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.carrier.airlineName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.carrier.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
writable
flightHeader.carrier.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.
writable
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"
writable
flightHeader.operatingCarrier nested object Information about operating airline carrier. writable
flightHeader.operatingCarrier.airlineAllianceLogo.sourceUri nested object The URI for the image. writable
flightHeader.operatingCarrier.airlineAllianceLogo.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
flightHeader.operatingCarrier.airlineAllianceLogo.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.operatingCarrier.airlineAllianceLogo.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.operatingCarrier.airlineAllianceLogo.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
flightHeader.operatingCarrier.airlineAllianceLogo.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.operatingCarrier.airlineAllianceLogo.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.operatingCarrier.airlineLogo.sourceUri nested object The URI for the image. writable
flightHeader.operatingCarrier.airlineLogo.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
flightHeader.operatingCarrier.airlineLogo.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.operatingCarrier.airlineLogo.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.operatingCarrier.airlineLogo.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
flightHeader.operatingCarrier.airlineLogo.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.operatingCarrier.airlineLogo.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.operatingCarrier.airlineName nested object A localized name of the airline specified by carrierIataCode. If unset, the localizedIssuerName or issuerName will be used for display purposes. We strongly encourage you to set this field becaue issuer name might not be same as airline name.

eg: "Swiss Air" for "LX"
writable
flightHeader.operatingCarrier.airlineName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
flightHeader.operatingCarrier.airlineName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.operatingCarrier.airlineName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.operatingCarrier.airlineName.translatedValues[] list Contains the translations for the string. writable
flightHeader.operatingCarrier.airlineName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.operatingCarrier.airlineName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
flightHeader.operatingCarrier.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
writable
flightHeader.operatingCarrier.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.
writable
flightHeader.operatingFlightNumber string The flight number used by the operating carrier without IATA carrier code. This field should contain only digits.

eg: "234"
writable
flightStatus string 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.

Acceptable values are:
  • "active": Flight is in progress (taxiing, taking off, landing, airborne).
  • "cancelled": Flight is cancelled.
  • "diverted": Flight has already landed at a different airport than the original destination.
  • "landed": Flight landed at the original destination.
  • "redirected": Flight is airborne but heading to a different airport than the original destination.
  • "scheduled": Flight is on time, early, or delayed.
writable
heroImage nested object 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. writable
heroImage.sourceUri nested object The URI for the image. writable
heroImage.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
heroImage.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
heroImage.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
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. writable
homepageUri nested object 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). writable
homepageUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
homepageUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
homepageUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[] list Image module data. If image modules data is also defined on the object, those will be merged with the image data defined on the class. The maximum number of these fields (combined with the object) is 1. writable
imageModulesData[].mainImage nested object A 100% width image. writable
imageModulesData[].mainImage.sourceUri nested object The URI for the image. writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData nested object Deprecated. Use textModulesData instead. writable
infoModuleData.labelValueRows[] list A list of collections of labels and values. These will be displayed one after the other in a singular column. writable
infoModuleData.labelValueRows[].columns[] list A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name. writable
infoModuleData.labelValueRows[].columns[].label string The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.labelValueRows[].columns[].localizedLabel nested object Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.

writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[] list Contains the translations for the string. writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue nested object Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[] list Contains the translations for the string. writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].value string The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.showLastUpdateTime boolean Deprecated writable
issuerName string The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. writable
linksModuleData nested object Links module data. If links module data is also defined on the object, both will be displayed. The maximum number of these fields (combined with the object) is 10. writable
linksModuleData.uris[] list The list of URIs. writable
linksModuleData.uris[].localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
linksModuleData.uris[].localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.translatedValues[] list Contains the translations for the string. writable
linksModuleData.uris[].localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
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.

If this is not set, Google will set it based on data from other sources.
writable
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 departure airport.

If this is not set, Google will set it based on data from other sources.
writable
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. Timezones will be calculated by Google based on departure airport.

If this is not set, Google will set it based on data from other sources.
writable
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.

writable
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 departure airport.

If this is not set, Google will set it based on data from other sources.
writable
localScheduledDepartureDateTime string 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.
writable
localizedIssuerName nested object Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. writable
localizedIssuerName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
localizedIssuerName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedIssuerName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedIssuerName.translatedValues[] list Contains the translations for the string. writable
localizedIssuerName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedIssuerName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[] list 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. writable
messages[].body string The message body. writable
messages[].displayInterval nested object The period of time that the message will be displayed to users. You can define both a startTime and endTime for each message. A message is displayed immediately after a Wallet Object is inserted unless a startTime is set. The message will appear in a list of messages indefinitely if endTime is not provided. writable
messages[].displayInterval.end nested object End time of the interval.

Offset is not required. If an offset is provided and start time is set, start must also include an offset.
writable
messages[].displayInterval.end.date string An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles.

Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
writable
messages[].displayInterval.start nested object Start time of the interval.

Offset is not required. If an offset is provided and end time is set, end must also include an offset.
writable
messages[].displayInterval.start.date string An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles.

Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
writable
messages[].header string The message header. writable
messages[].id string The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message. writable
messages[].localizedBody nested object Translated strings for the message body. writable
messages[].localizedBody.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
messages[].localizedBody.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.translatedValues[] list Contains the translations for the string. writable
messages[].localizedBody.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader nested object Translated strings for the message header. writable
messages[].localizedHeader.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
messages[].localizedHeader.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.translatedValues[] list Contains the translations for the string. writable
messages[].localizedHeader.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
multipleDevicesAndHoldersAllowedStatus string Identifies whether multiple users and devices will save the same object referencing this class.

Acceptable values are:
  • "multipleHolders": Multiple users on multiple devices are allowed.
  • "oneUserAllDevices": One user on multiple devices is allowed.
  • "oneUserOneDevice": Intended for use by select partners in limited circumstances. Contact support for additional information.
writable
origin nested object Origin airport. writable
origin.airportIataCode string Three character IATA airport code. This is a required field for origin and destination.

Eg: "SFO"
writable
origin.airportNameOverride nested object 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.
writable
origin.airportNameOverride.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
origin.airportNameOverride.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
origin.airportNameOverride.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
origin.airportNameOverride.translatedValues[] list Contains the translations for the string. writable
origin.airportNameOverride.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
origin.airportNameOverride.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
origin.gate string A name of the gate. Eg: "B59" or "59" writable
origin.terminal string Terminal name. Eg: "INTL" or "I" writable
redemptionIssuers[] list Available only to Smart Tap enabled partners. Contact support for additional guidance. writable
textModulesData[] list Text module data. If text modules data is also defined on the object, both will be displayed. The maximum number of these fields (combined with the object) is 10. writable
textModulesData[].body string The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].header string The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedBody nested object Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedBody.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
textModulesData[].localizedBody.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.translatedValues[] list Contains the translations for the string. writable
textModulesData[].localizedBody.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader nested object Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedHeader.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
textModulesData[].localizedHeader.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.translatedValues[] list Contains the translations for the string. writable
textModulesData[].localizedHeader.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri nested object The URI for the image. writable
wordMark.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
wordMark.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
wordMark.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable

Response

If successful, this method returns a Flightclass resource in the response body.

Send feedback about...

Google Pay for Passes