You can specify the language to use for API requests and responses. It follows the ISO-639-1 format.
Represents the media type of the resource. Defaults to application/json
.
The key value to use for API requests. Instructions for getting API keys are in "how to generate API Keys".
Channel name of the touchpoint and conversion.
Upon creation, tracking links are separated into "integrated" channels and "custom" channels.
"Integrated" channels are medias with postback integration, and have predefined channel names. All other channel names are considered "Custom" channels.
Configure campaign parameter for tracking link.
The campaign credited with the winning touchpoint or conversion.
The ad group credited with the winning touchpoint or conversion.
The ad creative credited with the winning touchpoint or conversion.
The content credited with the winning touchpoint or conversion.
The search term credited with the winning touchpoint or conversion.
The sub publisher that generated the touchpoint.
Sub media values are usually provided by predefined "integrated" channels.
The 1st level sub-sub publisher that generated the touchpoint.
Sub media values are usually provided by predefined "integrated" channels.
The 2nd level sub-sub publisher that generated the touchpoint.
Sub media values are usually provided by predefined "integrated" channels.
The 3rd level sub-sub publisher that generated the touchpoint.
Sub media values are usually provided by predefined "integrated" channels.
Configure the Re-engagement parameter. The Re-engagement parameter has three options: OFF, ON-TRUE, and ON-FALSE.
OFF
OFF is the default setting. The touchpoint can be attributed to both install events and post-install events (in-app events).
ON-TRUE
ON-TRUE is used for re-engagement campaigns for installed users. The touchpoint generated by the tracking link is attributed only to the deeplink open and the following in-app events, not to the install event.
ON-FALSE
ON-FALSE is used for user acquisition campaigns targeting uninstalled users. The touchpoint generated by the tracking link is attributed only to the install event and the following in-app events, not to the 'deeplink open' event.
Configure the Deeplink URL for redirect.
If deeplinkUrl
is missing or null, the deeplink setting is not configured.
Stopover Page
true: activate
false: deactivate
Configure the redirect path by platform when deep linking doesn't redirect as intended.
Redirect android user to google-play
, airpage
or http(s) url
google-play
Landing in the Google Play Store.
airpage
Landing in the Airpage.
{http_url}
Landing in the URL.
Redirect iOS user to itunes-appstore
, airpage
or http(s) url
itunes-appstore
Landing in the App Store.
airpage
Landing in the Airpage.
{http_url}
Landing in the URL.
Redirect desktop user to google-play
, itunes-appstore
or http(s) url
google-play
Landing in the Google Play Store.
itunes-appstore
Landing in the App Store.
{http_url}
Landing in the URL.
The ppid for the Custom Product Page in the Apple App Store.
Enable the custom product page to be shown when landing in the App Store.
The Custom Store Listing listing value for the Google Play Store.
Enables the display of your custom store listing when landing on the Google Play Store.
Configure the Open Graph for the tracking link that will be shown when the link is shared or posted.
The Open Graph of url specified in fallbackPath.
og:title
for tracking link
og:description
for tracking link
og:image
for tracking link
Enable the Social Share preview default values set in the Airbridge dashboard.
Note. Other parameter values in the og tag will be ignored.
Configure the Short Link ID of tracking links depending on your campaign or contents. If not passed, a random Short Link ID will be generate, and can not be changed once generated.
The Short Link ID of a tracking link cannot be reused even if the tracking link has been deprecated.