Примери за заявки за OData
Бележка
Customer Insights - Data таблици също могат да бъдат достъпни с помощта на Dataverse API. Препоръчваме ви да използвате Dataverse API, за да правите заявки за данни от Customer Insights, тъй като те предлагат по-обширно филтриране, по-голяма пропускателна способност и по-ниска латентност. За повече информация вижте Dataverse API за Статистика за клиентите.
Протоколът за отворени данни (OData) е протокол за достъп до данни, изграден върху основни протоколи като HTTP. Той използва общоприети методологии като REST за мрежата. Има различни видове библиотеки и инструменти, които могат да се използват за използване на услугите на OData.
За да ви помогнем да изградите свои собствени реализации въз основа на Dynamics 365 Customer Insights - Data API, прегледайте някои често искани примерни заявки.
Променете образците на заявки, за да ги накарате да работят в целевите среди:
- {serviceRoot}:
https://api.ci.ai.dynamics.com/v1/instances/{instanceId}where {instanceId} е GUID на средата, в Customer Insights - Data която искате да направите заявка. Операцията ListAllInstances ви позволява да намерите {InstanceId}, до който имате достъп. - {CID}: GUID на унифициран клиентски запис. Пример:
ce759201f786d590bf2134bff576c369. - {AlternateKey}: Идентификатор на първичния ключ на клиентски запис в източник на данни. Пример:
CNTID_1002 - {DSname}: Низ с името на таблицата на източник на данни, който се поглъща Customer Insights - Data. Пример:
Website_contacts. - {SegmentName}: String с името на изходната таблица на сегмент в Customer Insights - Data. Пример:
Male_under_40.
Клиент
Примерни заявки за таблицата "Клиент ".
| Тип заявка | Пример | Бележка |
|---|---|---|
| ИД на единичен клиент | {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}' |
|
| алтернативен ключ | {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} eq '{AlternateKey}' |
Алтернативните ключове продължават да съществуват в единната таблица за клиенти |
| Select | {serviceRoot}/data/Customer?$select=CustomerId,FullName&$filter=customerid eq '1' |
|
| Вход | {serviceRoot}/data/Customer?$filter=CustomerId in ('{CID1}',’{CID2}’) |
|
| алтернативен ключ + В | {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} in ('{AlternateKey}','{AlternateKey}') |
|
| Търсете | {serviceRoot}/data/Customer?$top=10&$skip=0&$search="string" |
Връща първите 10 резултата за низ за търсене |
| Членство в сегмент | {serviceRoot}/data/Customer?select=*&$filter=IsMemberOfSegment('{SegmentName}')&$top=10 |
Връща предварително зададен брой редове от таблицата за сегментиране. |
| Сегментно членство за клиент | {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}'&IsMemberOfSegment('{SegmentName}') |
Връща клиентския профил, ако е член на дадения сегмент |
Единна дейност
Примерни заявки за таблицата "Обединена дейност ".
| Тип заявка | Пример | Бележка |
|---|---|---|
| Дейност на CID | {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' |
Изброява дейностите на конкретен клиентски профил |
| Времева рамка на дейността | {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 |
Дейности на клиентски профил във времева рамка |
| Тип дейност | {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' and ActivityType eq '{ActivityName}' |
|
| Дейност по показвано име | {serviceRoot}/data/UnifiedActivity$filter=CustomerId eq ‘{CID}’ and ActivityTypeDisplay eq ‘{ActivityDisplayName}’ |
|
| Сортиране на дейности | {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq ‘{CID}’ & $orderby=ActivityTime asc |
Сортиране на дейности във възходящ или низходящ ред |
| Всички дейности и мерки за клиент | {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId eq '{CID}' |
Дейностите и мерките са допълнителни двойки ключ/стойност в върнатия клиентски профил |
Управление на работни потоци
Примерни заявки, свързани с процеси, като Customer Insights - Data например обновяване на източник на данни, обединяване на данни или получаване на състоянието на задача за обединение.
| Тип заявка | Пример | Бележка |
|---|---|---|
| Получаване на източник на данни идентификационни номера | {serviceRoot}/manage/datasources/v2 |
Връща всички източници на данни във вашата среда. От отговора можете да проверите "friendlyName" за конкретна източник на данни и след това да използвате неговия "dataSourceId". |
| Обновяване на източник на данни | {serviceRoot}/manage/workflows/main/jobs?operationType=Ingestion&identifiers='{dataSourceId}'&forceRunRequested=true |
Използвайте "dataSourceId" от горния отговор, за да обновите източник на данни. Това е пощенска заявка. |
| Изпълнение на пълно обновяване | {serviceRoot}/manage/workflows/main/jobs?operationType=all&forceRunRequested=true |
Освежава всички процеси във вашата среда. Това е пощенска заявка. |
| Получаване на статус на процесите | {serviceRoot}/manage/workflows/main/jobs |
Други примери
Примерни заявки за други таблици.
| Тип заявка | Пример | Бележка |
|---|---|---|
| Мерки на CID | {serviceRoot}/data/Customer_Measure?$filter=CustomerId eq '{CID}' |
|
| Обогатени марки на CID | {serviceRoot}/data/BrandShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}' |
|
| Обогатени интереси на CID | {serviceRoot}/data/InterestShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}' |
|
| В клауза + Разгъване | {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId in ('{CID}', '{CID}') |
Ограничения
API за клиентски прозрения връща максимум 100 обекта по подразбиране. Можете да анализирате повече от 100-те върнати обекта, като използвате стандартни техники за страниране. Като алтернатива можете да експортирате данните си.
Следните заявки не се поддържат:
-
$filterвърху погълнати таблици източници. Можете да изпълнявате $filter заявки само в системни таблици, които Customer Insights - Data създават. -
$expand$searchот заявка. Например:Customer?$expand=UnifiedActivity$top=10&$skip=0&$search="corey". -
$expandот$select, ако е избрано само подмножество от атрибути. Например:Customer?$select=CustomerId,FullName&$expand=UnifiedActivity&$filter=CustomerId eq '{CID}'. -
$expandобогатена марка или интерес афинитет към даден клиент. Например:Customer?$expand=BrandShareOfVoiceFromMicrosoft&$filter=CustomerId eq '518291faaa12f6d853c417835d40eb10'. - Заявка прогноза модел изходни таблици чрез алтернативен ключ. Например:
OOBModelOutputTable?$filter=HotelCustomerID eq '{AK}'.
-