Google создает поверхность на устройстве, которая организует приложения пользователей по вертикалям и обеспечивает новый захватывающий опыт для персонализированного потребления и обнаружения контента приложений. Этот полноэкранный режим дает партнерам-разработчикам возможность продемонстрировать свой лучший насыщенный контент в специальном канале за пределами приложения. Это руководство содержит инструкции для партнеров-разработчиков по интеграции контента о здоровье и фитнесе с помощью Engage SDK для заполнения этой новой области поверхности.
Детали интеграции
Терминология
Эта интеграция включает следующие три типа кластеров: Рекомендация , Рекомендуемые и Продолжение .
В кластерах рекомендаций представлены персонализированные предложения по здоровью и фитнесу от отдельного партнера-разработчика. Эти рекомендации могут быть персонализированы для пользователя или обобщены (например, тренды в области фитнеса и здоровья). Используйте их, чтобы найти статьи или людей, связанных со здоровьем и фитнесом.
- Кластер рекомендаций может состоять из
ArticleEntity
,PersonEntity
илиEventEntity
, но не из смеси различных типов сущностей.
Ваши рекомендации имеют следующую структуру:
Кластер рекомендаций: представление пользовательского интерфейса, содержащее группу рекомендаций от одного и того же партнера-разработчика.
Сущность: объект, представляющий один элемент в кластере. Эта интеграция предлагает некоторые сущности, которые будут отображаться с использованием кластера рекомендаций:
ArticleEntity : ArticleEntity представляет собой рекомендацию по текстовому контенту, связанному со здоровьем и фитнесом. Его можно использовать для статей, постов в блогах, маркетингового контента, фрагментов новостей и т. д.
PersonEntity : PersonEntity представляет человека. Рекомендации могут заключаться в том, чтобы выделить тренера или любого человека, имеющего отношение к здоровью и фитнесу, и т. д.
EventEntity : EventEntity представляет событие, которое произойдет в будущем. Время начала мероприятия — это важная информация, которую необходимо передать пользователям. Этот объект можно использовать для отображения таких событий, как лагерь сдачи крови, тренировки, занятия в тренажерном зале или йогой и т. д., связанных со здоровьем и фитнесом.
- Кластер рекомендаций может состоять из
Кластер «Продолжение» показывает контент, недавно использованный пользователями от нескольких партнеров-разработчиков, в одной группе пользовательского интерфейса. Каждому партнеру-разработчику будет разрешено транслировать максимум 10 сущностей в кластере продолжения.
Ваш контент-продолжение может иметь следующую структуру:
ArticleEntity : ArticleEntity представляет собой рекомендацию по текстовому контенту, связанному со здоровьем и фитнесом. Этот объект можно использовать для представления незаконченных новостных статей или другого контента, который пользователь хотел бы продолжать использовать с того места, где он его оставил. Пример: фрагмент новостей, фрагмент сообщения в блоге на темы, связанные со здоровьем или фитнесом.
EventReservationEntity : EventReservationEntity представляет резервирование для мероприятия и помогает пользователям отслеживать предстоящие или текущие резервирования на мероприятия по фитнесу и здоровью. Пример: Учебные занятия
В кластере «Рекомендуемые» представлены объекты от нескольких партнеров-разработчиков в одной группе пользовательского интерфейса. Будет один кластер «Рекомендуемые», который будет отображаться в верхней части пользовательского интерфейса с приоритетом над всеми кластерами «Рекомендации». Каждому партнеру-разработчику будет разрешено транслировать до 10 объектов в избранном кластере.
GenericFeaturedEntity : GenericFeaturedEntity отличается от элемента «Рекомендация» тем, что избранный элемент должен использоваться для одного основного контента от разработчиков и должен представлять единственный наиболее важный контент, который будет интересен и актуален для пользователей.
Предварительная работа
Минимальный уровень 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.2'
}
Краткое содержание
Проект основан на реализации привязанного сервиса .
На данные, которые клиент может публиковать, распространяются следующие ограничения для разных типов кластеров:
Тип кластера | Ограничения кластера | Минимальные ограничения на сущности в кластере | Максимальные ограничения объектов в кластере |
---|---|---|---|
Кластер(ы) рекомендаций | Максимум 5 | минимум 5 | Не более 25 ( ArticleEntity , PersonEntity или EventEntity ) |
Продолжение кластера | Максимум 1 | минимум 1 | Не более 10 ( ArticleEntity или EventReservationEntity ). |
Рекомендуемый кластер | Максимум 1 | минимум 1 | Не более 10 ( GenericFeaturedEntity ). |
Шаг 1. Предоставьте данные об объекте
В SDK определены разные объекты для представления каждого типа элементов. Мы поддерживаем следующие организации в категории «Здоровье и фитнес»:
-
GenericFeaturedEntity
-
ArticleEntity
-
PersonEntity
-
EventEntity
-
EventReservationEntity
В таблицах ниже показаны доступные атрибуты и требования для каждого типа.
GenericFeaturedEntity
Атрибут | Требование | Описание | Формат |
---|---|---|---|
Действие Ури | Необходимый | Глубокая ссылка на объект в приложении поставщика. Примечание. Для атрибуции можно использовать глубокие ссылки. Обратитесь к этому FAQ | Ури |
Изображения для плакатов | Необходимый | Если предоставлено несколько изображений, мы покажем только одно изображение. Рекомендуемое соотношение сторон — 16:9. Примечание. Если предоставляется значок, обеспечьте безопасное пространство в 24 д/с вверху и внизу изображения. | Дополнительные сведения см. в разделе «Спецификации изображения» . |
Заголовок | Необязательный | Название сущности. | Произвольный текст Рекомендуемый размер текста: 50 символов. |
Описание | Необязательный | Один абзац текста для описания объекта. Примечание. Пользователю будет отображаться либо описание, либо список субтитров, но не оба одновременно. | Произвольный текст Рекомендуемый размер текста: 180 символов. |
Список субтитров | Необязательный | До трех субтитров, каждый из которых представляет собой одну строку текста. Примечание. Пользователю будет отображаться либо описание, либо список субтитров, но не оба одновременно. | Произвольный текст Рекомендуемый размер текста для каждого субтитра: максимум 50 символов. |
Значки | Необязательный | Каждый значок представляет собой либо произвольный текст (максимум 15 символов), либо небольшое изображение. Специальная UX-обработка поверх изображения/видео, например наложение значка на изображение.
| |
Значок – текст | Необязательный | Название для значка Примечание. Для значка требуется текст или изображение. | Произвольный текст Рекомендуемый размер текста: максимум 15 символов. |
Значок – изображение | Необязательный | Маленькое изображение Специальная UX-обработка, например наложение значка на миниатюру изображения или видео. Примечание. Для значка требуется текст или изображение. | Дополнительные сведения см. в разделе «Спецификации изображения» . |
Категории контента | Необязательный | Опишите категорию контента в сущности. | Список перечислений Дополнительные сведения см. в разделе «Категория контента» . |
ArticleEntity
Атрибут | Требование | Описание | Формат |
---|---|---|---|
Действие Ури | Необходимый | Глубокая ссылка на объект в приложении поставщика. Примечание. Для атрибуции можно использовать глубокие ссылки. Обратитесь к этому FAQ | Ури |
Заголовок | Необходимый | Название сущности. | Произвольный текст Рекомендуемый размер текста: максимум 50 символов. |
Изображения для плакатов | Необязательный | Если предоставлено несколько изображений, мы покажем только одно изображение. Рекомендуемое соотношение сторон — 16:9. Примечание. Изображение настоятельно рекомендуется. Если предоставляется значок, обеспечьте безопасное пространство в 24 dps вверху и внизу изображения. | Дополнительные сведения см. в разделе «Спецификации изображения» . |
Источник - Название | Необязательный | Имя автора, организации или репортера | Произвольный текст Рекомендуемый размер текста: до 25 символов. |
Источник – изображение | Необязательный | Изображение источника, например автора, организации, репортера. | Дополнительные сведения см. в разделе «Спецификации изображения» . |
Описание | Необязательный | Один абзац текста для описания объекта. Примечание. Пользователю будет отображаться либо описание, либо список субтитров, но не оба одновременно. | Произвольный текст Рекомендуемый размер текста: 180 символов. |
Список субтитров | Необязательный | До трех субтитров, каждый из которых представляет собой одну строку текста. Примечание. Пользователю будет отображаться либо описание, либо список субтитров, но не оба одновременно. | Произвольный текст Рекомендуемый размер текста для каждого субтитра: максимум 50 символов. |
Значки | Необязательный | Каждый значок представляет собой либо произвольный текст (максимум 15 символов), либо небольшое изображение. Специальная UX-обработка поверх изображения/видео, например наложение значка на изображение.
| |
Значок – текст | Необязательный | Название для значка Примечание. Для значка требуется текст или изображение. | Произвольный текст Рекомендуемый размер текста: максимум 15 символов. |
Значок – изображение | Необязательный | Маленькое изображение Специальная UX-обработка, например наложение значка на миниатюру изображения или видео. Примечание. Для значка требуется текст или изображение. | Дополнительные сведения см. в разделе «Спецификации изображения» . |
Время публикации контента | Необязательный | Это временная метка эпохи в миллисекундах, когда контент был опубликован/обновлен в приложении. | Временная метка эпохи в миллисекундах |
Время последнего взаимодействия | Условно требуется | Временная метка эпохи в миллисекундах, когда пользователь последний раз взаимодействовал с этим объектом. Примечание. Это поле является обязательным, если данный объект является частью кластера продолжения. | Временная метка эпохи в миллисекундах |
Процент прогресса | Условно требуется | Процент всего контента, использованного пользователем на сегодняшний день. Примечание. Это поле является обязательным, если данный объект является частью кластера продолжения. | Целое значение от 0 до 100 включительно. |
Категории контента | Необязательный | Опишите категорию контента в сущности. | Список перечислений Дополнительные сведения см. в разделе «Категория контента» . |
PersonEntity
Атрибут | Требование | Описание | Формат |
---|---|---|---|
Действие Ури | Необходимый | Глубокая ссылка на объект в приложении поставщика. Примечание. Для атрибуции можно использовать глубокие ссылки. Обратитесь к этому FAQ | Ури |
Профиль — Имя | Необходимый | Имя, идентификатор или дескриптор профиля, например «Джон Доу», «@TeamPixel» и т. д. | Нить Рекомендуемый размер текста: максимум 50 символов. |
Профиль - Аватар | Необходимый | Изображение профиля или изображение аватара пользователя. Примечание. Должно быть квадратное изображение 1:1. | Дополнительные сведения см. в разделе «Спецификации изображения» . |
Профиль – дополнительный текст | Необязательный | Произвольный текст, например дескриптор профиля. | Произвольный текст Рекомендуемый размер текста: максимум 15 символов. |
Профиль – дополнительное изображение | Необязательный | Небольшое изображение, похожее на проверенный значок. | Дополнительные сведения см. в разделе «Спецификации изображения» . |
Изображение заголовка | Необязательный | Если предоставлено несколько изображений, мы покажем только одно изображение. Рекомендуемое соотношение сторон — 16:9. Примечание. Изображение настоятельно рекомендуется. Если предоставляется значок, обеспечьте безопасное пространство в 24 dps вверху и внизу изображения. | Дополнительные сведения см. в разделе «Спецификации изображения» . |
Популярность – подсчет | Необязательный | Укажите количество подписчиков или значение популярности, например — «3,7 млн». Примечание. Если указаны и Count, и Count Value, будет использоваться Count. | Нить Рекомендуемый размер текста: максимум 20 символов для количества и метки вместе взятых. |
Популярность – подсчет значения | Необязательный | Число подписчиков или значение популярности. Примечание. Укажите значение счетчика, если ваше приложение не хочет обрабатывать логику оптимизации большого числа для разных размеров дисплея. Если указаны и Count, и Count Value, будет использоваться Count. | Длинный |
Популярность – ярлык | Необязательный | Укажите, что такое ярлык популярности. Например – «Нравится». | Нить Рекомендуемый размер текста: максимум 20 символов для количества и метки вместе взятых. |
Популярность – визуальная | Необязательный | Укажите, для чего предназначено взаимодействие. Например: изображение со значком «Нравится» и эмодзи. Можно предоставить более 1 изображения, но не все могут отображаться во всех форм-факторах. Примечание. Должно быть квадратное изображение 1:1. | Дополнительные сведения см. в разделе «Спецификации изображения» . |
Рейтинг – максимальное значение | Необходимый | Максимальное значение рейтинговой шкалы. Должно быть указано, если также указано текущее значение рейтинга. | Число >= 0,0 |
Рейтинг - Текущее значение | Необходимый | Текущее значение оценочной шкалы. Должно быть указано, если также указано максимальное значение рейтинга. | Число >= 0,0 |
Рейтинг – подсчет | Необязательный | Количество рейтингов сущности. Примечание. Укажите это поле, если ваше приложение контролирует отображение счетчика пользователям. Используйте краткую строку. Например, если счетчик равен 1 000 000, рассмотрите возможность использования сокращения, например 1M, чтобы счетчик не обрезался на дисплеях меньшего размера. | Нить |
Рейтинг – значение подсчета | Необязательный | Количество рейтингов сущности. Примечание. Укажите это поле, если вы не обрабатываете логику сокращений дисплея самостоятельно. Если присутствуют и счетчик, и значение счетчика, пользователям отображается счетчик. | Длинный |
Местоположение - Страна | Необязательный | Страна, в которой человек находится или служит. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение - Город | Необязательный | Город, в котором человек находится или служит. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение — отображение адреса | Необязательный | Пользователю будет показан адрес, по которому человек находится или обслуживает. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение – адрес | Необязательный | Уличный адрес (если применимо), по которому находится или работает данное лицо. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение — штат | Необязательный | Государство (если применимо), в котором находится или служит данное лицо. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение — почтовый индекс | Необязательный | Почтовый индекс (если применимо), где находится или работает данное лицо. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение – район | Необязательный | Район (если применимо), где находится или служит человек. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Значки | Необязательный | Каждый значок представляет собой либо произвольный текст (максимум 15 символов), либо небольшое изображение. | |
Значок – текст | Необязательный | Название для значка Примечание. Для значка требуется текст или изображение. | Произвольный текст Рекомендуемый размер текста: максимум 15 символов. |
Значок – изображение | Необязательный | Маленькое изображение Специальная UX-обработка, например наложение значка на миниатюру изображения или видео. Примечание. Для значка требуется текст или изображение. | Дополнительные сведения см. в разделе «Спецификации изображения» . |
Описание | Необязательный | Один абзац текста для описания объекта. Примечание. Пользователю будет отображаться либо описание, либо список субтитров, но не оба одновременно. | Произвольный текст Рекомендуемый размер текста: 180 символов. |
Список субтитров | Необязательный | До трех субтитров, каждый из которых представляет собой одну строку текста. Примечание. Пользователю будет отображаться либо описание, либо список субтитров, но не оба одновременно. | Произвольный текст Рекомендуемый размер текста для каждого субтитра: максимум 50 символов. |
Категории контента | Необязательный | Опишите категорию контента в сущности. | Список подходящих перечислений
Дополнительные сведения см. в разделе «Категория контента» . |
EventEntity
Атрибут | Требование | Описание | Формат |
---|---|---|---|
Действие Ури | Необходимый | Глубокая ссылка на объект в приложении поставщика. Примечание. Для атрибуции можно использовать глубокие ссылки. Обратитесь к этому FAQ | Ури |
Заголовок | Необходимый | Название сущности. | Нить Рекомендуемый размер текста: максимум 50 символов. |
Время начала | Необходимый | Временная метка эпохи, когда ожидается начало события. Примечание. Это будет указано в миллисекундах. | Временная метка эпохи в миллисекундах |
Режим событий | Необходимый | Поле, указывающее, будет ли мероприятие виртуальным, очным или и тем, и другим. | Перечисление: VIRTUAL, IN_PERSON или HYBRID. |
Изображения для плакатов | Необходимый | Если предоставлено несколько изображений, мы покажем только одно изображение. Рекомендуемое соотношение сторон — 16:9. Примечание. Изображение настоятельно рекомендуется. Если предоставляется значок, обеспечьте безопасное пространство в 24 dps вверху и внизу изображения. | Дополнительные сведения см. в разделе «Спецификации изображения» . |
Местоположение - Страна | Условно требуется | Страна, в которой происходит событие. Примечание. Это необходимо для событий IN_PERSON или HYBRID. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение - Город | Условно требуется | Город, в котором происходит событие. Примечание. Это необходимо для событий IN_PERSON или HYBRID. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение – отображение адреса | Условно требуется | Адрес или название места проведения мероприятия, которое должно отображаться пользователю. Примечание. Это необходимо для событий IN_PERSON или HYBRID. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение – адрес | Необязательный | Адрес (если применимо) места проведения мероприятия. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение — штат | Необязательный | Штат или провинция (если применимо), в которой проводится мероприятие. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение — почтовый индекс | Необязательный | Почтовый индекс (если применимо) места, в котором проводится мероприятие. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение – район | Необязательный | Район (если применимо), в котором проводится мероприятие. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Время окончания | Необязательный | Временная метка эпохи, когда ожидается завершение события. Примечание. Это будет указано в миллисекундах. | Временная метка эпохи в миллисекундах |
Описание | Необязательный | Один абзац текста для описания объекта. Примечание. Пользователю будет отображаться либо описание, либо список субтитров, но не оба одновременно. | Произвольный текст Рекомендуемый размер текста: 180 символов. |
Список субтитров | Необязательный | До трех субтитров, каждый из которых представляет собой одну строку текста. Примечание. Пользователю будет отображаться либо описание, либо список субтитров, но не оба одновременно. | Произвольный текст Рекомендуемый размер текста для каждого субтитра: максимум 50 символов. |
Значки | Необязательный | Каждый значок представляет собой либо произвольный текст (максимум 15 символов), либо небольшое изображение. | |
Значок – текст | Необязательный | Название для значка Примечание. Для значка требуется текст или изображение. | Произвольный текст Рекомендуемый размер текста: максимум 15 символов. |
Значок – изображение | Необязательный | Маленькое изображение Специальная UX-обработка, например наложение значка на миниатюру изображения или видео. Примечание. Для значка требуется текст или изображение. | Дополнительные сведения см. в разделе «Спецификации изображения» . |
Цена - Текущая цена | Условно требуется | Текущая цена билета/пропуска на мероприятие. Должно быть указано, если указана зачеркнутая цена. | Произвольный текст |
Цена - Зачеркнутая цена | Необязательный | Первоначальная цена билета/пропуска на мероприятие. | Произвольный текст |
Выноска цен | Необязательный | Выноска цены, чтобы указать промо-акцию, мероприятие, скидку для участников, если таковая имеется. | Произвольный текст Рекомендуемый размер текста: до 45 символов (слишком длинный текст может содержать многоточие). |
Категории контента | Необязательный | Опишите категорию контента в сущности. | Список подходящих перечислений
Дополнительные сведения см. в разделе «Категория контента» . |
EventReservationEntity
Атрибут | Требование | Описание | Формат |
---|---|---|---|
Действие Ури | Необходимый | Глубокая ссылка на объект в приложении поставщика. Примечание. Для атрибуции можно использовать глубокие ссылки. Обратитесь к этому FAQ | Ури |
Заголовок | Необходимый | Название сущности. | Нить Рекомендуемый размер текста: максимум 50 символов. |
Время начала | Необходимый | Временная метка эпохи, когда ожидается начало события. Примечание. Это будет указано в миллисекундах. | Временная метка эпохи в миллисекундах |
Режим событий | Необходимый | Поле, указывающее, будет ли мероприятие виртуальным, очным или и тем, и другим. | Перечисление: VIRTUAL, IN_PERSON или HYBRID. |
Местоположение - Страна | Условно требуется | Страна, в которой происходит событие. Примечание. Это необходимо для событий IN_PERSON или HYBRID. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение - Город | Условно требуется | Город, в котором происходит событие. Примечание. Это необходимо для событий IN_PERSON или HYBRID. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение – отображение адреса | Условно требуется | Адрес или название места проведения мероприятия, которое должно отображаться пользователю. Примечание. Это необходимо для событий IN_PERSON или HYBRID. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение – адрес | Необязательный | Адрес (если применимо) места проведения мероприятия. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение — штат | Необязательный | Штат или провинция (если применимо), в которой проводится мероприятие. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение — почтовый индекс | Необязательный | Почтовый индекс (если применимо) места, в котором проводится мероприятие. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Местоположение – район | Необязательный | Район (если применимо), в котором проводится мероприятие. | Произвольный текст Рекомендуемый размер текста: максимум ~20 символов. |
Изображения для плакатов | Необязательный | Если предоставлено несколько изображений, мы покажем только одно изображение. Рекомендуемое соотношение сторон — 16:9. Примечание. Изображение настоятельно рекомендуется. Если предоставляется значок, обеспечьте безопасное пространство в 24 dps вверху и внизу изображения. | См. инструкции в разделе «Технические характеристики изображения» . |
Время окончания | Необязательный | Временная метка эпохи, когда ожидается завершение события. Примечание. Это будет указано в миллисекундах. | Временная метка эпохи в миллисекундах |
Поставщик услуг – имя | Необязательный | Имя поставщика услуг. Примечание. Для поставщика услуг требуется либо текст, либо изображение. | Свободный текст. Например, имя организатора мероприятия/тура. |
Поставщик услуг – изображение | Необязательный | Логотип/изображение поставщика услуг. Примечание. Для поставщика услуг требуется либо текст, либо изображение. | Дополнительные сведения см. в разделе «Спецификации изображения» . |
Описание | Необязательный | Один абзац текста для описания объекта. Примечание. Пользователю будет отображаться либо описание, либо список субтитров, но не оба одновременно. | Произвольный текст Рекомендуемый размер текста: 180 символов. |
Список субтитров | Необязательный | До трех субтитров, каждый из которых представляет собой одну строку текста. Примечание. Пользователю будет отображаться либо описание, либо список субтитров, но не оба одновременно. | Произвольный текст Рекомендуемый размер текста для каждого субтитра: максимум 50 символов. |
Значки | Необязательный | Каждый значок представляет собой либо произвольный текст (максимум 15 символов), либо небольшое изображение. | |
Значок – текст | Необязательный | Название для значка Примечание. Для значка требуется текст или изображение. | Произвольный текст Рекомендуемый размер текста: максимум 15 символов. |
Значок – изображение | Необязательный | Маленькое изображение Специальная UX-обработка, например наложение значка на миниатюру изображения или видео. Примечание. Для значка требуется текст или изображение. | Дополнительные сведения см. в разделе «Спецификации изображения» . |
Идентификатор резервирования | Необязательный | Идентификатор резервирования для резервирования события. | Произвольный текст |
Цена - Текущая цена | Условно требуется | Текущая цена билета/пропуска на мероприятие. Должно быть указано, если указана зачеркнутая цена. | Произвольный текст |
Цена - Зачеркнутая цена | Необязательный | Первоначальная цена билета/пропуска на мероприятие. | Произвольный текст |
Выноска цен | Необязательный | Выноска с ценами, чтобы указать промо-акцию, мероприятие, скидку для участников, если таковая имеется. | Произвольный текст Рекомендуемый размер текста: до 45 символов (слишком длинный текст может содержать многоточие). |
Рейтинг – максимальное значение | Необязательный | Максимальное значение рейтинговой шкалы. Должно быть указано, если также указано текущее значение рейтинга. | Число >= 0,0 |
Рейтинг - Текущее значение | Необязательный | Текущее значение оценочной шкалы. Должно быть указано, если также указано максимальное значение рейтинга. | Число >= 0,0 |
Рейтинг – подсчет | Необязательный | Подсчет рейтингов события. Примечание. Укажите это поле, если ваше приложение хочет контролировать, как оно отображается пользователям. Укажите краткую строку, которая может быть отображена пользователю. Например, если количество составляет 1 000 000, рассмотрите возможность использования сокращений, таких как 1M, чтобы оно не обрезалось на дисплеях меньшего размера. | Нить |
Рейтинг – значение подсчета | Необязательный | Подсчет рейтингов события. Примечание. Укажите это поле, если вы не хотите самостоятельно обрабатывать логику отображаемых сокращений. Если присутствуют и счетчик, и значение счетчика, мы будем использовать счетчик для отображения пользователям. | Длинный |
Категории контента | Необязательный | Опишите категорию контента в сущности. | Список подходящих перечислений
Дополнительные сведения см. в разделе «Категория контента» . |
Характеристики изображения
Необходимые характеристики для графических ресурсов перечислены в этой таблице:
Соотношение сторон | Минимум пикселей | Рекомендуемые пиксели |
---|---|---|
Квадрат (1х1) Предпочтительный | 300х300 | 1200x1200 |
Пейзаж (1,91x1) | 600x314 | 1200x628 |
Портрет (4x5) | 480x600 | 960x1200 |
Изображения должны размещаться на общедоступных CDN, чтобы Google мог получить к ним доступ.
Форматы файлов
PNG, JPG, статический GIF, WebP
Максимальный размер файла
5120 КБ
Дополнительные рекомендации
- Безопасная область изображения: поместите важный контент в центр 80% изображения.
- Используйте прозрачный фон, чтобы изображение правильно отображалось в настройках темной и светлой темы.
Категория контента
Категория контента позволяет приложениям публиковать контент, принадлежащий нескольким категориям. Это сопоставляет контент с некоторыми из предопределенных категорий, а именно:
-
TYPE_EDUCATION
-
TYPE_SPORTS
-
TYPE_MOVIES_AND_TV_SHOWS
-
TYPE_BOOKS
-
TYPE_AUDIOBOOKS
-
TYPE_MUSIC
-
TYPE_DIGITAL_GAMES
-
TYPE_TRAVEL_AND_LOCAL
-
TYPE_HOME_AND_AUTO
-
TYPE_BUSINESS
-
TYPE_NEWS
-
TYPE_FOOD_AND_DRINK
-
TYPE_SHOPPING
-
TYPE_HEALTH_AND_FITENESS
-
TYPE_MEDICAL
-
TYPE_PARENTING
-
TYPE_DATING
Изображения должны размещаться на общедоступных CDN, чтобы Google мог получить к ним доступ.
Рекомендации по использованию категорий контента
- Некоторые сущности, такие как ArticleEntity и GenericFeaturedEntity, имеют право использовать любую из категорий контента. Для других сущностей, таких как EventEntity , EventReservationEntity , PersonEntity , допускается только подмножество этих категорий. Прежде чем заполнять список, проверьте список категорий, подходящих для типа сущности.
Используйте конкретный тип сущности для некоторых категорий контента вместо комбинации общих сущностей и ContentCategory:
- TYPE_MOVIES_AND_TV_SHOWS – проверьте объекты из руководства по интеграции Watch, прежде чем использовать общие объекты.
- TYPE_BOOKS — проверьте EbookEntity перед использованием общих объектов.
- TYPE_AUDIOBOOKS — проверьте AudiobookEntity перед использованием общих объектов.
- TYPE_SHOPPING — проверьте ShoppingEntity перед использованием общих объектов.
- TYPE_FOOD_AND_DRINK — проверьте объекты из руководства по интеграции продуктов питания, прежде чем использовать общие объекты.
Поле ContentCategory является необязательным и его следует оставить пустым, если контент не принадлежит ни к одной из категорий, упомянутых ранее.
Если указано несколько категорий контента, укажите их в порядке релевантности контенту, при этом наиболее релевантная категория контента будет располагаться первой в списке.
Шаг 2. Предоставьте данные кластера
Рекомендуется, чтобы задание публикации контента выполнялось в фоновом режиме (например, с помощью WorkManager ) и планировалось на регулярной основе или на основе событий (например, каждый раз, когда пользователь открывает приложение или когда пользователь только что добавил что-то в их тележка).
AppEngagePublishClient
отвечает за публикацию кластеров.
Существуют следующие API для публикации кластеров в клиенте:
-
isServiceAvailable
-
publishRecommendationClusters
-
publishFeaturedCluster
-
publishContinuationCluster
-
publishUserAccountManagementRequest
-
updatePublishStatus
-
deleteRecommendationsClusters
-
deleteFeaturedCluster
-
deleteContinuationCluster
-
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. } }
Ява
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
.
Котлин
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Top Picks For You") .build() ) .build() )
Ява
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Top Picks For You") .build()) .build());
Когда сервис получает запрос, в рамках одной транзакции происходят следующие действия:
- Существующие данные
RecommendationCluster
от партнера-разработчика удаляются. - Данные запроса анализируются и сохраняются в обновленном кластере рекомендаций.
В случае ошибки весь запрос отклоняется и существующее состояние сохраняется.
publishFeaturedCluster
Этот API используется для публикации списка объектов FeaturedCluster
.
Котлин
client.publishFeaturedCluster( PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( FeaturedCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Ява
client.publishFeaturedCluster( new PublishFeaturedClustersRequest.Builder() .addFeaturedCluster( new FeaturedCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build());
Когда сервис получает запрос, в рамках одной транзакции происходят следующие действия:
- Существующие данные
FeaturedCluster
от партнера-разработчика удаляются. - Данные запроса анализируются и сохраняются в обновленном избранном кластере.
В случае ошибки весь запрос отклоняется и существующее состояние сохраняется.
publishContinuationCluster
Этот API используется для публикации объекта ContinuationCluster
.
Котлин
client.publishContinuationCluster( PublishContinuationClusterRequest.Builder() .setContinuationCluster( ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Ява
client.publishContinuationCluster( new PublishContinuationClusterRequest.Builder() .setContinuationCluster( new ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build());
Когда сервис получает запрос, в рамках одной транзакции происходят следующие действия:
- Существующие данные
ContinuationCluster
от партнера-разработчика удаляются. - Данные запроса анализируются и сохраняются в обновленном кластере продолжения.
В случае ошибки весь запрос отклоняется и существующее состояние сохраняется.
publishUserAccountManagementRequest
Этот API используется для публикации карты входа. Действие входа направляет пользователей на страницу входа в приложение, чтобы приложение могло публиковать контент (или предоставлять более персонализированный контент).
Следующие метаданные являются частью карты входа:
Атрибут | Требование | Описание |
---|---|---|
Действие Ури | Необходимый | Глубокая ссылка на действие (т. е. переход на страницу входа в приложение) |
Изображение | Необязательно: если не указано, необходимо указать название. | Изображение на карте Изображения с соотношением сторон 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());
Ява
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 == 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())
Ява
client.updatePublishStatus( new PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build());
deleteRecommendationClusters
Этот API используется для удаления содержимого кластеров рекомендаций.
Котлин
client.deleteRecommendationClusters()
Ява
client.deleteRecommendationClusters();
Когда служба получает запрос, она удаляет существующие данные из кластеров рекомендаций. В случае ошибки весь запрос отклоняется и существующее состояние сохраняется.
deleteFeaturedCluster
Этот API используется для удаления содержимого избранного кластера.
Котлин
client.deleteFeaturedCluster()
Ява
client.deleteFeaturedCluster();
Когда служба получает запрос, она удаляет существующие данные из избранного кластера. В случае ошибки весь запрос отклоняется и существующее состояние сохраняется.
deleteContinuationCluster
Этот API используется для удаления содержимого кластера продолжения.
Котлин
client.deleteContinuationCluster()
Ява
client.deleteContinuationCluster();
Когда служба получает запрос, она удаляет существующие данные из кластера продолжения. В случае ошибки весь запрос отклоняется и существующее состояние сохраняется.
deleteUserManagementCluster
Этот API используется для удаления содержимого кластера UserAccountManagement.
Котлин
client.deleteUserManagementCluster()
Ява
client.deleteUserManagementCluster();
Когда служба получает запрос, она удаляет существующие данные из кластера UserAccountManagement. В случае ошибки весь запрос отклоняется и существующее состояние сохраняется.
deleteClusters
Этот API используется для удаления содержания данного типа кластера.
Котлин
client.deleteClusters( DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .build())
Ява
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .build());
Когда служба получает запрос, она удаляет существующие данные из всех кластеров, соответствующих указанным типам кластеров. Клиенты могут выбрать проход одного или многих типов кластеров. В случае ошибки весь запрос отклоняется, и существующее состояние сохраняется.
Обработка ошибок
Настоятельно рекомендуется прослушать результат задачи из публикации API, чтобы можно было предпринять последующее действие для восстановления и повторного представления успешной задачи.
Котлин
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster(..) .build()) .addOnCompleteListener { task -> if (task.isSuccessful) { // do something } else { val exception = task.exception if (exception is AppEngageException) { @AppEngageErrorCode val errorCode = exception.errorCode if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) { // do something } } } }
Ява
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 continuation cluster publish when PUBLISH_CONTINUATION 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)) // Register Featured Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_FEATURED)) // Register Continuation Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION)) }
Ява
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 continuation cluster publish when PUBLISH_CONTINUATION 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)); // Register Featured Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED)); // Register Continuation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION)); }
- Статически объявить реализацию с помощью тега
<receiver>
в вашем файлеAndroidManifest.xml
. Это позволяет приложению получать намерения вещания, когда оно не работает, а также позволяет приложению публиковать контент.
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
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.PUBLISH_CONTINUATION" />
</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.PUBLISH_CONTINUATION
Рекомендуется начать вызовpublishContinuationCluster
при получении этого намерения.
Интеграционный рабочий процесс
Для пошагового руководства по проверке вашей интеграции после ее завершения см. Рабочий процесс интеграции разработчика Engage .
Часто задаваемые вопросы
См . Engage SDK часто задают вопросы о часто задаваемых вопросах.
Контакт
Свяжитесь с Engage-developers@google.com, если есть какие-либо вопросы в процессе интеграции.
Следующие шаги
После завершения этой интеграции ваши следующие шаги следующие:
- Отправьте электронное письмо на engage-developers@google.com и прикрепите свой интегрированный APK, который готов к тестированию Google.
- Google выполняет проверку и обзоры внутренне, чтобы убедиться, что интеграция работает, как и ожидалось. Если необходимы изменения, Google связывается с вами с любыми необходимыми деталями.
- Когда тестирование завершено, и никаких изменений не требуется, Google связывается с вами, чтобы уведомить вас, что вы можете начать публиковать обновленный и интегрированный APK в магазин Play.
- После того, как Google подтвердил, что ваш обновленный APK был опубликован в Play Store, ваша рекомендация , представленные и продолжительные кластеры могут быть опубликованы и видимы для пользователей.