前言
由于工作原因,需要用到今日头条的Marketing API做一些广告投放的定制化开发。然后看现在网上也没多少关于头条Marketing API的文章,于是便就有了该篇文章。
头条Marketing API主页地址:https://ad.toutiao.com/openapi/index.html。
头条Marketing API开发文档:https://ad.toutiao.com/openapi/doc/index.html
交互图
典型的OAuth2.0授权流程:
使用步骤
1. 首先需要去主页注册一个开发者账号,并申请一个APPID,设置好回调地址
因为从头条重定向回自己的站点只是浏览器行为,所有回调地址填写本机可访问的地址即可(不需要头条能访问),这里是http://localhost:5000/api/auth/callback。
2. 在appsettings.json中设置APPID + Secret
3. 启动项目,即可直接在swagger中使用
程序逻辑
1. 在launchsettings.json中设置启动地址为http://localhost:5000/api/auth
2. 浏览器访问地址http://localhost:5000/api/auth,会重定向到今日头条的认证地址,并且拼接好参数
3. 跳转到今日头条的认证地址并点击“同意授权”
4. 重定向回http://localhost:5000/api/auth/callback并带回了auth_code参数
5. 利用AuthCode + AppId + Secret调用头条认证API获取AccessToken,并把AccessToken缓存到内存中,然后重定向回swagger
调用头条API
0. 示例代码
1. 根据文档拼接对应参数
var url = "https://ad.toutiao.com/open_api/2/ad/get/" + "?advertiser_id=" + advertiserId + "&page=" + page + "&page_size=" + pageSize;
2. 从缓存中取出之前得到的AccessToken
_cache.Get<string>(ToutiaoCacheKey.AccessToken)
3. 构造请求头信息
client.DefaultRequestHeaders.Add("Access-Token", accessToken);
4. 调用API,并把返回的json反序列化为dynamic类型
var response = await _restClient.GetAsync<DynamicResponse>(url, _cache.Get<string>(ToutiaoCacheKey.AccessToken));
5. 输出结果到浏览器
说明:示例中只有查询类API,没有操作类型的API,主要是考虑到操作可能会影响到现有业务。
操作类型API
代码调用操作类型的API时,可能需要构建请求json对应的实体,这里可以使用Visual Studio的选择性编辑功能,快速生成对象。
示例:
1. 拷贝json
2. 新建一个cs文件,点击Visual Studio菜单栏的“编辑” -> “选择性编辑” -> “保存json为类”
3. 设置JsonProperty(可选,规范、美观考虑)
其实,头条的开发文档中有提供操作API的示例json,但是示例json的字段有些不全,而请求API的结果基本包含了操作API的字段。
因此,可以使用操作API的返回json来生成操作请求。同时,这个小工具也可以做一些前期的简单查询。
源码地址
https://github.com/ErikXu/ToutiaoApi
原文地址:https://www.cnblogs.com/Erik_Xu/p/10055384.html
.NET社区新闻,深度好文,欢迎访问公众号文章汇总 http://www.csharpkit.com