巨量星图 / 全部接口
入门指南
快速入门
术语解释
接口清单(Scope权限点)
Oauth2.0授权
简版授权流程说明
授权管理说明
新版授权常见问题
OAuth2.0原理及Marketing-API使用
回调地址怎么设置和使用
Token管理
获取Access Token
刷新Refresh Token
获取已授权账户
获取授权User信息
获取APP Access Token
账号服务
代理商账号管理
代理商管理账户列表
获取代理商信息
二级代理商列表
巨量星图
获取星图客户任务列表
获取星图客户任务订单列表
获取订单投后分析报表
获取订单投后受众报表
获取星图订单投后线索
频控限制
最佳实践
附录
枚举值
返回码
过滤条件
获取订单投后分析报表

此接口用于根据订单id,获取星图客户所发布任务的接单达人作品的创意表现、传播表现、舆情表现、组件转化表现、订单性价比等效果分析类数据。

  • 结果中所有的rate均为*100后的结果,如five_s_play_rate=2750,表示有效播放率27.5%。

数据更新频率

  • 数据为非实时更新,一般在次日凌晨产出前一天的数据;
  • 一般历史数据都不会变,除了数据有问题有校对的情况会更新历史数据。

请求地址

https://ad.oceanengine.com/open_api/2/star/report/order_overview/get/

请求方法

GET

请求头

字段类型描述
Access-Token必填
string
授权access-token,获取方法见接口文档【获取Access-Token】
X-Debug-Mode
number
允许值:1(开启);Debugger模式仅适用于接口测试使用(不适合线上生产环境),目前频控限制为20次/分钟,建议在遇到调用接口报错后,在header中传入此段,以获取错误help message

请求参数

字段类型描述
star_id 必填
number
星图id,星图客户授权后,通过“获取已授权账户”接口,查询到账号角色为”6-星图账号“的账户id,即为星图id
order_id 必填
number
订单id,可通过“获取星图客户任务订单列表”获取

请求示例

Java
Python
PHP
curl
import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.databind.ObjectMapper; import okhttp3.*; import org.apache.http.client.utils.URIBuilder; import java.io.IOException; import java.net.URI; import java.net.URISyntaxException; import java.net.URL; import java.util.List; import java.util.Map; import java.util.stream.Collectors; public class Demo { private static final String ACCESS_TOKEN = "YOUR_ACCESS_TOKEN"; private static final String PATH = "/star/report/order_overview/get/"; private static final ObjectMapper mapper = new ObjectMapper(); /** * Build request URL * * @param path Request path * @return Request URL */ private static String buildUrl(String path) throws URISyntaxException { return "https://ad.oceanengine.com/open_api/2" + path; } /** * Send GET request * * @param jsonStr:Args in JSON format * @return Response in JSON format */ private static String get(String jsonStr) throws IOException, URISyntaxException { OkHttpClient client = new OkHttpClient().newBuilder().build(); URIBuilder ub = new URIBuilder(buildUrl(PATH)); Map< String, Object > map = mapper.readValue(jsonStr, Map.class); map.forEach((k, v) -> { try { ub.addParameter(k, v instanceof String ? (String) v : mapper.writeValueAsString(v)); } catch (JsonProcessingException e) { e.printStackTrace(); } }); URL url = ub.build().toURL(); Request request = new Request.Builder() .url(url) .method("GET", null) .addHeader("Access-Token", ACCESS_TOKEN) .build(); Response response = client.newCall(request).execute(); return response.body().string(); } public static void main(String[] args) throws IOException, URISyntaxException { // Args in JSON format String myArgs = "{\"order_id\": ORDER_ID,\"star_id\": STAR_ID}"; System.out.println(get(myArgs)); } }
# coding=utf-8 import json import requests from six import string_types from six.moves.urllib.parse import urlencode, urlunparse # noqa ACCESS_TOKEN = "YOUR_ACCESS_TOKEN" PATH = "/star/report/order_overview/get/" def build_url(path, query=""): # type: (str, str) -> str """ Build request URL :param path: Request path :param query: Querystring :return: Request URL """ return urlunparse(("https","ad.oceanengine.com/open_api/2", path, "", query, "")) def get(json_str): # type: (str) -> dict """ Send GET request :param json_str: Args in JSON format :return: Response in JSON format """ args = json.loads(json_str) query_string = urlencode({k: v if isinstance(v, string_types) else json.dumps(v) for k, v in args.items()}) url = build_url(PATH, query_string) headers = { "Access-Token": ACCESS_TOKEN, } rsp = requests.get(url, headers=headers) return rsp.json() if __name__ == '__main__': # Args in JSON format my_args = "{\"order_id\": ORDER_ID,\"star_id\": STAR_ID}" print(get(my_args))
$ACCESS_TOKEN = "YOUR_ACCESS_TOKEN"; $PATH = "/star/report/order_overview/get/"; /** * Build request URL * @param $path : Request path * @return string */ function build_url($path) { return "https://ad.oceanengine.com/open_api/2" . $path; } /** * Send GET request * @param $json_str : Args in JSON format * @return bool|string : Response in JSON format */ function get($json_str) { global $ACCESS_TOKEN, $PATH; $curl = curl_init(); $args = json_decode($json_str, true); /* Values of querystring is also in JSON format */ foreach ($args as $key => $value) { $args[$key] = is_string($value) ? $value : json_encode($value); } $url = build_url($PATH) . "?" . http_build_query( $args ); curl_setopt_array($curl, array( CURLOPT_URL => $url, CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => array( "Access-Token: " . $ACCESS_TOKEN, ), )); $response = curl_exec($curl); curl_close($curl); return $response; } /* Args in JSON format */ $my_args = "{\"order_id\": ORDER_ID,\"star_id\": STAR_ID}"; echo get($my_args);
curl -X GET -H "Access-Token:YOUR_ACCESS_TOKEN" \ --data-urlencode "order_id=ORDER_ID" \ --data-urlencode "star_id=STAR_ID" \ https://ad.oceanengine.com/open_api/2/star/report/order_overview/get/

应答字段

字段类型描述
code
number
返回码,详见【附录-返回码】
message
string
返回信息,详见【附录-返回码】
request_id
string
请求日志id
data
json
返回数据
comment
object
舆情表现
high_frequency_words
string[]
热词top10
neg_rate
number
负向评论率(neg_rate/100)%
neu_rate
number
中立评论率(neu_rate/100)%
pos_rate
number
正向评论率(pos_rate/100)%
convert
object
转化表现
click
number
组件点击量
ctr
number
组件点击率 (ctr/100)%
show
number
组件展示量
cost_effectiveness
object
性价比表现
cpm
number
千次播放成本(分)
play
number
播放次数
price
number
订单金额(分)
creative
object
创意表现
finish_rate
number
完播率 (finish_rate/100)%
five_s_play_rate
number
有效播放率(播放5s以上记为有效播放)(five_s_play_rate/100)%
play_rate
number
平均播放率(=用户观看该任务视频的平均观看时长/视频总时长)(play_rate/100)%
spread
object
传播表现
comment
number
评论量
like
number
点赞量
play
number
播放量
share
number
分享量
update_time
string
数据更新时间,格式%Y-%m-%d %H:%M:%S

应答示例

HTTPS/1.1 200 OK { "code": 0, "message": "OK", "request_id": "202103102027450102121940513808BE0D", "data": { "spread": { "share": 0, "like": 0, "comment": 0, "play": 141 }, "creative": { "play_rate": 4397, "five_s_play_rate": 2895, "finish_rate": 2105 }, "convert": { "show": 55, "click": 23, "ctr": 4181 }, "update_time": "2021-03-10 20:27:46", "comment": { "pos_rate": 0, "high_frequency_words": [], "neg_rate": 0, "neu_rate": 0 }, "cost_effectiveness": { "cpm": 2127, "price": 300, "play": 141 } } }