@squadbase/vite-server 0.1.4 → 0.1.5-dev.1

package/dist/connectors/tiktok-ads.js

@@ -0,0 +1,840 @@
+// ../connectors/src/parameter-definition.ts
+var ParameterDefinition = class {
+  slug;
+  name;
+  description;
+  envVarBaseKey;
+  type;
+  secret;
+  required;
+  constructor(config) {
+    this.slug = config.slug;
+    this.name = config.name;
+    this.description = config.description;
+    this.envVarBaseKey = config.envVarBaseKey;
+    this.type = config.type;
+    this.secret = config.secret;
+    this.required = config.required;
+  }
+  /**
+   * Get the parameter value from a ConnectorConnectionObject.
+   */
+  getValue(connection2) {
+    const param = connection2.parameters.find(
+      (p) => p.parameterSlug === this.slug
+    );
+    if (!param || param.value == null) {
+      throw new Error(
+        `Parameter "${this.slug}" not found or has no value in connection "${connection2.id}"`
+      );
+    }
+    return param.value;
+  }
+  /**
+   * Try to get the parameter value. Returns undefined if not found (for optional params).
+   */
+  tryGetValue(connection2) {
+    const param = connection2.parameters.find(
+      (p) => p.parameterSlug === this.slug
+    );
+    if (!param || param.value == null) return void 0;
+    return param.value;
+  }
+};
+
+// ../connectors/src/connectors/tiktok-ads/sdk/index.ts
+var BASE_URL = "https://business-api.tiktok.com/open_api/v1.3/";
+function createClient(_params, fetchFn = fetch) {
+  function request(path2, init) {
+    const url = `${BASE_URL}${path2}`;
+    return fetchFn(url, init);
+  }
+  return { request };
+}
+
+// ../connectors/src/connector-onboarding.ts
+var ConnectorOnboarding = class {
+  /** Phase 1: Connection setup instructions (optional — some connectors don't need this) */
+  connectionSetupInstructions;
+  /** Phase 2: Data overview instructions */
+  dataOverviewInstructions;
+  constructor(config) {
+    this.connectionSetupInstructions = config.connectionSetupInstructions;
+    this.dataOverviewInstructions = config.dataOverviewInstructions;
+  }
+  getConnectionSetupPrompt(language) {
+    return this.connectionSetupInstructions?.[language] ?? null;
+  }
+  getDataOverviewInstructions(language) {
+    return this.dataOverviewInstructions[language];
+  }
+};
+
+// ../connectors/src/connector-tool.ts
+var ConnectorTool = class {
+  name;
+  description;
+  inputSchema;
+  outputSchema;
+  _execute;
+  constructor(config) {
+    this.name = config.name;
+    this.description = config.description;
+    this.inputSchema = config.inputSchema;
+    this.outputSchema = config.outputSchema;
+    this._execute = config.execute;
+  }
+  createTool(connections, config) {
+    return {
+      description: this.description,
+      inputSchema: this.inputSchema,
+      outputSchema: this.outputSchema,
+      execute: (input) => this._execute(input, connections, config)
+    };
+  }
+};
+
+// ../connectors/src/connector-plugin.ts
+var ConnectorPlugin = class _ConnectorPlugin {
+  slug;
+  authType;
+  name;
+  description;
+  iconUrl;
+  parameters;
+  releaseFlag;
+  proxyPolicy;
+  experimentalAttributes;
+  onboarding;
+  systemPrompt;
+  tools;
+  query;
+  checkConnection;
+  constructor(config) {
+    this.slug = config.slug;
+    this.authType = config.authType;
+    this.name = config.name;
+    this.description = config.description;
+    this.iconUrl = config.iconUrl;
+    this.parameters = config.parameters;
+    this.releaseFlag = config.releaseFlag;
+    this.proxyPolicy = config.proxyPolicy;
+    this.experimentalAttributes = config.experimentalAttributes;
+    this.onboarding = config.onboarding;
+    this.systemPrompt = config.systemPrompt;
+    this.tools = config.tools;
+    this.query = config.query;
+    this.checkConnection = config.checkConnection;
+  }
+  get connectorKey() {
+    return _ConnectorPlugin.deriveKey(this.slug, this.authType);
+  }
+  /**
+   * Create tools for connections that belong to this connector.
+   * Filters connections by connectorKey internally.
+   * Returns tools keyed as `${connectorKey}_${toolName}`.
+   */
+  createTools(connections, config, opts) {
+    const myConnections = connections.filter(
+      (c) => _ConnectorPlugin.deriveKey(c.connector.slug, c.connector.authType) === this.connectorKey
+    );
+    const result = {};
+    for (const t of Object.values(this.tools)) {
+      const tool = t.createTool(myConnections, config);
+      const originalToModelOutput = tool.toModelOutput;
+      result[`${this.connectorKey}_${t.name}`] = {
+        ...tool,
+        toModelOutput: async (options) => {
+          if (!originalToModelOutput) {
+            return opts.truncateOutput(options.output);
+          }
+          const modelOutput = await originalToModelOutput(options);
+          if (modelOutput.type === "text" || modelOutput.type === "json") {
+            return opts.truncateOutput(modelOutput.value);
+          }
+          return modelOutput;
+        }
+      };
+    }
+    return result;
+  }
+  static deriveKey(slug, authType) {
+    if (authType) return `${slug}-${authType}`;
+    const LEGACY_NULL_AUTH_TYPE_MAP = {
+      // user-password
+      "postgresql": "user-password",
+      "mysql": "user-password",
+      "clickhouse": "user-password",
+      "kintone": "user-password",
+      "squadbase-db": "user-password",
+      // service-account
+      "snowflake": "service-account",
+      "bigquery": "service-account",
+      "google-analytics": "service-account",
+      "google-calendar": "service-account",
+      "aws-athena": "service-account",
+      "redshift": "service-account",
+      // api-key
+      "databricks": "api-key",
+      "dbt": "api-key",
+      "airtable": "api-key",
+      "openai": "api-key",
+      "gemini": "api-key",
+      "anthropic": "api-key",
+      "wix-store": "api-key"
+    };
+    const fallbackAuthType = LEGACY_NULL_AUTH_TYPE_MAP[slug];
+    if (fallbackAuthType) return `${slug}-${fallbackAuthType}`;
+    return slug;
+  }
+};
+
+// ../connectors/src/auth-types.ts
+var AUTH_TYPES = {
+  OAUTH: "oauth",
+  API_KEY: "api-key",
+  JWT: "jwt",
+  SERVICE_ACCOUNT: "service-account",
+  PAT: "pat",
+  USER_PASSWORD: "user-password"
+};
+
+// ../connectors/src/connectors/tiktok-ads/tools/list-advertisers.ts
+import { z } from "zod";
+var BASE_URL2 = "https://business-api.tiktok.com/open_api/v1.3/";
+var REQUEST_TIMEOUT_MS = 6e4;
+var cachedToken = null;
+async function getProxyToken(config) {
+  if (cachedToken && cachedToken.expiresAt > Date.now() + 6e4) {
+    return cachedToken.token;
+  }
+  const url = `${config.appApiBaseUrl}/v0/database/${config.projectId}/environment/${config.environmentId}/oauth-request-proxy-token`;
+  const res = await fetch(url, {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+      "x-api-key": config.appApiKey,
+      "project-id": config.projectId
+    },
+    body: JSON.stringify({
+      sandboxId: config.sandboxId,
+      issuedBy: "coding-agent"
+    })
+  });
+  if (!res.ok) {
+    const errorText = await res.text().catch(() => res.statusText);
+    throw new Error(
+      `Failed to get proxy token: HTTP ${res.status} ${errorText}`
+    );
+  }
+  const data = await res.json();
+  cachedToken = {
+    token: data.token,
+    expiresAt: new Date(data.expiresAt).getTime()
+  };
+  return data.token;
+}
+var inputSchema = z.object({
+  toolUseIntent: z.string().optional().describe(
+    "Brief description of what you intend to accomplish with this tool call"
+  ),
+  connectionId: z.string().describe("ID of the TikTok Ads OAuth connection to use")
+});
+var outputSchema = z.discriminatedUnion("success", [
+  z.object({
+    success: z.literal(true),
+    advertisers: z.array(
+      z.object({
+        advertiserId: z.string(),
+        name: z.string()
+      })
+    )
+  }),
+  z.object({
+    success: z.literal(false),
+    error: z.string()
+  })
+]);
+var listAdvertisersTool = new ConnectorTool({
+  name: "listAdvertisers",
+  description: "List TikTok Ads advertiser accounts accessible with the current OAuth credentials.",
+  inputSchema,
+  outputSchema,
+  async execute({ connectionId }, connections, config) {
+    const connection2 = connections.find((c) => c.id === connectionId);
+    if (!connection2) {
+      return {
+        success: false,
+        error: `Connection ${connectionId} not found`
+      };
+    }
+    console.log(
+      `[connector-request] tiktok-ads/${connection2.name}: listAdvertisers`
+    );
+    try {
+      const token = await getProxyToken(config.oauthProxy);
+      const proxyUrl = `https://${config.oauthProxy.sandboxId}.${config.oauthProxy.previewBaseDomain}/_sqcore/connections/${connectionId}/request`;
+      const controller = new AbortController();
+      const timeout = setTimeout(() => controller.abort(), REQUEST_TIMEOUT_MS);
+      try {
+        const advertiserListResponse = await fetch(proxyUrl, {
+          method: "POST",
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${token}`
+          },
+          body: JSON.stringify({
+            url: `${BASE_URL2}oauth2/advertiser/get/`,
+            method: "GET"
+          }),
+          signal: controller.signal
+        });
+        const advertiserListData = await advertiserListResponse.json();
+        if (!advertiserListResponse.ok) {
+          return {
+            success: false,
+            error: advertiserListData?.message ?? `HTTP ${advertiserListResponse.status}`
+          };
+        }
+        if (advertiserListData.code !== void 0 && advertiserListData.code !== 0) {
+          return {
+            success: false,
+            error: advertiserListData.message ?? `API error code: ${advertiserListData.code}`
+          };
+        }
+        const advertisers = (advertiserListData.data?.list ?? []).map(
+          (adv) => ({
+            advertiserId: String(adv.advertiser_id ?? ""),
+            name: adv.advertiser_name ?? String(adv.advertiser_id ?? "")
+          })
+        );
+        return { success: true, advertisers };
+      } finally {
+        clearTimeout(timeout);
+      }
+    } catch (err) {
+      const msg = err instanceof Error ? err.message : String(err);
+      return { success: false, error: msg };
+    }
+  }
+});
+
+// ../connectors/src/connectors/tiktok-ads/setup.ts
+var listAdvertisersToolName = `tiktok-ads_${listAdvertisersTool.name}`;
+var tiktokAdsOnboarding = new ConnectorOnboarding({
+  connectionSetupInstructions: {
+    ja: `\u4EE5\u4E0B\u306E\u624B\u9806\u3067TikTok\u5E83\u544A (OAuth) \u30B3\u30CD\u30AF\u30B7\u30E7\u30F3\u306E\u30BB\u30C3\u30C8\u30A2\u30C3\u30D7\u3092\u884C\u3063\u3066\u304F\u3060\u3055\u3044\u3002
+
+1. \`${listAdvertisersToolName}\` \u3092\u547C\u3073\u51FA\u3057\u3066\u3001OAuth\u3067\u30A2\u30AF\u30BB\u30B9\u53EF\u80FD\u306A\u5E83\u544A\u4E3B\u30A2\u30AB\u30A6\u30F3\u30C8\u4E00\u89A7\u3092\u53D6\u5F97\u3059\u308B
+2. \u30A8\u30E9\u30FC\u304C\u767A\u751F\u3057\u305F\u5834\u5408\u306F\u30E6\u30FC\u30B6\u30FC\u306BOAuth\u63A5\u7D9A\u306E\u78BA\u8A8D\u3092\u4F9D\u983C\u3059\u308B
+3. \`updateConnectionParameters\` \u3092\u547C\u3073\u51FA\u3059:
+   - \`parameterSlug\`: \`"advertiser-id"\`
+   - \`options\`: \u5E83\u544A\u4E3B\u4E00\u89A7\u3002\u5404 option \u306E \`label\` \u306F \`\u5E83\u544A\u4E3B\u540D (id: \u5E83\u544A\u4E3BID)\` \u306E\u5F62\u5F0F\u3001\`value\` \u306F\u5E83\u544A\u4E3BID
+4. \u30E6\u30FC\u30B6\u30FC\u304C\u9078\u629E\u3057\u305F\u5E83\u544A\u4E3B\u306E \`label\` \u304C\u30E1\u30C3\u30BB\u30FC\u30B8\u3068\u3057\u3066\u5C4A\u304F\u306E\u3067\u3001\u6B21\u306E\u30B9\u30C6\u30C3\u30D7\u306B\u9032\u3080
+
+#### \u5236\u7D04
+- **\u30BB\u30C3\u30C8\u30A2\u30C3\u30D7\u4E2D\u306B\u30EC\u30DD\u30FC\u30C8\u30C7\u30FC\u30BF\u3092\u53D6\u5F97\u3057\u306A\u3044\u3053\u3068**\u3002\u5B9F\u884C\u3057\u3066\u3088\u3044\u306E\u306F\u4E0A\u8A18\u624B\u9806\u3067\u6307\u5B9A\u3055\u308C\u305F\u30E1\u30BF\u30C7\u30FC\u30BF\u53D6\u5F97\u306E\u307F
+- \u30C4\u30FC\u30EB\u9593\u306F1\u6587\u3060\u3051\u66F8\u3044\u3066\u5373\u6B21\u306E\u30C4\u30FC\u30EB\u547C\u3073\u51FA\u3057\u3002\u4E0D\u8981\u306A\u8AAC\u660E\u306F\u7701\u7565\u3057\u3001\u52B9\u7387\u7684\u306B\u9032\u3081\u308B`,
+    en: `Follow these steps to set up the TikTok Ads (OAuth) connection.
+
+1. Call \`${listAdvertisersToolName}\` to get the list of advertiser accounts accessible with the OAuth credentials
+2. If an error occurs, ask the user to verify their OAuth connection
+3. Call \`updateConnectionParameters\`:
+   - \`parameterSlug\`: \`"advertiser-id"\`
+   - \`options\`: The advertiser list. Each option's \`label\` should be \`Advertiser Name (id: advertiserId)\`, \`value\` should be the advertiser ID
+4. The \`label\` of the user's selected advertiser will arrive as a message. Proceed to the next step
+
+#### Constraints
+- **Do NOT fetch report data during setup**. Only the metadata requests specified in the steps above are allowed
+- Write only 1 sentence between tool calls, then immediately call the next tool. Skip unnecessary explanations and proceed efficiently`
+  },
+  dataOverviewInstructions: {
+    en: `1. Call tiktok-ads_request with GET campaign/get/ to explore campaign data
+2. Call tiktok-ads_request with GET adgroup/get/ to explore ad group data
+3. Call tiktok-ads_request with GET report/integrated/get/ with metrics=["spend","impressions","clicks","ctr","cpm","cpc"]&dimensions=["campaign_id"]&data_level=AUCTION_CAMPAIGN&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD to check recent performance`,
+    ja: `1. tiktok-ads_request \u3067 GET campaign/get/ \u3092\u547C\u3073\u51FA\u3057\u3066\u30AD\u30E3\u30F3\u30DA\u30FC\u30F3\u30C7\u30FC\u30BF\u3092\u63A2\u7D22
+2. tiktok-ads_request \u3067 GET adgroup/get/ \u3092\u547C\u3073\u51FA\u3057\u3066\u5E83\u544A\u30B0\u30EB\u30FC\u30D7\u30C7\u30FC\u30BF\u3092\u63A2\u7D22
+3. tiktok-ads_request \u3067 GET report/integrated/get/ \u306B metrics=["spend","impressions","clicks","ctr","cpm","cpc"]&dimensions=["campaign_id"]&data_level=AUCTION_CAMPAIGN&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD \u3092\u6307\u5B9A\u3057\u3066\u76F4\u8FD1\u306E\u30D1\u30D5\u30A9\u30FC\u30DE\u30F3\u30B9\u3092\u78BA\u8A8D`
+  }
+});
+
+// ../connectors/src/connectors/tiktok-ads/parameters.ts
+var parameters = {
+  advertiserId: new ParameterDefinition({
+    slug: "advertiser-id",
+    name: "Advertiser ID",
+    description: "The TikTok Ads advertiser ID. Found in the TikTok Ads Manager dashboard.",
+    envVarBaseKey: "TIKTOK_ADS_ADVERTISER_ID",
+    type: "text",
+    secret: false,
+    required: false
+  })
+};
+
+// ../connectors/src/connectors/tiktok-ads/tools/request.ts
+import { z as z2 } from "zod";
+var BASE_URL3 = "https://business-api.tiktok.com/open_api/v1.3/";
+var REQUEST_TIMEOUT_MS2 = 6e4;
+var cachedToken2 = null;
+async function getProxyToken2(config) {
+  if (cachedToken2 && cachedToken2.expiresAt > Date.now() + 6e4) {
+    return cachedToken2.token;
+  }
+  const url = `${config.appApiBaseUrl}/v0/database/${config.projectId}/environment/${config.environmentId}/oauth-request-proxy-token`;
+  const res = await fetch(url, {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+      "x-api-key": config.appApiKey,
+      "project-id": config.projectId
+    },
+    body: JSON.stringify({
+      sandboxId: config.sandboxId,
+      issuedBy: "coding-agent"
+    })
+  });
+  if (!res.ok) {
+    const errorText = await res.text().catch(() => res.statusText);
+    throw new Error(
+      `Failed to get proxy token: HTTP ${res.status} ${errorText}`
+    );
+  }
+  const data = await res.json();
+  cachedToken2 = {
+    token: data.token,
+    expiresAt: new Date(data.expiresAt).getTime()
+  };
+  return data.token;
+}
+var inputSchema2 = z2.object({
+  toolUseIntent: z2.string().optional().describe(
+    "Brief description of what you intend to accomplish with this tool call"
+  ),
+  connectionId: z2.string().describe("ID of the TikTok Ads OAuth connection to use"),
+  method: z2.enum(["GET", "POST"]).describe("HTTP method"),
+  path: z2.string().describe(
+    "API path appended to https://business-api.tiktok.com/open_api/v1.3/ (e.g., 'campaign/get/'). The advertiser_id is automatically injected."
+  ),
+  queryParams: z2.record(z2.string(), z2.string()).optional().describe("Query parameters to append to the URL"),
+  body: z2.record(z2.string(), z2.unknown()).optional().describe("POST request body (JSON)")
+});
+var outputSchema2 = z2.discriminatedUnion("success", [
+  z2.object({
+    success: z2.literal(true),
+    status: z2.number(),
+    data: z2.unknown()
+  }),
+  z2.object({
+    success: z2.literal(false),
+    error: z2.string()
+  })
+]);
+var requestTool = new ConnectorTool({
+  name: "request",
+  description: `Send authenticated requests to the TikTok Marketing API v1.3.
+Authentication is handled automatically via OAuth proxy.
+The advertiser_id is automatically injected if configured.`,
+  inputSchema: inputSchema2,
+  outputSchema: outputSchema2,
+  async execute({ connectionId, method, path: path2, queryParams, body }, connections, config) {
+    const connection2 = connections.find((c) => c.id === connectionId);
+    if (!connection2) {
+      return {
+        success: false,
+        error: `Connection ${connectionId} not found`
+      };
+    }
+    console.log(
+      `[connector-request] tiktok-ads/${connection2.name}: ${method} ${path2}`
+    );
+    try {
+      const advertiserId = parameters.advertiserId.tryGetValue(connection2) ?? "";
+      let url = `${BASE_URL3}${path2}`;
+      if (method === "GET") {
+        const params = new URLSearchParams(queryParams ?? {});
+        if (advertiserId && !params.has("advertiser_id")) {
+          params.set("advertiser_id", advertiserId);
+        }
+        if (params.toString()) {
+          const separator = url.includes("?") ? "&" : "?";
+          url = `${url}${separator}${params.toString()}`;
+        }
+      }
+      const requestBody = method === "POST" ? {
+        ...advertiserId ? { advertiser_id: advertiserId } : {},
+        ...body
+      } : void 0;
+      const token = await getProxyToken2(config.oauthProxy);
+      const proxyUrl = `https://${config.oauthProxy.sandboxId}.${config.oauthProxy.previewBaseDomain}/_sqcore/connections/${connectionId}/request`;
+      const controller = new AbortController();
+      const timeout = setTimeout(() => controller.abort(), REQUEST_TIMEOUT_MS2);
+      try {
+        const response = await fetch(proxyUrl, {
+          method: "POST",
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${token}`
+          },
+          body: JSON.stringify({
+            url,
+            method,
+            ...requestBody ? { body: JSON.stringify(requestBody) } : {}
+          }),
+          signal: controller.signal
+        });
+        const data = await response.json();
+        if (!response.ok) {
+          const dataObj2 = data;
+          const errorMessage = typeof dataObj2?.message === "string" ? dataObj2.message : `HTTP ${response.status} ${response.statusText}`;
+          return { success: false, error: errorMessage };
+        }
+        const dataObj = data;
+        if (dataObj.code !== void 0 && dataObj.code !== 0) {
+          return {
+            success: false,
+            error: dataObj.message ?? `API error code: ${dataObj.code}`
+          };
+        }
+        return { success: true, status: response.status, data };
+      } finally {
+        clearTimeout(timeout);
+      }
+    } catch (err) {
+      const msg = err instanceof Error ? err.message : String(err);
+      return { success: false, error: msg };
+    }
+  }
+});
+
+// ../connectors/src/connectors/tiktok-ads/index.ts
+var tools = {
+  request: requestTool,
+  listAdvertisers: listAdvertisersTool
+};
+var tiktokAdsConnector = new ConnectorPlugin({
+  slug: "tiktok-ads",
+  authType: AUTH_TYPES.OAUTH,
+  name: "TikTok Ads",
+  description: "Connect to TikTok Ads for advertising campaign data and reporting using OAuth.",
+  iconUrl: "https://images.ctfassets.net/9ncizv60xc5y/01jHuwvmhe4ts0wj23Hxpm/afac9fa50ac5b353927900a122e898ab/tiktok.webp",
+  parameters,
+  releaseFlag: { dev1: true, dev2: false, prod: false },
+  onboarding: tiktokAdsOnboarding,
+  proxyPolicy: {
+    allowlist: [
+      {
+        host: "business-api.tiktok.com",
+        methods: ["GET", "POST"]
+      }
+    ]
+  },
+  systemPrompt: {
+    en: `### Tools
+
+- \`tiktok-ads_request\`: Send authenticated requests to the TikTok Marketing API v1.3. Authentication is handled automatically via OAuth proxy. The advertiser_id is automatically injected if configured.
+- \`tiktok-ads_listAdvertisers\`: List accessible TikTok Ads advertiser accounts. Use this during setup to discover available accounts.
+
+### TikTok Marketing API Reference
+
+#### Get Advertiser Info
+- GET advertiser/info/?advertiser_id={advertiserId}
+
+#### List Campaigns
+- GET campaign/get/?advertiser_id={advertiserId}&page=1&page_size=100
+
+#### List Ad Groups
+- GET adgroup/get/?advertiser_id={advertiserId}&page=1&page_size=100
+
+#### List Ads
+- GET ad/get/?advertiser_id={advertiserId}&page=1&page_size=100
+
+#### Get Integrated Report
+- GET report/integrated/get/?advertiser_id={advertiserId}&report_type=BASIC&data_level=AUCTION_CAMPAIGN&dimensions=["campaign_id","stat_time_day"]&metrics=["spend","impressions","clicks","ctr","cpm","cpc","conversions","conversion_rate","cost_per_conversion"]&start_date=2025-01-01&end_date=2025-01-31
+
+### Report Data Levels
+- \`AUCTION_CAMPAIGN\`: Campaign-level metrics
+- \`AUCTION_ADGROUP\`: Ad group-level metrics
+- \`AUCTION_AD\`: Ad-level metrics
+- \`AUCTION_ADVERTISER\`: Advertiser-level metrics
+
+### Common Dimensions
+campaign_id, adgroup_id, ad_id, stat_time_day, stat_time_hour, country_code, age, gender
+
+### Common Metrics
+spend, impressions, clicks, reach, frequency, ctr, cpc, cpm,
+conversions, conversion_rate, cost_per_conversion,
+total_complete_payment, total_add_to_cart,
+video_play_actions, video_watched_2s, video_watched_6s, average_video_play_per_user
+
+### Date Range Limits
+- With stat_time_day or stat_time_hour dimensions: max 30 days
+- Without time dimensions: max 90 days
+
+### Pagination
+- Use \`page\` and \`page_size\` (max 1000) parameters
+- Response includes \`page_info.total_number\` and \`page_info.total_page\`
+
+### Tips
+- TikTok API responses have a top-level \`code\` (0 = success) and \`message\` field
+- Arrays in query parameters must be JSON-encoded (e.g., metrics=["spend","clicks"])
+- advertiser_id is required for almost all endpoints
+- Filtering supports IN, NOT_IN operators with JSON array values
+
+### Business Logic
+
+The business logic type for this connector is "typescript". Write handler code using the connector SDK shown below. Do NOT access credentials directly from environment variables.
+
+#### Example
+
+\`\`\`ts
+import { connection } from "@squadbase/vite-server/connectors/tiktok-ads";
+
+const tiktok = connection("<connectionId>");
+
+// Get campaigns
+const res = await tiktok.request("campaign/get/?advertiser_id={advertiserId}");
+const data = await res.json();
+\`\`\``,
+    ja: `### \u30C4\u30FC\u30EB
+
+- \`tiktok-ads_request\`: TikTok Marketing API v1.3\u3078\u8A8D\u8A3C\u6E08\u307F\u30EA\u30AF\u30A8\u30B9\u30C8\u3092\u9001\u4FE1\u3057\u307E\u3059\u3002\u8A8D\u8A3C\u306FOAuth\u30D7\u30ED\u30AD\u30B7\u7D4C\u7531\u3067\u81EA\u52D5\u7684\u306B\u51E6\u7406\u3055\u308C\u307E\u3059\u3002advertiser_id\u304C\u8A2D\u5B9A\u3055\u308C\u3066\u3044\u308B\u5834\u5408\u306F\u81EA\u52D5\u7684\u306B\u6CE8\u5165\u3055\u308C\u307E\u3059\u3002
+- \`tiktok-ads_listAdvertisers\`: \u30A2\u30AF\u30BB\u30B9\u53EF\u80FD\u306ATikTok Ads\u5E83\u544A\u4E3B\u30A2\u30AB\u30A6\u30F3\u30C8\u306E\u4E00\u89A7\u3092\u53D6\u5F97\u3057\u307E\u3059\u3002\u30BB\u30C3\u30C8\u30A2\u30C3\u30D7\u6642\u306B\u5229\u7528\u53EF\u80FD\u306A\u30A2\u30AB\u30A6\u30F3\u30C8\u3092\u78BA\u8A8D\u3059\u308B\u305F\u3081\u306B\u4F7F\u7528\u3057\u307E\u3059\u3002
+
+### TikTok Marketing API \u30EA\u30D5\u30A1\u30EC\u30F3\u30B9
+
+#### \u5E83\u544A\u4E3B\u60C5\u5831\u306E\u53D6\u5F97
+- GET advertiser/info/?advertiser_id={advertiserId}
+
+#### \u30AD\u30E3\u30F3\u30DA\u30FC\u30F3\u4E00\u89A7
+- GET campaign/get/?advertiser_id={advertiserId}&page=1&page_size=100
+
+#### \u5E83\u544A\u30B0\u30EB\u30FC\u30D7\u4E00\u89A7
+- GET adgroup/get/?advertiser_id={advertiserId}&page=1&page_size=100
+
+#### \u5E83\u544A\u4E00\u89A7
+- GET ad/get/?advertiser_id={advertiserId}&page=1&page_size=100
+
+#### \u7D71\u5408\u30EC\u30DD\u30FC\u30C8\u306E\u53D6\u5F97
+- GET report/integrated/get/?advertiser_id={advertiserId}&report_type=BASIC&data_level=AUCTION_CAMPAIGN&dimensions=["campaign_id","stat_time_day"]&metrics=["spend","impressions","clicks","ctr","cpm","cpc","conversions","conversion_rate","cost_per_conversion"]&start_date=2025-01-01&end_date=2025-01-31
+
+### \u30EC\u30DD\u30FC\u30C8\u306E\u30C7\u30FC\u30BF\u30EC\u30D9\u30EB
+- \`AUCTION_CAMPAIGN\`: \u30AD\u30E3\u30F3\u30DA\u30FC\u30F3\u30EC\u30D9\u30EB\u306E\u30E1\u30C8\u30EA\u30AF\u30B9
+- \`AUCTION_ADGROUP\`: \u5E83\u544A\u30B0\u30EB\u30FC\u30D7\u30EC\u30D9\u30EB\u306E\u30E1\u30C8\u30EA\u30AF\u30B9
+- \`AUCTION_AD\`: \u5E83\u544A\u30EC\u30D9\u30EB\u306E\u30E1\u30C8\u30EA\u30AF\u30B9
+- \`AUCTION_ADVERTISER\`: \u5E83\u544A\u4E3B\u30EC\u30D9\u30EB\u306E\u30E1\u30C8\u30EA\u30AF\u30B9
+
+### \u4E3B\u8981\u306A\u30C7\u30A3\u30E1\u30F3\u30B7\u30E7\u30F3
+campaign_id, adgroup_id, ad_id, stat_time_day, stat_time_hour, country_code, age, gender
+
+### \u4E3B\u8981\u306A\u30E1\u30C8\u30EA\u30AF\u30B9
+spend, impressions, clicks, reach, frequency, ctr, cpc, cpm,
+conversions, conversion_rate, cost_per_conversion,
+total_complete_payment, total_add_to_cart,
+video_play_actions, video_watched_2s, video_watched_6s, average_video_play_per_user
+
+### \u65E5\u4ED8\u7BC4\u56F2\u306E\u5236\u9650
+- stat_time_day\u307E\u305F\u306Fstat_time_hour\u30C7\u30A3\u30E1\u30F3\u30B7\u30E7\u30F3\u4F7F\u7528\u6642: \u6700\u592730\u65E5\u9593
+- \u6642\u9593\u30C7\u30A3\u30E1\u30F3\u30B7\u30E7\u30F3\u306A\u3057: \u6700\u592790\u65E5\u9593
+
+### \u30DA\u30FC\u30B8\u30CD\u30FC\u30B7\u30E7\u30F3
+- \`page\` \u3068 \`page_size\`\uFF08\u6700\u59271000\uFF09\u30D1\u30E9\u30E1\u30FC\u30BF\u3092\u4F7F\u7528
+- \u30EC\u30B9\u30DD\u30F3\u30B9\u306B \`page_info.total_number\` \u3068 \`page_info.total_page\` \u304C\u542B\u307E\u308C\u308B
+
+### \u30D2\u30F3\u30C8
+- TikTok API\u306E\u30EC\u30B9\u30DD\u30F3\u30B9\u306B\u306F\u30C8\u30C3\u30D7\u30EC\u30D9\u30EB\u306E \`code\`\uFF080 = \u6210\u529F\uFF09\u3068 \`message\` \u30D5\u30A3\u30FC\u30EB\u30C9\u304C\u3042\u308B
+- \u30AF\u30A8\u30EA\u30D1\u30E9\u30E1\u30FC\u30BF\u306E\u914D\u5217\u306FJSON\u5F62\u5F0F\u3067\u30A8\u30F3\u30B3\u30FC\u30C9\u3059\u308B\u5FC5\u8981\u304C\u3042\u308B\uFF08\u4F8B\uFF1Ametrics=["spend","clicks"]\uFF09
+- \u307B\u307C\u5168\u3066\u306E\u30A8\u30F3\u30C9\u30DD\u30A4\u30F3\u30C8\u3067 advertiser_id \u304C\u5FC5\u8981
+- \u30D5\u30A3\u30EB\u30BF\u30EA\u30F3\u30B0\u306FIN\u3001NOT_IN\u6F14\u7B97\u5B50\u3092JSON\u914D\u5217\u5024\u3067\u30B5\u30DD\u30FC\u30C8
+
+### Business Logic
+
+\u3053\u306E\u30B3\u30CD\u30AF\u30BF\u306E\u30D3\u30B8\u30CD\u30B9\u30ED\u30B8\u30C3\u30AF\u30BF\u30A4\u30D7\u306F "typescript" \u3067\u3059\u3002\u4EE5\u4E0B\u306B\u793A\u3059\u30B3\u30CD\u30AF\u30BFSDK\u3092\u4F7F\u7528\u3057\u3066\u30CF\u30F3\u30C9\u30E9\u30B3\u30FC\u30C9\u3092\u8A18\u8FF0\u3057\u3066\u304F\u3060\u3055\u3044\u3002\u74B0\u5883\u5909\u6570\u304B\u3089\u76F4\u63A5\u8A8D\u8A3C\u60C5\u5831\u306B\u30A2\u30AF\u30BB\u30B9\u3057\u306A\u3044\u3067\u304F\u3060\u3055\u3044\u3002
+
+#### Example
+
+\`\`\`ts
+import { connection } from "@squadbase/vite-server/connectors/tiktok-ads";
+
+const tiktok = connection("<connectionId>");
+
+// \u30AD\u30E3\u30F3\u30DA\u30FC\u30F3\u3092\u53D6\u5F97
+const res = await tiktok.request("campaign/get/?advertiser_id={advertiserId}");
+const data = await res.json();
+\`\`\``
+  },
+  tools,
+  async checkConnection(_params, config) {
+    const { proxyFetch } = config;
+    try {
+      const url = `https://business-api.tiktok.com/open_api/v1.3/user/info/`;
+      const res = await proxyFetch(url, { method: "GET" });
+      if (!res.ok) {
+        return {
+          success: false,
+          error: `TikTok API failed: HTTP ${res.status}`
+        };
+      }
+      const data = await res.json();
+      if (data.code !== void 0 && data.code !== 0) {
+        return {
+          success: false,
+          error: data.message ?? `API error code: ${data.code}`
+        };
+      }
+      return { success: true };
+    } catch (error) {
+      return {
+        success: false,
+        error: error instanceof Error ? error.message : String(error)
+      };
+    }
+  }
+});
+
+// src/connectors/create-connector-sdk.ts
+import { readFileSync } from "fs";
+import path from "path";
+
+// src/connector-client/env.ts
+function resolveEnvVar(entry, key, connectionId) {
+  const envVarName = entry.envVars[key];
+  if (!envVarName) {
+    throw new Error(`Connection "${connectionId}" is missing envVars mapping for key "${key}"`);
+  }
+  const value = process.env[envVarName];
+  if (!value) {
+    throw new Error(`Environment variable "${envVarName}" (for connection "${connectionId}", key "${key}") is not set`);
+  }
+  return value;
+}
+function resolveEnvVarOptional(entry, key) {
+  const envVarName = entry.envVars[key];
+  if (!envVarName) return void 0;
+  return process.env[envVarName] || void 0;
+}
+
+// src/connector-client/proxy-fetch.ts
+import { getContext } from "hono/context-storage";
+import { getCookie } from "hono/cookie";
+var APP_SESSION_COOKIE_NAME = "__Host-squadbase-session";
+function normalizeHeaders(input) {
+  const out = {};
+  if (!input) return out;
+  new Headers(input).forEach((value, key) => {
+    out[key] = value;
+  });
+  return out;
+}
+function createSandboxProxyFetch(connectionId) {
+  return async (input, init) => {
+    const token = process.env.INTERNAL_SQUADBASE_OAUTH_MACHINE_CREDENTIAL;
+    const sandboxId = process.env.INTERNAL_SQUADBASE_SANDBOX_ID;
+    if (!token || !sandboxId) {
+      throw new Error(
+        "Connection proxy is not configured. Please check your deployment settings."
+      );
+    }
+    const originalUrl = typeof input === "string" ? input : input instanceof URL ? input.href : input.url;
+    const originalMethod = init?.method ?? "GET";
+    const originalBody = init?.body ? JSON.parse(init.body) : void 0;
+    const baseDomain = process.env["SQUADBASE_PREVIEW_BASE_DOMAIN"] ?? "preview.app.squadbase.dev";
+    const proxyUrl = `https://${sandboxId}.${baseDomain}/_sqcore/connections/${connectionId}/request`;
+    return fetch(proxyUrl, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${token}`
+      },
+      body: JSON.stringify({
+        url: originalUrl,
+        method: originalMethod,
+        headers: normalizeHeaders(init?.headers),
+        body: originalBody
+      })
+    });
+  };
+}
+function createDeployedAppProxyFetch(connectionId) {
+  const projectId = process.env["SQUADBASE_PROJECT_ID"];
+  if (!projectId) {
+    throw new Error(
+      "Connection proxy is not configured. Please check your deployment settings."
+    );
+  }
+  const baseDomain = process.env["SQUADBASE_APP_BASE_DOMAIN"] ?? "squadbase.app";
+  const proxyUrl = `https://${projectId}.${baseDomain}/_sqcore/connections/${connectionId}/request`;
+  return async (input, init) => {
+    const originalUrl = typeof input === "string" ? input : input instanceof URL ? input.href : input.url;
+    const originalMethod = init?.method ?? "GET";
+    const originalBody = init?.body ? JSON.parse(init.body) : void 0;
+    const c = getContext();
+    const appSession = getCookie(c, APP_SESSION_COOKIE_NAME);
+    if (!appSession) {
+      throw new Error(
+        "No authentication method available for connection proxy."
+      );
+    }
+    return fetch(proxyUrl, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${appSession}`
+      },
+      body: JSON.stringify({
+        url: originalUrl,
+        method: originalMethod,
+        headers: normalizeHeaders(init?.headers),
+        body: originalBody
+      })
+    });
+  };
+}
+function createProxyFetch(connectionId) {
+  if (process.env.INTERNAL_SQUADBASE_SANDBOX_ID) {
+    return createSandboxProxyFetch(connectionId);
+  }
+  return createDeployedAppProxyFetch(connectionId);
+}
+
+// src/connectors/create-connector-sdk.ts
+function loadConnectionsSync() {
+  const filePath = process.env.CONNECTIONS_PATH ?? path.join(process.cwd(), ".squadbase/connections.json");
+  try {
+    const raw = readFileSync(filePath, "utf-8");
+    return JSON.parse(raw);
+  } catch {
+    return {};
+  }
+}
+function createConnectorSdk(plugin, createClient2) {
+  return (connectionId) => {
+    const connections = loadConnectionsSync();
+    const entry = connections[connectionId];
+    if (!entry) {
+      throw new Error(
+        `Connection "${connectionId}" not found in .squadbase/connections.json`
+      );
+    }
+    if (entry.connector.slug !== plugin.slug) {
+      throw new Error(
+        `Connection "${connectionId}" is not a ${plugin.slug} connection (got "${entry.connector.slug}")`
+      );
+    }
+    const params = {};
+    for (const param of Object.values(plugin.parameters)) {
+      if (param.required) {
+        params[param.slug] = resolveEnvVar(entry, param.slug, connectionId);
+      } else {
+        const val = resolveEnvVarOptional(entry, param.slug);
+        if (val !== void 0) params[param.slug] = val;
+      }
+    }
+    return createClient2(params, createProxyFetch(connectionId));
+  };
+}
+
+// src/connectors/entries/tiktok-ads.ts
+var connection = createConnectorSdk(tiktokAdsConnector, createClient);
+export {
+  connection
+};