Exemples de requête OData
Note
Customer Insights - Data les tables sont également accessibles à l’aide des Dataverse API. Nous vous recommandons d’utiliser des Dataverse API pour interroger les données Customer Insights, car elles offrent un filtrage plus étendu, un débit plus élevé et une latence plus faible. Pour plus d’informations, consultez API Dataverse pour Customer Insights.
L’Open Data Protocol (OData) est un protocole d’accès aux données basé sur des protocoles de base comme HTTP. Il utilise des méthodologies communément acceptées comme REST pour le Web. Il existe différents types de bibliothèques et d’outils qui peuvent être utilisés pour utiliser les services OData.
Pour vous aider à créer vos propres implémentations basées sur les Dynamics 365 Customer Insights - Data API, passez en revue certains des exemples de requêtes fréquemment demandées.
Modifiez les exemples de requêtes pour les faire fonctionner sur les environnements cibles :
- {serviceRoot} :
https://api.ci.ai.dynamics.com/v1/instances/{instanceId}où {instanceId} est le GUID de l’environnement Customer Insights - Data que vous souhaitez interroger. L’opération ListAllInstances vous permet de trouver l’{InstanceId} à laquelle vous avez accès. - {CID} : GUID d’un enregistrement de client unifié. Exemple :
ce759201f786d590bf2134bff576c369. - {AlternateKey} : Identifiant de la clé primaire d’un enregistrement de client dans une source de données. Exemple :
CNTID_1002 - {DSname} : Chaîne avec le nom de table d’une source de données qui est ingéré dans Customer Insights - Data. Exemple :
Website_contacts. - {SegmentName} : Chaîne avec le nom de la table de sortie d’un segment Customer Insights - Data. Exemple :
Male_under_40.
Customer
Exemples de requêtes pour la table Customer.
| Type de requête | Exemple | Note |
|---|---|---|
| ID client unique | {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}' |
|
| Clé secondaire | {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} eq '{AlternateKey}' |
Les clés secondaires persistent dans la table client unifiée |
| Sélectionner | {serviceRoot}/data/Customer?$select=CustomerId,FullName&$filter=customerid eq '1' |
|
| Intérieur | {serviceRoot}/data/Customer?$filter=CustomerId in ('{CID1}',’{CID2}’) |
|
| Clé secondaire + In | {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} in ('{AlternateKey}','{AlternateKey}') |
|
| Recherche | {serviceRoot}/data/Customer?$top=10&$skip=0&$search="string" |
Renvoie les 10 premiers résultats pour une chaîne de recherche |
| Appartenance aux segments | {serviceRoot}/data/Customer?select=*&$filter=IsMemberOfSegment('{SegmentName}')&$top=10 |
Renvoie un nombre prédéfini de lignes à partir de la table de segmentation. |
| Appartenance à un segment pour un client | {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}'&IsMemberOfSegment('{SegmentName}') |
Renvoie le profil du client s’il est membre du segment donné |
Activité unifiée
Exemples de requêtes pour la table UnifiedActivity.
| Type de requête | Exemple | Note |
|---|---|---|
| Activité de CID | {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' |
Répertorie les activités d’un profil client spécifique |
| Délai d’exécution de l’activité | {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 |
Activités d’un profil client dans un délai d’exécution |
| Type d’activité | {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' and ActivityType eq '{ActivityName}' |
|
| Activité par nom d’affichage | {serviceRoot}/data/UnifiedActivity$filter=CustomerId eq ‘{CID}’ and ActivityTypeDisplay eq ‘{ActivityDisplayName}’ |
|
| Tri des activités | {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq ‘{CID}’ & $orderby=ActivityTime asc |
Trier les activités dans l’ordre croissant ou décroissant |
| Toutes les activités et mesures pour un client | {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId eq '{CID}' |
Les activités et les mesures sont des paires clé/valeur supplémentaires sur le profil client renvoyé |
Gérer les workflows
Exemples de requêtes liées aux processus dans Customer Insights - Data tels que l’actualisation d’un source de données, l’unification des données ou l’obtention de l’état d’une tâche d’unification.
| Type de requête | Exemple | Note |
|---|---|---|
| Obtenir ID source de données | {serviceRoot}/manage/datasources/v2 |
Renvoie toutes les sources de données sur votre environnement. À partir de la réponse, vous pouvez vérifier le "friendlyName" pour un source de données spécifique, puis utiliser son "dataSourceId". |
| Actualiser une source de données | {serviceRoot}/manage/workflows/main/jobs?operationType=Ingestion&identifiers='{dataSourceId}'&forceRunRequested=true |
Utilisez le "dataSourceId" de la réponse ci-dessus pour actualiser un source de données. Ceci est une requête POST. |
| Exécuter une actualisation complète | {serviceRoot}/manage/workflows/main/jobs?operationType=all&forceRunRequested=true |
Actualiser tous les processus de votre environnement. Ceci est une requête POST. |
| Obtenir le statut des processus | {serviceRoot}/manage/workflows/main/jobs |
Autres exemples
Exemples de requêtes pour d’autres tables.
| Type de requête | Exemple | Note |
|---|---|---|
| Mesures de CID | {serviceRoot}/data/Customer_Measure?$filter=CustomerId eq '{CID}' |
|
| Marques enrichies de CID | {serviceRoot}/data/BrandShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}' |
|
| Centres d’intérêt enrichis de CID | {serviceRoot}/data/InterestShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}' |
|
| Dans-Clause + Développer | {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId in ('{CID}', '{CID}') |
Limitations
L’API Customer Insights renvoie un maximum de 100 objets par défaut. Vous pouvez analyser plus de 100 objets renvoyés en utilisant des techniques de pagination standard. Vous pouvez également exporter vos données.
Les requêtes suivants ne sont pas pris en charge :
-
$filtersur les tables sources ingérées. Vous ne pouvez exécuter les requêtes $filter que sur les tables système créées par Customer Insights - Data. -
$expandd’une requête$search. Par exemple :Customer?$expand=UnifiedActivity$top=10&$skip=0&$search="corey". -
$expandde$selectsi seul un sous-ensemble d’attributs est sélectionné. Par exemple :Customer?$select=CustomerId,FullName&$expand=UnifiedActivity&$filter=CustomerId eq '{CID}'. -
$expanda enrichi les affinités de marque ou d’intérêt pour un client donné. Par exemple :Customer?$expand=BrandShareOfVoiceFromMicrosoft&$filter=CustomerId eq '518291faaa12f6d853c417835d40eb10'. - Interrogez les tables de sortie du modèle de prédiction via la clé secondaire. Par exemple :
OOBModelOutputTable?$filter=HotelCustomerID eq '{AK}'.
-