Engage SDK Health and Fitness: 서드 파티 기술 통합 안내

Google에서는 사용자의 앱을 카테고리별로 정리하고 맞춤형 앱 콘텐츠 소비와 검색을 위한 새로운 몰입형 환경을 제공하는 기기 내 표시 경로를 구축하고 있습니다. 이 전체 화면 환경을 통해 개발자 파트너는 앱 외부의 전용 채널에서 최고의 리치 콘텐츠를 선보일 수 있습니다.이 가이드에는 개발자 파트너가 Engage SDK를 사용하여 이 새로운 노출 영역을 채우는 방식으로 건강 및 피트니스 콘텐츠를 통합하는 방법에 관한 안내가 포함되어 있습니다.

통합 세부정보

용어

이 통합에는 맞춤 콘텐츠, 추천, 연속이라는 세 가지 클러스터 유형이 포함되어 있습니다.

• 맞춤 콘텐츠 클러스터에는 개별 개발자 파트너의 건강 및 피트니스 추천이 맞춤형으로 표시됩니다. 이러한 추천은 사용자에 맞게 맞춤설정하거나 일반화 (예: 피트니스 및 건강 관련 트렌드)할 수 있습니다. 건강 및 피트니스와 관련된 기사나 인물을 표시할 때 사용합니다.

  • 맞춤 콘텐츠 클러스터는 ArticleEntity, PersonEntity 또는 EventEntity로 구성할 수 있지만 여러 항목 유형을 혼합하여 구성할 수는 없습니다.

  맞춤 콘텐츠의 구조는 다음과 같습니다.

  • 맞춤 콘텐츠 클러스터: 동일한 개발자 파트너의 맞춤 콘텐츠 그룹이 포함된 UI 뷰입니다.

  • 항목: 클러스터에 있는 단일 항목을 나타내는 객체입니다. 이 통합은 맞춤 콘텐츠 클러스터를 사용하여 표시되는 몇 가지 항목을 제공합니다.

    • ArticleEntity: ArticleEntity는 건강 및 피트니스와 관련된 텍스트 기반 콘텐츠의 권장사항을 나타냅니다. 기사, 블로그 게시물, 마케팅 콘텐츠, 뉴스 스니펫 등에 사용할 수 있습니다

      

      그림 1: 맞춤 콘텐츠 클러스터 내의 단일 ArticleEntity를 보여주는 UI

    • PersonEntity: PersonEntity를 의미합니다. 추천은 코치 또는 건강/피트니스 등과 관련된 사람을 강조할 수 있습니다.

      

      그림 2: 맞춤 콘텐츠 클러스터 내의 단일 PersonEntity를 보여주는 UI

    • EventEntity: EventEntity는 미래에 발생하는 이벤트를 나타냅니다. 이벤트 시작 시간은 사용자에게 전달해야 하는 중요한 정보입니다. 이 항목은 헌혈 캠프, 트레이닝 세션, 체육관 또는 요가 수업과 같은 건강 및 피트니스 관련 이벤트를 표시하는 데 사용할 수 있습니다.

      

      그림 3: 맞춤 콘텐츠 클러스터 내의 단일 EventEntity를 보여주는 UI

• 연속 클러스터에는 여러 개발자 파트너의 사용자가 최근에 참여한 콘텐츠가 단일 UI 그룹으로 표시됩니다. 각 개발자 파트너는 연속 클러스터에서 최대 10개의 항목을 브로드캐스트할 수 있습니다.

  연속 콘텐츠의 구조는 다음과 같습니다.

  • ArticleEntity: ArticleEntity는 건강 및 피트니스와 관련된 텍스트 기반 콘텐츠의 권장사항을 나타냅니다. 이 항목은 아직 끝나지 않은 뉴스 기사나 사용자가 중단한 부분부터 계속 소비하고 싶어 하는 기타 콘텐츠를 나타내는 데 사용할 수 있습니다. 예: 건강 또는 피트니스 관련 주제에 관한 뉴스 스니펫, 블로그 게시물 스니펫

    

    그림 6. 연속 클러스터 내의 단일 ArticleEntity를 보여주는 UI입니다.

  • EventBookingEntity: EventBookingEntity는 이벤트 예약을 나타내며 예정되어 있거나 진행 중인 피트니스 및 건강 이벤트 예약을 사용자가 추적하는 데 도움이 됩니다. 예: 교육 세션

    

    그림 8. 연속 클러스터 내의 단일 EventSchedulingEntity를 보여주는 UI입니다.

• 추천 클러스터는 여러 개발자 파트너의 선택된 히어로 GenericFeaturedEntity를 하나의 UI 그룹으로 보여주는 UI 뷰입니다. 추천 클러스터는 1개가 UI 상단에 표시되며 모든 맞춤 콘텐츠 클러스터보다 우선순위가 높습니다. 각 개발자 파트너는 추천 클러스터에 있는 여러 앱 개발자의 많은 항목 (다양한 유형일 수 있음)과 함께 추천 클러스터에서 지원되는 유형의 단일 항목을 브로드캐스트할 수 있습니다.

  • GenericFeaturedEntity: GenericFeaturedEntity는 추천 항목과 다릅니다. 추천 상품은 개발자의 인기 콘텐츠 한 개에 사용되어야 하고 사용자에게 흥미롭고 관련성이 있는 가장 중요한 단일 콘텐츠를 나타내야 합니다.

    

    그림 12: 추천 클러스터 내의 단일 히어로 GenericFeaturedEntity 카드를 보여주는 UI

사전 작업

최소 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.1'
}

요약

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

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

클러스터 유형	클러스터 제한	클러스터의 최소 항목 제한	클러스터의 최대 항목 제한
맞춤 콘텐츠 클러스터	최대 5개	5개 이상	최대 25개(ArticleEntity, PersonEntity 또는 EventEntity)
연속 클러스터	최대 1개	1개 이상	최대 10개 (ArticleEntity 또는 EventReservationEntity)
추천 클러스터	최대 1개	1개 이상	최대 10개 (GenericFeaturedEntity)

1단계: 항목 데이터 제공

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

1. GenericFeaturedEntity
2. ArticleEntity
3. PersonEntity
4. EventEntity
5. EventReservationEntity

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

GenericFeaturedEntity

속성	요구사항	설명	형식
작업 URI	필수 항목	제공업체 앱의 항목으로 연결되는 딥 링크입니다. 참고: 기여 분석에 딥 링크를 사용할 수 있습니다. 이 FAQ 참고	URI
포스터 이미지	필수 항목	여러 이미지가 제공된 경우 1개의 이미지만 표시됩니다. 권장 가로세로 비율은 16:9입니다. 참고: 배지가 제공되는 경우 이미지 상단과 하단 모두 24dps의 안전한 공간을 확보하세요.	자세한 내용은 이미지 사양을 참고하세요.
제목	선택사항	항목의 제목입니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 50자(영문 기준)
설명	선택사항	항목을 설명하는 단일 텍스트 단락입니다. 참고: 설명 또는 부제목 목록 중 하나만 사용자에게 표시됩니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 180자(영문 기준)
자막 목록	선택사항	최대 3개의 자막(각 자막에 한 줄의 텍스트 포함) 참고: 설명 또는 부제목 목록 중 하나만 사용자에게 표시됩니다.	자유 형식의 텍스트로 표시합니다. 각 부제목의 권장 텍스트 크기: 최대 50자(영문 기준)
배지	선택사항	각 배지는 무료 텍스트 (영문 기준 최대 15자) 또는 작은 이미지입니다. 이미지/동영상 상단의 특별한 UX 처리(예: 이미지에 배지 오버레이) 예: '실시간 업데이트' 예: 기사 읽기 시간
배지 - 텍스트	선택사항	배지 제목 참고: 배지에는 텍스트 또는 이미지가 필요합니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 15자(영문 기준)
배지 - 이미지	선택사항	Small image 특수한 UX 처리(예: 이미지/동영상 썸네일에 배지 오버레이) 참고: 배지에는 텍스트 또는 이미지가 필요합니다.	자세한 내용은 이미지 사양을 참고하세요.
컨텐츠 카테고리	선택사항	항목의 콘텐츠 카테고리를 설명하세요.	enum 목록 자세한 내용은 콘텐츠 카테고리 섹션을 참고하세요.

ArticleEntity

속성	요구사항	설명	형식
작업 URI	필수 항목	제공업체 앱의 항목으로 연결되는 딥 링크입니다. 참고: 기여 분석에 딥 링크를 사용할 수 있습니다. 이 FAQ 참고	URI
제목	필수 항목	항목의 제목입니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 50자(영문 기준)
포스터 이미지	선택사항	여러 이미지가 제공된 경우 1개의 이미지만 표시됩니다. 권장 가로세로 비율은 16:9입니다. 참고: 이미지를 사용하는 것이 좋습니다. 배지가 제공되는 경우 이미지 상단과 하단 모두 24dps의 안전한 공간을 확보합니다.	자세한 내용은 이미지 사양을 참고하세요.
출처 - 제목	선택사항	작성자, 조직 또는 기자의 이름	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 25자(영문 기준) 미만
출처 - 이미지	선택사항	저자, 조직, 기자 등 출처의 이미지	자세한 내용은 이미지 사양을 참고하세요.
설명	선택사항	항목을 설명하는 단일 텍스트 단락입니다. 참고: 설명 또는 부제목 목록 중 하나만 사용자에게 표시됩니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 180자(영문 기준)
자막 목록	선택사항	최대 3개의 자막(각 자막에 한 줄의 텍스트 포함) 참고: 설명 또는 부제목 목록 중 하나만 사용자에게 표시됩니다.	자유 형식의 텍스트로 표시합니다. 각 부제목의 권장 텍스트 크기: 최대 50자(영문 기준)
배지	선택사항	각 배지는 무료 텍스트 (영문 기준 최대 15자) 또는 작은 이미지입니다. 이미지/동영상 상단의 특별한 UX 처리(예: 이미지에 배지 오버레이) 예: '실시간 업데이트' 예: 기사 읽기 시간
배지 - 텍스트	선택사항	배지 제목 참고: 배지에는 텍스트 또는 이미지가 필요합니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 15자(영문 기준)
배지 - 이미지	선택사항	Small image 특수한 UX 처리(예: 이미지/동영상 썸네일에 배지 오버레이) 참고: 배지에는 텍스트 또는 이미지가 필요합니다.	자세한 내용은 이미지 사양을 참고하세요.
콘텐츠 게시 시간	선택사항	앱에서 콘텐츠가 게시 / 업데이트된 시점의 에포크 타임스탬프(밀리초)입니다.	에포크 타임스탬프(밀리초)
최근 참여 시간	조건부 필수	사용자가 마지막으로 이 항목과 상호작용한 때의 에포크 타임스탬프(밀리초)입니다. 참고: 이 항목은 이 항목이 연속 클러스터의 일부인 경우에 필수입니다.	에포크 타임스탬프(밀리초)
진행률	조건부 필수	현재까지 사용자가 소비한 전체 콘텐츠의 비율입니다. 참고: 이 항목은 이 항목이 연속 클러스터의 일부인 경우에 필수입니다.	0 이상 100 이하의 int 값입니다.
컨텐츠 카테고리	선택사항	항목의 콘텐츠 카테고리를 설명하세요.	enum 목록 자세한 내용은 콘텐츠 카테고리 섹션을 참고하세요.

PersonEntity

속성	요구사항	설명	형식
작업 URI	필수 항목	제공업체 앱의 항목으로 연결되는 딥 링크입니다. 참고: 기여 분석에 딥 링크를 사용할 수 있습니다. 이 FAQ 참고	URI
프로필 - 이름	필수 항목	프로필 이름 또는 ID 또는 핸들(예: 'John Doe', '@TeamPixel' 등)	문자열 권장 텍스트 크기: 최대 50자(영문 기준)
프로필 - 아바타	필수 항목	사용자의 프로필 사진 또는 아바타 이미지입니다. 참고: 정사각형 1:1 이미지여야 합니다.	자세한 내용은 이미지 사양을 참고하세요.
프로필 - 추가 텍스트	선택사항	프로필 핸들과 같은 자유 텍스트입니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 15자(영문 기준)
프로필 - 추가 이미지	선택사항	인증 배지와 같은 작은 이미지입니다.	자세한 내용은 이미지 사양을 참고하세요.
헤더 이미지	선택사항	여러 이미지가 제공된 경우 1개의 이미지만 표시됩니다. 권장 가로세로 비율은 16:9입니다. 참고: 이미지를 사용하는 것이 좋습니다. 배지가 제공되는 경우 이미지 상단과 하단 모두 24dps의 안전한 공간을 확보합니다.	자세한 내용은 이미지 사양을 참고하세요.
인기도 - 횟수	선택사항	헤더 이미지를 나타냅니다. 프로필 이미지와 달라야 합니다. 이 방법은 인물이 하는 일을 좋아하는 것을 강조하는 데 도움이 되는 추가 이미지가 있는 경우 사용할 수 있습니다. 참고: 16:9 이미지여야 합니다. 배지가 제공되는 경우 이미지 상단과 하단 모두 24dps의 안전한 공간을 확보합니다.	문자열 권장 텍스트 크기: 개수 + 라벨을 합친 최대 20자(영문 기준)
인기도 - 횟수 값	선택사항	팔로어 수 또는 인기도 값입니다. 참고: 앱에서 많은 수를 다양한 디스플레이 크기에 맞게 최적화하는 방법에 관한 로직을 처리하지 않으려면 개수 값을 제공하세요. 개수 및 개수 값을 모두 제공하면 개수가 사용됩니다.	Long
인기도 - 라벨	선택사항	인기도 라벨이 무엇인지 나타냅니다(예: '좋아요').	문자열 권장 텍스트 크기: 개수 + 라벨을 합친 최대 20자(영문 기준)
인기도 - 시각적	선택사항	상호작용의 목적을 나타냅니다. 좋아요 아이콘, 그림 이모티콘을 보여주는 이미지를 예로 들 수 있습니다. 2개 이상의 이미지를 제공할 수 있지만 모든 폼 팩터에서 표시되는 것은 아닙니다. 참고: 정사각형 1:1 이미지여야 합니다.	자세한 내용은 이미지 사양을 참고하세요.
평점 - 최댓값	필수	평가 척도의 최댓값입니다. 현재 평점 값도 제공되는 경우 제공해야 합니다.	0.0보다 크거나 같은 숫자
평점 - 현재 값	필수	평가 척도의 현재 값입니다. 평점 최댓값도 제공되는 경우 제공해야 합니다.	0.0보다 크거나 같은 숫자
평점 - 개수	선택사항	항목의 평점 수입니다. 참고: 앱에서 사용자에게 표시되는 방식을 제어하려는 경우 이 필드를 제공합니다. 사용자에게 표시될 수 있는 간결한 문자열을 제공하세요. 예를 들어 개수가 1,000,000개라면 작은 디스플레이 크기에서 잘리지 않도록 1M과 같은 약어를 사용하는 것이 좋습니다.	문자열
등급 - 개수 값	선택사항	항목의 평점 수입니다. 참고: 약어 표시 로직을 직접 처리하지 않으려면 이 필드를 제공합니다. 개수 및 개수 값이 모두 있는 경우 집계를 사용하여 사용자에게 표시합니다.	Long
위치 - 국가	선택사항	개인이 거주하거나 서비스를 제공하는 국가입니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 도시	선택사항	개인이 거주하거나 서비스를 제공하는 도시입니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 표시 주소	선택사항	그 사람이 거주하거나 서비스를 제공하는 곳의 주소가 사용자에게 표시됩니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 상세 주소	선택사항	개인이 거주하거나 서비스를 제공하는 상세 주소입니다 (해당하는 경우).	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 주	선택사항	개인이 거주하거나 서비스를 제공하는 주입니다 (해당하는 경우).	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 우편번호	선택사항	개인이 거주하거나 서비스를 제공하는 지역의 우편번호입니다 (해당하는 경우).	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 동네	선택사항	개인이 거주하거나 서비스를 제공하는 동네입니다 (해당하는 경우).	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
배지	선택사항	각 배지는 무료 텍스트 (영문 기준 최대 15자) 또는 작은 이미지입니다.
배지 - 텍스트	선택사항	배지 제목 참고: 배지에는 텍스트 또는 이미지가 필요합니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 15자(영문 기준)
배지 - 이미지	선택사항	Small image 특수한 UX 처리(예: 이미지/동영상 썸네일에 배지 오버레이) 참고: 배지에는 텍스트 또는 이미지가 필요합니다.	자세한 내용은 이미지 사양을 참고하세요.
설명	선택사항	항목을 설명하는 단일 텍스트 단락입니다. 참고: 설명 또는 부제목 목록 중 하나만 사용자에게 표시됩니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 180자(영문 기준)
자막 목록	선택사항	최대 3개의 자막(각 자막에 한 줄의 텍스트 포함) 참고: 설명 또는 부제목 목록 중 하나만 사용자에게 표시됩니다.	자유 형식의 텍스트로 표시합니다. 각 부제목의 권장 텍스트 크기: 최대 50자(영문 기준)
컨텐츠 카테고리	선택사항	항목의 콘텐츠 카테고리를 설명하세요.	사용 가능한 enum 목록 TYPE_HEALTH_AND_FITENESS (예: 요가/피트니스 트레이너) TYPE_HOME_AND_AUTO (예: 배관공) TYPE_SPORTS (예: 플레이어) TYPE_DATING 자세한 내용은 콘텐츠 카테고리 섹션을 참고하세요.

EventEntity

속성	요구사항	설명	형식
작업 URI	필수 항목	제공업체 앱의 항목으로 연결되는 딥 링크입니다. 참고: 기여 분석에 딥 링크를 사용할 수 있습니다. 이 FAQ 참고	URI
제목	필수 항목	항목의 제목입니다.	문자열 권장 텍스트 크기: 최대 50자(영문 기준)
시작 시간	필수 항목	이벤트가 시작될 것으로 예상되는 에포크 타임스탬프입니다. 참고: 밀리초 단위로 표시됩니다.	에포크 타임스탬프(밀리초)
활동 모드	필수 항목	이벤트가 가상인지, 오프라인인지, 아니면 둘 다인지를 나타내는 필드입니다.	열거형: VIRTUAL, IN_PERSON 또는 HYBRID
포스터 이미지	필수 항목	여러 이미지가 제공된 경우 1개의 이미지만 표시됩니다. 권장 가로세로 비율은 16:9입니다. 참고: 이미지를 사용하는 것이 좋습니다. 배지가 제공되는 경우 이미지 상단과 하단 모두 24dps의 안전한 공간을 확보합니다.	자세한 내용은 이미지 사양을 참고하세요.
위치 - 국가	조건부 필수	이벤트가 열리는 국가입니다. 참고: IN_PERSON 또는 HYBRID인 이벤트에 필요합니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 도시	조건부 필수	이벤트가 열리는 도시입니다. 참고: IN_PERSON 또는 HYBRID인 이벤트에 필요합니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 표시 주소	조건부 필수	이벤트가 열리는 주소 또는 장소 이름으로, 사용자에게 표시되어야 합니다. 참고: IN_PERSON 또는 HYBRID인 이벤트에 필요합니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 상세 주소	선택사항	이벤트가 호스팅되는 위치의 상세 주소입니다 (해당하는 경우).	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 주	선택사항	이벤트가 호스팅되는 주 또는 도입니다 (해당하는 경우).	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 우편번호	선택사항	이벤트가 호스팅되는 위치의 우편번호입니다 (해당하는 경우).	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 동네	선택사항	이벤트가 개최되는 인근 지역입니다 (해당하는 경우).	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
종료 시간	선택사항	이벤트가 종료될 것으로 예상되는 에포크 타임스탬프입니다. 참고: 밀리초 단위로 표시됩니다.	에포크 타임스탬프(밀리초)
설명	선택사항	항목을 설명하는 단일 텍스트 단락입니다. 참고: 설명 또는 부제목 목록 중 하나만 사용자에게 표시됩니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 180자(영문 기준)
자막 목록	선택사항	최대 3개의 자막(각 자막에 한 줄의 텍스트 포함) 참고: 설명 또는 부제목 목록 중 하나만 사용자에게 표시됩니다.	자유 형식의 텍스트로 표시합니다. 각 부제목의 권장 텍스트 크기: 최대 50자(영문 기준)
배지	선택사항	각 배지는 무료 텍스트 (영문 기준 최대 15자) 또는 작은 이미지입니다.
배지 - 텍스트	선택사항	배지 제목 참고: 배지에는 텍스트 또는 이미지가 필요합니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 15자(영문 기준)
배지 - 이미지	선택사항	Small image 특수한 UX 처리(예: 이미지/동영상 썸네일에 배지 오버레이) 참고: 배지에는 텍스트 또는 이미지가 필요합니다.	자세한 내용은 이미지 사양을 참고하세요.
가격 - 현재 가격	조건부 필수	이벤트 티켓/패스의 현재 가격입니다. 취소선 가격을 제공한 경우 입력해야 합니다.	자유 형식의 텍스트로 표시합니다.
가격 - STP(StrikethroughPrice)	선택사항	이벤트 티켓/패스의 원래 가격입니다.	자유 형식의 텍스트로 표시합니다.
가격 콜아웃	선택사항	프로모션, 이벤트, 회원 할인을 표시하는 가격 콜아웃이 있는 경우 이를 표시합니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 45자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
컨텐츠 카테고리	선택사항	항목의 콘텐츠 카테고리를 설명하세요.	사용 가능한 enum 목록 TYPE_MovieS_AND_TV_SHOWS (예: 영화) TYPE_DIGITAL_GAMES (예: e스포츠) TYPE_MUSIC (예: 콘서트) TYPE_TRAVEL_AND_LOCAL (예: 투어, 페스티벌) TYPE_HEALTH_AND_FITENESS (예: 요가 수업) TYPE_EDUCATION (예: 수업) TYPE_SPORTS (예: 미식축구 게임) TYPE_DATING (예: 모임) 자세한 내용은 콘텐츠 카테고리 섹션을 참고하세요.

EventReservationEntity

속성	요구사항	설명	형식
작업 URI	필수 항목	제공업체 앱의 항목으로 연결되는 딥 링크입니다. 참고: 기여 분석에 딥 링크를 사용할 수 있습니다. 이 FAQ 참고	URI
제목	필수 항목	항목의 제목입니다.	문자열 권장 텍스트 크기: 최대 50자(영문 기준)
시작 시간	필수 항목	이벤트가 시작될 것으로 예상되는 에포크 타임스탬프입니다. 참고: 밀리초 단위로 표시됩니다.	에포크 타임스탬프(밀리초)
활동 모드	필수 항목	이벤트가 가상인지, 오프라인인지, 아니면 둘 다인지를 나타내는 필드입니다.	열거형: VIRTUAL, IN_PERSON 또는 HYBRID
위치 - 국가	조건부 필수	이벤트가 열리는 국가입니다. 참고: IN_PERSON 또는 HYBRID인 이벤트에 필요합니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 도시	조건부 필수	이벤트가 열리는 도시입니다. 참고: IN_PERSON 또는 HYBRID인 이벤트에 필요합니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 표시 주소	조건부 필수	이벤트가 열리는 주소 또는 장소 이름으로, 사용자에게 표시되어야 합니다. 참고: IN_PERSON 또는 HYBRID인 이벤트에 필요합니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 상세 주소	선택사항	이벤트가 호스팅되는 위치의 상세 주소입니다 (해당하는 경우).	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 주	선택사항	이벤트가 호스팅되는 주 또는 도입니다 (해당하는 경우).	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 우편번호	선택사항	이벤트가 호스팅되는 위치의 우편번호입니다 (해당하는 경우).	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
위치 - 동네	선택사항	이벤트가 개최되는 인근 지역입니다 (해당하는 경우).	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 20자(영문 기준)
포스터 이미지	선택사항	여러 이미지가 제공된 경우 1개의 이미지만 표시됩니다. 권장 가로세로 비율은 16:9입니다. 참고: 이미지를 사용하는 것이 좋습니다. 배지가 제공되는 경우 이미지 상단과 하단 모두 24dps의 안전한 공간을 확보합니다.	자세한 내용은 이미지 사양을 참고하세요.
종료 시간	선택사항	이벤트가 종료될 것으로 예상되는 에포크 타임스탬프입니다. 참고: 밀리초 단위로 표시됩니다.	에포크 타임스탬프(밀리초)
서비스 제공업체 - 이름	선택사항	서비스 제공업체의 이름입니다. 참고: 서비스 제공업체에는 텍스트 또는 이미지가 모두 필요합니다.	자유 텍스트입니다. 예: 이벤트 주최자/투어 이름
서비스 제공업체 - 이미지	선택사항	서비스 제공업체의 로고/이미지입니다. 참고: 서비스 제공업체에는 텍스트 또는 이미지가 모두 필요합니다.	자세한 내용은 이미지 사양을 참고하세요.
설명	선택사항	항목을 설명하는 단일 텍스트 단락입니다. 참고: 설명 또는 부제목 목록 중 하나만 사용자에게 표시됩니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 180자(영문 기준)
자막 목록	선택사항	최대 3개의 자막(각 자막에 한 줄의 텍스트 포함) 참고: 설명 또는 부제목 목록 중 하나만 사용자에게 표시됩니다.	자유 형식의 텍스트로 표시합니다. 각 부제목의 권장 텍스트 크기: 최대 50자(영문 기준)
배지	선택사항	각 배지는 무료 텍스트 (영문 기준 최대 15자) 또는 작은 이미지입니다.
배지 - 텍스트	선택사항	배지 제목 참고: 배지에는 텍스트 또는 이미지가 필요합니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 최대 15자(영문 기준)
배지 - 이미지	선택사항	Small image 특수한 UX 처리(예: 이미지/동영상 썸네일에 배지 오버레이) 참고: 배지에는 텍스트 또는 이미지가 필요합니다.	자세한 내용은 이미지 사양을 참고하세요.
예약 ID	선택사항	이벤트 예약의 예약 ID입니다.	자유 형식의 텍스트로 표시합니다.
가격 - 현재 가격	조건부 필수	이벤트 티켓/패스의 현재 가격입니다. 취소선 가격을 제공한 경우 입력해야 합니다.	자유 형식의 텍스트로 표시합니다.
가격 - STP(StrikethroughPrice)	선택사항	이벤트 티켓/패스의 원래 가격입니다.	자유 형식의 텍스트로 표시합니다.
가격 콜아웃	선택사항	프로모션, 이벤트, 회원 할인을 표시하는 가격 콜아웃이 있는 경우 이를 표시합니다.	자유 형식의 텍스트로 표시합니다. 권장 텍스트 크기: 45자(영문 기준) 미만(텍스트가 너무 길면 생략 부호가 표시될 수 있음)
평점 - 최댓값	선택사항	평가 척도의 최댓값입니다. 현재 평점 값도 제공되는 경우 제공해야 합니다.	0.0보다 크거나 같은 숫자
평점 - 현재 값	선택사항	평가 척도의 현재 값입니다. 평점 최댓값도 제공되는 경우 제공해야 합니다.	0.0보다 크거나 같은 숫자
평점 - 개수	선택사항	이벤트 평점 수입니다. 참고: 앱에서 사용자에게 표시되는 방식을 제어하려는 경우 이 필드를 제공합니다. 사용자에게 표시될 수 있는 간결한 문자열을 제공하세요. 예를 들어 개수가 1,000,000개라면 작은 디스플레이 크기에서 잘리지 않도록 1M과 같은 약어를 사용하는 것이 좋습니다.	문자열
등급 - 개수 값	선택사항	이벤트 평점 수입니다. 참고: 약어 표시 로직을 직접 처리하지 않으려면 이 필드를 제공합니다. 개수 및 개수 값이 모두 있는 경우 집계를 사용하여 사용자에게 표시합니다.	Long
컨텐츠 카테고리	선택사항	항목의 콘텐츠 카테고리를 설명하세요.	사용 가능한 enum 목록 TYPE_MovieS_AND_TV_SHOWS (예: 영화) TYPE_DIGITAL_GAMES (예: e스포츠) TYPE_MUSIC (예: 콘서트) TYPE_TRAVEL_AND_LOCAL (예: 투어, 페스티벌) TYPE_HEALTH_AND_FITENESS (예: 요가 수업) TYPE_EDUCATION (예: 수업) TYPE_SPORTS (예: 미식축구 게임) TYPE_DATING (예: 모임) 자세한 내용은 콘텐츠 카테고리 섹션을 참고하세요.

이미지 사양

이미지 확장 소재의 필수 사양은 다음 표에 나와 있습니다.

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

Google이 액세스할 수 있도록 공개 CDN에 이미지를 호스팅해야 합니다.

파일 형식

PNG, JPG, 정적 GIF, WebP

최대 파일 크기

5120KB

추가 권장사항

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

콘텐츠 카테고리

콘텐츠 카테고리를 사용하면 앱이 여러 카테고리에 속하는 콘텐츠를 게시할 수 있습니다. 이렇게 하면 콘텐츠가 다음과 같이 사전 정의된 카테고리 중 일부와 매핑됩니다.

• TYPE_EDUCATION
• TYPE_SPORTS
• TYPE_MOVIES_AND_TV_SHOWS
• TYPE_BOOKS
• TYPE_AUDIOBOOKS
• TYPE_MUSIC
• TYPE_DIGITAL_GAMES
• TYPE_TRAVEL_AND_LOCAL
• TYPE_HOME_AND_AUTO
• TYPE_BUSINESS
• TYPE_NEWS
• TYPE_FOOD_AND_DRINK
• TYPE_SHOPPING
• TYPE_HEALTH_AND_FITENESS
• TYPE_MEDICAL
• TYPE_PARENTING
• TYPE_DATING

Google이 액세스할 수 있도록 공개 CDN에 이미지를 호스팅해야 합니다.

콘텐츠 카테고리 사용 가이드라인

1. ArticleEntity, GenericFeaturedEntity와 같은 일부 항목은 모든 콘텐츠 카테고리를 사용할 수 있습니다. EventEntity, EventBookingEntity, PersonEntity와 같은 다른 항목의 경우 이러한 카테고리의 하위 집합만 사용할 수 있습니다. 목록을 채우기 전에 항목 유형에 적합한 카테고리 목록을 확인합니다.

2. 일반 항목과 ContentCategory의 조합 대신 일부 콘텐츠 카테고리에 특정 항목 유형을 사용합니다.

   • TYPE_moviesS_AND_TV_SHOWS - 일반 항목을 사용하기 전에 보기 통합 가이드의 항목을 확인하세요.
   • TYPE_BOOKS - 일반 항목을 사용하기 전에 EbookEntity를 확인합니다.
   • TYPE_AUDIOBOOKS - 일반 항목을 사용하기 전에 AudiobookEntity를 확인합니다.
   • TYPE_SHOPPING - 일반 항목을 사용하기 전에 ShoppingEntity를 확인합니다.
   • TYPE_FOOD_AND_DRINK - 일반 항목을 사용하기 전에 음식 통합 가이드의 항목을 확인합니다.

3. ContentCategory 필드는 선택사항이며, 콘텐츠가 앞서 언급한 카테고리에 속하지 않는 경우 비워 두어야 합니다.

4. 여러 콘텐츠 카테고리가 제공된 경우 가장 관련성 높은 콘텐츠 카테고리가 목록에서 가장 먼저 표시되도록 콘텐츠와의 관련성 순으로 제공합니다.

2단계: 클러스터 데이터 제공

콘텐츠 게시 작업을 백그라운드에서 실행하고(예: WorkManager 사용) 정기적으로 또는 이벤트를 기반으로 예약하는 것이 좋습니다(예: 사용자가 앱을 열 때마다 또는 사용자가 장바구니에 상품을 추가했을 때).

AppEngagePublishClient는 클러스터 게시를 담당합니다.

클라이언트에서 클러스터를 게시하는 API는 다음과 같습니다.

• isServiceAvailable
• publishRecommendationClusters
• publishFeaturedCluster
• publishContinuationCluster
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteFeaturedCluster
• deleteContinuationCluster
• 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.
    }
});

참고: 나중에 서비스가 제공되는지 확인하기 위해 주기적 작업을 계속 실행하는 것이 좋습니다. 서비스의 사용 가능 여부는 Android 버전 업그레이드와 앱 업그레이드, 설치, 제거에 따라 달라질 수 있습니다. 특정 시간 간격으로 주기적인 작업 확인을 보장하면 서비스가 제공되었을 때 데이터를 게시할 수 있습니다.

publishRecommendationClusters

이 API는 RecommendationCluster 객체 목록을 게시하는 데 사용됩니다.

중요: 게시 API는 upsert API입니다. 기존 콘텐츠를 대체합니다. 이후에 삭제 및 게시 API를 호출하여 콘텐츠를 대체하지 마세요. 게시 API가 기본적으로 이 작업을 실행합니다.

Kotlin

client.publishRecommendationClusters(
      PublishRecommendationClustersRequest.Builder()
        .addRecommendationCluster(
          RecommendationCluster.Builder()
            .addEntity(entity1)
            .addEntity(entity2)
            .setTitle("Top Picks For You")
            .build()
        )
        .build()
    )

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Top Picks For You")
                        .build())
                .build());

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

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

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

publishFeaturedCluster

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

중요: 게시 API는 upsert API입니다. 기존 콘텐츠를 대체합니다. 이후에 삭제 및 게시 API를 호출하여 콘텐츠를 대체하지 마세요. 게시 API가 기본적으로 이 작업을 실행합니다.

Kotlin

client.publishFeaturedCluster(
    PublishFeaturedClusterRequest.Builder()
      .setFeaturedCluster(
        FeaturedCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

Java

client.publishFeaturedCluster(
            new PublishFeaturedClustersRequest.Builder()
                .addFeaturedCluster(
                    new FeaturedCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

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

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

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

publishContinuationCluster

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

중요: 게시 API는 upsert API입니다. 기존 콘텐츠를 대체합니다. 이후에 삭제 및 게시 API를 호출하여 콘텐츠를 대체하지 마세요. 게시 API가 기본적으로 이 작업을 실행합니다.

Kotlin

client.publishContinuationCluster(
    PublishContinuationClusterRequest.Builder()
      .setContinuationCluster(
        ContinuationCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

Java

client.publishContinuationCluster(
            new PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    new ContinuationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

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

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

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

publishUserAccountManagementRequest

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

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

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

중요: 게시 API는 upsert API입니다. 기존 콘텐츠를 대체합니다. 이후에 삭제 및 게시 API를 호출하여 콘텐츠를 대체하지 마세요. 게시 API가 기본적으로 이 작업을 실행합니다.

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는 맞춤 콘텐츠 클러스터의 콘텐츠를 삭제하는 데 사용됩니다.

중요: 삭제 API는 게시할 콘텐츠가 없는 경우에만 호출해야 합니다. 이후에 삭제 및 게시 API를 호출하여 콘텐츠를 대체하지 마세요. 게시 API가 기본적으로 이 작업을 실행합니다. 삭제 API를 사용하기 전에 engage-developers@에 문의하세요.

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

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

참고: 이 API는 버전 1.1.0부터 사용할 수 있습니다.

deleteFeaturedCluster

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

중요: 삭제 API는 게시할 콘텐츠가 없는 경우에만 호출해야 합니다. 이후에 삭제 및 게시 API를 호출하여 콘텐츠를 대체하지 마세요. 게시 API가 기본적으로 이 작업을 실행합니다. 삭제 API를 사용하기 전에 engage-developers@에 문의하세요.

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

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

참고: 이 API는 버전 1.1.0부터 사용할 수 있습니다.

deleteContinuationCluster

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

중요: 삭제 API는 게시할 콘텐츠가 없는 경우에만 호출해야 합니다. 이후에 삭제 및 게시 API를 호출하여 콘텐츠를 대체하지 마세요. 게시 API가 기본적으로 이 작업을 실행합니다. 삭제 API를 사용하기 전에 engage-developers@에 문의하세요.

Kotlin

client.deleteContinuationCluster()

Java

client.deleteContinuationCluster();

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

참고: 이 API는 버전 1.1.0부터 사용할 수 있습니다.

deleteUserManagementCluster

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

중요: 삭제 API는 게시할 콘텐츠가 없는 경우에만 호출해야 합니다. 이후에 삭제 및 게시 API를 호출하여 콘텐츠를 대체하지 마세요. 게시 API가 기본적으로 이 작업을 실행합니다. 삭제 API를 사용하기 전에 engage-developers@에 문의하세요.

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

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

참고: 이 API는 버전 1.1.0부터 사용할 수 있습니다.

deleteClusters

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

중요: 삭제 API는 게시할 콘텐츠가 없는 경우에만 호출해야 합니다. 이후에 삭제 및 게시 API를 호출하여 콘텐츠를 대체하지 마세요. 게시 API가 기본적으로 이 작업을 실행합니다. 삭제 API를 사용하기 전에 engage-developers@에 문의하세요.

Kotlin

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

Java

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

서비스가 요청을 수신하면 지정된 클러스터 유형과 일치하는 모든 클러스터에서 기존 데이터가 삭제됩니다. 클라이언트는 하나 이상의 클러스터 유형을 전달하도록 선택할 수 있습니다. 오류가 발생하면 전체 요청이 거부되고 기존 상태가 유지됩니다.

오류 처리

후속 작업을 실행하여 성공적인 작업을 복구하고 다시 제출할 수 있도록 게시 API의 작업 결과를 수신 대기하는 것이 좋습니다.

Kotlin

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

Java

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 클래스의 인스턴스를 동적으로 등록합니다. 이렇게 하면 여전히 메모리에 있는 애플리케이션의 통신이 가능해집니다.

Kotlin

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
  // is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
  // Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
  // received
}

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

// Register Recommendation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION))

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED))

// Register Continuation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION))
}

Java

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 continuation cluster publish when PUBLISH_CONTINUATION 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 Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION));

}

• 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.PUBLISH_CONTINUATION" />
      </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.PUBLISH_CONTINUATION 이 인텐트를 수신할 때 publishContinuationCluster 호출을 시작하는 것이 좋습니다.

통합 워크플로

통합 완료 후 통합 확인에 관한 단계별 안내는 Engage 개발자 통합 워크플로를 참고하세요.

FAQ

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

문의

통합 과정에서 궁금한 점이 있으면 [e-mail]으로 문의해 주세요.

다음 단계

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

• [e-mail]으로 Google의 테스트를 위한 통합 APK를 첨부하여 이메일을 보냅니다.
• Google은 내부적으로 인증 및 검토를 실행하여 통합이 예상대로 작동하는지 확인합니다. 변경이 필요한 경우 Google에서는 필요한 세부정보와 함께 연락을 드립니다.
• 테스트가 완료되고 아무것도 변경할 필요가 없으면 Google에서는 업데이트된 통합 APK를 Play 스토어에 게시할 수 있음을 알려 드립니다.
• 업데이트된 APK가 Play 스토어에 게시되었음을 Google에서 확인한 후에는 맞춤 콘텐츠, 추천, 연속 클러스터가 게시되고 사용자에게 표시될 수 있습니다.