金袋DSP对接文档
    • 金袋程序化广告投放接口

    金袋程序化广告投放接口

    使用条款#
    此文档协助第三方接入金袋程序广告交易平台,其中定义了接口和交互的标准规范。
    此文档适用于第三方广告平台与金袋程序化交易平台的对接。
    本文档由广州金袋有限公司起草,最终解释权归广州金袋有限公司所有。
    ==文档说明与proto注释不一致的,以文档说明为准==
    RTB接口
    通信方式
    交易平台和DSP之间的基础通信协议采用HTTP协议,使用POST方法发送BidRequest消息。使用GET方法发送Win Notice消息。
    测试参数:
    正式请求地址 :http://ad.api2.jindaixx.com/pb/r
    测试请求地址 :http://testapi2.jindaixx.com/pb/r(此地址如偶遇无法请求,则请使用正式地址)
    测试apptoken:223948433684303872
    测试广告位id:2
    请注意,一个广告位对应一个apptoken,不同的广告位对应不同的apptoken
    HTTP请求头
    Content-Type:application/x-protobuf
    HTTP状态码
    正常出价响应包的返回状态码为HTTP 200 OK,不正常的则为204 no content。群里沟通对接情况
    修订历史#
    版本修改时间修改内容
    1.02021.05.13Admin
    1.12024.06.03新增上报宏替换 __WIN_PRICE__ RTB 二价成交价格替换
    1.22024.08.09新增竞价失败上报 loseNoticeUrls
    1.32024.08.23新增系统启动时间(纳秒) boot_time_nanosec新增系统更新时间(纳秒) update_time_nanosec
    1.42024.08.23新增竞价成功上报 win_notice_urls
    1.52024.10.09新增oaidMd5值 oaidMd5
    1.62024.10.23新增下载六要素、激励视频相关
    1.72025.03.17新增快应用跳转链接quickapplink
    1.82025.04.16新增ipv6字段ipv6
    1.82025.04.16新增caid_list字段caid_list
    2.02025.12.01更改对接模式pb模式所有文档更新为pb格式对接
    2.12026.08.06新增ULink字段ULink
    请求实体BidRequsetModel#
    参数名类型说明是否必填(Y/N)
    signstring加密 签名,规则 :md5大写(time+slot_id+token) , 媒体token,slot_id 请联系商务/渠道人员获取Y
    slot_idint平台申请的slotIdY
    timelong请求平台的13位时间戳,精确到毫秒 (加密使用)Y
    bidfloorint千次展示底价,竞价必填(单位:分);N
    app_namestringapp名称N
    package_namestringapp包名N
    app_verstringapp版本号N
    keywordstring广告关键词,最多长度50N
    widthint广告位宽度N
    heightint广告位高度N
    ipstring网络真实 IP信息N
    ipv6string网络真实 IPv6信息N
    networkint网络类型 0未知、 1 wifi、 2 2G、 3 3G、 4 4G、 5 5GN
    operatorint网络运营商(用户识别码) 46000 中国移动、46001 中国联通、46003 中国电信N
    wifi_ssidstringwifi名称N
    wifi_bssidstringwifi对应的网卡mac地址N
    user_agentstring浏览器ua ,必须是客户端系统Webview的UA,而非系统原始UA或自定义定义UAN
    device_typeint设备类型 0 未知、1 phone、 2 pad、 3 pc、4 wapN
    osint设备类型 客户端操作系统 1 Android、 2 IOS、 3 WAP、 4 Windows、 5 鸿蒙N
    os_verstring操作系统版本N
    imeistring移动设备身份码N
    imeimd5stringMD5的移动设备身份码N
    android_idstring安卓IDN
    android_idmd5stringMD5的安卓IDN
    macstring设备的MAC 地址N
    macmd5string设备的MD5MAC地址N
    idfvstringIOS的idfvN
    idfvmd5stringidfvmd5值N
    idfastringIOS的idfa唯一标识N
    idfamd5stringidfamd5值N
    udidstringios中的openudidN
    duidstringwp的 duidN
    brandstring设备品牌 如苹果N
    modelstring设备型号 5S 6s 7sN
    densitydouble屏幕密度N
    screen_widthint屏幕宽度N
    screen_heightint屏幕高度N
    screen_orientationint横竖屏 0:未知、1:竖屏、2:横屏N
    languagestring当前使用语言N
    gps_typeintgps类型 0 高德、 1 百度、 2 腾讯、 3 谷歌、 4 其他N
    longitudedouble经度N
    latitudedouble纬度N
    packagesList< string >设备已安装app包名集合N
    imsistringimsi值N
    serialnostring移动设备序列号N
    oaidstring安卓10 IDN
    oaidMd5string安卓10 ID Md5值N
    acidstringios的acidN
    boot_markstring系统启动标识N
    update_markstring系统更新标识N
    hms_verstring华为安卓设备的HMS Core 的版本号,保留原始值(华为必传)N
    appstore_versionstring应用商店版本号(huawei、oppo、vivo 必传)N
    deviceNamestringiso的设备名称N
    deviceStartTimeint设备开机时间 卑位秒 (ios推荐填写)N
    deviceNameMd5string设备名称的 MD5 值 (ios推荐填写)N
    deviceMemorylong设备物理内存 单位byte(ios推荐填写)N
    deviceHardDisklong设备硬盘大小 卑位byte (ios推荐填写)N
    sysUpdateTimelong系统更新时间 卑位秒(ios推荐填写)N
    ppiint移动设备像素密度;例如:406N
    caidstringcaidN
    bootTimestring最近一次开机时间ISO必传 秒级N
    deviceModelstringios硬件版本号modelN
    deviceMachinestringios设备型号N
    paidstring拼多多需要的paid,更新时间:2023-6-20N
    caidverstringcaid版本号N
    cpu_numintCpu个数N
    sysComplingTimelong系统编译时间N
    inittimestring设备初始化时间N
    dpiint每英寸像素个数N
    boot_time_nanosecstring系统启动时间(纳秒) 示例值:1760655815.731337300N
    update_time_nanosecstring系统更新时间(纳秒) 示例值:1760655815.731337300N
    caid_listarray of caidlistlist集合 IOS caid 数组,14以上必传,新老版本都要传;N
    caidlist 对象#
    参数名类型说明是否必填(Y/N)
    ca_idstringcaid ios14替代idfa,例如:2a30adf7d1641daa3a940cc364b84f7dY
    caid_verstringcaid 版本,iOS14 以上必填,例如:20230506Y

    proto格式#

     syntax = "proto3";
    
    package jindaiadx;
    
    option csharp_namespace = "JindaiAdx.API";
    option java_package = "com.jindai.protobuf.adx.api";
    option java_outer_classname = "JindaiAdxApiProto";
    
    syntax = "proto3";
    
    package platform;
    
    option csharp_namespace = "YourNamespace";
    
    message PBAdRequest {
      string request_id = 1;
      string token = 2;
      int32 app_id = 3;
      int32 slot_id = 4;
      int64 time = 5;
      string sign = 6;
      int32 bidfloor = 7;
      string package_name = 8;
      string app_name = 9;
      string app_ver = 10;
      string keyword = 11;
      int32 width = 12;
      int32 height = 13;
      string ip = 14;
      string ipv6 = 15;
      int32 network = 16;
      int32 operator = 17;
      string wifi_ssid = 18;
      string wifi_bssid = 19;
      string user_agent = 20;
      int32 device_type = 21;
      int32 os = 22;
      string os_ver = 23;
      string imei = 24;
      string imeimd5 = 25;
      string android_id = 26;
      string android_idmd5 = 27;
      string mac = 28;
      string macmd5 = 29;
      string idfv = 30;
      string idfvmd5 = 31;
      string idfa = 32;
      string idfamd5 = 33;
      string udid = 34;
      string duid = 35;
      string brand = 36;
      string model = 37;
      double density = 38;
      int32 screen_width = 39;
      int32 screen_height = 40;
      int32 screen_orientation = 41;
      string language = 42;
      int32 gps_type = 43;
      double longitude = 44;
      double latitude = 45;
      int32 sdk_version = 46;
      repeated string packages = 47;
      string imsi = 48;
      string serialno = 49;
      string oaid = 50;
      string oaidmd5 = 51;
      string acid = 52;
      string boot_mark = 53;
      string update_mark = 54;
      string hms_ver = 55;
      string appstore_version = 56;
      string deviceName = 57;
      int32 deviceStartTime = 58;
      string deviceNameMd5 = 59;
      string timeZone = 60;
      int32 ppi = 61;
      string caid = 62;
      string caidmd5 = 63;
      string mac_md5 = 64;
      string bootTime = 65;
      string deviceModel = 66;
      string deviceMachine = 67;
      string paid = 68;
      string caidver = 69;
      int32 cpu_num = 70;
      string inittime = 71;
      int64 deviceMemory = 72;
      int64 deviceHardDisk = 73;
      int64 sysComplingTime = 74;
      int64 sysUpdateTime = 75;
      int32 dpi = 76;
      string boot_time_nanosec = 77;
      string update_time_nanosec = 78;
      string aaid = 79;
      string hms_ag = 80;
      string hms_gaid = 81;
      string adx_id = 83;
      string reqip = 84;
      repeated caid_list caid_list = 85;
    }
    
    message caid_list {
      string ca_id = 1;
      string caid_ver = 2;
    }
    
    
    message PBAdResponse {
      bool status = 1;
      string msg = 2;
      repeated Ad ads = 3;
      int32 code = 4;
      int32 nbr = 5;
      int64 cold_end_time = 6;
    }
    
    message Ad {
      int64 ad_id = 1;
      int32 type = 2;
      int32 price = 3;
      string creative_id = 4;
      string html = 5;
      int32 width = 6;
      int32 height = 7;
      string title = 8;
      string desc = 9;
      repeated string native_imgs = 10;
      string icon = 11;
      string brand_name = 12;
      int32 close_control = 13;
      int32 min_showtime = 14;
      int32 click_action = 15;
      string link = 16;
      string deeplink = 17;
      string ULink = 99
      ExtendTracking tracking = 18;
      string adx_id = 19;
      Videos videos = 20;
      string app_name = 21;
      string app_ver = 22;
      string package_name = 23;
      string app_icon = 24;
      uint32 app_size = 25;
      string app_developer_name = 26;
      string app_privacy_url = 27;
      string app_permission = 28;
      string app_function_introduction = 29;
      string quickapplink = 30;
      string creativeUniqueId = 31;
    }
    
    message ExtendTracking {
      repeated string exposure_tracking = 1;
      repeated string click_tracking = 2;
      repeated string deeplink_evoke = 3;
      repeated string download_start = 4;
      repeated string download_complete = 5;
      repeated string installation_start = 6;
      repeated string installation_complete = 7;
      repeated string activation = 8;
      repeated string deeplink_start = 9;
      repeated string loseNoticeUrls = 10;
      repeated string win_notice_urls = 11;
      repeated string click_area_report_url = 12;
    }
    
    message Videos {
      string video_url = 1;
      int32 video_duration = 2;
      bool prefetch = 3;
      repeated string video_loaded_trackers = 4;
      repeated string start_play_trackers = 5;
      repeated string video_play_25 = 6;
      repeated string video_play_50 = 7;
      repeated string video_play_75 = 8;
      repeated string end_play_trackers = 9;
      repeated string video_close = 10;
      repeated string video_skip = 11;
      repeated Playpercentage playpercentages = 12;
      string html = 13;
      repeated string html_exposure_tracking = 14;
      repeated string html_clos_tracking = 15;
      repeated string callback_trackers = 16;
      repeated string error = 17;
      Playtrackers play_trackers = 18;
      string cover_url = 19;
      repeated string play_1_trackers = 20;
      repeated string play_2_trackers = 21;
      repeated string play_3_trackers = 22;
      ExtendAds Ext = 23;
    }
    
    message ExtendAds {
      int32 t = 1;
      string ua = 2;
      int32 clk_t = 3;
      int32 render_t = 4;
      int32 render_ac = 5;
      int32 render_as = 6;
      int32 ot = 7;
      string headers = 8;
      string curl = 9;
      string img = 10;
    }
    
    
    
    
    // 播放进度追踪
    message Playpercentage {
      int32 checkpoint = 1;
      repeated string urls = 2;
    }
    
    // 播放跟踪器
    message Playtrackers {
      repeated string mute = 1;
      repeated string unmute = 2;
      repeated string play = 3;
      repeated string pause = 4;
      repeated string replay = 5;
      repeated string fullscreen = 6;
      repeated string unfullscreen = 7;
      repeated string upscroll = 8;
      repeated string downscroll = 9;
    }
    
    // 广点通下载响应
    message GuangdiantongDownloadResponse {
      ResponseData data = 1;
      int32 ret = 2;
      
      message ResponseData {
        string clickid = 1;
        string dstlink = 2;
      }
    }
    
    
    // 网络类型枚举
    enum NetworkType {
      NETWORK_UNKNOWN = 0;
      NETWORK_WIFI = 1;
      NETWORK_2G = 2;
      NETWORK_3G = 3;
      NETWORK_4G = 4;
      NETWORK_5G = 5;
    }
    
    // 设备类型枚举
    enum DeviceType {
      DEVICE_UNKNOWN = 0;
      DEVICE_PHONE = 1;
      DEVICE_PAD = 2;
      DEVICE_PC = 3;
      DEVICE_WAP = 4;
    }
    
    // 操作系统枚举
    enum OSType {
      OS_ANDROID = 1;
      OS_IOS = 2;
      OS_WAP = 3;
      OS_WINDOWS = 4;
      OS_HARMONY = 5;
    }
    
    // 屏幕方向枚举
    enum ScreenOrientation {
      ORIENTATION_UNKNOWN = 0;
      ORIENTATION_PORTRAIT = 1;
      ORIENTATION_LANDSCAPE = 2;
    }
    
    // GPS类型枚举
    enum GPSType {
      GPS_GAODE = 0;
      GPS_BAIDU = 1;
      GPS_TENCENT = 2;
      GPS_GOOGLE = 3;
      GPS_OTHER = 4;
    }
    
    // 运营商枚举
    enum OperatorType {
      OPERATOR_UNKNOWN = 0;
      OPERATOR_CMCC = 46000;
      OPERATOR_CUCC = 46001;
      OPERATOR_CTCC = 46003;
    }
    
    
    请求Json示例#
     {
    	"token": null,
    	"slot_id": 0,
    	"time": 0,
    	"sign": null,
    	"bidfloor": 0,
    	"app_ver": null,
    	"keyword": null,
    	"width": 0,
    	"height": 0,
    	"ip": null,
    	"network": 0,
    	"operator": 0,
    	"wifi_ssid": null,
    	"wifi_bssid": null,
    	"user_agent": null,
    	"device_type": 0,
    	"os": 0,
    	"os_ver": null,
    	"imei": null,
    	"imeimd5": null,
    	"android_id": null,
    	"android_idmd5": null,
    	"mac": null,
    	"macmd5": null,
    	"idfv": null,
    	"idfvmd5": null,
    	"idfa": null,
    	"idfamd5": null,
    	"udid": null,
    	"duid": null,
    	"brand": null,
    	"model": null,
    	"density": 0.0,
    	"screen_width": 0,
    	"screen_height": 0,
    	"screen_orientation": 0,
    	"language": null,
    	"gps_type": 0,
    	"longitude": 0.0,
    	"latitude": 0.0,
    	"sdk_version": 0,
    	"packages": null,
    	"imsi": null,
    	"serialno": null,
    	"oaid": null,
    	"acid": null,
    	"boot_mark": null,
    	"update_mark": null,
    	"hms_ver": null,
    	"appstore_version": null,
    	"deviceName": null,
    	"deviceStartTime": 0,
    	"deviceNameMd5": null,
    	"deviceMemory": 0,
    	"deviceHardDisk": 0,
    	"timeZone": null,
    	"sysUpdateTime": 0,
    	"ppi": 0,
    	"caid": null,
    	"mac_md5": null,
    	"bootTime": null,
    	"deviceModel": null,
    	"deviceMachine": null,
    	"paid": null,
    	"caidver": null,
    	"cpu_num": null,
    	"sysComplingTime": 0,
    	"inittime": null,
    	"dpi": 0
    }
    响应Json示例#
    {
        "status": true,
        "msg": null,
        "ads": [
            {
                "ad_id": 223959669734772736,
                "type": 0,
                "price": 0,
                "tp_price": 0,
                "creative_id": null,
                "html": null,
                "width": 0,
                "height": 0,
                "title": "上淘宝",
                "desc": "逛淘宝",
                "native_imgs": [
                    "https://jdossbucket.oss-cn-hangzhou.aliyuncs.com/Img/1.jpg",
                    "https://jdossbucket.oss-cn-hangzhou.aliyuncs.com/Img/2.jpg",
                    "https://jdossbucket.oss-cn-hangzhou.aliyuncs.com/Img/3.jpg"
                ],
                "icon": null,
                "close_control": 0,
                "min_showtime": 0,
                "click_action": 1,
                "link": "https://jdossbucket.oss-cn-hangzhou.aliyuncs.com/Img/1.jpg",
                "deeplink": "https://jdossbucket.oss-cn-hangzhou.aliyuncs.com/Img/1.jpg",
                "app_name": null,
                "package_name": null,
                "app_icon": null,
                "app_size": 0,
                "tracking": {
                    "exposure_tracking": [
                        "http://ad.api.jindaixx.com/api/e?s=RLBQOCLKQyXxHLDr7WtPh7XFoL12Xu7aGFIOGlb3I96bHb%2FXytRmveaQ3tHQafuEbQKAhPqz91esHzVzOf5hfpyUZtXfWKyhHRSHy18VqYbLsTS0ddYu6n29xhxmhuE0xW9h%2BvDpG%2FzhNp0EZ94ljs7qO83QW9BnxAjSDq4jVjEv%2FkxoEwwTN2cl3sF2UTB6gSPmUdLmv2TBZ6q753vHBIHfjag6VOat2NcuTnBMOdrSQ4cj8e46zYuQA43mNkGIINwGMwESr5LbWa9c7mc7tzE4HmfwkPgmwz066%2FgkzCca8M246rl3oHUH4SbhJaNiLX6jD%2F6%2BGjqmZnOkYXbmpI4%2FWu1KVNfErc67G5PlxuvVf2ygtdk6j3s0tJt88CmZzAr6qJtWqGEb9%2F4XJzNC70%2BDbdYpNe9b0am%2FFXX56Gznp%2FX4XbpMz5pwuRCOHdpHFy7I77p%2Bw6LRdld6W%2FvELB6w9dnV045yZe1CDumesiU%3D"
                    ],
                    "click_tracking": [
                        "http://ad.api.jindaixx.com/api/e?s=RLBQOCLKQyXxHLDr7WtPh7MV72aW6zqCJuSeDzxAWRJee9Xl%2FHYcyIKIU93LLuOx1c4U6Ai4cPe%2BYpIUXfT%2FBjBekPExxmGdC7mTsn58jXISe0RV1iP6gyYPdKYgTr6poWNMLaIW5P8ibz9wnI37tAc2ctV6Jidyzcx%2FjI3PedmHWm%2BrHh7RMpWmKLj1gUOD602uoKud8PwW5V8MBFgFUdQb4snCAw6HL91ObzPpLhFB5kL%2FG%2FzWlR3EMXFPB02D%2FbelzXilYj3zahYLIa5Q3Dl75JT7lD127YyDs0N2aMP0KW38DlU0N1TEFOI4EOuY9P7qAwY%2BtCTAGF%2BFNgOQWnIXTnmSsEmsXSJ58%2F2d2UmcCIewb5qkpIG1fnT0%2F51JknUrAT2zhKDWSpLGdf1SwdPyBctM3Z1ThFc4f%2BUocq%2FfDlDp0vhCOa2XLI%2BcPZkwqZWYKSjQk%2BincPCKpf7IAeFKlqLHx5Q6EElyozYcaug%3D"
                    ],
                    "deeplink_evoke": [
                        "http://ad.api.jindaixx.com/api/e?s=RLBQOCLKQyXxHLDr7WtPhzNQdba68wyi9yFmEuZsJiYdO5b%2FHpqrNDqi6SQeb2yxP%2Bxmr8Z547Z7QQ21GXJ1Balzg6wIR8JNT0SST8D4qOiTvLBZWchuH4RQ6uTibKGFrJvNMI%2FSW4RUxIsSB6VpVKhRJ%2BuwU1xgqBXXjcckxjRPiW7Oo8D289L7IpT9xAi5HomAm3JwWmg5QsrxurZ90V0lpdk2ckpZ%2Bow2YNRZ2VGROA373dIiOP1%2F1RWmka2fH8n%2FxUmVg%2FYxSVcYC0rxAahIwwTxw2qQKviyPIZ88v3No0hsgOvaKauyIJEXWv1L9KjcKU8e30R6MGKRyg3YNwNjc9FTUSJOG8k%2FFCq2ToHSmORigFyHo%2Ftp%2F73wYcYDL4t1euB9fimR2yAZXG2h7ZgZqMAEXxZVTjSNwwlxkjBszyafiTimO0qxorENL9NlxRWQcf4mlKma1IQ5ghIHMgLsdwOKsFfTbeSG3bXDG%2Fc%3D"
                    ],
                    "download_start": null,
                    "download_complete": null,
                    "installation_start": null,
                    "installation_complete": null,
                    "activation": null,
                    "deeplink_start": [
                        "http://ad.api.jindaixx.com/api/e?s=RLBQOCLKQyXxHLDr7WtPh5aeqDnGkvkkren%2B0lCBNUiOosErlKr3Jt%2FPF7dINoFy595PZ58NZesNZZcSLHczRT4bWSVs7pFFp%2ByVze2iFTU0n5wj1FCTJuW7PO4xwOd8uorLwVNojbcbRwDE%2Fn7c%2BjBjU9PR0TM2NJUX%2FRRzsm4FapN1q7QC%2BrFNhpoytNVv1t9on3IZzqlK6NBBfOaZJWyZC%2FSK7pSxKwEnD%2BaneJwuq%2BgvVgZcrRwdGbStd5i4QwAM5KKYo%2FyCDuMrYbzRTExrhvvgkgJ5DR7tkcJE74OfYar1ijhNP6dqne%2BZGtwjwHxHNZoWovuRbJiVhasKn21Rr4HOWlYBNdpa7UY930fA4c4R5RGMzZmUis3JA6o5sjeKvdhNiU3FpHYBWiXqwawDvRVbLEoy5W7brdRtZTNAPIMpcJnMU5XEg0TIqM1MqBnZgMrXo74w6eBRxnXjZyjmbO4yp%2BlcLrn%2F27VCU%2BY%3D"
                    ]
                }
            }
        ],
        "code": 0
    }
    响应实体BidRepostModel#
    参数名类型说明是否必填(Y/N)
    statusbool响应状态码 true:成功Y
    msgstring错误消息Y
    adsarray of ad广告集合信息Y
    校验类型codemsg
    时段定向4017时段定向不通过
    OS定向4017OS定向不通过
    设备号定向4017设备号定向不通过
    IP定向4017IP定向不通过
    机型定向4017机型定向不通过
    上游机型定向4017上游机型定向不通过
    网络定向4017网络定向不通过
    运营商定向4017运营商定向不通过
    已安装包名定向4017已安装包名定向未命中
    关键字过滤4017关键字过滤命中
    包名黑名单4017包名黑名单命中
    包名白名单4017包名白名单未命中
    已安装黑名单4017已安装黑名单命中
    已安装白名单4017已安装白名单未命中
    日期定向4017日期定向不通过
    媒体必传参数4017媒体必传参数缺失
    媒体频控4009媒体频控命中
    上游频控4010上游频控命中
    媒体IP频控4011媒体IP频控命中
    上游IP频控4011上游IP频控命中
    媒体设备频控4012媒体设备频控命中
    上游设备频控4012上游设备频控命中
    地域定向4016地域定向不通过
    包名筛选数据缺失4013包名筛选数据缺失
    包名频控4013包名频控命中
    包名频控4006无填充
    包名频控0正常请求

    AdModel#

    参数名类型说明是否必填(Y/N)
    priceint广告竞价成功的价格(单位)分/CPM 例如:1000分=10元N
    click_area_report_urlarray of string详见汇川上报N
    htmlstringhtml 信息N
    widthintbanner类图片宽度N
    heightintbanner类图片高度N
    titlestring广告标题N
    descstring广告描述N
    native_imgsarray of string素材图片地址N
    iconstring图片 iconN
    click_actionint点击行为 1:页面跳转,2 :下载,3:广点通下载,10:快应用跳转Y
    quickapplinkstring跳转快应用链接地址N
    linkstring链接地址,如果有宏替换的标识,需要宏替换Y
    deeplinkstringdeeplink 地址,如果有宏替换的标识,需要宏替换N
    ULinkstringiosDeeplink 地址,如果有宏替换的标识,需要宏替换N
    adx_idstring媒体的广告位id或自定义返回参数N
    trackingExtendTracking 对象上报地址N
    package_namestringapp包名 只在下载类广告时生效N
    app_iconstringapp图标 只在下载类广告时生效N
    app_sizeintapp大小 只在下载类广告时生效N
    app_namestringapp名称 只在下载类广告时生效(六要素)Y
    app_verstringapp版本 只在下载类广告时生效(六要素)Y
    app_developer_namestringapp开发者(公司)名称 只在下载类广告时生效(六要素)Y
    app_privacy_urlstringapp隐 私 政策url 只在下载类广告时生效(六要素)Y
    app_permissionstringapp应用权限url 只在下载类广告时生效(六要素)Y
    app_function_introductionstring下载类广告必填、合规六要素只在下载类广告时生效(六要素)Y
    videosVideos 对象激励视频相关Y
    ExtendTrackingModel#
    参数名类型说明是否必填(Y/N)
    exposure_trackingarray of string展示上报地址,如果有宏替换的标识,需要宏替换N
    click_trackingarray of string点击上报地址,如果有宏替换的标识,需要宏替换N
    deeplink_evokearray of stringdeeplink 唤起成功上报地址,如果有宏替换的标识,需要宏替换N
    deeplink_startarray of stringdeeplink 开始打开监测,需要宏替换N
    download_startarray of string下载开始上报地址 ,如果有宏替换的标识,需要宏替换N
    download_completearray of string下载完成上报地址,如果有宏替换的标识,需要宏替换N
    installation_startarray of string安装开始上报地址 ,如果有宏替换的标识,需要宏替换N
    installation_completearray of string安装完成上报地址,如果有宏替换的标识,需要宏替换N
    activationarray of string激活上报地址,如果有宏替换的标识,需要宏替换N
    loseNoticeUrlsarray of string竞价失败上报地址,如果有宏替换的标识,需要宏替换N
    win_notice_urlsarray of string竞价成功上报地址,如果有宏替换的标识,需要宏替换N
    Videos 对象#
    参数名类型说明是否必填(Y/N)
    video_urlstring视频地址N
    video_durationint视频广告的时长,单位秒N
    cover_urlstring视频封面图片地址N
    prefetchbool是否预先加载视频N
    video_loaded_trackersarray of string视频加载成功上报地址N
    start_play_trackersarray of string视频播放开始上报地址N
    video_play_25array of string视频播放25%上报N
    video_play_50array of string视频播放50%上报N
    video_play_75array of string视频播放75%上报N
    end_play_trackersarray of string视频播放完成上报地址N
    video_closearray of string关闭视频上报地址N
    video_skiparray of string跳过视频上报地址N
    htmlstringHTML 片段,不为空时使用,必须在视频播放完毕后再渲染 HTML片段N
    html_exposure_trackingarray of stringHTML 展示上报链接N
    html_clos_trackingarray of stringHTML 关闭上报链接N
    callback_trackersarray of string服务器激励回调上报 URLN
    errorarray of string视频播放错误上报地址N
    playpercentagesarray of Playpercentage播放进度上报地址N
    play_trackersPlaytrackers对象视频扩展上报地址N
    Playpercentage  对象#
    参数名类型说明是否必填(Y/N)
    checkpointint时间(秒)N
    urlsarray of string跟踪上报地址N
    Playtrackers 对象#
    参数名类型说明是否必填(Y/N)
    mutearray of string静音事件上报地址N
    unmutearray of string关闭静音事件上报地址N
    playarray of string播放事件上报地址N
    pausearray of string暂停事件上报地址N
    replayarray of string重新播放事件上报地址N
    fullscreenarray of string全屏事件上报地址N
    unfullscreenarray of string退出全屏事件上报地址N
    upscrollarray of string上滑事件上报地址N
    downscrollarray of string下滑事件上报地址N
    宏替换#
    参数名类型
    __WIN_PRICE__二价成交价宏替换,明文替换不需要加密,例如:1500 ,单位:分
    __LAT__手指按下时的纬度坐标
    __LON__手指按下时的经度坐标
    __DOWN_X__手指按下时的横坐标,屏幕坐标
    __DOWN_Y__手指按下时的纵坐标,屏幕坐标
    __UP_X__手指松开时的横坐标,屏幕坐标
    __UP_Y__手指松开时的纵坐标,屏幕坐标
    __BUTTON_LUX__广告 按钮 区域 坐标定义:以屏幕左上角坐标为原点左上角横坐标
    __BUTTON_LUY__广告 按钮 区域 坐标定义:以屏幕左上角坐标为原点左上角纵坐标
    __BUTTON_RDX__广告 按钮 区域 坐标定义:以屏幕左上角坐标为原点左上角纵坐标
    __BUTTON_RDY__广告 按钮 区域 坐标定义:以屏幕左上角坐标为原点右下角纵坐标
    __AD_X__广告左上角坐标 x
    __AD_Y__广告左上角坐标 y
    __ADRB_X__广告右下角坐标 x
    __ADRB_Y__广告右下角坐标 y
    __OFFSET_X__手指按下时的横坐标,广告 view 上的相对坐标,以广告左上角为原点,不是屏幕的坐标
    __OFFSET_Y__手指按下时的纵坐标,广告 view 上的相对坐标,以广告左上角为原点,不是屏幕的坐标
    __OFFSET_UP_X__手指松开时的横坐标,广告 view 上的相对坐标,以广告左上角为原点,不是屏幕的坐标
    __OFFSET_UP_Y__手指松开时的纵坐标,广告 view 上的相对坐标,以广告左上角为原点,不是屏幕的坐标
    __TIME_START__手指按下时的时间戳(十三位,毫秒)
    __TIME_END__手指松开时的时间戳(十三位,毫秒)
    __TIME_TEN_START__手指按下时的时间戳(十位,秒)
    __TIME_TEN_END__手指松开时的时间戳(十位,秒)
    __CLICKID__广点通宏替换参数
    __DP_WIDTH__广告位的宽度,Android 端单位为逻辑像素(dp)
    __DP_HEIGHT__广告位的高度,Android 端单位为逻辑像素(dp)
    __DP_DOWN_X__手指按下时的 x 坐标(相对于广告位左上顶点), Android 端单 位为逻辑像素(dp)
    __DP_DOWN_Y__手指按下时的 y 坐标(相对于广告位左上顶点), Android 端单 位为逻辑像素(dp)
    __DP_UP_X__手指离开手机屏幕时的 x 坐标(相对于广告位左上顶点), Android 端单位为逻辑像素(dp)
    __DP_UP_Y__手指离开手机屏幕时的 y 坐标(相对于广告位左上顶点), Android 端单位为逻辑像素(dp)
    __SLD__广告交互方式(其中常规触屏点击、滑动点击、自定义手势、擦除需上报点击坐标摇一摇、扭一扭可以不上报点击坐标,需将点击坐标宏替换为-999):0 - 常规触屏点击 1 - 滑动点击 2 - 摇一摇 3 - 自定义手势 5 - 扭一扭 6 - 擦除
    __CLICKAREA__点击区域:1-广告素材;2-按钮
    __X_MAX_ACC__当 SLD=2 时需要替换,用户摇动点击时 x轴加速度峰值。Android 端乘以 100 取整,iOS 端乘以 980取整。
    __Y_MAX_ACC__当 SLD=2 时需要替换,用户摇动点击时 y轴加速度峰值。Android 端乘以 100 取整,iOS 端乘以 980取整
    __Z_MAX_ACC__当 SLD=2 时需要替换,用户摇动点击时 z轴加速度峰值。Android 端乘以 100 取整,iOS 端乘以 980取整。
    __TURN_X__当 SLD=5 时需要替换,对比扭动前初始位置,扭动触发点击时的 x 轴扭动角度,为-180 到 180 的整数。
    __TURN_Y__当 SLD=5 时需要替换,对比扭动前初始位置,扭动触发点击时的 y 轴扭动角度,为-180 到 180 的整数。
    __TURN_Z__当 SLD=5 时需要替换,对比扭动前初始位置,扭动触发点击时的 z 轴扭动角度,为-180 到 180 的整数。
    __TURN_TIME__当 SLD=5 时需要替换,扭动触发点击时扭动的总时间(单位毫秒,保留整数)。即最后一次监听到 3 个方向扭动角度均小于±5 度,到点击触发的时间。
    广点通类下载广告说明#
    如果action=3,代表下载类广告需要对 url 链接地址进行宏替换处理,宏替换处理完成后, 需要 get 请求 url 链接地址地址,返回结果为 json,内容如下,从 json 中提取真实下载 dstlink,如下格式:
    名称类型是否必填(Y/N)描述
    clickidstringY点击 ID,需要缓存下来,用于后续下载,安装,激活类转化上报链接中${CLICKID} 的宏替换
    dstlinkstringY目标地址,即 apk 下载地址
    retintY错误码,0 表示返回正常,否则表示错误
    {
        "data":{
            "clickid":"xxxxxxxxxxxxx",
            "dstlink":"http://xxx.com/xxx/xxx.apk"
        },
        "ret":0
    }
    汇川上报#
    1. 点击坐标反馈:该接口用于汇川广告在媒体侧产生点击事件时,由媒体回传点击坐标
    信息,用于反作弊。
    2. 触发条件:如汇川广告在媒体侧产生点击事件,则构造 POST 请求,并使用规定 json
    串为 body。
    3. 业务流程:
    	3.1. 汇川检索在 click_area_report_url 上追加 sid 和 creative_id,并下发给媒体。
    	3.2. 汇川广告在媒体侧产生点击事件时,媒体构造 post 请求,body 为 json 串:
    		3.2.1. 客户端将 click_area_report_url 中的 sid 和 creative_id 解析后追加到json 串 中的 “sid” 和 “creative_id”
    		3.2.2. 追加相应的点击信息到”click_element”,如点击标题等 click_element:title
    		3.2.3. json 串 kv 均为字符串形式。
    4. 响应中 click_area_report_url 的示例
    			
    	[https://test.huichuan.sm.cn/redirect/click\_area?sid=12345&creative\_id=456](https://test.huichuan.sm.cn/redirect/click_area?sid=12345&creative_id=456)  
    		{  
    		“sId” : “必填 string 实际的点击方式 枚举值:  
    			0-常规触屏点击,1-滑动点击,2-摇一摇,3-自定义手势,  4-点击或滑动,5-扭一扭,6-擦除触发点击,7-横竖屏转换,  
    			仅 sId=0,1,3,4,6 时 需要媒体上报点击坐标”,  
    		“width” : “必填 string 实际广告位的宽,单位为像素”,  
    		“height” : “必填 string 实际广告位的高,单位为像素”,  
    		“down_x” : “必填 string 用户手指按下时的横坐标”,  
    		“down_y” : “必填 string 用户手指按下时的纵坐标”,  
    		“up_x” : “必填 string 用户手指离开屏幕时的横坐标”,  
    		“up_y” : “必填 string 用户手指离开屏幕时的纵坐标”,  
    		“click_element” : “string 点击标题 title 信息”,  
    		“sid” : “必填 string 媒体端上从 click\_area\_report\_url 中解析的 sid”,  
    		“creative\_id” : “必填 string 媒体端上从 click\_area\_report\_url 中解析的 creative\_id”  
    		}
    修改于 2026-08-06 09:26:09
    Built with