OData-Abfragebeispiele

Anmerkung

Auf Customer Insights - Data-Tabellen kann auch über die Dataverse APIs zugegriffen werden. Wir empfehlen Ihnen, Dataverse APIs zum Abfragen von Customer Insights-Daten zu verwenden, da diese eine umfassendere Filterung, einen höheren Durchsatz und eine geringere Latenz bieten. Weitere Informationen finden Sie unter Dataverse APIs für Customer Insights.

Das Open Data Protocol (OData) ist ein Datenzugriffsprotokoll, das auf Kernprotokollen wie HTTP aufbaut. Es verwendet allgemein anerkannte Methoden wie REST für das Web. Du kannst verschiedene Arten von Bibliotheken und Tools verwenden, um OData-Dienste zu nutzen.

Um Ihnen beim Erstellen Ihrer eigenen Implementierungen auf der Grundlage der Dynamics 365 Customer Insights - Data-APIs zu helfen, sehen Sie sich Beispiele für einige häufig gestellte Fragen an.

Sie müssen die Abfragebeispiele ändern, damit sie in den Zielumgebungen funktionieren:

  • {serviceRoot} https://api.ci.ai.dynamics.com/v1/instances/{instanceId}: Wo {instanceId} befindet sich der GUID der Customer Insights - Data-Umgebung, die Sie abfragen möchten? Die ListAllInstances-Operation hilft dir, die {InstanceId} Adressen zu finden, auf die du Zugriff hast.
  • {CID}: GUID eines einheitlichen Kundendatensatzes. Beispiel: ce759201f786d590bf2134bff576c369.
  • {AlternateKey}: Identifizierer des Primärschlüssels eines Kundendatensatzes in einer Datenquelle. Beispiel: CNTID_1002.
  • {DSname}: String mit dem Tabellennamen einer Datenquelle, die in Customer Insights - Data aufgenommen wird. Beispiel: Website_contacts.
  • {SegmentName}: String mit dem Ausgabetabellennamen eines Segments in Customer Insights - Data. Beispiel: Male_under_40.

Kundin/Kunde

Beispielabfragen für die Tabelle Kunde.

Abfragetyp Beispiel Anmerkung
Einzelnen Kunden-ID {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}' 
Alternativschlüssel {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} eq '{AlternateKey}' Alternative Schlüssel bleiben in der vereinheitlichten Kundentabelle bestehen
Auswählen {serviceRoot}/data/Customer?$select=CustomerId,FullName&$filter=customerid eq '1'
In {serviceRoot}/data/Customer?$filter=CustomerId in ('{CID1}',’{CID2}’)
Alternativschlüssel + In {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} in ('{AlternateKey}','{AlternateKey}')
Suche {serviceRoot}/data/Customer?$top=10&$skip=0&$search="string" Gibt die Top-10-Ergebnisse für eine Suchzeichenfolge zurück
Segmentmitgliedschaft {serviceRoot}/data/Customer?select=*&$filter=IsMemberOfSegment('{SegmentName}')&$top=10 Gibt eine voreingestellte Anzahl von Zeilen aus der Segmentierungstabelle zurück.
Segmentzugehörigkeit für einen Kunden {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}'&IsMemberOfSegment('{SegmentName}') Gibt das Kundenprofil zurück, wenn er Mitglied des angegebenen Segments ist

Vereinheitlichte Aktivität

Beispielabfragen für die Tabelle UnifiedActivity.

Abfragetyp Beispiel Anmerkung
Aktivität von CID {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}'  Listet Aktivitäten eines bestimmten Kundenprofils auf
Aktivitätszeitrahmen {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' and ActivityTime gt 2017-01-01T00:00:00.000Z and ActivityTime lt 2020-01-01T00:00:00.000Z Aktivitäten eines Kundenprofils in einem Zeitrahmen
Aktivitätstyp {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' and ActivityType eq '{ActivityName}'
Aktivität nach Anzeigename {serviceRoot}/data/UnifiedActivity$filter=CustomerId eq ‘{CID}’ and ActivityTypeDisplay eq ‘{ActivityDisplayName}’
Aktivitätssortierung {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq ‘{CID}’ & $orderby=ActivityTime asc Sortieren von Aktivitäten in aufsteigender oder absteigender Reihenfolge
Alle Aktivitäten und Maßnahmen für einen Kunden {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId eq '{CID}' Aktivitäten und Maßnahmen sind zusätzliche Schlüssel/Wert-Paare auf dem zurückgegebenen Kundenprofil

Workflows verwalten

Beispielabfragen zu Prozessen in Customer Insights - Data, z. B. zum Aktualisieren einer Datenquelle, Vereinheitlichen von Daten oder Abrufen des Status eines Vereinheitlichungsauftrags.

Abfragetyp Beispiel Anmerkung
Datenquellen-IDs abrufen {serviceRoot}/manage/datasources/v2 Gibt alle Datenquellen in Ihrer Umgebung zurück. Aus der Antwort heraus kannst du die friendlyName auf eine bestimmte Datenquelle prüfen und dann deren dataSourceIdverwenden.
Aktualisieren einer Datenquelle {serviceRoot}/manage/workflows/main/jobs?operationType=Ingestion&identifiers='{dataSourceId}'&forceRunRequested=true Verwenden Sie die dataSourceId vorherige Antwort, um eine Datenquelle zu aktualisieren. Diese Anfrage verwendet die POST-Methode.
Vollständige Aktualisierung ausführen {serviceRoot}/manage/workflows/main/jobs?operationType=all&forceRunRequested=true Aktualisiert alle Prozesse in Ihrer Umgebung. Diese Anfrage verwendet die POST-Methode.
Status der Prozesse abrufen {serviceRoot}/manage/workflows/main/jobs

Weitere Beispiele

Beispielabfragen für andere Tabellen.

Abfragetyp Beispiel Anmerkung
CID-Kennzahlen {serviceRoot}/data/Customer_Measure?$filter=CustomerId eq '{CID}'
Angereicherte Marken von CID {serviceRoot}/data/BrandShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}'
Angereicherte Interessen von CID {serviceRoot}/data/InterestShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}'
In-Klausel + Erweitern {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId in ('{CID}', '{CID}')

Einschränkungen

  • Die Customer Insights-API gibt standardmäßig maximal 100 Objekte zurück. Sie können mehr als die 100 zurückgegebenen Objekte analysieren, indem Sie standardmäßige Paginierungstechniken verwenden. Alternativ können Sie Ihre Daten exportieren.

  • Die folgenden Anforderungen werden nicht unterstützt:

    • $filter auf erfasste Quelltabellen. Sie können $filter-Abfragen nur für Systemtabellen ausführen, die Customer Insights - Data erstellt.
    • $expand aus einer $search-Abfrage. Beispiel: Customer?$expand=UnifiedActivity$top=10&$skip=0&$search="corey".
    • $expand aus $select, wenn nur eine Teilmenge von Attributen ausgewählt ist. Beispiel: Customer?$select=CustomerId,FullName&$expand=UnifiedActivity&$filter=CustomerId eq '{CID}'.
    • $expand angereicherte Marken- oder Interessenaffinitäten für einen bestimmten Kunden. Beispiel: Customer?$expand=BrandShareOfVoiceFromMicrosoft&$filter=CustomerId eq '518291faaa12f6d853c417835d40eb10'.
    • Abfragen an Vorhersage-Modellausgabetabellen über Alternativschlüssel. Beispiel: OOBModelOutputTable?$filter=HotelCustomerID eq '{AK}'.