億起發(fā)廣告主CPS接口文檔(最新).ppt

1、億起發(fā)廣告主CPS業(yè)務(wù)接入手冊(cè),億瑪在線科技有限公司應(yīng)用開發(fā)部 2013.05,V1.3.0,目錄,1.1 術(shù)語表 1.2 億起發(fā)推廣流程,2.1 廣告入口 2.2 實(shí)時(shí)數(shù)據(jù)接口 2.3 數(shù)據(jù)查詢接口,3.1 JAVA代碼 3.2 PHP代碼 3.3 .NET/C#代碼,3,1.1 術(shù)語表,1.1 術(shù)語表,注：本文檔中紅色字體為需要特別注意的部分。,2.1 廣告入口,廣告入口是廣告主提供給億起發(fā)的在廣告跳轉(zhuǎn)過程中能記錄聯(lián)盟以及網(wǎng)站主信息的鏈接，這些信息保存在COOKIE中，采用last click win（即效果算做最后一次帶來流量的聯(lián)盟和網(wǎng)站主）的方式更新COOKIE的值。 廣告入口參數(shù)如下

2、表：,左側(cè)表格中除target參數(shù)外都是必要參數(shù)，source、channel 可以讓廣告主接口在多合作 伙伴、多渠道推廣時(shí)具有最大 的靈活性，且給廣告主統(tǒng)計(jì)各 個(gè)渠道的數(shù)據(jù)帶來方便，一次 開發(fā)多次使用。cid、wi是億起發(fā)統(tǒng)計(jì)數(shù)據(jù)和給站長(zhǎng)結(jié)算的依據(jù)，也是必不可少的。 target參數(shù)是廣告入口記錄COOKIE后要跳轉(zhuǎn)到的鏈接地址，請(qǐng)根據(jù)自己網(wǎng)站使用的字符集進(jìn)行URLDecode,防止目標(biāo)地址參數(shù)丟失。,2.1 廣告入口,廣告入口形式： 注意：紅色部分為目標(biāo)地址，目標(biāo)地址在網(wǎng)站主投放廣告時(shí)可以修改為廣告主網(wǎng)站的任意一個(gè)鏈接。 廣告入口的功能： 1、讀取鏈接參數(shù)source、channel、ci

3、d、wi、target的值。 2、在COOKIE中保存參數(shù)source、channel、cid、wi的值，并設(shè)置COOKIE有效期。 3、對(duì)參數(shù)目標(biāo)地址做URLDecode(所有字符集與廣告主網(wǎng)站使用的字符集相同)操作后跳轉(zhuǎn)到目標(biāo)地址指定的頁面。 （如果您使用的是由億起發(fā)提供的sdk，一些默認(rèn)參數(shù)可直接使用各版本定義好的即可）,2.2 實(shí)時(shí)數(shù)據(jù)接口,實(shí)時(shí)數(shù)據(jù)接口由億起發(fā)提供，用于接收廣告主的訂單數(shù)據(jù)。廣告主需要在訂單生成后支付前調(diào)用此接口向億起發(fā)發(fā)送訂單數(shù)據(jù)，不作為最后結(jié)算的依據(jù)。此接口發(fā)送所有來源為億起發(fā)的訂單，實(shí)時(shí)性好，網(wǎng)站主能及時(shí)看到產(chǎn)生的訂單，有助于增強(qiáng)網(wǎng)站主推廣的信心，請(qǐng)求格式：,2

4、.2 實(shí)時(shí)數(shù)據(jù)接口,優(yōu)惠券分?jǐn)偺幚砉剑?price（商品金額）=商品單價(jià)*【1-（優(yōu)惠券金額/總價(jià)）】 （查詢接口顯示也同樣這樣處理） 問題描述： 一個(gè)訂單，商品A單價(jià)100元1件、商品B單價(jià)50元2件，使用優(yōu)惠券金額20元，此時(shí)總價(jià)為200： 商品A對(duì)應(yīng)的price=100*1-(20/200)=90 amount參數(shù)=1 商品B對(duì)應(yīng)的price=50*1-(20/200)=45 amount參數(shù)=2,2.2 實(shí)時(shí)數(shù)據(jù)接口,1、實(shí)時(shí)數(shù)據(jù)接口形式： interId=519200e5e03bbcaa579e8b04 Sender send = new Sender(order); send.s

5、endOrder(request); 2、發(fā)送訂單狀態(tài)信息： orderStatus orderStatus = new orderStatus(); Sender send = new Sender(orderStatus); send.sendOrderStatus(); 特別注意： a、廣告主在和億起發(fā)對(duì)接接口時(shí)，需要在配置文件中設(shè)置接口ID（億起發(fā)提供）。 b、該類根據(jù)訂單信息拼接URL,拼接URL時(shí)會(huì)對(duì)商品名稱、下單時(shí)間和傭金類型進(jìn)行編碼。,3.1 JAVA代碼,三）、java版本Sdk查詢接口調(diào)用說明： 調(diào)用方式，例如： ,3.1 JAVA代碼,注意：需要使用PHP5或者PHP5以

6、上版本 一）、php版本Sdk廣告入口調(diào)用說明： 實(shí)現(xiàn)功能：接受億起發(fā)傳過去的參數(shù)，創(chuàng)建AdEnter對(duì)象，調(diào)用jump方法，傳入獲取的參數(shù)保存cookie并跳轉(zhuǎn)到對(duì)應(yīng)的目標(biāo)地址。 網(wǎng)站調(diào)用接口的形式：,3.2 PHP代碼,二）、php版本Sdk實(shí)時(shí)推送接口調(diào)用說明： 實(shí)現(xiàn)功能： Sender類為實(shí)時(shí)數(shù)據(jù)接口類,接口用于推送送廣告主的訂單數(shù)據(jù),廣告主需要在訂單生成后、支付前調(diào)用此接口程序會(huì)讀取億起發(fā)cookie、拼接鏈接向億起發(fā)發(fā)送訂單數(shù)據(jù)。 發(fā)送格式為JSON 。默認(rèn)編碼格式為 GBK （配置文件yiqifa-config.php中可更換）。 Sender類使用方法： 1、發(fā)送訂單信息： $

7、sender = new Sender(); $sender - setOrder($order); $sender - sendOrder(); 測(cè)試文件參考TestOrder.php 2、發(fā)送訂單狀態(tài)信息： $sender = new Sender(); $sender - setOrder($orderStatus); $sender - sendOrderStatus(); 測(cè)試文件參考TestOrderStatus.php 特別注意： 廣告主在和億起發(fā)對(duì)接接口時(shí)，需要在配置文件中設(shè)置接口ID（億起發(fā)提供）。,3.2 PHP代碼,三）、php版本Sdk查詢接口調(diào)用說明： 調(diào)用的方式：

8、/查詢的是在orderStartTime和orderEndTime這段的時(shí)間段內(nèi)的訂單 /查詢的是在updateStartTime和updateEndTime這段時(shí)間段內(nèi)訂單狀態(tài)發(fā)生變化的訂單 相關(guān)類說明： 1.getOrder.php，訂單信息查詢接口 2.getOrderStatus.php，訂單狀態(tài)信息查詢接口 3.Dto.php，操作數(shù)據(jù)庫，把查詢出來的數(shù)據(jù)已json的格式返回。 特別注意： 1、yiqifa-config.php，配置文件，該文件為主配置文件，重要和常用的變量都在該文件中設(shè)置。其中涉及到IP限制和sign簽名的設(shè)置 2、util/Config.php，工具類，getS

9、tring($name)方法調(diào)用億起發(fā)獲取yiqifa-config.php配置文件中已設(shè)置的變量。,3.2 PHP代碼,注意點(diǎn)：需要使用Visual Studio 2008版本 一）、.net版本Sdk廣告入口調(diào)用說明 實(shí)現(xiàn)功能：接受億起發(fā)傳過去的參數(shù)，創(chuàng)建AdEnterCore的對(duì)象，調(diào)用jump方法，獲取參數(shù)保存至cookie并跳轉(zhuǎn)到對(duì)應(yīng)的目標(biāo)地址。 網(wǎng)站調(diào)用接口的形式： ,3.3 .NET代碼,二）、.net版本Sdk實(shí)時(shí)推送接口調(diào)用說明 業(yè)務(wù)邏輯：當(dāng)用戶點(diǎn)擊“提交訂單”按鈕時(shí)，程序判斷是否是億起發(fā)帶去的訂單， 如果是，將訂單信息回傳給我們。 代碼調(diào)用示例： protected voi

10、d Button1_Click(object sender, EventArgs e) GetDataFromPage gdfp = new GetDataFromPage(); List order = new List(); order = this.getOrder(); string url = gdfp.getOrderFromPage(order); Sender s = new Sender(); s.send(url); protected void Button2_Click(object sender, EventArgs e) GetDataFromPage gdfp = new GetDataFromPage(); List orderStatuss = new List(); orderStatuss = this.getOrderStatus(); string url = gdfp.getStatusFromPa