Customer Insights - Data 適用的 Dataverse API
如果您已經在使用 Customer Insights - Data API (例如查詢客戶設定檔，或取得客戶細分成員)，則建議改將您的 API 移轉至 Dataverse API。 對 Dataverse API 查詢中繼資料的支援 (例如，取得客戶細分定義和工作流程管理) 即將推出。
如果您要開始使用 API 來查詢資料，建議您改用 Dataverse API。
重要
建議只使用 Dataverse API 來讀取資料 (GET)，而不要用來寫入資料 (POST/PATCH/PUT)，否則可能會造成 Customer Insights - Data 處理發生問題。
Dataverse API 有下列優點：
擴充篩選和排序的功能
改善規模和效能
跨 Dynamics 365 和 Power Platform 應用程式的一致 API 體驗
範例查詢
若要開始使用 Dataverse API，請在 Azure 中建立應用程式註冊，並要求 Dataverse 的權限，然後在 Customer Insights - Data 上授與應用程式檢視者權限。
修改查詢範例，使其在目標環境中運作：
{serviceRoot}：
{Organization URI}/api/data/v9.2/，其中 {Organization URI} 是與環境相關聯之 Dataverse 租用戶的 URI。 例如：https://{mydvorg}.crm.dynamics.com{CID}：整合客戶記錄的 GUID。 例如：
ce759201f786d590bf2134bff576c369。{AlternateKey}：資料來源中，客戶記錄的主索引鍵識別碼。 例如：
CNTID_1002。{DSname}：包含資料來源的資料表名稱的字串，該資料來源已內嵌至 Customer Insights - Data。 例如：
Website_contacts。{SegmentName}：包含客戶細分輸出資料表名稱的字串。 例如：
Male_under_40。{CookieId}：每個網站訪客的識別碼，這是在使用 Web 追蹤指令碼時自動產生。 例如：
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 |
Web 個人化
根據 CookieId 個人化您的網站的範例查詢。 回應會傳回已知和未知的客戶。 建立的 Web 追蹤和個人化資料表可在 Dataverse 中使用。
| 查詢類型 | 範例 | 注意 |
|---|---|---|
| 依 CookieId 取得客戶 | {serviceRoot}/msdynci_p13nprofile(cookieid='{cookieId}') |
|
| 依 CookieId 取得客戶，並包含客戶細分、量值、活動 | {serviceRoot}/msdynci_p13nprofile(cookieid='{cookieId}',include=['segmentmembership','measures','unifiedactivity']) |
|
| 依 CookieId 取得客戶最近 (最近 10 次) 的網頁檢視次數 | {serviceRoot}/msdynci_pageviews(cookieid='{cookieId}',top=10) |
可將此查詢變更為傳回最多 200 次的最近網頁檢視 |
| 依 CookieId 取得客戶最近 (最近 10 次) 的網頁點選次數 | {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}' |
|
| 取得客戶所有屬於 activityDisplayName 的活動 | {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 |
整合活動
如果 Web 個人化未在使用中，則為 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}' |
|
| 取得客戶所有屬於 activityDisplayName 的活動 | {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' |
|
| 取得客戶的 AI 模型結果 | {serviceRoot}/msdynci_predictions?$filter=msdynci_customerid eq '{CID}' and msdynci_modelprovider eq 'ChurnModel' |
後續步驟
大部分 Customer Insights - Data 資料表都可在 Dataverse 中使用。 如需詳細資訊，請參閱Dataverse 中的資料表。
Dataverse 提供廣泛的 API 測試支援 (例如透過 Insomnia 提供)。 如需詳細資訊，請參閱將 Insomnia 與 Dataverse Web API 搭配使用。
如需 Dataverse API 服務限制的詳細資訊，請參閱 Microsoft Dataverse API 限制概觀。
如需有關如何使用 Dataverse API 的詳細資訊，請參閱使用 Web API 查詢資料。