Google Ad Manager offers a SOAP API for both reporting and manipulating trafficking entities, like LineItems.
Client libraries are available in several languages. Like the AdX Seller API, the Ad Manager API uses OAuth2 for authentication.
To get started with your first API request, see Getting Started.
Reporting in the Ad Manager API
The Ad Manager API ReportService offers two ways of running and downloading reports:
- Creating a query in the UI and running it based on its ID.
- Constructing an ad hoc ReportQuery.
With either option, the API workflow consists of four steps:
- Call runReportJob.
- Poll for the report status using getReportJobStatus.
- Get the URL to the completed report using getReportDownloadUrlWithOptions.
- Download the report from the returned URL.
For more details, see the reporting guide.
Reporting Time Zones
Unlike the Ad Exchange Seller REST API, in the Ad Manager API reports default to your
network's time zone. To change this, set the
TimeZoneType
field.
AdX to Ad Manager Metrics and Dimensions Mapping
All supported Ad Exchange Seller REST API metrics and dimensions are now present in the Ad Manager reporting API. Some names have changed and a few have been deprecated. Please see the tables below for details.
Metrics / Columns
This table maps AdX Metrics to Ad Manager Columns.
| AdX Metric | Ad Manager Column | Ad Manager Query Tool Name |
|---|---|---|
| ACTIVE_VIEW_ELIGIBLE_COUNT | AD_EXCHANGE_ACTIVE_VIEW_ENABLED_IMPRESSIONS | Active view enabled impressions |
| ACTIVE_VIEW_MEASURABLE_COUNT | AD_EXCHANGE_ACTIVE_VIEW_MEASURED_IMPRESSIONS | Active view measured impressions |
| ACTIVE_VIEW_MEASURABLE_RATIO | (deprecated) | (deprecated) |
| ACTIVE_VIEW_VIEWABLE_COUNT | AD_EXCHANGE_ACTIVE_VIEW_VIEWED_IMPRESSIONS | Active view viewed impressions |
| ACTIVE_VIEW_VIEWABLE_RATIO | (deprecated) | (deprecated) |
| ACTIVE_VIEW_VIEWABLE_TIME | AD_EXCHANGE_AVERAGE_VIEWABLE_TIME | Average viewable time (secs) |
| AD_IMPRESSIONS | AD_EXCHANGE_IMPRESSIONS | Ad impressions |
| AD_IMPRESSIONS_RPM | AD_EXCHANGE_AD_ECPM | Ad eCPM |
| AD_REQUESTS | AD_EXCHANGE_AD_REQUESTS | Ad requests |
| AD_REQUESTS_COVERAGE | AD_EXCHANGE_COVERAGE | Coverage |
| AD_REQUESTS_CTR | AD_EXCHANGE_AD_REQUEST_CTR | Ad request CTR |
| AD_REQUESTS_RPM | AD_EXCHANGE_AD_REQUEST_ECPM | Ad request eCPM |
| CLICKS | AD_EXCHANGE_CLICKS | Clicks |
| COST_PER_CLICK | AD_EXCHANGE_CPC | CPC |
| DEALS_AD_REQUESTS | AD_EXCHANGE_DEALS_AD_REQUESTS | Deals ad requests |
| DEALS_BID_RESPONSES | AD_EXCHANGE_DEALS_BID_RESPONSES | Deals bid responses |
| DEALS_MATCH_RATE | AD_EXCHANGE_DEALS_MATCH_RATE | Deals match rate |
| DEALS_MATCHED_REQUESTS | AD_EXCHANGE_DEALS_MATCHED_REQUESTS | Deals matched requests |
| EARNINGS | AD_EXCHANGE_ESTIMATED_REVENUE | Estimated revenue |
| INDIVIDUAL_AD_IMPRESSIONS | (deprecated) | (deprecated) |
| INDIVIDUAL_AD_IMPRESSIONS_CTR | AD_EXCHANGE_AD_CTR | Ad CTR |
| INDIVIDUAL_AD_IMPRESSIONS_RPM | (new recommendation) AD_EXCHANGE_AD_ECPM | (new recommendation) Ad eCPM |
| LIFT_RATE | AD_EXCHANGE_LIFT | Lift |
| MATCHED_AD_REQUESTS | AD_EXCHANGE_MATCHED_REQUESTS | Matched requests |
| MATCHED_AD_REQUESTS_CTR | AD_EXCHANGE_CTR | CTR |
| MATCHED_AD_REQUESTS_RPM | AD_EXCHANGE_MATCHED_ECPM | Matched eCPM |
| VIDEO_AD_ABANDONMENT_RATIO | AD_EXCHANGE_VIDEO_ABANDONMENT_RATE | Video abandonment rate |
| VIDEO_AD_DROPOFF_RATIO | AD_EXCHANGE_VIDEO_DROPOFF_RATE | Video drop-off rate |
| VIDEO_AD_QUARTILE_ONE | AD_EXCHANGE_VIDEO_QUARTILE_1 | Video quartile 1 |
| VIDEO_AD_QUARTILE_THREE | AD_EXCHANGE_VIDEO_QUARTILE_3 | Video quartile 3 |
| VIDEO_AD_SKIPPABLE_SKIP_RATIO | AD_EXCHANGE_VIDEO_TRUEVIEW_SKIP_RATE | TrueView skip rate |
| VIDEO_AD_SKIPPABLE_VIEWS | AD_EXCHANGE_VIDEO_TRUEVIEW_VIEWS | TrueView views |
| VIDEO_AD_SKIPPABLE_VTR | AD_EXCHANGE_VIDEO_TRUEVIEW_VTR | TrueView VTR |
Dimensions
This table maps AdX Dimensions to Ad Manager Dimensions .
| AdX Dimension | Ad Manager Dimension | Ad Manager Query Tool Name |
|---|---|---|
| AD_CLIENT_ID | AD_EXCHANGE_WEB_PROPERTY_CODE | Web property |
| AD_LOCATION | AD_EXCHANGE_AD_LOCATION | Ad locations |
| AD_TAG_NAME | AD_EXCHANGE_TAG_NAME | Tags |
| AD_UNIT_SIZE_CODE | AD_EXCHANGE_INVENTORY_SIZE_CODE | (Not available) |
| AD_UNIT_SIZE_NAME | AD_EXCHANGE_INVENTORY_SIZE | Inventory sizes |
| ADVERTISER_DOMAIN | AD_EXCHANGE_ADVERTISER_DOMAIN | Advertiser domains |
| ADVERTISER_NAME | AD_EXCHANGE_ADVERTISER_NAME | Advertisers |
| ADVERTISER_VERTICAL | AD_EXCHANGE_ADVERTISER_VERTICAL | Advertiser verticals |
| AGENCY_NAME | AD_EXCHANGE_AGENCY | Agencies |
| BID_TYPE_CODE | AD_EXCHANGE_BID_TYPE_CODE | (Not available) |
| BRAND_NAME | AD_EXCHANGE_BRAND_NAME | Brands |
| BRANDING_TYPE_CODE | AD_EXCHANGE_BRANDING_TYPE_CODE | (Not available) |
| BRANDING_TYPE_NAME | AD_EXCHANGE_BRANDING_TYPE | Branding Types |
| BUYER_NETWORK_ID | AD_EXCHANGE_BUYER_NETWORK_ID | (Not available) |
| BUYER_NETWORK_NAME | AD_EXCHANGE_BUYER_NETWORK_NAME | Buyer networks |
| COUNTRY_CODE | AD_EXCHANGE_COUNTRY_CODE | (Not available) |
| COUNTRY_NAME | AD_EXCHANGE_COUNTRY_NAME | Countries |
| CREATIVE_SIZE | AD_EXCHANGE_CREATIVE_SIZES | Creative sizes |
| CUSTOM_CHANNEL_CODE | AD_EXCHANGE_CUSTOM_CHANNEL_CODE | (Not available) |
| CUSTOM_CHANNEL_ID | AD_EXCHANGE_CUSTOM_CHANNEL_ID | (Not available) |
| CUSTOM_CHANNEL_NAME | AD_EXCHANGE_CHANNEL_NAME | Channels |
| DATE | AD_EXCHANGE_DATE | Days |
| DEAL_ID | AD_EXCHANGE_DEAL_ID | Deal IDs |
| DEAL_NAME | AD_EXCHANGE_DEAL_NAME | Deal names |
| DFP_AD_UNIT_ID | AD_EXCHANGE_DFP_AD_UNIT_ID | (Not available) |
| DFP_AD_UNITS | AD_EXCHANGE_DFP_AD_UNIT | DFP Ad Units |
| DFP_REQUEST_SOURCE | AD_EXCHANGE_REQUEST_SOURCES | Request sources |
| DOMAIN_NAME | AD_EXCHANGE_SITE_NAME | Sites |
| DSP_NAME | AD_EXCHANGE_DSP_BUYER_NETWORK_NAME | DSPs |
| EXPANSION_TYPE_NAME | AD_EXCHANGE_EXPANSION_TYPE | Expandable types |
| INVENTORY_OWNERSHIP | AD_EXCHANGE_INVENTORY_OWNERSHIP | Inventory ownership |
| INVENTORY_PARTNER_NAME | AD_EXCHANGE_NETWORK_PARTNER_NAME | Network partner names |
| MOBILE_APP_NAME | AD_EXCHANGE_MOBILE_APP_NAME | App names |
| MOBILE_CARRIER_NAME | AD_EXCHANGE_MOBILE_CARRIER_NAME | Carrier names |
| MOBILE_DEVICE_NAME | AD_EXCHANGE_MOBILE_DEVICE_NAME | Devices |
| MOBILE_INVENTORY_TYPE | AD_EXCHANGE_MOBILE_INVENTORY_TYPE | Inventory types |
| MOBILE_OS_VERSION | AD_EXCHANGE_OPERATING_SYSTEM | Operating systems |
| MOBILE_USER_BANDWIDTH | AD_EXCHANGE_USER_BANDWIDTH_NAME | Bandwidth |
| MONTH | AD_EXCHANGE_MONTH | Months |
| PLATFORM_TYPE_NAME | AD_EXCHANGE_DEVICE_CATEGORY | Device categories |
| PRODUCT_CODE | AD_EXCHANGE_PRODUCT_CODE | (Not available) |
| PRODUCT_NAME | AD_EXCHANGE_PRODUCT_NAME | Products |
| TARGETING_TYPE_CODE | AD_EXCHANGE_TARGETING_TYPE_CODE | (Not available) |
| TARGETING_TYPE_NAME | AD_EXCHANGE_TARGETING_TYPE | Targeting types |
| TRANSACTION_TYPE_CODE | AD_EXCHANGE_TRANSACTION_TYPE_CODE | (Not available) |
| TRANSACTION_TYPE_NAME | AD_EXCHANGE_TRANSACTION_TYPE | Transaction types |
| URL_CHANNEL_ID | AD_EXCHANGE_URL_ID | (Not available) |
| URL_CHANNEL_NAME | AD_EXCHANGE_URL | URLs |
| VIDEO_AD_DURATION | AD_EXCHANGE_VIDEO_AD_DURATION | (Not available) |
| VIDEO_AD_DURATION_RAW | AD_EXCHANGE_VIDEO_AD_DURATION_RAW | Video ad durations |
| VIDEO_AD_FORMAT | AD_EXCHANGE_VIDEO_AD_TYPE | Video ad types |
| WEEK | AD_EXCHANGE_WEEK | Weeks |
| WINNING_BID_RULE_ID | AD_EXCHANGE_PRICING_RULE_ID | (Not available) |
| WINNING_BID_RULE_NAME | AD_EXCHANGE_PRICING_RULE_NAME | Pricing rules |