Udostępnij za pośrednictwem

Interfejsy API Dataverse dla aplikacji Customer Insights - Data

  • Artykuł

Jeśli korzystasz już z interfejsów API Customer Insights - Data do wyszukiwania danych, takich jak profil klienta lub członkostwo w segmencie, zalecamy migrację interfejsów API do interfejsów API Dataverse. Obsługa zapytań dotyczących metadanych, takich jak definiowanie segmentów i zarządzanie przepływem pracy, wkrótce pojawi się w interfejsach API Dataverse.

Jeśli dopiero zaczynasz korzystać z zapytań o dane za pomocą interfejsów API, zalecamy zamiast tego korzystanie z interfejsów API Dataverse.

Ważne

Zaleca się używanie interfejsów API Dataverse tylko do odczytu danych (GET), a nie do zapisu danych (POST/PATCH/PUT), ponieważ może to powodować problemy z przetwarzaniem Customer Insights - Data.

Interfejsy API Dataverse mają następujące korzyści:

  • Rozszerzone możliwości filtrowania i sortowania

  • Ulepszona skala i wydajność

  • Spójne środowisko API w aplikacjach Dynamics 365 i Power Platform

Przykładowe zapytania

Aby rozpocząć korzystanie z interfejsów API Dataverse, utwórz rejestrację aplikacji na platformie Azure i zażądaj uprawnień dla Dataverse oraz przyznaj uprawnienia do przeglądania aplikacji w Customer Insights - Data.

Musisz zmodyfikować próbki zapytań, aby działały na docelowych środowiskach:

  • {serviceRoot}: {Organization URI}/api/data/v9.2/ gdzie {identyfikator URI organizacji} jest URI dzierżawcy Dataverse skojarzonego ze środowiskiem użytkownika. Na przykład: https://{mydvorg}.crm.dynamics.com.

  • {CID}: GUID zunifikowanego rekordu klienta. Na przykład: ce759201f786d590bf2134bff576c369.

  • {AlternateKey}: Identyfikator klucza głównego rekordu klienta w źródle danych. Na przykład: CNTID_1002.

  • {DSname}: ciąg zawierający nazwę tabeli źródło danych, których jest pozyskiwany do Customer Insights - Data. Na przykład: Website_contacts.

  • {SegmentName}: ciąg zawierający nazwę tabeli wyjściowej segmentu. Na przykład: Male_under_40.

  • {CookieId}: identyfikator każdego użytkownika witryny sieci Web. Jest on generowany automatycznie podczas korzystania ze skryptu śledzenia w sieci Web. Na przykład: 3f43317e-d1ef-4cd3-9917-2d3342111d1a.

kliencie

Przykładowe zapytania dla tabeli CustomerProfile i członkostwa w segmentach.

Typ zapytania Przykład Uwaga
Pobierz wszystkich klientów {serviceRoot}/msdynci_customerprofiles
Pobierz klienta według identyfikatora {serviceRoot}/msdynci_customerprofiles?$filter=msdynci_customerid eq '{CID}'
Pobierz klienta według klucza alternatywnego {serviceRoot}/msdynci_customerprofiles?$filter={msdynci_alternate_column} eq '{AK}' Klucze alternatywne są przechowywane w zunifikowanej tabeli klientów w formacie msdynci_DSname_TableName_PrimaryKeyColumnName
Pobierz wybrane atrybuty dla klienta {serviceRoot}/msdynci_customerprofiles?$select=msdynci_fullname&$filter=msdynci_customerid eq '{CID}'
Pobieranie klientów według identyfikatorów (In) {serviceRoot}/msdynci_customerprofiles?$filter=msdynci_customerid eq '{CID1}' or msdynci_customerid eq '{CID2}'
Uzyskiwanie klientów według alternatywnych kluczy (In) {serviceRoot}/msdynci_customerprofiles?$filter={msdynci_alternate_column} eq '{AK1}' or {msdynci_alternate_column} eq '{AK2}'
Wyszukaj klientów {serviceRoot}/msdynci_customerprofiles?$filter=contains(msdynci_lastname,'string')&$top=10
Pobierz wszystkich klientów należących do segmentu {serviceRoot}/msdynci_segmentmemberships?$filter=contains(msdynci_segments,'\"{SegmentName}\"')&$select=msdynci_customerid
Pozyskaj klienta, jeśli należy do segmentu {serviceRoot}/msdynci_segmentmemberships?$filter=contains(msdynci_segments,'\"{SegmentName}\"') and msdynci_customerid eq '{CID}'&$select=msdynci_customerid
Pobierz wszystkie członkostwa segmentu klienta {serviceRoot}/msdynci_segmentmemberships?$filter=msdynci_customerid eq '{CID}'&$select=msdynci_segments

Personalizacja w sieci Web

Przykładowe zapytania w celu spersonalizowania witryny sieci Web na podstawie danych CookieId. Odpowiedź zwraca zarówno znanych, jak i nieznanych klientów.

Typ zapytania Przykład Uwaga
Pobierz klienta według CookieId {serviceRoot}/msdynci_personalizationprofiles(cookieid='{cookieId}')
Pobierz klienta według CookieId i uwzględnij Segmenty, Miary, Działania {serviceRoot}/msdynci_personalizationprofiles(cookieid='{cookieId}',include=['segmentmembership','measures','unifiedactivity'])
Pobierz najnowsze (ostatnie 10) widoki strony klienta według pliku CookieId {serviceRoot}/msdynci_pageviews(cookieid='{cookieId}',top=10) Można to zmienić, aby powrócić do 200 ostatnich widoków strony
Pobierz najnowsze (ostatnie 10) kliknięcia strony klienta według pliku CookieId {serviceRoot}/msdynci_pageclicks(cookieid='{cookieId}',top=10) Można to zmienić, aby powrócić do 200 ostatnich kliknięć strony

Ujednolicona aktywność

Przykładowe zapytania dotyczące tabeli UnifiedActivity.

Typ zapytania Przykład Uwaga
Pobierz wszystkie działania klienta {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}'
Uzyskanie wszystkich działań klienta w określonym czasie {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytime gt 2017-01-01T00:00:00Z and msdynci_activitytime lt 2017-01-01T00:00:00Z
Pobieranie wszystkich działań activityType klienta {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytype eq '{ActivityType}'
Pobierz wszystkie działania activityDisplayName klienta {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytypedisplay eq '{ActivityDisplayName}'
Pobieranie i sortowanie wszystkich działań klienta {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}'&$orderby=msdynci_activitytime asc

Inne przykłady

Przykładowe zapytania dotyczące innych tabel.

Typ zapytania Przykład Uwaga
Uzyskaj wszystkie pomiary klienta {serviceRoot}/msdynci_customermeasures?$filter=msdynci_customerid eq '{CID}'
Uzyskaj wzbogacone marki klienta {serviceRoot}/msdynci_enrichments?$filter=msdynci_customerid eq '{CID}' and msdynci_enrichmentprovider eq 'BrandShareOfVoiceFromMicrosoft'
Uzyskaj wzbogacone zainteresowania klienta {serviceRoot}/msdynci_enrichments?$filter=msdynci_customerid eq '{CID}' and msdynci_enrichmentprovider eq 'InterestShareOfVoiceFromMicrosoft'
Uzyskaj wyniki modelu AI klienta {serviceRoot}/msdynci_predictions?$filter=msdynci_customerid eq '{CID}' and msdynci_modelprovider eq 'ChurnModel'

Następne kroki