API接口示例


联调URL

请使用线上服务地址:http://ope.tanx.com/api

您可以使用本节提供的联调pid进行开发联调,联调pid的返回数据(如素材尺寸)是固定的,仅供开发使用。实际投放会根据媒体素材规范进行配置

当您无法获取到广告时,请使用http://ope.tanx.com/api?trace=1发送请求,并提供请求基础结构中的请求id供我们排查原因。

注:本页提供的示例以Json格式展示,实际请求API接口请使用Protocol Buffer方式


开屏类型

  • 开屏类型联调pid1: mm_116532257_14926483_58192126

  • 联调支持的请求尺寸:720x1280,750x1624,1242x2208,1080x1920,1080x2340,640x1136 (其他尺寸不返回广告)

  • 联调请求所需deal_id:splash_dealid_test

请求一个广告
  • 请求示例
{
  "app": {
    "app_name": "alimama",
    "package_name": "com.alimama.android",
    "category": [
      "电"
    ]
  },
  "id": "0a674362000057b6be176e7600d4c089",
  "version": 2,
  "imp": [
    {
      "deal": [
        {
          "min_price": 0,
          "deal_id": "splash_dealid_test"
        }
      ],
      "slot_num": 1,
      "pos": 1,
      "width": 720,
      "is_fullscreen": false,
      "pid": "mm_116532257_14926483_58192126",
      "id": 0,
      "campaign_date": "20201111",
      "height": 1280
    }
  ],
  "device": {
    "os": "Android",
    "ip": "58.44.34.93",
    "timezone_offset": 480,
    "device_type": 0,
    "mac": "10:e9:53:66:cc:63",
    "operator": 1,
    "network": 1,
    "osv": "28",
    "imei_md5": "f6917410470e0ac479c3c2a365c29819",
    "width": 1080,
    "model": "HUAWEI",
    "user_agent": "Mozilla/5.0 (Linux; Android 9; GLK-AL00 Build/HUAWEIGLK-AL00; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/70.0.3538.64 Mobile Safari/537.36",
    "oaid": "f3fecefb-755f-ab9d-fff5-790b9dfe49fd",
    "height": 2208
  }
}
  • 广告响应示例
{
id: "0a674362000057b6be176e7600d4c089"
status: 0
seat {
  id: 0
  ad { 
    id: 0
    creative_type: 2
    category: 60107
    destination_url: "http://www.taobao.com"
    impression_tracking_url: "http://df.tanx.com/spf?e=D6VQPt8&k=205"
    impression_tracking_url: "http://df.tanx.com/track?e=88o2g2D7%2F"
    click_through_url: "https://jvrhzp.tmall.com"
    click_tracking_url:"http://rdstat.tanx.com/trd?f=&&p=mm_2000139"
    deal_id: "12345"
    native_ad {
        attr {
        name: "img_url"
        value: "http://i.mmcdn.cn/simba/img/TBSutbFXXX.jpg"
      }
      template_id: 4
    }
    campaign_date: "20191111"  //媒体须在此日期展示
  }
}
}

请求两个广告
  • 请求示例
{
    "app":{
        "app_name":"alimama",
        "package_name":"com.alimama.android",
        "category":[
            "电"
        ]
    },
    "id":"0a674362000057b6be176e7600d4c089",
    "version":2,
    "imp":[
        {
            "deal":[
                {
                    "min_price":0,
                    "deal_id":"splash_dealid_test"
                }
            ],
            "slot_num":1,
            "pos":1,
            "width":720,
            "is_fullscreen":false,
            "pid":"mm_116532257_14926483_58192126",
            "id":0,
            "campaign_date":"20201110",//请求第一天的广告 
            "height":1280
        },
        {
            "deal":[
                {
                    "min_price":0,
                    "deal_id":"splash_dealid_test"
                }
            ],
            "slot_num":1,
            "pos":1,
            "width":720,
            "is_fullscreen":false,
            "pid":"mm_116532257_14926483_58192126",
            "id":1,
            "campaign_date":"20201111",//请求第二天的广告
            "height":1280
        }
    ],
    "device":{
        "os":"Android",
        "ip":"58.44.34.93",
        "timezone_offset":480,
        "device_type":0,
        "mac":"10:e9:53:66:cc:63",
        "operator":1,
        "network":1,
        "osv":"28",
        "imei_md5":"f6917410470e0ac479c3c2a365c29819",
        "width":1080,
        "model":"HUAWEI",
        "user_agent":"Mozilla/5.0 (Linux; Android 9; GLK-AL00 Build/HUAWEIGLK-AL00; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/70.0.3538.64 Mobile Safari/537.36",
        "oaid":"f3fecefb-755f-ab9d-fff5-790b9dfe49fd",
        "height":2208
    }
}
  • 广告响应示例
{
id: "0a674362000057b6be176e7600d4c089"
status: 0
seat { //第一天的广告
  id: 0 //对应请求中第0个imp
  ad { 
    id: 0
    creative_type: 2
    category: 60107
    destination_url: "http://www.taobao.com"
    impression_tracking_url: "http://df.tanx.com/spf?e=D6VQPt8&k=205"
    impression_tracking_url: "http://df.tanx.com/track?e=88o2g2D7%2F"
    click_through_url: "https://jvrhzp.tmall.com"
    click_tracking_url:"http://rdstat.tanx.com/trd?f=&&p=mm_2000139"
    deal_id: "splash_dealid_test"
    native_ad {
        attr {
        name: "img_url"
        value: "http://i.mmcdn.cn/simba/img/TBSutbFXXX.jpg"
      }
      template_id: 4
    }
    campaign_date: "20191110"
  }
}
seat{ //第二天的广告
  id:1  //对应请求中第1个imp
  ad { 
    id: 0
    creative_type: 2
    category: 60107
    destination_url: "http://www.taobao.com"
    impression_tracking_url: "http://df.tanx.com/spf?e=D6VQPt8&k=205"
    impression_tracking_url: "http://df.tanx.com/track?e=88o2g2D7%2F"
    click_through_url: "https://jvrhzp.tmall.com"
    click_tracking_url:"http://rdstat.tanx.com/trd?f=&&p=mm_2000139"
    deal_id: "splash_dealid_test"
    native_ad {
        attr {
        name: "img_url"
        value: "http://i.mmcdn.cn/simba/img/TBSutbFXXX.jpg"
      }
      template_id: 4
    }
    campaign_date: "20191111"
  }
}
}

信息流(其他类型)

  • 信息流联调pid: mm_116532257_14926483_58180224

  • 联调返回图片样式:大图640x200,三图150x100

  • 联调请求所需deal_id:feed_dealid_test
请求示例
{
version: 2
id: "0a674362000057b6be176e7600d4c089"
imp {
  id: 0
  pid: "mm_116532257_14926483_58180224"
  deal {
    deal_id: "feed_dealid_test"
    min_price: "0"
       }
}
device {
  ip: "59.172.75.115"
  user_agent: "Mozilla/5.0 (Linux; U; Android 4.2.2; zh-CN; vivo Y13 Build/JDQ39) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 UCBrowser/10.10.8.822 U3/0.8.0 Mobile Safari/534.30"
  imei: "867348022656925"
  device_type: 0
  brand: "Samsung"
  model: "galaxy"
  os: "Android"
  osv: "4.4.4"
  network: 1
  operator: 1
  width: 480
  height: 640
  pixel_ratio: 10000
  timezone_offset: 480
}
app {
  package_name: "com.xxxx.news"
  app_name: "新闻"
  category: "101701"
}
}

响应示例

{
id: "0a674362000057b6be176e7600d4c089"
status: 0
seat {
  id: 0
  ad { 
    id: 0
    creative_type: 2
    category: 60107
    destination_url: "http://www.taobao.com"
    impression_tracking_url: "http://df.tanx.com/spf?e=D6VQPt8&k=205"
    impression_tracking_url: "http://df.tanx.com/track?e=88o2g2D7%2F"
    click_through_url: "https://jvrhzp.tmall.com"
    click_tracking_url:"http://rdstat.tanx.com/trd?f=&&p=mm_2000139"
    deal_id: "feed_dealid_test"
    native_ad {   //此处表示原生的各种元素
        attr {
        name: "img_url"
        value: "http://i.mmcdn.cn/simba/img/TBSutbFXXX.jpg"
      }
       attr {
         name: "title"
           value: "男士速干透气健身运动裤"
          }
      template_id: 4
    }
  }
}
}

1. 联调pid的返回数据(如素材尺寸)是固定的,仅供开发使用。实际投放会根据媒体素材规范进行配置
Copyright © 2017 Taobao.com. all right reserved,powered by Gitbook最后修订时间: 2020-06-18 22:10:06

results matching ""

    No results matching ""