Ejemplos de consulta de OData

Nota

Las tablas de Customer Insights - Data también se pueden acceder mediante API de Dataverse. Le recomendamos que utilice Dataverse API para consultar los datos de Customer Insights, ya que ofrecen un filtrado más extenso, mayor rendimiento y menor latencia. Para obtener más información, consulte API de Dataverse para Customer Insights.

El Protocolo de datos abiertos (OData) es un protocolo de acceso a datos basado en protocolos centrales como HTTP. Utiliza metodologías comúnmente aceptadas como REST para la web. Puedes usar varios tipos de bibliotecas y herramientas para consumir servicios OData.

Para ayudarle a crear sus propias implementaciones basadas en las API de Dynamics 365 Customer Insights - Data, revise algunas consultas de ejemplo solicitadas con frecuencia.

Modifique los ejemplos de consulta para que funcionen en los entornos de destino:

  • {serviceRoot}: https://api.ci.ai.dynamics.com/v1/instances/{instanceId} ¿dónde {instanceId} está el GUID del entorno Customer Insights - Data que quieres consultar? La operación ListAllInstances te ayuda a encontrar a los {InstanceId} que tienes acceso.
  • {CID}: GUID de un registro unificado de clientes. Ejemplo: ce759201f786d590bf2134bff576c369.
  • {AlternateKey}: Identificador de la clave primaria de un registro de cliente en una fuente de datos. Ejemplo: CNTID_1002.
  • {DSname}: Cadena con el nombre de la tabla de una fuente de datos que se ingiere en Customer Insights - Data. Ejemplo: Website_contacts.
  • {SegmentName}: Cadena con el nombre de la tabla de salida de un segmento en Customer Insights - Data. Ejemplo: Male_under_40.

Customer

Ejemplos de consultas para la tabla Cliente.

Tipo de consulta Ejemplo Nota
Id. de cliente único {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}' 
Clave alternativa {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} eq '{AlternateKey}' Las claves alternativas persisten en la tabla de cliente unificada
Select {serviceRoot}/data/Customer?$select=CustomerId,FullName&$filter=customerid eq '1'
En {serviceRoot}/data/Customer?$filter=CustomerId in ('{CID1}',’{CID2}’)
Clave alternativa + In {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} in ('{AlternateKey}','{AlternateKey}')
Buscar {serviceRoot}/data/Customer?$top=10&$skip=0&$search="string" Devuelve los 10 mejores resultados para una cadena de búsqueda
Suscripción de segmento {serviceRoot}/data/Customer?select=*&$filter=IsMemberOfSegment('{SegmentName}')&$top=10 Devuelve un número predeterminado de filas de la tabla de segmentación.
Pertenencia al segmento para un cliente {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}'&IsMemberOfSegment('{SegmentName}') Devuelve el perfil del cliente si es miembro del segmento dado

Actividad unificada

Ejemplos de consultas para la tabla UnifiedActivity:

Tipo de consulta Ejemplo Nota
Actividad de CID {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}'  Enumera las actividades de un perfil de cliente específico
Plazo de tiempo de la actividad {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 Actividades de un perfil de cliente en un período de tiempo
Tipo actividad {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' and ActivityType eq '{ActivityName}'
Actividad por nombre para mostrar {serviceRoot}/data/UnifiedActivity$filter=CustomerId eq ‘{CID}’ and ActivityTypeDisplay eq ‘{ActivityDisplayName}’
Ordenación de actividades {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq ‘{CID}’ & $orderby=ActivityTime asc Ordenar actividades en orden ascendente o descendente
Todas las actividades y medidas para un cliente {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId eq '{CID}' Las actividades y medidas son pares clave/valor adicionales en el perfil de cliente devuelto

Administrar flujos de trabajo

Ejemplos de consultas relacionadas con procesos en Customer Insights - Data como actualizar un origen de datos, unificar datos u obtener el estado de un trabajo de unificación.

Tipo de consulta Ejemplo Nota
Obtener identificadores de origen de datos {serviceRoot}/manage/datasources/v2 Devuelve todas las fuentes de datos de su entorno. A partir de la respuesta, puedes comprobar la friendlyName fuente de datos específica y luego usar su dataSourceId.
Actualizar un origen de datos {serviceRoot}/manage/workflows/main/jobs?operationType=Ingestion&identifiers='{dataSourceId}'&forceRunRequested=true Utiliza la dataSourceId respuesta de la anterior para actualizar una fuente de datos. Esta solicitud utiliza el método POST.
Ejecutar una actualización completa {serviceRoot}/manage/workflows/main/jobs?operationType=all&forceRunRequested=true Actualiza todos los procesos en su entorno. Esta solicitud utiliza el método POST.
Obtener estado de procesos {serviceRoot}/manage/workflows/main/jobs

Otros ejemplos

Ejemplos de consultas para otras tablas:

Tipo de consulta Ejemplo Nota
Medidas de CID {serviceRoot}/data/Customer_Measure?$filter=CustomerId eq '{CID}'
Marcas enriquecidas de CID {serviceRoot}/data/BrandShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}'
Intereses enriquecidos de CID {serviceRoot}/data/InterestShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}'
Cláusula In + Expandir {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId in ('{CID}', '{CID}')

Limitaciones

  • La API de Customer Insights devuelve un máximo de 100 objetos de forma predeterminada. Puede analizar más de los 100 objetos devueltos mediante el uso de técnicas de paginación estándar. Alternativamente, puede exportar sus datos.

  • Las siguientes consultas no son compatibles:

    • $filter en las tablas de origen ingeridas. Solo puede ejecutar las consultas de $filter en las tablas del sistema que Customer Insights - Data crea.
    • $expand de una consulta $search. Por ejemplo: Customer?$expand=UnifiedActivity$top=10&$skip=0&$search="corey".
    • $expand de $select si solo se ha seleccionado un subconjunto de atributos. Por ejemplo: Customer?$select=CustomerId,FullName&$expand=UnifiedActivity&$filter=CustomerId eq '{CID}'.
    • Marca enriquecida de $expand o afinidades de un interés para un cliente determinado. Por ejemplo: Customer?$expand=BrandShareOfVoiceFromMicrosoft&$filter=CustomerId eq '518291faaa12f6d853c417835d40eb10'.
    • Consulte las tablas de salida del modelo de predicción a través de la clave alternativa. Por ejemplo: OOBModelOutputTable?$filter=HotelCustomerID eq '{AK}'.
  • Se actualizó por última vez el