Google에서는 사용자의 앱을 카테고리별로 정리하고 맞춤형 앱 콘텐츠 소비와 검색을 위한 새로운 몰입형 환경을 제공하는 기기 내 노출 영역을 구축하고 있습니다. 이 전체 화면 환경을 통해 개발자 파트너는 앱 외부의 전용 채널에서 최고의 리치 콘텐츠를 선보일 수 있습니다.
이 가이드에는 개발자 파트너가 Engage SDK를 사용하여 이 새로운 노출 영역과 기존 Google 노출 영역을 모두 채우는 방식으로 음식 콘텐츠를 통합하는 방법에 관한 안내가 포함되어 있습니다.
통합 세부정보
용어
이 통합에는 맞춤 콘텐츠, 추천, 식품 장바구니, 식품 쇼핑 목록, 재주문이라는 5가지 클러스터 유형이 포함되어 있습니다.
맞춤 콘텐츠 클러스터에는 개별 개발자 파트너의 음식 관련 추천이 맞춤형으로 표시됩니다. 이러한 맞춤 콘텐츠는 사용자에 맞게 맞춤설정하거나 일반화(예: 새로운 할인 상품)할 수 있습니다. 레시피, 매장, 요리, 식료품 등을 적절하게 표시하는 데 사용합니다.
맞춤 콘텐츠 클러스터는 ProductEntity나 StoreEntity, RecipeEntity 등록정보로 구성할 수 있지만 여러 항목 유형을 혼합하여 구성할 수는 없습니다.
그림 :`ProductEntity`, `StoreEntity`, `RecipeEntity`.
(*참고용 UI)
추천 클러스터는 여러 개발자 파트너의 선택된 히어로 ProductEntity, StoreEntity 또는 RecipeEntity를 하나의 UI 그룹으로 보여줍니다. 추천 클러스터는 1개가 UI 상단에 표시되며 모든 맞춤 콘텐츠 클러스터보다 우선순위가 높습니다. 각 개발자 파트너는 추천 클러스터에 있는 여러 앱 개발자의 많은 항목(다양한 유형일 수 있음)과 함께 추천 클러스터에서 지원되는 유형의 단일 항목을 브로드캐스트할 수 있습니다.
<ph type="x-smartling-placeholder"></ph>
<ph type="x-smartling-placeholder"></ph>
그림 : `RecipeEntity`가 포함된 추천 클러스터
(*참고용 UI)
식품 장바구니 클러스터는 여러 개발자 파트너가 제공하는 식료품 장바구니의 미리보기를 한 UI 그룹으로 표시하여 사용자가 아직 처리되지 않은 장바구니를 완료하도록 유도합니다. 식품 장바구니 클러스터는 1개입니다.
식품 장바구니 클러스터는 장바구니에 있는 총 항목 수를 표시해야 하고 사용자의 장바구니에 있는 X 항목의 이미지를 포함할 수도 있습니다.
<ph type="x-smartling-placeholder"></ph>
<ph type="x-smartling-placeholder"></ph>
그림: 단일 클러스터의 식품 장바구니 클러스터
있습니다. (*참고용 UI)
를 통해 개인정보처리방침을 정의할 수 있습니다.
식품 쇼핑 목록 클러스터는 여러 개발자 파트너의 식료품 쇼핑 목록의 미리보기를 하나의 UI 그룹으로 표시하여 사용자가 해당 앱으로 돌아가 목록을 업데이트하고 완료하도록 유도합니다. 식품 쇼핑 목록 클러스터는 1개입니다.
<ph type="x-smartling-placeholder"></ph>
<ph type="x-smartling-placeholder"></ph>
그림: 단일 도메인의 식품 쇼핑 목록 클러스터
있습니다. (*참고용 UI)
를 통해 개인정보처리방침을 정의할 수 있습니다.
재주문 클러스터는 여러 개발자 파트너의 이전 주문에 관한 미리보기를 하나의 UI 그룹으로 표시하여 사용자가 재주문하도록 유도합니다.
재주문 클러스터는 1개입니다.
재주문 클러스터는 사용자의 이전 주문에 있는 총 항목 수를 표시해야 하며 다음 중 하나도 포함해야 합니다.
사용자의 이전 주문에 있는 X 항목의 이미지
사용자의 이전 주문에 있는 X 항목의 라벨
그림: 단일 항목의 음식 재주문 클러스터
있습니다. (*참고용 UI)
를 통해 개인정보처리방침을 정의할 수 있습니다.
사전 작업
최소 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'
}
이미지가 어두운 테마 설정과 밝은 테마 설정에서 제대로 표시될 수 있도록 투명한 배경을 사용합니다.
2단계: 클러스터 데이터 제공
콘텐츠 게시 작업을 백그라운드에서 실행하고(예: WorkManager 사용) 정기적으로 또는 이벤트를 기반으로 예약하는 것이 좋습니다(예: 사용자가 앱을 열 때마다 또는 사용자가 장바구니에 상품을 추가했을 때).
AppEngageFoodClient는 식품 클러스터 게시를 담당합니다.
클라이언트에서 클러스터를 게시하는 API는 다음과 같습니다.
isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishFoodShoppingCart
publishFoodShoppingList
publishReorderCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteFoodShoppingCartCluster
deleteFoodShoppingListCluster
deleteReorderCluster
deleteUserManagementCluster
deleteClusters
isServiceAvailable
이 API는 서비스를 통합에 사용할 수 있는지, 콘텐츠를 기기에 표시할 수 있는지 확인하는 데 사용됩니다.
Kotlin
client.isServiceAvailable.addOnCompleteListener { task ->
if (task.isSuccessful) {
// Handle IPC call success
if(task.result) {
// Service is available on the device, proceed with content publish
// calls.
} else {
// Service is not available, no further action is needed.
}
} else {
// The IPC call itself fails, proceed with error handling logic here,
// such as retry.
}
}
Java
client.isServiceAvailable().addOnCompleteListener(task - > {
if (task.isSuccessful()) {
// Handle success
if(task.getResult()) {
// Service is available on the device, proceed with content publish
// calls.
} else {
// Service is not available, no further action is needed.
}
} else {
// The IPC call itself fails, proceed with error handling logic here,
// such as retry.
}
});
publishRecommendationClusters
이 API는 목록 RecommendationCluster 객체를 게시하는 데 사용됩니다.
RecommendationCluster 객체에는 다음 속성이 포함될 수 있습니다.
속성
요구사항
설명
ProductEntity, StoreEntity 또는 RecipeEntity의 목록
필수 항목
이 맞춤 콘텐츠 클러스터의 권장사항을 구성하는 항목 목록입니다. 단일 클러스터의 항목은 동일한 유형이어야 합니다.
제목
필수 항목
맞춤 콘텐츠 클러스터의 제목입니다(예: 추수감사절 메뉴 대폭 할인).
권장 텍스트 크기: 25자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
부제
선택사항
맞춤 콘텐츠 클러스터의 부제목입니다.
작업 URI
선택사항
사용자가 전체 맞춤 콘텐츠 목록을 볼 수 있는 파트너 앱의 페이지로 연결되는 딥 링크입니다.
client.publishRecommendationClusters(
new PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(
new RecommendationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.setTitle("Big savings on Thanksgiving menu")
.build())
.build());
client.publishFoodShoppingCart(
new PublishFoodShoppingCartClusterRequest.Builder()
.setShoppingCart(
new FoodShoppingCart.Builder()
...
.build())
.build());
client.publishFoodShoppingList(
new PublishFoodShoppingListRequest.Builder()
.setFoodShoppingList(
new FoodShoppingListEntity.Builder()
...
.build())
.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
내부적인 이유로 어떠한 클러스터도 게시되지 않는 경우 updatePublishStatus API를 사용하여 게시 상태를 업데이트할 것을 적극 권장합니다.
이는 다음과 같은 이유로 중요합니다.
콘텐츠가 게시되는 경우에도(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
로그인하지 않은 사용자로 인해 콘텐츠가 게시되지 않은 경우
로그인 카드를 게시하는 것이 좋습니다.
어떠한 이유로든 제공업체가 로그인 카드를 게시할 수 없는 경우 상태 코드 NOT_PUBLISHED_REQUIRES_SIGN_IN을 사용하여 updatePublishStatus API를 호출하는 것이 좋습니다.
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으로 반환되며 원인은 오류 코드로 포함됩니다.
오류 코드
참고
SERVICE_NOT_FOUND
지정된 기기에서 서비스를 사용할 수 없습니다.
SERVICE_NOT_AVAILABLE
서비스는 특정 기기에서 사용할 수 있지만 호출 시점에는 사용할 수 없습니다(예: 명시적으로 사용 중지됨).
SERVICE_CALL_EXECUTION_FAILURE
스레딩 문제로 인해 작업을 실행할 수 없습니다. 이 경우 재시도할 수 있습니다.
SERVICE_CALL_PERMISSION_DENIED
호출자가 서비스를 호출할 수 없습니다.
SERVICE_CALL_INVALID_ARGUMENT
요청에 잘못된 데이터가 포함되어 있습니다(예: 허용된 클러스터 수를 초과함).
SERVICE_CALL_INTERNAL
서비스 측에 오류가 있습니다.
SERVICE_CALL_RESOURCE_EXHAUSTED
서비스 호출이 너무 자주 이루어집니다.
3단계: 브로드캐스트 인텐트 처리
작업을 통해 게시 콘텐츠 API를 호출하는 것 외에도 콘텐츠 게시 요청을 수신하도록 BroadcastReceiver를 설정해야 합니다.
브로드캐스트 인텐트의 목표는 주로 앱 재활성화 및 데이터 동기화 강제입니다. 브로드캐스트 인텐트는 자주 전송되지 않도록 설계되었습니다. 이는 참여 서비스에서 콘텐츠가 오래되었을 수 있다고 판단할 때만(예: 1주일) 트리거됩니다. 이렇게 하면 애플리케이션이 장기간 실행되지 않은 경우에도 사용자에게 새로운 콘텐츠 환경을 제공할 수 있습니다.
BroadcastReceiver는 다음 두 가지 방법으로 설정해야 합니다.
Context.registerReceiver()를 사용하여 BroadcastReceiver 클래스의 인스턴스를 동적으로 등록합니다. 이렇게 하면 여전히 메모리에 있는 애플리케이션의 통신이 가능해집니다.
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));
}
AndroidManifest.xml 파일에서 <receiver> 태그를 사용하여 구현을 정적으로 선언합니다. 이를 통해 애플리케이션이 실행 중이 아닐 때 브로드캐스트 인텐트를 수신할 수 있고, 애플리케이션이 콘텐츠를 게시할 수 있습니다.