Direct
Help
Contact us

Parameters transferred in ad URLs

You can transfer various parameters and tags (including UTM tags) in Direct ad URLs. They can be used for tracking various statistical data (such as traffic sources) and assessing the effectiveness of ad campaigns.

What are URL parameters?

URL parameters are variables which can be added to the link to an advertiser's site. Using link parameters and web analytics tools like Yandex.Metrica, Google Analytics, etc., you can obtain additional information about the clicks generated by these links.

For example, you can use a parameter to notify Yandex.Metrica that a user has reached the site via a keyword:

The parameter itself is a "name-value" pair. Depending on the set value, parameters can be as follows:

  • static — you can set the value to be transferred, e.g. utm_term=sony_playstation (utm_term — name, sony_playstation — static value)
  • dynamic — the required values are automatically added by the system, e.g. term={keyword}, where {keyword} stands for the keyword which triggered the ad impression

How to add a parameter

You can add parameters when creating or editing ads in the Link to site field by using the operators ? and &, for example:

http://www.site.com/?utm_source=yandex-direct&term={keyword}

You should choose a parameter name, e.g. term={keyword} or keyword={keyword}.

Make sure that the pages the links redirect to are available.

Attention! Cyrillic characters transferred in the URL are automatically encoded in UTF-8. It's important that your site correctly accepts requests in this encoding. Please note that after encoding Cyrillic characters in UTF-8, the URL will become longer. If it exceeds 4096 bytes, only the yclid and _openstat tag values will be transferred.

Direct's dynamic parameters

The table below provides a list of values for Direct's dynamic parameters which are recommended for collecting detailed statistics.

Value to be inserted in URL

Description

Transferred value

{ad_id} or {banner_id}

ID of ad

number

{addphrases}

Whether the impression was initiated by automatically added phrases (additional relevant phrases or automatically-added related keywords)

yes — ad impression according to one of the additional phrases

no — ad impression according to one of the source phrases

{addphrasestext}

Text of the automatically-added phrase

text of the phrase – for impressions of phrases that are added automatically;

none — this impression was not triggered by an automatically-added phrase

{campaign_type}

Campaign type

type1 — Text & Image ads

type2 — Ads for Mobile Apps

type3 — Dynamic ads

{сampaign_id}

Ad campaign ID

number

{device_type}

Device type on which impression was made

desktop — desktop

mobile — mobile phone

tablet — tablet

{gbid}

Group ID

number

{keyword}

The keyword for which the ad was displayed (Text & Image Ads or Ads for Mobile Apps)

keyword text without negative keywords

{phrase_id}

The ID of the keyword for the Text & Image Ads or Ads for Mobile Apps

number

{retargeting_id}

The target audience ID

number

{adtarget_name}

Dynamic text ad target for which the dynamic ad was displayed

name of dynamic text ad target

{adtarget_id}

ID of a targeting condition for dynamic ad.

number

{position}

Exact position of an ad within a block. Transfers only the position number for which it is not possible to determine the block type where the ad is displayed (use with {position_type})

position number in a block (for example 1)

0 — ad was served on ad networks (YAN or ad exchanges)

{position_type}

Ad block type if the ad appeared on a Yandex search results page

premium — premium placement

other — block to the right or at the bottom

none — ad was served on ad networks (YAN or ad exchanges)

{source}

Display space

domain of a site (for example, travel.ru) — when serving ads on ad networks (YAN or ad exchanges)

none — during impressions on Yandex search

{source_type}

Type of site on which the ad has been displayed

search — search site

context — ad network site

{region_name} Name of the region where the ad has been displayedname of the region

{region_id}

ID of the region where the ad has been displayednumber

A link with dynamic parameters will look something like this:

http://www.site.com/?type={source_type}&source={source}&added={addphrases}&block={position_type}&pos={position}&key={keyword}&campaign={campaign_id}&retargeting={retargeting_id}&ad={ad_id}&phrase={phrase_id}&gbid={gbid}&device={device_type}&region={region_id}&region_name={region_name}
Note.  In sitelinks the insertion of values of the parameters {campaign_id}, {ad_id}, {banner_id}, {phrase_id} is guaranteed only when these parameters are also present in the ad URL itself.

Special parameters {param1} and {param2}

The dynamic parameters {param1} and {param2} are general purpose parameters. First, for collecting statistics you can use them as additional parameters, for which you manually set a list of transferred values. Second, by using {param1} and {param2} you can redirect users to different pages of your site, who all encountered the same ad but according to different keywords.

You can set {param1} and {param2} values only in XLS/XLSX files, in Direct Commander or via the Direct API.

For example, you can use Excel spreadsheets to set the values like so:

Phrase (including negative keywords)

Link to website

Parameter 1

roses

http://site.com/{param1}

rose.html

lilac

http://site.com/{param1}

lilac.html

iris

http://site.com/{param1}

iris.html

The ad which will be displayed according to the keyword roses will lead to the page http://www.site.com/rose.html.

The ad which will be displayed according to the keyword lilac will lead to the page http://www.site.com/lilac.html.

UTM tags

UTM is a standard means for obtaining statistics. Here are the basic names of UTM tags:

  • utm_source — source of click
  • utm_medium — traffic type
  • utm_campaign — ad campaign name
  • utm_content — additional information which helps to differentiate ads
  • utm_term — keyword

The parameters utm_source, utm_medium, and utm_campaign are required, while utm_content and utm_term are optional. You must use all UTM tags to get the correct information in the standard tags report in Yandex.Metrica. Please note that if you use all UTM tags apart from utm_content, then data for utm_term may not be received, and can only be done by reconstructing the report (you must remove theutm_content dimension in the report settings).

UTM tags can be used with Yandex.Direct's dynamic parameters:

http://www.site.com/?utm_source={source}&utm_medium=cpc&utm_campaign={campaign_id}&utm_content={position_type}.{position}&utm_term={keyword}

Openstat tags

You can track ad campaign results in Yandex.Direct by using independent third-party statistics systems like Openstat or LiveInternet. Just add the special parameter — tag _openstat to your ad link (see the Openstat documentation for more information).

On the Campaign Parameters page, enable the External Statistics option (advanced settings are at the bottom of the page). After you've enabled this option, the _openstat tag with encoded data (Unicode) will automatically be added to all your campaign's ads. Make sure that the landing pages that your links with _openstat parameters lead to are available.

Links that use the _openstat tag look like this:

http://www.site.com/?_openstat=ZGlyZWN0LnlhbmRleC5ydTsxMjM0OzU2Nzg5O3lhbmRleC5ydTpwcmVtaXVt
For Openstat users
Ad click-through statistics can be found in the Click-throughs from Ads report in the Openstat interface (for more information, see the Openstat documentation).
For LiveInternet users
You will see a Direct click-through report in your website statistics.

Using parameters with templates

Parameters can be used with templates:

http://www.site.com/?key=##&ad_id={ad_id}

Please make sure that the pages to which the template links redirect are available.

For impressions initiated by the automatically added phrases (additional relevant phrases or automatically-added related keywords), the text and ID of the phrase are not inserted into the template.

Rate this article
Thank you for your feedback!