이 페이지는 Cloud Translation API를 통해 번역되었습니다.

Engage SDK Food: 서드 파티 기술 통합 안내

Google에서는 사용자의 앱을 카테고리별로 정리하고 맞춤형 앱 콘텐츠 소비와 검색을 위한 새로운 몰입형 환경을 제공하는 기기 내 노출 영역을 구축하고 있습니다. 이 전체 화면 환경을 통해 개발자 파트너는 앱 외부의 전용 채널에서 최고의 리치 콘텐츠를 선보일 수 있습니다.

이 가이드에는 개발자 파트너가 Engage SDK를 사용하여 이 새로운 노출 영역과 기존 Google 노출 영역을 모두 채우는 방식으로 음식 콘텐츠를 통합하는 방법에 관한 안내가 포함되어 있습니다.

통합 세부정보

용어

이 통합에는 맞춤 콘텐츠, 추천, 식품 장바구니, 식품 쇼핑 목록, 재주문이라는 5가지 클러스터 유형이 포함되어 있습니다.

맞춤 콘텐츠 클러스터에는 개별 개발자 파트너의 음식 관련 추천이 맞춤형으로 표시됩니다. 이러한 맞춤 콘텐츠는 사용자에 맞게 맞춤설정하거나 일반화(예: 새로운 할인 상품)할 수 있습니다. 레시피, 매장, 요리, 식료품 등을 적절하게 표시하는 데 사용합니다.
- 맞춤 콘텐츠 클러스터는 ProductEntity나 StoreEntity, RecipeEntity 등록정보로 구성할 수 있지만 여러 항목 유형을 혼합하여 구성할 수는 없습니다.
추천 클러스터는 여러 개발자 파트너의 선택된 히어로 ProductEntity, StoreEntity 또는 RecipeEntity를 하나의 UI 그룹으로 보여줍니다. 추천 클러스터는 1개가 UI 상단에 표시되며 모든 맞춤 콘텐츠 클러스터보다 우선순위가 높습니다. 각 개발자 파트너는 추천 클러스터에 있는 여러 앱 개발자의 많은 항목(다양한 유형일 수 있음)과 함께 추천 클러스터에서 지원되는 유형의 단일 항목을 브로드캐스트할 수 있습니다.
식품 장바구니 클러스터는 여러 개발자 파트너가 제공하는 식료품 장바구니의 미리보기를 한 UI 그룹으로 표시하여 사용자가 아직 처리되지 않은 장바구니를 완료하도록 유도합니다. 식품 장바구니 클러스터는 1개입니다.
- 식품 장바구니 클러스터는 장바구니에 있는 총 항목 수를 표시해야 하고 사용자의 장바구니에 있는 X 항목의 이미지를 포함할 수도 있습니다.
식품 쇼핑 목록 클러스터는 여러 개발자 파트너의 식료품 쇼핑 목록의 미리보기를 하나의 UI 그룹으로 표시하여 사용자가 해당 앱으로 돌아가 목록을 업데이트하고 완료하도록 유도합니다. 식품 쇼핑 목록 클러스터는 1개입니다.
재주문 클러스터는 여러 개발자 파트너의 이전 주문에 관한 미리보기를 하나의 UI 그룹으로 표시하여 사용자가 재주문하도록 유도합니다. 재주문 클러스터는 1개입니다.
- 재주문 클러스터는 사용자의 이전 주문에 있는 총 항목 수를 표시해야 하며 다음 중 하나도 포함해야 합니다.
  - 사용자의 이전 주문에 있는 X 항목의 이미지
  - 사용자의 이전 주문에 있는 X 항목의 라벨

사전 작업

최소 API 수준: 19

다음과 같이 com.google.android.play:engage 라이브러리를 앱에 추가합니다.

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

요약

설계는 바인드된 서비스의 구현을 기반으로 합니다.

클라이언트가 게시할 수 있는 데이터에는 다음과 같은 다양한 클러스터 유형의 제한이 적용됩니다.

클러스터 유형	클러스터 제한	클러스터의 최대 항목 제한
맞춤 콘텐츠 클러스터	최대 5개	최대 25개(`ProductEntity`, `RecipeEntity` 또는 `StoreEntity`)
추천 클러스터	최대 1개	최대 1개(`ProductEntity`, `RecipeEntity` 또는 `StoreEntity`)
식품 장바구니 클러스터	최대 1개	최대 1개 `ShoppingCartEntity`
식품 쇼핑 목록 클러스터	최대 1개	최대 1개 `ShoppingListEntity`
식품 재주문 클러스터	최대 1개	최대 1개 `ReorderEntity`

1단계: 항목 데이터 제공

SDK는 각 항목 유형을 나타내는 여러 항목을 정의했습니다. Food 카테고리에는 다음 항목이 지원됩니다.

ProductEntity
StoreEntity
RecipeEntity
FoodShoppingCart
FoodShoppingList
FoodReorderCluster

아래 차트에는 각 유형에 사용 가능한 속성과 요구사항이 나와 있습니다.

`ProductEntity`

ProductEntity 객체는 개발자 파트너가 게시하려는 개별 항목(예: 식료품, 레스토랑의 요리, 프로모션)을 나타냅니다.

속성	요구사항	설명	형식
포스터 이미지	필수 항목	이미지를 하나 이상 제공해야 합니다.	자세한 내용은 이미지 사양을 참고하세요.
작업 URI	필수 항목	제품 세부정보를 표시하는 앱 페이지의 딥 링크입니다. 참고: 기여 분석에 딥 링크를 사용할 수 있습니다. 이 FAQ 참고하기	URI
제목	선택사항	제품 이름입니다.	자유 텍스트 권장 텍스트 크기: 90자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
가격 - 현재	조건부 필수	제품의 현재 가격입니다. 취소선 가격이 제공되는 경우 제공해야 합니다.	자유 텍스트
가격 - 취소선	선택사항	항목의 원래 가격으로, UI에서 취소선 처리됩니다.	자유 텍스트
콜아웃	선택사항	제품에 관한 프로모션, 이벤트 또는 업데이트가 있는 경우 이를 표시하는 콜아웃입니다.	자유 텍스트 권장 텍스트 크기: 45자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
콜아웃 세부사항	선택사항	콜아웃의 세부 텍스트입니다.	자유 텍스트 권장 텍스트 크기: 45자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
평점(선택사항) - 참고: 모든 평점은 표준 별표 평점 시스템을 사용하여 표시됩니다.
평점 - 최댓값	필수	평가 척도의 최댓값입니다. 현재 평점 값도 제공되는 경우 제공해야 합니다.	0.0보다 크거나 같은 숫자
평점 - 현재 값	필수	항목 평점의 현재 값입니다. 평점 최댓값도 제공되는 경우 제공해야 합니다.	0.0보다 크거나 같은 숫자
평점 - 개수	선택사항	항목의 평점 수입니다.	문자열
DisplayTimeWindow(선택사항): 노출 영역에 콘텐츠를 표시할 시간 설정
시작 타임스탬프	선택사항	에포크 타임스탬프로, 이후에 콘텐츠가 노출 영역에 표시되어야 합니다. 설정하지 않으면 콘텐츠가 노출 영역에 표시될 수 있습니다.	에포크 타임스탬프(밀리초)
최종 타임스탬프	선택사항	에포크 타임스탬프로, 이후에 콘텐츠가 더 이상 노출 영역에 표시되지 않습니다. 설정하지 않으면 콘텐츠가 노출 영역에 표시될 수 있습니다.	에포크 타임스탬프(밀리초)

`StoreEntity`

StoreEntity 객체는 개발자 파트너가 게시하려는 개별 매장(예: 레스토랑 또는 식료품점)을 나타냅니다.

속성	요구사항	설명	형식
포스터 이미지	필수 항목	이미지를 하나 이상 제공해야 합니다.	자세한 내용은 이미지 사양을 참고하세요.
작업 URI	필수 항목	매장에 관한 세부정보를 표시하는 앱 페이지의 딥 링크입니다. 참고: 기여 분석에 딥 링크를 사용할 수 있습니다. 이 FAQ 참고하기	URI
제목	선택사항	매장의 이름입니다.	자유 텍스트 권장 텍스트 크기: 45자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
위치	선택사항	매장의 위치입니다.	자유 텍스트 권장 텍스트 크기: 45자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
콜아웃	선택사항	매장에 관한 프로모션, 이벤트 또는 업데이트가 있는 경우 이를 표시하는 콜아웃입니다.	자유 텍스트 권장 텍스트 크기: 45자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
콜아웃 세부사항	선택사항	콜아웃의 세부 텍스트입니다.	자유 텍스트 권장 텍스트 크기: 45자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
설명	선택사항	매장에 관한 설명입니다.	자유 텍스트 권장 텍스트 크기: 90자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
참고: 모든 평점은 Google의 표준 별표 평점 시스템을 사용하여 표시됩니다.
평점 - 최댓값	조건부 필수	평가 척도의 최댓값입니다. 현재 평점 값도 제공되는 경우 제공해야 합니다.	0.0보다 크거나 같은 숫자
평점 - 현재 값	조건부 필수	항목 평점의 현재 값입니다. 평점 최댓값도 제공되는 경우 제공해야 합니다.	0.0보다 크거나 같은 숫자
평점 - 개수	선택사항	항목의 평점 수입니다.	문자열

`RecipeEntity`

RecipeEntity 객체는 개발자 파트너가 게시하려는 레시피 항목을 나타냅니다.

속성	요구사항	설명	형식
포스터 이미지	필수 항목	이미지를 하나 이상 제공해야 합니다.	자세한 내용은 이미지 사양을 참고하세요.
작업 URI	필수 항목	레시피에 관한 세부정보를 표시하는 앱 페이지의 딥 링크입니다. 참고: 기여 분석에 딥 링크를 사용할 수 있습니다. 이 FAQ 참고하기	URI
제목	선택사항	레시피의 이름입니다.	자유 텍스트 권장 텍스트 크기: 45자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
작성자	선택사항	레시피의 작성자입니다.	자유 텍스트 권장 텍스트 크기: 45자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
요리/준비 시간	선택사항	레시피의 요리 시간입니다.	자유 텍스트 권장 텍스트 크기: 45자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
콜아웃	선택사항	레시피에 관한 프로모션, 이벤트 또는 업데이트가 있는 경우 이를 표시하는 콜아웃입니다.	자유 텍스트 권장 텍스트 크기: 45자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
카테고리	선택사항	레시피의 카테고리입니다.	자유 텍스트 권장 텍스트 크기: 45자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
설명	선택사항	레시피에 관한 설명입니다.	자유 텍스트 권장 텍스트 크기: 90자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
참고: 모든 평점은 Google의 표준 별표 평점 시스템을 사용하여 표시됩니다.
평점 - 최댓값	조건부 필수	평가 척도의 최댓값입니다. 현재 평점 값도 제공되는 경우 제공해야 합니다.	0.0보다 크거나 같은 숫자
평점 - 현재 값	조건부 필수	항목 평점의 현재 값입니다. 평점 최댓값도 제공되는 경우 제공해야 합니다.	0.0보다 크거나 같은 숫자
평점 - 개수	선택사항	항목의 평점 수입니다.	문자열

`FoodShoppingCart`

속성	요구사항	설명	형식
작업 URI	필수 항목	파트너 앱의 장바구니로 연결되는 딥 링크입니다. 참고: 기여 분석에 딥 링크를 사용할 수 있습니다. 이 FAQ 참고하기	URI
항목 수	필수 항목	장바구니에 있는 항목의 수(단지 제품 수가 아님)입니다. 예: 장바구니에 오렌지 3개와 사과 1개가 있으면 이 숫자는 4여야 합니다.	1보다 크거나 같은 정수
제목	선택사항	장바구니의 제목입니다(예: 내 장바구니). *개발자가 제목을 제공하지 않으면 내 장바구니가 기본값입니다.*	자유 텍스트 권장 텍스트 크기: 25자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
작업 텍스트	선택사항	장바구니에 있는 버튼의 클릭 유도 문구 텍스트입니다(예: 쇼핑백). *개발자가 작업 텍스트를 제공하지 않으면 기본값인 장바구니 보기가 적용됩니다.* 이 속성은 버전 1.1.0부터 지원됩니다.	문자열
장바구니 이미지	선택사항	장바구니에 있는 각 제품의 이미지입니다. 우선순위에 따라 최대 10개의 이미지가 제공될 수 있습니다. 표시되는 실제 이미지 수는 기기 폼 팩터에 따라 다릅니다.	자세한 내용은 이미지 사양을 참고하세요.
항목 라벨	선택사항	쇼핑 목록에 있는 항목의 라벨 목록입니다. 표시되는 실제 라벨 수는 기기 폼 팩터에 따라 다릅니다.	자유 텍스트 라벨 목록 권장 텍스트 크기: 20자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
DisplayTimeWindow(선택사항): 노출 영역에 콘텐츠를 표시할 시간 설정
시작 타임스탬프	선택사항	에포크 타임스탬프로, 이후에 콘텐츠가 노출 영역에 표시되어야 합니다. 설정하지 않으면 콘텐츠가 노출 영역에 표시될 수 있습니다.	에포크 타임스탬프(밀리초)
최종 타임스탬프	선택사항	에포크 타임스탬프로, 이후에 콘텐츠가 더 이상 노출 영역에 표시되지 않습니다. 설정하지 않으면 콘텐츠가 노출 영역에 표시될 수 있습니다.	에포크 타임스탬프(밀리초)

`FoodShoppingList`

속성	요구사항	설명	형식
작업 URI	필수 항목	파트너 앱의 쇼핑 목록 딥 링크입니다. 참고: 기여 분석에 딥 링크를 사용할 수 있습니다. 이 FAQ 참고하기	URI
항목 수	필수 항목	쇼핑 목록에 있는 항목의 수입니다.	1보다 크거나 같은 정수
제목	선택사항	목록의 제목(예: 내 식료품 목록)입니다. *개발자가 제목을 제공하지 않으면 쇼핑 목록이 기본값이 됩니다.*	자유 텍스트 권장 텍스트 크기: 25자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
항목 라벨	필수 항목	쇼핑 목록에 있는 항목의 라벨 목록입니다. 라벨을 1개 이상 제공해야 하며 최대 10개까지 우선순위에 따라 라벨을 제공할 수 있습니다. 표시되는 실제 라벨 수는 기기 폼 팩터에 따라 다릅니다.	자유 텍스트 라벨 목록 권장 텍스트 크기: 20자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)

`FoodReorderCluster`

속성	요구사항	설명	형식
작업 URI	필수 항목	파트너 앱의 재주문으로 연결되는 딥 링크입니다. 참고: 기여 분석에 딥 링크를 사용할 수 있습니다. 이 FAQ 참고하기	URI
작업 텍스트	선택사항	재주문에 있는 버튼의 클릭 유도 문구 텍스트입니다(예: 다시 주문). *개발자가 작업 텍스트를 제공하지 않으면 기본값인 재주문이 적용됩니다.* 이 속성은 버전 1.1.0부터 지원됩니다.	문자열
항목 수	필수 항목	이전 주문의 항목 수(단지 제품 수가 아님)입니다. 예: 이전 주문에 스몰 커피 3개와 크루아상 1개가 있다면 이 숫자는 4여야 합니다.	1보다 크거나 같은 정수
제목	필수 항목	재주문 항목의 제목입니다.	자유 텍스트 권장 텍스트 크기: 40자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
항목 라벨	선택사항 (제공되지 않는 경우 포스터 이미지를 제공해야 함)	이전 주문의 항목 라벨 목록입니다. 우선순위에 따라 최대 10개의 라벨을 제공할 수 있습니다. 표시되는 실제 라벨 수는 기기 폼 팩터에 따라 다릅니다.	자유 텍스트 목록 라벨당 권장 텍스트 크기: 20자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
포스터 이미지	선택사항 (제공되지 않는 경우 항목 라벨을 제공해야 함)	이전 주문에 포함된 항목의 이미지입니다. 우선순위에 따라 최대 10개의 이미지가 제공될 수 있습니다. 표시되는 실제 이미지 수는 기기 폼 팩터에 따라 다릅니다.	자세한 내용은 이미지 사양을 참고하세요.

이미지 사양

이미지 확장 소재의 필수 사양은 다음과 같습니다.

가로세로 비율	최소 픽셀	권장 픽셀
정사각형(1x1) 기본	300x300	1200x1200
가로 모드(1.91x1)	600x314	1200x628
세로 모드(4x5)	480x600	960x1200

가로세로 비율

최소 픽셀

권장 픽셀

정사각형(1x1)

기본

300x300

1200x1200

가로 모드(1.91x1)

600x314

1200x628

세로 모드(4x5)

480x600

960x1200

파일 형식

PNG, JPG, 정적 GIF, WebP

최대 파일 크기

5120KB

추가 권장사항

이미지 안전 영역: 중요한 콘텐츠를 이미지의 중앙 80%에 배치합니다.
이미지가 어두운 테마 설정과 밝은 테마 설정에서 제대로 표시될 수 있도록 투명한 배경을 사용합니다.

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	선택사항	사용자가 전체 맞춤 콘텐츠 목록을 볼 수 있는 파트너 앱의 페이지로 연결되는 딥 링크입니다. 참고: 기여 분석에 딥 링크를 사용할 수 있습니다. 이 FAQ 참고하기

속성

요구사항

설명

ProductEntity, StoreEntity 또는 RecipeEntity의 목록

필수 항목

이 맞춤 콘텐츠 클러스터의 권장사항을 구성하는 항목 목록입니다. 단일 클러스터의 항목은 동일한 유형이어야 합니다.

제목

필수 항목

맞춤 콘텐츠 클러스터의 제목입니다(예: 추수감사절 메뉴 대폭 할인).

권장 텍스트 크기: 25자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)

작업 URI

선택사항

사용자가 전체 맞춤 콘텐츠 목록을 볼 수 있는 파트너 앱의 페이지로 연결되는 딥 링크입니다.

참고: 기여 분석에 딥 링크를 사용할 수 있습니다. 이 FAQ 참고하기

Kotlin


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

Java


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

서비스가 요청을 수신하면 다음 작업이 한 트랜잭션 내에서 발생합니다.

기존의 모든 맞춤 콘텐츠 클러스터 데이터가 삭제됩니다.
요청 데이터가 파싱되어, 새 맞춤 콘텐츠 클러스터에 저장됩니다.

오류가 발생하면 전체 요청이 거부되고 기존 상태가 유지됩니다.

`publishFeaturedCluster`

이 API는 FeaturedCluster 객체를 게시하는 데 사용됩니다.

Kotlin


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

Java


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

서비스가 요청을 수신하면 다음 작업이 한 트랜잭션 내에서 발생합니다.

개발자 파트너의 기존 FeaturedCluster 데이터가 삭제됩니다.
요청 데이터가 파싱되어, 업데이트된 추천 클러스터에 저장됩니다.

오류가 발생하면 전체 요청이 거부되고 기존 상태가 유지됩니다.

`publishFoodShoppingCart`

이 API는 FoodShoppingCart 객체를 게시하는 데 사용됩니다.

Kotlin


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

Java


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

서비스가 요청을 수신하면 다음 작업이 한 트랜잭션 내에서 발생합니다.

개발자 파트너의 기존 FoodShoppingCart 데이터가 삭제됩니다.
요청 데이터가 파싱되어, 업데이트된 장바구니 클러스터에 저장됩니다.

오류가 발생하면 전체 요청이 거부되고 기존 상태가 유지됩니다.

`publishFoodShoppingList`

이 API는 FoodShoppingList 객체를 게시하는 데 사용됩니다.

Kotlin


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

Java


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

서비스가 요청을 수신하면 다음 작업이 한 트랜잭션 내에서 발생합니다.

개발자 파트너의 기존 FoodShoppingList 데이터가 삭제됩니다.
요청 데이터가 파싱되어, 업데이트된 쇼핑 목록 클러스터에 저장됩니다.

오류가 발생하면 전체 요청이 거부되고 기존 상태가 유지됩니다.

`publishReorderCluster`

이 API는 FoodReorderCluster 객체를 게시하는 데 사용됩니다.

Kotlin


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

Java


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

서비스가 요청을 수신하면 다음 작업이 한 트랜잭션 내에서 발생합니다.

개발자 파트너의 기존 FoodReorderCluster 데이터가 삭제됩니다.
요청 데이터가 파싱되어, 업데이트된 재주문 클러스터에 저장됩니다.

오류가 발생하면 전체 요청이 거부되고 기존 상태가 유지됩니다.

`publishUserAccountManagementRequest`

이 API는 로그인 카드를 게시하는 데 사용됩니다. 로그인 작업은 앱이 콘텐츠를 게시하거나 더 맞춤설정된 콘텐츠를 제공할 수 있도록 사용자를 앱의 로그인 페이지로 안내합니다.

다음 메타데이터는 로그인 카드의 일부입니다.

속성	요구사항	설명
작업 URI	필수	작업으로 연결되는 딥 링크(앱 로그인 페이지로 이동)
이미지	선택사항 - 제공되지 않은 경우 제목을 입력해야 합니다.	카드에 표시된 이미지 해상도 1264x712의 16x9 가로세로 비율 이미지
제목	선택사항 - 제공되지 않은 경우 이미지를 제공해야 합니다.	카드상의 제목
작업 텍스트	선택사항	CTA에 표시된 텍스트(로그인)
부제	선택사항	카드의 부제목(선택사항)

Kotlin


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

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

Java


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

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

서비스가 요청을 수신하면 다음 작업이 한 트랜잭션 내에서 발생합니다.

개발자 파트너의 기존 UserAccountManagementCluster 데이터가 삭제됩니다.
요청 데이터가 파싱되어, 업데이트된 UserAccountManagementCluster 클러스터에 저장됩니다.

오류가 발생하면 전체 요청이 거부되고 기존 상태가 유지됩니다.

`updatePublishStatus`

내부적인 이유로 어떠한 클러스터도 게시되지 않는 경우 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를 호출하는 것이 좋습니다.

Kotlin


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

Java


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

`deleteRecommendationClusters`

이 API는 맞춤 콘텐츠 클러스터의 콘텐츠를 삭제하는 데 사용됩니다.

Kotlin


client.deleteRecommendationClusters()

Java


client.deleteRecommendationClusters();

서비스가 요청을 수신하면 맞춤 콘텐츠 클러스터에서 기존 데이터를 삭제합니다. 오류가 발생하면 전체 요청이 거부되고 기존 상태가 유지됩니다.

`deleteFeaturedCluster`

이 API는 추천 클러스터의 콘텐츠를 삭제하는 데 사용됩니다.

Kotlin


client.deleteFeaturedCluster()

Java


client.deleteFeaturedCluster();

서비스가 요청을 수신하면 추천 클러스터에서 기존 데이터를 삭제합니다. 오류가 발생하면 전체 요청이 거부되고 기존 상태가 유지됩니다.

`deleteFoodShoppingCartCluster`

이 API는 식품 장바구니 클러스터의 콘텐츠를 삭제하는 데 사용됩니다.

Kotlin


client.deleteFoodShoppingCartCluster()

Java


client.deleteFoodShoppingCartCluster();

서비스가 요청을 수신하면 식품 장바구니 클러스터에서 기존 데이터를 삭제합니다. 오류가 발생하면 전체 요청이 거부되고 기존 상태가 유지됩니다.

`deleteFoodShoppingListCluster`

이 API는 식품 쇼핑 목록 클러스터의 콘텐츠를 삭제하는 데 사용됩니다.

Kotlin


client.deleteFoodShoppingListCluster()

Java


client.deleteFoodShoppingListCluster();

서비스가 요청을 수신하면 식품 쇼핑 목록 클러스터에서 기존 데이터를 삭제합니다. 오류가 발생하면 전체 요청이 거부되고 기존 상태가 유지됩니다.

`deleteReorderCluster`

이 API는 FoodReorderCluster의 콘텐츠를 삭제하는 데 사용됩니다.

Kotlin


client.deleteReorderCluster()

Java


client.deleteReorderCluster();

서비스가 요청을 수신하면 재주문 클러스터에서 기존 데이터를 삭제합니다. 오류가 발생하면 전체 요청이 거부되고 기존 상태가 유지됩니다.

`deleteUserManagementCluster`

이 API는 UserAccountManagement 클러스터의 콘텐츠를 삭제하는 데 사용됩니다.

Kotlin


client.deleteUserManagementCluster()

Java


client.deleteUserManagementCluster();

서비스가 요청을 수신하면 UserAccountManagement 클러스터에서 기존 데이터를 삭제합니다. 오류가 발생하면 전체 요청이 거부되고 기존 상태가 유지됩니다.

`deleteClusters`

이 API는 특정 클러스터 유형의 콘텐츠를 삭제하는 데 사용됩니다.

Kotlin


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

Java


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> 태그를 사용하여 구현을 정적으로 선언합니다. 이를 통해 애플리케이션이 실행 중이 아닐 때 브로드캐스트 인텐트를 수신할 수 있고, 애플리케이션이 콘텐츠를 게시할 수 있습니다.

<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 개발자 통합 워크플로를 참고하세요.

FAQ

FAQ에 관해서는 Engage SDK 관련 자주 묻는 질문(FAQ)을 참고하세요.

문의

통합 과정에서 궁금한 점이 있으면 engage-developers@google.com으로 문의해 주세요. 지원팀에서 최대한 빨리 답변해 드리겠습니다.

다음 단계

이 통합을 완료한 후 단계는 다음과 같습니다.

engage-developers@google.com으로 Google의 테스트를 받을 준비가 된 통합 APK를 첨부하여 이메일을 보냅니다.
Google에서는 내부적으로 검증 및 검토를 실행하여 통합이 예상대로 작동하는지 확인합니다. 변경이 필요한 경우 Google에서는 필요한 세부정보를 알려 드립니다.
테스트가 완료되고 아무것도 변경할 필요가 없으면 Google에서는 업데이트된 통합 APK를 Play 스토어에 게시할 수 있음을 알려 드립니다.
업데이트된 APK가 Play 스토어에 게시되었음을 Google에서 확인한 후에는 맞춤 콘텐츠, 추천, 장바구니, 쇼핑 목록, 재주문 클러스터가 게시되고 사용자에게 표시됩니다.