ToBid 聚合管理 OpenAPI

修订历史

文档版本	发布时间	修订说明
v 2.6	2026年3月6日	增加聚推，旺脉，泛为渠道
v 2.5	2025年4月11日	优化广告网络参数样例枚举
v 2.3	2024年12月31日	支持聚合广告位激励服务器回调
v 2.2	2024年7月15日	增加广告网络auth_source参数说明、流量分组规则说明
v 2.1	2024年6月5日	增加针对原生转、广告类型优选等新功能的Open API支持
v 2.0	2023年9月15日	增加广告源数据获取接口，升级签名验证方式
v 1.0	2022年11月30日	支持全部聚合管理接口

开发者可以通过请求 ToBid 聚合管理 OpenAPI，实现聚合管理功能。API 支持

聚合应用管理
第三方广告网络账号管理
聚合广告位管理
聚合广告位瀑布流管理
聚合广告位绑定第三方广告源的管理

每一个模块均支持查询、编辑、新建能力。使用此 API 依赖开发者已经开通 ToBid 聚合服务权限，具体开通步骤联系ToBid 商务。

V1版本的签名(已弃用)

v1版本签名算法,已弃用，建议升级，参见下一节1.接口请求说明V2

此模块用于验证账号正确性及权限。

所有接口必传以下 3 个参数，GET 请求时参数以 QueryString 的形式出现，POST 请求时以 application/json 形式出现。API 文档中入参不再写这 3 个参数，但提交请求时务必加上。接口中 type 为 list 或 dict 时，需将其序列化具体实现参考 签名示例

key	type	required	comment	value
_user	String	Y	Tobid 平台的注册账户	abc@163.com
_t	Interge	Y	13 位时间戳，服务端会校验时间戳参数_t，请求时间在服务器时间±3s 内请求有效	1582271847180
_sign	String	Y	获取 URL 请求的所有参数，除_sign 参数外（即 _user 、_t、appid），按参数名升序将参数值字符串拼接，然后加上 secret_key（secret_key 为账户管理下的 Sigmob SecretKey），对得到的字符串进行SHA-1 得到 sign 参数的值。	c032c2d84f0e2c9de1b581049d979c870fcfb069

v1版 Python签名示例

python

_user = "abc@163.com"
_t = 1582271847180
appid = 1235 
# 以上为除 sign 参数外所有的参数，按参数名升序排列后得到的拼接值
s='1582271847180abc@163.com1235'
# 假定 secret_key = '96188eff7a33a6d4f549763fa366e5ff' ，则
sh = s+ secret_key='1582271847180abc@163.com123596188eff7a33a6d4f549763fa366e5ff'
# SHA-1 计算的
_sign = '40d76f273702ea4d44c5b11c7f9854c2434c3a0f'

def sign():
  sk = '96188eff7a33a6d4f549763fa366e5ff'
  base_info = {"_user": "abc@163.com",
               "_t": 1582271847180,
               "appid": 1235,
              }
  # print("三个参数名升序：")
  src_keys = sorted(base_info.keys())
  asc_str = ''
  for item in src_keys:
    asc_str += str(base_info.get(item))
    print(asc_str)
    sign_str = asc_str + sk
    print("加上sk：")
    print(sign_str)
    return hashlib.sha1(sign_str.encode("utf-8")).hexdigest()

v1版 Java请求示例

xml

<!--相关maven依赖-->
<dependencies>
	<dependency>
		<groupId>commons-codec</groupId> <!--apache commons codec-->
		<artifactId>commons-codec</artifactId>
		<version>1.15</version>
	</dependency>
	<dependency>
		<groupId>org.apache.httpcomponents.client5</groupId>
		<artifactId>httpclient5</artifactId>
		<version>5.2.1</version>
	</dependency>
	<dependency>
		<groupId>org.apache.commons</groupId>
		<artifactId>commons-lang3</artifactId>
		<version>3.12.0</version>
	</dependency>
	<dependency>
		<groupId>com.fasterxml.jackson.core</groupId>
		<artifactId>jackson-databind</artifactId>
		<version>2.15.2</version>
	</dependency>
</dependencies>

java

package com.tobid.openapi;

import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.commons.codec.binary.Hex;
import org.apache.commons.lang3.tuple.ImmutablePair;
import org.apache.commons.lang3.tuple.Pair;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClients;
import org.apache.hc.core5.http.ClassicHttpRequest;
import org.apache.hc.core5.http.ContentType;
import org.apache.hc.core5.http.HttpHeaders;
import org.apache.hc.core5.http.io.entity.EntityUtils;
import org.apache.hc.core5.http.io.entity.StringEntity;
import org.apache.hc.core5.http.io.support.ClassicRequestBuilder;
import org.apache.hc.core5.net.URIBuilder;
import org.apache.hc.core5.util.Asserts;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

public class Demo {

	/**
	 * 变现账户名
	 */
	private static final String USER_NAME = "";
	/**
	 * Sigmob Secret Key，从平台账户管理->Keys功能页获取。<br/>
	 * 注意，这里要使用Sigmob Secret Key，而不是ToBid Secret Key
	 */
	private static final String SECRET_Key = "";

	/**
	 * 签名使用 SHA-1(160bit)算法生成<br/>
	 * 
	 * @param plainText
	 * @return
	 * @throws NoSuchAlgorithmException
	 */
	public static String sha1(String plainText) throws NoSuchAlgorithmException {
		MessageDigest messageDigest = MessageDigest.getInstance("SHA");
		byte[] cipherBytes = messageDigest.digest(plainText.getBytes());
		String cipherStr = Hex.encodeHexString(cipherBytes);
		return cipherStr;
	}

	/**
	 * 获取 URL 请求的所有参数对，按参数名升序排序后，将所有参数值做字符串连接<br/>
	 * 在拼接后的字符串后，再追加secret key，计算出用于签名的字符串<br/>
	 * 
	 * @param requestParams
	 * @return
	 */
	public static String prepaireSignPlainText(List<Pair<String, Object>> requestParams) {
		// 先对请求参数按照参数名升序排序
		Collections.sort(requestParams, new Comparator<Pair<String, Object>>() {
			@Override
			public int compare(Pair<String, Object> o1, Pair<String, Object> o2) {
				return o1.getKey().compareTo(o2.getKey());
			}
		});
		// 将排序后的参数对的value值按次拼成一个字符串
		StringBuilder sb = new StringBuilder();
		requestParams.forEach(temp -> {
			sb.append(temp.getValue());
		});

		/**
		 * 注意，这里别忘了追加secretKey，用于签名
		 */
		sb.append(SECRET_Key);
		return sb.toString();
	}

	/**
	 * 获取 URL 请求的所有参数对，按参数名升序排序后，将所有参数值做字符串连接。<br/>
	 * 在拼接后的字符串后，再追加secret key，计算出用于签名的字符串<br/>
	 * 对得到的字符串进行SHA-1(160bit)哈希操作得到的值即为请求签名。<br/>
	 * 
	 * @param requestParams
	 * @return
	 * @throws NoSuchAlgorithmException
	 */
	public static String sign(List<Pair<String, Object>> requestParams) throws NoSuchAlgorithmException {
		String plainText = prepaireSignPlainText(requestParams);
		return sha1(plainText);
	}

	public static String buildRequestObjectJson(List<Pair<String, Object>> requestParams)
			throws JsonProcessingException {
		Map<String, Object> requestMap = new HashMap<String, Object>();
		requestParams.forEach(temp -> {
			requestMap.put(temp.getKey(), temp.getValue());
		});
		ObjectMapper om = new ObjectMapper();
		return om.writeValueAsString(requestMap);
	}

	/**
	 * 
	 * @param url    接口地址
	 * @param params 接口需要的业务参数对（不包含公共参数_user,_t,_sign这三个用于签名校验的参数）
	 * @throws IOException
	 * @throws URISyntaxException
	 * @throws NoSuchAlgorithmException
	 */
	public static String doRequest(String url, List<Pair<String, Object>> params)
			throws IOException, URISyntaxException, NoSuchAlgorithmException {

		// 根据传入参数，创建http request参数对
		List<Pair<String, Object>> requestParams = new ArrayList<Pair<String, Object>>(params);

		// 除了业务需要的请求参数外，需要追加时间戳以及_user参数用于签名验证
		// 服务端会校验时间戳参数 timestamp，请求时间在服务器时间±5s 内请求有效
		Pair<String, Object> timestampPair = new ImmutablePair<String, Object>("_t", System.currentTimeMillis());
		Pair<String, Object> userPair = new ImmutablePair<String, Object>("_user", USER_NAME);
		requestParams.add(timestampPair);
		requestParams.add(userPair);

		// 计算签名
		String signStr = sign(requestParams);

		// 别忘了签名也是参数的一部分
		Pair<String, Object> signPair = new ImmutablePair<String, Object>("_sign", signStr);
		requestParams.add(signPair);

		URI uri = new URIBuilder(new URI(url)).build();

		// 接口接收post方式的json对象，而不是form表单。所以需要把请求参数转换成json对象
		String json = buildRequestObjectJson(requestParams);
		StringEntity stringEntity = new StringEntity(json, ContentType.APPLICATION_JSON);

		ClassicHttpRequest httpPost = ClassicRequestBuilder.post().setUri(uri).build();
		httpPost.setEntity(stringEntity);

		// 这里只能是 application/json，请勿添加其他信息，例如：application/json;charset=UTF-8
		httpPost.setHeader(HttpHeaders.CONTENT_TYPE, "application/json");
		CloseableHttpClient httpclient = HttpClients.createDefault();

		return httpclient.execute(httpPost, response -> {
			System.out.println(response.getCode() + " " + response.getReasonPhrase());
			return EntityUtils.toString(response.getEntity());
		});
	}

	// 查询已绑定应用列表
	public static void main(String[] args) {

		Asserts.check(!USER_NAME.isBlank(), "请填写变现账号");
		Asserts.check(!SECRET_Key.isBlank(), "请填写Sigmob Secret Key");

		List<Pair<String, Object>> params = new ArrayList<Pair<String, Object>>();
		Pair<String, Object> channelPair = new ImmutablePair<String, Object>("app_id", 0);
		Pair<String, Object> page = new ImmutablePair<String, Object>("page", "1,10");
		params.add(channelPair);
		params.add(page);

		try {
			System.out.println(doRequest("https://mmapi.sigmob.com/srv/open/api/union_mediation/app/list", params));
		} catch (NoSuchAlgorithmException | IOException | URISyntaxException e) {

			e.printStackTrace();
		}
	}
}

1. 接口请求说明V2

1.1 请求说明

请求以http post方式发出，参数以 application/json 形式出现，内容为所有参数组成的json字符串。
同时需要将body的内容，追加 Sigmob Secret Key 之后拼接的字符串做sha1((160bit))处理，生成签名，并将签名字符串放入http header中，随请求参数一起发送给服务端。
具体处理过程可以参见下方Demo示例(提供Python签名示例及Java请求示例)

1.2 请求域名

https://mmapi.sigmob.com

1.3请求头

字段	值	说明
Content-Type	application/json	这里只能是application/json，请勿添加其他信息，例如：application/json;charset=UTF-8
X-Open-Signature	请求body加Secret Key之后形成的字符串的sha1摘要信息	例如：957b42285342390188d1351126b775514cc5d463

1.4 公共请求参数

所有请求都必须要带上这些字段，用以确认该用户是否有权限请求对应接口

key	type	required	comment	value
_user	String	Y	平台的账户	abc@163.com
_t	Interge	Y	13 位时间戳，服务端会校验时间戳参数_t，请求时间在服务器时间±3s 内请求有效	1582271847180

1.5 公共响应参数

key	type	required	comment
code	String	Y	返回码
msg	String	Y	返回信息：若有错误，此字段展示详细错误信息
data	Object	Y	接口返回数据, 列表接口{"content":[],"page":[1,12,23,12,1]},增加和修改接口返回
type	String	N	type为"waring",表示请求成功，但并未像预期结果一样(比如瀑布流广告源开启数据量为30，调用API开启广告源数据量超过30会将广告源自动关闭)

2. Demo示例

2.1 Python 请求示例

python

import json
import time
import requests
import random
from unittest import TestCase
from attrdict import AttrDict
from hashlib import sha1

headers = {"Content-Type": "application/json"}
username = '您的账户名'
secret = '您的Sigmob Secret Key'
host = "https://mmapi.sigmob.com"


class TestApi(TestCase):
    def setUp(self) -> None:
        self.secret = secret
        self.user = username

    def header_signature(self, body):
        s = body + self.secret
        return sha1(s.encode()).hexdigest()

    def assemble_base(self):
        _t = int(time.time() * 1000)
        params = AttrDict(
            _user=self.user,
            _t=_t
        )
        return params

    def test_create(self):
        request_data = {"pub_code": "您的聚合广告位", "name": "测试新34建分组", "preset": 0,
                        "rules": [{"type": 13, "rule": 1, "content": [{"key": "232", "rule": 1, "content": "1312"}]}]}
        url = '/srv/open/api/union_mediation/group/create'
        request_data.update(self.assemble_base())
        json_data = json.dumps(request_data)
        headers.update({"X-Open-Signature": self.header_signature(json_data)})
        r = requests.post(host + url, headers=headers, data=json_data)
        assert r.status_code == 200
        print(r.json())


if __name__ == '__main__':
    test_obj = TestApi()
    test_obj.test_create()

2.2 Java 请求示例

xml

<!--相关maven依赖-->
<dependencies>
	<dependency>
		<groupId>commons-codec</groupId> <!--apache commons codec-->
		<artifactId>commons-codec</artifactId>
		<version>1.15</version>
	</dependency>
	<dependency>
		<groupId>org.apache.httpcomponents.client5</groupId>
		<artifactId>httpclient5</artifactId>
		<version>5.2.1</version>
	</dependency>
	<dependency>
		<groupId>org.apache.commons</groupId>
		<artifactId>commons-lang3</artifactId>
		<version>3.12.0</version>
	</dependency>
	<dependency>
		<groupId>com.fasterxml.jackson.core</groupId>
		<artifactId>jackson-databind</artifactId>
		<version>2.15.2</version>
	</dependency>
</dependencies>

java

package com.tobid.openapi;

import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.HashMap;
import java.util.Map;

import org.apache.commons.codec.binary.Hex;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClients;
import org.apache.hc.core5.http.ClassicHttpRequest;
import org.apache.hc.core5.http.ContentType;
import org.apache.hc.core5.http.HttpHeaders;
import org.apache.hc.core5.http.io.entity.EntityUtils;
import org.apache.hc.core5.http.io.entity.StringEntity;
import org.apache.hc.core5.http.io.support.ClassicRequestBuilder;
import org.apache.hc.core5.net.URIBuilder;

import com.fasterxml.jackson.databind.ObjectMapper;

public class DemoV2 {

	/**
	 * 变现账户名
	 */
	private static final String USER_NAME = "";
	/**
	 * Sigmob Secret Key，从平台账户管理->Keys功能页获取。<br/>
	 * 注意，这里要使用Sigmob Secret Key，而不是ToBid Secret Key
	 */
	private static final String SECRET_KEY = "";
	
	private static final String HEADER_NAME_SIGNATURE = "X-Open-Signature";

	private static class SourceAuthContent {
		private String placementId;

		public String getPlacementId() {
			return placementId;
		}

		public void setPlacementId(String placementId) {
			this.placementId = placementId;
		}
	}

	/**
	 * 签名使用 SHA-1(160bit)算法生成<br/>
	 * 
	 * @param plainText
	 * @return
	 * @throws NoSuchAlgorithmException
	 */
	private static String sha1(String plainText) throws NoSuchAlgorithmException {
		MessageDigest messageDigest = MessageDigest.getInstance("SHA");
		byte[] cipherBytes = messageDigest.digest(plainText.getBytes());
		String cipherStr = Hex.encodeHexString(cipherBytes);
		return cipherStr;
	}

	public static String doRequest(String url, Map<String, Object> requestMap)
			throws IOException, URISyntaxException, NoSuchAlgorithmException {

		// 接口接收post方式的json数据，而不是form表单。所以需要把请求参数转换成json对象
		ObjectMapper om = new ObjectMapper();
		String json = om.writeValueAsString(requestMap);
		
		// 计算签名.签名由body加Sigmob Secret Key组成
		String plainTxt = json+SECRET_KEY;
		String signStr = sha1(plainTxt);

		URI uri = new URIBuilder(new URI(url)).build();

		StringEntity stringEntity = new StringEntity(json, ContentType.APPLICATION_JSON);

		ClassicHttpRequest httpPost = ClassicRequestBuilder.post().setUri(uri).build();
		httpPost.setEntity(stringEntity);

		// 这里只能是 application/json，请勿添加其他信息，例如：application/json;charset=UTF-8
		httpPost.setHeader(HttpHeaders.CONTENT_TYPE, "application/json");
		// 增加签名http header
		httpPost.setHeader(HEADER_NAME_SIGNATURE, signStr);
		CloseableHttpClient httpclient = HttpClients.createDefault();

		return httpclient.execute(httpPost, response -> {
			System.out.println(response.getCode() + " " + response.getReasonPhrase());
			return EntityUtils.toString(response.getEntity());
		});
	}

	public static void main(String[] args) {

		Asserts.check(!USER_NAME.isBlank(), "请填写变现账号");
		Asserts.check(!SECRET_Key.isBlank(), "请填写Sigmob Secret Key");

		SourceAuthContent sac = new SourceAuthContent();
		sac.setPlacementId("广告源名称");
		
		Map<String, Object> requestMap = new HashMap<String,Object>();
		requestMap.put("name", "测试广告源！");
		requestMap.put("pub_code", "你的聚合广告位");
		requestMap.put("media_network_id", 广告网络id);
		requestMap.put("source_auth_content", sac);
		
		// 除了业务需要的请求参数外，需要追加时间戳_t参数以及_user参数用于签名验证
		// 服务端会校验时间戳参数 timestamp，请求时间在±5秒内有效
		requestMap.put("_user", USER_NAME);
		requestMap.put("_t", System.currentTimeMillis());
		
		//创建广告源
		String createGroupUrl = "http://shadowd.sigmob.com/srv/open/api/union_mediation/ad_source/create";
		try {
			System.out.println(doRequest(createGroupUrl, requestMap));
		} catch (NoSuchAlgorithmException | IOException | URISyntaxException e) {
			e.printStackTrace();
		}
	}
}

2.3 Shell请求示例

Shell

curl --request POST --url https://mmapi.sigmob.com/srv/open/api/union_mediation/placement/update --header 'X-Open-Signature: 你的签名字符串' --header 'content-type:application/json' \
--data '{"pub_code": "12312311222", "name": "\u6d4b\u8bd5\u4fee\u65391\u2014\u20141", "enabled": 0, "_user": "123@sigmob.com", "_t": 1668695460842}'

3. 聚合管理接口

聚合管理接口包含了主要的聚合管理功能，是本API的核心模块。

3.1 广告网络账号管理

3.1.1 查询广告网络账号列表

Request

Url:/srv/open/api/union_mediation/ad_network/list
Method:POST
Content-Type:application/json
Body:

key	type	required	comment	value
channel_id	Int	N	广告网络id，具体值参考广告网络枚举	9
page	String	N	页码(每页最多 100 条)	1,100

Response

key	type	required	comment	value
id	Int	Y	ToBid 体系中标识广告网络账号的id	1
name	String	Y	广告网络账号名称	Sigmob
channel_id	Int	Y	广告网络id，具体值广告网络枚举	9
currency	Int	Y	币种 1:人民币（默认） 2:美元	1
reportapi_status	Int	Y	是否开通Report API，枚举值说明： 0: 不开通 1: 开通	1
auth_content	Object	Y	广告网络账号参数，具体值参考广告网络参数样例枚举

请求样例

Json

{
  "page":"1,1",
  "channel_id":1,
  "_user":"123@sigmob.com",
  "_t":1668493535670
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "type": null,
  "data": {
    "content": [{
      "channel_id": 9,
      "name": "广告网络测试名称",
      "id": 1,
      "currency": 1,
      "reportapi_status": 1,
      "auth_content": {
        "apiKey": "123asdasd",
        "repApiKey": "1234",
        "repApiSecret": "123"
      }
    }],
    "page": [20, 1, 20, 1, 1]
  }
}

3.1.2 新建广告网络账号

Request

URL:/srv/open/api/union_mediation/ad_network/create
Method:POST
Content-Type:application/json
Body:

key	type	required	comment	value
name	String	Y	广告网络账号名称(长度限制30个字符)	测试广告网络账号
channel_id	Int	Y	广告网络id，具体值参考广告网络枚举	9
reportapi_status	Int	Y	是否开通Report API，枚举值说明： 0: 不开通 1: 开通	1
auth_content	Object	Y	广告平台 Publisher 维度参数，注意：无论是否开通报表，有些广告平台相关参数都是必传的。具体值参考广告网络账号参数	{"appId":"123123"}，若该广告网络没有账号维度参数，则传 {}
currency	Int	N	币种 1:人民币（默认） 2:美元；仅穿山甲、Gromore渠道支持传入。不传默认人民币	1

Response

接口响应参考公共响应参数

请求样例

JSON

{
  "name":"mtg_测试新建_927",
  "channel_id":1,
  "reportapi_status":0,
  "auth_content":{
      "apiKey":"887",
      "repApiSecret":"5"
  },
  "_user":"123@sigmob.com",
  "_t":1668681345811
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "data": {
    "id": 12 //ToBid 体系中标识广告网络账号的id
  }
}

3.1.3 编辑广告网络账号

Request

URL:/srv/open/api/union_mediation/ad_network/update
Method:POST
Content-Type:application/json
Body:

key	type	required	comment	value
id	Int	Y	ToBid 体系中标识广告网络账号的id	12
name	String	Y	广告网络账号名称(长度限制30个字符)	测试广告网络账号
reportapi_status	Int	Y	是否开通Report API，枚举值说明： 0: 不开通 1: 开通	1
auth_content	Object	Y	广告平台 Publisher 维度参数，注意：无论是否开通报表，有些广告平台相关参数都是必传的。具体值参考广告网络账号参数	{"appId":"123123"}，若该广告网络没有账号维度参数，则传 {}

Response

接口响应参考公共响应参数

请求样例

JSON

{
  "id":283,
  "name":"mtg_测试更新_708",
  "channel_id":1,
  "reportapi_status":0,
  "auth_content":{
      "apiKey":"更新883",
      "repApiSecret":"更新252"
  },
  "_user":"123@sigmob.com",
  "_t":1668682831272
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "data": {
    "id": 12 //ToBid 体系中标识广告网络账号的id
  }
}

3.2 应用管理

将平台创建的应用绑定至 ToBid 聚合服务。由于ToBid沿用Sigmob应用体系，因此要使用Open api创建应用，请联系对应商务开通。

3.2.1 查询已绑定应用列表

Request

URL:/srv/open/api/union_mediation/app/list
Method:POST
Content-Type:application/json
Body:

key	type	required	comment	value
app_id	Integer	N	添加到聚合的应用ID	3123
platform	Integer	N	操作系统 1:iOS 2:android 4:harmony	1
page	String	N	页码(每页最多 100 条) 1,100	1,100

Response

key	type	required	comment
id	Interge	Y	添加到聚合的应用ID
name	String	Y	app 名称
platform	Interge	Y	操作系统 1:iOS,2:android,4:harmony
icon	String	Y	图标

请求样例

json

{
  "page":"1,1",
  "app_id":12222,
  "platform":1,
  "_user":"123@sigmob.com",
  "_t":1668684023937
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "data": {
    "content": [{
      "id": 3123,
      "platform": 1,
      "icon": "https:100x100bb.jpg",
      "name": "测试应用"
    }],
    "page": [366, 1, 37, 10, 1]
  }
}

3.2.2 将应用绑定到 ToBid 聚合

Request

URL:/srv/open/api/union_mediation/app/bind
Method:POST
Content-Type:application/json
Body:

key	type	required	comment	value
app_id	Integer	Y	添加到聚合的应用ID	1234

Response 接口响应参考公共响应参数

请求样例

JSON

{
  "app_id":3299,
  "_user":"123@sigmob.com",
  "_t":1668684584838
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "data": {
    "id":3299
  }
}

3.3 管理应用聚合配置

查询、新建、编辑 ToBid Appid 和第三方广告网络账号及对应的Appid 的绑定关系。

3.3.1 查询应用聚合配置

Request

URL:/srv/open/api/union_mediation/media_app/list
Method:POST
Content-Type:application/json
Body:

key	type	required	comment	value
app_id	Integer	Y	应用ID	3123
channel_id	Integer	N	广告网络id	9
page	String	N	页码(每页最多 100 条) 1,100	1,100

Response

key	type	required	comment
id	Integer	Y	ToBid Appid与广告网络账号的关联id
app_id	Integer	Y	ToBid Appid
ad_network_id	Integer	Y	广告网络账号id
app_auth_content	Object	Y	第三方广告网络账号的Appid 维度的参数，详见广告网络参数枚举
channel_id	Integer	Y	广告网络id
channel_name	String	Y	广告网络名称

请求样例

JSON

{
  "app_id":2280,
  "channel_id":1,
  "_user":"123@sigmob.com",
  "_t":1668684780693
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "data": {
    "content": [{
      "app_id": 3123,
      "id": 1661,
      "ad_network_id": 120,
      "channel_id": 1,
      "channel_name": "Mintegral",
      "app_auth_content": {
        "appId": "1231231231278"
      }
    }],
    "page": [1, 1, 1, 100, 1]
  }
}

3.3.2 新建应用聚合配置

Request

URL:/srv/open/api/union_mediation/media_app/create
Method:POST
Content-Type:application/json
Body:

key	type	required	comment	value
app_id	Integer	Y	ToBid 的Appid	3123
ad_network_id	Integer	Y	广告网络账号ID	120
app_auth_content	Obeject	Y	第三方广告网络账号的Appid 维度的参数，详见广告网络参数枚举	`{"appId": "1231231231278"}`

Response

key	type	required	comment
id	Interge	Y	ToBid Appid与广告网络账号的关联id

请求样例

json

{
  "app_id":3302,
  "ad_network_id":222,
  "app_auth_content":{
    "appId":"test"
  },
  "_user":"123@sigmob.com",
  "_t":1668685229627
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "data": {
    "id": 123 // ToBid Appid与广告网络账号的关联id
  }
}

3.3.3 更新应用聚合配置

Request

URL:/srv/open/api/union_mediation/media_app/update
Method:POST
Content-Type:application/json
Body:

key	type	required	comment	value
id	Integer	Y	ToBid Appid与广告网络账号的关联id	123123
app_auth_content	Obeject	Y	第三方广告网络账号的Appid 维度的参数，详见广告网络参数枚举	`{"appId": "1231231231278"}`

Response

接口响应参考公共响应参数

请求样例

JSON

{
  "id":1738,
  "app_auth_content":{
    "appId":"test_update"
  },
  "_user":"123@sigmob.com",
  "_t":1668685387521
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "data": {
    "id": 123
  }
}

3.4 广告位管理

查询、新建、编辑指定应用的聚合广告位。

3.4.1 查询广告位列表

Request

URL:/srv/open/api/union_mediation/placement/list
Method:POST
Content-Type:application/json
Body:

key	type	required	comment	value
app_id	Integer	Y	应用ID	3123
ad_type	Integer	N	广告位类型	1
pub_code	String	N	聚合广告位code	213123123124342
page	String	N	页码(每页最多 100 条) 1,100	1,100

Response

key	type	required	comment
id	Interger	Y	聚合广告位自增id
app_id	Interger	Y	app id
name	String	Y	广告位名称
pub_code	String	Y	聚合广告位pub_code
enabled	Interger	Y	聚合广告位是否启用. 0：关闭，1：开启
reward_setting	Int	N	激励服务端回调。枚举值说明：0: 关闭 1: 开启
reward_sum	Int	N	奖励数量，reward_setting=1时必填。
reward_name	String	N	奖励名称，reward_setting=1时必填。
reward_url	String	N	服务端回调url，reward_setting=1时必填。具体值参考服务端验证回传参数说明
reward_key	String	N	reward_setting = 1时返回，代表security key。

请求样例

JSON

{
  "page":"1,2",
  "app_id":2280,
  "_user":"123@sigmob.com",
  "_t":1668686050469
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "type": null,
  "data": {
    "content": [{
      "enabled": 1,
      "pub_code": "6924557774853221",
      "name": "qe12312",
      "id": 457,
      "app_id": 2280
    }, {
      "enabled": 0,
      "pub_code": "7258926842389361",
      "name": "ghfhf",
      "id": 456,
      "app_id": 2280
    }],
    "page": [13, 1, 7, 2, 1]
  }
}

3.4.2 新建广告位

Request

URL:/srv/open/api/union_mediation/placement/create
Method:POST
Content-Type:application/json
Body:

key	type	required	comment	value
name	String	Y	广告位名称(长度限制30个字符)	激励视频
app_id	Integer	Y	应用ID	1234
ad_type	Integer	Y	广告位类型，激励：1，开屏：2，插屏：4，原生：5，横幅：7	3
reward_setting	Int	N	激励服务端回调。枚举值说明：0: 关闭 1: 开启	0
reward_sum	Int	N	奖励数量，reward_setting=1时必填。	1
reward_name	String	N	奖励名称，reward_setting=1时必填。	复活
reward_url	String	N	服务端回调url，reward_setting=1时必填。具体值参考服务端验证回传参数说明

reward_setting = 1时，返回参数含reward_key，代表security key。

Response

接口响应参考公共响应参数

请求样例

JSON

{
  "app_id":2280,
  "ad_type":5,
  "name":"测试新建1_1_1",
  "_user":"123@sigmob.com",
  "_t":1668687052432
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "type": null,
  "data": {
    "id": 472, //聚合广告位自增id
    "pub_code": "6856974695593541"
  }
}

3.4.3 编辑广告位

Request

URL:/srv/open/api/union_mediation/placement/update
Method:POST
Content-Type:application/json
Body:

key	type	required	comment	value
pub_code	String	Y	聚合广告位code	12312312321312
name	String	Y	广告位名称(长度限制30个字符)	12
enabled	Integer	Y	是否启用: 0 未启用 1 启用	0/1
reward_setting	Int	N	激励服务端回调。枚举值说明：0: 关闭 1: 开启。不传不更改。	0
reward_sum	Int	N	奖励数量，reward_setting=1时必填。	1
reward_name	String	N	奖励名称，reward_setting=1时必填。	复活
reward_url	String	N	服务端回调url，reward_setting=1时必填。具体值参考服务端验证回传参数说明

Response

接口响应参考公共响应参数

请求样例

JSON

{
  "pub_code":"12312311222",
  "name":"测试修改1——1",
  "enabled":0,
  "_user":"123@sigmob.com",
  "_t":1668695460842
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "type": null,
  "data": {
    "id": 471,
    "pub_code": "5594586337477361"
  }
}

3.4.4 删除广告位

Request

URL:/srv/open/api/union_mediation/placement/delete
Method:POST
Content-Type:application/json
Body:

key	type	required	comment	value
pub_code	String	Y	聚合广告位code	12312312321312

Response

接口响应参考公共响应参数

请求样例

JSON

{
  "pub_code":"12312311222"
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "type": null
}

3.5 分组管理

用于指定聚合广告位查询、编辑、新建流量分组。

3.5.1 查询分组列表

Request

URL:/srv/open/api/union_mediation/group/list
Method: POST
Content-Type: application/json
Body:

key	type	required	comment	value
pub_code	String	Y	聚合广告位code	12312312321312
id	Integer	N	流量分组id	12

Response

key	type	required	comment	value
id	Integer	Y	分组id	12
pub_code	String	Y	聚合广告位code	12312312321312
name	String	Y	流量分组名字(长度限制30个字符)	测试流量分组
is_default	Integer	Y	是否是默认分组,枚举值说明 0:不是 1:是	1
order	Integer	Y	流量分组优先级	2
ab_test_status	Integer	Y	是否开启ab测试标志 0:未开启 1开启	1
enabled	Integer	Y	流量分组是否启用 0:禁用 1:启用	1
group_config	Array[Object]	Y	流量分组瀑布流属性设置，如果分组开启AB实验则数组长度为2(group_config.status=1,group_config.status=2), 如未开启AB测试只有一条(group_config.status=0)	参考返回样例
group_config.status	Integer	Y	AB 实验中所属分组，枚举值说明 0:默认分组 1:A组 2:B组	参考返回样例
group_config.waterfall_total_request_timeout	string	Y	瀑布流总请求超时时长(秒）。可参考不同广告位类型瀑布流属性	参考返回样例
group_config.request_mode	Integer	Y	瀑布流请求模式 0：固定数量并行请求 1：固定数量并行补位请求 2：相同价格并行请求	参考返回样例
group_config.bid_reserve_price	Integer	Y	应用内竞价底价(¥，单位为分)	参考返回样例
group_config.single_parallel_request_timeout	String	Y	单次并行请求超时时长(秒)。可参考不同广告位类型瀑布流属性	参考返回样例
group_config.parallel_req_count	Integer	Y	并行请求数。可参考不同广告位类型瀑布流属性	参考返回样例
group_config.open_screen_timeout	Integer	Y	开屏加载超时时长。可参考不同广告位类型瀑布流属性	参考返回样例
group_config. auto_refresh_interval	Integer	Y	横幅广告自动刷新间隔。可参考不同广告位类型瀑布流属性	参考返回样例
group_config.bidding_timeout	Integer	Y	竞价超时时长，单位秒
group_config.client_sort_switch	Integer	Y	竞价加速器开关 0:关 1:开
group_config.strategy_cache_switch	Integer	Y	客户端策略缓存开关 0:关 1:开
group_config.strategy_cache_time	Integer	Y	策略缓存时长单位小时
group_config.enable_concurrency	Integer	Y	应用内竞价与普通广告源并行请求开关 0:关1:开
group_config.max_concurrent_count	Integer	Y	补位阶段最大并行数
group_config.auto_load_ad	Integer	Y	自动加载广告设置
group_config.fill_type	Integer	Y	瀑布流填充回调模式 0：速度优先 1:价值优先
group_config.rate	Integer	Y	AB 实验中AB组的流量占比	参考返回样例
rules	Array[Object]	Y	流量分组的规则。参考流量分组规则说明	参考返回样例
rules.rule	Integer	Y	规则类型，参考流量分组规则说明	参考返回样例
rules.type	Integer	Y	规则逻辑，参考流量分组规则说明	参考返回样例
rules.content	Object		规则内容，参考流量分组规则说明	参考返回样例

请求样例

JSON

{
  "pub_code":"1232131212",
  "id":945,
  "_user":"123@sigmob.com",
  "_t":1668697520983
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "type": null,
  "data": {
    "content": [
      {
        "is_default": 0,
        "order": 2,
        "ab_test_status": 0,
        "placement_id": 470,
        "name": "测试新建分组",
        "enabled": 1,
        "is_delete": 0,
        "id": 983,
        "group_config": [
          {
            "open_screen_timeout": 0,
            "status": 0,
            "parallel_req_count": 3,
            "rate": 100,
            "single_parallel_request_timeout": 3,
            "bid_reserve_price": 0.0,
            "request_mode": 0,
            "auto_refresh_interval": -1,
            "waterfall_total_request_timeout": 45,
            "group_attr_id": 1458
          }
        ],
        "rules": [
          {
            "content": [
              "设备ID",
              "设备ID1"
            ],
            "rule": 1,
            "type": 3
          },
          {
            "content": [
              "应用版本",
              "应用版本2"
            ],
            "rule": 1,
            "type": 1
          },
          {
            "content": [
              "SDK版本",
              "SDK版本1"
            ],
            "rule": 0,
            "type": 2
          },
          {
            "content": [
              100,
              5,
              3,
              4,
              2
            ],
            "rule": 1,
            "type": 7
          },
          {
            "content": [
              "user_id",
              "user_id1"
            ],
            "rule": 1,
            "type": 5
          },
          {
            "content": {
              "type": 2,
              "content": [
                "1156140100",
                "1156140200",
                "1156140300",
                "1156140400",
                "1156140500",
                "1156140600",
                "1156140700",
                "1156140800",
                "1156140900",
                "1156141000",
                "1156141100"
              ]
            },
            "rule": 1,
            "type": 8
          },
          {
            "content": [
              "渠道",
              "渠道1"
            ],
            "rule": 1,
            "type": 10
          },
          {
            "content": [
              "子渠道",
              "子渠道1"
            ],
            "rule": 1,
            "type": 11
          },
          {
            "content": "1",
            "rule": 9,
            "type": 4
          },
          {
            "content": [
              2,
              1
            ],
            "rule": 1,
            "type": 6
          },
          {
            "content": 175,
            "rule": 1,
            "type": 9
          },
          {
            "content": [
              {
                "key": "自定义规则",
                "rule": 1,
                "content": "12323"
              },
              {
                "key": "432",
                "rule": 0,
                "content": "32423"
              }
            ],
            "rule": 1,
            "type": 13
          }
        ]
      },
      {
        "is_default": 1,
        "order": 1,
        "ab_test_status": 0,
        "placement_id": 470,
        "name": "默认分组",
        "enabled": 1,
        "is_delete": 0,
        "id": 975,
        "group_config": [
          {
            "open_screen_timeout": 0,
            "status": 0,
            "parallel_req_count": 3,
            "rate": 100,
            "single_parallel_request_timeout": 3,
            "bid_reserve_price": 0.0,
            "request_mode": 0,
            "auto_refresh_interval": -1,
            "waterfall_total_request_timeout": 45,
            "group_attr_id": 1450
          }
        ],
        "rules": null
      }
    ],
    "page": [2, 1, 1, 1, 1]
  }
}

3.5.2 新建分组

Request

URL:/srv/open/api/union_mediation/group/create
Method: POST
Content-Type: application/json
Body:

key	type	required	comment	value
name	string	Y	分组名称(长度限制30个字符)	测试流量分组
pub_code	String	Y	聚合广告位code	12312312321312
rules	Array[Object]	Y	流量分组规则	参考流量分组规则说明
rules.type	int	Y	规则类型	参考流量分组规则说明
rules.rule	int	Y	规则逻辑	参考流量分组规则说明
rules.content	Object	Y	规则内容	参考流量分组规则说明

Response

字段	类型	是否必传	备注
id	int	Y	流量分组ID

请求样例

JSON

{
  "placement_id":279,
  "name":"测试新建分组",
  "rules":[
    {
      "type":1,
      "rule":1,
      "content":[
        "1",
        "2"
      ]
    }
  ],
  "_user":"123@sigmob.com",
  "_t":1668700406099
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "data": {
    "id": 123
  }
}

3.5.3 编辑分组

Request

URL: /srv/open/api/union_mediation/group/update
Method: POST
Content-Type: application/json
Body:

key	type	required	comment	value
name	string	Y	分组名称(长度限制30个字符)	测试流量分组
id	int	Y	分组id	221
rules	Array[Object]	Y	流量分组规则	参考流量分组规则说明
rules.type	int	Y	规则类型	参考流量分组规则说明
rules.rule	int	Y	规则逻辑	参考流量分组规则说明
rules.content	Object	Y	规则内容	参考流量分组规则说明
enabled	Integer	Y	是否启用 0：未启用，1：启用	0/1

Response

字段	类型	是否必传	备注
id	int	Y	流量分组ID

请求样例

JSON

{
  "id":976,
  "placement_id":279,
  "rules":[
    {
      "type":1,
      "rule":1,
      "content":"2"
    }
  ],
  "enabled":0,
  "name":"测试修改",
  "_user":"123@sigmob.com",
  "_t":1668701343435
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "data": {
    "id":123
  }
}

3.6 广告源管理

在聚合广告位下查询、新建、编辑第三方的代码位。

3.6.1 广告源列表

Request

URL: /srv/open/api/union_mediation/ad_source/list
Method: POST
Content-Type: application/json
Body:

key	type	required	comment	value
pub_code	String	Y	聚合广告位code	12312312321312
channel_id	Integer	N	广告平台id	9
id	Integer	N	广告源id	12
page	String	N	页码(每页最多 100 条) 1,100	1,100

Response

key	type	required	comment	value
pub_code	String	Y	聚合广告位code	12312312321312
name	String	Y	广告源名称(长度限制30个字符)	Sigmob_rv_1000
aggr_adtype	Integer	Y	广告源广告类型:激励：1，开屏：2，插屏：4，原生：5，横幅：7
render_type	Integer	Y	使用原生广告渲染，不传默认0。1：使用，0：不使用。仅插屏、开屏、banner广告类型的部分广告网络支持。
header_bidding_switch	Integer	Y	是否是应用内竞价广告源。 0：不是，1：是。支持应用内竞价的广告网络列表查看广告网络枚举	0/1
bidding_method	Integer	Y	应用内竞价模式。 0/1	0/1
id	Integer	Y	ToBid 体系内第三方广告源的自增id
channel_id	Integer	Y	广告网络渠道id	具体值广告网络枚举
source_auth_content	Obejct	Y	第三方广告源的信息	具体值广告网络参数样例枚举
timed_enable_switch	Integer	N	定时生效设置 0：关 1：开	0/1

请求样例

JSON

{
  "page":"1,1",
  "placement_id":279,
  "channel_id":21,
  "id":55448,
  "_user":"123@sigmob.com",
  "_t":1668702346405
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "type": null,
  "data": {
    "content": [{
      "placement_id": 279,
      "name": "65464565",
      "aggr_adtype": 1,
      "render_type": 0,
      "header_bidding_switch": 0,
      "bidding_method": 0,
      "is_delete": 0,
      "id": 55448,
      "channel_id": 21,
      "source_auth_content": {
              "placementId": "65464565"
      }
    }, {
      "placement_id": 279,
      "name": "32432",
      "aggr_adtype": 1,
      "render_type": 0,
      "header_bidding_switch": 1,
      "bidding_method": 1,
      "is_delete": 0,
      "id": 55439,
      "channel_id": 21,
      "source_auth_content": {
              "placementId": "2342"
      }
    }],
    "page": [2, 1, 1, 2, 1]
  }
}

3.6.2 创建广告源

广告源创建后，在流量分组中均为关闭状态。通过调用修改瀑布waterfall属性 enabled 将其在对应分组下启用

Request

URL: /srv/open/api/union_mediation/ad_source/create
Method: POST
Content-Type: application/json
Body:

key	type	required	comment	value
name	String	Y	广告源名称，除sigmob、ToBid ADX渠道外必填(长度限制100个字符)	测试rv_500
pub_code	String	Y	聚合广告位 code	"12312312321312"
aggr_adtype	Integer	N	不传默认同聚合广告位类型，广告源广告类型:激励：1，开屏：2，插屏：4，原生：5，横幅：7
media_network_id	Integer	Y	ToBid Appid与广告网络账号的关联id。即新建应用聚合配置Reponse 中的id	3
render_type	Integer	N	使用原生广告渲染，不传默认0。1：使用，0：不使用
header_bidding_switch	Integer	N	是否是应用内竞价广告源。 0:不是，1:是。创建成功后不可编辑注意:Sigmob、ToBid ADX渠道无需填写	0/1
bidding_method	Integer	N	应用内竞价模式枚举值: 0:服务端竞价 1:客户端竞价，当广告网络同时支持两种竞价方式且 header_bidding_switch=1 时必填。广告网络是否支持应用内竞价，参考广告网络枚举	0/1
source_auth_content	Object	Y	第三方广告源的信息,详见广告网络参数枚举
price	Integer	N	瀑布流中的排序价格，单位分。应用内竞价广告源无须填写	1000
bid_reserve_price	Integer	N	应用内竞价底价设置，单位分。普通广告源无需填写取值范围（0<=bid_reserve_price<=2000000）	1000
reward_callback_time	Integer	N	在激励聚合广告位下使用广告类型优选时必传。激励回调时机。1:广告关闭时回调激励，2:广告点击时回调激励，不传默认为1
reward_guide_prompt	string	N	激励引导文案。仅在激励视频广告位下混出原生转插屏广告时生效。ToBid 可根据开发者配置的引导文案，在广告视图中渲染引导提示，明确告知用户完成激励任务即可获取对应奖励。该功能需依赖 ToBid Android v4.6.9 及以上版本。不传默认为空
timed_enable_switch	Integer	N	定时生效设置 0：关 1：开，仅csj、gromore、快手、优量汇、百度此参数有效	0/1
auto_price	Integer	N	自动价格。0：关闭 1：开启，默认关闭
auto_price_cal_period	Integer	N	计算周期。1-7之间的整数，默认7

Response

接口响应参考公共响应参数

请求样例

JSON

{
  "placement_id":278,
  "name":"测试新建广告源323",
  "price":122,
  "media_network_id":1723,
  "source_auth_content":{
      "subType":"0",
      "placementId":"21311232",
      "templateType":"0"
  },
  "_user":"123@sigmob.com",
  "_t":1668704866279
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "data":{"id":123,"source_auth_content":{}}
}

3.6.3 编辑广告源

Request

URL: /srv/open/api/union_mediation/ad_source/update
Method: POST
Content-Type: application/json
Body:

key	type	required	comment	value
name	String	Y	广告位名称(长度限制100个字符)	12
id	Integer	Y	ToBid 体系内的广告源自增id，即查询广告源列表返回的id	1231
source_auth_content	Object	Y	第三方广告源的信息,详见广告网络参数枚举
timed_enable_switch	Integer	N	定时生效设置 0：关 1：开，仅csj、gromore、快手、优量汇、百度此参数有效	0/1

Response

接口响应参考公共响应参数

样例

请求样例

JSON

{
  "id":55453,
  "name":"测试修改广告源323",
  "source_auth_content":{
    "subType":"1",
    "placementId":"21311232",
    "templateType":"0"
  },
  "_user":"123@sigmob.com",
  "_t":1668705369422
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "data": {
    "id":123,
    "source_auth_content":{}
  }
}

3.6.4 删除广告源

Request

URL: /srv/open/api/union_mediation/ad_source/delete
Method: POST
Content-Type: application/json
Body:

key	type	required	comment	value
id	Integer	Y	广告源id	12

请求样例

JSON

{
  "id": 1,
  "_user": "123@sigmob.com",
  "_t":  1668706564419
}

3.6.5 新建三方代码位和ToBid广告源

支持开发者同时创建三方代码位和ToBid广告源。使用该功能请联系ToBid运营获取文档并开通权限。

3.7 瀑布流属性管理

用户请求流量进入某个流量分组后，ToBid 会下发对应流量分组的广告瀑布流。此接口是编辑 ToBid SDK 加载的瀑布流的一些基础属性，例如并行加载数、最大请求时长等信息。

3.7.1 瀑布流属性编辑

Request

URL: /srv/open/api/union_mediation/waterfall_attr/update
Method: POST
Content-Type: application/json
Body:

key	type	required	comment	value
group_id	Integer	Y	流量分组ID，即查询分组列表接口返回的 id	12
status	Integer	Y	AB实验所属分组。枚举值说明 0:默认分组，无AB实验则传入此值 1:A组 2:B组	0/1/2
request_mode	Integer	N	瀑布流请求模式 0:固定数量并行请求 1:固定数量并行补位请求 2:相同价格并行请求可参考不同广告位类型瀑布流属性注意：如果request_mode 为2，则parallel_req_count固定为5	0
parallel_req_count	Integer	N	并行请求组最大并行数。取值范围可参考不同广告位类型瀑布流属性注意：request_mode 为2时可不传
open_screen_timeout	Integer	N	开屏请求超时时间。取值可参考不同广告位类型瀑布流属性
single_parallel_request_timeout	Float	N	单次并行请求超时时长。取值可参考不同广告位类型瀑布流属性，最多一位小数。
waterfall_total_request_timeout	Float	N	瀑布流总请求超时时长。取值可参考不同广告位类型瀑布流属性，最多一位小数。仅激励，插屏，原生，横幅，支持该参数
auto_refresh_interval	Float	N	横幅广告自动刷新间隔。取值可参考不同广告位类型瀑布流属性，传None关闭自动刷新，最多一位小数。
bid_reserve_price	Integer	N	应用内竞价底价设置，单位分。取值范围（0<=bid_reserve_price<=2000000）	1000
client_sort_switch	Integer	N	开屏广告位支持，竞价加速器开关 0:关 1:开
strategy_cache_switch	Integer	N	开屏广告位支持，策略缓存开关 0:关1:开
strategy_cache_time	Float	N	仅当策略缓存开关=1是生效，策略缓存时长，单位小时
auto_load_ad	Integer	N	仅激励、插屏、原生、开屏支持，自动加载广告开关：0:关 1:开
enable_concurrency	Integer	N	应用内竞价与普通广告源并行请求开关：0：关1：开
max_concurrent_count	Integer	N	仅当 enable_concurrency=1生效，最大并行请求数，不填默认跟随系统默认或历史设置值
fill_type	Integer	N	瀑布流填充回调模式 0：速度优先 1:价值优先，默认0:速度优先
bidding_timeout	Integer	N	客户端竞价响应超时时长(秒)
server_bidding_timeout	Integer	N	服务端竞价响应超时时长(秒)，默认1
hb_ad_bottom	Integer	N	使用广告源兜底。0：关闭 1：开启默认0
cap_hour	Integer	N	展示上限(小时) 1-1000 默认为null
cap_day	Integer	N	展示上限(天) 1-1000 默认为null
pacing	Integer	N	展示间隔(秒)1-7200 默认为null

请求样例

JSON

{
  "group_id":558,
  "status":0,
  "request_mode":1,
  "parallel_req_count":5,
  "_user":"123@sigmob.com",
  "_t":1668706564419
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "type": null,
  "data": null
}

3.7.2 瀑布流属性查询

Request

URL: /srv/open/api/union_mediation/waterfall_attr/info
Method: POST
Content-Type: application/json
Body:

key	type	required	comment	value
group_id	Integer	Y	流量分组ID，即查询分组列表接口返回的 id	12
status	Integer	Y	AB实验所属分组。枚举值说明 0:默认分组，无AB实验则传入此值 1:A组 2:B组	0/1/2

Response

key	type	required	comment	value
request_mode	Integer	Y	瀑布流请求模式 0:固定数量并行请求 1:固定数量并行补位请求 2:相同价格并行请求可参考不同广告位类型瀑布流属性注意：如果request_mode 为2，则parallel_req_count固定为5	0
parallel_req_count	Integer	Y	并行请求组最大并行数。取值范围可参考不同广告位类型瀑布流属性
open_screen_timeout	Integer	Y	开屏请求超时时间(s)。取值可参考不同广告位类型瀑布流属性
single_parallel_request_timeout	Float	Y	单次并行请求超时时长(s)。取值可参考不同广告位类型瀑布流属性，最多一位小数。
waterfall_total_request_timeout	Float	Y	瀑布流总请求超时时长(s)。取值可参考不同广告位类型瀑布流属性，最多一位小数。仅激励，插屏，原生，横幅，支持该参数
auto_refresh_interval	Float	Y	横幅广告自动刷新间隔(s)。取值可参考不同广告位类型瀑布流属性，传None关闭自动刷新，最多一位小数。
bid_reserve_price	Integer	Y	应用内竞价底价设置，单位分。取值范围（0<=bid_reserve_price<=2000000）	1000
client_sort_switch	Integer	Y	开屏广告位支持，竞价加速器开关 0:关 1:开
strategy_cache_switch	Integer	Y	开屏广告位支持，策略缓存开关 0:关1:开
strategy_cache_time	Float	Y	仅当策略缓存开关=1是生效，策略缓存时长，单位小时
auto_load_ad	Integer	Y	仅激励、插屏、原生、开屏支持，自动加载广告开关：0:关 1:开
enable_concurrency	Integer	Y	应用内竞价与普通广告源并行请求开关：0：关1：开
max_concurrent_count	Integer	Y	仅当 enable_concurrency=1生效，最大并行请求数，不填默认跟随系统默认或历史设置值
fill_type	Integer	Y	瀑布流填充回调模式 0：速度优先 1:价值优先，默认0:速度优先
bidding_timeout	Integer	Y	客户端竞价响应超时时长(秒)
server_bidding_timeout	Integer	Y	服务端竞价响应超时时长(秒)，默认1
hb_ad_bottom	Integer	Y	使用广告源兜底。0：关闭 1：开启默认0
cap_hour	Integer	Y	展示上限(小时) 1-1000 默认为null
cap_day	Integer	Y	展示上限(天) 1-1000 默认为null
pacing	Integer	Y	展示间隔(秒)1-7200 默认为null

请求样例

JSON

{
  "group_id":558,
  "status":0,
  "_user":"123@sigmob.com",
  "_t":1668706564419
}

返回样例

JSON

{
    "code": 200,
    "msg": "",
    "type": null,
    "data": {
        "auto_refresh_interval": 7.133,
        "max_concurrent_count": 4,
        "client_sort_switch": 0,
        "request_mode": 2,
        "cap_hour": null,
        "enable_concurrency": 1,
        "server_bidding_timeout": 1.0,
        "waterfall_total_request_timeout": 200.333,
        "fill_type": 0,
        "status": 0,
        "bidding_timeout": 3.0,
        "single_parallel_request_timeout": 3.2,
        "group_id": 2008,
        "bid_reserve_price": 200,
        "auto_load_ad": 0,
        "parallel_req_count": 5,
        "pacing": null,
        "cap_day": null,
        "strategy_cache_switch": 0,
        "strategy_cache_time": null,
        "open_screen_timeout": 4.4,
        "hb_ad_bottom": 0
    }
}

3.8 瀑布流管理

用于查询，管理 ToBid SDK 加载的瀑布流中第三方广告源的信息，包括开启、关闭，以及第三方广告源排序价格等信息。

3.8.1 获取瀑布流信息

Request

Url:/srv/open/api/union_mediation/waterfall/list
Method：POST
Content-Type：application/json
Body：

key	type	required	comment	value
group_id	Integer	Y	流量分组ID，即查询分组列表接口返回的 id	12
status	Integer	Y	AB实验所属分组。枚举值说明 0:默认分组，无AB实验则传入此值 1:A组 2:B组	0/1/2
channel_id	Integer	N	广告网络渠道id

Response

key	type	required	comment
ad_source_list	Array[Object]	Y	开启的瀑布流分层
free_ad_source_list	Array[Object]	Y	关闭的瀑布流分层

具体信息

key	type	required	comment
ad_source_id	Integer	Y	广告源id
channel_id	Integer	Y	广告网络id
name	Integer	Y	广告源名称
header_bidding_switch	Integer	Y	是否开启hb 0 ：不是 1:是
bidding_method	Integer	Y	竞价方式 0:服务端竞价 1:客户端竞价
enabled	Integer	Y	是否在当前流量分组内启用。 0: 不启用 1: 启用
price	Integer		排序价格，单位分
bid_reserve_price	Integer		应用内竞价底价设置，单位分。普通广告源无需填写取值范围（0<=bid_reserve_price<=2000000）
weight_switch	Integer	Y	填充回调模式 0:速度优先 1:价值优先
single_parallel_request_timeout	Integer		请求超时时间(秒) （当速度优先返回null）
cap_day	Integer		不填不限，默认返回null
cap_hour	Integer		不填不限，默认返回null
pacing	Integer		不填不限，默认返回null
reward_callback_time	Integer		默认返回0，激励回调时机。1:广告关闭时回调激励，2:广告点击时回调激励
reward_guide_prompt	string	N	激励引导文案。仅在激励视频广告位下混出原生转插屏广告时生效。ToBid 可根据开发者配置的引导文案，在广告视图中渲染引导提示，明确告知用户完成激励任务即可获取对应奖励。该功能需依赖 ToBid Android v4.6.9 及以上版本。不传默认为空
auto_price	Integer		自动价格。0：关闭 1：开启
weight_switch	Integer		填充回调模式。0（速度优先）/1（价值优先）
single_parallel_request_timeout	Integer		请求超时时间（秒），weight_switch=1的时候有效
auto_price_cal_period	Integer	N	计算周期。1-7之间的整数，默认7
source_auth_content	Obj	Y	三方代码位信息

请求样例

JSON

{
  "group_id":1184,
  "status":2,
  "channel_id":13,
  "_user":"123@sigmob.com",
  "_t":1695030024456
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "type": null,
  "data": {
    "free_ad_source_list": [
      {
        "weight_switch": 1,
        "cap_day": 342,
        "channel_id": 13,
        "price": 2300,
        "single_parallel_request_timeout": 4,
        "enabled": 0,
        "cap_hour": 343,
        "ad_source_id": 55966,
        "name": "324",
        "pacing": 23,
        "header_bidding_switch": 0,
        "bidding_method": 0,
        "source_auth_content":{
            "placementId": "12fhu23uytfrsdfs",
            "splashType": "0"
        }
      },
      {
        "weight_switch": 0,
        "cap_day": null,
        "channel_id": 13,
        "price": 1200,
        "single_parallel_request_timeout": null,
        "enabled": 0,
        "cap_hour": null,
        "ad_source_id": 55973,
        "name": "312312",
        "pacing": null,
        "header_bidding_switch": 0,
        "bidding_method": 0,
        "source_auth_content":{
            "placementId": "rtfyt4123424d5",
            "splashType": "0"
        }
      }
    ],
    "ad_source_list": []
  }
}

3.8.2 修改广告源在瀑布流的属性

Request

URL: /srv/open/api/union_mediation/waterfall/update
Method: POST
Content-Type: application/json
Body:

key	type	required	comment	value
ad_source_id	Integer	Y	ToBid 体系内的广告源自增id，即查询广告源列表返回的id	12
group_id	Integer	Y	流量分组ID，即查询流量分组中返回的id	123
status	Integer	Y	AB 实验所属分组。枚举值说明 0:默认分组，无 AB 实验传入此值 1:A组 2:B组	0/1/2
enabled	Integer	N	是否在当前流量分组内启用。 0: 不启用 1: 启用	0/1 不传不修改
price	Integer	N	排序价格，单位分。取值范围（1<=price<=1000000）	1000 不传不修改
bid_reserve_price	Integer	N	应用内竞价底价设置，单位分。普通广告源无需填写取值范围（0<=bid_reserve_price<=2000000）	1000 不传不修改
cap_hour	Integer	N	展示上限(小时) 1~1000	不传不修改，传None 为不限
cap_day	Integer	N	展示上限(天)1~1000	不传不修改，传None 为不限
pacing	Integer	N	展示间隔(秒)1~7200	不传不修改，传None 为不限
reward_callback_time	Integer	N	在激励聚合广告位下使用广告类型优选时必传。激励回调时机。1:广告关闭时回调激励，2:广告点击时回调激励
reward_guide_prompt	string	N	激励引导文案。仅在激励视频广告位下混出原生转插屏广告时生效。ToBid 可根据开发者配置的引导文案，在广告视图中渲染引导提示，明确告知用户完成激励任务即可获取对应奖励。该功能需依赖 ToBid Android v4.6.9 及以上版本。	不传不修改
auto_price	Integer		自动价格。0：关闭 1：开启不传不修改
weight_switch	Integer		填充回调模式。0（速度优先）/1（价值优先）不传不修改
single_parallel_request_timeout	Integer		请求超时时间（秒），weight_switch=1的时候有效不传不修改
auto_price_cal_period	Integer	N	计算周期。1-7之间的整数，不传不修改

Response

接口响应参考公共响应参数

请求样例

json

{
  "group_id":558,
  "status":0,
  "ad_source_id":55453,
  "enabled":1,
  "price":100,
  "_user":"123@sigmob.com",
  "_t":1668707029443
}

返回样例

JSON

{
  "code": 200,
  "msg": "",
  "type": null,
  "data": null
}

4. 广告网络参数样例枚举

以下枚举的广告网络参数，均需要开发者在创建、编辑广告源信息的时候传入。

4.1 Mintegral

auth_content

Key	required	comment
apiKey	N	Mintegral 的APP Key
repApiSecret	N	Mintegral 的Secret
repApiKey	N	Mintegral 的Skey

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "apiKey":"12344",
    "repApiSecret":"121344",
    "repApiKey":"12344"
  }
}

app_auth_content

Key	required	comment
appId	Y	Mintegral 的APP ID

样例

JSON

{
  "app_auth_content": {
    "appId":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
unitId	Y	注意：此值对应Mintegral 的 Placement ID
placementId	Y	注意：此值对应Mintegral 的 UnitID
autoPlayMuted	N	视频是否播放静音播放。仅激励视频、原转插广告、原生广告支持该字段	0：否 1：是（默认）
playDirection	N	广告播放方向。仅开屏广告支持该字段	0：竖屏播放 1：横屏播放
allowSkip	N	开屏广告是否展示跳过按钮。	0：否 1：是（默认）
countdown	N	开屏广告展示时长。范围1-5，单位秒	5（默认）
subType	N	Mintegral 渠道的插屏广告样式。请按照广告平台的样式传入该值	0：全屏视频 1：插屏广告 2：新插屏（默认）
bannerType	N	横幅广告广告位尺寸比例	0：横幅（320x50）（默认） 1：中矩形横幅（320x90） 2：大横幅（300x250） 3：智能横幅（320x50 或 728x90）
templateType	N	广告渲染方式。仅原生广告支持该字段	0：自动渲染（默认） 1：自渲染
autoPlayPolicy	N	是否自动播放视频。仅自动渲染模式的原生广告支持该字段	ALWAYS：自动播放（默认） WIFI：WiFi 网络自动播放
showClose	N	是否展示关闭按钮。仅自动渲染模式的原生广告支持该字段	0：显示（默认） 1：隐藏
nativeRenderType	N	模版广告大小。仅原生转开屏、原生转插屏支持该字段	0：全屏（仅开屏、插屏可用）(开屏默认) 1：半屏（仅插屏可用）（插屏默认）
nativeRenderOri	N	模版广告方向。仅原生转开屏、原生转插屏支持该字段	0：竖屏（默认） 1：横屏（仅插屏可用）
nativeTotalTime	N	倒计时时长。仅原生转开屏、原生转插屏支持该字段。开屏限制3-5s，默认3s；插屏限制0-15s，默认5s	5（默认）
nativeBtnStyle	N	下载/查看详情按钮样式。仅原生转开屏、原生转插屏支持该字段。	0：普通样式（默认） 1：光刀样式
nativeTemplateId	N	模板样式。仅原转开、原转插、原转banner支持该字段，且此时为必填	原生转插屏： 4012001 ：竖版方形； 4012002 ：竖版上图下文（小）； 4012003 ：竖版上图下文（中）。 4102001：横版方型。原生转开屏： 2002001：开屏全屏样式。原生转banner： 7002001：横幅样式
nativeSkipTime	N	播放至n秒可关闭。仅原生转插屏支持该字段。限制0-15s，默认5s	5（默认）
nativeIsAutoClose	N	倒计时结束自动关闭。仅原生转插屏支持该字段。 nativeSkipTime>0时有效	0：否（默认） 1：是
nativeEnableFullScreenClick	N	全广告区域可点击。仅原生转插屏、原生转banner支持该字段。	0：非全区域点击（默认） 1：全区域可点

样例

JSON

{
  "source_auth_content": {
    "unitId":"abcd",
    "placementId":"1234",
    "autoPlayMuted":"1",
    "playDirection":"1",
    "countdown":2
  }
}

4.2 AdMob

auth_content

Key	required	comment
publisherId	N	发布商 ID
token	N	访问权限口令

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "publisherId":"12344",
    "token":"121344"
  }
}

app_auth_content

Key	required	comment
appId	Y	APP ID

样例

JSON

{
  "app_auth_content": {
    "appId":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告位ID
adSize	N	横幅广告广告位尺寸比例	320x50：横幅（320x50）（默认） 320x100：大横幅（320x100） 300x250：中矩形横幅（300x250） 468x60：全尺寸横幅（468x60） 728x90：页首横幅（728x90）

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234",
    "adSize":"728x90"
  }
}

4.3 AdScope

auth_content

无此级别参数，需要传入空

样例

JSON

{
  "auth_content": {}
}

app_auth_content

Key	required	comment
appId	Y	APP ID

样例

JSON

{
  "app_auth_content": {
    "appId":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告位ID
adTemplateType	N	模板类型。仅安卓插屏、原生支持此参数。插屏仅支持1、2	1：平台模板1.0（默认），2：平台模板2.0 ，4：小图原生，5：上图下文原生
templateType	N	渲染方式，仅ios原生支持此参数。	0：模板渲染（默认） 1：自渲染
nativeRenderType	N	模版广告大小。仅原生转开屏、原生转插屏支持该字段	0：全屏（仅开屏、插屏可用）(开屏默认) 1：半屏（仅插屏可用）（插屏默认）
nativeRenderOri	N	模版广告方向。仅原生转开屏、原生转插屏支持该字段	0：竖屏（默认） 1：横屏（仅插屏可用）
nativeTotalTime	N	倒计时时长。仅原生转开屏、原生转插屏支持该字段。开屏限制3-5s，默认5s；插屏限制0-15s，默认5s	5（默认）
nativeBtnStyle	N	下载/查看详情按钮样式。仅原生转开屏、原生转插屏支持该字段。	0：普通样式（默认） 1：光刀样式
nativeTemplateId	N	模板样式。仅原转开、原转插、原转banner支持该字段，且此时为必填	原生转插屏： 4012001 ：竖版方形； 4012002 ：竖版上图下文（小）； 4012003 ：竖版上图下文（中）。 4102001：横版方型。原生转开屏： 2002001：开屏全屏样式。原生转banner： 7002001：横幅样式
nativeSkipTime	N	播放至n秒可关闭。仅原生转插屏支持该字段。限制0-15s，默认5s	5（默认）
nativeIsAutoClose	N	倒计时结束自动关闭。仅原生转插屏支持该字段。 nativeSkipTime>0时有效	0：否（默认） 1：是
nativeEnableFullScreenClick	N	全广告区域可点击。仅原生转插屏、原生转banner支持该字段。	0：非全区域点击（默认） 1：全区域可点

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234"
  }
}

4.4 Applovin

auth_content

Key	required	comment
repApiKey	N	Report Key
apiKey	N	SDK Key

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "repApiKey":"12344",
    "apiKey":"121344"
  }
}

app_auth_content

无此级别参数

样例

JSON

{
  "app_auth_content": {}
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	Zone ID
adSize	N	横幅广告广告位尺寸比例	320x50：横幅（320x50）（默认） 300x90：中矩形横幅（300x90）

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234",
    "adSize":"300x90"
  }
}

4.5 ironSource

auth_content

Key	required	comment
repusername	N	User Name
repApiKey	N	Secret Key

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "repusername":"12344",
    "repApiKey":"121344"
  }
}

app_auth_content

Key	required	comment
appId	Y	APP Key

样例

JSON

{
  "app_auth_content": {
    "appId":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	Instance ID

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234"
  }
}

4.6 UnityAds

auth_content

Key	required	comment
repApiKey	N	Monetization Stats API Key
organizationID	N	Organization Core ID

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "repApiKey":"12344",
    "organizationID":"121344"
  }
}

app_auth_content

Key	required	comment
appId	Y	Game ID

样例

JSON

{
  "app_auth_content": {
    "appId":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告位ID
adSize	N	横幅广告广告位尺寸比例	320x50：320x50（默认） 468x60：468x60 728x90：728x90

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234",
    "adSize":"728x90"
  }
}

4.7 Vungle

auth_content

Key	required	comment
repApiKey	N	Reporting API Key

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "repApiKey":"12344"
  }
}

app_auth_content

Key	required	comment
appId	Y	APP ID

样例

JSON

{
  "app_auth_content": {
    "appId":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告位置参考ID
adSize	N	横幅广告广告位尺寸比例	320x50：320x50（默认） 300x50：300x50 728x90：728x90

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234",
    "adSize":"728x90"
  }
}

4.8 百度联盟

auth_content

Key	required	comment
repApiKey	N	Access Key
public_key	N	公钥
private_key	N	私钥

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "repApiKey":"12344",
    "public_key":"xxxx",
    "private_key":"xxxx"
  }
}

app_auth_content

Key	required	comment
appId	Y	应用ID

样例

JSON

{
  "app_auth_content": {
    "appId":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告位ID
showDownloadDialog	N	安卓手机应用下载的二次确认弹窗。仅安卓应用支持此字段	0：不开启（默认）1：开启
subType	N	广告类型。请按照广告平台显示信息传入该字段	插屏：1：全屏视频 2：智选模版插屏（默认）；原生：1：信息流（默认） 2：Draw 信息流
adSize	N	横幅广告广告位尺寸比例	375x56：20:3（375x56）（默认） 200x30：20:3（200x30） 375x250：3:2（375x250） 200x133：3:2（200x133） 375x160：7:3（375x160） 200x85：7:3（200x85） 375x187：2:1（375x187） 200x100：2:1（200x100）
autoPlayMuted	N	视频声音控制。插屏、原生、开屏支持本字段	0：有声音 1：静音（默认）
templateType	N	渲染方式。原生支持本字段。 Draw仅支持1	0：智能优选-优选模版（默认） 1：返回元素/智能优选-自渲染；仅当subType = 1信息流时需填写
nativeRenderType	N	模版广告大小。仅原生转开屏、原生转插屏支持该字段	0：全屏（仅开屏、插屏可用）(开屏默认) 1：半屏（仅插屏可用）（插屏默认）
nativeRenderOri	N	模版广告方向。仅原生转开屏、原生转插屏支持该字段	0：竖屏（默认） 1：横屏（仅插屏可用）
nativeTotalTime	N	倒计时时长。仅原生转开屏、原生转插屏支持该字段。开屏限制3-5s；插屏限制0-15s	5（默认）
nativeBtnStyle	N	下载/查看详情按钮样式。仅原生转开屏、原生转插屏支持该字段。	0：普通样式（默认） 1：光刀样式
nativeShakeAd	N	创意交互类型。仅原生转开屏、原生转插屏支持该字段。	0：普通广告（默认） 1：摇一摇广告
nativeTemplateId	N	模板样式。仅原转开、原转插、原转banner支持该字段，且此时为必填	原生转插屏： 4012001 ：竖版方形； 4012002 ：竖版上图下文（小）； 4012003 ：竖版上图下文（中）。 4102001：横版方型。原生转开屏： 2002001：开屏全屏样式。原生转banner： 7002001：横幅样式
nativeSkipTime	N	播放至n秒可关闭。仅原生转插屏支持该字段。限制0-15s，默认5s	5
nativeIsAutoClose	N	倒计时结束自动关闭。仅原生转插屏支持该字段。 nativeSkipTime>0时有效	0：否（默认） 1：是
nativeEnableFullScreenClick	N	全广告区域可点击。仅原生转插屏、原生转banner支持该字段。	0：非全区域点击（默认） 1：全区域可点

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234",
    "showDownloadDialog":"1",
    "adSize":"375x187"
  }
}

4.9 穿山甲

auth_content

Key	required	comment
repApiKey	N	User ID
repApiSecret	N	Secure Key
repApiRoleId	N	Role ID

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "repApiKey":"12344",
    "repApiSecret":"12344",
    "repApiRoleId":"121344"
  }
}

app_auth_content

Key	required	comment
appId	Y	应用 ID

样例

JSON

{
  "app_auth_content": {
    "appId":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	代码位ID
templateType	N	广告渲染模式。注意：横幅广告仅HarmonyOS支持该字段；插屏广告仅全屏视频形式支持	0：模板渲染（默认） 1：自渲染
splashType	N	是否是开屏点睛广告。开屏支持，其他不支持	0：不是（默认） 1：是
subType	N	广告位类型。仅支持插屏、原生	插屏：0：插屏广告 1：全屏视频 2：新插屏（默认）；原生：1：信息流（默认） 2：Draw 信息流
ratio	N	插屏广告广告位尺寸比例。传入宽高比，例如3:2 仅subType为0的时候支持该字段	1:1（默认），2:3，3:2
imgType	N	原生广告素材尺寸。仅原生自渲染，原转开、原转插、原转banner广告支持	0：690388px （默认） 1：228150px
adSize	N	横幅广告广告位尺寸比例	IOS/Android: 600x300（默认） 600x400 600x500 600x260 600x150 640x100 690x388 600x90 Harmony: 300x150（默认） 300x200 300x250 300x130 300x45 300x75 320x50 345x194
nativeRenderType	N	模版广告大小。仅原生转开屏、原生转插屏支持该字段	0：全屏（仅开屏、插屏可用）(开屏默认) 1：半屏（仅插屏可用）（插屏默认）
nativeRenderOri	N	模版广告方向。仅原生转开屏、原生转插屏支持该字段	0：竖屏（默认） 1：横屏（仅插屏可用）
nativeTotalTime	N	倒计时时长。仅原生转开屏、原生转插屏支持该字段。开屏限制3-5s；插屏限制0-15s	3（默认）
nativeBtnStyle	N	下载/查看详情按钮样式。仅原转开、原转插支持该字段。	0：普通样式（默认） 1：光刀样式
nativeShakeAd	N	创意交互类型。仅原转开、原转插支持该字段。	0：普通广告（默认） 1：摇一摇广告
nativeTemplateId	N	模板样式。仅原转开、原转插、原转banner支持该字段，且此时为必填	原生转插屏： 4012001 ：竖版方形； 4012002 ：竖版上图下文（小）； 4012003 ：竖版上图下文（中）。 4102001：横版方型。原生转开屏： 2002001：开屏全屏样式。原生转banner： 7002001：横幅样式
nativeSkipTime	N	播放至n秒可关闭。仅原生转插屏支持该字段。限制0-15s，默认5s。nativeSkipTime需小于nativeTotalTime	5（默认）
nativeIsAutoClose	N	倒计时结束自动关闭。仅原生转插屏支持该字段。 nativeTotalTime>0时有效	0：否（默认） 1：是
nativeEnableFullScreenClick	N	全广告区域可点击。仅原生转插屏、原生转banner支持该字段。	0：非全区域点击（默认） 1：全区域可点
canInterruptVideoPlay	N	设置Draw视频点击可暂停仅HarmonyOS原生支持	0：不可以（默认） 1：可以

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234",
    "ratio":"1:1",
    "adSize":"728x90"
  }
}

4.10 快手广告

auth_content

Key	required	comment
apiKey	N	Access Key
repApiKey	N	Security Key
mediumId	Y	账号id。快手头部竞价功能需要填写账号id信息。请在快手后台->我的账号查看此id

以上非必填参数，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "apiKey":"12344",
    "repApiKey":"121344",
    "mediumId":"12344"
  }
}

app_auth_content

Key	required	comment
appId	Y	应用ID
appName	Y	应用名称

样例

JSON

{
  "app_auth_content": {
    "appId":"1234",
    "appName":"test"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告位ID
playDirection	N	广告播放方向。注意：仅激励视频和插屏广告支持；插屏仅全屏视频形式支持该字段	0：竖屏（默认） 1：横屏
autoPlayMuted	N	视频是否静音播放。ios：原生draw, 模版插屏、激励支持。安卓：原生模板渲染、原生自渲染、原生转开屏、原生转banner、原生转插屏、插屏、激励均支持。HarmonyOS：激励、开屏、插屏、原生均支持	0：否，1：是（默认）
subType	N	广告位类型。仅插屏、原生支持	插屏：0：插屏广告（默认） 1：全屏广告 2:新插屏广告（HarmonyOS不支持）；原生：1：信息流（默认） 2：Draw信息流（HarmonyOS不支持）
templateType	N	广告渲染模式。	0：模板渲染（默认） 1：自渲染
showDownloadDialog	N	应用下载弹窗。仅安卓系统：原生自渲染、banner支持	0：不开启（默认） 1：开启
nativeRenderType	N	模版广告大小。仅原生转开屏、原生转插屏支持该字段，HarmonyOS不支持	0：全屏（仅开屏、插屏可用） 1：半屏（仅插屏可用）
nativeRenderOri	N	模版广告方向。仅原生转开屏、原生转插屏支持该字段	0：竖屏（默认） 1：横屏（仅插屏可用）
nativeTotalTime	N	倒计时时长。仅原生转开屏、原生转插屏支持该字段。开屏限制3-5s；插屏限制0-15s	5（默认）
nativeBtnStyle	N	下载/查看详情按钮样式。仅原生转开屏、原生转插屏支持该字段。	0：普通样式（默认） 1：光刀样式
nativeShakeAd	N	创意交互类型。仅原生转开屏、原生转插屏支持该字段。	0：普通广告（默认） 1：摇一摇广告
nativeTemplateId	N	模板样式。仅原转开、原转插、原转banner支持该字段，且此时为必填	原生转插屏： 4012001 ：竖版方形； 4012002 ：竖版上图下文（小）； 4012003 ：竖版上图下文（中）。 4102001：横版方型。原生转开屏： 2002001：开屏全屏样式。原生转banner： 7002001：横幅样式
nativeSkipTime	N	播放至n秒可关闭。仅原生转插屏支持该字段。限制0-15s，默认5s	5（默认）
nativeIsAutoClose	N	倒计时结束自动关闭。仅原生转插屏支持该字段。 nativeSkipTime>0时有效	0：否（默认） 1：是
nativeEnableFullScreenClick	N	全广告区域可点击。仅原生转插屏、原生转banner支持该字段。	0：非全区域点击（默认） 1：全区域可点

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234",
    "adSize":"728x90"
  }
}

4.11 腾讯广告

auth_content

Key	required	comment
repApiKey	N	账户ID
repApiSecret	N	Secret Key

以上内容，若需使用报表API功能则必填。

样例

JSON

"auth_content":
{
    "repApiKey":"12344",
    "repApiSecret":"121344"
}

app_auth_content

Key	required	comment
appId	Y	媒体 ID

样例

JSON

"app_auth_content":
{
    "appId":"1234"
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告单元ID
autoPlayMuted	N	视频是否静音播放。注意：开屏广告、横幅广告不支持。原转开、原转插、原转banner均支持	0：否 1：是（默认）
subType	N	广告展示形式，请按照广告平台的信息传入此值。	插屏：0：弹窗 1：全屏（默认）；原生：1：信息流（默认）；2：沉浸式视频流广告
autoPlayPolicy	N	是否自动播放视频。仅原生、插屏、原转开、原转插、原转banner广告支持此字段	ALWAYS：总是（默认） WIFI：WiFi 网络播放
fakeMaxVideoDuration	X	是否限制广告视频最大时长。仅原生、插屏、原转开、原转插、原转banner广告支持此字段	0：不限制时长（插屏、原生默认） 1：限制时长（其他类型默认）
maxVideoDuration	N	广告视频最大时长。取值范围 5-60，单位秒仅原生、插屏、原转开、原转插、原转banner广告支持此字段；仅fakeMaxVideoDuration为1时支持	60（默认）
templateType	N	广告渲染模式。仅原生广告支持	0：优量汇渲染（默认） 1：开发者自渲染
adSize	N	横幅广告广告位尺寸比例	320x50：横幅（320x50）（默认）
detailPageMuted	N	详情页是否静音。仅原转开、原转插、原转banner支持	0：否 1：是（默认）
showDownloadDialog	N	应用下载按钮。仅安卓系统。原生、原转开、原转插、原转banner支持	0：否（默认） 1：是
nativeRenderType	N	模版广告大小。仅原生转开屏、原生转插屏支持该字段	0：全屏（仅开屏、插屏可用）(开屏默认) 1：半屏（仅插屏可用）（插屏默认）
nativeRenderOri	N	模版广告方向。仅原生转开屏、原生转插屏支持该字段	0：竖屏（默认） 1：横屏（仅插屏可用）
nativeTotalTime	N	倒计时时长。仅原生转开屏、原生转插屏支持该字段。开屏限制3-5s；插屏限制0-15s	5（默认）
nativeBtnStyle	N	下载/查看详情按钮样式。仅原生转开屏、原生转插屏支持该字段。	0：普通样式（默认） 1：光刀样式
nativeShakeAd	N	创意交互类型。仅原生转开屏、原生转插屏支持该字段。	0：普通广告（默认） 1：摇一摇广告
nativeTemplateId	N	模板样式。仅原转开、原转插、原转banner支持该字段，且此时为必填	原生转插屏： 4012001 ：竖版方形； 4012002 ：竖版上图下文（小）； 4012003 ：竖版上图下文（中）。 4102001：横版方型。原生转开屏： 2002001：开屏全屏样式。原生转banner： 7002001：横幅样式
nativeSkipTime	N	播放至n秒可关闭。仅原生转插屏支持该字段。限制0-15s，默认5s	5（默认）
nativeIsAutoClose	N	倒计时结束自动关闭。仅原生转插屏支持该字段。 nativeSkipTime>0时有效	0：否（默认） 1：是
nativeEnableFullScreenClick	N	全广告区域可点击。仅原生转插屏、原生转banner支持该字段。	0：非全区域点击（默认） 1：全区域可点

样例

JSON

"source_auth_content":
{
"placementId":"1234",
"adSize":"728x90",
"maxVideoDuration":"5"
}

4.12 Sigmob

auth_content

无此级别参数

样例

JSON

{
  "auth_content": {}
}

app_auth_content

无此级别参数

样例

JSON

{
  "app_auth_content": {}
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告单元ID

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234"
  }
}

4.13 Gromore

auth_content

Key	required	comment
repApiKey	N	User ID
repApiSecret	N	Secure Key
repApiRoleId	N	Role ID

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "repApiKey":"12344",
    "repApiSecret":"12344",
    "repApiRoleId":"121344"
  }
}

app_auth_content

Key	required	comment
appId	Y	应用 ID

样例

JSON

{
  "app_auth_content": {
    "appId":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	代码位ID
templateType	N	广告渲染模式。注意：仅原生，不支持鸿蒙系统	0：模板渲染（默认） 1：自渲染
splashType	N	是否是开屏点睛广告。	0：不是（默认） 1：是
subType	N	广告位类型。仅支持插屏、原生	插屏：0：插屏广告 1：全屏视频 2：新插屏（默认）；原生：1：信息流（默认） 2：Draw 信息流
imgType	N	原生广告素材尺寸。仅iOS原生信息流、原转开、原转插、原转banner广告支持	0：690388px（默认） 1：228150px
adSize	N	横幅广告广告位尺寸比例	IOS/Android: 600x300（默认） 600x400 600x500 600x260 600x150 640x100 690x388 600x90 Harmony: 300x150（默认） 300x200 300x250 300x130 300x45 300x75 320x50 345x194
nativeRenderType	N	模版广告大小。仅原生转开屏、原生转插屏支持该字段	0：全屏（仅开屏、插屏可用）(开屏默认) 1：半屏（仅插屏可用）（插屏默认）
nativeRenderOri	N	模版广告方向。仅原生转开屏、原生转插屏支持该字段	0：竖屏（默认） 1：横屏（仅插屏可用）
nativeTotalTime	N	倒计时时长。仅原生转开屏、原生转插屏支持该字段。开屏限制3-5s，插屏限制0-15s	5（默认）
nativeBtnStyle	N	下载/查看详情按钮样式。仅原转开、原转插支持该字段。	0：普通样式（默认） 1：光刀样式
nativeShakeAd	N	创意交互类型。仅原转开、原转插支持该字段。	0：普通广告（默认） 1：摇一摇广告
nativeTemplateId	N	模板样式。仅原转开、原转插、原转banner支持该字段，且此时为必填	原生转插屏： 4012001 ：竖版方形； 4012002 ：竖版上图下文（小）； 4012003 ：竖版上图下文（中）。 4102001：横版方型。原生转开屏： 2002001：开屏全屏样式。原生转banner： 7002001：横幅样式
nativeSkipTime	N	播放至n秒可关闭。仅原生转插屏支持该字段。限制0-15s，默认5s	5（默认）
nativeIsAutoClose	N	倒计时结束自动关闭。仅原生转插屏支持该字段。 nativeSkipTime>0时有效	0：否（默认） 1：是
nativeEnableFullScreenClick	N	全广告区域可点击。仅原生转插屏、原生转banner支持该字段。	0：非全区域点击（默认） 1：全区域可点

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234",
    "ratio":"1:1",
    "adSize":"728x90"
  }
}

4.14 华为inner（原华为）

auth_content

Key	required	comment
client_id	N	客户端ID
secretKey	N	SecretKey

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "client_id":"12344",
    "secretKey":"121344"
  }
}

app_auth_content

无此级别参数，需要传入空

样例

JSON

{
  "app_auth_content": {}
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	代码位ID
autoPlayMuted	N	是否静音播放。 ios仅激励视频支持；android仅激励视频、插屏支持；HarmonyOS除横幅广告外均支持。默认是	0：否 1：是（默认）
autoPlayPolicy	N	视频自动播放。android仅插屏支持，默认WIFI	WIFI`（默认）`：仅Wi-Fi自动播放 ALWAYS：始终自动播放 NEVER：从不自动播放
adSize	N	代码位尺寸比例，默认1080x170	1080x170`（默认）` 1080x432
allowMobileTraffic	N	是否允许流量下载，仅HarmonyOS支持	0：不允许（默认） 1：允许
adContentClassification	N	设置广告内容分级上限，仅HarmonyOS支持	W：3+（默认），所有受众 PI：7+，家长指导 J：12+，青少年 A：16+/18+，成人受众
enableDirectReturnVideoAd	N	等所有广告素材下载完后再回调，仅HarmonyOS支持	0：否（默认）1：是
templateType	N	渲染方式，仅HarmonyOS原生支持	0：模板渲染

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234",
    "adSize":"1080x432"
  }
}

4.15 趣盟

auth_content

Key	required	comment
repApiKey	N	secret_key

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "repApiKey":"12344"
  }
}

app_auth_content

无此级别参数，需要传入空

样例

JSON

{
  "app_auth_content": {}
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	代码位ID
templateType	N	渲染方式。默认0	0：模板渲染（默认） 1：自渲染
nativeRenderType	N	模版广告大小。仅原生转开屏、原生转插屏支持该字段	0：全屏（仅开屏、插屏可用）(开屏默认) 1：半屏（仅插屏可用）（插屏默认）
nativeRenderOri	N	模版广告方向。仅原生转开屏、原生转插屏支持该字段	0：竖屏（默认） 1：横屏（仅插屏可用）
nativeTotalTime	N	倒计时时长。仅原生转开屏、原生转插屏支持该字段。开屏限制3-5s，插屏限制0-15s	5（默认）
nativeBtnStyle	N	下载/查看详情按钮样式。仅原生转开屏、原生转插屏支持该字段。	0：普通样式（默认） 1：光刀样式
nativeTemplateId	N	模板样式。仅原转开、原转插、原转banner支持该字段，且此时为必填	原生转插屏： 4012001 ：竖版方形； 4012002 ：竖版上图下文（小）； 4012003 ：竖版上图下文（中）。 4102001：横版方型。原生转开屏： 2002001：开屏全屏样式。原生转banner： 7002001：横幅样式
nativeSkipTime	N	播放至n秒可关闭。仅原生转插屏支持该字段。限制0-15s，默认5s	5（默认）
nativeIsAutoClose	N	倒计时结束自动关闭。仅原生转插屏支持该字段。 nativeSkipTime>0时有效	0：否（默认） 1：是
nativeEnableFullScreenClick	N	全广告区域可点击。仅原生转插屏、原生转banner支持该字段。	0：非全区域点击（默认） 1：全区域可点

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234"
  }
}

4.16 TapADN

auth_content

| Key | required | comment | | ------- | ----------- | | appKey | N | 流量主id | | token | N | Token |

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "appKey":"12344",
    "token":"12344"
  }
}

app_auth_content

| Key | required | comment | | ------------- | ---------------- | | appId | Y | 应用ID | | apiKey | Y | 媒体密钥 | | media_version | Y | 媒体加密协议版本，固定传“1” | | app_channel | Y | 媒体渠道，固定传“taptap” |

样例

JSON

{
  "auth_content": {
    "appId":"12344",
    "apiKey":"12344",
    "media_version":"1",
    "app_channel":"taptap"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	代码位ID
templateType	N	渲染方式，仅原生模板渲染广告支持。	0：模板渲染 1：自渲染（默认）
autoPlayPolicy	N	自动播放视频，仅原生广告支持。默认ALWAYS	ALWAYS：总是（默认） WIFI：仅WiFi网络
nativeRenderType	N	模版广告大小。仅原生转开屏、原生转插屏支持该字段	0：全屏（仅开屏、插屏可用）(开屏默认) 1：半屏（仅插屏可用）（插屏默认）
nativeRenderOri	N	模版广告方向。仅原生转开屏、原生转插屏支持该字段	0：竖屏（默认） 1：横屏（仅插屏可用）
nativeTotalTime	N	倒计时时长。仅原生转开屏、原生转插屏支持该字段。开屏限制3-5s，插屏限制0-15s	5（默认）
nativeBtnStyle	N	下载/查看详情按钮样式。仅原生转开屏、原生转插屏支持该字段。	0：普通样式（默认） 1：光刀样式
nativeTemplateId	N	模板样式。仅原转开、原转插、原转banner支持该字段，且此时为必填	原生转插屏： 4012001 ：竖版方形； 4012002 ：竖版上图下文（小）； 4012003 ：竖版上图下文（中）。 4102001：横版方型。原生转开屏： 2002001：开屏全屏样式。原生转banner： 7002001：横幅样式
nativeSkipTime	N	播放至n秒可关闭。仅原生转插屏支持该字段。限制0-15s，默认5s	5（默认）
nativeIsAutoClose	N	倒计时结束自动关闭。仅原生转插屏支持该字段。 nativeSkipTime>0时有效	0：否（默认） 1：是
nativeEnableFullScreenClick	N	全广告区域可点击。仅原生转插屏、原生转banner支持该字段。	0：非全区域点击（默认） 1：全区域可点

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234"
  }
}

4.17 Pangle

auth_content

Key	required	comment
repApiKey	N	User ID
repApiRoleId	N	Role ID
repApiSecret	N	Secure Key

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "repApiKey":"12344",
    "repApiRoleId":"12344",
    "repApiSecret":"12344"
  }
}

app_auth_content

Key	required	comment
appId	Y	应用ID

样例

JSON

{
  "auth_content": {
    "appId":"12344"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	代码位ID
bannerType	N	横幅广告尺寸比例	0：320x50（默认） 1：300x250 2：728x90

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234"
  }
}

4.18 Reklamup

auth_content

Key	required	comment
apiKey	Y	apiKey
apiSecret	N	apiSecret

以上非必填参数，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "apiKey":"12344",
    "apiSecret":"12344"
  }
}

app_auth_content

Key	required	comment
appId	Y	应用ID

样例

JSON

{
  "auth_content": {
    "appId":"12344"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告单元 ID
adSize	N	横幅广告尺寸比例。	320x50（默认） 320x100 300x250 468x60 728x90

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234"
  }
}

4.19 Oppo ADN

auth_content

Key	required	comment
userId	N	User ID
api_key	N	API Key

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "userId":"12344",
    "api_key":"12344"
  }
}

app_auth_content

Key	required	comment
appId	Y	应用ID

样例

JSON

{
  "auth_content": {
    "appId":"12344"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告单元 ID
subType	Y	广告位类型。仅插屏支持	0：插屏广告 1：全屏视频
templateType	N	渲染方式。仅原生支持	0：原生模版广告（默认） 1：原生Advance广告

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234",
    "subType":"0"
  }
}

4.20 美数

auth_content

Key	required	comment
agent_id	N	Agent_id
token	N	token

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "agent_id":"12344",
    "token":"12344"
  }
}

app_auth_content

Key	required	comment
appId	Y	应用ID

样例

JSON

{
  "auth_content": {
    "appId":"12344"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告单元 ID
autoPlayMuted	N	视频静音。仅激励、插屏、原生支持。	0：否 1：是（默认）
subType	N	广告位类型。仅插屏支持，	0：插屏广告（默认） 1：全屏视频
adSize	N	广告位尺寸比例。仅 IOS\HarmonyOS banner支持，	600x300 600x400 600x500 600x260 600x90 600x150 640×100（默认） 690x388

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234",
    "subType":"0"
  }
}

4.21 荣耀

auth_content

Key	required	comment
client_id	N	Client_id
client_secret	N	Client_secret

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "client_id":"12344",
    "client_secret":"12344"
  }
}

app_auth_content

Key	required	comment
appId	Y	应用ID
apiKey	Y	APP KEY

样例

JSON

{
  "auth_content": {
    "appId":"12344",
    "apiKey":"12344"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告单元 ID
templateType	N	渲染方式。仅原生支持	0：模版渲染 1：自渲染（默认）

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234",
    "templateType":"0"
  }
}

4.22 inmobi

auth_content

Key	required	comment
userName	N	登录邮箱
appId	Y	accountId
secretKey	N	Secure Key

以上非必填参数，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "userName":"12344",
    "appId":"12344",
    "secretKey":"12344"
  }
}

app_auth_content

Key	required	comment
apiKey	Y	APP KEY

样例

JSON

{
  "auth_content": {
    "apiKey":"12344"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告单元 ID
templateType	N	广告位尺寸比例。仅banner支持	0：320x50（默认） 1：300x250

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234",
    "templateType":"0"
  }
}

4.23 Vivo Adn

auth_content

Key	required	comment
accountName	N	accountName
secretKey	N	SecretKey

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "accountName":"12344",
    "secretKey":"12344"
  }
}

app_auth_content

Key	required	comment
apiKey	Y	APP KEY

样例

JSON

{
  "auth_content": {
    "apiKey":"12344"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告单元 ID
subType	N	广告位类型。仅插屏支持	0：插屏广告（默认） 1：全屏视频
templateType	N	渲染方式。仅原生支持	0：原生模板广告（默认） 1：原生Advance广告
autoPlayPolicy	N	是否视频自动播放。仅原生支持	ALWAYS：总是（默认） WIFI：仅WiFi网络

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234"
  }
}

4.24 Billowlink

auth_content

无此级别参数

样例

JSON

{
  "auth_content": {}
}

app_auth_content

Key	required	comment
appId	Y	APP KEY

样例

JSON

{
  "auth_content": {
    "appId":"12344"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告单元 ID
templateType	N	渲染方式。仅原生支持	0：模版渲染（默认） 1：自渲染

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234"
  }
}

4.25 自定义渠道

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告单元 ID	必传
custom_info	N	自定义配置	非必传,json格式的配置信息，例如： "custom_info":"{"name": "233424"}",

4.26 京媒平台

auth_content

无此级别参数，需要传入空

样例

JSON

{
  "auth_content": {}
}

app_auth_content

Key	required	comment
appId	Y	应用 ID

样例

JSON

{
  "app_auth_content": {
    "appId":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告位ID
templateType	N	渲染方式，仅ios原生支持此参数。	0：模板渲染（默认） 1：自渲染
nativeRenderType	N	模版广告大小。仅原生转开屏、原生转插屏支持该字段	0：全屏（仅开屏、插屏可用）(开屏默认) 1：半屏（仅插屏可用）（插屏默认）
nativeRenderOri	N	模版广告方向。仅原生转开屏、原生转插屏支持该字段	0：竖屏（默认） 1：横屏（仅插屏可用）
nativeTotalTime	N	倒计时时长。仅原生转开屏、原生转插屏支持该字段。开屏限制3-5s，插屏限制0-15s	5（默认）
nativeBtnStyle	N	下载/查看详情按钮样式。仅原生转开屏、原生转插屏支持该字段。	0：普通样式（默认） 1：光刀样式
nativeTemplateId	N	模板样式。仅原转开、原转插、原转banner支持该字段，且此时为必填	原生转插屏： 4012001 ：竖版方形； 4012002 ：竖版上图下文（小）； 4012003 ：竖版上图下文（中）。 4102001：横版方型。原生转开屏： 2002001：开屏全屏样式。原生转banner： 7002001：横幅样式
nativeSkipTime	N	播放至n秒可关闭。仅原生转插屏支持该字段。限制0-15s，默认5s	5（默认）
nativeIsAutoClose	N	倒计时结束自动关闭。仅原生转插屏支持该字段。 nativeSkipTime>0时有效	0：否（默认） 1：是
nativeEnableFullScreenClick	N	全广告区域可点击。仅原生转插屏、原生转banner支持该字段。	0：非全区域点击（默认） 1：全区域可点

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234"
  }
}

4.27 章鱼

auth_content

Key	required	comment
repApiKey	N	账户名
repApiSecret	N	授权码

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "repApiKey":"12344",
    "repApiSecret":"12344"
  }
}

app_auth_content

Key	required	comment
appId	Y	应用 ID

样例

JSON

{
  "app_auth_content": {
    "appId":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告位ID
subType	N	广告位类型，仅原生、插屏支持此参数。	插屏：0：插屏（默认） 1：全屏；原生： 0：信息流（默认） 1：draw
templateType	N	渲染方式，仅原生信息流支持此参数。	0：模板渲染（默认） 1：自渲染
isHiddenVoiceButton	N	音量控制按钮，仅ios支持此参数。注意插屏广告仅subType=0时支持。	0：显示（默认） 1：隐藏
adClickToCloseAutomatically	N	广告点击跳转后自动关闭，仅ios开屏、插屏支持此参数。注意插屏广告仅subType=0时支持。	0：否（默认） 1：是
openAdInBrowser	N	落地页跳转方式，仅android支持此参数。	0：系统浏览器 1：App内（默认）
nativeRenderType	N	模版广告大小。仅原生转开屏、原生转插屏支持该字段	0：全屏（仅开屏、插屏可用）(开屏默认) 1：半屏（仅插屏可用）（插屏默认）
nativeRenderOri	N	模版广告方向。仅原生转开屏、原生转插屏支持该字段	0：竖屏（默认） 1：横屏（仅插屏可用）
nativeTotalTime	N	倒计时时长。仅原生转开屏、原生转插屏支持该字段。开屏限制3-5s；插屏限制0-15s	5（默认）
nativeBtnStyle	N	下载/查看详情按钮样式。仅原生转开屏、原生转插屏支持该字段。	0：普通样式（默认） 1：光刀样式
nativeTemplateId	N	模板样式。仅原转开、原转插、原转banner支持该字段，且此时为必填	原生转插屏： 4012001 ：竖版方形； 4012002 ：竖版上图下文（小）； 4012003 ：竖版上图下文（中）。 4102001：横版方型。原生转开屏： 2002001：开屏全屏样式。原生转banner： 7002001：横幅样式
nativeSkipTime	N	播放至n秒可关闭。仅原生转插屏支持该字段。限制0-15s，默认5s	5（默认）
nativeIsAutoClose	N	倒计时结束自动关闭。仅原生转插屏支持该字段。 nativeSkipTime>0时有效	0：否（默认） 1：是
nativeEnableFullScreenClick	N	全广告区域可点击。仅原生转插屏、原生转banner支持该字段。	0：非全区域点击（默认） 1：全区域可点

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234"
  }
}

4.28 倍业

auth_content

Key	required	comment
urlAk	N	服务端bidding 密钥（使用服务端竞价时必填，否则可不传入）

| 样例

JSON

{
  "auth_content": {}
}

app_auth_content

Key	required	comment
appId	Y	应用 ID
apiKey	Y	应用 KEY

样例

JSON

{
  "app_auth_content": {
    "appId":"1234",
    "apiKey":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	广告位ID
templateType	N	渲染方式，仅原生支持此参数。	0：模板渲染（默认） 1：自渲染
autoPlayMuted	N	是否静音，仅原生自渲染支持此参数。	0：非静音 1：静音（默认）
canReceiveClickEvent	N	视频能否点击跳转，仅ios原生自渲染支持此参数。	0：否 1：是（默认）
playDirection	N	视屏幕方向，仅android激励、插屏支持此参数。	0：竖屏 1：横屏 2：跟随当前页面（默认）
autoPlayPolicy	N	自动播放视频，仅android原生自渲染支持此参数。	WIFI:仅WiFi网络； ALWAYS：总是（默认）； NEVER：不自动播放；
adSize	N	广告位尺寸比例，仅横幅支持此参数。	320x50 （默认）
nativeRenderType	N	模版广告大小。仅原生转开屏、原生转插屏支持该字段	0：全屏（仅开屏、插屏可用）(开屏默认) 1：半屏（仅插屏可用）（插屏默认）
nativeRenderOri	N	模版广告方向。仅原生转开屏、原生转插屏支持该字段	0：竖屏（默认） 1：横屏（仅插屏可用）
nativeTotalTime	N	倒计时时长。仅原生转开屏、原生转插屏支持该字段。开屏限制3-5s，插屏限制0-15s	5（默认）
nativeBtnStyle	N	下载/查看详情按钮样式。仅原生转开屏、原生转插屏支持该字段。	0：普通样式（默认） 1：光刀样式
nativeTemplateId	N	模板样式。仅原转开、原转插、原转banner支持该字段，且此时为必填	原生转插屏： 4012001 ：竖版方形； 4012002 ：竖版上图下文（小）； 4012003 ：竖版上图下文（中）。 4102001：横版方型。原生转开屏： 2002001：开屏全屏样式。原生转banner： 7002001：横幅样式
nativeSkipTime	N	播放至n秒可关闭。仅原生转插屏支持该字段。限制0-15s，默认5s	5（默认）
nativeIsAutoClose	N	倒计时结束自动关闭。仅原生转插屏支持该字段。 nativeSkipTime>0时有效	0：否（默认） 1：是
nativeEnableFullScreenClick	N	全广告区域可点击。仅原生转插屏、原生转banner支持该字段。	0：非全区域点击（默认） 1：全区域可点

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234"
  }
}

4.29 华为lite

auth_content

Key	required	comment
client_id	N	客户端ID
secretKey	N	SecretKey

以上内容，若需使用报表API功能则必填。

样例

JSON

{
  "auth_content": {
    "client_id":"12344",
    "secretKey":"121344"
  }
}

app_auth_content

无此级别参数，需要传入空

样例

JSON

{
  "app_auth_content": {}
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	代码位ID
autoPlayMuted	N	是否静音播放。 android仅插屏支持，默认是	0：否 1：是（默认）
autoPlayPolicy	N	视频自动播放。android仅插屏支持，默认WIFI	WIFI`（默认）`：仅Wi-Fi自动播放 ALWAYS：始终自动播放 NEVER：从不自动播放

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234"
  }
}

4.30 聚推

auth_content 无此级别参数，需要传入空

样例

JSON

{
  "auth_content": {}
}

app_auth_content

Key	required	comment
appId	Y	应用ID
appToken	Y	应用签名

样例

JSON

{
  "app_auth_content": {
    "appId":"1234",
    "appToken":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	代码位ID
templateType	N	渲染方式, 原生广告可用	1:自渲染（默认）

样例

JSON

{
  "source_auth_content": {
    "placementId": "1234",
    "templateType": 1
  }
}

4.31 旺脉

auth_content 无此级别参数，需要传入空

样例

JSON

{
  "auth_content": {}
}

app_auth_content

Key	required	comment
appToken	Y	appToken
appKey	Y	appKey
appId	N	微信小程序APPID
universalLink	N	微信小程序universalLink

样例

JSON

{
  "app_auth_content": {
    "appKey":"1234",
    "appToken":"1234",
    "appId":"1234",
    "universalLink":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	代码位ID
stayTime	N	开屏广告停留时长(s) , 开屏可用	整数，允许值 3-6，默认5
videoMuted	N	视频静音, 插屏/原生广告(自渲染)/原转可用	0：否 1：是（默认）
templateType	N	渲染方式, 原生广告可用	0：模版渲染（默认） 1：自渲染

样例

JSON

{
  "source_auth_content": {
    "placementId":"1234",
    "stayTime":5,
    "videoMuted":1,
    "templateType": 0
  }
}

4.32 泛为

auth_content 无此级别参数，需要传入空

样例

JSON

{
  "auth_content": {}
}

app_auth_content

Key	required	comment
apiKey	Y	appKey
appToken	Y	appSecret

样例

JSON

{
  "app_auth_content": {
    "apiKey":"1234",
    "appToken":"1234"
  }
}

source_auth_content

Key	required	comment	枚举值
placementId	Y	代码位ID
hideSkipButton	N	是否隐藏跳过按钮，开屏可用	1：是 0：否（默认）
templateType	N	渲染方式, 原生广告可用	0：模版渲染（默认） 1：自渲染

样例

JSON

{
  "source_auth_content": {
    "placementId": "1234",
    "hideSkipButton": 0,
    "templateType": 0
  }
}

5. 附录

5.1 操作系统枚举值

枚举值	comment
1	IOS
2	安卓
4	鸿蒙

5.2 是否是应用内竞价广告源（head_bidding_swith）枚举值

枚举值	comment
0	非应用内竞价广告源
1	应用内竞价广告源

5.3 应用内竞价模式(bidding_method ) 枚举值

此值请在第三方广告网络平台查看，若填写错误会导致无法加载广告。

枚举值	comment
0	服务端竞价
1	客户端竞价

5.4 广告位类型（ad_type）枚举值

枚举值	comment
1	激励视频
2	开屏广告
4	插屏广告
5	原生广告
7	横幅广告

5.5 流量分组规则说明

rules.type(规则类型)	comment	rules.rule(具体规则)	rules.content	value
1	应用版本名，多个值使用英文逗号分隔	0:排除 1:包含 3:大于 4:小于 5:介于	Array(String)	json `{ "type": 1, "rule": 1, "content": ["12321", "23322"] }`
2	SDK版本，多个值使用英文逗号分隔	0:排除 1:包含 3:大于 4:小于	Array(String)	json `{ "type":2, "rule":1, "content":["1","2","3","4"] }`
3	设备ID，多个值使用英文逗号分隔	0:排除 1:包含	Array(String)	json `{ "type":3, "rule":1, "content":["1","2","3","4"] }`
4	IDFA状态	9:等于	Integer,枚举值 0:无IDFA 1:有IDFA	json `{ "type":4, "rule":9, "content":0 }`
5	user_id，多个值使用英文逗号分隔	0:排除 1:包含	Array(String)	json `{ "type":5, "rule":1, "content":["123","3234"] }`
6	设备类型	0:排除 1:包含	Array(Integer)，枚举值 1:iPhone 2:iPad	json `{ "type":6, "rule":1, "content":[1, 2] }`
7	网络类型。多个值使用英文逗号分隔	0:排除 1:包含	Array(Integer) 2: 2G 3: 3G 4: 4G 5: 5G 100: Wi-Fi	json `{ "type":7, "rule":1, "content":[2,3,4,5] }`
8	地区。多个值使用英文逗号分隔	0:排除 1:包含	Object content.type(枚举值): 1:[全球] 2:[中国大陆]。地区值参考：国内地区码说明：国内地区输入值海外地区码说明：海外地区输入值	json `{ "type":8, "rule":1, "content":{ "type": 2, "content": ["AU", "CN"] } }`
10	渠道，多个值使用英文逗号分隔	0:排除 1:包含	Array(String)	json `{ "type":10, "rule":1, "content":["1","2","3","4"] }`
11	子渠道，多个值使用英文逗号分隔	0:排除 1:包含	Array(String)	json `{ "type":11, "rule":1, "content":["1","2","3","4"] }`
13	自定义规则	1:包含	Array(Obejct) content.key(String) content.rule(Integer)，枚举值：0不等于1:等于 content.content(String)	json `{ "type":13, "rule":1, "content":[ { "key": "12312", "rule": 1, "content": "12312" }, { "key": "21321232", "rule": 0, "content": "21321" } ] }`
14	安装时间	3:大于 4:小于	Object——time:整数；time_type:时间类型（1:小时，2:天，3:周，4:自然日）	json `{ "type": 14, "rule": 3, "content": { "time": 1, "time_type":2 } }`
15	操作系统版本	0:排除 1:包含 3:大于 4:小于	Array(String)	json `{ "type":15, "rule":1, "content":["1.0.0", "2.0.0"] }`
16	日期	0:排除 1:包含	Array(Object)	json `{ "rule": 1, "type": 16, "content": [{ "min": "2024-06-26 00:00", "max": "2024-07-03 23:59" }] }`
17	星期	0:排除 1:包含	Array(Integer)，枚举值：0:周日 1:周一 2:周二 3:周三 4:周四 5:周五 6:周六	json `{ "rule": 1, "type": 17, "content": [1] }`
18	星期	0:排除 1:包含	Array(Object)	json `{ "rule": 1, "type": 18, "content": [{ "min": "00:00", "max": "23:59" }] }`
19	设备品牌	0:排除 1:包含	Array(Integer)，枚举值： 360：360 iphone：苹果 htc：HTC iqoo：iQOO oppo：OPPO realme：Realme vivo：VIVO hisense：海信 redmi：红米 huawei：华为 gionee：金立 coolpad：酷派 lenovo：联想 meitu：美图 meizu：魅族 motorola：摩托罗拉 nubia：努比亚 nokia：诺基亚 honor：荣耀 samsung：三星 sugar：糖果 xiaomi：小米 oneplus：一加 realme：真我	json `Content 是 brand_key { "rule": 1, "content": ["hisense", "vivo", "iphone"], "type": 19 }`
20	时段	1:包含	Array(Integer)	更新后的投放时段，格式是48*7位字符串，且都是0或1。也就是以半个小时为最小粒度，周一至周日每天分为48个区段，0为不投放，1为投放，不传、全传0、全传1均代表全时段投放。 json [{ "rule": 1, "content": [ 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ], "type": 20 }]
21	应用版本号，即gameVersionCode，从安卓SDK v4.4.30开始支持，需要填写整数。多个值使用英文逗号分隔	0:排除 1:包含 3:大于 4:小于 5:介于	Array(Integer)	json `{ "type": 21, "rule": 1, "content": [12321, 23322] }`

5.6 广告网络枚举

渠道名	渠道id	支持的广告位类型	是否支持竞价
Mintegral	1	激励视频，开屏广告，插屏广告，原生广告，横幅广告	服务端竞价，客户端竞价
Vungle	4	激励视频，插屏广告，横幅广告	不支持
AppLovin	5	激励视频，插屏广告，横幅广告	不支持
Unity Ads	6	激励视频，插屏广告，横幅广告	不支持
ironSource	7	激励视频，插屏广告	不支持
Sigmob	9	激励视频，开屏广告，插屏广告，原生广告	无需输入此信息
AdMob	11	激励视频，插屏广告，横幅广告	不支持
穿山甲	13	激励视频，开屏广告，插屏广告，原生广告，横幅广告	不支持
腾讯广告	16	激励视频，开屏广告，插屏广告，原生广告，横幅广告	服务端竞价，客户端竞价
快手	19	激励视频，开屏广告，插屏广告，原生广告，横幅广告	服务端竞价，客户端竞价
百度联盟	21	激励视频，开屏广告，插屏广告，原生广告	客户端竞价
Gromore	22	激励视频，开屏广告，插屏广告，原生广告，横幅广告	客户端竞价
HUAWEI Ads Inner（原HUAWEI Ads）	25	激励视频，开屏广告，插屏广告，原生广告，横幅广告	不支持
AdScope	27	激励视频，开屏广告，插屏广告，原生广告	客户端竞价
趣盟广告	28	激励视频，开屏广告，插屏广告，原生广告	客户端竞价
TapADN	29	激励视频，开屏广告，插屏广告，原生广告	客户端竞价
Pangle	30	激励视频，开屏广告，插屏广告，原生广告	客户端竞价
Reklamup	33	激励视频，插屏广告，横幅广告	不支持
Oppo ADN	34	激励视频，开屏广告，插屏广告，原生广告，横幅广告	客户端竞价
美数	35	激励视频，开屏广告，插屏广告，原生广告，横幅广告	客户端竞价
荣耀	36	激励视频，开屏广告，插屏广告，原生广告，横幅广告	不支持
InMobi	37	激励视频，插屏广告，横幅广告	客户端竞价
Vivo Adn	38	激励视频，开屏广告，插屏广告，原生广告	客户端竞价
Billowlink	39	激励视频，开屏广告，插屏广告，原生广告	客户端竞价
京媒平台	40	开屏广告，原生广告	客户端竞价
章鱼	41	激励视频，开屏广告，插屏广告，原生广告，横幅广告	客户端竞价
倍业	42	激励视频，开屏广告，插屏广告，原生广告，横幅广告	服务端竞价，客户端竞价
聚推	47	激励视频，开屏广告，插屏广告，原生广告	客户端竞价
旺脉	48	激励视频，开屏广告，插屏广告，原生广告，横幅广告	客户端竞价
泛为	49	激励视频，开屏广告，插屏广告，原生广告，横幅广告	客户端竞价
HUAWEI Ads Lite	43	开屏广告，插屏广告	客户端竞价
ToBid ADX	999	开屏广告，原生广告	服务端竞价

5.7 不同广告位类型瀑布流属性

广告类型	数值	并行组	开屏请求超时时长	瀑布流请求总超时时长	单次并行请求超时时长	banner 自动刷新时间间隔
开屏	默认值	3	5	-	2	-
	取值范围	[1,10]	[1,15]	-	[1,5]	-
激励、插屏	默认值	3	-	45	3	-
	取值范围	[1,10]	-	[20,300]	[2,10]	-
原生	默认值	3	-	45	3	-
	取值范围	[1,10]	-	[2,300]	[2,10]	-
横幅广告	默认值	3	-	10	2	30
	取值范围	[1,10]	-	[2,30]	[2,10]	[5,180]

5.8 异常返回 Code 说明

Code	comment
51000000	记录不存在
50010002	参数错误，详情请看错误提示
51000003	操作非法
51080000	该广告网络账号已存在,请检查相关参数（名称重复）
51080001	该Report API 参数校验失败,请检查参数准确性
51080002	该Report API 已存在,请检查相关参数（ReportAPi参数重复）
51080002	该聚合广告位名称已存在，请更换新名称
51090002	该APP已绑定该渠道的广告网络账号，请勿重复绑定
51090003	已开启的流量分组上限为`{total}`组，请关闭无用分组后再次添加
51090004	聚合广告位下最多允许创建50个分组（开启和关闭),请删除无用分组后再次添加
51090005	ToBid 建议一个应用下仅`{total}`个聚合广告位，请删除闲置广告位后再尝试新建
51100002	该代码位已在聚合广告位：`{placement_name}({placement_code})` 中存在。请先解除绑定关系或添加新参数
51100003	广告源名称已在`{channel_name}`渠道存在
51100005	为保证最佳流量请求效果，ToBid 建议开启至多`{total}`个广告分层。当前广告已自动关闭
51090005	page 内容格式为:要查的页码 + ','(英文)+每页的数量(不大于 100)
51091000	暂无权限，请联系商务为您开通
51091001	ReportApi如果为1,auth_content必传
51091002	header_bidding_switch为1的时候price不可传
51091002	规则类型只能存在一个
51091003	默认分组不可添加规则
51091004	请正确填写Sigmob广告单元placmentId
51091005	`{channel_id}`不支持HB
51091006	`{channel_id}`的`{ad_type}`广告位类型不支持HB"
51091007	除Sigmob渠道外名字必传
51091008	该渠道不支持创建报表API状态为开通(reportapi_status=1)的广告网络账号
51091009	Sigmob与App应用参数不可操作平台自动创建
51091010	请选择竞价方式0:服务端竞价 1:客户端竞价
51091011	是否启用HB，一旦创建不可修改
51091012	Sigmob广告网络账号平台自动创建

ToBid 聚合管理 OpenAPI ​

修订历史 ​

v1版本签名算法,已弃用，建议升级，参见下一节1.接口请求说明V2 ​

v1版 Python签名示例 ​

v1版 Java请求示例 ​

1. 接口请求说明V2 ​

1.1 请求说明 ​

1.2 请求域名 ​

1.3请求头 ​

1.4 公共请求参数 ​

1.5 公共响应参数 ​

2. Demo示例 ​

2.1 Python 请求示例 ​

2.2 Java 请求示例 ​

2.3 Shell请求示例 ​

3. 聚合管理接口 ​

3.1 广告网络账号管理 ​

3.1.1 查询广告网络账号列表 ​

3.1.2 新建广告网络账号 ​

3.1.3 编辑广告网络账号 ​

3.2 应用管理 ​

3.2.1 查询已绑定应用列表 ​

3.2.2 将应用绑定到 ToBid 聚合 ​

3.3 管理应用聚合配置 ​

3.3.1 查询应用聚合配置 ​

3.3.2 新建应用聚合配置 ​

3.3.3 更新应用聚合配置 ​

3.4 广告位管理 ​

3.4.1 查询广告位列表 ​

3.4.2 新建广告位 ​

3.4.3 编辑广告位 ​

3.4.4 删除广告位 ​

3.5 分组管理 ​

3.5.1 查询分组列表 ​

3.5.2 新建分组 ​

3.5.3 编辑分组 ​

3.6 广告源管理 ​

3.6.1 广告源列表 ​

3.6.2 创建广告源 ​

3.6.3 编辑广告源 ​

3.6.4 删除广告源 ​

3.6.5 新建三方代码位和ToBid广告源 ​

3.7 瀑布流属性管理 ​

3.7.1 瀑布流属性编辑 ​

3.7.2 瀑布流属性查询 ​

3.8 瀑布流管理 ​

3.8.1 获取瀑布流信息 ​

3.8.2 修改广告源在瀑布流的属性 ​

4. 广告网络参数样例枚举 ​

4.1 Mintegral ​

4.2 AdMob ​

4.3 AdScope ​

4.4 Applovin ​

4.5 ironSource ​

4.6 UnityAds ​

4.7 Vungle ​

4.8 百度联盟 ​

4.9 穿山甲 ​

4.10 快手广告 ​

4.11 腾讯广告 ​

4.12 Sigmob ​

4.13 Gromore ​

4.14 华为inner（原华为） ​

4.15 趣盟 ​

4.16 TapADN ​

4.17 Pangle ​

4.18 Reklamup ​

4.19 Oppo ADN ​

4.20 美数 ​

4.21 荣耀 ​

4.22 inmobi ​

4.23 Vivo Adn ​

4.24 Billowlink ​

4.25 自定义渠道 ​

4.26 京媒平台 ​

4.27 章鱼 ​

4.28 倍业 ​

4.29 华为lite ​

4.30 聚推 ​

4.31 旺脉 ​

ToBid 聚合管理 OpenAPI

修订历史

v1版本签名算法,已弃用，建议升级，参见下一节1.接口请求说明V2

v1版 Python签名示例

v1版 Java请求示例

1. 接口请求说明V2

1.1 请求说明

1.2 请求域名

1.3请求头

1.4 公共请求参数

1.5 公共响应参数

2. Demo示例

2.1 Python 请求示例

2.2 Java 请求示例

2.3 Shell请求示例

3. 聚合管理接口

3.1 广告网络账号管理

3.1.1 查询广告网络账号列表

3.1.2 新建广告网络账号

3.1.3 编辑广告网络账号

3.2 应用管理

3.2.1 查询已绑定应用列表

3.2.2 将应用绑定到 ToBid 聚合

3.3 管理应用聚合配置

3.3.1 查询应用聚合配置

3.3.2 新建应用聚合配置

3.3.3 更新应用聚合配置

3.4 广告位管理

3.4.1 查询广告位列表

3.4.2 新建广告位

3.4.3 编辑广告位

3.4.4 删除广告位

3.5 分组管理

3.5.1 查询分组列表

3.5.2 新建分组

3.5.3 编辑分组

3.6 广告源管理

3.6.1 广告源列表

3.6.2 创建广告源

3.6.3 编辑广告源

3.6.4 删除广告源

3.6.5 新建三方代码位和ToBid广告源

3.7 瀑布流属性管理

3.7.1 瀑布流属性编辑

3.7.2 瀑布流属性查询

3.8 瀑布流管理

3.8.1 获取瀑布流信息

3.8.2 修改广告源在瀑布流的属性

4. 广告网络参数样例枚举

4.1 Mintegral

4.2 AdMob

4.3 AdScope

4.4 Applovin

4.5 ironSource

4.6 UnityAds

4.7 Vungle

4.8 百度联盟

4.9 穿山甲

4.10 快手广告

4.11 腾讯广告

4.12 Sigmob

4.13 Gromore

4.14 华为inner（原华为）

4.15 趣盟

4.16 TapADN

4.17 Pangle

4.18 Reklamup

4.19 Oppo ADN

4.20 美数

4.21 荣耀

4.22 inmobi

4.23 Vivo Adn

4.24 Billowlink

4.25 自定义渠道

4.26 京媒平台

4.27 章鱼

4.28 倍业

4.29 华为lite

4.30 聚推

4.31 旺脉