火眼广告平台

# 基本信息

# 介绍

本文档描述了媒体主如何 通过 Server To Server 的方式接入火眼移动广告系统，请求并展示广告。

本文档适用人群 ：媒体相关技术人员

# 接入流程

接入流程

# API 约定

# 请求

# 地址

http://ss.myhayo.com/adx

# 方法

使用 POST 方法请求服务器

名称 是否必填 说明
Content-Type 是 固定填 application/json
X-Forwarded-For 是 用户设备的公网出口 IPv4 地址
形如 14.17.22.37
当广告请求由 Server 发起时，该字段务必正确填写，否则将严重影响流量变现效果
Accept-Encoding 是 是否启用压缩(开启后会显著减少网络传输时间)
形如 Accept-Encoding: gzip
User-Agent 否 用户设备 HTTP 请求头中的 User-Agent 字段
Referer 否 用户设备 HTTP 请求头中的 Referer 字段

注意

HTTP 请求头必须按照要求传值

HTTP 请求头必须按照要求传值

HTTP 请求头必须按照要求传值

# 响应

# 状态码

详情查看下文

# 响应体

响应体如果不为空, 解压后均为 JSON 格式的字符串。

# 更新记录

# 2024-08-05 版本号: 2.6.3

  1. 返回 宏定义

新增宏

  • __LOCAL_TIME__

# 2024-06-19 版本号: 2.6.2

  1. 请求 request-device

废弃参数

  • caid
  • caid_md5
  • caid_version

新增参数

  • caid_infos

# 2023-07-03 版本号: 2.6.1

  1. 返回 response

新增参数

  • app_name
  • app_version
  • app_developer
  • app_permission
  • app_privacy

# 2023-06-26 版本号: 2.6

  1. 请求 request-device

新增参数

  • density
  • appstore_version
  • physical_memory
  • harddisk_size
  • hardware_model
  • time_zone
  • birth_time
  1. 请求 request-media

新增参数

  • app_name

废弃参数

  • am_ver_code
  1. 废弃 POST 监测上报对象
  1. 新增宏
  • __AB_DOWN_X__
  • __AB_DOWN_Y__
  • __AB_UP_X__
  • __AB_UP_Y__
  • __DP_WIDTH__
  • __DP_HEIGHT__
  • __DP_DOWN_X__
  • __DP_DOWN_Y__
  • __DP_UP_X__
  • __DP_UP_Y__
  • __SLD__
  • __X_MAX_ACC__
  • __Y_MAX_ACC__
  • __Z_MAX_ACC__
  • __TURN_X__
  • __TURN_Y__
  • __TURN_Z__
  • __TURN_TIME__

# 2023-03-29 版本号: 2.5.8

  1. 请求 request 新增 is_https 参数

# 历史版本

# 2021-03-30 版本号: 2.5.1

  1. 调整 wxminiprog 中 minip_type 的枚举

调整如下

1-正式版；2-开发版；3-体验版，默认 1

0-正式版；1-开发版；2-体验版，默认 0

  1. 小程序广告 下发 click_link

优先通过 wxminiprog 跳转小程序，如果跳转失败则直接浏览器打开 click_link

# 2021-03-15 版本号: 2.5

  1. 请求中的 media 对象新增字段 is_wxminiprog (即是否支持微信小程序唤起)。

  2. 返回结构新增 wxminiprog 对象 （即唤起微信小程序的内容）。

  3. 交互方式 interact_type 新增类型 3 (微信小程序)

# 2021-06-10 版本号: 2.5.2

  1. 请求的 media 对象新增参数 am_ver_code

  2. 请求的 device 对象新增参数 hms_ver_code

# 2021-10-21 版本号: 2.5.3

  1. 请求的 device 对象新增参数
  • boot_mark
  • update_mark

  1. 请求的 media 对象 app_version 由选填调整为必填

  2. 返回的 adtracking 新增监测事件

  • 101014 : 视频广告播放 1/4 进度上报
  • 101012 : 视频广告播放 1/2 进度上报
  • 101034 : 视频广告播放 3/4 进度上报

# 2022-03-07 版本号: 2.5.4

  1. 新增音频广告形式
  • 音频信息流
  • 首听
# 注意事项

  1. 必须支持 MP3 音频播放

  2. 必须上报 监测事件 adtracking

  • 101000 : 音视频广告开始播放
  • 101002 : 音视频广告结束播放
  • 101014 : 音视频广告播放 1/4 进度上报
  • 101012 : 音视频广告播放 1/2 进度上报
  • 101034 : 音视频广告播放 3/4 进度上报

详情请咨询商务

  1. 返回的 广告 对象 新增两个字段
  • audio_url 音频链接
  • audio_duration 音频播放时长(单位: 秒)

# 2022-06-10 版本号: 2.5.5

  1. 请求 device 新增参数 oaid_md5

# 2022-11-30 版本号: 2.5.6

  1. 请求 device 新增 caid 系列参数

# 2023-02-21 版本号: 2.5.7

针对特定预算，火眼支持 RTB 竞价

媒体方 请求 携带底价， 火眼 返回出价

媒体方 替换 __WIN_PRICE__ 上报

如有需要请联系商务

  1. 请求 pos 新增 bid_type, bid_floor 系列参数
  2. 响应 pos 新增 bid_price 参数
  3. 展示监测新增 __WIN_PRICE__ 成交价宏

广告请求 →