爱德威chanet成果网媒体接口说明.docx

爱德威CHANet成果网媒体接口说明CHANet的媒体接口类型可分为两类：# 网站媒体定时读取CNAHet数据的接口# CHANet实时发送数据给网站媒体的接口1网站媒体定时来读CHANet数据：数据齐全，能读取成果网广告链接：/click.cgi?a=111&d=111&u=&e=里的u（string型），e（int型）两个下线信息，支持媒体下线返点功能。详细读报表方法如下：通过rest调用数据查询接口：1.请求查询报表：/rest/as/get_as_report_list.cgi?username=用户名&password=密码&token=令牌&as_id=网站编号&start_time=开始时间&end_time=结束时间用户名、密码和网站编号使用chanet系统的设定令牌为CHANet客服给出。开始时间和结束时间表示查询时间范围，精确到天，格式为yyyy-mm-dd如果参数无误，返回xml中将包括一个查询编号（job_id）2.查询报表状态/rest/as/get_as_report.cgi?username=用户名&password=密码&token=令牌&job_id=查询编号如果参数无误，返回xml中将包括查询报表状态：正在生成（working）或生成完毕（finished）3.获取报表/soap/as/get_report.cgi?u=用户名&p=密码&t=令牌&j=查询编号报表生成完毕后，返回xml包括查询的成果信息/soap/as/get_report.cgi/soap/mc/get_report.cgiParametersuser_name/u (Required) 使用者的用户名password/p (Required) 使用者的密码token/t (Required) 分配给使用者的令牌job_id/j (Required) 查询编号名词解释：AS：联盟网站，广告都是投放在在联盟网站上PT：联盟网站主，各个联盟网站管理MC：广告主，决定投放广告的商家DRAFT：放在联盟网站上的广告源代码PROMOTION：广告主投放广告所做的一个活动ACTION：为某个广告做的成果关于权限每个api用户（包括网站与广告主）使用其用户名，密码以及被分配的令牌来进行身份验证。系统会分配一定的限额给每个api用户，每次调用api操作都会消耗一定的配额。通过配额的限制，系统可以控制一个用户可以调用一个操作多少次，也可以控制参数的范围。例如：如果getReport操作每天要消耗点的配额，那么一个从2006-01-01到2006-01-05的同样的操作就要消耗点的配额。PT API数据类型Promotion:(AS申请的一个活动)Int ID;(活动标示)String promotion_name;（活动名称）String merchant_name;（活动的广告主名称）String LOGO_URL;（LOGO的URL）Date START_TIME;（活动开始时间）Date END_TIME;（活动结束时间）String INTRODUCTION;（活动介绍）String CATEGORY;(活动类别)String certification;（广告活动的认证状态）Thanks THANKS;（具体活动的具体成果的类别）Thanks: （具体活动的具体成果的类别）String NAME;（类别名称）String TYPE;（类型，表示是一个click还是一个action，等等）Float PRICE;（价格）Draft:（原稿）Int ID;（原稿标示）String NAME;（原稿名）String URL;（原稿链接）String SIZE;（原稿大小）String TYPE;（原稿类型）String PREVIEW_CODE;（用于预览的原稿代码，点击不计click）String ADVERTISEMENT_CODE;（用于放置在AS网站上的真实原稿代码，点击不计click）Action:（成果）Int PROMOTION_ID;（活动标示，这个成果是属于这个活动的）String PROMOTION_NAME;（活动名称）String THANKS_NAME;（成果类型名称）Int EXT_INFO;（下线的ID，必须为数字，通过链接中的e参数得到）String IP;（成果发生的来源ip）String USER_INFO;（成果发生的用户信息，通过链接中的u参数得到）Float PRICE;（成果价格）Time RECORD_TIME;（成果记录时间）Time CONFIRM_DEADLINE;（成果确认最后期限）Time CONFIRM_TIME;（成果确认时间）String CONFIRM_STATUS;（成果确认状态）Ext:（AS的下线）Int EXT_ID;（AS下线标示）Record RECORDS;（某个下线按draft的记录）Record:（按某个具体draft的记录）Int DRAFT_ID;（原稿的标示）String DRAFT_NAME;（原稿名称）Int PROMOTION_ID;（该原稿对应的活动标示）String PROMOTION_NAME;（该原稿对应的活动名称）Int PAGEVIEW;（该原稿被浏览次数）Int CLICK;（该原稿被点击次数）Int TOTAL_ACTION;（从此原稿来源的总成果数）Int UNCONFIRMED_ACTION;（从此原稿来源的尚未被认证的成果数）Int CONFIRMED_ACTION; （从此原稿来源的已认证的成果数）Int REJECTED_ACTION; （从此原稿来源的被否认证的成果数）Float REMUNERATION;（该原稿产生的报酬）Operationl 活动相关getPromotionList得到所有对此as可见的活动信息权限需要（联盟网站主，下同）有读权限参数user_name (Required) 使用者的用户名password (Required) 使用者的密码token (Required) 分配给使用者的令牌as_id (Required) 调用接口的网站IDcost_type (Required) case- insensitive 指定广告活动的类型allcpccpaeccertification (Required) case- insensitive 指定广告活动的认证状态allapplyingapprovedrejectednot_applied返回值PromotionRest interface/rest/as/get_pm_list.cgi参数同上示例：输入/rest/as/get_pm_list.cgi?user_name=*&password=*&token=#&as_id=28226&cost_type=all&certification=all输出：*#allall28226 - - - + - 11 CHANet招募联盟网站主 上海爱通广告有限公司 /image/mc/8 2005-03-01 2008-02-01 网站主注册只有经CHANet管理部门审核通过的,才视为有效成果. 招聘/求职 已批准 - - click 0.0000 cpc - click ip 0.0000 cpc - 通过审核 3.0000 cpa /soap:Envelope原稿相关getDraftList得到该as做的特定活动的所有的原稿信息权限此方法要求有读权限，并且该活动对于该as而言是可以访问的参数user_name (Required) 使用者的用户名password (Required) 使用者的密码token (Required) 分配给使用者的令牌as_id (Required) 调用接口的网站IDpromotion_id (Required) 广告活动ID 返回值DraftRest interface/rest/as/get_dr_list.cgi参数同上示例：输入：/rest/as/get_dr_list.cgi?user_name=*&password=*&token=#&as_id=28226&promotion_id=34输出：*#2822634 - - - + - 412 gif130_18 /FreePresent/intr2.jsp?ad=2001 banner 130*18 l 成果相关getActionList得到该as在这段时间内的所有成果信息权限要求PT有读权限参数user_name (Required) 使用者的用户名password (Required) 使用者的密码token (Required) 分配给使用者的令牌as_id (Required) 调用接口的网站IDconfirm_status (Required) case- insensitive 成果认证状态 allunconfirmedconfirmedrejecteduserinfo (Required) case- insensitive 是否需要返回u参数noyesstart_time (Required) 指定查询时间范围的开始时间end_time (Required) 指定查询时间范围的结束时间返回值ActionRest interface/rest/as/get_as_ac_list.cgi参数同上示例：输入：/rest/as/get_as_ac_list.cgi?user_name=*&password=*&token=#&as_id=28226&start_time=06-03-01&end_time=06-03-03&confirm_status=all&userinfo=no输出：*#no06-08-0306-08-01all28226556556l EC成果相关get_as_ec_list权限要求PT有读权限参数user_name (Required) 使用者的用户名password (Required) 使用者的密码token (Required) 分配给使用者的令牌as_id (Required) 调用接口的网站IDconfirm_status (Required) case- insensitive 成果认证状态 allunconfirmedconfirmedrejecteduserinfo (Required) case- insensitive 是否需要返回u参数noyesstart_time (Required) 指定查询时间范围的开始时间（格式yyyy-mm-dd）end_time (Required) 指定查询时间范围的结束时间（格式同上）返回值ActionRest interface/rest/as/get_as_ec_list.cgi示例：输入：/rest/as/get_as_ec_list.cgi?user_name=*&password=*&token=#&as_id=28226&start_time=06-03-01&end_time=06-03-03&confirm_status=all&userinfo=no输出： - - - - - 252 99读书人推广活动 99读书人 34693 1 W070809595340 21.1050 - - 24910 281.4000 1 0.0750 2007-08-09 01:31:36 unconfirmed l 报表相关getReport得到在一段时间内此as的概要报表权限需要PT有读权限参数user_name (Required) 使用者的用户名password (Required) 使用者的密码token (Required) 分配给使用者的令牌as_id (Required) 调用接口的网站IDstart_time (Required) 指定查询时间范围的开始时间end_time (Required) 指定查询时间范围的结束时间返回值ExtRest interface/rest/as/get_as_report_list.cgi参数同上示例：输入：/rest/as/get_as_ac_list.cgi?user_name=*&password=*&token=#&as_id=28226&start_time=06-03-01&end_time=06-03-03输出：*#06-03-0305-03-0328226551*#551finishedgetReportStatus得到报表或成果相关服务的状态权限需要PT有读权限参数user_name (Required) 使用者的用户名password (Required) 使用者的密码token (Required) 分配给使用者的令牌job_id (Required) 查询编号返回值Status（working/finished）Rest interface/rest/as/get_as_report.cgi参数同上示例：输入：/rest/as/get_as_report.cgi?user_name=*&password=*&token=#&job_id=551输出： - - - finished Notice:1. 所有的参数名后面不要加空格，否则系统忽略此参数2. 对于rest 接口而言，参数”user_name” 也可以写成”username”网站主传用户参数用户登陆的时候把username放到session中在需要放chanet代码的页面里添加如下代码：var username = Session(username)然后在chanet的代码处改成以下的样子：* 需要替换成相应的e参数，比如用户名等。2CHANet实时发送成果信息给媒体网站：网站每发生一个成果，CHANet会实时把该次成果发送给网站，网站需提供给CHANet网站接收数据的接口链接地址。关于实时返数据链接的设定对于CPA：如 我要打折网其接收CPA数据的接口为：/shop/chanet.php?yyyymmdd=&hhmmss=&u_id=&m_id=&comm=根据各个参数的含义应将AS接收数据链接设为：http:/ww