API Dataverse для Customer Insights - Data
Если вы уже используете API-интерфейсы Customer Insights - Data, например для запроса профиля клиента или получения данных об участии в сегменте, мы рекомендуем вместо этого перенести свои API-интерфейсы на API-интерфейсы Dataverse. Поддержка запросов к метаданным, таких как получение определения сегмента и управление рабочим процессом, скоро появится в API-интерфейсах Dataverse.
Если вы только начинаете запрашивать данные с помощью API-интерфейсов, мы рекомендуем вместо этого использовать API-интерфейсы Dataverse.
Внимание
Рекомендуется использовать API-интерфейсы Dataverse только для чтения данных (GET), а не для записи данных (POST/PATCH/PUT), поскольку это может вызвать проблемы с обработкой Customer Insights - Data.
API-интерфейсы Dataverse имеют следующие преимущества:
Расширенные возможности фильтрации и сортировки
Улучшенные масштабируемость и производительность
Согласованное взаимодействие с API-интерфейсами в приложениях Dynamics 365 и Power Platform
Примеры запросов
Чтобы начать использовать API-интерфейсы Dataverse, создайте регистрацию приложения в 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}' |
|
| Получить клиента по идентификаторам (Входит в) | {serviceRoot}/msdynci_customerprofiles?$filter=msdynci_customerid eq '{CID1}' or msdynci_customerid eq '{CID2}' |
|
| Получить клиентов по альтернативным ключам (Входит в) | {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. Ответ возвращает как известных, так и неизвестных клиентов. Таблицы, созданные для веб-отслеживания и персонализации, доступны в Dataverse.
| Тип запроса | Пример | Заметка |
|---|---|---|
| Получение клиентов 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 последних щелчков мышью на страницах |
| Получить все мероприятия для клиента | {serviceRoot}/msdynci_p13nprofile?$filter=msdynci_customerid eq '{CID}' |
|
| Получить все действия для клиента за определенный период времени | {serviceRoot}/msdynci_p13nprofile?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytime gt 2024-01-01T00:00:00Z and msdynci_activitytime lt 2024-06-01T00:00:00Z |
|
| Получить все действия типа activityType для клиента | {serviceRoot}/msdynci_p13nprofile?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytype eq '{ActivityType}' |
|
| Получить все действия 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 |
Объединенное действие
Примеры запросов к таблице UnifiedActivity, если веб-персонализация не используется.
| Тип запроса | Пример | Заметка |
|---|---|---|
| Получить все мероприятия для клиента | {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}' |
|
| Получить все действия для клиента за определенный период времени | {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytime gt 2024-01-01T00:00:00Z and msdynci_activitytime lt 2024-06-01T00:00:00Z |
|
| Получить все действия типа activityType для клиента | {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytype eq '{ActivityType}' |
|
| Получить все действия activityType для клиента | {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytypedisplay eq '{ActivityDisplayName}' |
|
| Получить все действия для клиента и отсортировать их | {serviceRoot}/msdynci_unifiedactivities?$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' |
|
| Получить результаты модели ММ для клиента | {serviceRoot}/msdynci_predictions?$filter=msdynci_customerid eq '{CID}' and msdynci_modelprovider eq 'ChurnModel' |
Следующие шаги
Большинство таблиц Customer Insights - Data доступны в Dataverse. Дополнительные сведения см. в разделе Таблицы в Dataverse.
Dataverse предлагает расширенную поддержку для тестирования своих API, например через Insomnia. Дополнительные сведения см. в статье Использование Insomnia с веб-API Dataverse.
Дополнительные сведения об ограничениях службы API-интерфейсов Dataverse см. в разделе Обзор ограничений API-интерфейсов Microsoft Dataverse.
Дополнительные сведения о том, как использовать API-интерфейсы Dataverse, см. в разделе Запрос данных с помощью веб-API.