Yandex.Direct: Most-used fields#
The table below gives information about most-used fields that you can import from Yandex.Direct. Other fields might also be available in Adverity.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.
API name |
Adverity UI name |
Description |
Use in Adverity |
|---|---|---|---|
AdFormat |
AdFormat |
Format of the ad impression: IMAGE — With an image / TEXT — A text ad / VIDEO — With video / SMART_MULTIPLE — Smart banner / SMART_SINGLE — Smart ad. |
dimension |
AdGroupId |
AdGroupId |
ID of the ad group. |
dimension |
AdGroupName |
AdGroupName |
Name of the ad group. |
dimension |
AdId |
AdId |
The ad ID. |
metric |
AdNetworkType |
AdNetworkType |
The type of advertising place where the ad is shown: SEARCH — In search results / AD_NETWORK — On ad networks. |
dimension |
Age |
Age |
The user’s age group: one of the values AGE_0_17 / AGE_18_24 / AGE_25_34 / AGE_35_44 / AGE_45 / AGE_45_54 / AGE_55 or UNKNOWN. Statistics for periods up through 21.08.2018 output the AGE_45 value and after this date the values AGE_45_54 and AGE_55 are shown. The statistics for a period that includes 21.08.2018 might show some with the AGE_45 value and some with AGE_45_54 or AGE_55. |
dimension |
AvgClickPosition |
AvgClickPosition |
Average position where the ad was clicked. Calculated using only clicks on the first page of Yandex search results. The top position is assigned the number 1. |
dimension |
AvgCpc |
AvgCpc |
Average cost per click. |
dimension |
AvgImpressionPosition |
AvgImpressionPosition |
Average display position of the ad. Calculated using only displays on the first page of Yandex search results. The top position is assigned the number 1. |
dimension |
AvgPageviews |
AvgPageviews |
The average session depth on the site meaning the number of pages viewed (according to Yandex.Metrica data). |
dimension |
BounceRate |
BounceRate |
The percentage of bounces in the total number of sessions (according to Yandex.Metrica data). |
dimension |
Bounces |
Bounces |
The number of bounces (according to Yandex.Metrica data). |
dimension |
CampaignId |
CampaignId |
The campaign ID. |
dimension |
CampaignName |
CampaignName |
The campaign name. |
dimension |
CampaignType |
CampaignType |
The type of campaign: TEXT_CAMPAIGN / MOBILE_APP_CAMPAIGN / DYNAMIC_TEXT_CAMPAIGN / SMART_BANNER_CAMPAIGN / MCBANNER_CAMPAIGN / CPM_BANNER_CAMPAIGN. |
dimension |
CampaignUrlPath |
CampaignUrlPath |
dimension |
|
CarrierType |
CarrierType |
The type of connection: CELLULAR — Mobile connection / STATIONARY — Wi-Fi or wired internet access / UNKNOWN — The type couldn’t be detected. |
dimension |
ClickType |
ClickType |
Which part of the ad was clicked by the user: TITLE — The ad title / SITELINK1 or SITELINK2 or SITELINK3 or SITELINK4 — Sitelinks / VCARD — The virtual business card / DISPLAY_URL_PATH — A displayed link / MOBILE_APP_ICON — The app icon (for mobile app ads) / BUTTON — The download or install button (for mobile app ads) / UNKNOWN. Note that for image ads or smart banners or display banners or search banners any click on an ad is considered a title click. |
dimension |
Clicks |
Clicks |
The number of clicks. |
dimension |
Client |
Client |
Client |
dimension |
ClientName |
ClientName |
dimension |
|
ConversionRate |
ConversionRate |
Ratio of the number of converted sessions to the number of clicks as a percentage (according to Yandex.Metrica data). It might be greater than 100 because a single click can be the source of multiple sessions. If the request specified Yandex.Metrica goals (the Goals parameter) the ConversionRate name is replaced with ConversionRate. |
dimension |
Conversions |
Conversions |
The number of conversions (according to Yandex.Metrica data). If the request specified Yandex.Metrica goals (the Goals parameter) then the Conversions name is replaced with Conversions. |
dimension |
Cost |
Cost |
The cost of clicks. |
dimension |
CostPerConversion |
CostPerConversion |
The average cost of reaching a goal (according to Yandex.Metrica data): the ratio of the cost of clicks to the number of conversions. If the request specified Yandex.Metrica goals (the Goals parameter) then the CostPerConversion name is replaced with CostPerConversion. |
dimension |
Criteria |
Criteria |
Name or text of the targeting criteria. For targeting a keyword or synonym — the keyword text. For autotargeting — the “—autotargeting” value. For targeting a related keyword wither an empty value if the report type is CUSTOM_REPORT or the text of the related keyword if the report type is SEARCH_QUERY_PERFORMANCE_REPORT. For targeting an audience target — the name of the retargeting list or the name of a mobile app category. For showing a dynamic ad — the name of the dynamic text ad target or the name of the filter. For showing smart banners — the name of the filter. |
dimension |
CriteriaId |
CriteriaId |
ID of the targeting criteria. For targeting a keyword or synonym – the keyword ID. For autotargeting — the autotargeting ID. For targeting a related keyword — a dash. For targeting an audience target — the ID of the audience target. For showing a dynamic ad — the ID of the dynamic text ad target or the ID of the filter. For showing smart banners — the ID of the filter. |
metric |
CriteriaType |
CriteriaType |
The type of targeting criteria set by the advertiser: KEYWORD — Keyword / AUTOTARGETING — Autotargeting / AUDIENCE_TARGET — Audience target / DYNAMIC_TEXT_AD_TARGET — Dynamic text ad target or filter for dynamic ads / SMART_BANNER_FILTER — Filter for smart banners. |
dimension |
Criterion |
Criterion |
The name or text of the targeting criteria set by the advertiser. For targeting a keyword or synonym — the keyword text. For impressions for a related keyword — the keyword text or the value “automatically added phrase” if the keyword couldn’t be determined. For autotargeting — the “—autotargeting” value. For targeting an audience target — the name of the retargeting list or the name of a mobile app category. For showing a dynamic ad — the name of the dynamic text ad target or the name of the filter. For showing smart banners — the name of the filter. We recommend using this name instead of Criteria. |
dimension |
CriterionId |
CriterionId |
The ID of the targeting criteria set by the advertiser. For targeting a keyword or synonym — the keyword ID. For targeting a related keyword — the ID of the keyword or a dash if the keyword couldn’t be determined. For autotargeting — the autotargeting ID. For targeting an audience (using a retargeting list or interest in a mobile app category) — the ID of the audience target or a dash if the target was deleted. For a dynamic text ad target generated from site pages — the ID of the dynamic text ad target. For a filter for dynamic ads generated from a feed or a filter for smart banners – the filter ID. We recommend using this name instead of CriteriaId. |
metric |
Ctr |
Ctr |
CTR as a percent. |
dimension |
Currency |
Currency |
Currency |
dimension |
Date |
Date |
The data statistics are provided for in the format YYYY-MM-DD. |
dimension |
Device |
Device |
The type of device the ad was shown on: DESKTOP or MOBILE or TABLET. |
dimension |
ExternalNetworkName |
ExternalNetworkName |
The name of the ad exchange (SSP). |
dimension |
Gender |
Gender |
The user’s gender: GENDER_MALE or GENDER_FEMALE or UNKNOWN. |
dimension |
GoalsRoi |
GoalsRoi |
The return on investment in advertising up to two decimal places (according to Yandex.Metrica data) calculated as ROI = (Revenue - Spent on advertising) / Spent on advertising. If the request specified Yandex.Metrica goals (the Goals parameter) then the GoalsRoi name is replaced with GoalsRoi. |
dimension |
ImpressionReach |
ImpressionReach |
metric |
|
Impressions |
Impressions |
Number of impressions. |
dimension |
Link |
Link |
dimension |
|
LocationOfPresenceId |
LocationOfPresenceId |
ID of the region where the user is located. |
dimension |
LocationOfPresenceName |
LocationOfPresenceName |
Name of the region where the user is located. |
dimension |
MatchType |
MatchType |
Keyword match type: RELATED_KEYWORD — Impression for a related keyword / SYNONYM — Impression for a keyword synonym / NONE — All other cases. |
dimension |
MatchedKeyword |
MatchedKeyword |
The matched keyword. For targeting a keyword synonym – the synonym text. For targeting a related keyword – the text of the related keyword. For showing a dynamic ad – the text of the keyword that was generated automatically on the main page of the advertised site or product offer from a feed. In other cases – an empty value. |
dimension |
MobilePlatform |
MobilePlatform |
OS type: ANDROID or IOS or OTHER or UNKNOWN. |
dimension |
Month |
Month |
Date of the start of the month in the format YYYY-MM-DD. |
dimension |
Placement |
Placement |
Name of the site where the ad is being displayed. |
dimension |
Quarter |
Quarter |
Date of the start of the quarter in the format YYYY-MM-DD. |
dimension |
Query |
Query |
The search query that triggered the ad. |
dimension |
Revenue |
Revenue |
Revenue (according to Yandex.Metrica data). If the request specified Yandex.Metrica goals (the Goals parameter) the Revenue name is replaced with Revenue. |
dimension |
Sessions |
Sessions |
Number of sessions (according to Yandex.Metrica data). For mobile app ads the number of clicks is shown as the number of visits. |
dimension |
Slot |
Slot |
The ad display place: PREMIUMBLOCK — Premium Placement / OTHER — Other ad blocks. |
dimension |
TargetingLocationId |
TargetingLocationId |
ID of the targeting region. If extended geotargeting is used it may differ from the region of the user’s location. |
dimension |
TargetingLocationName |
TargetingLocationName |
Name of the targeting region. |
dimension |
Week |
Week |
Date of the start of the week (Monday) in the format YYYY-MM-DD. |
dimension |
Year |
Year |
Date of the start of the year in the format YYYY-MM-DD. |
dimension |