Споделяне чрез

API на Dataverse за Customer Insights - Data

  • Статия

Ако вече използвате Customer Insights - Data API, като например заявка за потребителски профил или получаване на членство в сегмент, препоръчваме вместо това да мигрирате API си към Dataverse API. Поддръжката за заявки за метаданни, като например дефиниция на сегмент и управление на работния процес, скоро ще се появи в Dataverse API.

Ако започвате да правите заявки за данни чрез API, препоръчваме вместо това да използвате Dataverse API.

Важно

Препоръчително е да използвате Dataverse API само за четене на данни (GET), а не за запис на данни (POST/PATCH/PUT), тъй като това може да причини проблеми с Customer Insights - Data обработката.

Dataverse API имат следните предимства:

  • Разширени възможности за филтриране и сортиране

  • Подобрен мащаб и производителност

  • Последователна среда за работа с API в Dynamics 365 и Power Platform приложения

Примерни заявки

За да започнете да използвате Dataverse API, създайте регистрация на приложение в Azure и поискайте разрешения за Dataverse и дайте разрешения Customer Insights - Data за визуализиране на вашето приложение.

Променете примерите на заявките, за да ги накарате да работят в целевите среди:

  • {serviceRoot}: {Organization URI}/api/data/v9.2/ където {URI} на организацията е URI на Dataverse клиента, свързан с вашата среда. Например: https://{mydvorg}.crm.dynamics.com

  • {CID}: GUID на унифициран клиентски запис. Например: ce759201f786d590bf2134bff576c369.

  • {AlternateKey}: Идентификатор на първичния ключ на запис на клиент в източник на данни. Например: CNTID_1002.

  • {DSname}: Низ с името на таблицата на източник на данни, който се поглъща Customer Insights - Data. Например: Website_contacts.

  • {SegmentName}: Низ с името на изходната таблица на сегмент. Например: Male_under_40.

  • {CookieId}: Идентификатор за всеки посетител на уебсайта. Това се генерира автоматично при използване на скрипта зауеб проследяване. Например: 3f43317e-d1ef-4cd3-9917-2d3342111d1a.

Клиент

Примерни заявки за таблицата CustomerProfile и членството в сегмент.

Тип на заявката Пример Бележка
Вземете всички клиенти {serviceRoot}/msdynci_customerprofiles
Получаване на клиент по идентификационен номер {serviceRoot}/msdynci_customerprofiles?$filter=msdynci_customerid eq '{CID}'
Вземете клиент чрез алтернативен ключ {serviceRoot}/msdynci_customerprofiles?$filter={msdynci_alternate_column} eq '{AK}' Алтернативните ключове се запазват в унифицираната таблица на клиентите във формат msdynci_DSname_TableName_PrimaryKeyColumnName
Получаване на избрани атрибути за клиент {serviceRoot}/msdynci_customerprofiles?$select=msdynci_fullname&$filter=msdynci_customerid eq '{CID}'
Получаване на клиенти по идентификатори (In) {serviceRoot}/msdynci_customerprofiles?$filter=msdynci_customerid eq '{CID1}' or msdynci_customerid eq '{CID2}'
Получаване на клиенти чрез алтернативни ключове (In) {serviceRoot}/msdynci_customerprofiles?$filter={msdynci_alternate_column} eq '{AK1}' or {msdynci_alternate_column} eq '{AK2}'
Търсене на клиенти {serviceRoot}/msdynci_customerprofiles?$filter=contains(msdynci_lastname,'string')&$top=10
Вземете всички клиенти, които са членове на даден сегмент {serviceRoot}/msdynci_segmentmemberships?$filter=contains(msdynci_segments,'\"{SegmentName}\"')&$select=msdynci_customerid
Вземете клиент, ако е член на сегмент {serviceRoot}/msdynci_segmentmemberships?$filter=contains(msdynci_segments,'\"{SegmentName}\"') and msdynci_customerid eq '{CID}'&$select=msdynci_customerid
Получаване на всички членства в сегмент на клиент {serviceRoot}/msdynci_segmentmemberships?$filter=msdynci_customerid eq '{CID}'&$select=msdynci_segments

Уеб персонализация

Примерни заявки за персонализиране на вашия уебсайт въз основа на CookieId. В отговора се връщат както познати, така и неизвестни клиенти.

Тип на заявката Пример Бележка
Вземете клиент чрез CookieId {serviceRoot}/msdynci_p13nprofile(cookieid='{cookieId}')
Вземете клиент чрез CookieId и включете сегменти, мерки, дейности {serviceRoot}/msdynci_p13nprofile(cookieid='{cookieId}',include=['segmentmembership','measures','unifiedactivity'])
Получаване на скорошни (последните 10) показвания на страници на клиент чрез CookieId {serviceRoot}/msdynci_pageviews(cookieid='{cookieId}',top=10) Това може да бъде променено, за да върне до 200 скорошни показвания на страници
Получаване на скорошни (последните 10) кликвания върху страници на клиент чрез CookieId {serviceRoot}/msdynci_pageclicks(cookieid='{cookieId}',top=10) Това може да бъде променено, за да се върнат до 200 скорошни кликвания върху страници

Единна дейност

Примерни заявки за таблицата UnifiedActivity .

Тип на заявката Пример Бележка
Получаване на всички дейности на клиента {serviceRoot}/msdynci_p13nprofile?$filter=msdynci_customerid eq '{CID}'
Получаване на всички дейности на клиент в рамките на определен период от време {serviceRoot}/msdynci_p13nprofile?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytime gt 2017-01-01T00:00:00Z and msdynci_activitytime lt 2017-01-01T00:00:00Z
Получаване на всички дейности на дадена дейностТип клиент {serviceRoot}/msdynci_p13nprofile?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytype eq '{ActivityType}'
Получаване на всички дейности на дейностПоказванеИме на клиент {serviceRoot}/msdynci_p13nprofile?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytypedisplay eq '{ActivityDisplayName}'
Получаване на всички дейности на клиента и сортирането им {serviceRoot}/msdynci_p13nprofile?$filter=msdynci_customerid eq '{CID}'&$orderby=msdynci_activitytime asc

Други примери

Примерни заявки за други таблици.

Тип на заявката Пример Бележка
Получете всички мерки на клиент {serviceRoot}/msdynci_customermeasures?$filter=msdynci_customerid eq '{CID}'
Получете обогатени марки на клиент {serviceRoot}/msdynci_enrichments?$filter=msdynci_customerid eq '{CID}' and msdynci_enrichmentprovider eq 'BrandShareOfVoiceFromMicrosoft'
Обогатете интересите на клиента {serviceRoot}/msdynci_enrichments?$filter=msdynci_customerid eq '{CID}' and msdynci_enrichmentprovider eq 'InterestShareOfVoiceFromMicrosoft'
Получаване на резултати от AI модела на клиент {serviceRoot}/msdynci_predictions?$filter=msdynci_customerid eq '{CID}' and msdynci_modelprovider eq 'ChurnModel'

Следващи стъпки