Add links to your bBarding pass

There are three ways to add links to a Boarding Pass.

  • Use FlightClass.LinksModuleData to add links to all Boarding Passes that are associated with the FlightClass.
  • Use FlightObject.LinksModuleData to add a link to a specific Boarding Pass FlightObject.
  • Request access to app linking, and then use FlightObject.appLinkData to place an app link on top of Pass Details.

One benefit of app linking is that it empowers your call-to-action channel to navigate users to your branded experiences from Google Wallet. Links with this feature appear on top of Pass Details, and can be embedded in a logo, description, or call-to-action word.

Call-to-action Example of GMB

Request access to app linking

Request access with the Contact Support button in Google Pay and Wallet Console. Select Google Wallet API as the topic first, and then choose App linking as the support type.

For a given Boarding Pass, set the field FlightObject.appLinkData to the URI of your app or website. The URI can be any format, but we recommend that you use a dynamic link.

See the format and context of the appLinkData field in the following source code:

{
  "id": string,
  "classId": string,
  …
  …
  …
  "appLinkData": {
    "androidAppLinkInfo": {
      "appLogoImage": {
        "sourceUri": {
          "uri": string
        }
      },
        "title": {
          "defaultValue": {
            "language": string,
              "value": string
          }
        },
          "description": {
            "defaultValue": {
              "language": string,
                "value": string
            }
          },
            "appTarget": {
              "targetUri": {
                "uri": string,
                  "description": string
              }
            }
    }
  }
  …
  …
  …
}