Engage SDK Integration
Android (Google)OfficialCreated by Google LLCDistributed by Android (Google)
- Skill
- Tool integration
- Software development
- Apache-2.0
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides a structured workflow for Android developers to integrate the Play Engage SDK. It covers the end-to-end process, including identifying vertical-specific requirements, generating necessary boilerplate code, mapping local data models to Engage entities, and configuring broadcast receivers for data synchronization. The skill also includes a verification checklist and troubleshooting guidance to ensure a robust implementation.
What it does
- Guides developers through vertical-specific Engage SDK integration steps.
- Generates boilerplate code for constants, entity converters, request factories, and workers.
- Assists in mapping local app models to required Engage entity schemas.
- Provides instructions for both static and dynamic broadcast receiver registration.
- Offers a self-verification checklist to ensure successful implementation.
- Provides troubleshooting steps for common compilation and integration errors.
When to use it
- When adding Play Engage SDK support to an Android application.
- When generating publishing code for recommendation or continuation clusters.
- When mapping existing local data classes to Engage-compatible entities.
- When debugging SDK-related errors or implementation issues.
Advantages
- Ensures adherence to mandatory SDK structure and entity requirements.
- Reduces manual effort by providing standardized code templates.
- Promotes best practices for background data synchronization.
- Simplifies the complex process of vertical-specific configuration.
Usage examples
- “How do I integrate the Engage SDK for my food delivery app?”
- The agent will identify the food vertical, guide you through selecting the appropriate cluster types, and generate the required boilerplate classes like ItemToEntityConverter and EngageWorker.
- “I am getting a background execution error with my broadcast receiver. How do I fix it?”
- The agent will instruct you to implement dynamic registration for your EngageBroadcastReceiver and verify that the correct permissions are handled.
- “How do I map my local restaurant data class to a StoreEntity?”
- The agent will analyze your data class, compare it against the food schema, and generate the conversion logic for your ItemToEntityConverter.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/android/engage-sdk-integration/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip engage-sdk-integration.zip -d .agents/skills
Documentation by Google LLC
This skill guides you through integrating the Play Engage SDK into an Android app. It ensures that the code follows the mandatory structure and uses the required Engage entities for each vertical.
Workflow
Follow these steps to assist the developer:
Identify vertical and cluster:
Ask the developer which vertical their app belongs to based on references/schemas/.
Check if the integration is for TV or mobile. If the integration is for TV, read the TV-specific sections in patterns.md as well.
Use
{VERTICAL}.mdin the references/schemas/ directory to identify the corresponding Engage entities and theclientclass name. Theclientfield in the JSON provides the full class name. For example,com.google.android.engage.food.service.AppEngageFoodClient.Note: Initializing the client class requires a
Contextparameter. For example,AppEngageFoodClient(context).Always refer to common.md for common entities.
Ask which cluster type they want to publish from the supported cluster types for that vertical.
Find the method to call from
{VERTICAL}.mdin the references/schemas/ directory for the specified cluster. Each method will specify the request it expects.Get the request structure from requests.md and clusters from clusters.md. Then suggest and use sources to fill the fields in the request structure correctly, along with the required entities and clusters.
Generate structured boilerplate code:
Create a new directory for all Engage-related code. Name the directory to match the naming convention of the existing codebase.
Generate the following classes using templates in patterns.md:
Constants: holds constant values such as attempt counts and publish types.ItemToEntityConverter: converts the app's local models to Engage's Entity models.ClusterRequestFactory: constructs the publish requests.EngageWorker: handles the actual publishing and publish errors using WorkManager.EngagePublisher: orchestrates periodic and one-time jobs.EngageBroadcastReceiver: listens for AppEngageService intents and starts a one-time publish job fromEngagePublisher. Important : Implement both static registration and dynamic registration patterns, including the companion objectregistermethod inside theEngageBroadcastReceiverclass.
Suggest entity mapping:
Ask the developer to provide their local model schema (for example, a data class or a JSON snippet).
If they haven't provided one, share entities from
{VERTICAL}.mdin the references/schemas/ directory as a guide.Once the local model is identified, suggest a mapping to the corresponding Engage entity.
Generate the conversion logic using the
ItemToEntityConverterpattern in patterns.md and add it to the generated{ENGAGE_CODE_DIR}/ItemToEntityConverter.
Suggest data source:
Ask the developer to provide the source of actual data you'll publish.
Once you identify the data source, use it to fetch the data in the app's local model schema.
Use
{ENGAGE_CODE_DIR}/ItemToEntityConverterto convert this data to an Engage entity.Use obtained Engage entity model data with
{ENGAGE_CODE_DIR}/ ClusterRequestFactoryto get cluster requests.Call corresponding cluster publishing method obtained from
{VERTICAL}.mdin the references/schemas/ directory with the obtained request in previous step in{ENGAGE_CODE_DIR}/EngageWorker.
Gradle and manifest updates:
Suggest updates to
build.gradleandAndroidManifest.xml.For mobile apps, use patterns.md.
For TV apps, use the TV-specific sections in patterns.md.
Provide the necessary
implementationdependencies forbuild.gradleorbuild.gradle.ktsfrom patterns.md.Provide the
<receiver>and<service>declarations forAndroidManifest.xml.Note: Except for TV, there aren't any vertical-specific imports. For all other verticals,
com.google.android.engage:engage-core:1.6.0is sufficient.
Debugging and verification:
Self-verification checklist : Before considering your work complete, you must verify that you've implemented all of the following:
[ ] Registered
EngageBroadcastReceiverstatically inAndroidManifest.xml(inside the<application>tag).[ ] Registered
EngageBroadcastReceiverdynamically by callingEngageBroadcastReceiver.register(context)in theApplicationclass or mainActivityclass.[ ] Implemented the
registermethod inEngageBroadcastReceiver'scompanion objectto handle dynamic registration.[ ] Handled empty data lists in
EngageWorker(for example, by deleting the cluster instead of publishing empty data).
Perform a Gradle sync.
If errors occur (such as import failures, namespace conflicts, or compile errors), read references/troubleshooting.md to resolve them.
Execute a Gradle compilation (
./gradlew compileDebugUnitTestSourcesor./gradlew assembleDebug). See references/troubleshooting.md for compile rules and warnings about fast-compilation shortcuts. Repeat this step until compilation is successful.
User checklist: At the end of code generation, notify the user to go through this checklist to verify that the integration is complete and as intended:
[ ] Verify that all the Engage-related files are created in
{ENGAGE_CODE_DIR}/:ConstantsItemToEntityConverterClusterRequestFactoryEngageWorker{cluster_type}PublisherEngageBroadcastReceiver
[ ] Verify that app's local model is converted to Engage entity by populating the fields correctly in the model in
{ENGAGE_CODE_DIR}/ItemToEntityConverter.[ ] Verify that all image URIs in
ItemToEntityConverterpoint to images matching the strict aspect ratio requirements of the vertical (for example, 16:9, 1:1, 2:3).[ ] Verify that
{ENGAGE_CODE_DIR}/EngageWorkeruses the data source identified in Step 4.[ ] Verify that
EngageBroadcastReceiver.register(context)is called within theApplicationclass orMainActivityto register the receiver dynamically.[ ] Verify that
AndroidManifest.xmlcontains the static<receiver>declaration forEngageBroadcastReceiverwith the necessary intent actions.Important : Explicitly instruct the developer to call
EngageBroadcastReceiver.register(context)inside their customApplicationclassonCreate()(or their main activityonCreate()) to dynamically register the receiver. Stress that both static and dynamic registrations are required for the integration to function.
Reference materials
FAQ: Engage FAQ - Refer to this document for answers to frequently asked questions from developers.
Vertical-specific guides:
Vertical-specific schemas:
Files
- ATTRIBUTION.mdAdded by AutoGineer973 B
- LICENSELicence file added by AutoGineer11.1 KiB
- SKILL.md9.2 KiB
- references/android/guide/playcore/engage/faq.md22.7 KiB
- references/android/guide/playcore/engage/food.md58.1 KiB
- references/android/guide/playcore/engage/healthandfitness.md62.0 KiB
- references/android/guide/playcore/engage/listen.md52.9 KiB
- references/android/guide/playcore/engage/otherverticals.md92.8 KiB
- references/android/guide/playcore/engage/read.md44.0 KiB
- references/android/guide/playcore/engage/shopping.md60.4 KiB
- references/android/guide/playcore/engage/social.md35.8 KiB
- references/android/guide/playcore/engage/travel.md102.3 KiB
- references/android/guide/playcore/engage/tv/continue-watching/index.md1.1 KiB
- references/android/guide/playcore/engage/tv/entitlements.md15.1 KiB
- references/android/guide/playcore/engage/tv/getting-started.md22.5 KiB
- references/android/guide/playcore/engage/tv/recommendations.md18.4 KiB
- references/android/guide/playcore/engage/watch.md59.9 KiB
- references/clusters.md5.9 KiB
- references/common.md17.9 KiB
- references/patterns.md21.3 KiB
- references/requests.md10.3 KiB
- references/schemas/food.md18.6 KiB
- references/schemas/listen.md29.9 KiB
- references/schemas/other.md8.0 KiB
- references/schemas/read.md15.0 KiB
- references/schemas/shopping.md13.5 KiB
- references/schemas/social.md8.5 KiB
- references/schemas/travel.md34.0 KiB
- references/schemas/tv.md46.9 KiB
- references/schemas/watch.md43.7 KiB
- references/troubleshooting.md2.0 KiB
LICENSE
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- Google LLC
- Publisher
- Android (Google) (Official)
- Distributed by
- Android (Google)
- Source
- android/skills · play/engage-sdk-integration · commit bf68e2d
- Licence
- Apache License 2.0 (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE.txt)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Google LLC or Android (Google).
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download engage-sdk-integration.zip