Эта страница переведена с помощью Cloud Translation API.

Engage SDK Другие направления: инструкции по технической интеграции сторонних разработчиков. Engage SDK Другие направления: Инструкции по технической интеграции сторонних разработчиков.

Повысьте вовлеченность пользователей в приложение, взаимодействуя с ними там, где они находятся. Интегрируйте Engage SDK, чтобы предоставлять персонализированные рекомендации и дополнительный контент непосредственно пользователям на различных платформах устройства, таких как «Коллекции» , «Развлекательное пространство » и Play Store. Интеграция добавляет менее 50 КБ (в сжатом виде) к среднему размеру APK-файла и занимает у большинства приложений около недели на разработку. Узнайте больше на нашем корпоративном сайте .

В этом документе содержатся инструкции для партнеров-разработчиков по интеграции нового контента, такого как бронирования, мероприятия, размещение, достопримечательности, люди и другой контент, который может не относиться ни к одной из этих категорий.

Детали интеграции

Терминология

Данная интеграция включает в себя следующие три типа кластеров: Рекомендации , Рекомендуемые и Продолжение .

Кластеры рекомендаций отображают персонализированные предложения от конкретного разработчика-партнера. Это интерфейс, содержащий группу рекомендаций от одного и того же разработчика-партнера.
- ArticleEntity : ArticleEntity — это текстовая рекомендация контента, относящегося к нескольким категориям. Элемент ArticleEntity позволяет разработчикам предоставлять разнообразный текстовый и графический контент с большим количеством метаданных для более точной передачи информации пользователям по сравнению с GenericFeaturedEntity. Например: маркетинговый контент, новостной сниппет.
  Рисунок 1: Пользовательский интерфейс, отображающий отдельный объект ArticleEntity в кластере «Рекомендации».
- EventEntity : EventEntity представляет собой событие, которое произойдет в будущем. Время начала события — это важная информация, которую необходимо передать пользователям.
  Рисунок 2: Пользовательский интерфейс, отображающий отдельный объект EventEntity в кластере «Рекомендации».
- LodgingEntity : LodgingEntity обозначает тип жилья, например, отель, апартаменты или дом для отдыха, сдаваемый в краткосрочную и долгосрочную аренду.
  Рисунок 3: Пользовательский интерфейс, отображающий отдельный объект размещения (LodgingEntity) в кластере рекомендаций.
- StoreEntity : StoreEntity обозначает магазин, ресторан, кафе и т. д. Он выделяет контент, где информация о заведении общественного питания или магазине является критически важной для передачи пользователям.
  Рисунок 4: Пользовательский интерфейс, отображающий отдельный объект StoreEntity в кластере «Рекомендации».
- Объект PointOfInterestEntity : PointOfInterestEntity обозначает место, представляющее интерес, например, автозаправочную станцию, место проведения мероприятия, тематический парк, музей, туристическую достопримечательность, пешеходную тропу и т. д. Он выделяет контент, где местоположение является критически важной информацией, которую необходимо передать пользователям. Его не следует использовать для обозначения гостиниц, магазинов или ресторанов.
  Рисунок 5: Пользовательский интерфейс, отображающий отдельный объект PointOfInterestEntity в кластере «Рекомендации».
- PersonEntity : PersonEntity представляет собой человека. Рекомендации могут заключаться в том, чтобы выделить человека в таких категориях, как здоровье и фитнес, спорт, знакомства и т. д.
  Рисунок 5: Пользовательский интерфейс, отображающий отдельный объект PersonEntity в кластере «Рекомендации».
В кластере «Продолжение» отображается контент, недавно использованный пользователями из разных партнерских компаний-разработчиков, в рамках одной группы пользовательского интерфейса. Каждому партнеру-разработчику будет разрешено транслировать максимум 10 объектов в кластере «Продолжение».
Продолжение вашего текста может иметь следующую структуру:
- ArticleEntity : ArticleEntity — это текстовая рекомендация контента, относящегося к нескольким категориям. Эта сущность может использоваться для представления незавершенных новостных статей или другого контента, который пользователь хотел бы продолжить просмотр с того места, где он остановился. Например: маркетинговый контент, новостной фрагмент.
  Рисунок 6. Пользовательский интерфейс, отображающий отдельный объект ArticleEntity в кластере Continuation.
- RestaurantReservationEntity : RestaurantReservationEntity представляет собой бронирование столика в ресторане или кафе и помогает пользователям отслеживать предстоящие или текущие бронирования в ресторанах.
  Рисунок 7. Пользовательский интерфейс, отображающий отдельный объект RestaurantReservationEntity в кластере Continuation.
- EventReservationEntity : EventReservationEntity представляет собой бронирование на мероприятие и помогает пользователям отслеживать бронирования предстоящих или текущих мероприятий. Мероприятия могут включать, помимо прочего, следующие:
  - Спортивные мероприятия, такие как бронирование мест на футбольный матч.
  - Игровые мероприятия, такие как бронирование мест для киберспорта.
  - Развлекательные мероприятия, такие как бронирование билетов в кинотеатр, концерт, театр, автограф-сессия.
  - Бронирование поездок или посещение достопримечательностей, таких как экскурсии с гидом, билеты в музеи.
  - Бронирование мест на мероприятия / семинары / конференции
  - Бронирование образовательных/тренинговых сессий
  Рисунок 8. Пользовательский интерфейс, отображающий отдельный объект EventReservationEntity в кластере Continuation.
- LodgingReservationEntity : LodgingEntityReservation представляет собой бронирование жилья для путешествия и помогает пользователям отслеживать предстоящие или текущие бронирования отелей или апартаментов для отдыха.
  Рисунок 9. Пользовательский интерфейс, отображающий отдельный объект LodgingReservationEntity в кластере Continuation.
- TransportationReservationEntity : TransportationReservationEntity представляет собой бронирование транспортного средства любым видом транспорта и помогает пользователям отслеживать бронирования на предстоящие или текущие рейсы, паромы, поезда, автобусы, услуги такси или круизы.
  Рисунок 10. Пользовательский интерфейс, отображающий отдельный объект TransportationReservationEntity в кластере Continuation.
- VehicleRentalReservationEntity : VehicleRentalReservationEntity представляет собой бронирование автомобиля в аренду и помогает пользователям отслеживать предстоящие или текущие бронирования автомобилей в аренду.
  Рисунок 11. Пользовательский интерфейс, отображающий отдельный объект VehicleRentalReservationEntity в кластере Continuation.
Кластер «Рекомендуемые» — это элемент пользовательского интерфейса, демонстрирующий выбранный объект GenericFeaturedEntity от множества партнеров-разработчиков в одной группе. Существует один кластер «Рекомендуемые», который отображается в верхней части интерфейса и имеет приоритетное расположение над всеми кластерами «Рекомендуемые». Каждому партнеру-разработчику разрешено транслировать один объект поддерживаемого типа в кластере «Рекомендуемые», при этом в кластере «Рекомендуемые» могут находиться множество объектов (потенциально разных типов) от нескольких разработчиков приложений.
- GenericFeaturedEntity : GenericFeaturedEntity отличается от элемента «Рекомендация» тем, что элемент «Рекомендуемый» должен использоваться для отображения одного наиболее важного контента от разработчиков и представлять собой единственный наиболее важный контент, который будет интересен и актуален для пользователей.
  Рисунок 12: Пользовательский интерфейс, отображающий отдельную карточку 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.6.0'
}

Краткое содержание

Данная архитектура основана на реализации привязанного сервиса .

Для различных типов кластеров объем данных, которые может публиковать клиент, ограничен следующими лимитами:

Тип кластера	Границы кластера	Минимальное количество объектов в кластере	Максимальное количество объектов в кластере.
Кластер(ы) рекомендаций	Максимум 7	По крайней мере 1	Не более 50 ( `ArticleEntity` , `EventEntity` , `LodgingEntity` , `StoreEntity` , `PointOfInterestEntity` или `PersonEntity` )
Кластер продолжения	Не более 1	По крайней мере 1	Не более 20 ( `ArticleEntity` , `EventReservationEntity` , `LodgingReservationEntity` , `TransportationReservationEntity` или `VehicleRentalReservationEntity` )
Выделенный кластер	Не более 1	По крайней мере 1	Максимум 20 ( `GenericFeaturedEntity` )

Шаг 1: Предоставьте данные сущности.

В SDK определены различные сущности для представления каждого типа элементов. Для категории «Прочие» мы поддерживаем следующие сущности:

GenericFeaturedEntity
ArticleEntity
EventEntity
LodgingEntity
StoreEntity
PointOfInterestEntity
PersonEntity
RestaurantReservationEntity
EventReservationEntity
LodgingReservationEntity
TransportationReservationEntity
VehicleRentalReservationEntity

Приведенные ниже диаграммы описывают доступные характеристики и требования для каждого типа.

`GenericFeaturedEntity`

Атрибут	Требование	Описание	Формат
Action Uri	Необходимый	Прямая ссылка на сущность в приложении поставщика. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов.	Ури
Изображения для плакатов	Необходимый	При предоставлении нескольких изображений будет показано только одно. Рекомендуемое соотношение сторон — 16:9. Примечание: Если предоставляется бейдж, обеспечьте безопасное расстояние в 24 dps как сверху, так и снизу изображения.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Заголовок	Необязательный	Название организации.	Свободный текст Рекомендуемый размер текста: 50 символов.
Описание	Необязательный	Один абзац текста, описывающий объект. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста: 180 символов.
список субтитров	Необязательный	До 3 субтитров, каждый из которых представляет собой отдельную строку текста. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста для каждого субтитра: максимум 50 символов.
Значки	Необязательный	Каждый значок представляет собой либо произвольный текст (максимум 15 символов), либо небольшое изображение. Специальная обработка пользовательского интерфейса поверх изображения/видео, например, в виде наложения значка на изображение. "Обновление в режиме реального времени" Продолжительность чтения статьи
Значок - Текст	Необязательный	Название для значка Примечание: для значка требуется либо текст, либо изображение.	Свободный текст Рекомендуемый размер текста: максимум 15 символов.
Значок - Изображение	Необязательный	Маленькое изображение Особое оформление пользовательского интерфейса, например, наложение значка на миниатюру изображения/видео. Примечание: для значка требуется либо текст, либо изображение.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Категории контента	Необязательный	Опишите категорию контента в сущности.	Список перечислений См. раздел «Категории контента» для получения рекомендаций.

`ArticleEntity`

Атрибут	Требование	Описание	Формат
Action Uri	Необходимый	Прямая ссылка на сущность в приложении поставщика. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов.	Ури
Заголовок	Необходимый	Название организации.	Свободный текст Рекомендуемый размер текста: максимум 50 символов.
Изображения для плакатов	Необязательный	При предоставлении нескольких изображений будет показано только одно. Рекомендуемое соотношение сторон — 16:9. Примечание: Настоятельно рекомендуется использовать изображение. Если предоставляется бейдж, обеспечьте безопасное пространство в 24 dps как сверху, так и снизу изображения.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Источник - Название	Необязательный	Имя автора, организации или журналиста.	Свободный текст Рекомендуемый размер текста: менее 25 символов.
Источник - Изображение	Необязательный	Изображение источника, например, автора, организации, репортера.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Описание	Необязательный	Один абзац текста, описывающий объект. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста: 180 символов.
список субтитров	Необязательный	До 3 субтитров, каждый из которых представляет собой отдельную строку текста. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста для каждого субтитра: максимум 50 символов.
Значки	Необязательный	Каждый значок представляет собой либо произвольный текст (максимум 15 символов), либо небольшое изображение. Специальное оформление пользовательского интерфейса поверх изображения/видео, например, в виде наложения значка поверх изображения. "Обновление в режиме реального времени" Продолжительность чтения статьи
Значок - Текст	Необязательный	Название для значка Примечание: для значка требуется либо текст, либо изображение.	Свободный текст Рекомендуемый размер текста: максимум 15 символов.
Значок - Изображение	Необязательный	Маленькое изображение Особое оформление пользовательского интерфейса, например, наложение значка на миниатюру изображения/видео. Примечание: для значка требуется либо текст, либо изображение.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Время публикации контента	Необязательный	Это метка времени в миллисекундах, соответствующая дате публикации/обновления контента в приложении.	Временная метка эпохи в миллисекундах
Последнее время помолвки	Требуется при определенных условиях	Временная метка в миллисекундах, отражающая момент последнего взаимодействия пользователя с данным объектом. Примечание: это поле обязательно для заполнения, если данная сущность является частью кластера продолжения.	Временная метка эпохи в миллисекундах
Процент выполнения	Требуется при определенных условиях	Процент от общего объема контента, потребленного пользователем на данный момент. Примечание: это поле обязательно для заполнения, если данная сущность является частью кластера продолжения.	Целочисленное значение в диапазоне от 0 до 100 включительно.
Категории контента	Необязательный	Опишите категорию контента в сущности.	Список перечислений См. раздел «Категории контента» для получения рекомендаций.

`EventEntity`

Атрибут	Требование	Описание	Формат
Action Uri	Необходимый	Прямая ссылка на сущность в приложении поставщика. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов.	Ури
Заголовок	Необходимый	Название организации.	Нить Рекомендуемый размер текста: максимум 50 символов.
Время начала	Необходимый	Временная метка эпохи, когда ожидается начало события. Примечание: Данные будут представлены в миллисекундах.	Временная метка эпохи в миллисекундах
Режим событий	Необходимый	Поле для указания того, будет ли мероприятие виртуальным, очным или и тем, и другим.	Перечисление: ВИРТУАЛЬНЫЙ, ОЧНЫЙ или ГИБРИДНЫЙ формат
Изображения для плакатов	Необходимый	При предоставлении нескольких изображений будет показано только одно. Рекомендуемое соотношение сторон — 16:9. Примечание: Настоятельно рекомендуется использовать изображение. Если предоставляется бейдж, обеспечьте безопасное пространство в 24 dps как сверху, так и снизу изображения.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Местоположение - Страна	Требуется при определенных условиях	Страна, в которой проходит мероприятие. Примечание: Это необходимо для мероприятий, проводимых в очном или гибридном формате.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Город	Требуется при определенных условиях	Город, в котором проходит мероприятие. Примечание: Это необходимо для мероприятий, проводимых в очном или гибридном формате.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Отображаемый адрес	Требуется при определенных условиях	Адрес или название места проведения мероприятия, которое должно быть отображено пользователю. Примечание: Это необходимо для мероприятий, проводимых в очном или гибридном формате.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Уличный адрес	Необязательный	Адрес (если имеется) места проведения мероприятия.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Штат	Необязательный	Штат или провинция (если применимо), в которой проводится мероприятие.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - почтовый индекс	Необязательный	Почтовый индекс (если применимо) места проведения мероприятия.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Район	Необязательный	Район (если применимо), в котором проводится мероприятие.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Конец времени	Необязательный	Временная метка эпохи, когда ожидается завершение события. Примечание: Данные будут представлены в миллисекундах.	Временная метка эпохи в миллисекундах
Описание	Необязательный	Один абзац текста, описывающий объект. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста: 180 символов.
список субтитров	Необязательный	До 3 субтитров, каждый из которых представляет собой отдельную строку текста. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста для каждого субтитра: максимум 50 символов.
Значки	Необязательный	Каждый значок представляет собой либо произвольный текст (максимум 15 символов), либо небольшое изображение.
Значок - Текст	Необязательный	Название для значка Примечание: для значка требуется либо текст, либо изображение.	Свободный текст Рекомендуемый размер текста: максимум 15 символов.
Значок - Изображение	Необязательный	Маленькое изображение Особое оформление пользовательского интерфейса, например, наложение значка на миниатюру изображения/видео. Примечание: для значка требуется либо текст, либо изображение.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Цена - Текущая цена	Условно обязательно	Текущая цена билета/пропуска на мероприятие. Необходимо указать, если указана перечеркнутая цена.	Свободный текст
Цена - Зачеркнутая цена	Необязательный	Первоначальная цена билета/пропуска на мероприятие.	Свободный текст
Указание цены	Необязательный	Укажите цену, чтобы отобразить информацию о промоакции, мероприятии или скидке для участников, если таковая имеется.	Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие).
Категории контента	Необязательный	Опишите категорию контента в сущности.	Список соответствующих требованиям перечней TYPE_MOVIES_AND_TV_SHOWS (Пример - Кинотеатр) TYPE_DIGITAL_GAMES (Пример - киберспорт) TYPE_MUSIC (Пример - Концерт) TYPE_TRAVEL_AND_LOCAL (Пример - Тур, фестиваль) TYPE_HEALTH_AND_FITENESS (Пример - Занятие йогой) TYPE_EDUCATION (Пример - Класс) TYPE_SPORTS (Пример - Футбольный матч) TYPE_DATING (Пример - встреча) См. раздел «Категории контента» для получения рекомендаций.

`LodgingEntity`

Атрибут	Требование	Описание	Формат
Action Uri	Необходимый	Прямая ссылка на сущность в приложении поставщика. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов.	Ури
Заголовок	Необходимый	Название организации.	Нить Рекомендуемый размер текста: максимум 50 символов.
Изображения для плакатов	Необходимый	При предоставлении нескольких изображений будет показано только одно. Рекомендуемое соотношение сторон — 16:9. Примечание: Если предоставляется бейдж, обеспечьте безопасное расстояние в 24 dps как сверху, так и снизу изображения.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Местоположение - Страна	Необходимый	Страна, в которой осуществляется размещение.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Город	Необходимый	Город, в котором осуществляется размещение.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Отображаемый адрес	Необходимый	Адрес места проживания, который будет отображен пользователю.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Уличный адрес	Необязательный	Адрес проживания (если имеется).	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Штат	Необязательный	Штат или провинция (если применимо), в которой находится место проживания.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - почтовый индекс	Необязательный	Почтовый индекс (если имеется) места проживания.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Район	Необязательный	Район (если применимо), где находится жилье.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Значки	Необязательный	Каждый значок представляет собой либо произвольный текст (максимум 15 символов), либо небольшое изображение.
Значок - Текст	Необязательный	Название для значка Примечание: для значка требуется либо текст, либо изображение.	Свободный текст Рекомендуемый размер текста: максимум 15 символов.
Значок - Изображение	Необязательный	Маленькое изображение Особое оформление пользовательского интерфейса, например, наложение значка на миниатюру изображения/видео. Примечание: для значка требуется либо текст, либо изображение.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Описание	Необязательный	Один абзац текста, описывающий объект. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста: 180 символов.
список субтитров	Необязательный	До 3 субтитров, каждый из которых представляет собой отдельную строку текста. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста для каждого субтитра: максимум 50 символов.
AvailabilityTimeWindow - Время начала	Необязательный	Временная метка в миллисекундах, указывающая на предполагаемое время открытия/доступности жилья.	Временная метка эпохи в миллисекундах
AvailabilityTimeWindow - Время окончания	Необязательный	Временная метка в миллисекундах, до которой ожидается, что жилье будет открыто/доступно.	Временная метка эпохи в миллисекундах
Рейтинг - Максимальное значение	Необязательный	Максимальное значение шкалы оценок. Этот параметр необходимо указать, если также предоставлено текущее значение рейтинга.	Число >= 0,0
Рейтинг - Текущая стоимость	Необязательный	Текущее значение рейтинговой шкалы. Этот параметр необходимо указать, если также указано максимальное значение рейтинга.	Число >= 0,0
Рейтинг - Количество	Необязательный	Количество оценок, выставленных отелю. Примечание: Укажите это поле, если ваше приложение контролирует способ отображения количества для пользователей. Используйте краткую строку. Например, если количество равно 1 000 000, рассмотрите возможность использования сокращения, например, 1M, чтобы количество не обрезалось на экранах меньшего размера.	Нить
Рейтинг - Количество значений	Необязательный	Количество оценок, выставленных отелю. Примечание: Укажите это поле, если вы не обрабатываете логику отображения сокращений самостоятельно. Если присутствуют поля «Count» и «Count Value», пользователям будет отображаться значение «Count».	Длинный
Цена - Текущая цена	Условно обязательно	Текущая цена проживания. Необходимо указать, если указана перечеркнутая цена.	Свободный текст
Цена - Зачеркнутая цена	Необязательный	Первоначальная цена проживания, которая будет зачеркнута в UI.	Свободный текст
Указание цены	Необязательный	Укажите цену, чтобы отобразить информацию о промоакции, мероприятии или скидке для участников, если таковая имеется.	Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие).

`StoreEntity`

Объект StoreEntity представляет собой отдельный магазин, который партнеры-разработчики хотят опубликовать, например, ресторан или продуктовый магазин.

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

`PointOfInterestEntity`

Атрибут	Требование	Описание	Формат
Action Uri	Необходимый	Прямая ссылка на сущность в приложении поставщика. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов.	Ури
Заголовок	Необходимый	Название организации.	Нить Рекомендуемый размер текста: максимум 50 символов.
Изображения для плакатов	Необходимый	При предоставлении нескольких изображений будет показано только одно. Рекомендуемое соотношение сторон — 16:9. Примечание: Настоятельно рекомендуется использовать изображение. Если предоставляется бейдж, обеспечьте безопасное пространство в 24 dps как сверху, так и снизу изображения.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Местоположение - Страна	Необходимый	Страна, в которой происходит событие, представляющее интерес.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Город	Необходимый	Город, в котором находится интересующее место.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Отображаемый адрес	Необходимый	Адрес интересующего объекта, который будет отображен пользователю.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Уличный адрес	Необязательный	Адрес (если имеется) интересующего объекта.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Штат	Необязательный	Штат или провинция (если применимо), в которой находится интересующий объект.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - почтовый индекс	Необязательный	Почтовый индекс (если применимо) интересующего объекта.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Район	Необязательный	Окрестности (если применимо) интересующего объекта.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
AvailabilityTimeWindow - Время начала	Необязательный	Временная метка в миллисекундах, указывающая на момент, когда интересующая точка, как ожидается, будет открыта/доступна.	Временная метка эпохи в миллисекундах
AvailabilityTimeWindow - Время окончания	Необязательный	Временная метка эпохи в миллисекундах, до которой ожидается, что интересующая точка будет открыта/доступна.	Временная метка эпохи в миллисекундах
Значки	Необязательный	Каждый значок представляет собой либо произвольный текст (максимум 15 символов), либо небольшое изображение.
Значок - Текст	Необязательный	Название для значка Примечание: для значка требуется либо текст, либо изображение.	Свободный текст Рекомендуемый размер текста: максимум 15 символов.
Значок - Изображение	Необязательный	Маленькое изображение Особое оформление пользовательского интерфейса, например, наложение значка на миниатюру изображения/видео. Примечание: для значка требуется либо текст, либо изображение.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Описание	Необязательный	Один абзац текста, описывающий объект. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста: 180 символов.
список субтитров	Необязательный	До 3 субтитров, каждый из которых представляет собой отдельную строку текста. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста для каждого субтитра: максимум 50 символов.
Рейтинг - Максимальное значение	Необязательный	Максимальное значение шкалы оценок. Этот параметр необходимо указать, если также предоставлено текущее значение рейтинга.	Число >= 0,0
Рейтинг - Текущая стоимость	Необязательный	Текущее значение рейтинговой шкалы. Этот параметр необходимо указать, если также указано максимальное значение рейтинга.	Число >= 0,0
Рейтинг - Количество	Необязательный	Количество оценок для интересующего объекта. Примечание: Укажите это поле, если ваше приложение контролирует способ отображения количества для пользователей. Используйте краткую строку. Например, если количество равно 1 000 000, рассмотрите возможность использования сокращения, например, 1M, чтобы количество не обрезалось на экранах меньшего размера.	Нить
Рейтинг - Количество значений	Необязательный	Количество оценок для интересующего объекта. Примечание: Укажите это поле, если вы не обрабатываете логику отображения сокращений самостоятельно. Если присутствуют поля «Count» и «Count Value», пользователям будет отображаться значение «Count».	Длинный
Цена - Текущая цена	Условно обязательно	Текущая цена билетов/входного билета в достопримечательность. Необходимо указать, если указана перечеркнутая цена.	Свободный текст
Цена - Зачеркнутая цена	Необязательный	Первоначальная цена билетов/входного билета в достопримечательность.	Свободный текст
Указание цены	Необязательный	Укажите цену, чтобы отобразить информацию о промоакции, мероприятии или скидке для участников, если таковая имеется.	Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие).
Категории контента	Необязательный	Опишите категорию контента в сущности.	Список соответствующих требованиям перечней TYPE_TRAVEL_AND_LOCAL TYPE_MOVIES_AND_TV_SHOWS (Пример - театр) TYPE_MEDICAL (Пример - больница) TYPE_EDUCATION (Пример - школа) TYPE_SPORTS (Пример - стадион) См. раздел «Категории контента» для получения рекомендаций.

`PersonEntity`

Атрибут	Требование	Описание	Формат
Action Uri	Необходимый	Прямая ссылка на сущность в приложении поставщика. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов.	Ури
Профиль - Имя	Необходимый	Имя профиля, идентификатор или никнейм, например, "John Doe", "@TeamPixel" и т. д.	Нить Рекомендуемый размер текста: максимум 50 символов.
Профиль - Аватар	Необходимый	Фотография профиля или аватар пользователя. Примечание: Изображение должно быть квадратным, в масштабе 1:1.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Профиль - Дополнительный текст	Необязательный	Свободный текст, например, никнейм в профиле.	Свободный текст Рекомендуемый размер текста: максимум 15 символов.
Профиль - Дополнительное изображение	Необязательный	Небольшое изображение, похожее на значок подтверждения.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Изображение в заголовке	Необязательный	При предоставлении нескольких изображений будет показано только одно. Рекомендуемое соотношение сторон — 16:9. Примечание: Настоятельно рекомендуется использовать изображение. Если предоставляется бейдж, обеспечьте безопасное пространство в 24 dps как сверху, так и снизу изображения.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Популярность - Количество	Необязательный	Укажите количество подписчиков или показатель популярности, например, "3,7 млн". Примечание: Если указаны и значение Count, и значение Count, будет использовано значение Count.	Нить Рекомендуемый размер текста: максимум 20 символов для количества символов и метки вместе взятых.
Популярность - значение количества	Необязательный	Количество подписчиков или показатель популярности. Примечание: укажите значение Count, если ваше приложение не хочет обрабатывать логику оптимизации больших чисел для разных размеров экрана. Если указаны и Count, и Count Value, будет использоваться Count.	Длинный
Популярность - Метка	Необязательный	Укажите, какой рейтинг используется. Например, «Лайки».	Нить Рекомендуемый размер текста: максимум 20 символов для количества символов и метки вместе взятых.
Популярность - Визуальная	Необязательный	Укажите, для чего предназначено это взаимодействие. Например: изображение со значком «Нравится», эмодзи. Можно предоставить более одного изображения, однако не все из них могут отображаться на всех форм-факторах. Примечание: Изображение должно быть квадратным, в масштабе 1:1.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Рейтинг - Максимальное значение	Необходимый	Максимальное значение шкалы оценок. Этот параметр необходимо указать, если также предоставлено текущее значение рейтинга.	Число >= 0,0
Рейтинг - Текущая стоимость	Необходимый	Текущее значение рейтинговой шкалы. Этот параметр необходимо указать, если также указано максимальное значение рейтинга.	Число >= 0,0
Рейтинг - Количество	Необязательный	Количество оценок для данной организации. Примечание: Укажите это поле, если ваше приложение хочет контролировать способ отображения этой информации пользователям. Укажите краткую строку, которая может быть показана пользователю. Например, если значение равно 1 000 000, используйте сокращения, такие как 1M, чтобы оно не обрезалось на экранах меньшего размера.	Нить
Рейтинг - Количество значений	Необязательный	Количество оценок для данной организации. Примечание: Укажите это поле, если вы не хотите самостоятельно обрабатывать логику отображения сокращений. Если присутствуют поля «Количество» и «Значение количества», мы будем использовать значение «Количество» для отображения пользователям.	Длинный
Местоположение - Страна	Необязательный	Страна, в которой находится или работает данное лицо.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Город	Необязательный	Город, в котором находится или работает данный человек.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Отображаемый адрес	Необязательный	Пользователю будет показан адрес, по которому находится или оказывает свои услуги данное лицо.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Уличный адрес	Необязательный	Адрес (если применимо), по которому находится или работает данное лицо.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Штат	Необязательный	Штат (если применимо), где находится или работает данное лицо.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - почтовый индекс	Необязательный	Почтовый индекс (если применимо), по которому находится или проходит службу данное лицо.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Район	Необязательный	Район (если применимо), где находится или работает данное лицо.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Значки	Необязательный	Каждый значок представляет собой либо произвольный текст (максимум 15 символов), либо небольшое изображение.
Значок - Текст	Необязательный	Название для значка Примечание: для значка требуется либо текст, либо изображение.	Свободный текст Рекомендуемый размер текста: максимум 15 символов.
Значок - Изображение	Необязательный	Маленькое изображение Особое оформление пользовательского интерфейса, например, наложение значка на миниатюру изображения/видео. Примечание: для значка требуется либо текст, либо изображение.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Описание	Необязательный	Один абзац текста, описывающий объект. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста: 180 символов.
список субтитров	Необязательный	До 3 субтитров, каждый из которых представляет собой отдельную строку текста. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста для каждого субтитра: максимум 50 символов.
Категории контента	Необязательный	Опишите категорию контента в сущности.	Список соответствующих требованиям перечней TYPE_HEALTH_AND_FITENESS (Пример - Тренер по йоге/фитнесу) TYPE_HOME_AND_AUTO (Пример - Сантехник) TYPE_SPORTS (Пример - Игрок) TYPE_DATING См. раздел «Категории контента» для получения рекомендаций.

`RestaurantReservationEntity`

Атрибут	Требование	Описание	Формат
Action Uri	Необходимый	Прямая ссылка на сущность в приложении поставщика. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов.	Ури
Заголовок	Необходимый	Название организации.	Нить Рекомендуемый размер текста: максимум 50 символов.
Время начала бронирования	Необходимый	Временная метка в миллисекундах, указывающая на предполагаемое начало действия бронирования.	Временная метка эпохи в миллисекундах
Местоположение - Страна	Необходимый	Страна, в которой расположен ресторан.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Город	Необходимый	Город, в котором расположен ресторан.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Отображаемый адрес	Необходимый	Адрес ресторана, который будет отображен пользователю.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Уличный адрес	Необязательный	Адрес ресторана (если имеется).	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Штат	Необязательный	Штат или провинция (если применимо), в которой расположен ресторан.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - почтовый индекс	Необязательный	Почтовый индекс (если имеется) ресторана.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Район	Необязательный	Район (если применимо), в котором расположен ресторан.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Изображения для плакатов	Необязательный	При предоставлении нескольких изображений будет показано только одно. Рекомендуемое соотношение сторон — 16:9.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Описание	Необязательный	Один абзац текста, описывающий объект. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста: 180 символов.
список субтитров	Необязательный	До 3 субтитров, каждый из которых представляет собой отдельную строку текста. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста для каждого субтитра: максимум 50 символов.
Размер стола	Необязательный	Количество человек в резервационной группе	Целое число > 0

`EventReservationEntity`

Атрибут	Требование	Описание	Формат
Action Uri	Необходимый	Прямая ссылка на сущность в приложении поставщика. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов.	Ури
Заголовок	Необходимый	Название организации.	Нить Рекомендуемый размер текста: максимум 50 символов.
Время начала	Необходимый	Временная метка эпохи, когда ожидается начало события. Примечание: Данные будут представлены в миллисекундах.	Временная метка эпохи в миллисекундах
Режим событий	Необходимый	Поле для указания того, будет ли мероприятие виртуальным, очным или и тем, и другим.	Перечисление: ВИРТУАЛЬНЫЙ, ОЧНЫЙ или ГИБРИДНЫЙ формат
Местоположение - Страна	Требуется при определенных условиях	Страна, в которой проходит мероприятие. Примечание: Это необходимо для мероприятий, проводимых в очном или гибридном формате.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Город	Требуется при определенных условиях	Город, в котором проходит мероприятие. Примечание: Это необходимо для мероприятий, проводимых в очном или гибридном формате.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Отображаемый адрес	Требуется при определенных условиях	Адрес или название места проведения мероприятия, которое должно быть отображено пользователю. Примечание: Это необходимо для мероприятий, проводимых в очном или гибридном формате.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Уличный адрес	Необязательный	Адрес (если имеется) места проведения мероприятия.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Штат	Необязательный	Штат или провинция (если применимо), в которой проводится мероприятие.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - почтовый индекс	Необязательный	Почтовый индекс (если применимо) места проведения мероприятия.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Местоположение - Район	Необязательный	Район (если применимо), в котором проводится мероприятие.	Свободный текст Рекомендуемый размер текста: максимум ~20 символов.
Изображения для плакатов	Необязательный	При предоставлении нескольких изображений будет показано только одно. Рекомендуемое соотношение сторон — 16:9. Примечание: Настоятельно рекомендуется использовать изображение. Если предоставляется бейдж, обеспечьте безопасное пространство в 24 dps как сверху, так и снизу изображения.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Конец времени	Необязательный	Временная метка эпохи, когда ожидается завершение события. Примечание: Данные будут представлены в миллисекундах.	Временная метка эпохи в миллисекундах
Поставщик услуг - Название	Необязательный	Название поставщика услуг. Примечание: Для предоставления услуг поставщику требуется либо текст, либо изображение.	Свободный текст. Например, название организатора мероприятия/тура.
Поставщик услуг - Изображение	Необязательный	Логотип/изображение поставщика услуг. Примечание: Для предоставления услуг поставщику требуется либо текст, либо изображение.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Описание	Необязательный	Один абзац текста, описывающий объект. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста: 180 символов.
список субтитров	Необязательный	До 3 субтитров, каждый из которых представляет собой отдельную строку текста. Примечание: Пользователю будет отображаться либо описание, либо список подзаголовков, но не оба одновременно.	Свободный текст Рекомендуемый размер текста для каждого субтитра: максимум 50 символов.
Значки	Необязательный	Каждый значок представляет собой либо произвольный текст (максимум 15 символов), либо небольшое изображение.
Значок - Текст	Необязательный	Название для значка Примечание: для значка требуется либо текст, либо изображение.	Свободный текст Рекомендуемый размер текста: максимум 15 символов.
Значок - Изображение	Необязательный	Маленькое изображение Особое оформление пользовательского интерфейса, например, наложение значка на миниатюру изображения/видео. Примечание: для значка требуется либо текст, либо изображение.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Идентификатор бронирования	Необязательный	Идентификатор бронирования для подтверждения участия в мероприятии.	Свободный текст
Цена - Текущая цена	Условно обязательно	Текущая цена билета/пропуска на мероприятие. Необходимо указать, если указана перечеркнутая цена.	Свободный текст
Цена - Зачеркнутая цена	Необязательный	Первоначальная цена билета/пропуска на мероприятие.	Свободный текст
Указание цены	Необязательный	Укажите цену, чтобы отобразить информацию о промоакции, мероприятии или скидке для участников, если таковая имеется.	Свободный текст Рекомендуемый размер текста: менее 45 символов (слишком длинный текст может содержать многоточие).
Рейтинг - Максимальное значение	Необязательный	Максимальное значение шкалы оценок. Этот параметр необходимо указать, если также предоставлено текущее значение рейтинга.	Число >= 0,0
Рейтинг - Текущая стоимость	Необязательный	Текущее значение рейтинговой шкалы. Этот параметр необходимо указать, если также указано максимальное значение рейтинга.	Число >= 0,0
Рейтинг - Количество	Необязательный	Количество оценок мероприятия. Примечание: Укажите это поле, если ваше приложение хочет контролировать способ отображения этой информации пользователям. Укажите краткую строку, которая может быть показана пользователю. Например, если значение равно 1 000 000, используйте сокращения, такие как 1M, чтобы оно не обрезалось на экранах меньшего размера.	Нить
Рейтинг - Количество значений	Необязательный	Количество оценок мероприятия. Примечание: Укажите это поле, если вы не хотите самостоятельно обрабатывать логику отображения сокращений. Если присутствуют поля «Количество» и «Значение количества», мы будем использовать значение «Количество» для отображения пользователям.	Длинный
Категории контента	Необязательный	Опишите категорию контента в сущности.	Список соответствующих требованиям перечней TYPE_MOVIES_AND_TV_SHOWS (Пример - Кинотеатр) TYPE_DIGITAL_GAMES (Пример - киберспорт) TYPE_MUSIC (Пример - Концерт) TYPE_TRAVEL_AND_LOCAL (Пример - Тур, фестиваль) TYPE_HEALTH_AND_FITENESS (Пример - Занятие йогой) TYPE_EDUCATION (Пример - Класс) TYPE_SPORTS (Пример - Футбольный матч) TYPE_DATING (Пример - встреча) См. раздел «Категории контента» для получения рекомендаций.

`LodgingReservationEntity`

Атрибут	Требование	Описание	Формат
Action Uri	Необходимый	Прямая ссылка на сущность в приложении поставщика. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов.	Ури
Заголовок	Необходимый	Название организации.	Свободный текст. Например: «Ваше пребывание с 12 декабря». Рекомендуемый размер текста: максимум 50 символов.
Время заселения	Необходимый	Временная метка в миллисекундах, представляющая время регистрации бронирования.	Временная метка эпохи в миллисекундах
Время выезда	Необходимый	Временная метка в миллисекундах, представляющая время завершения бронирования.	Временная метка эпохи в миллисекундах
Location - Country	Необходимый	The country in which the lodging is located.	Свободный текст Recommended text size: max ~20 chars
Location - City	Необходимый	The city in which the lodging is located.	Свободный текст Recommended text size: max ~20 chars
Location - Display Address	Необходимый	The address of the lodging that will be displayed to the user.	Свободный текст Recommended text size: max ~20 chars
Location - Street Address	Необязательный	The street address (if applicable) of the lodging.	Свободный текст Recommended text size: max ~20 chars
Location - State	Необязательный	The state or province (if applicable) in which the lodging is located.	Свободный текст Recommended text size: max ~20 chars
Location - Zip code	Необязательный	The zip code (if applicable) of the lodging.	Свободный текст Recommended text size: max ~20 chars
Location - Neighborhood	Необязательный	The neighborhood (if applicable) of the lodging.	Свободный текст Recommended text size: max ~20 chars
Изображения для плакатов	Необязательный	We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9 Note: If a badge is provided, ensure safe space of 24 dps at both the top and bottom of the image	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Описание	Необязательный	A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both.	Свободный текст Recommended text size: 180 chars
Subtitle list	Необязательный	Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both.	Свободный текст Recommended text size for each subtitle: max 50 chars
Reservation ID	Необязательный	The reservation ID for the lodging reservation.	Свободный текст
Rating - Max value	Необязательный	The maximum value of the rating scale. Must be provided if current value of rating is also provided.	Number >= 0.0
Rating - Current value	Необязательный	The current value of the rating scale. Must be provided if maximum value of rating is also provided.	Number >= 0.0
Rating - Count	Необязательный	The count of the ratings for the lodging. Note: Provide this field if your app wants to control how this is displayed to the users. Provide the concise string that can be displayed to the user. For example, if the count is 1,000,000, consider using abbreviations like 1M, so that it won't be truncated on smaller display sizes.	Нить
Rating - Count Value	Необязательный	The count of the ratings for the lodging. Note: Provide this field if you don't want to handle the display abbreviation logic yourself. If both Count and Count Value are present, we will use the Count to display to users	Длинный
Price - CurrentPrice	Условно обязательно	The current price of the lodging. Must be provided if strikethrough price is provided.	Свободный текст
Price - StrikethroughPrice	Необязательный	The original price of the lodging, which is be struck-through in the UI.	Свободный текст
Price Callout	Необязательный	Price callout to feature a promo, event, member discount, if available.	Свободный текст Recommended text size: under 45 chars (Text that is too long may show ellipses)

`TransportationReservationEntity`

Атрибут	Требование	Описание	Формат
Action Uri	Необходимый	Прямая ссылка на сущность в приложении поставщика. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов.	Ури
Заголовок	Необходимый	Title of the entity.	Free text. For example, "SFO to SAN" Recommended text size: Max 50 chars
Transportation Type	Необходимый	The mode/type of transportation for the reservation.	Enum: FLIGHT, TRAIN, BUS, or FERRY
Время отправления	Необходимый	The epoch timestamp in milliseconds that represents the departure time.	Временная метка эпохи в миллисекундах
Время прибытия	Необходимый	The epoch timestamp in milliseconds that represents the arrival time.	Временная метка эпохи в миллисекундах
Departure Location - Country	Необязательный	The country of departure.	Свободный текст Recommended text size: max ~20 chars
Departure Location - City	Необязательный	The city of departure.	Свободный текст Recommended text size: max ~20 chars
Departure Location - Display Address	Необязательный	The location of departure that will be displayed to the user.	Свободный текст Recommended text size: max ~20 chars
Departure Location - Street Address	Необязательный	The street address (if applicable) of the departure location.	Свободный текст Recommended text size: max ~20 chars
Departure Location - State	Необязательный	The state or province (if applicable) of the departure location.	Свободный текст Recommended text size: max ~20 chars
Departure Location - Zip code	Необязательный	The zip code (if applicable) of the departure location.	Свободный текст Recommended text size: max ~20 chars
Departure Location - Neighborhood	Необязательный	The neighborhood (if applicable) of the departure location.	Свободный текст Recommended text size: max ~20 chars
Arrival Location - Country	Необязательный	The country of arrival.	Свободный текст Recommended text size: max ~20 chars
Arrival Location - City	Необязательный	The city of arrival.	Свободный текст Recommended text size: max ~20 chars
Arrival Location - Display Address	Необязательный	The location of arrival that will be displayed to the user.	Свободный текст Recommended text size: max ~20 chars
Arrival Location - Street Address	Необязательный	The street address (if applicable) of the arrival location.	Свободный текст Recommended text size: max ~20 chars
Arrival Location - State	Необязательный	The state or province (if applicable) of the arrival location.	Свободный текст Recommended text size: max ~20 chars
Arrival Location - Zip code	Необязательный	The zip code (if applicable) of the arrival location.	Свободный текст Recommended text size: max ~20 chars
Arrival Location - Neighborhood	Необязательный	The neighborhood (if applicable) of the arrival location.	Свободный текст Recommended text size: max ~20 chars
Service Provider - Name	Необязательный	The name of the service provider. Note: Either text or image is required for the service provider.	Free text. For example, Airline name
Service Provider - Image	Необязательный	The logo/image of the service provider. Note: Either text or image is required for the service provider.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Изображения для плакатов	Необязательный	We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Описание	Необязательный	A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both.	Свободный текст Recommended text size: 180 chars
Subtitle list	Необязательный	Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both.	Свободный текст Recommended text size for each subtitle: max 50 chars
Reservation ID	Необязательный	The reservation ID for the transportation reservation.	Свободный текст
Price - CurrentPrice	Условно обязательно	The current price of the reservation. Must be provided if strikethrough price is provided.	Свободный текст
Price - StrikethroughPrice	Необязательный	The original price of the reservation, which is be struck-through in the UI.	Свободный текст
Price Callout	Необязательный	Price callout to feature a promo, event, member discount, if available.	Свободный текст Recommended text size: under 45 chars (Text that is too long may show ellipses)
Transportation Number	Необходимый	The flight number, bus number, train number, or ferry/cruise number.	Свободный текст
Время посадки	Необходимый	The epoch timestamp that represents the boarding time for the reservation (if applicable)	Временная метка эпохи в миллисекундах

`VehicleRentalReservationEntity`

Атрибут	Требование	Описание	Формат
Action Uri	Необходимый	Прямая ссылка на сущность в приложении поставщика. Примечание: Для указания источника можно использовать прямые ссылки. См. этот раздел часто задаваемых вопросов.	Ури
Заголовок	Необходимый	Title of the entity.	Free text. For example, "Avis Union Square SF" Recommended text size: Max 50 chars
Время получения заказа	Необходимый	The epoch timestamp that represents the pick up time for the reservation.	Временная метка эпохи в миллисекундах
Время возврата	Необязательный	The epoch timestamp that represents the check out time for the reservation.	Временная метка эпохи в миллисекундах
Pickup Address - Country	Необязательный	The country of the pickup location.	Свободный текст Recommended text size: max ~20 chars
Pickup Address - City	Необязательный	The city of the pickup location.	Свободный текст Recommended text size: max ~20 chars
Pickup Address - Display Address	Необязательный	The pickup location that will be displayed to the user.	Свободный текст Recommended text size: max ~20 chars
Pickup Address - Street Address	Необязательный	The street address (if applicable) of the pickup location.	Свободный текст Recommended text size: max ~20 chars
Pickup Address - State	Необязательный	The state or province (if applicable) of the pickup location.	Свободный текст Recommended text size: max ~20 chars
Pickup Address - Zip code	Необязательный	The zip code (if applicable) of the pickup location.	Свободный текст Recommended text size: max ~20 chars
Pickup Address - Neighborhood	Необязательный	The neighborhood (if applicable) of the pickup location.	Свободный текст Recommended text size: max ~20 chars
Return Address - Country	Необязательный	The country of return location.	Свободный текст Recommended text size: max ~20 chars
Return Address - City	Необязательный	The city of return location.	Свободный текст Recommended text size: max ~20 chars
Return Address - Display Address	Необязательный	The return location that will be displayed to the user.	Свободный текст Recommended text size: max ~20 chars
Return Address - Street Address	Необязательный	The street address (if applicable) of the return location.	Свободный текст Recommended text size: max ~20 chars
Return Address - State	Необязательный	The state or province (if applicable) of the return location.	Свободный текст Recommended text size: max ~20 chars
Return Address - Zip code	Необязательный	The zip code (if applicable) of the return location.	Свободный текст Recommended text size: max ~20 chars
Return Address - Neighborhood	Необязательный	The neighborhood (if applicable) of the return location.	Свободный текст Recommended text size: max ~20 chars
Service Provider - Name	Необязательный	The name of the service provider. Note: Either text or image is required for the service provider.	Free text. For example, "Avis Car Rental"
Service Provider - Image	Необязательный	The logo/image of the service provider. Note: Either text or image is required for the service provider.	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Изображения для плакатов	Необязательный	We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9	См. раздел «Технические характеристики изображения» для получения дополнительной информации.
Описание	Необязательный	A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size: 180 chars
Subtitle list	Необязательный	Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size for each subtitle: max 50 chars
Confirmation ID	Необязательный	The confirmation ID for the vehicle rental reservation.	Free text
Price - CurrentPrice	Условно обязательно	The current price of the reservation. Must be provided if strikethrough price is provided.	Free text
Price - StrikethroughPrice	Необязательный	The original price of the reservation, which is be struck-through in the UI.	Free text
Price Callout	Необязательный	Price callout to feature a promo, event, member discount, if available.	Free text Recommended text size: under 45 chars (Text that is too long may show ellipses)

Технические характеристики изображения

Required specifications for image assets are listed in this table:

Соотношение сторон	Минимальное количество пикселей	Рекомендуемые пиксели
Квадрат (1х1) Предпочтительный	300x300	1200x1200
Пейзаж (1,91х1)	600x314	1200x628
Портрет (4x5)	480x600	960x1200

Соотношение сторон

Минимальное количество пикселей

Рекомендуемые пиксели

Квадрат (1х1)

Предпочтительный

300x300

1200x1200

Пейзаж (1,91х1)

600x314

1200x628

Портрет (4x5)

480x600

960x1200

Изображения необходимо размещать на общедоступных CDN-сетях, чтобы Google мог получить к ним доступ.

Форматы файлов

PNG, JPG, статический GIF, WebP

Максимальный размер файла

5120 КБ

Дополнительные рекомендации

Безопасная зона изображения: разместите важный контент в центральных 80% изображения.
Используйте прозрачный фон, чтобы изображение корректно отображалось в темной и светлой темах оформления.

Content Category

The content category allows apps to publish content belonging to multiple categories. This maps the content with some of the predefined categories namely:

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 мог получить к ним доступ.

Guidelines to use the content categories

Some entities like ArticleEntity and GenericFeaturedEntity are eligible to use any of the content categories. For other entities like EventEntity , EventReservationEntity , PointOfInterestEntity , only a subset of these categories are eligible. Check the list of categories eligible for an entity type before populating the list.
Use the specific entity type for some content categories over a combination of the Generic entities and the ContentCategory:
- TYPE_MOVIES_AND_TV_SHOWS - Check out the entities from Watch integration guide before using the generic entities.
- TYPE_BOOKS - Check out the EbookEntity before using the generic entities.
- TYPE_AUDIOBOOKS - Check out AudiobookEntity before using the generic entities.
- TYPE_SHOPPING - Check out ShoppingEntity before using the generic entities.
- TYPE_FOOD_AND_DRINK - Check out entities from Food Integration guide before using the generic entities.
The ContentCategory field is optional and should be left blank if the content doesn't belong to any of the categories mentioned earlier.
In case multiple content categories are provided, provide them in the order of relevance to the content with the most relevant content category placed first in the list.

Шаг 2: Предоставьте данные кластера.

It is recommended to have the content publish job executed in the background (for example, using WorkManager ) and scheduled on a regular basis or on an event basis (for example, every time the user opens the app or when the user just added something to their cart).

AppEngagePublishClient is responsible for publishing clusters.

Для публикации кластеров на стороне клиента доступны следующие API:

isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishContinuationCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteContinuationCluster
deleteUserManagementCluster
deleteClusters

`isServiceAvailable`

Этот API используется для проверки доступности сервиса для интеграции и возможности отображения контента на устройстве.

Для Engage SDK версии 1.6.0 и выше (рекомендуется)

Вы можете проверить доступность сервиса для каждого типа кластера, который планируете опубликовать. API isServiceAvailable принимает объект запроса ServiceAvailabilityRequest , который содержит типы кластеров, для которых необходимо проверить доступность сервиса. Значения перечисления ClusterType необходимые для ServiceAvailabilityRequest можно найти в следующей таблице.

Тип кластера	Тип кластера — константа	Целочисленное значение
Неизвестный	`TYPE_UNKNOWN`	0
Кластер рекомендаций	`TYPE_RECOMMENDATION`	1
Выделенный кластер	`TYPE_FEATURED`	2
Кластер продолжения	`TYPE_CONTINUATION`	3
Shopping Cart Cluster	`TYPE_SHOPPING_CART`	4
Food Reorder Cluster	`TYPE_FOOD_REORDER`	5
Food Shopping Cart Cluster	`TYPE_FOOD_SHOPPING_CART`	6
Food Shopping List Cluster	`TYPE_FOOD_SHOPPING_LIST`	7
Кластер управления пользователями	`TYPE_ENGAGEMENT`	8
Shopping List Cluster	`TYPE_SHOPPING_LIST`	9
Shopping Reorder Cluster	`TYPE_SHOPPING_REORDER`	10
Shopping Order Tracking Cluster	`TYPE_SHOPPING_ORDER_TRACKING`	11
Кластер подписок	`TYPE_SUBSCRIPTION`	12
Continue Search Cluster	`TYPE_CONTINUE_SEARCH`	13
Reservation Cluster	`TYPE_RESERVATION`	14

Котлин

val request = ServiceAvailabilityRequest.Builder()
    .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
    .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
    .build()

client.isServiceAvailable(request).addOnCompleteListener { task ->
    if (task.isSuccessful) {
        val availabilityMap = task.result
        if (availabilityMap[ClusterType.TYPE_CONTINUATION] == true) {
            // Proceed with publishing continuation content
        }
        if (availabilityMap[ClusterType.TYPE_RECOMMENDATION] == true) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
}

Java

ServiceAvailabilityRequest request =
    new ServiceAvailabilityRequest.Builder()
        .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
        .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
        .build();

client.isServiceAvailable(request).addOnCompleteListener(task -> {
    if (task.isSuccessful()) {
        Map<Integer, Boolean> availabilityMap = task.getResult();
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
            // Proceed with publishing continuation content
        }
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
});

Функция условной доступности сервиса

Некоторые интегрированные приложения запрашивают специальную конфигурацию, которая периодически включает и отключает сервис Engage для снижения затрат на его обслуживание. Такая стратегия периодической загрузки контента, хотя и возможна, негативно влияет на пользователя и продукт — устаревший контент не будет отображаться, а некоторые разделы вообще не будут доступны.

Начиная с версии 1.6.0, Engage SDK позволяет проверять доступность для определенных типов кластеров. Это обеспечивает большую гибкость: если в данном приложении используется стратегия периодического контента, некоторые типы кластеров могут следовать этой стратегии, в то время как другие типы кластеров остаются постоянно включенными (т.е. кластеры непрерывного действия).

If the Engage service should not be 'continuously' enabled on all supported devices for whatever reason, and is configured for intermittent ingestion for any set of devices, all continuation cluster publications (eg Continue Reading and Reservations) will be still enabled by default configuration, and the rest of the cluster types will be enabled and disabled intermittently. If intermittent ingestion applies to you but this default configuration is not suitable for your needs, please contact engage-developers@google.com.

Для версий SDK до v1.6.0 (устарело)

Котлин

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 .

Котлин

client.publishRecommendationClusters(
      PublishRecommendationClustersRequest.Builder()
        .addRecommendationCluster(
          RecommendationCluster.Builder()
            .addEntity(entity1)
            .addEntity(entity2)
            .setTitle("Top Picks For You")
            .build()
        )
        .build()
    )

Java

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())

Java

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())

Java

client.publishContinuationCluster(
            new PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    new ContinuationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

После получения запроса сервисом в рамках одной транзакции выполняются следующие действия:

Существующие данные ContinuationCluster от партнера-разработчика удаляются.
Данные из запроса анализируются и сохраняются в обновленном кластере продолжения работы.

В случае ошибки весь запрос отклоняется, и сохраняется текущее состояние.

`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();

Когда сервис получает запрос, он удаляет существующие данные из кластера избранных данных. В случае ошибки весь запрос отклоняется, и сохраняется существующее состояние.

`deleteContinuationCluster`

Этот API используется для удаления содержимого кластера продолжения.

Котлин

client.deleteContinuationCluster()

Java

client.deleteContinuationCluster();

Когда служба получает запрос, она удаляет существующие данные из кластера продолжения. В случае ошибки весь запрос отклоняется, и сохраняется текущее состояние.

`deleteUserManagementCluster`

Этот API используется для удаления содержимого кластера UserAccountManagement.

Котлин

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

Когда служба получает запрос, она удаляет существующие данные из кластера UserAccountManagement. В случае ошибки весь запрос отклоняется, и сохраняется существующее состояние.

`deleteClusters`

Этот API используется для удаления содержимого кластера определенного типа.

Котлин

client.deleteClusters(
    DeleteClustersRequest.Builder()
      .addClusterType(ClusterType.TYPE_CONTINUATION)
      .addClusterType(ClusterType.TYPE_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      .build())

Java

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
            }
          }
        }
      }

Java

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),
                           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 Continuation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION),
                           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 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),
                         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 Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION),
                         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.PUBLISH_CONTINUATION" />
      </intent-filter>
   </receiver>
</application>

The following intents is sent by the service:

com.google.android.engage.action.PUBLISH_RECOMMENDATION Рекомендуется инициировать вызов publishRecommendationClusters при получении этого намерения.
com.google.android.engage.action.PUBLISH_FEATURED Рекомендуется инициировать вызов publishFeaturedCluster при получении этого намерения.
com.google.android.engage.action.PUBLISH_CONTINUATION It is recommended to start a publishContinuationCluster call when receiving this intent.

Рабочий процесс интеграции

Пошаговое руководство по проверке интеграции после ее завершения см. в разделе «Рабочий процесс интеграции для разработчиков Engage» .

Часто задаваемые вопросы

Часто задаваемые вопросы по Engage SDK можно найти в разделе "Часто задаваемые вопросы".

Контакт

Contact engage-developers@google.com if there are any questions during the integration process.

Следующие шаги

После завершения интеграции ваши дальнейшие действия будут следующими:

Отправьте электронное письмо на адрес engage-developers@google.com и прикрепите к нему свой интегрированный APK-файл, готовый к тестированию компанией Google.
Google проводит внутреннюю проверку и анализ, чтобы убедиться, что интеграция работает должным образом. Если потребуются изменения, Google свяжется с вами и предоставит всю необходимую информацию.
После завершения тестирования и если никаких изменений не потребуется, Google свяжется с вами, чтобы уведомить о возможности публикации обновленного и интегрированного APK-файла в Play Store.
After Google has confirmed that your updated APK has been published to the Play Store, your Recommendation , Featured , and Continuation clusters may be published and visible to users.