Hightouch Personalization API

Hightouch의 Personalization API는 클라우드 데이터 웨어하우스 내의 모든 데이터셋을 기반으로 저지연 데이터 API를 호스팅할 수 있는 관리형 서비스입니다.

Braze와 Hightouch 통합을 사용하면 Braze 연결된 콘텐츠와 함께 API를 활용하여 발송 시점에 최신 고객 또는 오브젝트 데이터를 Campaigns 또는 Canvases로 가져올 수 있습니다.

Hightouch의 Personalization API는 Braze 구성 내에서 사용할 수 있는 REST 엔드포인트를 제공합니다. 구체적으로, Braze 연결된 콘텐츠 기능을 사용하여 Personalization API에 GET 요청을 보내 특정 식별자와 관련된 모든 정보를 검색할 수 있습니다. 이 API를 통해 노출되는 데이터는 고객, 제품 또는 기타 오브젝트 데이터를 나타낼 수 있습니다.

필수 조건

• 활용 사례
• 데이터셋

통합

1단계: Hightouch에 데이터 소스 연결

Hightouch 소스는 조직의 비즈니스 데이터가 저장된 곳입니다. 이 경우 사용자 데이터가 저장된 곳이 됩니다.

1. Hightouch에서 Sources Overview > Add Source로 이동합니다. 데이터 웨어하우스를 소스로 선택합니다.
   
   
2. 관련 자격 증명을 입력합니다. 이는 소스에 따라 다릅니다.

자세한 내용은 관련 소스 설명서를 참조하세요.

2단계: 데이터 모델링

Hightouch 모델은 소스에서 가져올 데이터를 정의합니다. 새 모델을 설정하려면 다음 단계를 따르세요:

1. Hightouch에서 Models overview > Add model로 이동하고, 방금 연결한 소스를 선택합니다.
   
   
2. 다음으로, 모델링 방법을 선택합니다. 모든 정보가 하나의 테이블에 조인되어야 하므로 시각적 테이블 선택기를 사용하여 테이블을 정의할 수 있습니다. 또는 SQL을 작성하여 원하는 열만 포함하거나, 기존 dbt 모델, Looker Looks 또는 Sigma 워크북을 활용할 수도 있습니다.
   
   
3. 계속하기 전에 모델을 미리보기하여 원하는 데이터를 쿼리하고 있는지 확인합니다. 기본적으로 Braze는 미리보기를 처음 100개 레코드로 제한합니다. 데이터를 검증한 후 Continue를 클릭합니다.
   
   
4. 모델 이름을 지정합니다. 예를 들어, “User recommendations”로 지정합니다.
   
   
5. 마지막으로, 기본 키를 선택하고 Finish를 클릭합니다. 기본 키는 고유 식별자가 있는 열이어야 합니다. 이 필드는 특정 사용자의 추천을 검색하기 위해 Personalization API를 호출할 때 사용하는 필드이기도 합니다.

3단계: Personalization API 구성

API가 요청을 수신할 수 있도록 준비하는 데는 두 가지 단계가 있습니다:

• 인프라에 가장 가까운 리전에서 Personalization API 활성화
• 어떤 모델이 Hightouch 관리형 캐시에 구체화되어야 하는지 정의하는 동기화 생성

다음 지침에 따라 두 가지를 모두 완료하세요:

1. Hightouch에서 Destinations로 이동하고, 생성된 Hightouch Personalization API를 선택합니다. 이 대상이 활성화되어 있지 않은 경우 Hightouch 고객지원에 문의하세요.
   
   
2. 다음으로, 적절한 리전을 선택합니다. 인프라에 가장 가까운 리전을 선택하면 응답 시간이 단축됩니다. 인프라에 가까운 리전이 보이지 않는 경우 Hightouch 고객지원에 문의하세요.
   
   
3. Syncs 개요 페이지로 이동하고 Add sync 버튼을 클릭합니다. 다음으로, 관련 모델과 이전에 설정한 대상을 선택합니다.
   
   
4. 영숫자 컬렉션 이름을 입력합니다. 컬렉션은 개념적으로 데이터베이스 테이블과 유사합니다. 각 컬렉션은 고객 또는 인보이스와 같은 특정 데이터 유형을 나타내야 합니다. 컬렉션 이름은 영숫자여야 하며 Personalization API 엔드포인트의 일부가 됩니다.
   
   
5. 다음으로, 모델에서 어떤 열이 레코드 조회의 기본 인덱스 역할을 해야 하는지 지정합니다. 이 필드는 컬렉션의 각 레코드를 고유하게 식별해야 하며, 일반적으로 모델의 기본 키와 동일합니다. Personalization API는 여러 인덱스에 대한 조회를 지원합니다. 예를 들어, user_id, anonymous_id 또는 email_address를 사용하여 고객 프로필을 검색할 수 있습니다. 여러 인덱스를 활성화하려면 Hightouch 고객지원에 문의하세요.
   
   
6. 필드 매퍼를 사용하여 모델에서 어떤 열이 API 응답 페이로드에 포함되어야 하는지 지정합니다. 이러한 필드의 이름을 변경하고 고급 매퍼를 사용하여 Liquid 템플릿 언어로 변환을 적용할 수 있습니다.
   
   
7. 사용 사례에 적합한 삭제 동작을 선택합니다.
   
   
8. 마지막으로, Continue를 클릭한 다음 동기화 스케줄을 선택합니다.

이제 Hightouch가 웨어하우스의 데이터를 관리형 데이터베이스에 동기화하고 Personalization API를 통해 노출합니다.

4단계: Braze 연결된 콘텐츠를 통해 Personalization API 호출

Personalization API 인스턴스를 설정한 후에는 Braze 연결된 콘텐츠 엔드포인트로 사용할 수 있습니다.

API는 https://personalization.{region}.hightouch.com에서 접근할 수 있습니다. 예를 들어, https://personalization.us-west-2.hightouch.com입니다.

정보는 이 엔드포인트 /v1/collections/:collection_name/records/:index_key/:index_value를 사용하여 이용할 수 있습니다.

예를 들어, Campaign 또는 Canvas에 다음 스니펫을 포함할 수 있습니다:

1
2
3
4
5
6
7
8
9
{% connected_content
     https://personalization.us-west-2.hightouch.com/v1/collections/customer/records/id/12345
     :method get
     :headers {
       "Authorization": "Bearer {{YOUR-API-KEY}}"
  }
     :content_type application/json
     :save customer
%}

Liquid 템플릿을 사용하여 JSON 페이로드에서 반환된 등록정보를 참조하고 메시징에 활용할 수 있습니다.

아래 예시 페이로드의 경우:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
    "user_id": 12345,
    "full_name": "Jane Doe",
    "lifetime_value": 1492.18,
    "churn_risk": 0.04,
    "90_day_summary": {
        "num_songs_listened": 813,
        "top_genres": [
            "house",
            "techno",
            "ambient"
        ],
        "top_artists": [
            "deadmau5",
            "Marsh",
            "Enamour"
        ]
    },
    "recommendations": {
        "concerts": [
            {
                "artist": "Aphex Twin",
                "location": "San Francisco, CA",
                "event_date": "2023-01-31"
            },
            {
                "artist": "Sultan + Shepard",
                "location": "San Francisco, CA",
                "event_date": "2023-02-25"
            }
        ],
        "upcoming_album_release": {
            "title": "Universal Language",
            "artist": "Simon Doty",
            "label": "Anjunadeep",
            "release_date": "2023-04-28"
        }
    }
}

다음 Liquid 참조는 이 예시 데이터를 반환합니다:

문제 해결

질문이 있는 경우 Hightouch 고객지원에 문의하여 도움을 받으세요.