engage-sdk-integration

Generate Play Engage SDK publishing boilerplate and map data classes to Engage entities.

6.6k|388|Updated Mar 16, 2026
One-click install
npx skills add https://github.com/android/skills --skill engage-sdk-integration-android
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: engage-sdk-integration
Source: https://github.com/android/skills/tree/main/play/engage-sdk-integration
Command: npx skills add https://github.com/android/skills --skill engage-sdk-integration-android

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill solves the problem of developers getting stuck when integrating the Play Engage SDK—especially when they need to map their app’s models to the correct Engage entities, wire the required publishing workflow, and fix common SDK-related build and runtime errors.

Core Features & Use Cases

  • Vertical & cluster alignment: Guides you to identify the correct Engage entities, client class, and publish method for your app’s specific vertical and chosen cluster type.
  • Boilerplate integration & publishing workflow: Generates the required Engage publishing components (constants, converters, request factory, WorkManager worker, publisher orchestrator, and broadcast receiver).
  • Entity mapping & data publishing: Helps you map your local data model into the Engage entity schema and construct the correct cluster publish requests using the provided reference materials.
  • Gradle/manifest setup and debugging: Specifies the dependency versions, AndroidManifest receiver/service declarations, and an error-resolution order when compilation or integration fails.
  • Correct receiver registration (critical): Ensures both static AndroidManifest registration and dynamic receiver registration via EngageBroadcastReceiver.register(context) to make broadcasts work reliably.

Quick Start

Use the engage-sdk-integration skill to generate the Engage publishing boilerplate for your app, then confirm that both static <receiver> registration and dynamic EngageBroadcastReceiver.register(context) are implemented in your Application or MainActivity.

Frequently Asked Questions about engage-sdk-integration

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I integrate the Play Engage SDK and map my local data to Engage entities?

To integrate the Play Engage SDK, you select the correct vertical-specific client, map your local data classes to Engage entities using cluster schemas, and construct cluster publish requests using the provided reference materials.

Can I use WorkManager to handle Play Engage SDK publishing workflows?

Yes, you can use WorkManager to handle Play Engage SDK publishing. The integration requires wiring a WorkManager-based worker and a publisher orchestrator to construct request payloads and manage the cluster publish workflows.

Why does my Play Engage SDK BroadcastReceiver not receive broadcasts after registration?

Your Play Engage SDK BroadcastReceiver might fail because it requires both static AndroidManifest registration and dynamic registration via EngageBroadcastReceiver.register(context) in your Application or MainActivity to work reliably.

What Gradle dependencies and AndroidManifest entries are needed for Play Engage SDK integration?

Play Engage SDK integration requires specifying correct dependency versions in Gradle and declaring the required BroadcastReceiver and service components in the AndroidManifest to resolve SDK-related build and runtime errors.

Does the Play Engage SDK support both mobile and TV publishing workflows?

Yes, the Play Engage SDK supports both mobile and TV publishing workflows. The integration process generates required publishing boilerplate code and resolves SDK-related publishing errors for mobile and TV when applicable.

What is the best way to resolve Play Engage SDK build and compilation errors?

The best way to resolve Play Engage SDK build errors is to follow a specific error-resolution order that verifies Gradle dependencies, AndroidManifest receiver declarations, and entity mapping configurations.