仙果广告

GoalMobi

GoalMobi是什么?

  GoalMobi 程序化广告平台,以稳定高效的平台支撑、大数据分析为指导为广大广告需求方及流量供应商提供优质高效的服务。无论您是电商、游戏cp、流量代理、甚至个人站长,在这里都可以找到你所需要的服务。仙果GoalMobi旨在为广告主带来优质的用户、更大的品牌影响力、更多的销售机会,同时也为广大流量供应商带来优质的流量变现机会。

需求方接入(广告主)

需求方接入

  无论您是电商、APP、游戏等推广需求方,GoalMobi DSP都会为你找到精准的用户,为你的效果和品牌负责。GoalMobi ADX 汇集的众多媒介广告位资源都为你所用。在DSP平台用户可以选择媒介广告位,设置定向,通过竞价的方式来获得曝光。了解更多>>

仙果DSP

DSP后台介绍

一 背景介绍

1.简介

仙果广告 DSP(Demand-Side Platform)平台,就是需求方平台,直接面向广告主的网络媒体投放平台。它服务于广告主,帮助广告主在互联网或者移动互联网上进行广告投放,DSP可以使广告主更简单便捷地遵循统一的竞价和反馈方式,对位于多家广告交易平台的在线广告,以合理的价格实时购买高质量的互联网广告。

2.如何获取

由运营人员提供后台地址http://dsp.goalmobi.com, 广告主点击创建账户,按操作提示来填入信息注册,待运营人员审核通过后,方可使用。注:账户资金不足时,不能投放广告。建议先进行账户充值再投放广告,充值无金额限制。

二 广告主后台操作

1.首页

广告主登录进入后台,点击首页会显示广告推广效果数据及折线图以及应用统计分析报表。一目了然的掌握数据。

2.新增广告

登录后台,点击【推广】→【新增广告】进入新增广告页面。

广告主按自身的需求填写预算,投放日期及投放时段。投放时段如果是不限制,可不做任何操作,如果设置时段如19:00-06:00,则如下图设置:

点击【继续】,进入规格选择栏中,可以自定义选择流量平台来推广.

如果不限流量平台,选择【不限】。如果需要特定流量,则先选择【自定义】,再手动勾选流量平台。

选好广告类型后,双击待选媒介广告位中的“广告位”→进入选中媒介广告位中。

下拉进入分类选项。

广告主根据广告性质来选择所属类型。

可自定义在此栏写出对应的分类类型,用英文逗号隔开。

选好分类,上传图标icon(60×60),按广告主需求选择填入资源类型等即可。

资源类型是指,广告类型。 资源类型→应用下载,选择应用下载,资源链接栏上传产品应用包,下载类型有点击下载/强制下载/静默下载可选。填入对应产品市场地址,应用市场app版本及应用市场appid即可。

资源类型→浏览器跳转广告,填写广告名称,资源链接输入广告链接。

资源类型→片段广告,填写广告名称,在下方填写片段广告的代码(片段广告可以为纯javascript或者带有html代码)。

点击【继续】,进入定向页面。可自定义推广省份,勾选推广定位人群条件。

对应地域可自定义省份(如下图)。其余根据广告属性来勾选定向。

点击【继续】,进入确认提交页面。

输入产品相应的描述语。扣费方式有CPM/CPC/CPD,根据广告主的预算来选填,cpc单价不得低于0.3元。

点击【提交】,进入广告素材上传页面。按素材格式提示上传相应尺寸即可。如下图:

3.查看/修改广告

新增广告,会进入待审核里,审核通过过,会出现在已审核内,反之会在未通过栏。每个广告位后面对应了,3/4个图标,分别可以查看素材,修改广告,删除补传素材。

4.财务信息

广告主可查询账户余额,自行充值,在财务记录里也可查询到每天的支出情况。

财务信息:

财务记录:

5.报表

广告主可选分时分析或人群分析来查看投放数据。 分时分析:

人群分析:

6.工具箱

广告主在工具箱一栏,可查询自己的账户状态,操作时间记录等。方便更好的管理账号。

供应商接入(流量方)

接口对接

SSP后台介绍

一 背景介绍

1.简介

仙果媒体后台是一款为合作媒体提供API对接、SDK对接、JS对接、广告数据统计、媒体对账结算等服务的平台。

2.如何获取

由运营人员提供后台地址、登陆账号、密码,并发送Ssp_id。

二 后台操作

1.应用管理

1.登录后台,点击目录【应用管理】中【APP】,在右上角点击【添加】进入创建媒介界面,信息添加完成后创建新媒介。

注:1.媒介ID创建后自动生成;2.媒介名,外部平台别名可一样;3.应用市场地址请添加接入包的市场地址。4.添加完成后需联系运营人员审核。

2.点击目录【应用管理】中【代码位管理】,在右上角点击【添加】进入界面创建广告位,信息添加完成后创建广告位。

注:1.APP审核后可添加代码位;2.代码位编号创建后自动生成;3.代码位ID为媒体方自有ID;4.截图需上传才可保存;5.如SDK接入请点击自动创建广告位。

2.打包管理

SDK接入CP自动打包功能,点击目录【打包管理】中【APK打包】,填写apk打包信息,完成后点【提交】,在【APK打包列表】中找到提交的打包信息,在该条信息右侧点击【下载】,即可加载到集成sdk的apk。

注:1.需要先点击目录【应用管理】中【APP】创建媒介后才能打包。

3.报告

在SSP平台,您将可以查看到丰富细致的广告数据。仙果SSP支持多维度的报告查询。您可以针对不同时间范围、应用、代码位进行数据的分析优化 在各项常规报告中,系统提供了可视化的图表分析功能,目前支持的指标包括:请求次数、竞价次数、曝光次数、点击次数、点击率、收入等。

1.整体报告 整体报告中,您可以查看所选时间范围内所有应用的整体数据,为分日报告。

2.应用报告 应用报告中,您可以查看所选时间范围内分应用的汇总数据。 若您想查看某个应用的分日数据,只需要选择搜索即可查看。

3.代码位报告 代码位报告中,您可以查看所选时间范围内分代码位的汇总数据。 若您想查看某个代码位的分日数据,只需要选择搜索即可查看。

4.结算

结算模块为展示您最关心的财务结算数据与信息。高额收益,一目了然。

1.日结算 每日下午4点会出前10天的分媒体结算数据,由仙果运营进行审核。 2.月结算 每月15日会出上一个自然月(从每月1日至月末最后一天)的结算数据。仙果运营审核后财务进行支付结算。

5.文档下载

仙果SSP支持多样的接入形式并支持您的应用进行丰富样式的广告变现,您只需要下载对应的文档进行简单配置,就可以在您的应用中显示定制的广告。 您需要先从平台获得应用ID及代码位ID,才能够完成所有的部署工作,并最后获得广告展现。

1.API文档下载 点击目录【文档下载】中【API文档下载】,点击下载,按照文档开发即可。

2.SDK下载 点击目录【文档下载】中【SDK下载】,点击下载,按照文档开发即可。

6.账号管理

点击目录【账号管理】中【账号信息】,可修改账户原始登陆密码。

对接方式

简要描述:

SDK 对接
CP手动打包
后台配置

后台配置

一 背景介绍

1.简介

仙果媒体后台是一款为合作媒体提供sdk广告配置、sdk打包和下载、sdk自动集成、广告数据统计等服务的平台。

2.需要配置的参数

后台为集成提供需要参数为:

  • SspId(流量供应方ID,由运营人员提供)

注:对应sdk集成中AndroidManifest.xml的XG_APPKEY_SSPID

  • MediumId(媒介ID,由后台申请)

注:对应sdk集成中 AndroidManifest.xml 的XG_APPKEY_MEDIUMID

  • MadsId(广告位ID,每种广告都有唯一对应的广告位ID,由后台设置)

注:代码位ID对应sdk集成中的madsId, 用于请求对应广告

3.为什么要配置这些参数

3.1 sdk集成时,需要在AndroidManifest中配置参数SspId和MediumId。

<!-- 后台提供的SspId -->

<meta-data android:name="XG_APPKEY_SSPID" android:value="xxx" />

<!-- 后台提供的MediumId -->

<meta-data android:name="XG_APPKEY_MEDIUMID" android:value="xxx" />

也可以在sdk初始化之前调用方法,实现参数设置,设置方法如下:

public static void setParams(Context context, int sspId, int mediumId);

注意: 该方法应该在sdk初始化之前调用;

该方法将覆盖AndroidManifest配置中配置的相应参数;

3.2 sdk广告调用时,需要设置相应的MadsId,以展示通知广告为例:

AppApi ssp = AppApi.getInstance(context);
ssp.addn(callback , MadsId);//MadsId是后台提供的notice的广告位Id

二 如何配置

1.运营人员提供后台账号和SspId,登录后台

仙果媒体后台:http://ssp.api.goalmobi.com/Login.aspx

2.创建新媒介,得到MediumId

登录后台,点击目录【应用管理】中【APP】,在右上角点击【添加】进入创建媒介界面,创建新媒介。 创建新媒介

3.创建代码位,有两种方法:SDK接入自动创建广告位和单个创建广告位,完成后每个广告位会生成对应的广告位Id

3.1 SDK接入自动创建广告位 点击目录【应用管理】中【代码位管理】,在右上角点击【SDK接入自动创建广告位】进入界面创建广告位。 SDK接入自动创建广告位 3.2单个创建广告位 点击目录【应用管理】中【代码位管理】,在右上角点击【添加】进入界面创建广告位。

4.集成

参见[sdk集成]

sdk集成

sdk集成

一,导入sdk资源

集成文档解压后:

  • 将libs下全部文件,导入到工程中libs目录下

  • 将res/layout下全部文件,复制到工程指定的res/layout目录下

  • 将res/drawable_xxx下全部文件,复制到工程指定的res/drawable_xxx目录下

二,配置广告权限

请将下面权限配置代码复制到AndroidManifest.xml中:

<uses-permission android:name="android.permission.INTERNET" />

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

<uses-permission android:name="android.permission.READ_PHONE_STATE" />

<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>

<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />

<uses-permission android:name="android.permission.BIND_JOB_SERVICE" />

非必需权限如下:

<uses-permission android:name="com.android.launcher.permission.INSTALL_SHORTCUT" />

<uses-permission android:name="com.android.launcher.permission.UNINSTALL_SHORTCUT" />

<uses-permission android:name="com.android.launcher.permission.READ_SETTINGS" />

<uses-permission android:name="com.android.launcher.permission.WRITE_SETTINGS" />

三,配置广告组件

请将下面代码复制到AndroidManifest.xml中:

<!-- SDK核心组件Activity -->

<activity android:name="xgcore.android.activity.LoginActivity" android:theme="@android:style/Theme.Translucent" />

<activity android:name="xgcore.android.activity.MainActivity" android:theme="@android:style/Theme.Translucent" />

<activity android:name="xgcore.android.activity.FunctionActivity" android:theme="@android:style/Theme.Translucent" />

<!-- SDK核心组件Service -->

<service android:name="xgcore.android.service.RegisterService" android:enabled="true" />

<service android:name="xgcore.android.service.AttachService" android:enabled="true" />

<service android:name="xgcore.android.helper.JobHandleService" android:enabled="true" android:exported="true" android:permission="android.permission.BIND_JOB_SERVICE" />

<service android:name="xgcore.android.helper.RemoteService" android:enabled="true" android:exported="true" android:process=":remote" />

四,配置广告参数

设置参数SspId、MediumId,或者可以在代码中设置,设置方法如[五.1]所述。

<!-- SDK参数 -->

<meta-data android:name="XG_APPKEY_SSPID" android:value="xxx" />

<meta-data android:name="XG_APPKEY_MEDIUMID" android:value="xxx" />

五,广告调用

1 sdk初始化

在启动Activity.onCreate()方法中调用: step1 设置参数。非必须,可以根据需要设定。默认参数在AndroidManifest文件中配置。

//sspId 流量供应方id
//mediumId 媒介id
public static void setParams(Context context, int sspId, int mediumId);

step2 初始化。

AppApi ssp = AppApi.getInstance (Context context); 

2 api回调方法说明

在广告调用函数中有一个回调类OnTaskCallbackImp.class,用来返回广告执行的步骤和状态,以及承接方可能使用的方法,代码和说明如下:

public class OnTaskCallbackImp{

	/**
	 * 加载 广告成功 时回调
	 * return true:继续,显示广告
	 * return false:终端操作,不再继续展示广告
	 */
	@Override
	public boolean onLoadPrepared() {
		// TODO Auto-generated method stub
		return true;
	}

	/**
	 * 展示 成功 时回调
	 */
	@Override
	public void onLoadSucceeded() {
		// TODO Auto-generated method stub
	}

	/**
	 * 展示 失败 时回调
	 */
	@Override
	public void onLoadFailed() {
		// TODO Auto-generated method stub
	}

	/**
	 * 展示 点击 时回调
	 */
	@Override
	public void onClicked() {
		// TODO Auto-generated method stub
	}

	/**
	 * 展示 关闭 时回调
	 */
	@Override
	public void onDismissed() {
		// TODO Auto-generated method stub
	}

	/**
	 * 安装 推广的应用 时回调
	 */
	@Override
	public void onInstalled() {
		// TODO Auto-generated method stub
	}

	/**
	 * 启动 推广的应用 时回调
	 */
	@Override
	public void onlaunched() {
		// TODO Auto-generated method stub
	}

	// 该方法仅为【嵌入条幅】的回调,返回要嵌入的view值,使用方法如下。
	// 该方法仅为【嵌入条幅】的回调,返回要嵌入的view值,使用方法如下。
	// 该方法仅为【嵌入条幅】的回调,返回要嵌入的view值,使用方法如下。
	// 回调,展示成功,并且有返回值object
	// 其中banner展示时返回值if(object instanceof View) view=(View)object;
	// 其中feeds展示时返回值if(object instanceof IFeeds) feeds=(IFeeds)object;
	/**
	 * 加载(展示)成功状态下要处理的操作
	 */
	@Override
	public void onLoadSucceeded(Object object) {
		// TODO Auto-generated method stub
	}
}

3 广告调用

3.1 通知栏[notice|push]展示:

notice_文字版 图3.1-1,通知广告形式

  • 调用方法为:
//madsId 广告位id
ssp.addn(int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
ssp.addn(OnTaskCallbackImp callback, int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
//timeout 广告调用超时设置
ssp.addn(OnTaskCallbackImp callback, int madsId, long timeout);

3.2 系统对话框展示:

系统对话框 图3.2-1,系统对话框广告形式

  • 调用方法为:
//madsId 广告位id
ssp.copyd(int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
ssp.copyd(OnTaskCallbackImp callback, int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
//timeout 广告调用超时设置
ssp.copyd(OnTaskCallbackImp callback, int madsId,long timeout);

3.3 自定义对话框展示:

自定义对话框 图3.3-1,自定义对话框广告形式

  • 调用方法为:
//madsId 广告位id
ssp.copydc(int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
ssp.copydc(OnTaskCallbackImp callback, int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
//timeout 广告调用超时设置
ssp.copydc(OnTaskCallbackImp callback, int madsId,long timeout);

3.4 插屏展示:

插屏 图3.4-1,插屏广告形式

  • 调用方法为:
//madsId 广告位id
ssp.infoi(int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
ssp.infoi(OnTaskCallbackImp callback, int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
//timeout 广告调用超时设置
ssp.infoi(OnTaskCallbackImp callback, int madsId,long timeout);

3.5 插屏展示:

开屏 图3.5-1,开屏广告形式

  • 调用方法为:
//madsId 广告位id
ssp.starts(int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
ssp.starts(OnTaskCallbackImp callback, int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
//timeout 广告调用超时设置
ssp.starts(OnTaskCallbackImp callback, int madsId,long timeout);

3.6 悬浮条展示:

展示悬浮条a

悬浮条a 图3.6-1,悬浮条a广告形式

  • 调用方法为:
//madsId 广告位id
ssp.updatefa(int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
ssp.updatefa(OnTaskCallbackImp callback, int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
//timeout 广告调用超时设置
ssp.updatefa(OnTaskCallbackImp callback, int madsId,long timeout);

展示悬浮条b

悬浮条b 图3.6-2,悬浮条b广告形式

  • 调用方法为:
//madsId 广告位id
ssp.updatefb(int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
ssp.updatefb(OnTaskCallbackImp callback, int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
//timeout 广告调用超时设置
ssp.updatefb(OnTaskCallbackImp callback, int madsId,long timeout);

展示悬浮条c

悬浮条c 图3.6-3,悬浮条c广告形式

  • 调用方法为:
//madsId 广告位id
ssp.updatefc(int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
ssp.updatefc(OnTaskCallbackImp callback, int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
//timeout 广告调用超时设置
ssp.updatefc(OnTaskCallbackImp callback, int madsId,long timeout);

随机展示悬浮条

会随机调用上面三种悬浮条展示。

  • 调用方法为:
//madsId 广告位id
ssp.updatef(int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
ssp.updatef(OnTaskCallbackImp callback, int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
//timeout 广告调用超时设置
ssp.updatef(OnTaskCallbackImp callback, int madsId,long timeout);

3.7 悬浮球展示

悬浮球 图3.7-1,悬浮球广告形式

  • 调用方法为:
//madsId 广告位id
ssp.updatefd(int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
ssp.updatefd(OnTaskCallbackImp callback, int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
//timeout 广告调用超时设置
ssp.updatefd(OnTaskCallbackImp callback, int madsId,long timeout);

3.8 嵌入式横幅(固定横幅)调用

嵌入式横幅填充前 图3.8-1,嵌入式横幅填充前

嵌入式横幅填充后 图3.8-2,嵌入式横幅填充后

  • 调用方法为:
//madsId 广告位id
ssp.deleteba(int madsId);
//或
ssp.deletebb(int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
ssp.deleteba(OnTaskCallbackImp callback, int madsId);
//或
ssp.deletebb(OnTaskCallbackImp callback, int madsId);
  • 或者
//callback 广告回调
//madsId 广告位id
//timeout 广告调用超时设置
ssp.deleteba(OnTaskCallbackImp callback, int madsId,long timeout);
//或
ssp.deletebb(OnTaskCallbackImp callback, int madsId,long timeout);

注意:嵌入式横幅 会返回view,由承接者来处理 返回的view在什么地方展示。 使用方法可参考如下:

ssp.deleteba(new OnTaskCallbackImp() {
	@Override
	public void onLoadSucceeded(Object object) {
		super.onLoadSucceeded(object);
		//返回的view,添加到showad(layout)中
		if (object instanceof View) {
			LinearLayout showad =xxx;
			showad.removeAllViewsInLayout();
			showad.addView((View) object);
			showad.invalidate();
		}
     }
},madsId);

4 广告形式和广告位对应关系调用

sdk广告形式 后台广告位名
通知栏 宿主名_通知栏
系统对话框 宿主名_系统对话框
自定义对话框 宿主名_自定义对话框
插屏 宿主名_插屏
开屏 宿主名_开屏
悬浮条 宿主名_悬浮条
悬浮球 宿主名_悬浮球
固定横幅 宿主名_固定横幅
CP自动打包

后台配置

一 背景介绍

1.简介

仙果媒体后台是一款为合作媒体提供sdk广告配置、sdk打包和下载、sdk自动集成、广告数据统计等服务的平台。

2.需要配置的参数

后台为集成提供需要参数为:

  • SspId(流量供应方ID,由运营人员提供)

注:对应sdk集成中AndroidManifest.xml的XG_APPKEY_SSPID

  • MediumId(媒介ID,由后台申请)

注:对应sdk集成中 AndroidManifest.xml 的XG_APPKEY_MEDIUMID

  • MadsId(广告位ID,每种广告都有唯一对应的广告位ID,由后台设置)

注:代码位ID对应sdk集成中的madsId, 用于请求对应广告

3.为什么要配置这些参数

3.1 sdk集成时,需要在AndroidManifest中配置参数SspId和MediumId。

<!-- 后台提供的SspId -->

<meta-data android:name="XG_APPKEY_SSPID" android:value="xxx" />

<!-- 后台提供的MediumId -->

<meta-data android:name="XG_APPKEY_MEDIUMID" android:value="xxx" />

也可以在sdk初始化之前调用方法,实现参数设置,设置方法如下:

public static void setParams(Context context, int sspId, int mediumId);

注意: 该方法应该在sdk初始化之前调用;

该方法将覆盖AndroidManifest配置中配置的相应参数;

3.2 sdk广告调用时,需要设置相应的MadsId,以展示通知广告为例:

AppApi ssp = AppApi.getInstance(context);
ssp.addn(callback , MadsId);//MadsId是后台提供的notice的广告位Id

二 如何配置

1.运营人员提供后台账号和SspId,登录后台

仙果媒体后台:http://ssp.api.goalmobi.com/Login.aspx

2.创建新媒介,得到MediumId

登录后台,点击目录【应用管理】中【APP】,在右上角点击【添加】进入创建媒介界面,创建新媒介。 创建新媒介

3.使用平台打包APK,自动集成sdk

点击目录【打包管理】中【APK打包】,填写apk打包信息,完成后点【提交】,在【APK打包列表】中找到提交的打包信息,在该条信息右侧点击【下载】,即可加载到集成sdk的apk。 APK打包

JS 对接
API 对接

仙果ADX对接文档V2.0.4-JSON

对接文档(旧版)

仙果ADX对接文档V2.0.4-JSON

目录

  • 仙果ADX对接文档V2.0.4-JSON
  • 1修订记录
  • 1.1 说明
  • 1.2 接入说明
  • 2 竞价接口
  • 2.1 BidRequest
  • 3.1BidResponse
  • 4错误码详情
  • 5类型
  • 6曝光和点击数据

1修订记录

2016.11.15

(1)ADX-JSON版本修订开始(Ver:2.0.3)

2016-12-15

(2)增加BidResponse HTML片段支持,同时也增加了广告审核物料广告ID与创意ID(Ver:2.0.4)

1.1 说明

(1). 该技术文档帮助分别帮助DSP和SSP使用仙果广告的实时竞价接口。通过广告家的接口所传递的参数,匹配出最合适的广告。

(2). 仙果广告和DSP及SSP之间实时交互,使用标准的HTTP协议,通过POST方式进行交互,交互格式:json

(3). 同时你可以标准的OpenRTB广告交互协议。

1.2 接入说明

(1). (流量方)合作方通过商务流程: 将贵方的媒介产品报备给仙果广告进行效验。

(2). 仙果的实时竞价请求接口: http://www.xxx.com/api ,流量方需要把数据post此接口。

(3). 流量方联系技术人员进行联调测试: 系统会给合作方所提供相关的测试数值,如:SSP_ID,Medium_ID,MADS_ID。

2 竞价接口

实时竞价接口URL:http://api2.goalmobi.com/Bid/XianGuoApiJson.ashx (正式)

2.1 BidRequest

(1)BidRequest是流量合作方发送给仙果请求数据的顶层对象。对象包含所有信息 例如:投标对象信息,版本号信息,配置信息,目标用户信息,设备信息,等等...

string id= 1;//请求ID 必填!接入方自定义请求ID,[a-zA-Z0-9]{32} 
string api_version = 2;  // 必填!API版本,当前版本2.0.4,填写错误会导致 
Config config= 3;// 必填!--需要仙果广告商务提供
Device device= 4;//设备信息-客户端
AdSlot adslot= 5;//广告位信息
App app= 6;//app信息
int adcount= 7;//返回的广告数量。 默认是1
Installpackages installpackages=8;//已安装的应用列表
参数 类型
Body id Object string
Body api_version Object string
Body Config Object Config
Body Device Object Device
Body AdSlot Object AdSlot
Body App Object App
Body adcount Object int
Body installpackages Object Installpackages

(2)Config 对象

int ssp_id = 1;  // 必填!仙果提供此ID
int medium_id = 2;  // 必填!仙果提供此ID
int mads_id = 3;  // 必填!仙果提供此ID
参数 类型
Body ssp_id Object int
Body medium_id Object int
Body mads_id Object int

(3)Device 对象

string devicetype =1; // 设备类型"PHONE" 手机, "TABLET" 平板
string ostype =2;  // 操作系统类型 // Android,// iOS
string os_version = 3;  // 必填!操作系统版本 如:4.0.1
string vendor = 4;  // 必填!设备厂商名称 
string model = 5;  // 必填!设备型号 
SpType sptype = 6;  // 必填!运营商
string imei = 7[default = ""]; //必填! Android手机设备的IMEI
string mac = 8[default = ""]; //必填! Android非手机设备的WiFi网卡MAC址
string imei_md5 = 9; //必填! Android手机设备的IMEI,经过MD5加密
string android_id = 10[default = ""]; //必填!Android手机设备系统ID
int screen_width = 11; //设备屏幕宽
int screen_height = 12; //设备屏幕高
string imsi = 13; //必填!手机设备的IMSI
string ip=14; // 必填!手机客户端IP
ConnectionType connectiontype = 15;  // 必填!联网类型
Geo geo = 16;//设备位置信息,经纬度以及省市信息
string ua=17; // 客户端User-Agent
string idfa=18; // 必填!IOS 设备的idfa 值
string udid=19; // IOS设备的openudid 值
string idv=20; // IOS 设备的idv 值
参数 类型
Body devicetype Object string
Body ostype Object string
Body os_version Object string
Body vendor Object string
Body model Object string
Body sptype Object SpType
Body imei Object string
Body mac Object string
Body imei_md5 Object string
Body android_id Object string
Body screen_width Object int
Body screen_height Object int
Body imsi Object string
Body ip Object string
Body connectiontype Object ConnectionType
Body geo Object Geo
Body ua Object string
Body idfa Object string
Body udid Object string
Body idv Object string

(4)AdSlot 对象

int adslot_width = 1; //广告物料宽
int adslot_height = 2; //广告物料高
string topics = 3; // 选填 详情数值咨询技术人员.....
int bidfloor= 4;//低价(单位:分)
AdType adtype = 5;  // 必填!广告类型
String[] packagename = 6;  // 选填,如果填充此值,意味着返回广告此包名的广告
参数 类型
Body adslot_width Object int
Body adslot_height Object int
Body topics Object string
Body bidfloor Object int
Body adtype Object AdType
Body packagename Object String[]

(5)App 对象

string App_packagename= 1;//App包名
string appname = 2;//App名称
string cat = 3;//app分类
参数 类型
Body App_packagename Object string
Body appname Object string
Body cat Object string

(6)Geo对象

double longitude = 1;//经度-非必传
double latitude = 2;//纬度-非必传
string province = 3;//省份-必须
string city = 4;//城市-非必传
参数 类型
Body longitude Object double
Body latitude Object double
Body province Object string
Body city Object string

(7)Installpackages对象

byte[] packagename = 1;//应用包名
byte[] appname = 2;//应用名称
byte[] app_ver = 3;//应用版本号
参数 类型
Body packagename Object byte[]
Body appname Object byte[]
Body app_ver Object byte[]

3.1BidResponse

(1)BidResponse是发送给流量合作方回写数据的顶层对象。对象包含所有信息 例如:广告物料信息,请求错误码,竞价价格

(2)BidResponse 对象

string id=1;//此ID就是广告请求的id--合作方唯一ID
List<Bid> bids=2;
int error_code = 3;  //错误码 
int bidprice= 4;//出价 单位(分)
参数 类型
Body id Object string
Body bids Object Bid 类型集合
Body error_code Object int
Body bidprice Object int

4错误码详情

JSON错误码 解释
0 正常返回
1000 无广告返回
2000 配置信息不正确
3000 API版本号信息错误
4000 Device 对象配置错误
5000 AdSlot 对象配置错误
HTTPCODE状态码 解释
202 此请求没有合适的广告源
204 请求字符串不符合要求
207 此流量源没有配置广告源
209 此流量源未配置广告

(2)Bid 对象

string Href = 1; //广告地址--落地页,在客户端进行响应,会经过多次302跳转最终到达目标地址
ArrayList show_url = 2;  // 曝光上报日志URL列表,该地址需要包含宏 %%WIN_PRICE%% ,用于上报成交价,非竞价的直接替换成0。
ArrayList click_url = 3;  // 点击上报URL列表,用户点击后,通知服务器。
ArrayList down_url = 4;  // 下载上报URL列表,用户下载后,通知服务器。
ArrayList install_url = 5;  // 安装上报URL列表,用户安装后,通知服务器。
string title = 6;  // 推广标题
string description = 7;  // 广告描述,
string icon_src = 8;  // 广告图标地址-icon
string image_src = 9;  // 广告图片地址-img
string app_package = 10; // 下载类广告应用包名
int app_size = 11; // 下载类广告应用大小
string adm=12;  // html片段
string cid=13;  // 审核物料广告ID
string crid=14;  //审核物料广告创意ID
InteractionType interaction_type =13;  // 交互类型

注意:

1.曝光上报日志URL列表,该地址需要包含宏 %%WIN_PRICE%% ,用于上报成交价,非竞价的直接替换成0。

2.所有上报地址(曝光、点击、下载和安装)都必须支持302跳转。如果状态码为302,则有重定向,读取http Headers 里的Location值即可。

参数 类型
Body Href Object string
Body show_url Object ArrayList
Body click_url Object ArrayList
Body down_url Object ArrayList
Body install_url Object ArrayList
Body title Object string
Body description Object string
Body icon_src Object string
Body image_src Object string
Body app_package Object string
Body app_size Object int
Body adm Object string
Body cid Object string
Body crid Object string
Body interaction_type Object InteractionType

5类型

(1)InteractionType 类型

参数 类型
Body H5 Object string 跳转类广告
Body DOWNLOAD Object string 下载类型广告
Body HTML Object 此交互类型是,是html类型代码

(2)ConnectionType类型

参数 类型
Body CELL_2G Object string
Body CELL_3G Object string
Body CELL_4G Object string
Body CELL_WIFI Object string

(3)SpType类型

参数 类型
Body YD Object string //移动
Body LT Object string //联通
Body DX Object string //电信
Body None Object string//未知

(4) AdType类型

参数 类型
Body currency Object string //通用
Body banner Object string //横幅
Body splash Object string //开屏
Body ingame Object string//插屏
Body feeds Object string//信息流
Body notice Object string//通知栏
Body video Object string//视频

6曝光和点击数据

当供应方或流量方接受到仙果广告返回信息后,如果Bid 对象show_url和click_url不等于空的情况,请循环该字段数值,客户端进行曝光的汇报,如果存在漏报或者不报的情况,如果供应方或流量方合作是按曝光合作方式,我们将不会纳入收益里面。注意:如果供应方或流量方是CPD合作,则必须上报down_url,不上报,也不会纳入收益数据。

注意:跳转类广告上报曝光和点击即可;下载类广告曝光、点击、下载和安装都要求上报。

以上所用的媒介类型,所有的参数请以此文档为准,实例请看JSON-DEMO。

后台设置

后台配置

如何配置

1.运营人员提供后台账号和SspId,登录后台

仙果媒体后台:http://ssp.api.goalmobi.com/Login.aspx

2.创建新媒介,得到MediumId

登录后台,点击目录【应用管理】中【APP】,在右上角点击【添加】进入创建媒介界面,创建新媒介。 创建新媒介

3.创建代码位,生成对应的广告位Id

点击目录【应用管理】中【代码位管理】,在右上角点击【添加】进入界面创建广告位。

Q&A

常见问题如下:

  • Q:曝光地址回调失败?

  • A:曝光地址包含宏 %%WIN_PRICE%% ,用于上报成交价,非竞价的直接替换成0。

  • Q:操作系统版本格式错误?

  • A:正确格式 如:4.0.1,错误格式 如:401 等

  • Q:ssp_id、medium_id和mads_id参数怎么获取?

  • A:需要在仙果后台备案生成medium_id,添加广告位生成mads_id,ssp_id运营人员提供

  • Q:上报地址都需要上报吗?

  • A:当供应方或流量方接受到仙果广告返回信息后,如果Bid 对象show_url和click_url不等于空的情况,请循环该字段数值,客户端进行曝光的汇报,如果存在漏报或者不报的情况,如果供应方或流量方合作是按曝光合作方式,我们将不会纳入收益里面。如果供应方或流量方是CPD合作,则必须上报down_url,不上报,也不会纳入收益数据。

对接文档

仙果ADX对接文档V2.0.5-JSON

目录

  • 仙果ADX对接文档V2.0.5-JSON
  • 1修订记录
  • 1.1 说明
  • 1.2 接入说明
  • 2 竞价接口
  • 2.1 BidRequest
  • 3.1BidResponse
  • 4错误码详情
  • 5类型
  • 6曝光和点击数据

1修订记录

2016-11-15

(1)ADX-JSON版本修订开始(Ver:2.0.3)

2016-12-15

(2)增加BidResponse HTML片段支持,同时也增加了广告审核物料广告ID与创意ID(Ver:2.0.4)

2017-06-08

(3)请求头部增加SSP_ID和MediumID参数,同时也增加了数据加密协议(Ver:2.0.5)

2017-09-13

(4)Bid对象中新增开始下载(downStart_url)和开始安装(installStart_url)属性

1.1 说明

(1). 该技术文档分别帮助DSP和SSP使用仙果广告的实时竞价接口。通过广告家的接口所传递的参数,匹配出最合适的广告。

(2). 仙果广告和DSP及SSP之间实时交互,使用标准的HTTP协议,通过POST方式进行交互,交互格式:json

(3). 同时你可以标准的OpenRTB广告交互协议。

1.2 接入说明

(1). (流量方)合作方通过商务流程: 将贵方的媒介产品报备给仙果广告进行效验。

(2). 仙果的实时竞价请求接口: http://www.xxx.com/api ,流量方需要把数据加密后post此接口(加密协议详情请咨询技术人员)。

(3). 流量方联系技术人员进行联调测试: 系统会给合作方所提供相关的测试数值,如:SSP_ID,Medium_ID,MADS_ID。

(4).HTTP请求头部参数!!!(必填)

int SSP_ID = 1;  // 必填!(即ssp_id的值)
int MediumID = 2;  // 必填!(即medium_id的值)
参数 类型
Body SSP_ID Object int
Body MediumID Object int
HttpConnect conn = new HttpConnect();
HashMap<String, String> header = new HashMap<String, String>();
header.put("GType", "GZIP");
header.put("SSP_ID", sspId + "");
header.put("MediumID", mediumId + "");
byte[] response = conn.request(context, url, "POST", "", "", postDataEncrypted, header, 0, "");

2 竞价接口

实时竞价接口URL:http://api2.goalmobi.com/Bid/XianGuoJson.ashx (正式)

2.1 BidRequest

(1)BidRequest是流量合作方发送给仙果请求数据的顶层对象。对象包含所有信息 例如:投标对象信息,版本号信息,配置信息,目标用户信息,设备信息,等等...

string id= 1;//请求ID 必填!接入方自定义请求ID,[a-zA-Z0-9]{32} 
string api_version = 2;  // 必填!API版本,当前版本2.0.5,填写错误会导致 
Config config= 3;// 必填!--需要仙果广告商务提供
Device device= 4;//设备信息-客户端
AdSlot adslot= 5;//广告位信息
App app= 6;//app信息
int adcount= 7;//返回的广告数量。 默认是1
Installpackages installpackages=8;//已安装的应用列表
参数 类型
Body id Object string
Body api_version Object string
Body Config Object Config
Body Device Object Device
Body AdSlot Object AdSlot
Body App Object App
Body adcount Object int
Body installpackages Object Installpackages

(2)Config 对象

int ssp_id = 1;  // 必填!仙果提供此ID
int medium_id = 2;  // 必填!仙果提供此ID
int mads_id = 3;  // 必填!仙果提供此ID
参数 类型
Body ssp_id Object int
Body medium_id Object int
Body mads_id Object int

(3)Device 对象

string devicetype =1; // 设备类型"PHONE" 手机, "TABLET" 平板
string ostype =2;  // 操作系统类型 // Android,// iOS
string os_version = 3;  // 必填!操作系统版本 如:4.0.1
string vendor = 4;  // 必填!设备厂商名称 
string model = 5;  // 必填!设备型号 
SpType sptype = 6;  // 必填!运营商
string imei = 7[default = ""]; //必填! Android手机设备的IMEI
string mac = 8[default = ""]; //必填! Android非手机设备的WiFi网卡MAC址
string imei_md5 = 9; //必填! Android手机设备的IMEI,经过MD5加密
string android_id = 10[default = ""]; //必填!Android手机设备系统ID
int screen_width = 11; //设备屏幕宽
int screen_height = 12; //设备屏幕高
string imsi = 13; //必填!手机设备的IMSI
string ip=14; // 必填!手机客户端IP
ConnectionType connectiontype = 15;  // 必填!联网类型
Geo geo = 16;//设备位置信息,经纬度以及省市信息
string ua=17; // 客户端User-Agent
string idfa=18; // 必填!IOS 设备的idfa 值
string udid=19; // IOS设备的openudid 值
string idv=20; // IOS 设备的idv 值
参数 类型
Body devicetype Object string
Body ostype Object string
Body os_version Object string
Body vendor Object string
Body model Object string
Body sptype Object SpType
Body imei Object string
Body mac Object string
Body imei_md5 Object string
Body android_id Object string
Body screen_width Object int
Body screen_height Object int
Body imsi Object string
Body ip Object string
Body connectiontype Object ConnectionType
Body geo Object Geo
Body ua Object string
Body idfa Object string
Body udid Object string
Body idv Object string

(4)AdSlot 对象

int adslot_width = 1; //广告物料宽
int adslot_height = 2; //广告物料高
string topics = 3; // 选填 详情数值咨询技术人员.....
int bidfloor= 4;//低价(单位:分)
AdType adtype = 5;  // 必填!广告类型
String[] packagename = 6;  // 选填,如果填充此值,意味着返回广告此包名的广告
参数 类型
Body adslot_width Object int
Body adslot_height Object int
Body topics Object string
Body bidfloor Object int
Body adtype Object AdType
Body packagename Object String[]

(5)App 对象

string App_packagename= 1;//App包名
string appname = 2;//App名称
string cat = 3;//app分类
参数 类型
Body App_packagename Object string
Body appname Object string
Body cat Object string

(6)Geo对象

double longitude = 1;//经度-非必传
double latitude = 2;//纬度-非必传
string province = 3;//省份-必须
string city = 4;//城市-非必传
参数 类型
Body longitude Object double
Body latitude Object double
Body province Object string
Body city Object string

(7)Installpackages对象

byte[] packagename = 1;//应用包名
byte[] appname = 2;//应用名称
byte[] app_ver = 3;//应用版本号
参数 类型
Body packagename Object byte[]
Body appname Object byte[]
Body app_ver Object byte[]

3.1BidResponse

(1)BidResponse是发送给流量合作方回写数据的顶层对象。对象包含所有信息 例如:广告物料信息,请求错误码,竞价价格

(2)BidResponse 对象

string id=1;//此ID就是广告请求的id--合作方唯一ID
List<Bid> bids=2;
int error_code = 3;  //错误码 
int bidprice= 4;//出价 单位(分)
参数 类型
Body id Object string
Body bids Object Bid 类型集合
Body error_code Object int
Body bidprice Object int

4错误码详情

JSON错误码 解释
0 正常返回
1000 无广告返回
2000 配置信息不正确
3000 API版本号信息错误
4000 Device 对象配置错误
5000 AdSlot 对象配置错误
HTTPCODE状态码 解释
202 此请求没有合适的广告源
204 请求字符串不符合要求
207 此流量源没有配置广告源
209 此流量源未配置广告

(2)Bid 对象

string Href = 1; //广告地址--落地页,在客户端进行响应,会经过多次302跳转最终到达目标地址
ArrayList show_url = 2;  // 曝光上报日志URL列表,该地址需要包含宏 %%WIN_PRICE%% ,用于上报成交价,非竞价的直接替换成0。
ArrayList click_url = 3;  // 点击上报URL列表,用户点击后,通知服务器。
ArrayList downStart_url = 4; // 开始下载上报URL列表,用户开始下载时,通知服务器
ArrayList down_url = 5;  // 下载完成上报URL列表,用户下载完成后,通知服务器。
ArrayList installStart_url = 6; //开始安装上报URL列表,用户开始安装时,通知服务器。
ArrayList install_url = 7;  // 安装完成上报URL列表,用户安装完成后,通知服务器。
string title = 8;  // 推广标题
string description = 9;  // 广告描述,
string icon_src = 10;  // 广告图标地址-icon
string image_src = 11;  // 广告图片地址-img
string app_package = 12; // 下载类广告应用包名
int app_size = 13; // 下载类广告应用大小
string adm=14;  // html片段
string cid=15;  // 审核物料广告ID
string crid=16;  //审核物料广告创意ID
InteractionType interaction_type =17;  // 交互类型

注意:

1.曝光上报日志URL列表,该地址需要包含宏 %%WIN_PRICE%% ,用于上报成交价,非竞价的直接替换成0。

2.所有上报地址(曝光、点击、开始下载、下载完成、开始安装和安装完成)都必须支持302跳转。如果状态码为302,则有重定向,读取http Headers 里的Location值即可。

参数 类型
Body Href Object string
Body show_url Object ArrayList
Body click_url Object ArrayList
Body downStart_url Object ArrayList
Body down_url Object ArrayList
Body installStart_url Object ArrayList
Body install_url Object ArrayList
Body title Object string
Body description Object string
Body icon_src Object string
Body image_src Object string
Body app_package Object string
Body app_size Object int
Body adm Object string
Body cid Object string
Body crid Object string
Body interaction_type Object InteractionType

5类型

(1)InteractionType 类型

参数 类型
Body H5 Object string 跳转类广告
Body DOWNLOAD Object string 下载类型广告
Body HTML Object 此交互类型是,是html类型代码

(2)ConnectionType类型

参数 类型
Body CELL_2G Object string
Body CELL_3G Object string
Body CELL_4G Object string
Body CELL_WIFI Object string

(3)SpType类型

参数 类型
Body YD Object string //移动
Body LT Object string //联通
Body DX Object string //电信
Body None Object string//未知

(4) AdType类型

参数 类型
Body currency Object string //通用
Body banner Object string //横幅
Body splash Object string //开屏
Body ingame Object string//插屏
Body feeds Object string//信息流
Body notice Object string//通知栏
Body video Object string//视频

6曝光和点击数据

当供应方或流量方接受到仙果广告返回信息后,如果Bid 对象show_url和click_url不等于空的情况,请循环该字段数值,客户端进行曝光的汇报,如果存在漏报或者不报的情况,如果供应方或流量方合作是按曝光合作方式,我们将不会纳入收益里面。注意:如果供应方或流量方是CPD合作,则必须上报down_url,不上报,也不会纳入收益数据。

注意:跳转类广告上报曝光和点击即可;下载类广告曝光、点击、开始下载、下载完成、开始安装和安装完成都要求上报。

以上所用的媒介类型,所有的参数请以此文档为准,实例请看JSON-DEMO。

对接文档(Proto版)

仙果ADX对接文档V2.0.4-Proto

目录

  • 仙果ADX对接文档V2.0.4-Proto版本
  • 1 修订记录
  • 1.1 说明
  • 1.2 接入说明
  • 2 竞价接口
  • 2.1 BidRequest
  • 3.1BidResponse
  • 4错误码详情
  • 5 枚举类型
  • 6 曝光和点击数据

1.修订记录

2016-08-04

(1)对应协议文档版本XinGuoV2.0.1.proto版本

2016-09-22

(2)增加了广告数量,同时扩展了已安装的包的信息。对应协议文档版本XinGuoV2.0.2.proto版本

(3)修改了个别参数的类型,扩充了广告的根据包名下发,对应的协议版本是XinGuoV2.0.3.proto版本

(4)增加BidResponse HTML片段支持(2016-12-15)XinGuoV2.0.4.proto版本

1.1 说明

(1). 该技术文档帮助分别帮助DSP和SSP使用仙果广告的实时竞价接口。通过广告家的接口所传递的参数,匹配出最合适的广告。

(2). 仙果广告和DSP及SSP之间实时交互,使用标准的HTTP协议,通过POST方式进行交互,交互格式:protocol-buers。

(3). 您可以通过 http://code.google.com/p/protobuf,获取最新的protocol-buers 技术支持。

(4). 同时你可以标准的OpenRTB广告交互协议。

1.2 接入说明

(1). (流量方)合作方通过商务流程: 将贵方的媒介产品报备给仙果广告进行效验。

(2). 仙果的实时竞价请求接口:http://www.xxx.com/api,流量方需要把数据post此接口。

(3). 流量方联系技术人员进行联调测试: 系统会给合作方所提供相关的测试数值,如:SSP_ID,Medium_ID,MADS_ID。

2 竞价接口

实时竞价接口URL:http://api2.goalmobi.com/Bid/XianGuoApi.ashx(正式)

2.1 BidRequest

(1)BidRequest是流量合作方发送给仙果请求数据的顶层对象。对象包含所有信息 例如:投标对象信息,版本号信息,配置信息,目标用户信息,设备信息,等等...

对应protobuf:

optional string id= 1;//请求ID 必填!接入方自定义请求ID,[a-zA-Z0-9]{32} 
optional Version api_version = 2;  // 必填!API版本,当前版本2.0.4,填写错误会导致 
optional Config config= 3;// 必填!--需要仙果广告商务提供
optional Device device= 4;//设备信息-客户端
optional AdSlot adslot= 5;//广告位信息
optional App app= 6;//app信息
optional uint32 adcount= 7;//返回的广告数量。 默认是1
repeated Installpackages installpackages=8;//已安装的应用列表
参数 类型
Body id Object string
Body api_version Object Version
Body config Object Config
Body device Object Device
Body adslot Object AdSlot
Body app Object App
Body adcount Object int
Body installpackages Object Installpackages

(2)Version对象

对应protobuf:

optional uint32 major = 1[default = 0]; // 必填!
optional uint32 minor = 2[default = 0]; // 必填!
optional uint32 micro = 3[default = 0]; // 必填!
参数 类型
Body major Object int
Body minor Object int
Body micro Object int

(3)Config 对象

对应protobuf:

optional uint32 ssp_id = 1;  // 必填!仙果提供此ID
optional uint32 medium_id = 2;  // 必填!仙果提供此ID
optional uint32 mads_id = 3;  // 必填!仙果提供此ID
参数 类型
Body ssp_id Object int
Body medium_id Object int
Body mads_id Object int

(4)Device 对象

对应protobuf:

optional string devicetype =1; // 设备类型"PHONE" 手机, "TABLET" 平板
optional string ostype =2;  // 操作系统类型 // Android,// iOS
optional string os_version = 3;  // 必填!操作系统版本 如:4.0.1
optional string vendor = 4;  // 必填!设备厂商名称 
optional string model = 5;  // 必填!设备型号 
optional SpType sptype = 6;  // 必填!运营商
optional string imei = 7[default = ""];  //必填! Android手机设备的IMEI
optional string mac = 8[default = ""];  //必填! Android非手机设备的WiFi网卡MAC址
optional string imei_md5 = 9; //必填! Android手机设备的IMEI,经过MD5加密
optional string android_id = 10[default = ""]; //必填!Android手机设备系统ID
optional uint32 screen_width = 11; //设备屏幕宽
optional uint32 screen_height = 12; //设备屏幕高
optional string imsi = 13; //必填!手机设备的IMSI
optional string ip=14; // 必填!手机客户端IP
optional ConnectionType connectiontype = 15;  // 必填!联网类型
optional Geo geo = 16;//设备位置信息,经纬度以及省市信息
optional string ua=17; // 必填!手机User-Agent
optional string idfa=18; //IOS 必填
optional string udid=19; //IOS 相关
optional string idv=20; //IOS相关
参数 类型
Body devicetype Object string
Body ostype Object string
Body os_version Object string
Body vendor Object string
Body model Object string
Body sptype Object SpType
Body imei Object string
Body mac Object string
Body imei_md5 Object string
Body android_id Object string
Body screen_width Object int
Body screen_height Object int
Body imsi Object string
Body ip Object string
Body connectiontype Object ConnectionType
Body geo Object Geo
Body ua Object string
Body idfa Object string
Body udid Object string
Body idv Object string

(5)AdSlot 对象

对应protobuf:

optional uint32 adslot_width = 1; //广告物料宽
optional uint32 adslot_height = 2; //广告物料高
optional string topics = 3; // 选填 详情数值咨询技术人员...
required uint32 bidfloor= 4;//低价(单位:分)
optional AdType adtype = 5;  // 必填!广告类型
optional string packagename = 6;  // 选填,如果填充此值,意味着返回广告此包名的广告
参数 类型
Body adslot_width Object int
Body adslot_height Object int
Body topics Object string
Body bidfloor Object int
Body adtype Object AdType
Body packagename Object string

(6)App 对象

对应protobuf:

optional string App_packagename= 1;//App包名
optional string appname = 2;//App名称
optional string cat = 3;//app分类
参数 类型
Body App_packagename Object string
Body appname Object string
Body cat Object string

(7)Geo对象

对应protobuf:

optional double longitude = 1;//经度-非必传
optional double latitude = 2;//纬度-非必传
optional string province = 3;//省份-必须
optional string city = 4;//城市-非必传
参数 类型
Body longitude Object double
Body latitude Object double
Body province Object string
Body city Object string

(8)Installpackages对象

对应protobuf:

optional bytes packagename = 1;//应用包名
optional bytes appname = 2;//应用名称
optional bytes app_ver = 3;//应用版本号
参数 类型
Body packagename Object bytes
Body appname Object bytes
Body app_ver Object bytes

3.1BidResponse

(1)BidResponse是发送给流量合作方回写数据的顶层对象。对象包含所有信息 例如:广告物料信息,请求错误码,竞价价格

(2)BidResponse 对象

对应protobuf:

optional string id=1;//此ID就是广告请求的id--合作方唯一ID
repeated Bid bids=2;
optional uint64 error_code = 3;  //错误码 
optional uint32 bidprice= 4;//出价。单位(分)
参数 类型
Body id Object string
Body bids Object Bid
Body error_code Object int
Body bidprice Object uint32

(3)Bid 对象

对应protobuf:

optional string Href = 1; //广告地址--落地页,在客户端进行响应,会经过多次302跳转最终到达目标地址
repeated string show_url = 2;  // 曝光上报日志URL列表,该地址需要包含宏 %%WIN_PRICE%% ,用于上报成交价,非竞价的直接替换成0。
repeated string click_url = 3;  // 点击上报URL列表,用户点击后,通知服务器。
repeated string down_url = 4;  // 下载上报URL列表,用户点击后,通知服务器。
repeated string install_url = 5;  // 安装上报URL列表,用户点击后,通知服务器。
optional string title = 6;  // 推广标题
optional string description = 7;  // 广告描述,
optional string icon_src = 8;  // 广告图标地址-icon
optional string image_src = 9;  // 广告图片地址-img
optional string app_package = 10; // 下载类广告应用包名
optional uint32 app_size = 11; // 下载类广告应用大小
optional string adm=12;  // html片段
optional InteractionType interaction_type =13;  // 交互类型

注意:当InteractionType 等于HTML时,如果曝光和点击字段存在数值,这种情况必须也要进行上报。

参数 类型
Body Href Object string
Body show_url Object string
Body click_url Object string
Body down_url Object string
Body install_url Object string
Body title Object string
Body description Object string
Body icon_src Object string
Body image_src Object string
Body app_package Object string
Body app_size Object int
Body adm Object string
Body interaction_type Object InteractionType

4 错误码详情

错误码 解释
0 正常返回
1000 无广告返回
2000 配置信息不正确
3000 API版本号信息错误
4000 Device 对象配置错误
5000 AdSlot 对象配置错误

5 枚举类型

(1)InteractionType 类型

参数 类型
Body H5 Object string 跳转类广告
Body DOWNLOAD Object string 下载类型广告
Body HTML Object 此交互类型是html类型代码

(2)ConnectionType类型

参数 类型
Body CELL_2G Object string
Body CELL_3G Object string
Body CELL_4G Object string
Body CELL_WIFI Object string

(3)SpType类型

参数 类型
Body YD Object string//移动
Body LT Object string//联通
Body DX Object string//电信
Body None Object string//未知

(4) AdType类型

参数 类型
Body currency Object string//通用
Body banner Object string//横幅
Body splash Object string//开屏
Body ingame Object string//插屏
Body feeds Object string//信息流
Body notice Object string//通知栏
Body video Object string//视频

6 曝光和点击数据

当供应方或流量方接受到仙果广告返回信息后,如果Bid 对象show_url和click_url不等与空的情况,请循环该字段数值,客户端进行曝光的汇报,如果存在漏报或者不报的情况,如果供应方或流量方合作是按曝光合作方式,我们将不会纳入收益里面。

注意:如果供应方或流量方是CPD合作,则必须上报down_url,不上报,也不会纳入收益数据

以上所用的媒介类型,所有的参数请以XinGuoV2.0.4.proto为准。

DSP对接

仙果DSP对接文档

DSP对接文档

仙果DSP对接文档V2.0.1-JSON

目录

  • 仙果DSP对接文档V2.0.1-JSON
  • 1 修订记录
  • 1.1 说明
  • 1.2 接入说明
  • 2 竞价接口
  • 2.1 BidRequest
  • 2.2 BidResponse
  • 3 错误码详情

1修订记录

2016-11-15

(1)DSP-JSON版本修订开始(Ver:2.0.1)

1.1 说明

(1). 该技术文档帮助DSP使用仙果广告的实时竞价接口。通过广告家的接口所传递的参数,匹配出最合适的广告。

(2). 仙果广告和DSP之间实时交互,使用标准的HTTP协议,通过POST方式进行交互,交互格式:json

(3). 同时你可以标准的OpenRTB广告交互协议。

1.2 接入说明

(1). (流量方)合作方通过商务流程: 将贵方的媒介产品报备给仙果广告进行效验。

(2). 仙果的实时竞价请求接口: http://www.xxx.com/api 。

2 竞价接口

实时竞价接口URL:http://192.168.1.166:8090/dsp/ad (正式)

2.1 XianGuoRequest

(1)基础信息

string request_id = 1;  // 请求ID 必填!接入方自定义请求ID,[a-zA-Z0-9]{32}
int iswap=2; // 是否支持WAP 0:不支持;1:支持 默认为0(支持WAP时,必填!)
ArrayList dmp_tag=3;// 用户标签(选填)
double bidprice=4;//选填!底价
参数 类型
Body request_id Object string
Body iswap Object int
Body dmp_tag Object ArrayList
Body bidprice Object double

(2)配置信息

int ssp_id = 1;  // 必填!仙果提供此ID
int medium_id = 2;  // 必填!仙果提供此ID
int mads_id = 3;  // 必填!仙果提供此ID
参数 类型
Body ssp_id Object int
Body medium_id Object int
Body mads_id Object int

(3)app信息

string medium_name=1;必填! app名称
string packageList=2;// app包名(选填)
string cat=3;//app分类(选填)
参数 类型
Body medium_name Object string
Body packageList Object string
Body cat Object string

(4)设备信息

string dpid = 1;  // 必填!安卓ID(暂无IOS量)
string imei = 2;  // 必填!
string imsi = 3;  // 必填!
string user_ip=4; //必填!必须是客户端IP
string mac=5; //必填!MAC地址
int nettype=6; //必填!网络类型(UNKNOWN=0,WIFI=1,2G=2,3G=3,4G=4,Ethenet=5)
string province=7;//推荐填写!省份
string carrier=8;//必填!运营商(1:移动 2:联通 3:电信)
string serise=9;//必填!设备型号
string brand=10;//必填!设备品牌
string idfa=11;//IOS量必填!
参数 类型
Body dpid Object string
Body imei Object string
Body imsi Object string
Body user_ip Object string
Body mac Object string
Body nettype Object int
Body province Object string
Body carrier Object string
Body serise Object string
Body brand Object string
Body idfa Object string

(5)广告位信息

string adtype=1;//必填!广告类型(通用=0;横幅=1;开屏=2;插屏=3;信息流=4;焦点图=5;通知栏=6;视频=7)
string adwidth=2;//必填!广告位宽度
string adheight=3;//必填!广告位高度
string clicktype=4;//选填 广告资源类型(0:应用下载,1:浏览器跳转,2:片段广告)
参数 类型
Body adtype Object string
Body adwidth Object string
Body adheight Object string
Body clicktype Object string

(6)用户信息

string gmuid=1;//必填!用户id (生成规则:JS流量:用户唯一标识(CookieID)MD5加密;其他流量:(imei+dpid)MD5加密)
string mwh=2;
参数 类型
Body gmuid Object string
Body mwh Object string

2.2 XianGuoResponse

(1)XianGuoResponse是发送给流量合作方回写数据的顶层对象。对象包含所有信息 例如:广告物料信息,状态码,错误信息

(2)XianGuoResponse 对象

int code = 1;  //状态码 
string msg= 2;//错误信息
Adinfo adInfo=3;//广告物料信息
参数 类型
Body code Object int
Body msg Object string
Body adInfo Object Adinfo

(3)Adinfo 对象

string adurl = 1;  //落地页 
string title= 2;//标题
string content=3;//描述
string src=4;//图片地址
string clicktype=4;// 广告资源类型(0:应用下载,1:浏览器跳转,2:片段广告)
string icon=5;//图标icon
string pname=6;//广告名
string packagename=7;//包名
string adlibid=8;//广告位id
string fs=9;//包大小
string imgSize=10;//物料尺寸
string crid=11;//创意id
string crAdid=12;//广告id
string dsp_AppCat=13;//二级分类id
ArrayList showurl = 14;  // 曝光上报日志URL列表,用户曝光后,通知服务器。
ArrayList clickurl = 15;  // 点击上报URL列表,用户点击后,通知服务器。
ArrayList downurl = 16;  // 下载完成上报URL列表,用户下载完成后,通知服务器。
ArrayList insturl = 17;  // 安装完成上报URL列表,用户安装完成后,通知服务器。
参数 类型
Body adurl Object string
Body title Object string
Body content Object string
Body src Object string
Body clicktype Object string
Body icon Object string
Body pname Object string
Body packagename Object string
Body adlibid Object string
Body fs Object string
Body imgSize Object string
Body crid Object string
Body crAdid Object string
Body dsp_AppCat Object string
Body showurl Object ArrayList
Body clickurl Object ArrayList
Body downurl Object ArrayList
Body insturl Object ArrayList

3 错误码详情

JSON状态码 解释
200 正常返回
400 无广告返回
500 参数错误
收益查看

常见问题