@guardian/google-admanager-api

中文文档
8.0.2发布于 2026/10/09MITTypeScriptCommonJS构建来源已验证近 30 天下载 6967

用于节点Js的 Google 代理管理器 API 客户端库

中文使用文档
文档目录6 节
  1. 说明
  2. 安装库
  3. 概览
  4. 验证
  5. 调试
  6. 已知问题/问题

Ad Manager Logo

Google 代理管理器 API 节点Js的客户端库.

NPM Version Package License NPM Downloads

说明

从 https://github.com/Niurmiguel/google-admanager-api 页面存档备份,存于互联网档案馆 由于原始软件包没有保留.

开发者可以使用Google Ad Manager API来构建管理库存的应用程序,创建订单,拉取报告等.

安装库

$ npm install @guardian/google-admanager-api
$ yarn add @guardian/google-admanager-api
$ pnpm add @guardian/google-admanager-api

概览

认证

所有Google Ad Manager API的调用都必须通过 OAuth2 的开放标准授权,允许用户对第三方应用程序授予权限,因此应用程序可以代表用户与网络服务互动. OAuth2 允许您的 Ad Manager API 客户端应用程序访问用户的 Ad Manager 账户,而无需处理或存储用户的用户名或密码.

生成服务账户证书

const credential = new GoogleSACredential({
    type: "service_account",
    project_id: "...",
    private_key_id: "...",
    private_key: "...",
    client_email: "...",
    client_id: "...",
    auth_uri: "...",
    token_uri: "...",
    ...
});

//or

const credential = new GoogleSAFileCredential('./credentials.json');

生成用户账户证书

代表真实用户使用API比使用服务账户要复杂一些. 用户必须允许您访问他们的 Ad Manager 账户 。 这是通过将用户重定向到Google的OAuth2同意屏幕来实现的,将要求他们允许您访问他们的Ad管理器账户.

有一个 实例 如何在示例文件夹中生成用户账户证书.

它使用 刷新符号生成示例 生成刷新符号.

还有一个选择是使用 访问令牌 直接说 由于访问符是短暂的,你需要自己刷新.

使用客户端库

const adManagerClient = new AdManagerClient('networkCode',credential,'applicationName');

const orderService = await adManagerClient.getService("OrderService");
const statement = new StatementBuilder().limit(10);
const orderPage = await orderService.getOrdersByStatement(statement.toStatement())

/**
 * {
 *  results: [],
 *  totalResultSetSize: 0,
 *  startIndex: 0
 * }
 * /
选项
networkCode Number 正在处理的网络的网络代码(所需经费) (中文(简体) ).
credential SACredential OAuth2 证书所需经费) (中文(简体) ).
applicationName String 一个任意的字符串名称来识别您的应用程序 。 这将在Google的日志文件中显示. 例如:"我的编目应用"或"App 1" (中文(简体) )选项) (中文(简体) ).
apiVersion String Ad Mananger API 版本,如果您想要定义一个与默认版本不同的版本,即 v202605 ()选项) (中文(简体) ).

验证

使用 超级结构 用于类型验证,从而可用于分析我们从不同"守护者"项目中的API获取的行项目数据.

每个类型都有自己的Struct,应该在与类型相同的文件中找到,然后用于 项目. struct.ts。 。 。 .

在早期进行类型安全检查会减少我们以后可能遇到的bug,没有比这个寄存器更好的地方可以添加.

调试

通过设置启用请求和响应记录 logRequests 和(或) logResponses 改为 true 在服务对象上.

const orderService = await adManagerClient.getService("OrderService");
orderService.logRequests = true;
orderService.logResponses = true;

已知问题/问题

SOAP 要求对象属性按正确的顺序排列

使用此库发送对象的属性需要按正确的顺序排列(与类型定义的顺序相同),或者您可能遇到 Unmarshalling Error 反应.

例如,一个 线性项目 页:1 orderName 必须是在 startDateTime。 。 。 .

// will not work
lineItemService.createLineitem({
  priority: 12,
  orderId: 123,
  ...
})

// must be
lineItemService.createLineitem({
  orderId: 123,
  priority: 12,
  ...
})

一些对象需要额外的属性

在某些情况下,如果接受多种形状的物体,则需要在一个特殊的情况下指定该类型 attributes 属性.

例如,对于自定义目标,对象需要指定其类型是否属于 CustomCriteriaSet 或者说 CustomTargeting 像这样:

const customTargeting: CustomCriteriaSet = {
  attributes: {
    "xsi:type": "CustomCriteriaSet",
  },
  logicalOperator: LogicalOperator.OR,
  children: [{
    attributes: {
      "xsi:type": "CustomCriteriaSet",
    },
    logicalOperator: LogicalOperator.AND,
    children: [{
      attributes: {
        "xsi:type": "CustomCriteria",
      },
      keyId: 123,
      valueIds: [123],
      operator: ComparisonOperator.IS,
    }],
  }],
};

lineItemService.createLineitem({
  ...
  targeting: {
    customTargeting
  }
  ...
})

它还适用于技术瞄准, 因为有很多类型的技术

type Browser = {
  attributes: {
    "xsi:type": "Browser";
  };
  id: number;
  name: string;
  majorVersion: string;
  minorVersion: string;
};

版本与发布记录

@guardian/google-admanager-api 共发布 88 个版本,首次发布于 2024/08/20;过去 12 个月发布了 24 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
8.0.2latest2026/10/091 个月前
8.0.12026/09/102 个月前
8.0.02026/08/103 个月前
0.0.0-beta-20260803150447beta2026/08/033 个月前
7.0.52026/07/233 个月前
7.0.42026/07/084 个月前

关于 @guardian/google-admanager-api 的常见问题

@guardian/google-admanager-api 是什么?

用于节点Js的 Google 代理管理器 API 客户端库

如何安装 @guardian/google-admanager-api?

在项目目录运行 npm install @guardian/google-admanager-api,或使用 pnpm add / yarn add / bun add。

@guardian/google-admanager-api 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@guardian/google-admanager-api 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@guardian/google-admanager-api 可以商用吗?

@guardian/google-admanager-api 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@guardian/google-admanager-api 的下载量有多少?

根据 npm 官方下载统计,@guardian/google-admanager-api 在 2026/10/17 – 2026/11/15 这 30 天内被下载 6,967 次,日均约 232 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@guardian/google-admanager-api 还在维护吗?

最新版本 8.0.2 发布于 2026/10/09(1 个月前);至今共发布 88 个版本,其中过去 12 个月发布了 24 个;首次发布于 2024/08/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。