Zemanta: Most-used fields#
The table below gives information about most-used fields that you can import from Zemanta. 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 |
|---|---|---|---|
Country |
country |
The geographic country where the ad was served. Reports can be grouped by this dimension. |
dimension |
Device |
device |
The type of device (e.g., mobile, desktop, tablet) on which the ad was displayed. Reports can be grouped by this dimension. |
dimension |
Placement |
placement |
The specific location or platform where an ad is displayed. Reports can be grouped by this dimension. |
dimension |
account_agency_id |
account_agency_id |
The unique identifier of the agency to which the account belongs. |
dimension |
account_archived |
account_archived |
Indicates if the account is archived. Setting to ‘true’ archives the account; ‘false’ restores it. |
dimension |
account_currency |
account_currency |
The currency used for the account, with USD as the default. |
dimension |
account_frequency_capping |
account_frequency_capping |
The maximum number of times ads from the account can be shown to a unique user in one day. |
dimension |
account_name |
account_name |
The name associated with the advertising account. |
dimension |
account_status |
account_status |
The current operational status of the account, indicating if it is active, paused, or otherwise. |
dimension |
account_targeting_publisher_groups_excluded |
account_targeting_publisher_groups_excluded |
A list of Publisher Group IDs that are excluded from targeting at the account level. |
dimension |
account_targeting_publisher_groups_included |
account_targeting_publisher_groups_included |
A list of Publisher Group IDs that are included for targeting at the account level. |
dimension |
ad_creative_brand_name |
ad_brand_name |
The brand name associated with the ad creative. |
dimension |
ad_creative_call_to_action |
ad_call_to_action |
The call-to-action text displayed on the ad creative (e.g., ‘Learn More’, ‘Shop Now’). |
dimension |
ad_creative_description |
ad_description |
The descriptive text accompanying the ad creative. |
dimension |
ad_creative_display_url |
ad_display_url |
The URL that is displayed with the creative. |
dimension |
ad_creative_image_crop |
ad_image_crop |
The strategy used for cropping the creative’s image, such as ‘OPTIMIZED’, ‘CENTER’, or ‘FACES’. |
dimension |
ad_creative_image_url |
ad_image_url |
The URL of the image used in the ad creative. |
dimension |
ad_creative_title |
ad_title |
The title of the ad creative. |
dimension |
ad_creative_tracker_urls |
ad_tracker_urls |
A list of tracking URLs associated with the ad creative for third-party measurement. |
dimension |
ad_creative_url |
ad_url |
The destination URL or landing page URL for the ad creative. |
dimension |
ad_group_archived |
ad_group_archived |
Indicates if the ad group is archived. Setting to ‘true’ archives the ad group; ‘false’ restores it. |
dimension |
ad_group_autopilot_state |
ad_group_autopilot_state |
The status of automated optimization features (Autopilot) for the ad group. |
dimension |
ad_group_bidding_type |
ad_group_bidding_type |
The bidding strategy or type configured for the ad group (e.g., CPC, CPM). |
dimension |
ad_group_click_capping_daily_ad_group_max_clicks |
ad_group_click_capping_daily_ad_group_max_clicks |
Limits the maximum number of clicks an ad group can receive daily. Once this limit is reached, spending for the ad group stops for the rest of the day. |
dimension |
ad_group_daily_budget |
ad_group_daily_budget |
The daily budget allocated for the ad group. |
dimension |
ad_group_delivery_type |
ad_group_delivery_type |
Specifies how ads are delivered within the ad group. Options include ‘STANDARD’ for delivery throughout the day and ‘ACCELERATED’ for delivery as soon as possible. |
dimension |
ad_group_end_date |
ad_group_end_date |
The scheduled end date for the ad group. |
dimension |
ad_group_frequency_capping |
ad_group_frequency_capping |
The maximum number of times ads from the ad group can be shown to a unique user in one day. |
metric |
ad_group_max_cpc |
ad_group_max_cpc |
The maximum cost-per-click bid set for the ad group. |
dimension |
ad_group_name |
ad_group_name |
The name of the ad group within a campaign. |
dimension |
ad_group_start_date |
ad_group_start_date |
The scheduled start date for the ad group. |
dimension |
ad_group_state |
ad_group_state |
The current state of the ad group, reflecting its active status. |
dimension |
ad_group_status |
ad_group_status |
The current operational status of the ad group within a campaign. |
dimension |
ad_group_targeting_browsers |
ad_group_targeting_browsers |
A list of browser families to target within the ad group. If none are specified, content is served to all browsers. |
dimension |
ad_group_targeting_custom_audiences_excluded |
ad_group_targeting_custom_audiences_excluded |
A list of Custom Audience IDs to exclude from targeting within the ad group. |
dimension |
ad_group_targeting_custom_audiences_included |
ad_group_targeting_custom_audiences_included |
A list of Custom Audience IDs to include for targeting within the ad group. |
dimension |
ad_group_targeting_devices |
ad_group_targeting_devices |
A list of device types (e.g., DESKTOP, MOBILE, TABLET) to target for the ad group. If none are specified, content is served to all device types. |
dimension |
ad_group_targeting_geo_excluded_cities |
ad_group_targeting_geo_excluded_cities |
A list of Geoname IDs for cities to be excluded from the ad group’s geographical targeting. |
dimension |
ad_group_targeting_geo_excluded_countries |
ad_group_targeting_geo_excluded_countries |
A list of ISO 3166-1 alpha-2 country codes to be excluded from the ad group’s geographical targeting. |
dimension |
ad_group_targeting_geo_excluded_dma |
ad_group_targeting_geo_excluded_dma |
A list of DMA (Designated Market Area) IDs to be excluded from the ad group’s geographical targeting. |
dimension |
ad_group_targeting_geo_excluded_postal_codes |
ad_group_targeting_geo_excluded_postal_codes |
A list of postal codes (e.g., US:10001) to be excluded from the ad group’s geographical targeting. |
dimension |
ad_group_targeting_geo_excluded_regions |
ad_group_targeting_geo_excluded_regions |
A list of state or region codes (e.g., US-NY) to be excluded from the ad group’s geographical targeting. |
dimension |
ad_group_targeting_geo_included_cities |
ad_group_targeting_geo_included_cities |
A list of Geoname IDs for cities to be included in the ad group’s geographical targeting. |
dimension |
ad_group_targeting_geo_included_countries |
ad_group_targeting_geo_included_countries |
A list of ISO 3166-1 alpha-2 country codes to be included in the ad group’s geographical targeting. |
dimension |
ad_group_targeting_geo_included_dma |
ad_group_targeting_geo_included_dma |
A list of DMA (Designated Market Area) IDs to be included in the ad group’s geographical targeting. |
dimension |
ad_group_targeting_geo_included_postal_codes |
ad_group_targeting_geo_included_postal_codes |
A list of postal codes (e.g., US:10001) to be included in the ad group’s geographical targeting. |
dimension |
ad_group_targeting_geo_included_regions |
ad_group_targeting_geo_included_regions |
A list of state or region codes (e.g., US-NY) to be included in the ad group’s geographical targeting. |
dimension |
ad_group_targeting_interest_excluded |
ad_group_targeting_interest_excluded |
A list of interest categories to avoid when targeting ads within the ad group. This field is deprecated. |
dimension |
ad_group_targeting_interest_included |
ad_group_targeting_interest_included |
A list of interest categories to target for ads within the ad group. This field is deprecated. |
dimension |
ad_group_targeting_language_matching_enabled |
ad_group_targeting_language_matching_enabled |
Indicates whether the language of the ad should match the language of the content on the website for targeting purposes. |
dimension |
ad_group_targeting_os |
ad_group_targeting_os |
A list of operating systems targeted by the ad group. Reports can be grouped by Operating System. |
dimension |
ad_group_targeting_placements |
ad_group_targeting_placements |
A list of specific ad placement types (e.g., IN_STREAM, IN_ARTICLE, IN_FEED) to enable for the ad group. |
dimension |
ad_group_targeting_publisher_groups_excluded |
ad_group_targeting_publisher_groups_excluded |
A list of Publisher Group IDs to exclude from targeting within the ad group. |
dimension |
ad_group_targeting_publisher_groups_included |
ad_group_targeting_publisher_groups_included |
A list of Publisher Group IDs to include for targeting within the ad group. |
dimension |
ad_group_targeting_retargeting_ad_groups_excluded |
ad_group_targeting_retargeting_ad_groups_excluded |
A list of Ad Group IDs to exclude from retargeting within the ad group. |
dimension |
ad_group_targeting_retargeting_ad_groups_included |
ad_group_targeting_retargeting_ad_groups_included |
A list of Ad Group IDs to include for retargeting within the ad group. |
dimension |
ad_group_tracking_code |
ad_group_tracking_code |
Custom tracking codes that are appended to all ad URLs within this ad group. |
dimension |
ad_label |
ad_label |
A free-form text label associated with an ad. |
dimension |
ad_state |
ad_state |
The current operational state of the individual ad creative. |
dimension |
avg_cost_per_non_bounced_visit |
avg_cost_per_non_bounced_visit |
The average cost for a visit to the site that did not result in a bounce (user leaving after one pageview). |
dimension |
avg_cost_per_pageview |
avg_cost_per_pageview |
The average cost incurred for each pageview on the website. |
dimension |
avg_cost_per_visit |
avg_cost_per_visit |
The average cost incurred for each visit to the website. |
dimension |
avg_cpc |
avg_cpc |
The average cost per click, calculated as total media spend divided by total clicks. |
metric |
avg_cpm |
avg_cpm |
The average cost per mille (thousand impressions), calculated as total media spend divided by total impressions (x1000). |
dimension |
bounced_rate |
bounced_rate |
The percentage of visits in which the user left the site from the entrance page without interacting with it. |
dimension |
bounced_visits |
bounced_visits |
The number of visits to the site that resulted in a bounce. |
dimension |
campaign_archived |
campaign_archived |
Indicates if the campaign is archived. Setting to ‘true’ archives the campaign; ‘false’ restores it. |
dimension |
campaign_autopilot |
campaign_autopilot |
The status of automated optimization features (Autopilot) for the campaign. |
dimension |
campaign_frequency_capping |
campaign_frequency_capping |
The maximum number of times ads from the campaign can be shown to a unique user in one day. |
dimension |
campaign_iab_category |
campaign_iab_category |
The IAB (Interactive Advertising Bureau) content category of the campaign. |
dimension |
campaign_language |
campaign_language |
The language of the ads within the campaign. |
dimension |
campaign_name |
campaign_name |
The name of the advertising campaign. |
dimension |
campaign_status |
campaign_status |
The current operational status of the campaign, such as active, paused, or completed. |
dimension |
campaign_targeting_devices |
campaign_targeting_devices |
This field specifies the types of devices (e.g., Desktop, Mobile, Tablet) on which a campaign’s ads will be displayed. It is used for campaign targeting and as a breakdown field in reports. |
dimension |
campaign_targeting_os |
campaign_targeting_os |
This field defines the operating systems (e.g., Android, iOS, Windows) and their versions that a campaign’s ads will target. It is used for campaign targeting and as a breakdown field in reports. |
dimension |
campaign_targeting_placements |
campaign_targeting_placements |
This field specifies the types of ad placements (e.g., In-Stream, In-Article, In-Feed) where a campaign’s content will be promoted. It is used for campaign targeting and as a breakdown field in reports. |
dimension |
campaign_targeting_publisher_groups_excluded |
campaign_targeting_publisher_groups_excluded |
A list of Publisher Group IDs that are excluded from targeting at the campaign level. |
dimension |
campaign_targeting_publisher_groups_included |
campaign_targeting_publisher_groups_included |
A list of Publisher Group IDs that are included for targeting at the campaign level. |
dimension |
campaign_tracking_adobe_enabled |
campaign_tracking_adobe_enabled |
Indicates if Adobe Analytics tracking is enabled for the campaign. |
dimension |
campaign_tracking_adobe_tracking_parameter |
campaign_tracking_adobe_tracking_parameter |
The specific tracking parameter used for Adobe Analytics integration for the campaign. |
dimension |
campaign_tracking_ga_enabled |
campaign_tracking_ga_enabled |
Indicates if Google Analytics tracking is enabled for the campaign. |
dimension |
campaign_tracking_ga_type |
campaign_tracking_ga_type |
The type of Google Analytics integration used for the campaign (e.g., UA, GA4). |
dimension |
campaign_tracking_ga_web_property_id |
campaign_tracking_ga_web_property_id |
The Google Analytics web property ID associated with the campaign. |
dimension |
campaign_type |
campaign_type |
The type of advertising campaign (e.g., native, video). |
dimension |
clicks |
clicks |
The total number of clicks received by the ad or campaign. This is a core campaign performance metric. |
dimension |
ctr |
ctr |
The click-through rate, calculated as clicks divided by impressions, indicating ad effectiveness. |
metric |
data_cost |
data_cost |
The cost associated with using data (e.g., curated inventory packages) for targeting. |
metric |
impression_distribution_not_measurable |
impression_distribution_not_measurable |
The percentage of impressions for which viewability could not be measured, calculated out of all impressions. |
metric |
impression_distribution_not_viewable |
impression_distribution_not_viewable |
The number of impressions that were served but determined to be not viewable according to industry standards. |
metric |
impression_distribution_viewable |
impression_distribution_viewable |
The number of impressions that were served and determined to be viewable according to industry standards. |
metric |
impressions |
impressions |
The total number of times an ad was shown. This is a core campaign performance metric. |
dimension |
license_fee |
license_fee |
The license fee incurred for the reported activity. |
dimension |
margin |
margin |
The margin percentage fraction (e.g., 0.1 for 10%) applied to the campaign’s budget or reported for the activity. |
dimension |
measurable_impressions |
measurable_impressions |
The number of impressions that were measurable for viewability. |
metric |
media_source_status |
media_source_status |
The current status of the media source, indicating its operational state. |
dimension |
media_spend |
media_spend |
The total amount of money spent on media for the ad or campaign. This is a core campaign performance metric. |
dimension |
new_users |
new_users |
The number of unique users who visited the site for the first time. |
dimension |
non_bounced_visits |
non_bounced_visits |
The number of visits to the site that did not result in a bounce. |
dimension |
not_measurable_impressions |
not_measurable_impressions |
The number of impressions for which viewability could not be measured. |
metric |
not_viewable_impressions |
not_viewable_impressions |
The total count of impressions that were served but deemed not viewable. |
metric |
pageviews |
pageviews |
The total number of pages viewed on the website. |
dimension |
pageviews_per_visit |
pageviews_per_visit |
The average number of pages viewed during a single visit to the website. |
dimension |
percentage_new_users |
percentage_new_users |
The percentage of new users out of the total unique users. |
dimension |
returning_users |
returning_users |
The number of unique users who have previously visited the site. |
dimension |
time_on_site |
time_on_site |
The average duration of a user’s visit to the website. |
dimension |
total_seconds |
total_seconds |
The total duration in seconds that users spent on the site. |
dimension |
total_spend |
total_spend |
The total amount of money spent across all aspects of the campaign, including media, data, and fees. |
dimension |
unique_users |
unique_users |
The total number of distinct individuals who visited the site. |
dimension |
video_complete |
video_complete |
The number of times a video ad played to 100% completion. |
dimension |
video_first_quartile |
video_first_quartile |
The number of times a video ad played past the 25% mark. |
dimension |
video_midpoint |
video_midpoint |
The number of times a video ad played past the 50% mark. |
dimension |
video_start |
video_start |
The number of times a video ad began to play. |
dimension |
video_third_quartile |
video_third_quartile |
The number of times a video ad played past the 75% mark. |
dimension |
viewable_impressions |
viewable_impressions |
The total count of impressions that were served and considered viewable. |
metric |
visits |
visits |
The total number of sessions or visits to the website. |
dimension |
yesterday_spend |
yesterday_spend |
The total media spend incurred on the previous day. |
metric |