In this article, you’ll find information on click appends and the available dynamic parameter values that can be returned on each Awin redirect to your site.
Application note
Applying default URL parameters to your program will require Awin staff intervention.
If your program is live, please contact the appointed post-live support endpoint.
Alternatively, if your program is in the process of integrating, please reach out to your Integration Analyst.
What is a click append?
A click append allows you, as an advertiser, to send variables or other identifiers via the query string and can be used for a number of use-cases:
To track that a sale has come through from Awin and tag it in an external analytics platform like Google Analytics.
To initiate conditional landing page changes to remove items that may not be partner-friendly such as phone numbers.
Source tracking
Through the use of our standard source parameter, we’ll return a value of aw in the event that the click was referred via an Awin URL. This same parameter comes into play when setting up deduplication.
You additionally have the option to return a parameter / value combination such as utm_source=Awin for consolidation on platforms like Google Analytics.
Ensuring a partner-friendly website
To ensure that you offer a partner-friendly website, you may need to control leakage from the affiliate marketing funnel. Making use of values like the source parameter will allow you to update your website in order to prevent a potential customer from converting through an untracked channel.
For example, if your site typically displays a telephone number to make a purchase, you’ll want to hide this when a partner’s referral lands to prevent conversion on an untracked medium.
To do this, you will need to recognize that a visitor has come through an Awin link and remove relevant page data such as the telephone number.
The example below shows a PHP script that recognizes the source=aw parameter in the page URL and hides a page element. Your application may vary.
<?php
$url = $_SERVER['REQUEST_URI'];
$check_if_awin = strpos($url,'aw');
if ($check_if_awin !== false) {
$thirtydays = 60 * 60 * 24 * 30 + time();
$awin = 1;
setcookie('awin', $awin, $thirtydays);
}
if(isset($_COOKIE['awin']))
$awin = $_COOKIE['awin'];
// Hide or display your phone number
if ($awin == 1)
echo "Phone number hidden";
else
echo "<img src='https://www.phonenumberimage/0800.gif'>";
?>What is a URL parameter?
An URL parameter is a piece of information added to a web address (URL) to pass data to a website or application.
Basic idea
URL parameters are written as key–value pairs and are appended to the end of a URL, starting with a question mark (?). Multiple parameters are separated by an ampersand (&).
Example: https://example.com/products?category=shoes&size=10
category=shoes → parameter key: category, value: shoes
size=10 → parameter key: size, value: 10
Together, these parameters tell the website how to filter or customize the content being shown.
Standard URL parameters
Each Awin redirect will include a few standard parameters. For example, take this URL:
https://awin.com/?source=aw&sv1=affiliate&sv_campaign_id=!!!affid!!!&awc=!!!awc!!!When redirected through our system, this URL will populate key identifiers for the click event.
Note
SingleView (
&sv1=affiliate&sv_campaign_id=) parameters are only applicable to appropriate programs with relevant plugin activation.
These are needed for funnel and journey path reporting.
source
source is responsible for returning aw in the event that a click was received via an Awin link. If this parameter is missing, it’s safe to assume that the click has not originated from Awin. Please also check your sale channel cookies, in case it’s only returning users within the attribution time. If you prefer utm_source=aw or something similar, we can also implement that at the program level.
This parameter is relevant to the Channel Parameter.
AWC
awc will populate the click’s Awin Click Identifier. This value is necessary for us to attribute a given click and transaction combo to a partner and for validation.
Dynamic URL parameters
In addition to the standard parameters applied on your redirects, there are a number of optional dynamic values that we can supply to any given redirect.
When requesting the application of these parameters, please supply your Awin point of contact with the exact string you wish to be placed. For example:
&utm_source=Awin&utm_medium=affiliate&utm_promo=!!!promotype!!!Most frequently used dynamic parameters are !!!affid!!!, !!!linkid!!!, !!!awc!!!
Introduction
Dynamic parameters (also called placeholders, variabls, makros) are codes added in redirection urls or image urls or generally at the program or partner level settings in Awin platform.
During the redirection, our system will replace this codes with an id, or a chains of characters.
Example:
In Awin platform, we have the dynamic parameter
!!!affid!!!as append.During the redirection,
!!!affid!!!is replaced by the ID of the partner (static account ID).
Available dynamic values
AffID
affid will populate the partner’s numeric ID from the click-through. Spelling variants were introduced for this parameter in case of typos but have no functional difference.
!!!affid!!!, !!!add!!!, !!!aid!!!, !!!id!!!LinkID
LinkID will populate the numeric banner ID of the creative applicable to the redirect.
Example: 574669 (or 0 for default link, (link-builder) deep link, or product data feed redirection).
!!!linkid!!!GID
GID will populate the numeric group ID of the creative applicable to the redirect. This ID is matching with the unique creative tag as defined for each creative.
Example: 340110 (or 0 for default link, deep link, or product data feed redirection).
!!!gid!!!ProductID
ProductID will populate the datafeed’s numeric Product ID when a product’s link is clicked.
Example: 3104094889 (or 0 for default link, deep link).
!!!productid!!!AWC
AWC will populate a unique click identifier checksum (or first-party cookie value).
Example for click (cread, awclick, pclick URLs): 3661_1358445475_f396d719f0b67247f126a90bd2898cf0.
Example for view (cshow URL): 6683_111_1517587427_.
!!!awc!!!ClickRef
ClickRef will return the click reference that was optionally specified in the partner’s link. If no &clickref= reference has been used in the URL, the return value will be empty.
Example: mobile_click, awin_landing_banner.
!!!clickref!!!Only clickref/pref1 is transmitted to the advertiser landing page. In the case of pref2 - pref6 or clickref2 - clickref6, these are (non-public) parameters that cannot be transmitted to the advertiser’s landing page.
Sitename
Sitename will populate a simple URL-encoded version of the value the partner has specified in their Settings > Site Information > Site Name field.
Example: Awin%20Test, http%3A%2F%2Fwww.example.com
!!!sitename!!!SitenameCM
SitenameCM will populate a “CoreMetrics friendly” version of the value the partner has specified in their Settings > Site Information > Site Name field.
Example: Awin%20Test, http%3A%2F%2Fwww%2example%2Ecom
!!!sitenamecm!!!Sitenamechar
Sitenamechar will populate an alphanumeric-only version of the value the partner has specified in Settings > Site Information > Site Name field.
Example: AwinTest, httpwwwexamplecom
!!!sitenamechar!!!Companyname
Companyname will populate the value the partner has specified in Account > Contact Details > Company Name.
Example: Facebook, Test+pub+acc4+aw
!!!companyname!!!Theoretically possible, but not recommended, as shop users can see information (in this case, company names) from your partners on your landing page or it could confuse users. This is usually problematic due to data protection laws (PII). User consent is probably required. We are not permitted to provide legal advice on this matter. Please use sitename parameter instead.
Affiliatedomain
Affiliatedomain will populate the referrer URL host. If there was no referrer it will populate the value the partner has specified in Settings > Site Information > Primary Site URL.
Example: www.awin.com, example.blogspot.com
!!!affiliatedomain!!!Promotype
Promotype will populate the partner’s primary promotion type.
Example: Cashback, Social+Traffic
!!!promotype!!!Please note that this value corresponds to the partner’s self-reported information, not the advertiser’s assignment to a specific group (partner tag).
PromotypeCM
PromotypeCM will populate a “CoreMetrics friendly” version of the partner’s primary promotion type.
Example: Lead%20Generation%20%28Email%29, Social%20Traffic
!!!promotypecm!!!Please note that this value corresponds to the partner’s self-reported information, not the advertiser’s assignment to a specific group (partner tag).
PartnerTagID
PartnerTagID will populate the numeric ID of the Partner Tag the advertiser has assigned to a partner. If the partner has no partner tag, the return value will be empty. If the partner has multiple tags, the return value will contain several IDs, separated by pipe(|). If a tag is system-generated, its ID will not be included (tags written while a CommissionGroup template is applied; example "template-[templatename]" or "template-Cashback").
Example: 123321, 45235|89652|145862358
!!!publishertagid!!!PartnerTagName1
PartnerTagName1 will populate the tag name(s) of the Partner Tag(s) the advertiser has assigned to a partner with single encoding. For most advertisers, this will be the preferred version of PartnerTagName. If the partner has no partner tag, the return value will be empty. If the partner has multiple tags, the return value will contain several tag names, separated by (single) URL encoded pipe(|). If a tag is system-generated, its name will not be included (tags written while a CommissionGroup template is applied; example "template-[templatename]" or "template-Cashback").
Example (readable version, without url-encoding): tag1name|cashback|pubgroupA
Example (current, with url-encoding): tag1name%7Ccashback%7CpubgroupA
!!!publishertagname1!!!PartnerTagName2
PartnerTagName2 will populate the tag name(s) of the Partner Tag(s) the advertiser has assigned to a partner. PartnerTagName2 differs from PartnerTagName1 in that it is double URL encoded. If the partner has no partner tag, the return value will be empty. If the partner has multiple tags, the return value will contain several tag names, separated by (double) URL encoded pipe(|). If a tag is system-generated, its name will not be included (tags written while a CG template is applied; example "template-[templatename]" or "template-Cashback").
Example (readable version, without url-encoding): tag1name|cashback|pubgroupA
Example (current, with double url-encoding): tag1name%257cashback%257pubgroupA
!!!publishertagname2!!!Use case: If you work with prefix-url(s) it may sometimes be needed.
PartnerTagNameChar
PartnerTagNameChar will populate a "CoreMetrics friendly" version of the tag name(s) of the Partner Tag(s) the advertiser has assigned to a partner with special characters removed. If the partner has no partner tag, the return value will be empty. If the partner has multiple tags, the return value will contain several tag names, separated by (single) URL encoded pipe(|). If a tag is system-generated, its name will not be included (tags written while a CommissionGroup template is applied; example "template-[templatename]" or "template-Cashback").
Example (readable version, without url-encoding): my+tag+with+plus+symbol|cashback|pubgroupA
Example (current, with url-encoding): mytagwithplussymbol%7Ccashback%7CpubgroupA
!!!publishertagnamecm!!!Campaign
Campaign will populate a simple URL encoded version of the value of campaign=.
Example (current, with url-encoding): Awin%20BlackFriday or https%3A%2F%2Fwww.awin.com
!!!campaign!!!Example use case: campaigns via my offers.
CampaignCM
CampaignCM will populate a "CoreMetrics friendly" version of the value of campaign= parameter (without special characters).
Example (current, with url-encoding): Awin%20BlackFriday or https%3A%2F%2Fwww.awin.com
!!!campaigncm!!!CampaignChar
CampaignChar will populate alphanumerical characters of the value of campaign= parameter (without special characters).
Example (current, with url-encoding): AwinBlackFriday or httpswwwawincom
!!!campaignchar!!!Timestamp
Timestamp will generate a UNIX timestamp in UTC.
Example: 1358445475
!!!timestamp!!!DateDay
DateDay will generate a date value of the current day UTC in the ISO format yyyymmdd.
Example: 20260320
!!!dateday!!!Note
The parameter is available within the Prefixes, RedirectURL and ClickAppend and has been provided to support a specific setup of integrations (for App Tracking over MMP).
Hash
Hash will generate a hash symbol: #
Example: #
!!!hash!!!Use cases: provided to support a specific setup of mobile integrations (for App Tracking over MMP) or inside special creatives like HTML5.
SN
SN (sn = stricly necessary) will populate the incentive cookie flag value for click redirects.
Identify which exception partners work via legitimate tracking interest (technically necessary, independent of user cookie decision) like incentive partners and which are Awin standard partners (most in our network and often depends on the user’s cookie decision or settings).
Example: 1
!!!sn!!!Use case example:
&aw_incentive_flag=!!!sn!!! at program level (click appends):
For standard partner (e.g. example id 111) > value is empty (&aw_incentive_flag=).
For incentive partner (like cashback, loyalty, charity, incentive partners - example id: 45628) - you get value 1 (&aw_incentive_flag=1).
MerchantURL
MerchantURL will generate the destination advertiser URL of the user.
Example: https://www.advertisertopshop.com/featured/interior-design-trends
!!!merchanturl!!!Note
The parameter is available within prefixes and append only, as destination URL inside the destination URL would lead into loops.
MerchantURLcm
MerchantURLcm will generate a "CoreMetrics friendly" (an encoded) version of the advertiser destination URL of the user.
Example: https%3A%2F%2Fwww.advertisertopshop.com%2Ffeatured%2Finterior-design-trends
!!!merchanturlcm!!!Note
The parameter is available within prefixes and append only, as destination URL inside the destination URL would lead into loops.
RedirectURL
RedirectURL will generate an encoded version of the advertiser destination URL including all relevant prefixes and appends from the tracking settings.
Example: https%3A%2F%2Fwww.advertisertopshop.com%2Ffeatured%2Finterior-design-trends%26utm_source%3Dawin%26utm_medium%3Daffiliate%26utm_campaign%3Duk_location_buyer%26utm_content%3D!!!affid!!!
!!!redirectURL!!!Use case: Provided to support a specific setup of Mobile integrations (for App Tracking over MMP).
Note
The parameter is available within a beta version of specific mobile-prefix only, as the destination URL inside the destination URL including all relevant prefixes and appends from the tracking settings would lead into loops.
GDPR
GDPR propagates the value Awin receives on partner links from a TCF-compatible Consent Management Platforms (CMP). Signifies if GDPR (for the European Union) is applicable to this consumer. Expected values '0' (does not apply) or '1' (does apply). More information from IAB.
Example: 1 → https://www.exampleshop.com/?gdpr=1
!!!gdpr!!!See also our article about Consent Framework.
GDPRconsent
GDPRconsent propagates the value Awin receives on partner links from a TCF-compatible Consent Management Platforms (CMP). Signifies if GDPR (for the European Union) is applicable to this consumer. Contains the fully encoded consent string. More information from IAB.
Example: encrypted value → https://www.exampleshop.com/?gdpr_consent=CO8Gg25O8Gg25AKATBENA-CsAP_AAH_AAAwIG-sN5W_FYTdh8P58aosUMQFXUG5cPyECiAEdEaQBgFpQMKUVwEALCAzigIoIoQYAKXJAAAAACIGARAmwaIkBIAFoKEAAIIBCI6HEgCIAICUIEHtfn9VTOZIQRJRATwAgwogj____79f_r-3_3_vp9V-gboASAakUBFmBQwEggKRQgAQBQAhwAIAKIAQUAIAAAWBAgpAAQQAMAAAKAiAiBBgAhFkAAAAAACQBACABggAAAAAgAAAAgAAAAIUAQAAAgIAAAKAaFgBFAEAEABEEFACCAAAItFBPJWAJRc7GGEIZRQAA.f_gAAAAAAAAA
!!!gdpr_consent!!!See also our article about Consent Framework.
AwinCodeBlock
AwinCB This is a prefix only relevant to advertisers setting up on Adjust.
awin_cbException use case: provided to support a specific setup of mobile integrations (for App Tracking over MMP Adjust)
It’s a parameter that’s recognised by Adjust and prompts them to replace awin_cb with the following:
https://www.awin1.com/sread.php?tt=ns&tv=2&ch=aw&p1={activity_kind}&p2={event_name}&p3={idfa||gps_adid}&p4={event}