Ae Data Integration Helper

ae-data-integration-helper

Conversation language: This skill document is in English, but all output to the user MUST be in the user's input language. Chinese input → Chinese reply; English input → English reply; Japanese input → Japanese reply. If uncertain, default to English. This applies to all output: headings, step descriptions, code comments, examples, etc. ⚠️ CRITICAL: Many reference documents (FAQ, wiki) are in Chinese. When reading Chinese source material to answer an English/Japanese user, you MUST translate the content to the user's language. The source document's language is NOT the user's language. Never output Chinese to an English user just because the wiki page is in Chinese. Use the Terminology Glossary above to map terms accurately. Do NOT copy Chinese text verbatim from this document into English/Japanese replies.

Terminology Glossary

When to Trigger

Trigger when a user asks about:

• Pre-ingestion Preparation:
• User identification rules (distinct_id / account_id / visitor ID / login ID)
• Data rules (event format / property types / validation)
• Preset properties & system fields (#device_id, #time, etc.)
• Client SDK Integration: Android / iOS / JavaScript / Unity / OpenHarmony / Mini-program, etc.
• Server SDK Integration: Java / Python / Go / Node.js / PHP / C#, etc.
• Data Import: LogBus2 / RESTful API / DataX
• Advanced Data Types: Updatable events / first event check
• Auto-tracking: Page view / button click / app start, etc.
• Real-time Debugging: Debug mode / device binding / data validation
• Compliance / Privacy: GDPR / privacy policy / SDK data collection rules
• API Usage: init / track / user_set / LoggerConsumer, etc.
• Configuration: Debug mode / data validation / retry strategy
• Troubleshooting: Upload failures / missing data / format errors

Do NOT trigger: Inline Q&A within ae-generate-tracking-plan or ae-generate-tracking-code sessions (those skills have their own workflows). Offline local-file import (CSV / Excel / JSONL → AE) and Feishu sheet URL import are owned by the ae-data-integration skill — route those requests there instead of answering with LogBus / RESTful guidance.

Workflow

Step 1: Parse the Question

Extract from the user's query:

• Topic category:
• Pre-ingestion Prep: User identification / data rules / preset properties
• Client SDK: Android / iOS / JavaScript / Unity / OpenHarmony / Mini-program, etc.
• Server SDK: Java / Python / Go / Node.js / PHP / C#, etc.
• Data Import: LogBus2 / RESTful API / DataX
• Advanced Data Types: Updatable events / first event check
• Auto-tracking: Page view / button click / app start
• Real-time Debug: Debug mode / device binding / data validation
• Compliance: GDPR / privacy policy / SDK data collection rules
• Query type: Integration method / API usage / configuration / deployment / error / logging

Step 1.5: Information Gathering

⚠️ Key principle: When the question is vague, gather information FIRST before answering. Do NOT guess or ramble.

If the user's question involves any of the following scenarios, collect critical information before proceeding:

Ask first, then answer. Examples:

• "Data logs show success but the dashboard shows nothing — are you using SDK, LogBus, or HTTP upload?"
• "Can't connect — which language/platform are you using? Can you share the error message?"

Step 2: Find Relevant Documentation

Prefer FAQ documents first (for quick lookup of specific issues):

1. Read skills/ae-data-integration-helper/references/ corresponding FAQ (e.g., android_sdk_faq.md, logbus2_guide.md, etc.)
2. FAQ documents cover specific troubleshooting, code examples, parameter tables, and best practices

Check wiki when FAQ has no answer (for framework-level and authoritative content):

1. Read ~/.ae-cli/wiki/te-docs/index.md to locate document paths
2. Prefer overview documents under ~/.ae-cli/wiki/te-docs/synthesis/
3. For detailed API references, check the corresponding main document under ~/.ae-cli/wiki/te-docs/raw/

Commonly used FAQ documents:

• references/android_sdk_faq.md — Android SDK integration & FAQ
• references/ios_sdk_faq.md — iOS SDK integration & FAQ
• references/java_sdk_faq.md — Java SDK integration & FAQ
• references/logbus2_guide.md — LogBus2 complete configuration guide
• references/sdk_usage_notes.md — Client/server SDK usage notes
• references/restful_api_notes.md — RESTful API usage notes
• Full list: see references/index.md

Step 3: Read & Summarize

After reading relevant documentation, output in the following format:

## <Topic> (<Platform>)

### Summary
<1-2 sentence description>

### Integration / Usage Steps
1. <Step 1>
2. <Step 2>
...

### Code Example

<code>

### Notes / Caveats
- <Note 1>
- <Note 2>

### Source Document
<Prefer wiki document sourceUrl. Language rules:
  - User interacts in Chinese → provide Chinese doc (lan=zh-CN)
  - User interacts in other languages → provide English doc (lan=en-US)
  - Chinese-only SDKs (Mini-program / OpenHarmony / Cocos2d-Lua / LayaAir / Egret) → Chinese only
  Example: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=xxx>
(If no sourceUrl, provide local .md file path)

⚠️ Terminology Rules: