@jiangzhx/tencent-ads-marketing-api-sdk

基于腾讯广告官方 Go SDK github.com/tencentad/marketing-api-go-sdk porting 生成的 Node.js/TypeScript SDK。

安装

npm install @jiangzhx/tencent-ads-marketing-api-sdk

本发布线对标官方 Go SDK github.com/tencentad/[email protected]。

使用入口

v3 接口从 api/v3 导入，对应 Go SDK 的 pkg/api/v3：

import {
  ApiClient,
  AdgroupsApi,
} from "@jiangzhx/tencent-ads-marketing-api-sdk/api/v3";

const client = new ApiClient().setAccessToken("access-token");
const api = new AdgroupsApi(client);

await api.get({
  accountId: "1234567890",
  fields: ["adgroup_id", "adgroup_name"],
});

@jiangzhx/tencent-ads-marketing-api-sdk/api/v3 对应 Go SDK pkg/api/v3 下的接口，默认请求 https://api.e.qq.com/v3.0；@jiangzhx/tencent-ads-marketing-api-sdk/api 对应 Go SDK pkg/api 下的接口，按官方 Go SDK 配置请求 https://sandbox-api.e.qq.com/v1.3。

Porting 来源

当前 SDK 的目标源码是官方 Go SDK：

• Go module: github.com/tencentad/marketing-api-go-sdk
• 当前源码版本: v1.7.84
• API 源码: pkg/api/*.go 和 pkg/api/v3/*.go，生成到 src/api/*.ts 和 src/api/v3/*.ts
• Model 源码: pkg/model/*.go 和 pkg/model/v3/*.go，生成到 src/model/*.ts 和 src/model/v3/*.ts
• Config 源码: pkg/config/configuration.go 和 pkg/config/v3/configuration.go，生成到 src/config/configuration.ts 和 src/config/v3/configuration.ts
• 仓库源码中的生成版本记录: src/manifest.json 的 sourceVersion

生成链路读取 Go SDK 源码，生成 TypeScript API、类型模型和运行时调用配置。

Porting 规则

生成器维护在内部包 packages/codegen，入口命令：

bun run codegen:tencent-ads:generate /path/to/marketing-api-go-sdk

核心映射规则：

• Go 文件按相对目录生成到 TypeScript 文件，例如 pkg/api/v3/api_adgroups.go 生成 src/api/v3/api_adgroups.ts。
• Go 的 XxxApiService 映射为 TypeScript XxxApi class。
• Go service method 映射为 TypeScript request object 方法，例如 Get(ctx, accountId, opts) 映射为 get({ accountId, ...opts })。
• Go required 参数和 optional.* 参数统一收口到 request object。
• Go localVarQueryParams 映射为 queryParams。
• Go localVarPostBody 映射为 JSON request body。
• Go localVarFormParams 和文件参数映射为 formParams 和 files，用于 multipart/form-data 上传。
• JSON 响应使用 json-bigint 的 storeAsString: true 配置解析，避免响应体里的大整数在解析阶段丢失精度。
• Go int64 中 ID 类字段映射为 number | string，允许调用方在请求入参里传字符串 ID。

包形态

发布到 npm 的包只包含 dist/、README.md 和 package.json。package.json 的 exports 指向 dist 构建产物；prepack 会在打包前执行 bun run build，生成可被 Node.js 直接导入的 ESM .js 文件和 .d.ts 类型声明。

包验证

在当前 SDK 目录执行：

bun run build
bun run typecheck
bun run test
npm pack --dry-run