Web SDK 概览与安装

本文说明 AdStage Web SDK 的安装与初始化方法。广告展示、事件跟踪等具体用法请参考各功能文档。

🚀 安装

包管理器

pnpm add @adstage/web-sdk

安装问题排查

发生 peer dependency 冲突错误 时：

# 立即解决
npm install @adstage/web-sdk --legacy-peer-deps
 
# 或在 .npmrc 文件中添加配置
echo "legacy-peer-deps=true" >> .npmrc

CDN（原型 / 静态页面）

<script src="https://unpkg.com/@adstage/web-sdk/dist/index.umd.js"></script>

⚙️ 初始化

init() 方式

<script>
  AdStage.init({ 
    apiKey: 'your-api-key',
    debug: true // 仅限开发环境
  });
</script>

Provider 方式

import { AdStageProvider } from '@adstage/web-sdk';
 
export function App() {
  return (
    <AdStageProvider 
      config={{ 
        apiKey: 'your-api-key',
        debug: process.env.NODE_ENV === 'development'
      }}
    >
      <div>{/* 应用组件 */}</div>
    </AdStageProvider>
  );
}

🔧 配置选项

选项	类型	默认值	说明
`apiKey`	`string`	必填	API 密钥
`debug`	`boolean`	`false`	启用调试模式

Web SDK 概览与安装

目录