OData クエリの例
注意
Customer Insights - Data テーブルは、Dataverse API を使用してにアクセスすることもできます。 より広範なフィルター、より優れたスループット、短い待ち時間を提供するため、Dataverse API を使用して、Customer Insights データを照会することをお勧めします。 詳細については、Customer Insights 用 Dataverse API を参照してください。
Open Data Protocol (OData) は、HTTP などのコア プロトコルに基づいて構築されたデータ アクセス プロトコルです。 Web 用の REST のような一般的に受け入れられている方法論を使用します。 OData サービスを使用するために使用できるさまざまな種類のライブラリとツールがあります。
Dynamics 365 Customer Insights - Data API に基づいて独自の実装を構築するには、よくリクエストされるこれらのサンプル クエリの一部を確認できます。
クエリ サンプルを変更して、ターゲット環境で機能するようにします。
- {serviceRoot}:
https://api.ci.ai.dynamics.com/v1/instances/{instanceId}ここで {instanceId} は、問い合わせたい Customer Insights - Data 環境の GUID です。 ListAllInstances 操作 を使用すると、アクセスできる {InstanceId} を見つけることができます。 - {CID}: 統合された顧客レコードの GUID。 例:
ce759201f786d590bf2134bff576c369。 - {AlternateKey}: データ ソースの顧客レコードの主キーの識別子。 例:
CNTID_1002 - {DSname}: Customer Insights - Data に取り込まれるデータ ソースのテーブル名を持つ文字列。 例:
Website_contacts。 - {SegmentName}: Customer Insights - Data のセグメントの出力テーブル名を含む文字列。 例:
Male_under_40。
大変お世話になっております
顧客 テーブルのサンプル クエリ。
| クエリの種類 | 例 | 注意 |
|---|---|---|
| 1 つの顧客 ID | {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}' |
|
| 代替キー | {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} eq '{AlternateKey}' |
代替キーは統合された顧客テーブルに保持されます |
| 選択 | {serviceRoot}/data/Customer?$select=CustomerId,FullName&$filter=customerid eq '1' |
|
| 含む | {serviceRoot}/data/Customer?$filter=CustomerId in ('{CID1}',’{CID2}’) |
|
| 代替キー + In | {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}') |
指定されたセグメントのメンバーである場合、顧客プロファイルを返します |
統合した活動
UnifiedActivity テーブルのサンプル クエリ:
| クエリの種類 | 例 | 注意 |
|---|---|---|
| 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 のプロセスに関連するサンプル クエリ。
| クエリの種類 | 例 | 注意 |
|---|---|---|
| データ ソース ID を取得 | {serviceRoot}/manage/datasources/v2 |
環境上のすべてのデータ ソースを返します。 応答から特定のデータ ソースの 'friendlyName' を確認し、その 'dataSourceId' を使用できます。 |
| データ ソースの更新 | {serviceRoot}/manage/workflows/main/jobs?operationType=Ingestion&identifiers='{dataSourceId}'&forceRunRequested=true |
上記の応答からの 'dataSourceId' を使用してデータ ソースを更新します。 これは POST 要求です。 |
| 完全更新の実行 | {serviceRoot}/manage/workflows/main/jobs?operationType=all&forceRunRequested=true |
環境ですべてのプロセスを更新します。 これは POST 要求です。 |
| プロセスの状態の取得 | {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}') |
制限
Customer Insights API は、デフォルトで最大 100 個のオブジェクトを返します。 標準のページ割り付け手法を使用して、返される 100 個を超えるオブジェクトを解析できます。 代わりに、データをエクスポート することもできます。
次のクエリはサポートされていません:
- 取り込んだソース テーブルの
$filter。 Customer Insights - Data が作成したシステム テーブルに対してのみ $filter クエリを実行できます。 -
$searchクエリによる$expand。 例:Customer?$expand=UnifiedActivity$top=10&$skip=0&$search="corey"。 - 属性のサブセットのみを選択している場合は、
$selectによる$expand。 例:Customer?$select=CustomerId,FullName&$expand=UnifiedActivity&$filter=CustomerId eq '{CID}'。 - 特定の顧客に対して強化したブランドや関心のアフィニティを
$expandします。 例:Customer?$expand=BrandShareOfVoiceFromMicrosoft&$filter=CustomerId eq '518291faaa12f6d853c417835d40eb10'。 - 代替キーによって予測モデルの出力テーブルをクエリします。 例:
OOBModelOutputTable?$filter=HotelCustomerID eq '{AK}'。
- 取り込んだソース テーブルの