从 AdX Seller REST API 迁移

Google Ad Manager 提供了一种用于报告和操纵广告投放管理实体(例如 LineItems)的 SOAP API。 客户端库提供多种语言版本。与 AdX Seller API 一样,Ad Manager API 也使用 OAuth2 进行身份验证

要想开始发出您的第一项 API 请求,请参阅使用入门

在 Ad Manager API 中生成报表

Ad Manager API ReportService 提供了两种生成和下载报表的方法:

  1. 在界面中创建一条查询并根据其 ID 运行该查询。
  2. 构建临时的 ReportQuery

无论采用哪种方法,API 工作流程都包括四个步骤:

  1. 调用 runReportJob
  2. 使用 getReportJobStatus 轮询报表状态。
  3. 使用 getReportDownloadUrlWithOptions 获取指向已完成报表的网址。
  4. 通过返回的网址下载报表。

有关详情,请参见报表指南

报表时区

与 Ad Exchange Seller REST API 不同,在 Ad Manager API 中,报表默认采用您广告联盟的时区。要更改此设置,请设置 TimeZoneType 字段。

在旧版 API 中,此字段不可用,并且时区由 API 版本确定。有关详情,请参阅下表。

版本 Ad Exchange 报表的时区 Ad Manager 报表的时区
201802 TimeZoneType 指定 TimeZoneType 指定
201711 太平洋标准时间 (PST) 广告联盟时区
201708 广告联盟时区 广告联盟时区
201705 广告联盟时区 广告联盟时区

AdX 与 Ad Manager 之间的指标和维度对应关系

v201705 及更高版本的 Ad Manager Reporting API 中现已包含所有受支持的 Ad Exchange Seller REST 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
CLICKS AD_EXCHANGE_CLICKS 点击次数
COST_PER_CLICK AD_EXCHANGE_CPC 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 交易匹配请求数
EARNINGS 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 匹配 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 渠道
DATE 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 带宽
MONTH 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 视频广告类型
WEEK AD_EXCHANGE_WEEK
WINNING_BID_RULE_ID AD_EXCHANGE_PRICING_RULE_ID (不可用)
WINNING_BID_RULE_NAME AD_EXCHANGE_PRICING_RULE_NAME 定价规则

发送以下问题的反馈:

此网页
Ad Manager
Ad Manager
需要帮助?请访问我们的支持页面