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

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

В этом руководстве рассказывается, как партнеры-разработчики могут передавать контент для покупок на платформы Engage.

Поддерживаемые категории и платформы

Доступность платформ Engage SDK зависит от категории контента в приложении. В таблице ниже указано, какие требования нужно выполнить, чтобы ваши товары показывались на разных платформах.

android skills add engage-sdk-integration

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

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

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

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

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

  Рекомендации имеют следующую структуру:

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

  • ShoppingEntity: объект, представляющий один элемент в кластере.

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

• Кластер Корзина показывает корзины из приложений разных партнеров-разработчиков в одном месте, напоминая пользователям о незавершенных покупках. Кластер корзины один, и он находится в верхней части интерфейса, выше всех кластеров рекомендаций. Каждый партнер-разработчик может транслировать до трех экземпляров ShoppingCart в кластере корзины.

  Корзина покупок имеет следующую структуру:

  • Кластер корзин. Элемент интерфейса, в котором собраны предварительные версии корзин от разных партнеров-разработчиков.

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

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

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

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

    • Изображения X товаров из предыдущего заказа пользователя.
    • Ярлыки для X товаров в предыдущем заказе пользователя.

• Кластер Отслеживание заказов позволяет пользователям следить за статусом ожидающих или недавно выполненных заказов от разных партнеров-разработчиков.

  Кластер ShoppingOrderTracking находится в верхней части интерфейса, выше всех кластеров рекомендаций. Каждый партнер-разработчик может передавать несколько объектов ShoppingOrderTrackingEntity в кластере Shopping Order Tracking.

  • Кластер ShoppingOrderTrackingCluster имеет следующую структуру:

    • Кластер ShoppingOrderTracking. Элемент интерфейса, который содержит группу предпросмотров отслеживания заказов от разных партнеров-разработчиков.
    • ShoppingOrderTrackingEntity – объект, представляющий предварительный просмотр отслеживания заказа для одного партнера-разработчика. Он показывается в кластере отслеживания заказов. В ShoppingOrderTrackingEntity должен быть указан статус заказа и время его оформления. Мы настоятельно рекомендуем указывать ожидаемую дату доставки в ShoppingOrderTrackingEntity, поскольку она показывается пользователям.

Подготовка

Минимальный уровень 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'
}

Подробнее о видимости пакетов в Android 11…

Сводка

Дизайн основан на реализации привязанной службы.

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

Шаг 1. Укажите данные о компании

В SDK определены разные объекты, представляющие каждый тип товара. Для категории "Покупки" поддерживаются следующие объекты:

1. ShoppingEntity
2. ShoppingCart
3. ShoppingList
4. Reorder
5. ShoppingOrderTracking

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

ShoppingEntity

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

ShoppingEntity

ShoppingCart

ShoppingList

ShoppingReorderCluster

ShoppingOrderTrackingCluster

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

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

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

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

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

5120 КБ

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

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

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

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

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

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

• isServiceAvailable
• publishRecommendationClusters
• publishFeaturedCluster
• publishShoppingCarts
• publishShoppingLists
• publishShoppingReorderCluster
• publishShoppingOrderTrackingCluster
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteFeaturedCluster
• deleteShoppingCartCluster
• deleteShoppingListCluster
• deleteReorderCluster
• deleteShoppingOrderTrackingCluster
• deleteUserManagementCluster
• deleteClusters

isServiceAvailable

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

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

android skills add engage-sdk-integration

Use the engage-sdk-integration skill to use Engage SDK 1.6.0 and refactor isServiceAvailable to pass ServiceAvailabilityRequest for publishing all cluster types.

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

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

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 (поддержка прекращена)

client.isServiceAvailable.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        // Handle IPC call success
        if(task.result) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
}

client.isServiceAvailable().addOnCompleteListener(task - > {
    if (task.isSuccessful()) {
        // Handle success
        if(task.getResult()) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
});

publishRecommendationClusters

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

Объект RecommendationCluster может иметь следующие атрибуты:

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Black Friday Deals")
                        .build())
                .build())

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Black Friday Deals")
                        .build())
                .build());

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

• Все существующие данные кластера рекомендаций удаляются.
• Данные из запроса анализируются и сохраняются в новых кластерах рекомендаций.

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

publishFeaturedCluster

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

client.publishFeaturedCluster(
            PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    FeaturedCluster.Builder()
                        ...
                        .build())
                .build())

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

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

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

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

publishShoppingCarts

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

client.publishShoppingCarts(
            PublishShoppingCartClustersRequest.Builder()
                .addShoppingCart(
                    ShoppingCart.Builder()
                        ...
                        .build())
                .build())

client.publishShoppingCarts(
            new PublishShoppingCartClustersRequest.Builder()
                .addShoppingCart(
                    new ShoppingCart.Builder()
                        ...
                        .build())
                .build())

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

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

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

publishShoppingLists

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

client.publishShoppingLists(
            PublishShoppingListsRequest.Builder()
                .addShoppingList(
                    ShoppingList.Builder()
                        ...
                        .build())
                .build())

client.publishShoppingLists(
            new PublishShoppingListsRequest.Builder()
                .addShoppingList(
                    new ShoppingList.Builder()
                        ...
                        .build())
                .build());

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

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

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

publishShoppingReorderCluster

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

client.publishShoppingReorderCluster(
            PublishShoppingReorderClusterRequest.Builder()
                .setReorderCluster(
                    ShoppingReorderCluster.Builder()
                        ...
                        .build())
                .build())

client.publishShoppingReorderCluster(
            new PublishShoppingReorderClusterRequest.Builder()
                .setReorderCluster(
                    new ShoppingReorderCluster.Builder()
                        ...
                        .build())
                .build());

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

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

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

publishShoppingOrderTrackingCluster

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

client.publishShoppingOrderTrackingCluster(
            PublishShoppingOrderTrackingClusterRequest.Builder()
                .setShoppingOrderTrackingCluster(
                    ShoppingOrderTrackingCluster.Builder()
                        ...
                        .build())
                .build())

client.publishShoppingOrderTrackingCluster(
            new PublishShoppingOrderTrackingClusterRequest.Builder()
                .setShoppingOrderTrackingCluster(
                    new ShoppingOrderTrackingCluster.Builder()
                        ...
                        .build())
                .build());

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

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

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

publishUserAccountManagementRequest

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

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

var SIGN_IN_CARD_ENTITY =
      SignInCardEntity.Builder()
          .addPosterImage(
              Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build()

client.publishUserAccountManagementRequest(
            PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

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

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

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

updatePublishStatus

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

• Указывать статус нужно во всех случаях, даже когда контент опубликован (STATUS == 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())

client.updatePublishStatus(
    new PublishStatusRequest.Builder()
        .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
        .build());

deleteRecommendationsClusters

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

client.deleteRecommendationsClusters()

client.deleteRecommendationsClusters();

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

deleteFeaturedCluster

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

client.deleteFeaturedCluster()

client.deleteFeaturedCluster();

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

deleteShoppingCartCluster

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

client.deleteShoppingCartCluster()

client.deleteShoppingCartCluster();

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

deleteShoppingListCluster

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

client.deleteShoppingListCluster()

client.deleteShoppingListCluster();

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

deleteReorderCluster

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

client.deleteReorderCluster()

client.deleteReorderCluster();

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

deleteShoppingOrderTrackingCluster

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

client.deleteShoppingOrderTrackingCluster()

client.deleteShoppingOrderTrackingCluster();

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

deleteUserManagementCluster

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

client.deleteUserManagementCluster()

client.deleteUserManagementCluster();

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

deleteClusters

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

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

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

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

Обработка ошибок

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

client.publishRecommendationClusters(
        PublishRecommendationClustersRequest.Builder()
          .addRecommendationCluster(..)
          .build())
      .addOnCompleteListener { task ->
        if (task.isSuccessful) {
          // do something
        } else {
          val exception = task.exception
          if (exception is AppEngageException) {
            @AppEngageErrorCode val errorCode = exception.errorCode
            if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
              // do something
            }
          }
        }
      }

client.publishRecommendationClusters(
              new PublishRecommendationClustersRequest.Builder()
                  .addRecommendationCluster(...)
                  .build())
          .addOnCompleteListener(
              task -> {
                if (task.isSuccessful()) {
                  // do something
                } else {
                  Exception exception = task.getException();
                  if (exception instanceof AppEngageException) {
                    @AppEngageErrorCode
                    int errorCode = ((AppEngageException) exception).getErrorCode();
                    if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
                      // do something
                    }
                  }
                }
              });

Ошибка возвращается как AppEngageException с указанием причины в виде кода ошибки.

Шаг 3. Обработка намерений широковещательной рассылки

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

Цель широковещательных намерений – повторная активация приложения и принудительная синхронизация данных. Широковещательные намерения не предназначены для частой отправки. Он запускается, только когда сервис Google Play Объекты определяет, что контент может быть устаревшим (например, ему неделя). Это позволяет пользователю видеть актуальный контент, даже если приложение не запускалось в течение длительного периода времени.

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 shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast
  // is received
  // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast
  // is received
  // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is
  // received
  // Trigger shopping order tracking cluster publish when
  // PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER broadcast is received
}

fun registerBroadcastReceivers(context: Context){
  var  context = context
  context = context.applicationContext

// Register Recommendation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Shopping Cart Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_CART),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Shopping List Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_LIST),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Reorder Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Shopping Order Tracking Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)
}

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 shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast is
// received

// Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast is
// received

// Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is
// received

// Trigger reorder cluster publish when PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER
// broadcast is received
}

public static void registerBroadcastReceivers(Context context) {

context = context.getApplicationContext();

// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_CART),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_LIST),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Reorder Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Shopping Order Tracking Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER),
                         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.shopping.PUBLISH_SHOPPING_CART" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER" />
      </intent-filter>
   </receiver>
</application>

Сервис отправляет следующие намерения:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION При получении этого намерения рекомендуется начать вызов publishRecommendationClusters.
• com.google.android.engage.action.PUBLISH_FEATURED При получении этого намерения рекомендуется запустить вызов publishFeaturedCluster.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART При получении этого намерения рекомендуется запустить вызов publishShoppingCarts.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST При получении этого намерения рекомендуется запустить вызов publishShoppingLists.
• com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER При получении этого намерения рекомендуется запустить вызов publishReorderCluster.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER При получении этого намерения рекомендуется начать вызов publishShoppingOrderTrackingCluster.

Процесс интеграции

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

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

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

Контакт

Если у вас возникнут вопросы в процессе интеграции, обратитесь в engage-developers@google.com. Наши специалисты ответят вам как можно скорее.

Дальнейшие действия

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

• Отправьте письмо на адрес engage-developers@google.com и прикрепите к нему интегрированный APK-файл, готовый к тестированию в Google.
• Google выполняет проверку, чтобы убедиться, что интеграция работает правильно. Если потребуются изменения, Google свяжется с вами и сообщит необходимые сведения.
• Если тестирование прошло успешно и изменения не требуются, Google сообщит вам, что вы можете опубликовать обновленный APK-файл в Google Play.
• После того как Google подтвердит, что обновленный APK-файл опубликован в Google Play, ваши кластеры Рекомендации, Рекомендуемые, Корзина, Список покупок, Кластер повторных заказов и Кластер отслеживания заказов могут быть опубликованы и стать видны пользователям.