DotNetCore.SKIT.FlurlHttpCl.../docs/WechatAds/README.md
2021-09-12 22:00:12 +08:00

77 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# SKIT.FlurlHttpClient.Wechat.Ads
基于 `Flurl.Http` 的[微信广告平台](https://ad.weixin.qq.com/) API 客户端。
需要注意的是,微信广告平台是腾讯广点通的独立业务,请开发者阅读相关文档时注意与广点通本身的 API 区分。
---
## 功能
- 基于微信广告平台 API 封装。
- 请求时自动生成服务商身份令牌,无需开发者手动干预。
- 提供了微信广告平台 API 所需的 MD5 等算法工具类。
---
## 基础用法
### 安装:
提示:如果你使用 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)
- [如何在 ASP.NET Core 中与 `IHttpClientFactory` 集成?](./Advanced_IHttpClientFactory.md)
- [如何指定 JSON 序列化器?](./Advanced_JsonSerializer.md)
- [如何使用拦截器?](./Advanced_Interceptor.md)
- [如何获取接口调用凭据(即 AccessToken](./Advanced_AccessToken.md)