Engage SDK для других вертикалей: инструкции по интеграции сторонних сервисов

Повышайте вовлеченность пользователей, обращаясь к ним там, где они находятся. Интегрируйте Engage SDK, чтобы показывать персональные рекомендации и контент, который пользователи не досмотрели, на разных платформах на устройстве, например в подборках, Entertainment Space и Google Play. Интеграция добавляет менее 50 КБ (в сжатом виде) к среднему размеру APK и занимает у разработчиков около недели. Подробную информацию вы найдете на нашем сайте.

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

Сведения об интеграции

В этом разделе подробно описаны шаги, модели данных и терминология, необходимые для интеграции с Engage SDK для других категорий контента.

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

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

  • Рекомендации – персонализированные предложения от одного партнера-разработчика. Это представление интерфейса, которое содержит группу рекомендаций от одного разработчика-партнера.

    • ArticleEntity. Текстовая рекомендация контента, который относится к нескольким категориям. Элемент ArticleEntity позволяет разработчикам предоставлять разнообразный текстовый и графический контент с большим количеством метаданных, чтобы лучше доносить информацию до пользователей по сравнению с GenericFeaturedEntity. Пример: маркетинговый контент, фрагмент новости.

      Рисунок 1. Интерфейс с одним объектом ArticleEntity в кластере рекомендаций.
    • EventEntity – объект, представляющий событие, которое произойдет в будущем. Время начала мероприятия – это важная информация, которую необходимо сообщить пользователям.

      Рисунок 2. Интерфейс с одним объектом EventEntity в кластере рекомендаций.
    • LodgingEntity – объект размещения, например отель, апартаменты или дом для отпуска, который сдается в краткосрочную или долгосрочную аренду.

      Рисунок 3. Интерфейс, показывающий один объект LodgingEntity в кластере рекомендаций.
    • StoreEntity. Представляет магазин, ресторан, кафе и т. д. Выделяет контент, в котором магазин или заведение общественного питания является важной информацией, которую необходимо донести до пользователей.

      Рисунок 4. Интерфейс с одним объектом StoreEntity в кластере рекомендаций.
    • PointOfInterestEntity. Представляет достопримечательность, например заправку, место проведения мероприятия, тематический парк, музей, туристическую достопримечательность, пешеходную тропу и т. д. Выделяет контент, в котором местоположение является важной информацией, которую необходимо донести до пользователей. Его нельзя использовать для проживания, магазина или ресторана.

      Рисунок 5. Интерфейс с одним объектом PointOfInterestEntity в кластере рекомендаций.
    • PersonEntity – представляет человека. Рекомендации могут заключаться в том, чтобы выделить человека в таких категориях, как здоровье и фитнес, спорт, знакомства и т. д.

      Рисунок 5. Интерфейс с одним объектом PersonEntity в кластере рекомендаций.
  • В кластере Продолжение показывается контент, с которым недавно взаимодействовали пользователи, от нескольких партнеров-разработчиков в одной группе интерфейса. Каждый партнер-разработчик может транслировать в кластере продолжения не более 10 объектов.

    Продолжение может иметь следующую структуру:

    • ArticleEntity. Текстовая рекомендация контента, который относится к нескольким категориям. Этот объект может представлять недочитанные новостные статьи или другой контент, к которому пользователь хотел бы вернуться. Пример: маркетинговый контент, фрагмент новости.

      Рисунок 6. Интерфейс, в котором показан один объект ArticleEntity в кластере Continuation.
    • RestaurantReservationEntity представляет бронирование в ресторане или кафе и помогает пользователям отслеживать предстоящие или текущие бронирования.

      Рисунок 7. Интерфейс, в котором показан один объект RestaurantReservationEntity в кластере продолжения.
    • EventReservationEntity – бронирование мероприятия. Помогает пользователям отслеживать предстоящие или текущие бронирования. К таким событиям относятся, помимо прочего, следующие:

      • спортивные мероприятия, например бронирование билетов на футбольный матч;
      • Игровые мероприятия, например бронирование мест на киберспортивных соревнованиях.
      • Развлекательные мероприятия, например бронирование билетов в кино, на концерт, в театр или на встречу с писателем.
      • Бронирование путешествий или посещения достопримечательностей, например экскурсий или билетов в музей.
      • Бронирование мест на семинарах, конференциях и других мероприятиях
      • Образование/Бронирование занятий
      Рисунок 8. Интерфейс, в котором показан один объект EventReservationEntity в кластере продолжения.
    • LodgingReservationEntity – бронирование жилья для путешествий. Помогает пользователям отслеживать предстоящие или текущие бронирования отелей или жилья для отпуска.

      Рисунок 9. Интерфейс с одним объектом LodgingReservationEntity в кластере продолжения.
    • TransportationReservationEntity – объект, который представляет бронирование билетов на любой вид транспорта и помогает пользователям отслеживать предстоящие или текущие поездки на самолете, пароме, поезде, автобусе, круизном лайнере или автомобиле.

      Рисунок 10. Интерфейс с одним объектом TransportationReservationEntity в кластере Continuation.
    • VehicleRentalReservationEntity представляет бронирование автомобиля напрокат и помогает пользователям отслеживать предстоящие или текущие бронирования.

      Рисунок 11. Интерфейс с одним объектом VehicleRentalReservationEntity в кластере продолжения.
  • Кластер Рекомендуемые – это раздел интерфейса, в котором собраны выбранные герои из игр разных разработчиков. 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 определены разные объекты, представляющие каждый тип товара. Для категории "Другое" поддерживаются следующие объекты:

  1. GenericFeaturedEntity
  2. ArticleEntity
  3. EventEntity
  4. LodgingEntity
  5. StoreEntity
  6. PointOfInterestEntity
  7. PersonEntity
  8. RestaurantReservationEntity
  9. EventReservationEntity
  10. LodgingReservationEntity
  11. TransportationReservationEntity
  12. VehicleRentalReservationEntity

В таблицах ниже перечислены доступные атрибуты и требования для каждого типа.

GenericFeaturedEntity

Атрибут Требования Описание Формат
URI действия Обязательно

Ссылка на контент в приложении поставщика.

Примечание. Ссылки на контент можно использовать для атрибуции. Ознакомьтесь с разделом часто задаваемых вопросов

URI
Постеры Обязательно

Если вы добавите несколько изображений, мы покажем только одно из них. Рекомендуемое соотношение сторон – 16:9.

Примечание. Если вы используете значок, оставьте свободное пространство размером 24 dp в верхней и нижней частях изображения.

Ознакомьтесь со спецификациями изображений.
Название Необязательно Название объекта.

Произвольный текст

Рекомендуемый размер текста: 50 символов.

Описание Необязательно

Один абзац текста с описанием объекта.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста: 180 символов.

Список субтитров Необязательно

До трех подзаголовков, каждый из которых состоит из одной строки текста.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста для каждой строки субтитров: не более 50 символов.

Значки Необязательно

Каждый значок может содержать текст (не более 15 символов) или небольшое изображение.

Специальное оформление UX поверх изображения или видео, например значок, наложенный на изображение.

  • "Новости в реальном времени"
  • Продолжительность чтения статьи
Текстовый значок Необязательно

Название значка

Примечание. Для значка требуется текст или изображение.

Произвольный текст

Рекомендуемый размер текста: не более 15 символов.

Значок – изображение Необязательно

Маленькое изображение

Специальное оформление UX, например значок поверх миниатюры изображения или видео.

Примечание. Для значка требуется текст или изображение.

Ознакомьтесь со спецификациями изображений.
Категории контента Необязательно Опишите категорию контента в объекте.

Список перечислений

Подробные инструкции вы найдете в разделе Категория контента.

ArticleEntity

Атрибут Требования Описание Формат
URI действия Обязательно

Ссылка на контент в приложении поставщика.

Примечание. Ссылки на контент можно использовать для атрибуции. Ознакомьтесь с разделом часто задаваемых вопросов

URI
Название Обязательно Название объекта.

Произвольный текст

Рекомендуемый размер текста: не более 50 символов.

Постеры Необязательно

Если вы добавите несколько изображений, мы покажем только одно из них. Рекомендуемое соотношение сторон – 16:9.

Примечание. Настоятельно рекомендуется добавить изображение. Если вы используете значок, оставьте свободное пространство в 24 dp сверху и снизу изображения.

Ознакомьтесь со спецификациями изображений.
Источник – название Необязательно Имя автора, название организации или имя репортера.

Произвольный текст

Рекомендуемый размер текста: менее 25 символов.

Источник – изображение Необязательно Изображение источника, например автора, организации или репортера. Ознакомьтесь со спецификациями изображений.
Описание Необязательно

Один абзац текста с описанием объекта.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста: 180 символов.

Список субтитров Необязательно

До трех подзаголовков, каждый из которых состоит из одной строки текста.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста для каждой строки субтитров: не более 50 символов.

Значки Необязательно

Каждый значок может содержать текст (не более 15 символов) или небольшое изображение.

Особое оформление UX поверх изображения или видео, например значок, наложенный на изображение.

  • "Новости в реальном времени"
  • Продолжительность чтения статьи
Текстовый значок Необязательно

Название значка

Примечание. Для значка требуется текст или изображение.

Произвольный текст

Рекомендуемый размер текста: не более 15 символов.

Значок – изображение Необязательно

Маленькое изображение

Специальное оформление UX, например значок поверх миниатюры изображения или видео.

Примечание. Для значка требуется текст или изображение.

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

Временная метка в миллисекундах, когда пользователь в последний раз взаимодействовал с этим объектом.

Примечание. Это поле является обязательным, если объект входит в кластер продолжения.

Временная метка в миллисекундах с начала отсчета
Процент выполнения Условно обязательно

Процент контента, который пользователь уже посмотрел.

Примечание. Это поле является обязательным, если объект входит в кластер продолжения.

Целое число от 0 до 100 включительно.
Категории контента Необязательно Опишите категорию контента в объекте.

Список перечислений

Подробные инструкции вы найдете в разделе Категория контента.

EventEntity

Атрибут Требования Описание Формат
URI действия Обязательно

Ссылка на контент в приложении поставщика.

Примечание. Ссылки на контент можно использовать для атрибуции. Ознакомьтесь с разделом часто задаваемых вопросов

URI
Название Обязательно Название объекта.

Строка

Рекомендуемый размер текста: не более 50 символов.

Время начала Обязательно

Временная метка эпохи, когда должно начаться событие.

Примечание. Значение указывается в миллисекундах.

Временная метка в миллисекундах с начала отсчета
Режим событий Обязательно

Поле, в котором указывается, как будет проходить мероприятие: онлайн, офлайн или в смешанном формате.

Перечисление: VIRTUAL, IN_PERSON или HYBRID.
Постеры Обязательно

Если вы добавите несколько изображений, мы покажем только одно из них. Рекомендуемое соотношение сторон – 16:9.

Примечание. Настоятельно рекомендуется добавить изображение. Если вы используете значок, оставьте свободное пространство в 24 dp сверху и снизу изображения.

Ознакомьтесь со спецификациями изображений.
Местоположение – страна Условно обязательно

Страна, в которой проводится мероприятие.

Примечание. Это поле обязательно для событий с типом IN_PERSON или HYBRID.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – город Условно обязательно

Город, в котором проходит мероприятие.

Примечание. Это поле обязательно для событий с типом IN_PERSON или HYBRID.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – отображаемый адрес Условно обязательно

Адрес или название места проведения мероприятия, которое должно быть показано пользователю.

Примечание. Это поле обязательно для событий с типом IN_PERSON или HYBRID.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – почтовый адрес Необязательно Почтовый адрес (если применимо) места проведения мероприятия.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – штат Необязательно Штат или область, где проводится мероприятие (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – почтовый индекс Необязательно Почтовый индекс места проведения мероприятия (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – микрорайон Необязательно Район, в котором проводится мероприятие (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Время окончания Необязательно

Временная метка эпохи, когда событие должно закончиться.

Примечание. Значение указывается в миллисекундах.

Временная метка в миллисекундах с начала отсчета
Описание Необязательно

Один абзац текста с описанием объекта.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста: 180 символов.

Список субтитров Необязательно

До трех подзаголовков, каждый из которых состоит из одной строки текста.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста для каждой строки субтитров: не более 50 символов.

Значки Необязательно

Каждый значок может содержать текст (не более 15 символов) или небольшое изображение.

Текстовый значок Необязательно

Название значка

Примечание. Для значка требуется текст или изображение.

Произвольный текст

Рекомендуемый размер текста: не более 15 символов.

Значок – изображение Необязательно

Маленькое изображение

Специальное оформление UX, например значок поверх миниатюры изображения или видео.

Примечание. Для значка требуется текст или изображение.

Ознакомьтесь со спецификациями изображений.
Price – CurrentPrice Условно обязательно

Текущая цена билета или пропуска на мероприятие.

Обязателен, если указана зачеркнутая цена.

Произвольный текст
Price – StrikethroughPrice Необязательно Первоначальная цена билета или пропуска на мероприятие. Произвольный текст
Уточнение цены Необязательно Уточнение с ценой, чтобы выделить промоакцию, событие или скидку для участников, если они доступны.

Произвольный текст

Рекомендуемая длина текста – до 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 (например, meetup)

Подробные инструкции вы найдете в разделе Категория контента.

LodgingEntity

Атрибут Требования Описание Формат
URI действия Обязательно

Ссылка на контент в приложении поставщика.

Примечание. Ссылки на контент можно использовать для атрибуции. Ознакомьтесь с разделом часто задаваемых вопросов

URI
Название Обязательно Название объекта.

Строка

Рекомендуемый размер текста: не более 50 символов.

Постеры Обязательно

Если вы добавите несколько изображений, мы покажем только одно из них. Рекомендуемое соотношение сторон – 16:9.

Примечание. Если вы используете значок, оставьте свободное пространство в 24 dp в верхней и нижней частях изображения.

Ознакомьтесь со спецификациями изображений.
Местоположение – страна Обязательно Страна, в которой находится жилье.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – город Обязательно Город, в котором находится гостиница.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – отображаемый адрес Обязательно Адрес места проживания, который будет показываться пользователю.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – почтовый адрес Необязательно Почтовый адрес места размещения (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – штат Необязательно Штат или провинция (если применимо), в котором находится гостиница.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – почтовый индекс Необязательно Почтовый индекс места размещения (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – микрорайон Необязательно Район, в котором находится гостиница (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Значки Необязательно

Каждый значок может содержать текст (не более 15 символов) или небольшое изображение.

Текстовый значок Необязательно

Название значка

Примечание. Для значка требуется текст или изображение.

Произвольный текст

Рекомендуемый размер текста: не более 15 символов.

Значок – изображение Необязательно

Маленькое изображение

Специальное оформление UX, например значок поверх миниатюры изображения или видео.

Примечание. Для значка требуется текст или изображение.

Ознакомьтесь со спецификациями изображений.
Описание Необязательно

Один абзац текста с описанием объекта.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста: 180 символов.

Список субтитров Необязательно

До трех подзаголовков, каждый из которых состоит из одной строки текста.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста для каждой строки субтитров: не более 50 символов.

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

Максимальное значение оценочной шкалы.

Обязательно, если указано текущее значение оценки.

Число >= 0,0
Оценка – текущее значение Необязательно

Текущее значение оценочной шкалы.

Обязательно, если указано максимальное значение оценки.

Число >= 0,0
Оценка – количество Необязательно

Количество оценок места размещения.

Примечание. Укажите это поле, если ваше приложение управляет тем, как количество показывается пользователям. Используйте краткую строку. Например, если количество равно 1 000 000, используйте сокращение "1 млн", чтобы число не усекалось на экранах меньшего размера.

Строка
Рейтинг – количество оценок Необязательно

Количество оценок места размещения.

Примечание. Заполните это поле, если вы не используете собственную логику сокращения. Если указаны оба значения, пользователям будет показываться Count.

Долгота
Price – CurrentPrice Условно обязательно

Текущая цена проживания.

Обязателен, если указана зачеркнутая цена.

Произвольный текст
Price – StrikethroughPrice Необязательно Исходная цена за проживание, которая будет зачеркнута в интерфейсе. Произвольный текст
Уточнение цены Необязательно Уточнение с ценой, чтобы выделить промоакцию, событие или скидку для участников, если они доступны.

Произвольный текст

Рекомендуемая длина текста – до 45 символов. Если текст слишком длинный, он может быть сокращен.

StoreEntity

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

Атрибут Требования Описание Формат
Постеры Обязательно Добавьте хотя бы одно изображение. Ознакомьтесь со спецификациями изображений.
URI действия Обязательно

Ссылка на контент в приложении поставщика.

Примечание. Ссылки на контент можно использовать для атрибуции. Ознакомьтесь с разделом часто задаваемых вопросов

URI
Название Необязательно Название магазина.

Произвольный текст

Рекомендуемая длина текста: не более 45 символов. Если текст слишком длинный, он может быть сокращен.

Местоположение Необязательно Местоположение магазина.

Произвольный текст

Рекомендуемая длина текста: не более 45 символов. Если текст слишком длинный, он может быть сокращен.

Уточнение Необязательно Уточнение, в котором рассказывается о промоакции, событии или обновлении в магазине (если есть).

Произвольный текст

Рекомендуемая длина текста: не более 45 символов. Если текст слишком длинный, он может быть сокращен.

Текст мелким шрифтом в выноске Необязательно Текст мелким шрифтом для уточнения.

Произвольный текст

Рекомендуемая длина текста: не более 45 символов. Если текст слишком длинный, он может быть сокращен.

Описание Необязательно Описание магазина.

Произвольный текст

Рекомендуемый размер текста: менее 90 символов (слишком длинный текст может быть сокращен).

Оценка – максимальное значение Необязательно

Максимальное значение оценочной шкалы.

Обязательно, если указано текущее значение оценки.

Число >= 0,0
Оценка – текущее значение Необязательно

Текущее значение оценочной шкалы.

Обязательно, если указано максимальное значение оценки.

Число >= 0,0
Оценка – количество Необязательно

Количество оценок места размещения.

Примечание. Заполните это поле, если хотите управлять тем, как информация показывается пользователям. Укажите краткую строку, которая может быть показана пользователю. Например, если количество равно 1 000 000, используйте сокращение "1 млн", чтобы оно не усекалось на экранах меньшего размера.

Строка
Рейтинг – количество оценок Необязательно

Количество оценок места размещения.

Примечание. Заполните это поле, если не хотите самостоятельно настраивать логику сокращения. Если указаны оба значения, пользователям будет показываться Count.

Долгота

PointOfInterestEntity

Атрибут Требования Описание Формат
URI действия Обязательно

Ссылка на контент в приложении поставщика.

Примечание. Ссылки на контент можно использовать для атрибуции. Ознакомьтесь с разделом часто задаваемых вопросов

URI
Название Обязательно Название объекта.

Строка

Рекомендуемый размер текста: не более 50 символов.

Постеры Обязательно

Если вы добавите несколько изображений, мы покажем только одно из них. Рекомендуемое соотношение сторон – 16:9.

Примечание. Настоятельно рекомендуется добавить изображение. Если вы используете значок, оставьте свободное пространство в 24 dp сверху и снизу изображения.

Ознакомьтесь со спецификациями изображений.
Местоположение – страна Обязательно Страна, в которой находится объект инфраструктуры.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – город Обязательно Город, в котором находится объект инфраструктуры.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – отображаемый адрес Обязательно Адрес объекта инфраструктуры, который будет показан пользователю.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – почтовый адрес Необязательно Почтовый адрес объекта инфраструктуры (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – штат Необязательно Область или регион (если применимо), в котором находится объект.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – почтовый индекс Необязательно Почтовый индекс объекта инфраструктуры (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – микрорайон Необязательно Район, в котором находится объект инфраструктуры (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

AvailabilityTimeWindow – время начала Необязательно Временная метка в миллисекундах, когда объект инфраструктуры должен быть открыт или доступен. Временная метка в миллисекундах с начала отсчета
AvailabilityTimeWindow – время окончания Необязательно Временная метка в миллисекундах, указывающая, до какого момента объект будет открыт или доступен. Временная метка в миллисекундах с начала отсчета
Значки Необязательно

Каждый значок может содержать текст (не более 15 символов) или небольшое изображение.

Текстовый значок Необязательно

Название значка

Примечание. Для значка требуется текст или изображение.

Произвольный текст

Рекомендуемый размер текста: не более 15 символов.

Значок – изображение Необязательно

Маленькое изображение

Специальное оформление UX, например значок поверх миниатюры изображения или видео.

Примечание. Для значка требуется текст или изображение.

Ознакомьтесь со спецификациями изображений.
Описание Необязательно

Один абзац текста с описанием объекта.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста: 180 символов.

Список субтитров Необязательно

До трех подзаголовков, каждый из которых состоит из одной строки текста.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста для каждой строки субтитров: не более 50 символов.

Оценка – максимальное значение Необязательно

Максимальное значение оценочной шкалы.

Обязательно, если указано текущее значение оценки.

Число >= 0,0
Оценка – текущее значение Необязательно

Текущее значение оценочной шкалы.

Обязательно, если указано максимальное значение оценки.

Число >= 0,0
Оценка – количество Необязательно

Количество оценок объекта инфраструктуры.

Примечание. Укажите это поле, если ваше приложение управляет тем, как количество показывается пользователям. Используйте краткую строку. Например, если количество равно 1 000 000, используйте сокращение "1 млн", чтобы число не усекалось на экранах меньшего размера.

Строка
Рейтинг – количество оценок Необязательно

Количество оценок объекта инфраструктуры.

Примечание. Заполните это поле, если вы не используете собственную логику сокращения. Если указаны оба значения, пользователям показывается Count.

Долгота
Price – CurrentPrice Условно обязательно

Текущая цена билетов или абонементов для посещения объекта инфраструктуры.

Обязателен, если указана зачеркнутая цена.

Произвольный текст
Price – StrikethroughPrice Необязательно Исходная цена билетов или входных билетов для объекта инфраструктуры. Произвольный текст
Уточнение цены Необязательно Уточнение с ценой, чтобы выделить промоакцию, событие или скидку для участников, если они доступны.

Произвольный текст

Рекомендуемая длина текста: до 45 символов (слишком длинный текст может быть сокращен и дополнен многоточием).

Категории контента Необязательно Опишите категорию контента в объекте.

Список допустимых перечислений

  • TYPE_TRAVEL_AND_LOCAL
  • TYPE_MOVIES_AND_TV_SHOWS (пример: кинотеатр)
  • TYPE_MEDICAL (например, больница)
  • TYPE_EDUCATION (например, школа)
  • TYPE_SPORTS (например, стадион)

Подробные инструкции вы найдете в разделе Категория контента.

PersonEntity

Атрибут Требования Описание Формат
URI действия Обязательно

Ссылка на контент в приложении поставщика.

Примечание. Ссылки на контент можно использовать для атрибуции. Ознакомьтесь с разделом часто задаваемых вопросов

URI
Название профиля Обязательно Имя, идентификатор или псевдоним профиля, например "Иван Иванов", "@TeamPixel" и т. д.

Строка

Рекомендуемый размер текста: не более 50 символов.

Профиль – аватар Обязательно

Фото профиля или аватар пользователя.

Примечание. Изображение должно быть квадратным (1:1).

Ознакомьтесь со спецификациями изображений.
Профиль – дополнительный текст Необязательно Произвольный текст, например псевдоним профиля.

Произвольный текст

Рекомендуемый размер текста: не более 15 символов.

Профиль – дополнительное изображение Необязательно Небольшое изображение, например значок подтверждения. Ознакомьтесь со спецификациями изображений.
Обложка Необязательно

Если вы добавите несколько изображений, мы покажем только одно из них. Рекомендуемое соотношение сторон – 16:9.

Примечание. Настоятельно рекомендуется добавить изображение. Если вы используете значок, оставьте свободное пространство в 24 dp сверху и снизу изображения.

Ознакомьтесь со спецификациями изображений.
Популярность – количество Необязательно

Укажите количество подписчиков или значение популярности, например "3,7 млн".

Примечание. Если указаны оба параметра, будет использоваться Count.

Строка

Рекомендуемый размер текста: не более 20 символов для количества и ярлыка вместе.

Популярность – значение количества Необязательно

Количество подписчиков или показатель популярности.

Примечание. Укажите значение Count Value, если вы не хотите, чтобы приложение обрабатывало логику оптимизации больших чисел для разных размеров экрана. Если указаны оба значения, будет использоваться Count.

Долгота
Популярность – ярлык Необязательно Укажите ярлык популярности, например "Лайки".

Строка

Рекомендуемый размер текста: не более 20 символов для количества и ярлыка вместе.

Популярность – визуальный Необязательно

Укажите, для чего нужно взаимодействие. Например, изображение со значком "Нравится" и эмодзи.

Вы можете добавить несколько изображений, но не все из них будут показываться на всех типах устройств.

Примечание. Изображение должно быть квадратным (1:1).

Ознакомьтесь со спецификациями изображений.
Оценка – максимальное значение Обязательно

Максимальное значение оценочной шкалы.

Обязательно, если указано текущее значение оценки.

Число >= 0,0
Оценка – текущее значение Обязательно

Текущее значение оценочной шкалы.

Обязательно, если указано максимальное значение оценки.

Число >= 0,0
Оценка – количество Необязательно

Количество оценок объекта.

Примечание. Заполните это поле, если хотите управлять тем, как информация показывается пользователям. Укажите краткую строку, которая может быть показана пользователю. Например, если количество равно 1 000 000, используйте сокращение "1 млн", чтобы оно не усекалось на экранах меньшего размера.

Строка
Рейтинг – количество оценок Необязательно

Количество оценок объекта.

Примечание. Заполните это поле, если не хотите самостоятельно настраивать логику сокращения. Если указаны оба значения, пользователям будет показываться Count.

Долгота
Местоположение – страна Необязательно Страна, в которой находится или служит человек.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – город Необязательно Город, в котором находится или работает человек.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – отображаемый адрес Необязательно Пользователю будет показан адрес, по которому находится или оказывает услуги лицо, разместившее объявление.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – почтовый адрес Необязательно Почтовый адрес (если применимо), по которому находится или работает человек.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – штат Необязательно Штат, в котором находится или служит человек (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – почтовый индекс Необязательно Почтовый индекс (если применимо) места, где находится или служит человек.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – микрорайон Необязательно Район (если применимо), в котором находится или работает человек.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Значки Необязательно

Каждый значок может содержать текст (не более 15 символов) или небольшое изображение.

Текстовый значок Необязательно

Название значка

Примечание. Для значка требуется текст или изображение.

Произвольный текст

Рекомендуемый размер текста: не более 15 символов.

Значок – изображение Необязательно

Маленькое изображение

Специальное оформление UX, например значок поверх миниатюры изображения или видео.

Примечание. Для значка требуется текст или изображение.

Ознакомьтесь со спецификациями изображений.
Описание Необязательно

Один абзац текста с описанием объекта.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста: 180 символов.

Список субтитров Необязательно

До трех подзаголовков, каждый из которых состоит из одной строки текста.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста для каждой строки субтитров: не более 50 символов.

Категории контента Необязательно Опишите категорию контента в объекте.

Список допустимых перечислений

  • TYPE_HEALTH_AND_FITENESS (например, тренер по йоге или фитнесу)
  • TYPE_HOME_AND_AUTO (например, сантехник)
  • TYPE_SPORTS (пример – игрок)
  • TYPE_DATING

Подробные инструкции вы найдете в разделе Категория контента.

RestaurantReservationEntity

Атрибут Требования Описание Формат
URI действия Обязательно

Ссылка на контент в приложении поставщика.

Примечание. Ссылки на контент можно использовать для атрибуции. Ознакомьтесь с разделом часто задаваемых вопросов

URI
Название Обязательно Название объекта.

Строка

Рекомендуемый размер текста: не более 50 символов.

Время начала бронирования Обязательно Временная метка в миллисекундах, указывающая на ожидаемое время начала резервирования. Временная метка в миллисекундах с начала отсчета
Местоположение – страна Обязательно Страна, в которой находится ресторан.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – город Обязательно Город, в котором находится ресторан.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – отображаемый адрес Обязательно Адрес ресторана, который будет показываться пользователю.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – почтовый адрес Необязательно Почтовый адрес ресторана (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – штат Необязательно Область или регион, в котором расположен ресторан (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – почтовый индекс Необязательно Почтовый индекс ресторана (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – микрорайон Необязательно Район, в котором находится ресторан (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Постеры Необязательно Если вы добавите несколько изображений, мы покажем только одно из них. Рекомендуемое соотношение сторон – 16:9. Ознакомьтесь со спецификациями изображений.
Описание Необязательно

Один абзац текста с описанием объекта.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста: 180 символов.

Список субтитров Необязательно

До трех подзаголовков, каждый из которых состоит из одной строки текста.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста для каждой строки субтитров: не более 50 символов.

Размер таблицы Необязательно Количество человек в группе бронирования Целое число больше 0

EventReservationEntity

Атрибут Требования Описание Формат
URI действия Обязательно

Ссылка на контент в приложении поставщика.

Примечание. Ссылки на контент можно использовать для атрибуции. Ознакомьтесь с разделом часто задаваемых вопросов

URI
Название Обязательно Название объекта.

Строка

Рекомендуемый размер текста: не более 50 символов.

Время начала Обязательно

Временная метка эпохи, когда должно начаться событие.

Примечание. Значение указывается в миллисекундах.

Временная метка в миллисекундах с начала отсчета
Режим событий Обязательно

Поле, в котором указывается, как будет проходить мероприятие: онлайн, офлайн или в смешанном формате.

Перечисление: VIRTUAL, IN_PERSON или HYBRID.
Местоположение – страна Условно обязательно

Страна, в которой проводится мероприятие.

Примечание. Это поле обязательно для событий с типом IN_PERSON или HYBRID.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – город Условно обязательно

Город, в котором проходит мероприятие.

Примечание. Это поле обязательно для событий с типом IN_PERSON или HYBRID.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – отображаемый адрес Условно обязательно

Адрес или название места проведения мероприятия, которое должно быть показано пользователю.

Примечание. Это поле обязательно для событий с типом IN_PERSON или HYBRID.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – почтовый адрес Необязательно Почтовый адрес (если применимо) места проведения мероприятия.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – штат Необязательно Штат или область, где проводится мероприятие (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – почтовый индекс Необязательно Почтовый индекс места проведения мероприятия (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – микрорайон Необязательно Район, в котором проводится мероприятие (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Постеры Необязательно

Если вы добавите несколько изображений, мы покажем только одно из них. Рекомендуемое соотношение сторон – 16:9.

Примечание. Настоятельно рекомендуется добавить изображение. Если вы используете значок, оставьте свободное пространство в 24 dp сверху и снизу изображения.

Ознакомьтесь со спецификациями изображений.
Время окончания Необязательно

Временная метка эпохи, когда событие должно закончиться.

Примечание. Значение указывается в миллисекундах.

Временная метка в миллисекундах с начала отсчета
Поставщик услуг – название Необязательно

Название поставщика услуг.

Примечание. Для поставщика услуг необходимо указать текст или изображение.

Произвольный текст. Например, название организатора мероприятия или тура.
Поставщик услуг – изображение Необязательно

Логотип или изображение поставщика услуг.

Примечание. Для поставщика услуг необходимо указать текст или изображение.

Ознакомьтесь со спецификациями изображений.
Описание Необязательно

Один абзац текста с описанием объекта.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста: 180 символов.

Список субтитров Необязательно

До трех подзаголовков, каждый из которых состоит из одной строки текста.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста для каждой строки субтитров: не более 50 символов.

Значки Необязательно

Каждый значок может содержать текст (не более 15 символов) или небольшое изображение.

Текстовый значок Необязательно

Название значка

Примечание. Для значка требуется текст или изображение.

Произвольный текст

Рекомендуемый размер текста: не более 15 символов.

Значок – изображение Необязательно

Маленькое изображение

Специальное оформление UX, например значок поверх миниатюры изображения или видео.

Примечание. Для значка требуется текст или изображение.

Ознакомьтесь со спецификациями изображений.
Идентификатор резервирования Необязательно Идентификатор бронирования мероприятия. Произвольный текст
Price – CurrentPrice Условно обязательно

Текущая цена билета или пропуска на мероприятие.

Обязателен, если указана зачеркнутая цена.

Произвольный текст
Price – StrikethroughPrice Необязательно Первоначальная цена билета или пропуска на мероприятие. Произвольный текст
Уточнение цены Необязательно Уточнение с ценой, чтобы выделить промоакцию, событие или скидку для участников, если они доступны.

Произвольный текст

Рекомендуемая длина текста – до 45 символов. Если текст слишком длинный, он может быть сокращен.

Оценка – максимальное значение Необязательно

Максимальное значение оценочной шкалы.

Обязательно, если указано текущее значение оценки.

Число >= 0,0
Оценка – текущее значение Необязательно

Текущее значение оценочной шкалы.

Обязательно, если указано максимальное значение оценки.

Число >= 0,0
Оценка – количество Необязательно

Количество оценок мероприятия.

Примечание. Заполните это поле, если хотите управлять тем, как информация показывается пользователям. Укажите краткую строку, которая может быть показана пользователю. Например, если количество равно 1 000 000, используйте сокращение "1 млн", чтобы оно не усекалось на экранах меньшего размера.

Строка
Рейтинг – количество оценок Необязательно

Количество оценок мероприятия.

Примечание. Заполните это поле, если не хотите самостоятельно настраивать логику сокращения. Если указаны оба значения, пользователям будет показываться Count.

Долгота
Категории контента Необязательно Опишите категорию контента в объекте.

Список допустимых перечислений

  • TYPE_MOVIES_AND_TV_SHOWS (пример: кинотеатр)
  • TYPE_DIGITAL_GAMES (например, киберспорт)
  • TYPE_MUSIC (например, концерт)
  • TYPE_TRAVEL_AND_LOCAL (например, тур, фестиваль)
  • TYPE_HEALTH_AND_FITENESS (например, занятие йогой)
  • TYPE_EDUCATION (например, класс)
  • TYPE_SPORTS (например, футбольный матч)
  • TYPE_DATING (например, meetup)

Подробные инструкции вы найдете в разделе Категория контента.

LodgingReservationEntity

Атрибут Требования Описание Формат
URI действия Обязательно

Ссылка на контент в приложении поставщика.

Примечание. Ссылки на контент можно использовать для атрибуции. Ознакомьтесь с разделом часто задаваемых вопросов

URI
Название Обязательно Название объекта.

Произвольный текст. Пример: "Ваше бронирование с 12 декабря".

Рекомендуемый размер текста: не более 50 символов.

Время заезда Обязательно Временная метка в миллисекундах, которая представляет время заезда. Временная метка в миллисекундах с начала отсчета
Время выезда Обязательно Временная метка в миллисекундах, которая представляет время выезда для бронирования. Временная метка в миллисекундах с начала отсчета
Местоположение – страна Обязательно Страна, в которой находится гостиница.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – город Обязательно Город, в котором находится гостиница.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – отображаемый адрес Обязательно Адрес места проживания, который будет показываться пользователю.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – почтовый адрес Необязательно Почтовый адрес места размещения (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – штат Необязательно Штат или провинция (если применимо), в котором находится гостиница.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – почтовый индекс Необязательно Почтовый индекс места размещения (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Местоположение – микрорайон Необязательно Район, в котором находится гостиница (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Постеры Необязательно

Если вы добавите несколько изображений, мы покажем только одно из них. Рекомендуемое соотношение сторон – 16:9.

Примечание. Если вы используете значок, оставьте свободное пространство в 24 dp в верхней и нижней частях изображения.

Ознакомьтесь со спецификациями изображений.
Описание Необязательно

Один абзац текста с описанием объекта.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста: 180 символов.

Список субтитров Необязательно

До трех подзаголовков, каждый из которых состоит из одной строки текста.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста для каждой строки субтитров: не более 50 символов.

Идентификатор резервирования Необязательно Идентификатор бронирования жилья. Произвольный текст
Оценка – максимальное значение Необязательно

Максимальное значение оценочной шкалы.

Обязательно, если указано текущее значение оценки.

Число >= 0,0
Оценка – текущее значение Необязательно

Текущее значение оценочной шкалы.

Обязательно, если указано максимальное значение оценки.

Число >= 0,0
Оценка – количество Необязательно

Количество оценок места размещения.

Примечание. Заполните это поле, если хотите управлять тем, как информация показывается пользователям. Укажите краткую строку, которая может быть показана пользователю. Например, если количество равно 1 000 000, используйте сокращение "1 млн", чтобы оно не усекалось на экранах меньшего размера.

Строка
Рейтинг – количество оценок Необязательно

Количество оценок места размещения.

Примечание. Заполните это поле, если не хотите самостоятельно настраивать логику сокращения. Если указаны оба значения, пользователям будет показываться Count.

Долгота
Price – CurrentPrice Условно обязательно

Текущая цена проживания.

Обязателен, если указана зачеркнутая цена.

Произвольный текст
Price – StrikethroughPrice Необязательно Исходная цена за проживание, которая будет зачеркнута в интерфейсе. Произвольный текст
Уточнение цены Необязательно Уточнение с ценой, чтобы выделить промоакцию, событие или скидку для участников, если они доступны.

Произвольный текст

Рекомендуемая длина текста – до 45 символов. Если текст слишком длинный, он может быть сокращен.

TransportationReservationEntity

Атрибут Требования Описание Формат
URI действия Обязательно

Ссылка на контент в приложении поставщика.

Примечание. Ссылки на контент можно использовать для атрибуции. Ознакомьтесь с разделом часто задаваемых вопросов

URI
Название Обязательно Название объекта.

Произвольный текст. Пример: "SFO to SAN".

Рекомендуемый размер текста: не более 50 символов.

Вид транспорта Обязательно Вид транспорта, на который оформлено бронирование. Примеры: FLIGHT, TRAIN, BUS, FERRY.
Выезд Обязательно Временная метка в миллисекундах, представляющая время отправления. Временная метка в миллисекундах с начала отсчета
Прибытие Обязательно Временная метка в миллисекундах, которая представляет время прибытия. Временная метка в миллисекундах с начала отсчета
Место отправления – страна Необязательно Страна отправления.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Место отправления – город Необязательно Город отправления.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Место отправления – отображаемый адрес Необязательно Место отправления, которое будет показываться пользователю.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Место отправления – почтовый адрес Необязательно Почтовый адрес места отправления (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Место отправления – штат Необязательно Штат или провинция (если применимо) места отправления.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Место отправления – почтовый индекс Необязательно Почтовый индекс места отправления (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Место отправления – район Необязательно Район (если применимо) места отправления.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Место прибытия – страна Необязательно Страна прибытия.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Место прибытия – город Необязательно Город прибытия.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Место прибытия – отображаемый адрес Необязательно Место прибытия, которое будет показано пользователю.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Место прибытия – почтовый адрес Необязательно Почтовый адрес места прибытия (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Место прибытия – штат Необязательно Штат или провинция (если применимо) места прибытия.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Место прибытия – почтовый индекс Необязательно Почтовый индекс (если применимо) места прибытия.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Место прибытия – микрорайон Необязательно Район (если применимо) места прибытия.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Поставщик услуг – название Необязательно

Название поставщика услуг.

Примечание. Для поставщика услуг необходимо указать текст или изображение.

Произвольный текст. Например, название авиакомпании.
Поставщик услуг – изображение Необязательно

Логотип или изображение поставщика услуг.

Примечание. Для поставщика услуг необходимо указать текст или изображение.

Ознакомьтесь со спецификациями изображений.
Постеры Необязательно

Если вы добавите несколько изображений, мы покажем только одно из них. Рекомендуемое соотношение сторон – 16:9.

Ознакомьтесь со спецификациями изображений.
Описание Необязательно

Один абзац текста с описанием объекта.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста: 180 символов.

Список субтитров Необязательно

До трех подзаголовков, каждый из которых состоит из одной строки текста.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста для каждой строки субтитров: не более 50 символов.

Идентификатор резервирования Необязательно Идентификатор бронирования. Произвольный текст
Price – CurrentPrice Условно обязательно

Текущая цена бронирования.

Обязателен, если указана зачеркнутая цена.

Произвольный текст
Price – StrikethroughPrice Необязательно Исходная цена бронирования, которая будет зачеркнута в интерфейсе. Произвольный текст
Уточнение цены Необязательно Уточнение с ценой, чтобы выделить промоакцию, событие или скидку для участников, если они доступны.

Произвольный текст

Рекомендуемая длина текста – до 45 символов. Если текст слишком длинный, он может быть сокращен.

Номер транспортного средства Обязательно Номер рейса, автобуса, поезда, парома или круиза. Произвольный текст
Время посадки Обязательно Временная метка эпохи, представляющая время посадки для бронирования (если применимо). Временная метка в миллисекундах с начала отсчета

VehicleRentalReservationEntity

Атрибут Требования Описание Формат
URI действия Обязательно

Ссылка на контент в приложении поставщика.

Примечание. Ссылки на контент можно использовать для атрибуции. Ознакомьтесь с разделом часто задаваемых вопросов

URI
Название Обязательно Название объекта.

Произвольный текст. Пример: "Avis Union Square SF".

Рекомендуемый размер текста: не более 50 символов.

Время получения автомобиля Обязательно Временная метка, представляющая время получения заказа. Временная метка в миллисекундах с начала отсчета
Время возврата Необязательно Временная метка в формате Unix, которая представляет время выезда для бронирования. Временная метка в миллисекундах с начала отсчета
Pickup Address - Country Необязательно Страна, в которой находится место самовывоза.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Адрес места получения – город Необязательно Город, в котором находится место посадки.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Адрес самовывоза – отображаемый адрес Необязательно Место самовывоза, которое будет показываться пользователю.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Адрес места получения – почтовый адрес Необязательно Почтовый адрес места посадки (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Адрес самовывоза – штат Необязательно Штат или провинция (если применимо) места самовывоза.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Адрес самовывоза – почтовый индекс Необязательно Почтовый индекс места самовывоза (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Адрес места посадки – район Необязательно Район, в котором находится место самовывоза (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Адрес для возвратов – страна Необязательно Страна, в которой находится пункт возврата.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Адрес для возвратов – город Необязательно Город, в котором находится пункт возврата.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Адрес для возвратов – отображаемый адрес Необязательно Адрес возврата, который будет показан пользователю.

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Адрес для возвратов – почтовый адрес Необязательно Почтовый адрес пункта возврата (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Адрес для возвратов – штат Необязательно Штат или провинция, где находится пункт возврата (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Адрес для возвратов – почтовый индекс Необязательно Почтовый индекс пункта возврата (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Адрес для возвратов – район Необязательно Район, в котором находится пункт возврата (если применимо).

Произвольный текст

Рекомендуемый размер текста: не более 20 символов.

Поставщик услуг – название Необязательно

Название поставщика услуг.

Примечание. Для поставщика услуг необходимо указать текст или изображение.

Произвольный текст. Пример: "Прокат автомобилей Avis".
Поставщик услуг – изображение Необязательно

Логотип или изображение поставщика услуг.

Примечание. Для поставщика услуг необходимо указать текст или изображение.

Ознакомьтесь со спецификациями изображений.
Постеры Необязательно

Если вы добавите несколько изображений, мы покажем только одно из них. Рекомендуемое соотношение сторон – 16:9.

Ознакомьтесь со спецификациями изображений.
Описание Необязательно

Один абзац текста с описанием объекта.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста: 180 символов.

Список субтитров Необязательно

До трех подзаголовков, каждый из которых состоит из одной строки текста.

Примечание. Пользователю будет показано либо описание, либо список подзаголовков, но не оба элемента.

Произвольный текст

Рекомендуемый размер текста для каждой строки субтитров: не более 50 символов.

Идентификатор подтверждения Необязательно Идентификатор подтверждения бронирования автомобиля. Произвольный текст
Price – CurrentPrice Условно обязательно

Текущая цена бронирования.

Обязателен, если указана зачеркнутая цена.

Произвольный текст
Price – StrikethroughPrice Необязательно Исходная цена бронирования, которая будет зачеркнута в интерфейсе. Произвольный текст
Уточнение цены Необязательно Уточнение с ценой, чтобы выделить промоакцию, событие или скидку для участников, если они доступны.

Произвольный текст

Рекомендуемая длина текста – до 45 символов. Если текст слишком длинный, он может быть сокращен.

Требования к картинкам

В таблице ниже приведены требования к объектам изображений.

Соотношение сторон Поддерживаемые кластеры Минимальный размер (пиксели) Рекомендуемый размер (пиксели)
Горизонтальное (16:9, 1,91:1) Рекомендуемые, продолжение и рекомендации (предпочтительно 16:9) 640 x 360 (16:9) / 600 x 314 (1,91:1) 1264 x 712 (16:9) / 1200 x 628 (1,91:1)
Квадрат (1:1). Все кластеры (рекомендуется для StoreEntity; обязательно для аватара, популярности (PersonEntity), поставщика услуг и изображений значков) 300x300 1200x1200
Вертикальное (4:5) Рекомендация 480x600 960x1200

Изображения должны размещаться в общедоступных сетях доставки контента, чтобы у 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

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

Рекомендации по использованию категорий контента

  1. Некоторые объекты, например ArticleEntity и GenericFeaturedEntity, могут использовать любые категории контента. Для других объектов, таких как EventEntity, EventReservationEntity и PointOfInterestEntity, доступен только набор этих категорий. Прежде чем заполнять список, проверьте, какие категории доступны для того или иного типа объекта.
  2. Для некоторых категорий контента используйте определенный тип объекта, а не сочетание общих объектов и ContentCategory:

  3. Поле ContentCategory необязательно. Если контент не относится ни к одной из перечисленных выше категорий, оставьте его пустым.

  4. Если вы указываете несколько категорий контента, расположите их в порядке релевантности контенту, начиная с самой подходящей.

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

Рекомендуется выполнять публикацию контента в фоновом режиме (например, с помощью WorkManager) и запланировать ее на регулярной основе или на основе событий (например, каждый раз, когда пользователь открывает приложение или когда пользователь только что добавил что-то в корзину).

AppEngagePublishClient отвечает за публикацию кластеров.

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

  • isServiceAvailable
  • publishRecommendationClusters
  • publishFeaturedCluster
  • publishContinuationCluster
  • publishUserAccountManagementRequest
  • updatePublishStatus
  • deleteRecommendationsClusters
  • deleteFeaturedCluster
  • deleteContinuationCluster
  • deleteUserManagementCluster
  • deleteClusters

isServiceAvailable

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

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

Тип кластера Константа типа кластера Целочисленное значение
Неизвестно TYPE_UNKNOWN 0
Кластер рекомендаций TYPE_RECOMMENDATION 1
Рекомендуемый кластер TYPE_FEATURED 2
Кластер продолжения TYPE_CONTINUATION 3
Кластер корзины покупок TYPE_SHOPPING_CART 4
Кластер повторного заказа еды TYPE_FOOD_REORDER 5
Кластер "Продуктовая тележка" TYPE_FOOD_SHOPPING_CART 6
Кластер "Список покупок" TYPE_FOOD_SHOPPING_LIST 7
Кластер управления пользователями TYPE_ENGAGEMENT 8
Кластер списка покупок TYPE_SHOPPING_LIST 9
Кластер повторного заказа в Покупках TYPE_SHOPPING_REORDER 10
Кластер отслеживания заказов в Покупках TYPE_SHOPPING_ORDER_TRACKING 11
Кластер подписок TYPE_SUBSCRIPTION 12
Кластер "Продолжить поиск" TYPE_CONTINUE_SEARCH 13
Кластер резервирования TYPE_RESERVATION 14

Kotlin

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 позволяет проверять доступность определенных типов кластеров. Если ваше приложение использует прерывистую передачу данных:

  • Кластеры продолжения (например, "Продолжить чтение" и "Бронирования") по умолчанию включены на всех поддерживаемых устройствах.
  • Другие типы кластеров (например, рекомендации) включаются и отключаются периодически.

Если эта конфигурация по умолчанию вам не подходит, напишите на адрес engage-developers@google.com.

Для версий SDK до 1.6.0 (поддержка прекращена)

Kotlin

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.

Kotlin

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.

Kotlin

client.publishFeaturedCluster(
    PublishFeaturedClusterRequest.Builder()
      .setFeaturedCluster(
        FeaturedCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

Java

client.publishFeaturedCluster(
            new PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    new FeaturedCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

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

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

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

publishContinuationCluster

Этот API используется для публикации объекта ContinuationCluster.

Kotlin

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 используется для публикации карточки входа . Действие "Войти" перенаправляет пользователей на страницу входа в приложение, чтобы оно могло публиковать контент (или предоставлять более персонализированный контент).

В карточке входа содержатся следующие метаданные:

Атрибут Требования Описание
URI действия Обязательно Ссылка на контент для действия (например, переход на страницу входа в приложение)
Изображение Необязательный. Если не указан, необходимо указать название.

Изображение на карточке

Изображения с соотношением сторон 16:9 и разрешением 1264 x 712.

Название Необязательный (если не указан, необходимо указать атрибут "изображение" [image]) Название на карточке
Текст действия Необязательно Текст, который показывается на кнопке с призывом к действию (например, "Войти")
Подзаголовок Необязательно Необязательный подзаголовок на карточке

Kotlin

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.

Kotlin

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

deleteRecommendationsClusters

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

Kotlin

client.deleteRecommendationsClusters()

Java

client.deleteRecommendationsClusters();

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

deleteFeaturedCluster

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

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

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

deleteContinuationCluster

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

Kotlin

client.deleteContinuationCluster()

Java

client.deleteContinuationCluster();

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

deleteUserManagementCluster

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

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

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

deleteClusters

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

Kotlin

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 публикации, чтобы можно было предпринять последующие действия для восстановления и повторной отправки успешной задачи.

Kotlin

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 для получения запроса на публикацию контента.

Основная цель широковещательных намерений – повторная активация приложения и принудительная синхронизация данных. Намерения широковещательной рассылки не предназначены для частой отправки. Он запускается, только когда сервис Google Play Обзор определяет, что контент может быть устаревшим (например, ему неделя). Это позволяет пользователю получать актуальный контент, даже если приложение не запускалось в течение длительного периода времени.

BroadcastReceiver необходимо настроить двумя способами:

  • Динамически зарегистрируйте экземпляр класса BroadcastReceiver с помощью Context.registerReceiver(). Это позволяет приложениям, которые все ещё находятся в памяти, обмениваться данными.

Kotlin

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);
}
  • Статически объявите реализацию с помощью тега <receiver> в файле AndroidManifest.xml. Это позволяет приложению получать намерения широковещательной рассылки, когда оно не запущено, а также публиковать контент.

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

Сервис отправляет следующие намерения:

  • 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 SDK.

Контакт

Если у вас возникнут вопросы в процессе интеграции, обратитесь в engage-developers@google.com.

Дальнейшие действия

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

  • Отправьте электронное письмо на адрес engage-developers@google.com и прикрепите к нему интегрированный APK-файл, готовый к тестированию специалистами Google.
  • Google выполняет проверку, чтобы убедиться, что интеграция работает правильно. Если потребуются изменения, Google свяжется с вами и сообщит необходимые сведения.
  • Если тестирование прошло успешно и изменения не требуются, Google сообщит вам, что вы можете опубликовать обновленный и интегрированный APK-файл в Google Play.
  • После того как Google подтвердит, что обновленный APK-файл опубликован в Google Play, ваши кластеры Рекомендации, Избранное и Продолжение могут быть опубликованы и стать видны пользователям.