Google Ad Manager 提供了一个 SOAP API,用于报告和操作广告投放管理实体,例如 LineItems。
客户端库支持多种语言。与 AdX Seller API 一样,Ad Manager API 使用 OAuth2 进行身份验证。
如需开始发出第一个 API 请求,请参阅使用入门。
Ad Manager API 中的报表功能
Ad Manager API ReportService 提供了两种运行和下载报告的方式:
- 在界面中创建查询,并根据其 ID 运行查询。
- 构建临时 ReportQuery。
无论采用哪种方式,API 工作流都包含四个步骤:
- 调用 runReportJob。
- 使用 getReportJobStatus 轮询报告状态。
- 使用 getReportDownloadUrlWithOptions 获取已完成报告的网址。
- 从返回的网址下载报告。
如需了解详情,请参阅报告指南。
报告时区
与 Ad Exchange Seller REST API 不同,Ad Manager API 报告默认采用您广告资源网的时区。如需更改此设置,请设置 TimeZoneType 字段。
AdX 与 Ad Manager 指标和维度映射
所有受支持的 Ad Exchange Seller REST API 指标和维度现在都已在 Ad Manager Reporting API 中提供。部分名称已更改,还有一些名称已被弃用。如需了解详情,请参阅下表。
指标/列
此表格将 AdX 指标映射到 Ad Manager 列。
| AdX 指标 | Ad Manager 列 | Ad Manager 查询工具名称 |
|---|---|---|
| ACTIVE_VIEW_ELIGIBLE_COUNT | AD_EXCHANGE_ACTIVE_VIEW_ENABLED_IMPRESSIONS | 启用了 Active View 的展示次数 |
| ACTIVE_VIEW_MEASURABLE_COUNT | AD_EXCHANGE_ACTIVE_VIEW_MEASURED_IMPRESSIONS | Active View 衡量的展示次数 |
| ACTIVE_VIEW_MEASURABLE_RATIO | (已弃用) | (已弃用) |
| ACTIVE_VIEW_VIEWABLE_COUNT | AD_EXCHANGE_ACTIVE_VIEW_VIEWED_IMPRESSIONS | Active View 可见的展示次数 |
| ACTIVE_VIEW_VIEWABLE_RATIO | (已弃用) | (已弃用) |
| ACTIVE_VIEW_VIEWABLE_TIME | AD_EXCHANGE_AVERAGE_VIEWABLE_TIME | 平均可见时间(秒) |
| AD_IMPRESSIONS | AD_EXCHANGE_IMPRESSIONS | 广告展示次数 |
| AD_IMPRESSIONS_RPM | AD_EXCHANGE_AD_ECPM | 广告 eCPM |
| AD_REQUESTS | AD_EXCHANGE_AD_REQUESTS | 广告请求 |
| AD_REQUESTS_COVERAGE | AD_EXCHANGE_COVERAGE | 覆盖率 |
| AD_REQUESTS_CTR | AD_EXCHANGE_AD_REQUEST_CTR | 广告请求点击率 |
| AD_REQUESTS_RPM | AD_EXCHANGE_AD_REQUEST_ECPM | 广告请求 eCPM |
| 点击次数 | AD_EXCHANGE_CLICKS | 点击次数 |
| COST_PER_CLICK | AD_EXCHANGE_CPC | 每次点击费用 |
| DEALS_AD_REQUESTS | AD_EXCHANGE_DEALS_AD_REQUESTS | 交易广告请求数 |
| DEALS_BID_RESPONSES | AD_EXCHANGE_DEALS_BID_RESPONSES | 交易出价响应数 |
| DEALS_MATCH_RATE | AD_EXCHANGE_DEALS_MATCH_RATE | 交易匹配率 |
| DEALS_MATCHED_REQUESTS | AD_EXCHANGE_DEALS_MATCHED_REQUESTS | 交易匹配的请求数 |
| 收入 | AD_EXCHANGE_ESTIMATED_REVENUE | 估算收入 |
| INDIVIDUAL_AD_IMPRESSIONS | (已弃用) | (已弃用) |
| INDIVIDUAL_AD_IMPRESSIONS_CTR | AD_EXCHANGE_AD_CTR | 广告点击率 |
| INDIVIDUAL_AD_IMPRESSIONS_RPM | (新建议)AD_EXCHANGE_AD_ECPM | (新建议)广告 eCPM |
| LIFT_RATE | AD_EXCHANGE_LIFT | 提升 |
| MATCHED_AD_REQUESTS | AD_EXCHANGE_MATCHED_REQUESTS | 匹配的请求数 |
| MATCHED_AD_REQUESTS_CTR | AD_EXCHANGE_CTR | 点击率 |
| MATCHED_AD_REQUESTS_RPM | AD_EXCHANGE_MATCHED_ECPM | 匹配有效每千次展示费用 |
| VIDEO_AD_ABANDONMENT_RATIO | AD_EXCHANGE_VIDEO_ABANDONMENT_RATE | 视频放弃率 |
| VIDEO_AD_DROPOFF_RATIO | AD_EXCHANGE_VIDEO_DROPOFF_RATE | 视频访问者流失率 |
| VIDEO_AD_QUARTILE_ONE | AD_EXCHANGE_VIDEO_QUARTILE_1 | 视频四分之一处 |
| VIDEO_AD_QUARTILE_THREE | AD_EXCHANGE_VIDEO_QUARTILE_3 | 视频四分之三处 |
| VIDEO_AD_SKIPPABLE_SKIP_RATIO | AD_EXCHANGE_VIDEO_TRUEVIEW_SKIP_RATE | TrueView 跳过率 |
| VIDEO_AD_SKIPPABLE_VIEWS | AD_EXCHANGE_VIDEO_TRUEVIEW_VIEWS | TrueView 观看次数 |
| VIDEO_AD_SKIPPABLE_VTR | AD_EXCHANGE_VIDEO_TRUEVIEW_VTR | TrueView 观看率 |
维度
下表将 AdX 维度映射到 Ad Manager 维度。
| AdX 维度 | Ad Manager 维度 | Ad Manager 查询工具名称 |
|---|---|---|
| AD_CLIENT_ID | AD_EXCHANGE_WEB_PROPERTY_CODE | 网站媒体资源 |
| AD_LOCATION | AD_EXCHANGE_AD_LOCATION | 广告位置 |
| AD_TAG_NAME | AD_EXCHANGE_TAG_NAME | 标记 |
| AD_UNIT_SIZE_CODE | AD_EXCHANGE_INVENTORY_SIZE_CODE | (不可用) |
| AD_UNIT_SIZE_NAME | AD_EXCHANGE_INVENTORY_SIZE | 广告资源尺寸 |
| ADVERTISER_DOMAIN | AD_EXCHANGE_ADVERTISER_DOMAIN | 广告客户域名 |
| ADVERTISER_NAME | AD_EXCHANGE_ADVERTISER_NAME | 广告客户 |
| ADVERTISER_VERTICAL | AD_EXCHANGE_ADVERTISER_VERTICAL | 广告客户所在行业 |
| AGENCY_NAME | AD_EXCHANGE_AGENCY | 代理机构 |
| BID_TYPE_CODE | AD_EXCHANGE_BID_TYPE_CODE | (不可用) |
| BRAND_NAME | AD_EXCHANGE_BRAND_NAME | 品牌 |
| BRANDING_TYPE_CODE | AD_EXCHANGE_BRANDING_TYPE_CODE | (不可用) |
| BRANDING_TYPE_NAME | AD_EXCHANGE_BRANDING_TYPE | 实名与否 |
| BUYER_NETWORK_ID | AD_EXCHANGE_BUYER_NETWORK_ID | (不可用) |
| BUYER_NETWORK_NAME | AD_EXCHANGE_BUYER_NETWORK_NAME | 买方广告联盟 |
| COUNTRY_CODE | AD_EXCHANGE_COUNTRY_CODE | (不可用) |
| COUNTRY_NAME | AD_EXCHANGE_COUNTRY_NAME | 国家/地区 |
| CREATIVE_SIZE | AD_EXCHANGE_CREATIVE_SIZES | 广告素材尺寸 |
| CUSTOM_CHANNEL_CODE | AD_EXCHANGE_CUSTOM_CHANNEL_CODE | (不可用) |
| CUSTOM_CHANNEL_ID | AD_EXCHANGE_CUSTOM_CHANNEL_ID | (不可用) |
| CUSTOM_CHANNEL_NAME | AD_EXCHANGE_CHANNEL_NAME | 频道 |
| 日期 | AD_EXCHANGE_DATE | 天 |
| DEAL_ID | AD_EXCHANGE_DEAL_ID | 交易 ID |
| DEAL_NAME | AD_EXCHANGE_DEAL_NAME | 交易名称 |
| DFP_AD_UNIT_ID | AD_EXCHANGE_DFP_AD_UNIT_ID | (不可用) |
| DFP_AD_UNITS | AD_EXCHANGE_DFP_AD_UNIT | DFP 广告单元 |
| DFP_REQUEST_SOURCE | AD_EXCHANGE_REQUEST_SOURCES | 请求来源 |
| DOMAIN_NAME | AD_EXCHANGE_SITE_NAME | 协作平台 |
| DSP_NAME | AD_EXCHANGE_DSP_BUYER_NETWORK_NAME | DSP |
| EXPANSION_TYPE_NAME | AD_EXCHANGE_EXPANSION_TYPE | 展开式广告类型 |
| INVENTORY_OWNERSHIP | AD_EXCHANGE_INVENTORY_OWNERSHIP | 广告资源所有权 |
| INVENTORY_PARTNER_NAME | AD_EXCHANGE_NETWORK_PARTNER_NAME | 广告资源网合作伙伴名称 |
| MOBILE_APP_NAME | AD_EXCHANGE_MOBILE_APP_NAME | 应用名称 |
| MOBILE_CARRIER_NAME | AD_EXCHANGE_MOBILE_CARRIER_NAME | 运营商名称 |
| MOBILE_DEVICE_NAME | AD_EXCHANGE_MOBILE_DEVICE_NAME | 设备 |
| MOBILE_INVENTORY_TYPE | AD_EXCHANGE_MOBILE_INVENTORY_TYPE | 广告资源类型 |
| MOBILE_OS_VERSION | AD_EXCHANGE_OPERATING_SYSTEM | 操作系统 |
| MOBILE_USER_BANDWIDTH | AD_EXCHANGE_USER_BANDWIDTH_NAME | 带宽 |
| 月 | AD_EXCHANGE_MONTH | 月 |
| PLATFORM_TYPE_NAME | AD_EXCHANGE_DEVICE_CATEGORY | 设备类别 |
| PRODUCT_CODE | AD_EXCHANGE_PRODUCT_CODE | (不可用) |
| PRODUCT_NAME | AD_EXCHANGE_PRODUCT_NAME | 产品 |
| TARGETING_TYPE_CODE | AD_EXCHANGE_TARGETING_TYPE_CODE | (不可用) |
| TARGETING_TYPE_NAME | AD_EXCHANGE_TARGETING_TYPE | 定位类型 |
| TRANSACTION_TYPE_CODE | AD_EXCHANGE_TRANSACTION_TYPE_CODE | (不可用) |
| TRANSACTION_TYPE_NAME | AD_EXCHANGE_TRANSACTION_TYPE | 交易类型 |
| URL_CHANNEL_ID | AD_EXCHANGE_URL_ID | (不可用) |
| URL_CHANNEL_NAME | AD_EXCHANGE_URL | 网址 |
| VIDEO_AD_DURATION | AD_EXCHANGE_VIDEO_AD_DURATION | (不可用) |
| VIDEO_AD_DURATION_RAW | AD_EXCHANGE_VIDEO_AD_DURATION_RAW | 视频广告时长 |
| VIDEO_AD_FORMAT | AD_EXCHANGE_VIDEO_AD_TYPE | 视频广告类型 |
| 周 | AD_EXCHANGE_WEEK | 周 |
| WINNING_BID_RULE_ID | AD_EXCHANGE_PRICING_RULE_ID | (不可用) |
| WINNING_BID_RULE_NAME | AD_EXCHANGE_PRICING_RULE_NAME | 定价规则 |