Повысьте вовлеченность пользователей в приложение, взаимодействуя с ними там, где они находятся. Интегрируйте Engage SDK, чтобы предоставлять персонализированные рекомендации и дополнительный контент непосредственно пользователям на различных платформах устройства, таких как «Коллекции» , «Развлекательное пространство » и Play Store. Интеграция добавляет менее 50 КБ (в сжатом виде) к среднему размеру APK-файла и занимает у большинства приложений около недели на разработку. Узнайте больше на нашем корпоративном сайте .
В этом руководстве содержатся инструкции для партнеров-разработчиков по размещению контента, связанного с едой (заказ еды, обзоры и поиск блюд или ресторанов, подписки на меню, рецепты), на информационных платформах Engage.
Детали интеграции
Терминология
Данная интеграция включает в себя следующие пять типов кластеров: Рекомендации , Рекомендуемые товары , Корзина покупок продуктов , Список покупок продуктов и Повторный заказ .
Кластеры рекомендаций отображают персонализированные предложения, связанные с едой, от конкретного разработчика-партнера. Эти рекомендации могут быть персонализированы для пользователя или обобщены (например, новинки по акции). Используйте их для отображения рецептов, магазинов, блюд, продуктов и так далее по своему усмотрению.
- Кластер рекомендаций может состоять из списков объектов типов
ProductEntity,StoreEntityилиRecipeEntity, но не из смеси различных типов сущностей.

Рисунок: `ProductEntity`, `StoreEntity` и `RecipeEntity`. (*Пользовательский интерфейс представлен только для иллюстрации) - Кластер рекомендаций может состоять из списков объектов типов
В разделе «Рекомендуемые» отображается подборка объектов от нескольких партнеров-разработчиков в одном интерфейсе. Будет создан единый раздел «Рекомендуемые», который будет отображаться в верхней части интерфейса с приоритетным размещением над всеми разделами «Рекомендуемые». Каждому партнеру-разработчику будет разрешено транслировать до 10 объектов в разделе «Рекомендуемые».

Рисунок: Кластер с объектом `RecipeEntity`. (*Пользовательский интерфейс представлен только для иллюстрации) В кластере «Корзина покупок продуктов» отображается предварительный просмотр корзин покупок продуктов от нескольких партнеров-разработчиков в одном пользовательском интерфейсе, предлагая пользователям завершить оформление своих незавершенных заказов. Существует один кластер «Корзина покупок продуктов».
В разделе «Корзина для покупок продуктов» должно отображаться общее количество товаров в корзине, а также могут быть включены изображения для X товаров в корзине пользователя.

Рисунок: Кластер корзин покупок продуктов от одного партнера. (*Интерфейс пользователя представлен только для иллюстрации)
В кластере «Список покупок продуктов» отображается предварительный просмотр списков покупок от нескольких партнеров-разработчиков в одном пользовательском интерфейсе, предлагая пользователям вернуться в соответствующее приложение для обновления и завершения своих списков. Существует один кластер «Список покупок продуктов».

Рисунок: Сгруппированные списки покупок продуктов от одного партнера. (*Интерфейс представлен только для иллюстрации) В кластере «Повторный заказ» отображается предварительный просмотр предыдущих заказов от нескольких партнеров-разработчиков в одном пользовательском интерфейсе, предлагая пользователям повторно оформить заказ. Существует один кластер «Повторный заказ».
Кластер повторного заказа должен отображать общее количество товаров в предыдущем заказе пользователя и включать одно из следующих значений:
- Изображения для X товаров из предыдущего заказа пользователя.
- Метки для X товаров в предыдущем заказе пользователя.

Рисунок: Кластер повторных заказов продуктов питания от одного партнера. (*Интерфейс пользователя приведен только для иллюстрации)
Предварительная работа
Минимальный уровень API: 19
Добавьте библиотеку com.google.android.engage:engage-core в ваше приложение:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.5.11'
}
Краткое содержание
Данная архитектура основана на реализации привязанного сервиса .
Для различных типов кластеров объем данных, которые может публиковать клиент, ограничен следующими лимитами:
| Тип кластера | Границы кластера | Максимальное количество объектов в кластере. |
|---|---|---|
| Кластер(ы) рекомендаций | Максимум 7 | Максимум 50 ( ProductEntity , RecipeEntity или StoreEntity ) |
| Выделенный кластер | Не более 1 | Не более 20 ( ProductEntity , RecipeEntity или StoreEntity ) |
| Группа тележек для покупок продуктов | Не более 1 | Не более 3 FoodShoppingCart |
| Группа пунктов списка покупок продуктов | Не более 1 | Не более 3 FoodShoppingList |
| Кластер повторного заказа продуктов питания | Не более 1 | Не более 1 ReorderEntity |
Шаг 1: Предоставьте данные сущности.
В SDK определены различные сущности для представления каждого типа товаров. Для категории «Еда» мы поддерживаем следующие сущности:
-
ProductEntity -
StoreEntity -
RecipeEntity -
FoodShoppingCart -
FoodShoppingList -
FoodReorderCluster
Приведенные ниже диаграммы описывают доступные характеристики и требования для каждого типа.
ProductEntity
Объект ProductEntity представляет собой отдельный элемент (например, продукт питания, блюдо из ресторана или рекламную акцию), который партнеры-разработчики хотят опубликовать.

ProductEntity
| Атрибут | Требование | Описание | Формат |
|---|---|---|---|
| Изображения для плакатов | Необходимый | Необходимо предоставить как минимум одно изображение. | См. раздел «Технические характеристики изображения» для получения дополнительной информации. |
| Action Uri | Необходимый | Прямая ссылка на страницу в приложении, отображающую подробную информацию о продукте. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов. | Ури |
| Заголовок | Необязательный | Название продукта. | Свободный текст Рекомендуемый размер текста: менее 90 символов (слишком длинный текст может содержать многоточие). |
| Текущая цена | Условно обязательно | Текущая цена товара. Необходимо указать, если указана перечеркнутая цена. | Свободный текст |
| Цена - зачеркнуто | Необязательный | Первоначальная цена объекта, которая перечеркнута в пользовательском интерфейсе. | Свободный текст |
| Вызывать | Необязательный | При необходимости укажите ссылку на акцию, мероприятие или обновление продукта. | Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие). |
| Мелкий шрифт в пояснительной записке | Необязательный | Текст, напечатанный мелким шрифтом для пояснения. | Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие). |
| Оценка (необязательно) - Примечание: Все оценки отображаются с использованием нашей стандартной системы звездных оценок. | |||
| Рейтинг - Максимальное значение | Необязательный | Максимальное значение шкалы оценок. Этот параметр необходимо указать, если также предоставлено текущее значение рейтинга. | Число >= 0,0 |
| Рейтинг - Текущая стоимость | Необязательный | Текущее значение рейтинговой шкалы. Этот параметр необходимо указать, если также указано максимальное значение рейтинга. | Число >= 0,0 |
| Рейтинг - Количество | Необязательный | Количество оценок товара. Примечание: Укажите это поле, если ваше приложение контролирует способ отображения количества для пользователей. Используйте краткую строку. Например, если количество равно 1 000 000, рассмотрите возможность использования сокращения, например, 1M, чтобы количество не обрезалось на экранах меньшего размера. | Нить |
| Рейтинг - Количество значений | Необязательный | Количество оценок товара. Примечание: Укажите это поле, если вы не обрабатываете логику отображения сокращений самостоятельно. Если присутствуют поля «Количество» и «Значение количества», пользователям будет отображаться «Количество». | Длинный |
| DisplayTimeWindow (необязательно) — задайте временной интервал для отображения контента на поверхности. | |||
| Отметка времени начала | Необязательный | Временная метка эпохи, после которой контент должен отображаться на поверхности. Если параметр не задан, контент может отображаться на поверхности. | Временная метка эпохи в миллисекундах |
| Отметка времени окончания | Необязательный | Временная метка эпохи, после которой контент больше не отображается на поверхности. Если параметр не задан, контент может отображаться на поверхности. | Временная метка эпохи в миллисекундах |
StoreEntity
Объект StoreEntity представляет собой отдельный магазин, который партнеры-разработчики хотят опубликовать, например, ресторан или продуктовый магазин.

StoreEntity
| Атрибут | Требование | Описание | Формат |
|---|---|---|---|
| Изображения для плакатов | Необходимый | Необходимо предоставить как минимум одно изображение. | См. раздел «Технические характеристики изображения» для получения дополнительной информации. |
| Action Uri | Необходимый | Прямая ссылка на страницу в приложении, отображающую подробную информацию о магазине. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов. | Ури |
| Заголовок | Необязательный | Название магазина. | Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие). |
| Расположение | Необязательный | Местоположение магазина. | Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие). |
| Вызывать | Необязательный | При необходимости укажите ссылку на акцию, мероприятие или обновление информации о магазине. | Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие). |
| Мелкий шрифт в пояснительной записке | Необязательный | Текст, напечатанный мелким шрифтом для пояснения. | Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие). |
| Описание | Необязательный | Описание магазина. | Свободный текст Рекомендуемый размер текста: менее 90 символов (слишком длинный текст может содержать многоточие). |
| Категория | Необязательный | В контексте заведений общественного питания категория магазина может включать в себя кухню, например, «французская», «новоамериканская», «рамен», «изысканная кухня». | Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие). |
| Примечание: Все оценки отображаются с использованием нашей стандартной системы звездных оценок. | |||
| Рейтинг - Максимальное значение | Необязательный | Максимальное значение шкалы оценок. Этот параметр необходимо указать, если также предоставлено текущее значение рейтинга. | Число >= 0,0 |
| Рейтинг - Текущая стоимость | Необязательный | Текущее значение рейтинговой шкалы. Этот параметр необходимо указать, если также указано максимальное значение рейтинга. | Число >= 0,0 |
| Рейтинг - Количество | Необязательный | Количество оценок магазина. Примечание: Укажите это поле, если ваше приложение хочет контролировать способ отображения этой информации пользователям. Укажите краткую строку, которая может быть показана пользователю. Например, если значение равно 1 000 000, используйте сокращения, такие как 1M, чтобы оно не обрезалось на экранах меньшего размера. | Нить |
| Рейтинг - Количество значений | Необязательный | Количество оценок магазина. Примечание: Укажите это поле, если вы не хотите самостоятельно обрабатывать логику отображения сокращений. Если присутствуют поля «Количество» и «Значение количества», мы будем использовать значение «Количество» для отображения пользователям. | Длинный |
RecipeEntity
Объект RecipeEntity представляет собой элемент рецепта, который партнеры-разработчики хотят опубликовать.

RecipeEntity
| Атрибут | Требование | Описание | Формат |
|---|---|---|---|
| Изображения для плакатов | Необходимый | Необходимо предоставить как минимум одно изображение. | См. раздел «Технические характеристики изображения» для получения дополнительной информации. |
| Action Uri | Необходимый | Прямая ссылка на страницу в приложении, где отображается подробная информация о рецепте. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов. | Ури |
| Заголовок | Необязательный | Название рецепта. | Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие). |
| Автор | Необязательный | Автор рецепта. | Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие). |
| Время приготовления/подготовки | Необязательный | Время приготовления по этому рецепту. | Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие). |
| Вызывать | Необязательный | При необходимости укажите, если имеется, рекламную акцию, мероприятие или обновление рецепта. | Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие). |
| Категория | Необязательный | Категория рецепта. | Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие). |
| Описание | Необязательный | Описание рецепта. | Свободный текст Рекомендуемый размер текста: менее 90 символов (слишком длинный текст может содержать многоточие). |
| Примечание: Все оценки отображаются с использованием нашей стандартной системы звездных оценок. | |||
| Рейтинг - Максимальное значение | Необязательный | Максимальное значение шкалы оценок. Этот параметр необходимо указать, если также предоставлено текущее значение рейтинга. | Число >= 0,0 |
| Рейтинг - Текущая стоимость | Необязательный | Текущее значение рейтинговой шкалы. Этот параметр необходимо указать, если также указано максимальное значение рейтинга. | Число >= 0,0 |
| Рейтинг - Количество | Необязательный | Количество оценок рецепта. Примечание: Укажите это поле, если ваше приложение хочет контролировать способ отображения этой информации пользователям. Укажите краткую строку, которая может быть показана пользователю. Например, если значение равно 1 000 000, используйте сокращения, такие как 1M, чтобы оно не обрезалось на экранах меньшего размера. | Нить |
| Рейтинг - Количество значений | Необязательный | Количество оценок рецепта. Примечание: Укажите это поле, если вы не хотите самостоятельно обрабатывать логику отображения сокращений. Если присутствуют поля «Количество» и «Значение количества», мы будем использовать значение «Количество» для отображения пользователям. | Длинный |
FoodShoppingCart

| Атрибут | Требование | Описание | Формат |
|---|---|---|---|
| Action Uri | Необходимый | Прямая ссылка на корзину покупок в приложении партнера. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов. | Ури |
| Количество товаров | Необходимый | Количество товаров (не просто число товаров) в корзине. Например: если в тележке 3 апельсина и 1 яблоко, то это число должно быть равно 4. | Целое число >= 1 |
| отметка времени последнего взаимодействия пользователя | Необходимый | Количество миллисекунд, прошедших с начала эпохи, указывающее на последнее взаимодействие пользователя с корзиной покупок. | Временная метка эпохи в миллисекундах |
| Заголовок | Необязательный | Название корзины (например, «Ваша корзина »). Если разработчик не указал название, по умолчанию будет отображаться содержимое вашей корзины . | Свободный текст Рекомендуемый размер текста: менее 25 символов (слишком длинный текст может содержать многоточие). |
| Текст действия | Необязательный | Текст призыва к действию на кнопке в корзине покупок (например, «Ваша корзина »). Если разработчик не указал текст действия, по умолчанию будет выбран вариант «Просмотреть корзину» . Этот атрибут поддерживается начиная с версии 1.1.0. | Нить |
| Изображения корзины | Необязательный | Изображения каждого товара в корзине. Можно предоставить до 10 изображений в порядке приоритета; фактическое количество отображаемых изображений зависит от форм-фактора устройства. | См. раздел «Технические характеристики изображения» для получения дополнительной информации. |
| Этикетки товаров | Необязательный | Список этикеток для товаров в списке покупок. Фактическое количество отображаемых меток зависит от форм-фактора устройства. | Список свободных текстовых меток Рекомендуемый размер текста: менее 20 символов (слишком длинный текст может содержать многоточие). |
| DisplayTimeWindow (необязательно) — задайте временной интервал для отображения контента на поверхности. | |||
| Отметка времени начала | Необязательный | Временная метка эпохи, после которой контент должен отображаться на поверхности. Если параметр не задан, контент может отображаться на поверхности. | Временная метка эпохи в миллисекундах |
| Отметка времени окончания | Необязательный | Временная метка эпохи, после которой контент больше не отображается на поверхности. Если параметр не задан, контент может отображаться на поверхности. | Временная метка эпохи в миллисекундах |
FoodShoppingList

| Атрибут | Требование | Описание | Формат |
|---|---|---|---|
| Action Uri | Необходимый | Прямая ссылка на список покупок в приложении партнера. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов. | Ури |
| Количество товаров | Необходимый | Количество товаров в списке покупок. | Целое число >= 1 |
| отметка времени последнего взаимодействия пользователя | Необходимый | Количество миллисекунд, прошедших с начала эпохи, указывающее на последнее взаимодействие пользователя со списком покупок. | Временная метка эпохи в миллисекундах |
| Заголовок | Необязательный | Заголовок списка (например, «Ваш список покупок »). Если разработчик не указал название, по умолчанию используется «Список покупок» . | Свободный текст Рекомендуемый размер текста: менее 25 символов (слишком длинный текст может содержать многоточие). |
| Этикетки товаров | Необходимый | Список этикеток для товаров в списке покупок. Необходимо предоставить как минимум одну этикетку, а максимальное количество этикеток может составлять 10 в порядке приоритета; фактическое количество отображаемых этикеток зависит от форм-фактора устройства. | Список свободных текстовых меток Рекомендуемый размер текста: менее 20 символов (слишком длинный текст может содержать многоточие). |
FoodReorderCluster

| Атрибут | Требование | Описание | Формат |
|---|---|---|---|
| Action Uri | Необходимый | Прямая ссылка для повторного заказа в приложении партнера. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов. | Ури |
| Текст действия | Необязательный | Текст призыва к действию для кнопки «Повторный заказ» (например, «Заказать снова »). Если разработчик не предоставил текст действия, по умолчанию используется параметр «Изменить порядок» . Этот атрибут поддерживается начиная с версии 1.1.0. | Нить |
| Количество товаров | Необходимый | Количество товаров (а не просто количество продуктов) в предыдущем заказе. Например: если в предыдущем заказе было 3 маленьких кофе и 1 круассан, то это число должно быть равно 4. | Целое число >= 1 |
| Заголовок | Необходимый | Название товара для повторного заказа. | Свободный текст Рекомендуемый размер текста: менее 40 символов (слишком длинный текст может содержать многоточие). |
| Этикетки товаров | Необязательный (Если изображения плаката не предоставлены, их следует предоставить) | Список наименований товаров из предыдущего заказа. Можно указать до 10 меток в порядке приоритета; фактическое количество отображаемых меток зависит от форм-фактора устройства. | Список свободного текста Рекомендуемый размер текста на метку: менее 20 символов (слишком длинный текст может отображаться многоточием). |
| Изображения для плакатов | Необязательный (Если этикетки не указаны, их следует предоставить) | Изображения товаров из предыдущего заказа. Можно предоставить до 10 изображений в порядке приоритета; фактическое количество отображаемых изображений зависит от форм-фактора устройства. | См. раздел «Технические характеристики изображения» для получения дополнительной информации. |
Технические характеристики изображения
Ниже перечислены необходимые спецификации для графических ресурсов:
| Соотношение сторон | Минимальное количество пикселей | Рекомендуемые пиксели |
|---|---|---|
Квадрат (1х1) Предпочтительный | 300x300 | 1200x1200 |
| Пейзаж (1,91х1) | 600x314 | 1200x628 |
| Портрет (4x5) | 480x600 | 960x1200 |
Форматы файлов
PNG, JPG, статический GIF, WebP
Максимальный размер файла
5120 КБ
Дополнительные рекомендации
- Безопасная зона изображения: разместите важный контент в центральных 80% изображения.
- Используйте прозрачный фон, чтобы изображение корректно отображалось в темной и светлой темах оформления.
Шаг 2: Предоставьте данные кластера.
Рекомендуется запускать задачу публикации контента в фоновом режиме (например, с помощью WorkManager ) и планировать ее выполнение на регулярной основе или по событию (например, каждый раз, когда пользователь открывает приложение или добавляет товар в корзину).
AppEngageFoodClient отвечает за публикацию кластеров продуктов питания.
Для публикации кластеров на стороне клиента доступны следующие API:
-
isServiceAvailable -
publishRecommendationClusters -
publishFeaturedCluster -
publishFoodShoppingCarts -
publishFoodShoppingLists -
publishReorderCluster -
publishUserAccountManagementRequest -
updatePublishStatus -
deleteRecommendationsClusters -
deleteFeaturedCluster -
deleteFoodShoppingCartCluster -
deleteFoodShoppingListCluster -
deleteReorderCluster -
deleteUserManagementCluster -
deleteClusters
isServiceAvailable
Этот API используется для проверки доступности сервиса для интеграции и возможности отображения контента на устройстве.
Котлин
client.isServiceAvailable.addOnCompleteListener { task ->
if (task.isSuccessful) {
// Handle IPC call success
if(task.result) {
// Service is available on the device, proceed with content publish
// calls.
} else {
// Service is not available, no further action is needed.
}
} else {
// The IPC call itself fails, proceed with error handling logic here,
// such as retry.
}
}
Java
client.isServiceAvailable().addOnCompleteListener(task - > {
if (task.isSuccessful()) {
// Handle success
if(task.getResult()) {
// Service is available on the device, proceed with content publish
// calls.
} else {
// Service is not available, no further action is needed.
}
} else {
// The IPC call itself fails, proceed with error handling logic here,
// such as retry.
}
});
publishRecommendationClusters
Этот API используется для публикации списка объектов RecommendationCluster .
Объект RecommendationCluster может иметь следующие атрибуты:
| Атрибут | Требование | Описание |
|---|---|---|
| Список объектов ProductEntity, StoreEntity или RecipeEntity | Необходимый | Список объектов, составляющих рекомендации для данного кластера рекомендаций. Объекты в одном кластере должны быть одного типа. |
| Заголовок | Необходимый | Заголовок для группы рекомендаций (например, «Большие скидки на меню на День благодарения »). Рекомендуемый размер текста: менее 25 символов (слишком длинный текст может содержать многоточие). |
| Субтитры | Необязательный | Подзаголовок для кластера рекомендаций. |
| Action Uri | Необязательный | Прямая ссылка на страницу в партнерском приложении, где пользователи могут увидеть полный список рекомендаций. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов. |
Котлин
client.publishRecommendationClusters(
PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(
RecommendationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.setTitle("Big savings on Thanksgiving menu")
.build())
.build())
Java
client.publishRecommendationClusters(
new PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(
new RecommendationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.setTitle("Big savings on Thanksgiving menu")
.build())
.build());
После получения запроса сервисом в рамках одной транзакции выполняются следующие действия:
- Все существующие данные кластера рекомендаций удалены.
- Данные из запроса анализируются и сохраняются в новых кластерах рекомендаций.
В случае ошибки весь запрос отклоняется, и сохраняется текущее состояние.
publishFeaturedCluster
Этот API используется для публикации объекта FeaturedCluster .
Котлин
client.publishFeaturedCluster(
PublishFeaturedClusterRequest.Builder()
.setFeaturedCluster(
FeaturedCluster.Builder()
...
.build())
.build())
Java
client.publishFeaturedCluster(
new PublishFeaturedClusterRequest.Builder()
.setFeaturedCluster(
new FeaturedCluster.Builder()
...
.build())
.build());
После получения запроса сервисом в рамках одной транзакции выполняются следующие действия:
- Существующие данные
FeaturedClusterот партнера-разработчика удаляются. - Данные из запроса анализируются и сохраняются в обновленном кластере избранных элементов.
В случае ошибки весь запрос отклоняется, и сохраняется текущее состояние.
publishFoodShoppingCarts
Этот API используется для публикации списка объектов FoodShoppingCart .
Котлин
client.publishFoodShoppingCarts(
PublishFoodShoppingCartsRequest.Builder()
.addFoodShoppingCart(
FoodShoppingCart.Builder()
...
.build())
.build())
Java
client.publishFoodShoppingCarts(
new PublishFoodShoppingCartsRequest.Builder()
.addFoodShoppingCart(
new FoodShoppingCart.Builder()
...
.build())
.build());
После получения запроса сервисом в рамках одной транзакции выполняются следующие действия:
- Существующие данные
FoodShoppingCartот партнера-разработчика удалены. - Данные из запроса анализируются и сохраняются в обновленном кластере корзины покупок.
В случае ошибки весь запрос отклоняется, и сохраняется текущее состояние.
publishFoodShoppingLists
Этот API используется для публикации списка объектов FoodShoppingList .
Котлин
client.publishFoodShoppingLists(
PublishFoodShoppingListsRequest.Builder()
.addFoodShoppingList(
FoodShoppingListEntity.Builder()
...
.build())
.build())
Java
client.publishFoodShoppingLists(
new PublishFoodShoppingListsRequest.Builder()
.addFoodShoppingList(
new FoodShoppingListEntity.Builder()
...
.build())
.build());
После получения запроса сервисом в рамках одной транзакции выполняются следующие действия:
- Существующие данные
FoodShoppingListот партнера-разработчика удалены. - Данные из запроса анализируются и сохраняются в обновленном кластере списков покупок.
В случае ошибки весь запрос отклоняется, и сохраняется текущее состояние.
publishReorderCluster
Этот API используется для публикации объекта FoodReorderCluster .
Котлин
client.publishReorderCluster(
PublishReorderClusterRequest.Builder()
.setReorderCluster(
FoodReorderCluster.Builder()
...
.build())
.build())
Java
client.publishReorderCluster(
new PublishReorderClusterRequest.Builder()
.setReorderCluster(
new FoodReorderCluster.Builder()
...
.build())
.build());
После получения запроса сервисом в рамках одной транзакции выполняются следующие действия:
- Существующие данные
FoodReorderClusterот партнера-разработчика удаляются. - Данные из запроса анализируются и сохраняются в обновленном кластере переупорядочивания.
В случае ошибки весь запрос отклоняется, и сохраняется текущее состояние.
publishUserAccountManagementRequest
Этот API используется для публикации карточки входа. Действие входа перенаправляет пользователей на страницу авторизации приложения, чтобы приложение могло публиковать контент (или предоставлять более персонализированный контент).
Следующие метаданные являются частью карточки входа в систему:
| Атрибут | Требование | Описание |
|---|---|---|
| Action Uri | Необходимый | Глубокая ссылка на действие (т.е. переход на страницу входа в приложение) |
| Изображение | Необязательно — если не указано, необходимо указать заголовок. | Изображение, показанное на карте Изображения с соотношением сторон 16x9 и разрешением 1264x712. |
| Заголовок | Изображение необязательно — если не указано, его необходимо предоставить. | Название на карточке |
| Текст действия | Необязательный | Текст, отображаемый в призыве к действию (например, при входе в систему) |
| Субтитры | Необязательный | Дополнительный подзаголовок на карточке (по желанию) |
Котлин
var SIGN_IN_CARD_ENTITY =
SignInCardEntity.Builder()
.addPosterImage(
Image.Builder()
.setImageUri(Uri.parse("http://www.x.com/image.png"))
.setImageHeightInPixel(500)
.setImageWidthInPixel(500)
.build())
.setActionText("Sign In")
.setActionUri(Uri.parse("http://xx.com/signin"))
.build()
client.publishUserAccountManagementRequest(
PublishUserAccountManagementRequest.Builder()
.setSignInCardEntity(SIGN_IN_CARD_ENTITY)
.build());
Java
SignInCardEntity SIGN_IN_CARD_ENTITY =
new SignInCardEntity.Builder()
.addPosterImage(
new Image.Builder()
.setImageUri(Uri.parse("http://www.x.com/image.png"))
.setImageHeightInPixel(500)
.setImageWidthInPixel(500)
.build())
.setActionText("Sign In")
.setActionUri(Uri.parse("http://xx.com/signin"))
.build();
client.publishUserAccountManagementRequest(
new PublishUserAccountManagementRequest.Builder()
.setSignInCardEntity(SIGN_IN_CARD_ENTITY)
.build());
После получения запроса сервисом в рамках одной транзакции выполняются следующие действия:
- Существующие данные
UserAccountManagementClusterот партнера-разработчика удаляются. - Данные из запроса анализируются и сохраняются в обновленном кластере UserAccountManagementCluster.
В случае ошибки весь запрос отклоняется, и сохраняется текущее состояние.
updatePublishStatus
Если по каким-либо внутренним причинам ни один из кластеров не опубликован, мы настоятельно рекомендуем обновить статус публикации с помощью API updatePublishStatus . Это важно, потому что:
- Указание статуса во всех сценариях, даже когда контент опубликован (STATUS == PUBLISHED), имеет решающее значение для заполнения панелей мониторинга, которые используют этот явный статус для отображения состояния и других показателей вашей интеграции.
- Если контент не опубликован, но статус интеграции не нарушен (STATUS == NOT_PUBLISHED), Google может избежать срабатывания оповещений на панелях мониторинга состояния приложения. Это подтверждает, что контент не опубликован из-за ожидаемой ситуации с точки зрения поставщика.
- Это помогает разработчикам получать информацию о том, когда данные публикуются, а когда нет.
- Google может использовать коды состояния, чтобы подтолкнуть пользователя к выполнению определенных действий в приложении, чтобы он мог увидеть контент приложения или обойти его ограничения.
Список допустимых кодов статуса публикации:
// Content is published
AppEngagePublishStatusCode.PUBLISHED,
// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,
// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,
// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,
// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,
// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,
// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,
// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,
// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER
Если контент не публикуется из-за того, что пользователь не авторизован, Google рекомендует опубликовать карточку входа. Если по какой-либо причине поставщики не могут опубликовать карточку входа, мы рекомендуем вызвать API updatePublishStatus со статусом NOT_PUBLISHED_REQUIRES_SIGN_IN.
Котлин
client.updatePublishStatus(
PublishStatusRequest.Builder()
.setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
.build())
Java
client.updatePublishStatus(
new PublishStatusRequest.Builder()
.setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
.build());
deleteRecommendationClusters
Этот API используется для удаления содержимого кластеров рекомендаций.
Котлин
client.deleteRecommendationClusters()
Java
client.deleteRecommendationClusters();
Когда сервис получает запрос, он удаляет существующие данные из кластеров рекомендаций. В случае ошибки весь запрос отклоняется, и сохраняется текущее состояние.
deleteFeaturedCluster
Этот API используется для удаления содержимого раздела "Рекомендуемые кластеры".
Котлин
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
Когда сервис получает запрос, он удаляет существующие данные из кластера избранных данных. В случае ошибки весь запрос отклоняется, и сохраняется существующее состояние.
deleteFoodShoppingCartCluster
Этот API используется для удаления содержимого кластера корзин покупок продуктов питания.
Котлин
client.deleteFoodShoppingCartCluster()
Java
client.deleteFoodShoppingCartCluster();
Когда сервис получает запрос, он удаляет существующие данные из кластера корзины покупок продуктов. В случае ошибки весь запрос отклоняется, и сохраняется существующее состояние.
deleteFoodShoppingListCluster
Этот API используется для удаления содержимого кластера списков покупок продуктов.
Котлин
client.deleteFoodShoppingListCluster()
Java
client.deleteFoodShoppingListCluster();
Когда сервис получает запрос, он удаляет существующие данные из кластера списков покупок продуктов. В случае ошибки весь запрос отклоняется, и сохраняется существующее состояние.
deleteReorderCluster
Этот API используется для удаления содержимого объекта FoodReorderCluster.
Котлин
client.deleteReorderCluster()
Java
client.deleteReorderCluster();
Когда сервис получает запрос, он удаляет существующие данные из кластера переупорядочивания. В случае ошибки весь запрос отклоняется, и сохраняется существующее состояние.
deleteUserManagementCluster
Этот API используется для удаления содержимого кластера UserAccountManagement.
Котлин
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
Когда служба получает запрос, она удаляет существующие данные из кластера UserAccountManagement. В случае ошибки весь запрос отклоняется, и сохраняется существующее состояние.
deleteClusters
Этот API используется для удаления содержимого кластера определенного типа.
Котлин
client.deleteClusters(
DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
...
.build())
Java
client.deleteClusters(
new DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
...
.build());
Когда сервис получает запрос, он удаляет существующие данные из всех кластеров, соответствующих указанным типам кластеров. Клиенты могут указать один или несколько типов кластеров. В случае ошибки весь запрос отклоняется, и сохраняется текущее состояние.
Обработка ошибок
Настоятельно рекомендуется отслеживать результаты выполнения задачи через API публикации, чтобы иметь возможность предпринять дальнейшие действия для восстановления и повторной отправки успешно выполненной задачи.
client.publishRecommendationClusters(
new PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(...)
.build())
.addOnCompleteListener(
task -> {
if (task.isSuccessful()) {
// do something
} else {
Exception exception = task.getException();
if (exception instanceof AppEngageException) {
@AppEngageErrorCode
int errorCode = ((AppEngageException) exception).getErrorCode();
if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
// do something
}
}
}
});
В результате возникает ошибка, которая возвращается как AppEngageException , при этом причина ошибки указывается в виде кода ошибки.
| Код ошибки | Название ошибки | Примечание |
|---|---|---|
1 | SERVICE_NOT_FOUND | Данная услуга недоступна на указанном устройстве. |
2 | SERVICE_NOT_AVAILABLE | Услуга доступна на данном устройстве, но недоступна в момент звонка (например, она явно отключена). |
3 | SERVICE_CALL_EXECUTION_FAILURE | Выполнение задачи завершилось с ошибкой из-за проблем с многопоточностью. В этом случае можно повторить попытку. |
4 | SERVICE_CALL_PERMISSION_DENIED | Звонившему не разрешается вызывать специалиста для оказания услуги. |
5 | SERVICE_CALL_INVALID_ARGUMENT | Запрос содержит недопустимые данные (например, большее количество кластеров, чем разрешено). |
6 | SERVICE_CALL_INTERNAL | На стороне сервиса произошла ошибка. |
7 | SERVICE_CALL_RESOURCE_EXHAUSTED | Вызов сервисной службы происходит слишком часто. |
Шаг 3: Обработка широковещательных намерений
Помимо выполнения вызовов API для публикации контента через задание, также необходимо настроить BroadcastReceiver для приема запросов на публикацию контента.
Основная цель широковещательных интентов — повторная активация приложения и принудительная синхронизация данных. Широковещательные интенты не предназначены для частой отправки. Они срабатывают только тогда, когда служба Engage определяет, что контент может быть устаревшим (например, недельной давности). Таким образом, обеспечивается большая уверенность в том, что пользователь получит актуальный контент, даже если приложение долгое время не запускалось.
Для настройки BroadcastReceiver необходимо использовать два следующих способа:
Динамически зарегистрируйте экземпляр класса
BroadcastReceiverс помощьюContext.registerReceiver(). Это позволит осуществлять связь с приложениями, которые всё ещё находятся в оперативной памяти.
Котлин
class AppEngageBroadcastReceiver : BroadcastReceiver(){
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION
// broadcast is received
// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is
// received
// Trigger food shopping cart cluster publish when PUBLISH_FOOD_SHOPPING_CART broadcast
// is received
// Trigger food shopping list cluster publish when PUBLISH_FOOD_SHOPPING_LIST broadcast
// is received
// Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is
// received
}
fun registerBroadcastReceivers(context: Context){
var context = context
context = context.applicationContext
// Register Recommendation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Featured Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register food Shopping Cart Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_FOOD_SHOPPING_CART),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register food Shopping List Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_FOOD_SHOPPING_LIST),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Reorder Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
}
Java
class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received
// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
// Trigger food shopping cart cluster publish when PUBLISH_FOOD_SHOPPING_CART broadcast is
// received
// Trigger food shopping list cluster publish when PUBLISH_FOOD_SHOPPING_LIST broadcast is
// received
// Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is
// received
}
public static void registerBroadcastReceivers(Context context) {
context = context.getApplicationContext();
// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register food Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_FOOD_SHOPPING_CART),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register food Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_FOOD_SHOPPING_LIST),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Reorder Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
}
В файле
AndroidManifest.xmlстатически объявите реализацию с помощью тега<receiver>. Это позволит приложению получать широковещательные интенты, когда оно не запущено, а также позволит приложению публиковать контент.
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
android:exported="true"
android:enabled="true">
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_CART" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER" />
</intent-filter>
</receiver>
</application>
Сервис отправит следующие намерения :
-
com.google.android.engage.action.PUBLISH_RECOMMENDATIONРекомендуется инициировать вызовpublishRecommendationClustersпри получении этого намерения. -
com.google.android.engage.action.PUBLISH_FEATUREDРекомендуется инициировать вызовpublishFeaturedClusterпри получении этого намерения. -
com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_CARTРекомендуется инициировать вызовpublishFoodShoppingCartsпри получении этого намерения. -
com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LISTРекомендуется инициировать вызовpublishFoodShoppingListsпри получении этого намерения. -
com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTERРекомендуется инициировать вызовpublishReorderClusterпри получении этого намерения.
Рабочий процесс интеграции
Пошаговое руководство по проверке интеграции после ее завершения см. в разделе «Рабочий процесс интеграции для разработчиков Engage» .
Часто задаваемые вопросы
Часто задаваемые вопросы по Engage SDK можно найти в разделе "Часто задаваемые вопросы".
Контакт
Если у вас возникнут вопросы в процессе интеграции, обращайтесь по адресу engage-developers@google.com . Наша команда ответит вам в кратчайшие сроки.
Следующие шаги
После завершения интеграции ваши дальнейшие действия будут следующими:
- Отправьте электронное письмо на адрес
engage-developers@google.comи прикрепите к нему свой интегрированный APK-файл, готовый к тестированию компанией Google. - Google проведет внутреннюю проверку и анализ, чтобы убедиться, что интеграция работает должным образом. Если потребуются изменения, Google свяжется с вами и предоставит всю необходимую информацию.
- После завершения тестирования и если никаких изменений не потребуется, Google свяжется с вами, чтобы уведомить о возможности публикации обновленного и интегрированного APK-файла в Play Store.
- После того, как Google подтвердит публикацию вашего обновленного APK-файла в Play Store, ваши разделы «Рекомендации» , «Рекомендуемые» , «Корзина покупок» , «Список покупок» и «Повторный заказ» будут опубликованы и видны пользователям.