Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Details on link substitutions #461

Merged
merged 2 commits into from
Dec 4, 2024
Merged

Details on link substitutions #461

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ffc2035
Details on link substitutions
davidfischer Nov 27, 2024
135d3da
Add flight name as well
davidfischer Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions content/pages/learning-hub/advertiser-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,21 +106,27 @@ you're seeing from us against other networks you're using.
We are confident in our performance and know the results will speak for themselves.

We also have a few variables you can use in your landing page links
in order to capture data about the publisher where the ad was clicked or the specific advertisement:

* `${publisher_slug}` is used to insert the slug of the publisher
* `${publisher_name}` is used to insert the name of the publisher
* `${advertisement_slug}` is used to insert the name of the ad that was served
* `${advertisement_name}` is used to insert the name of the ad that was served

The `slug` variable is useful because it doesn't change when the name of the publisher or ad changes.
It's a lowercase representation of the name with spaces replaced by hyphens, generated when the publisher or ad is created.
in order to capture data about the publisher where the ad was clicked or the specific advertisement
or very-broad, non-identifying information about the visitor:

* `${publisher}` or `${publisher_slug}` is used to insert the slug of the publisher (all lowercase, no spaces)
* `${publisher_name}` is used to insert the name of the publisher (may contain spaces)
* `${advertisement}` or `${advertisement_slug}` is used to insert the slug of the specific ad that was served (all lowercase, no spaces)
* `${advertisement_name}` is used to insert the name of the ad that was served (may contain spaces)
* `${flight}` is used to insert the slug of the flight of the ad served (all lowercase, no spaces)
davidfischer marked this conversation as resolved.
Show resolved Hide resolved
* `${country}` inserts the visitor's country
(2 characters, [ISO 3166 Alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format or `None` when unknown).
Examples: "US", "CA", or "GB".
The country can be unknown even when an ad flight is targeted to a region or list of countries.
Only impressions served within the targeted country list are billed to advertisers.
* `${continent}` inserts the visitor's continent (2 characters or `None` when unknown).
Examples: "NA" for North America, "EU" for Europe, "OC" for Oceania.

For example, using the landing page link below would let you measure EthicalAds as a whole
as well as different publishers and specific ad creatives:

```pytb
https://example.com?utm_medium=cpc&utm_source=ethicalads&utm_campaign=${advertisement_name}&utm_content=${publisher_slug}
https://example.com?utm_medium=cpc&utm_source=ethicalads&utm_campaign=${flight}&utm_content=${advertisement}&country=${country}
```

Our advertiser platform will measure all performance metrics before a user clicks-through
Expand Down
Loading