Hightouch Personalization API

Die Personalization API von Hightouch ist ein verwalteter Dienst, mit dem Sie eine Daten-API mit niedriger Latenz hosten können, die auf einem beliebigen Datensatz in Ihrem Cloud Data Warehouse basiert.

Die Integration von Braze und Hightouch ermöglicht es Ihnen, die API mit Braze Connected-Content zu nutzen, um aktuelle Kund:innen- oder Objektdaten zum Zeitpunkt des Versands in Ihre Campaigns oder Canvases zu ziehen.

Die Personalization API von Hightouch bietet einen REST-Endpunkt zur Verwendung innerhalb Ihrer Braze-Konfiguration. Konkret können Sie das Braze Connected-Content-Angebot nutzen, um eine GET-Anfrage an die Personalization API zu stellen und alle Informationen zu einem bestimmten Bezeichner abzurufen. Die von dieser API bereitgestellten Daten können Kund:innen-, Produkt- oder andere Objektdaten darstellen.

Voraussetzungen

• anwendungsfälle
• datensätze

Integration

1. Schritt: Datenquelle mit Hightouch verbinden

Hightouch-Quellen sind der Ort, an dem die Geschäftsdaten Ihres Unternehmens gespeichert sind. In diesem Fall ist es der Ort, an dem Ihre Nutzerdaten gespeichert sind.

1. Gehen Sie in Hightouch zu Sources Overview > Add Source. Wählen Sie Ihr Data Warehouse als Quelle aus.
   
   
2. Geben Sie die entsprechenden Zugangsdaten ein; diese unterscheiden sich je nach Quelle.

Weitere Einzelheiten finden Sie in der entsprechenden Dokumentation.

2. Schritt: Daten modellieren

Hightouch-Modelle definieren, welche Daten aus Ihrer Quelle gezogen werden sollen. Um ein neues Modell einzurichten, gehen Sie folgendermaßen vor:

1. Gehen Sie in Hightouch zu Models overview > Add model und wählen Sie die Quelle aus, die Sie gerade verbunden haben.
   
   
2. Wählen Sie als Nächstes eine Modellierungsmethode. Da alle Ihre Informationen in einer Tabelle zusammengefasst werden sollten, können Sie den visuellen Tabellenselektor verwenden, um diese zu definieren. Alternativ können Sie SQL schreiben, um nur die gewünschten Spalten einzubeziehen, oder sich auf Ihre vorhandenen dbt-Modelle, Looker Looks oder Sigma-Arbeitsmappen verlassen.
   
   
3. Bevor Sie fortfahren, zeigen Sie eine Vorschau Ihres Modells an, um sicherzustellen, dass es die gewünschten Daten abfragt. Standardmäßig beschränkt Braze die Vorschau auf die ersten 100 Datensätze. Nachdem Sie Ihre Daten validiert haben, klicken Sie auf Continue.
   
   
4. Benennen Sie Ihr Modell, zum Beispiel „Nutzer:innen-Empfehlungen“.
   
   
5. Wählen Sie abschließend einen Primärschlüssel aus und klicken Sie auf Finish. Ein Primärschlüssel sollte eine Spalte mit eindeutigen Bezeichnern sein. Dies ist auch das Feld, über das Sie die Personalization API aufrufen, um die Empfehlungen einer bestimmten Nutzer:in abzurufen.

3. Schritt: Personalization API konfigurieren

Das Vorbereiten der API für den Empfang von Anfragen besteht aus zwei Schritten:

• Aktivieren der Personalization API in den Regionen, die Ihrer Infrastruktur am nächsten liegen
• Erstellen von Syncs, um festzulegen, welche Modelle im von Hightouch verwalteten Cache materialisiert werden sollen

Folgen Sie diesen Anweisungen, um beides abzuschließen:

1. Gehen Sie in Hightouch zu Destinations und wählen Sie die für Sie erstellte Hightouch Personalization API aus. Wenn Sie dieses Ziel nicht aktiviert haben, wenden Sie sich an den Hightouch-Support.
   
   
2. Wählen Sie dann die entsprechende Region aus. Wenn Sie die Region auswählen, die Ihrer Infrastruktur am nächsten liegt, verkürzen sich Ihre Antwortzeiten. Wenn Sie keine Region in der Nähe Ihrer Infrastruktur sehen, wenden Sie sich an den Hightouch-Support.
   
   
3. Rufen Sie die Übersichtsseite Syncs auf und klicken Sie auf den Button Add sync. Wählen Sie dann das entsprechende Modell und das Ziel aus, das Sie zuvor eingerichtet haben.
   
   
4. Geben Sie einen alphanumerischen Namen für die Sammlung ein. Sammlungen sind konzeptionell ähnlich wie Datenbanktabellen. Jede sollte einen bestimmten Datentyp repräsentieren, z. B. Kund:innen oder Rechnungen. Die Sammlungsnamen müssen alphanumerisch sein und werden Teil Ihres Personalization-API-Endpunkts.
   
   
5. Geben Sie als Nächstes an, welche Spalte aus Ihrem Modell als Primärindex für die Datensatzsuche dienen soll. Dieses Feld muss jeden Datensatz in der Sammlung eindeutig identifizieren und ist oft derselbe wie der Primärschlüssel Ihres Modells. Die Personalization API unterstützt Abfragen über mehrere Indizes. Sie könnten zum Beispiel Kundenprofile mit user_id, anonymous_id oder email_address abrufen wollen. Um mehrere Indizes zu aktivieren, wenden Sie sich an den Hightouch-Support.
   
   
6. Verwenden Sie den Feld-Mapper, um festzulegen, welche Spalten aus Ihrem Modell in die API-Antwort-Payload aufgenommen werden sollen. Sie können diese Felder umbenennen und den erweiterten Mapper verwenden, um Transformationen mithilfe der Liquid-Template-Sprache anzuwenden.
   
   
7. Wählen Sie das passende Löschverhalten für Ihren Anwendungsfall aus.
   
   
8. Klicken Sie abschließend auf Continue und wählen Sie einen Sync-Zeitplan aus.

Hightouch synchronisiert jetzt die Daten in Ihrem Data Warehouse mit einer verwalteten Datenbank und stellt sie über die Personalization API zur Verfügung.

4. Schritt: Personalization API über Braze Connected-Content aufrufen

Sobald Sie Ihre Personalization-API-Instanz eingerichtet haben, können Sie sie als Braze Connected-Content-Endpunkt verwenden.

Die API ist unter https://personalization.{region}.hightouch.com zugänglich, zum Beispiel unter https://personalization.us-west-2.hightouch.com.

Die Informationen sind über diesen Endpunkt verfügbar: /v1/collections/:collection_name/records/:index_key/:index_value.

Sie können dieses Snippet zum Beispiel in eine Campaign oder ein Canvas einfügen:

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
%}

Sie können Liquid-Templating verwenden, um die in der JSON-Payload zurückgegebenen Eigenschaften zu referenzieren und sie in Ihrem Messaging zu verwenden.

Für die Beispiel-Payload unten:

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"
        }
    }
}

Die folgenden Liquid-Referenzen würden diese Beispieldaten zurückgeben:

Fehlerbehebung

Wenn Sie Fragen haben, wenden Sie sich an den Hightouch-Support, um Hilfe zu erhalten.