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

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

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

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

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

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

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

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

  • Кластер рекомендаций может состоять из списков ProductEntity , StoreEntity или RecipeEntity , но не из смеси различных типов сущностей.

  

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

  

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

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

    

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

  

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

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

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

  

Предварительная работа

Минимальный уровень API: 19

Добавьте библиотеку com.google.android.engage:engage-core в свое приложение:

dependencies {
    // Make sure you also include that repository in your project's build.gradle file.
    implementation 'com.google.android.engage:engage-core:1.5.2'
}

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

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

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

Шаг 1: Предоставьте данные об организации

SDK определил различные сущности для представления каждого типа элемента. Мы поддерживаем следующие сущности для категории Food:

1. ProductEntity
2. StoreEntity
3. RecipeEntity
4. FoodShoppingCart
5. FoodShoppingList
6. FoodReorderCluster

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

ProductEntity

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

StoreEntity

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

RecipeEntity

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

FoodShoppingCart

FoodShoppingList

FoodReorderCluster

Характеристики изображения

Требуемые характеристики для графических ресурсов перечислены ниже:

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

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

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

5120 КБ

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

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

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

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

AppEngageFoodClient отвечает за публикацию кластеров продуктов питания.

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

• isServiceAvailable
• publishRecommendationClusters
• publishFeaturedCluster
• publishFoodShoppingCart
• publishFoodShoppingList
• publishReorderCluster
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteFeaturedCluster
• deleteFoodShoppingCartCluster
• deleteFoodShoppingListCluster
• deleteReorderCluster
• deleteUserManagementCluster
• deleteClusters

isServiceAvailable

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

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

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("Big savings on Thanksgiving menu")
                        .build())
                .build())

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Big savings on Thanksgiving menu")
                        .build())
                .build());

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

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

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

publishFeaturedCluster

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

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

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

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

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

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

publishFoodShoppingCart

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

client.publishFoodShoppingCart(
            PublishFoodShoppingCartClusterRequest.Builder()
                .setShoppingCart(
                    FoodShoppingCart.Builder()
                        ...
                        .build())
                .build())

client.publishFoodShoppingCart(
            new PublishFoodShoppingCartClusterRequest.Builder()
                .setShoppingCart(
                    new FoodShoppingCart.Builder()
                        ...
                        .build())
                .build());

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

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

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

publishFoodShoppingList

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

client.publishFoodShoppingList(
            PublishFoodShoppingListRequest.Builder()
                .setFoodShoppingList(
                    FoodShoppingListEntity.Builder()
                        ...
                        .build())
                .build())

client.publishFoodShoppingList(
            new PublishFoodShoppingListRequest.Builder()
                .setFoodShoppingList(
                    new FoodShoppingListEntity.Builder()
                        ...
                        .build())
                .build());

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

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

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

publishReorderCluster

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

client.publishReorderCluster(
            PublishReorderClusterRequest.Builder()
                .setReorderCluster(
                    FoodReorderCluster.Builder()
                        ...
                        .build())
                .build())

client.publishReorderCluster(
            new PublishReorderClusterRequest.Builder()
                .setReorderCluster(
                    new FoodReorderCluster.Builder()
                        ...
                        .build())
                .build());

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

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

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

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 == 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 рекомендует опубликовать Sign In Card. Если по какой-либо причине поставщики не могут опубликовать Sign In Card, мы рекомендуем вызвать API updatePublishStatus с кодом статуса NOT_PUBLISHED_REQUIRES_SIGN_IN

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

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

deleteRecommendationClusters

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

client.deleteRecommendationClusters()

client.deleteRecommendationClusters();

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

deleteFeaturedCluster

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

client.deleteFeaturedCluster()

client.deleteFeaturedCluster();

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

deleteFoodShoppingCartCluster

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

client.deleteFoodShoppingCartCluster()

client.deleteFoodShoppingCartCluster();

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

deleteFoodShoppingListCluster

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

client.deleteFoodShoppingListCluster()

client.deleteFoodShoppingListCluster();

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

deleteReorderCluster

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

client.deleteReorderCluster()

client.deleteReorderCluster();

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

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(
              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 для получения запроса на публикацию контента.

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

BroadcastReceiver необходимо настроить следующими двумя способами:

• Динамически зарегистрируйте экземпляр класса BroadcastReceiver с помощью Context.registerReceiver() . Это позволяет осуществлять связь из приложений, которые все еще находятся в памяти.

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_FOOD_SHOPPING_CART
// broadcast is received

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

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

public static void registerBroadcastReceivers(Context context) {

context = context.getApplicationContext();

// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION));

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));

// Register Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_FOOD_SHOPPING_CART));

// Register Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_FOOD_SHOPPING_LIST));

// Register Reorder Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER));

}

• Статически объявите реализацию с тегом <receiver> в вашем файле AndroidManifest.xml . Это позволяет приложению получать широковещательные намерения, когда оно не запущено, а также позволяет приложению публиковать контент.

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_CART" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER" />
      </intent-filter>
   </receiver>
</application>

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

• com.google.android.engage.action.PUBLISH_RECOMMENDATION Рекомендуется начать вызов publishRecommendationClusters при получении этого намерения.
• com.google.android.engage.action.PUBLISH_FEATURED При получении этого намерения рекомендуется запустить вызов publishFeaturedCluster .
• com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_CART При получении этого намерения рекомендуется начать вызов publishFoodShoppingCart .
• com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST При получении этого намерения рекомендуется начать вызов publishFoodShoppingList .
• com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER При получении этого намерения рекомендуется начать вызов publishReorderCluster .

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

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

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

См. раздел « Часто задаваемые вопросы по Engage SDK» .

Контакт

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

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

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

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