PlayerOS

PlayerOS SDK

PlayerOS API 向けの公式 TypeScript/JavaScript SDK および CLI — ゲーム事業者向けカジノマーケティングプラットフォーム（統合プレイヤーデータベース、マルチチャネルキャンペーン、ジャーニー自動化、TCPA/CCPA/GDPR 準拠）。

• ドキュメント： https://playeros.ai/api-docs · Markdown
• OpenAPI 3.1： https://playeros.ai/openapi.json
• MCP サーバー（AI エージェント向け）： https://api.playeros.ai/api/mcp · マニフェスト
• 認証ガイド： https://playeros.ai/auth.md

実行時依存関係はありません。Node 18 以上（組み込みの fetch を使用）。

インストール

npm install @playeros/sdk

認証

Settings → API & MCP （https://playeros.ai/dashboard/mcp）で**プロパティ単位の API キー**（pk_…）を作成します。キーには read および／または write スコープが付与され、1 つのプロパティに紐付けられます。X-Api-Key として送信してください（SDK が自動で処理します）。

クイックスタート

import { PlayerOS } from "@playeros/sdk";

const playeros = new PlayerOS({ apiKey: process.env.PLAYEROS_API_KEY! });

// List players
const { data: players, totalCount } = await playeros.players.list({ limit: 50, q: "gold" });

// Create a player (gaming-native fields)
await playeros.players.create({ email: "[email protected]", tier: "Gold", adt: 250, coin_in: 18000 });

// Send a campaign — pass an idempotencyKey so retries never double-send
await playeros.campaigns.sendEmail(
  { campaignId: "…", propertyId: "…" },
  { idempotencyKey: crypto.randomUUID() }
);

リソース

グループ	メソッド
players	list、get、create、update、delete、validateBatch
validationJobs	get（非同期バッチジョブのポーリング）
campaigns	sendEmail、sendSms（どちらも { idempotencyKey } を受け付けます）
compliance	check、recordConsent
privacy	exportData、deleteData（CCPA / GDPR）
webhooks	list、create
apiKeys	create、list、revoke（管理者向け。ダッシュボード JWT が必要です）

各呼び出しは { data, status, requestId, totalCount?, rateLimit, idempotencyReplayed? } を返します。

エラー

2xx 以外のレスポンスでは、安定した .code を持つ PlayerOSError がスローされます。これを使って処理を分岐できます。

import { PlayerOSError } from "@playeros/sdk";

try {
  await playeros.players.create({ /* … */ });
} catch (e) {
  if (e instanceof PlayerOSError) {
    if (e.code === "insufficient_scope") { /* use a write-scoped key */ }
    if (e.status === 429) await sleep((e.retryAfter ?? 1) * 1000); // then retry
    console.error(e.status, e.code, e.requestId);
  }
}

rateLimit（X-RateLimit-*）のヒントに従い、429 が返された場合はバックオフしてください。

CLI

このパッケージには playeros コマンドが含まれています。

export PLAYEROS_API_KEY=pk_live_…

playeros players list --limit 25
playeros players get <id>
playeros players create --data '{"email":"[email protected]","tier":"Gold"}'
playeros campaigns send <campaignId> --property <propertyId> --idempotency-key $(uuidgen)
playeros compliance check --data '{"propertyId":"…","playerId":"…","channel":"sms"}'
playeros --help

出力は標準出力に JSON 形式で出力されます — jq にパイプできます。インストールせずに一度だけ実行するには、npx @playeros/sdk --help を使用します。

AI エージェント向け

AGENTS.md を参照してください。PlayerOS は、25 個のツールと検出可能なリソースを備えた Model Context Protocol サーバーも https://api.playeros.ai/api/mcp で公開しています。

ライセンス

MIT © PlayerOS