Eksempler på OData-forespørgsler
Bemærk
Customer Insights - Data-tabeller kan ikke aktiveres ved hjælp af Dataverse API'er. Det anbefales, at du bruger Dataverse API'er til at forespørge om Customer Insights-data, da de giver mere omfattende filtrering, større gennemløb og lavere ventetid. Du kan finde flere oplysninger i Dataverse API'er til Customer Insights.
OData (Open Data Protocol) er en dataadgangsprotokol, der er baseret på kerneprotokoller som HTTP. Der bruges almindeligt accepterede metoder, f.eks. REST til internettet. Der findes forskellige typer biblioteker og værktøjer, der kan bruges til at forbruge OData-tjenester.
Se nogle ofte anmodede eksempler på forespørgsler, der kan hjælpe dig med at oprette dine egne implementeringer baseret på Dynamics 365 Customer Insights - Data-API'er.
Du skal ændre forespørgselseksemplerne, så de fungerer i destinationsmiljøerne:
- {serviceRoot}:
https://api.ci.ai.dynamics.com/v1/instances/{instanceId}hvor {instanceId} er GUID for det Customer Insights - Data-miljø, du vil forespørge om. Du kan bruge handlingen ListAllInstances til at finde {InstanceId}, du har adgang til. - {CID}: GUID for en ensartet kundepost. Eksempel:
ce759201f786d590bf2134bff576c369. - {AlternateKey}: Id for den primære nøgle for en kundepost i en datakilde. Eksempel:
CNTID_1002 - {DSname}: Streng med tabelnavnet på en datakilde, der bliver indtaget i Customer Insights - Data. Eksempel:
Website_contacts. - {SegmentName}: Streng med outputtabelnavnet på et segment i Customer Insights - Data. Eksempel:
Male_under_40.
Kunde
Eksempelforespørgsler for tabellen Kunde.
| Forespørgselstype | Eksempel | Bemærk |
|---|---|---|
| Enkelt kunde-id | {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}' |
|
| Alternativ nøgle | {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} eq '{AlternateKey}' |
Alternative nøgler bliver ved med at være i tabellen Samlet kunde |
| Markér | {serviceRoot}/data/Customer?$select=CustomerId,FullName&$filter=customerid eq '1' |
|
| Om | {serviceRoot}/data/Customer?$filter=CustomerId in ('{CID1}',’{CID2}’) |
|
| Alternativ nøgle + In | {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} in ('{AlternateKey}','{AlternateKey}') |
|
| Søge | {serviceRoot}/data/Customer?$top=10&$skip=0&$search="string" |
Returnerer de 10 bedste resultater for en søgestreng |
| Segmentmedlemskab | {serviceRoot}/data/Customer?select=*&$filter=IsMemberOfSegment('{SegmentName}')&$top=10 |
Returnerer et antal rækker fra segmenteringstabellen. |
| Medlemskab af et segment for en kunde | {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}'&IsMemberOfSegment('{SegmentName}') |
Returnerer kundeprofilen, hvis kunden er medlem af det givne segment |
Samlet aktivitet
Eksempelforespørgsler for tabellen UnifiedActivity:
| Forespørgselstype | Eksempel | Bemærk |
|---|---|---|
| CID for aktivitet | {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' |
Viser aktiviteter for en bestemt kundeprofil |
| Tidsramme for aktivitet | {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 |
Aktiviteter for en kundeprofil i en tidsramme |
| Aktivitetstype | {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' and ActivityType eq '{ActivityName}' |
|
| Aktivitet efter visningsnavn | {serviceRoot}/data/UnifiedActivity$filter=CustomerId eq ‘{CID}’ and ActivityTypeDisplay eq ‘{ActivityDisplayName}’ |
|
| Aktivitetssortering | {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq ‘{CID}’ & $orderby=ActivityTime asc |
Sortér aktiviteter stigende eller faldende |
| Alle aktiviteter og målinger for en kunde | {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId eq '{CID}' |
Aktiviteter og målinger er yderligere nøgle/værdipar i den returnerede kundeprofil |
Administrer arbejdsprocesser
Eksempelforespørgsler, der er relateret til processer i Customer Insights - Data, f.eks. opdatere en datakilde, samle data eller få statussen for et samlingsjob.
| Forespørgselstype | Eksempel | Bemærk |
|---|---|---|
| Hent datakilde-id'er | {serviceRoot}/manage/datasources/v2 |
Returnerer alle datakilder i miljøet. Du kan kontrollere, om et 'friendlyName' er for et bestemt datakilde og derefter bruge 'dataSourceId'. |
| Opdater en datakilde | {serviceRoot}/manage/workflows/main/jobs?operationType=Ingestion&identifiers='{dataSourceId}'&forceRunRequested=true |
Brug 'dataSourceId' fra ovenstående svar for at opdatere en datakilde. Dette er en POST-anmodning. |
| Kør en fuld opdatering | {serviceRoot}/manage/workflows/main/jobs?operationType=all&forceRunRequested=true |
Opdaterer alle processer i dit miljø. Dette er en POST-anmodning. |
| Få status for processer | {serviceRoot}/manage/workflows/main/jobs |
Andre eksempler
Eksempelforespørgsler for andre tabeller:
| Forespørgselstype | Eksempel | Bemærk |
|---|---|---|
| Målinger af CID | {serviceRoot}/data/Customer_Measure?$filter=CustomerId eq '{CID}' |
|
| Forbedrede mærker til CID | {serviceRoot}/data/BrandShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}' |
|
| Forbedring af interesser til CID | {serviceRoot}/data/InterestShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}' |
|
| In-Clause + Udvid | {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId in ('{CID}', '{CID}') |
Begrænsninger
Customer Insights API returnerer som standard op til 100 objekter. Du kan opdele teksten i mere end de 100 objekter, der returneres, ved hjælp af standardteknikker til sideinddeling. Du kan også eksportere dataene.
Følgende forespørgsler understøttes ikke:
-
$filterfor indtagede kildetabeller. Du kan kun køre $filter-forespørgsler på systemtabeller, der er oprettet af Customer Insights - Data. -
$expandfra en$search-forespørgsel. Eksempel:Customer?$expand=UnifiedActivity$top=10&$skip=0&$search="corey". -
$expandfra$select, hvis der kun er valgt et delsæt af attributter. Eksempel:Customer?$select=CustomerId,FullName&$expand=UnifiedActivity&$filter=CustomerId eq '{CID}'. -
$expandforbedret mærke eller interessetilhørsforhold for en bestemt kunde. Eksempel:Customer?$expand=BrandShareOfVoiceFromMicrosoft&$filter=CustomerId eq '518291faaa12f6d853c417835d40eb10'. - Outputtabeller for forespørgselsforudsigelsesmodeller via alternativ nøgle. Eksempel:
OOBModelOutputTable?$filter=HotelCustomerID eq '{AK}'.
-