Add links to your Gift card

  • There are four ways to add links to a gift card: using GiftCardClass.LinksModuleData for all cards in a class, GiftCardObject.LinksModuleData for a specific card, GiftCardObject.appLinkData for an app link at the bottom of a specific pass, and GiftCardClass.appLinkData for an app link at the bottom of all passes in a class.

  • App linking enables call-to-actions that navigate users to branded experiences from Google Wallet, appearing at the bottom of the pass.

  • To set an app link, configure the GiftCardObject.appLinkData field with the URI or Package name of your app or website for a given gift card.

  • The appLinkData field allows specifying androidAppLinkInfo for Android and webAppLinkInfo for web links, along with displayText (limited to 30 characters) for the link's visible label.

  • An alternative implementation for appLinkData utilizes targetUri within androidAppLinkInfo to link directly to the app's Play Store listing.

There are four ways to add links to a gift card.

  • Use GiftCardClass.LinksModuleData to add links to all gift cards that are associated with the GiftCardClass.
  • Use GiftCardObject.LinksModuleData to add a link to a specific gift card GiftCardObject.
  • Use GiftCardObject.appLinkData to place an app link at the bottom of that particular Pass.
  • Use GiftCardClass.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 Name Applink Data Example
Issuer

For a given gift card, set the field GiftCardObject.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. 

  {
    "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"
        }
      }
    }
  }
}