AppLinkData
Stay organized with collections
Save and categorize content based on your preferences.
| Fields |
androidAppLinkInfo |
object (AppLinkInfo)
Optional information about the partner app link.
|
iosAppLinkInfo
(deprecated) |
object (AppLinkInfo)
Deprecated. Links to open iOS apps are not supported.
|
webAppLinkInfo |
object (AppLinkInfo)
Optional information about the partner web link.
|
displayText |
object (LocalizedString)
Optional display text for the app link button. Character limit is 30.
|
AppLinkInfo
| Fields |
appLogoImage
(deprecated) |
object (Image)
Deprecated. Image isn't supported in the app link module.
|
title
(deprecated) |
object (LocalizedString)
Deprecated. Title isn't supported in the app link module.
|
description
(deprecated) |
object (LocalizedString)
Deprecated. Description isn't supported in the app link module.
|
appTarget |
object (AppTarget)
Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
|
AppTarget
| JSON representation |
{
// Union field target can be only one of the following:
"targetUri": {
object (Uri)
},
"packageName": string
// End of list of possible types for union field target.
} |
| Fields |
Union field target. target can be only one of the following:
|
targetUri |
object (Uri)
URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
|
packageName |
string
Package name for AppTarget. For example: com.google.android.gm
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-13 UTC.
[null,null,["Last updated 2025-03-13 UTC."],[[["\u003cp\u003eAppLinkData objects contain information about app links for Android, iOS, and web apps, along with display text.\u003c/p\u003e\n"],["\u003cp\u003eAppLinkInfo objects, while largely deprecated, can define targets for opening app links.\u003c/p\u003e\n"],["\u003cp\u003eAppTarget objects specify either a URI or package name as the target for the app link.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edisplayText\u003c/code\u003e field within AppLinkData allows for customization of the app link button's text, with a 30-character limit.\u003c/p\u003e\n"],["\u003cp\u003eApp link functionality enables integration with external apps or web pages directly from Google Wallet passes.\u003c/p\u003e\n"]]],["The core content describes data structures for app links, including `JSON representation`, `AppLinkInfo`, and `AppTarget`. `AppLinkInfo` contains information for Android and web app links, with `displayText`. `AppLinkInfo` further specifies `appTarget`, which defines how to open the link, via either a `targetUri` or `packageName`. Several fields, such as `iosAppLinkInfo`, `appLogoImage`, `title`, and `description`, are deprecated. `target` is a union field with either `targetUri` or `packageName`.\n"],null,["# AppLinkData\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [AppLinkInfo](#AppLinkInfo)\n - [JSON representation](#AppLinkInfo.SCHEMA_REPRESENTATION)\n- [AppTarget](#AppTarget)\n - [JSON representation](#AppTarget.SCHEMA_REPRESENTATION)\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"androidAppLinkInfo\": { object (/wallet/reference/rest/v1/AppLinkData#AppLinkInfo) }, \"iosAppLinkInfo\": { object (/wallet/reference/rest/v1/AppLinkData#AppLinkInfo) }, \"webAppLinkInfo\": { object (/wallet/reference/rest/v1/AppLinkData#AppLinkInfo) }, \"displayText\": { object (/wallet/reference/rest/v1/LocalizedString) } } ``` |\n\n| Fields ||\n|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `androidAppLinkInfo` | `object (`[AppLinkInfo](/wallet/reference/rest/v1/AppLinkData#AppLinkInfo)`)` Optional information about the partner app link. |\n| `iosAppLinkInfo` **(deprecated)** | `object (`[AppLinkInfo](/wallet/reference/rest/v1/AppLinkData#AppLinkInfo)`)` | This item is deprecated! Deprecated. Links to open iOS apps are not supported. |\n| `webAppLinkInfo` | `object (`[AppLinkInfo](/wallet/reference/rest/v1/AppLinkData#AppLinkInfo)`)` Optional information about the partner web link. |\n| `displayText` | `object (`[LocalizedString](/wallet/reference/rest/v1/LocalizedString)`)` Optional display text for the app link button. Character limit is 30. |\n\nAppLinkInfo\n-----------\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"appLogoImage\": { object (/wallet/reference/rest/v1/Image) }, \"title\": { object (/wallet/reference/rest/v1/LocalizedString) }, \"description\": { object (/wallet/reference/rest/v1/LocalizedString) }, \"appTarget\": { object (/wallet/reference/rest/v1/AppLinkData#AppTarget) } } ``` |\n\n| Fields ||\n|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `appLogoImage` **(deprecated)** | `object (`[Image](/wallet/reference/rest/v1/Image)`)` | This item is deprecated! Deprecated. Image isn't supported in the app link module. |\n| `title` **(deprecated)** | `object (`[LocalizedString](/wallet/reference/rest/v1/LocalizedString)`)` | This item is deprecated! Deprecated. Title isn't supported in the app link module. |\n| `description` **(deprecated)** | `object (`[LocalizedString](/wallet/reference/rest/v1/LocalizedString)`)` | This item is deprecated! Deprecated. Description isn't supported in the app link module. |\n| `appTarget` | `object (`[AppTarget](/wallet/reference/rest/v1/AppLinkData#AppTarget)`)` Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage. |\n\nAppTarget\n---------\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { // Union field `target` can be only one of the following: \"targetUri\": { object (/wallet/reference/rest/v1/Uri) }, \"packageName\": string // End of list of possible types for union field `target`. } ``` |\n\n| Fields ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Union field `target`. `target` can be only one of the following: ||\n| `targetUri` | `object (`[Uri](/wallet/reference/rest/v1/Uri)`)` URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application. |\n| `packageName` | `string` Package name for AppTarget. For example: com.google.android.gm |"]]
