Customer Insights - Data 向けの Dataverse API

  • [アーティクル]

注意

Dynamics 365 Customer Insights - Data API は 2024 年 8 月 31 日に廃止されます。 Microsoft Dataverse のデータを操作するには、Web API を使用することをお勧めします。

顧客プロファイルのクエリやセグメント メンバーシップの取得など、データのクエリにすでに Customer Insights - Data API を使用している場合は、代わりに API を Dataverse API に移行することをお勧めします。 セグメント定義の取得やワークフロー管理などのメタデータのクエリのサポートが、 Dataverse API に間もなく追加される予定です。

API を使用してデータのクエリを開始する場合は、代わりに Dataverse API を使用することをお勧めします。

重要

Customer Insights - Data の処理で問題が発生する可能性があるため、Dataverse API はデータの読み取り (GET) のみに使用し、データの書き込み (POST/PATCH/PUT) には使用しないことをお勧めします。

Dataverse API には、次の利点があります。

  • フィルタリングと並べ替えのための拡張機能

  • 拡張性とパフォーマンスの向上

  • Dynamics 365 と Power Platform アプリの一貫した API エクスペリエンス

サンプル クエリ

Dataverse の API の使用を開始するには、Azure でアプリケーション登録を作成し、Dataverse の権限を要求し、Customer Insights - Data でアプリの閲覧者権限を付与します。

クエリ サンプルを変更して、ターゲット環境で機能するようにします。

  • {serviceRoot}: {Organization URI}/api/data/v9.2/ {組織 URI} は、環境に関連付けられた Dataverse テナントの URI です。 例: https://{mydvorg}.crm.dynamics.com

  • {CID}: 統合された顧客レコードの GUID。 例: ce759201f786d590bf2134bff576c369。

  • {AlternateKey}: データ ソースの顧客レコードの主キーの識別子。 例: CNTID_1002。

  • {DSname}: Customer Insights - Data に取り込まれるデータ ソースのテーブル名を持つ文字列。 例: Website_contacts。

  • {SegmentName}: セグメントの出力テーブル名を含む文字列。 例: Male_under_40。

大変お世話になっております

CustomerProfile テーブルとセグメント メンバーシップのサンプル クエリ。

クエリの種類 例 注意
すべての顧客を取得 {serviceRoot}/msdynci_customerprofiles
ID で顧客を取得する {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}'
ID で顧客を取得する (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

統合した活動

UnifiedActivity テーブルのサンプル クエリ:

クエリの種類 例 注意
顧客に関するすべてのアクティビティ {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}'
期間内の顧客のすべてのアクティビティを取得する {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytime gt 2017-01-01T00:00:00Z and msdynci_activitytime lt 2017-01-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'

次の手順