Google Ad Manager 提供 SOAP API,可用於回報及操控廣告投放實體 (例如 LineItems)。
用戶端程式庫支援多種語言。與 AdX Seller API 一樣,Ad Manager API 同樣會使用 OAuth2 進行驗證。
如要開始使用第一個 API 要求,請參閱入門指南。
Ad Manager API 中的報表
Ad Manager API ReportService 提供兩種方式執行及下載報表:
- 在 UI 中建立查詢,並根據其 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 | 廣告有效千次曝光出價 |
| 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 | 廣告請求有效千次曝光出價 |
| 點擊次數 | 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 | (新版建議) 廣告有效千次曝光出價 |
| 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 | 影片四分位數 1 |
| VIDEO_AD_QUARTILE_THREE | AD_EXCHANGE_VIDEO_QUARTILE_3 | 影片四分位數 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 | 需求端平台 |
| 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 | 定價規則 |