Add links to your Generic Pass

AI-generated Key Takeaways

• There are four ways to add links to Generic passes: using GenericClass.LinksModuleData for all passes of a class, using GenericObject.LinksModuleData for a specific pass, using GenericObject.appLinkData for an app link at the bottom of a specific pass, and using GenericClass.appLinkData for an app link at the bottom of all passes of a class.

• App linking allows call-to-actions on Google Wallet passes to direct users to branded experiences, with links appearing at the bottom of the pass.

• To set an app link, configure the GenericObject.appLinkData field with the URI or package name of your app or website for a specific pass or GenericClass.appLinkData for all passes of that class.

• The appLinkData field can include androidAppLinkInfo for Android apps and webAppLinkInfo for websites, and the displayText field, limited to 30 characters, provides a label for the link.

• You can alternatively use targetUri within androidAppLinkInfo to link directly to your app's Play Store listing instead of opening the app directly.

There are four ways to add links to a Generic pass.

• Use GenericClass.LinksModuleData to add links to all Generic passes that are associated with the GenericClass.
• Use GenericObject.LinksModuleData to add a link to a specific Generic pass GenericObject.
• Use GenericObject.appLinkData to place an app link at the bottom of that particular Pass.
• Use GenericClass.appLinkData to place an app link at the bottom of all the passes of that class.

One benefit of app linking is that it empowers your call-to-action to navigate users to your branded experiences from Google Wallet. Links with this feature appear at the bottom of the Pass.

Feature example

Issuer

Set the app link on your Google Wallet pass

For a given Generic pass, set the field GenericObject.appLinkData to the URI or Package name of your app or website.

See the format and context of the appLinkData field in the following source code: The displayText field is limited to 30 characters.

Note: To deep link to a specific view within an app you must use webAppLinkInfo.

  {
    "id": string,
    "classId": string,
    …
    …
    …
    "appLinkData": {
      "androidAppLinkInfo": {
        "appTarget": {
          "packageName": "com.google.android.gm",
        }
      },
      "webAppLinkInfo": {
        "appTarget": {
           "targetUri": {
              "uri": "https://mail.google.com/mail/",
              "description": "Web link for Gmail"
           }
        }
      }
      "displayText": {
        "defaultValue": {
           "value": "Our awesome app!"
        }
      }
    }
  }

For posterity the following implementation will also work.

{
  "id": string,
  "classId": string,
  …
  …
  …
  "appLinkData": {
    "androidAppLinkInfo": {
      "appTarget": {
        "targetUri": {
          "uri": "https://play.google.com/store/apps/details?id=com.google.android.gm",
            "description": "Play store link for Gmail app"
        }
      }
    }
  }
}