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

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

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

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

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

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

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

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

  

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

  

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

  • Кластер корзины покупок продуктов питания должен отображать общее количество товаров в корзине, а также может включать изображения для 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 определены разные объекты для представления каждого типа элементов. Мы поддерживаем следующие объекты в категории «Продовольствие»:

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 от партнера-разработчика удаляются.
• Данные запроса анализируются и сохраняются в обновленном избранном кластере.

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

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 от партнера-разработчика удаляются.
• Данные запроса анализируются и сохраняются в обновленном кластере повторного заказа.

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

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

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

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

deleteRecommendationClusters

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

client.deleteRecommendationClusters()

client.deleteRecommendationClusters();

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

deleteFeaturedCluster

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

client.deleteFeaturedCluster()

client.deleteFeaturedCluster();

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

deleteFoodShoppingCartCluster

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

client.deleteFoodShoppingCartCluster()

client.deleteFoodShoppingCartCluster();

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

deleteFoodShoppingListCluster

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

client.deleteFoodShoppingListCluster()

client.deleteFoodShoppingListCluster();

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

deleteReorderCluster

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

client.deleteReorderCluster()

client.deleteReorderCluster();

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

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

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

Контакт

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

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

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

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

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

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

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

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

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

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

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

  

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

  

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

  • Кластер корзины покупок продуктов питания должен отображать общее количество товаров в корзине, а также может включать изображения для 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 определены разные объекты для представления каждого типа элементов. Мы поддерживаем следующие объекты в категории «Продовольствие»:

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 от партнера-разработчика удаляются.
• Данные запроса анализируются и сохраняются в обновленном избранном кластере.

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

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 от партнера-разработчика удаляются.
• Данные запроса анализируются и сохраняются в обновленном кластере повторного заказа.

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

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

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

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

deleteRecommendationClusters

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

client.deleteRecommendationClusters()

client.deleteRecommendationClusters();

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

deleteFeaturedCluster

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

client.deleteFeaturedCluster()

client.deleteFeaturedCluster();

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

deleteFoodShoppingCartCluster

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

client.deleteFoodShoppingCartCluster()

client.deleteFoodShoppingCartCluster();

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

deleteFoodShoppingListCluster

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

client.deleteFoodShoppingListCluster()

client.deleteFoodShoppingListCluster();

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

deleteReorderCluster

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

client.deleteReorderCluster()

client.deleteReorderCluster();

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

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

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

Контакт

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

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

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

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