How to Apply for data-group-id for Shared Sandbox (IME Kit)

Read the original article：How to Apply for data-group-id for Shared Sandbox (IME Kit)

Context

Custom input methods (IMEs) that use the Shared Sandbox in HarmonyOS need a data-group-id to securely share data between components. Developers must request this identifier before shipping features that rely on shared storage.

Description

Issue: How do you apply for a data-group-id used by a custom input method’s Shared Sandbox?
Answer: Submit an application via email with specific subject/content and required screenshots. Approval is returned by email.

Solution / Approach

1. Send an email to: [e-mail]
2. Email subject format: [Input Method Application for In-App Data Sharing] <Your App Name> Application
3. Email body (include these fields):
   • Application appid: <your appid>
   • Application name: <your app name>
   • Developer id: <your developer id>
4. Attach the following:
   • Screenshot 1: Your input method app installed and visible in the system’s input method list (Settings).
   • Screenshot 2: The InputMethodExtensionAbility configuration from your app’s module.json5.
5. Review & approval: You’ll receive the result via email after review.

Notes: Processing time may vary; ensure the screenshots clearly show the IME enabled and the exact bundle/module configuration to avoid back-and-forth. If your team uses multiple variants (beta/stable), specify each appid. After approval, store the data-group-id securely and keep it consistent across releases to maintain access to previously written shared data.

Key Takeaways

• A data-group-id is required for Shared Sandbox usage in custom IMEs.
• Apply by emailing [e-mail] with the subject format, appid/app name/developer id, and two screenshots.
• Approval updates are returned by email.

Written by Fatih Turan Gundogdu