mirror of
https://gitee.com/fudiwei/DotNetCore.SKIT.FlurlHttpClient.Wechat.git
synced 2025-09-19 01:58:14 +08:00
docs: 完善文档
This commit is contained in:
92
docs/WechatAds/README.md
Normal file
92
docs/WechatAds/README.md
Normal file
@@ -0,0 +1,92 @@
|
||||
# SKIT.FlurlHttpClient.Wechat.Ads
|
||||
|
||||
[](https://www.nuget.org/packages/SKIT.FlurlHttpClient.Wechat.Ads)
|
||||
[](https://www.nuget.org/packages/SKIT.FlurlHttpClient.Wechat.Ads)
|
||||
[](https://github.com/fudiwei/DotNetCore.SKIT.FlurlHttpClient.Wechat/blob/main/LICENSE)
|
||||
|
||||
基于 `Flurl.Http` 的[微信广告平台](https://ad.weixin.qq.com/) API 客户端。
|
||||
|
||||
需要注意的是,微信广告平台是腾讯广点通的独立业务,请开发者阅读相关文档时注意与广点通本身的 API 区分。
|
||||
|
||||
---
|
||||
|
||||
## 功能
|
||||
|
||||
- 基于微信广告平台 API 封装。
|
||||
|
||||
- 请求时自动生成服务商身份令牌,无需开发者手动干预。
|
||||
|
||||
- 提供了微信广告平台 API 所需的 MD5 等算法工具类。
|
||||
|
||||
- 完整微信广告平台 API 一览:
|
||||
|
||||
| | 微信 API | 备注 |
|
||||
| :-: | :------------: | :--: |
|
||||
| √ | 广告帐号模块 | |
|
||||
| √ | 资质管理模块 | |
|
||||
| √ | 服务商权限模块 | |
|
||||
| √ | 资金账户模块 | |
|
||||
| √ | 推广计划模块 | |
|
||||
| √ | 广告组模块 | |
|
||||
| √ | 广告创意模块 | |
|
||||
| √ | 广告模块 | |
|
||||
| √ | 报表模块 | |
|
||||
| √ | 异步任务模块 | |
|
||||
| √ | 图片管理模块 | |
|
||||
| √ | 客户人群管理 | |
|
||||
| √ | 其他模块 | |
|
||||
|
||||
---
|
||||
|
||||
## 基础用法
|
||||
|
||||
### 安装:
|
||||
|
||||
提示:如果你使用 Visual Studio NuGet 管理器图形化界面,请在搜索结果中勾选“**包括预发行版**”。
|
||||
|
||||
```shell
|
||||
# 通过 NuGet 安装
|
||||
> Install-Package SKIT.FlurlHttpClient.Wechat.Ads
|
||||
|
||||
# 通过 dotnet-tools 安装
|
||||
> dotnet add package SKIT.FlurlHttpClient.Wechat.Ads
|
||||
```
|
||||
|
||||
### 初始化:
|
||||
|
||||
```csharp
|
||||
using SKIT.FlurlHttpClient.Wechat;
|
||||
using SKIT.FlurlHttpClient.Wechat.Ads;
|
||||
|
||||
var options = new WechatAdsClientOptions()
|
||||
{
|
||||
AgencyId = "广告服务商 ID",
|
||||
AgencyAppId = "广告服务商 AppId",
|
||||
AgencyApiKey = "广告服务商 ApiKey"
|
||||
};
|
||||
var client = new WechatAdsClient(options);
|
||||
```
|
||||
|
||||
### 请求 & 响应:
|
||||
|
||||
```csharp
|
||||
using SKIT.FlurlHttpClient.Wechat.Ads;
|
||||
using SKIT.FlurlHttpClient.Wechat.Ads.Models;
|
||||
|
||||
/* 示例:创建推广计划 */
|
||||
var request = new CampaignsAddRequest()
|
||||
{
|
||||
AccessToken = "广告主的 AccessToken",
|
||||
CampaignType = "CAMPAIGN_TYPE_WECHAT_OFFICIAL_ACCOUNTS",
|
||||
ProductType = "PRODUCT_TYPE_LINK_WECHAT"
|
||||
};
|
||||
var response = await client.ExecuteCampaignsAddAsync(request);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 高级技巧
|
||||
|
||||
- [如何快速找到需要调用的 API 模型类名 / 方法名?](./Advanced_ModelDefinition.md)
|
||||
|
||||
- [如何获取接口调用凭据(即 AccessToken)?](./Advanced_AccessToken.md)
|
Reference in New Issue
Block a user