Compartilhar via

APIs do Dataverse para o Customer Insights - Data

  • Artigo

Se você já estiver usando APIs do Customer Insights - Data, como consultar um perfil de cliente ou obter associações de segmento, será recomendável migrar as APIs para as APIs do Dataverse. O suporte para consulta de metadados, como obter definição de segmento e gerenciamento do fluxo de trabalho, estará disponível em breve para APIs do Dataverse.

Se você está começando a consultar dados usando APIs, recomendamos usar APIs do Dataverse.

Importante

Só é recomendável usar APIs do Dataverse para ler dados (GET), e não gravar dados (POST/PATCH/PUT), pois isso pode causar problemas no processamento do Customer Insights - Data.

As APIs do Dataverse têm as seguintes vantagens:

  • Recursos estendidos para filtragem e classificação

  • Escala e desempenho melhorados

  • Experiência de API consistente em aplicativos do Dynamics 365 e do Power Platform

Consultas de amostra

Para começar a usar as APIs do Dataverse, crie um registro de aplicativo no Azure e solicite permissões para o Dataverse e conceda as permissões de visualizador do aplicativo no Customer Insights - Data.

Modifique os exemplos de consulta para fazê-los funcionar nos ambientes de destino:

  • {serviceRoot}: {Organization URI}/api/data/v9.2/ em que {URI da Organização} é o URI do locatário do Dataverse associado do ambiente. Por exemplo: https://{mydvorg}.crm.dynamics.com

  • {CID}: GUID de um registro de cliente unificado. Por exemplo: ce759201f786d590bf2134bff576c369.

  • {AlternateKey}: identificador da chave primária de um registro de cliente em uma fonte de dados. Por exemplo: CNTID_1002.

  • {DSname}: cadeia de caracteres com o nome da tabela de uma fonte de dados ingerida no Customer Insights - Data. Por exemplo: Website_contacts.

  • {SegmentName}: cadeia de caracteres com o nome da tabela de saída de um segmento. Por exemplo: Male_under_40.

  • {CookieId}: identificador de cada visitante do site. Isso é gerado automaticamente durante o uso do script de rastreamento da Web. Por exemplo: 3f43317e-d1ef-4cd3-9917-2d3342111d1a.

Customer

Consultas de exemplo da tabela CustomerProfile e associações de segmento.

Tipo de consulta Exemplo Observação
Obter todos os clientes {serviceRoot}/msdynci_customerprofiles
Obter um cliente por ID {serviceRoot}/msdynci_customerprofiles?$filter=msdynci_customerid eq '{CID}'
Obter um cliente por chave alternativa {serviceRoot}/msdynci_customerprofiles?$filter={msdynci_alternate_column} eq '{AK}' As chaves alternativas persistem na tabela de clientes unificada no formato msdynci_DSname_TableName_PrimaryKeyColumnName
Obter atributos selecionados para um cliente {serviceRoot}/msdynci_customerprofiles?$select=msdynci_fullname&$filter=msdynci_customerid eq '{CID}'
Obter clientes por IDs (entrada) {serviceRoot}/msdynci_customerprofiles?$filter=msdynci_customerid eq '{CID1}' or msdynci_customerid eq '{CID2}'
Obter clientes por chaves alternativas (entrada) {serviceRoot}/msdynci_customerprofiles?$filter={msdynci_alternate_column} eq '{AK1}' or {msdynci_alternate_column} eq '{AK2}'
Pesquisar clientes {serviceRoot}/msdynci_customerprofiles?$filter=contains(msdynci_lastname,'string')&$top=10
Obter todos os clientes membros de um segmento {serviceRoot}/msdynci_segmentmemberships?$filter=contains(msdynci_segments,'\"{SegmentName}\"')&$select=msdynci_customerid
Obter um cliente se ele for membro de um segmento {serviceRoot}/msdynci_segmentmemberships?$filter=contains(msdynci_segments,'\"{SegmentName}\"') and msdynci_customerid eq '{CID}'&$select=msdynci_customerid
Obter todas as associações de segmento de um cliente {serviceRoot}/msdynci_segmentmemberships?$filter=msdynci_customerid eq '{CID}'&$select=msdynci_segments

Personalização da Web

Consultas de amostra para personalizar o site com base no CookieId. A resposta retorna clientes conhecidos e desconhecidos.

Tipo de consulta Exemplo Observação
Obter um cliente por CookieId {serviceRoot}/msdynci_personalizationprofiles(cookieid='{cookieId}')
Obter um cliente por CookieId e incluir segmentos, medidas, atividades {serviceRoot}/msdynci_personalizationprofiles(cookieid='{cookieId}',include=['segmentmembership','measures','unifiedactivity'])
Obter exibições de página recentes (últimas 10) de um cliente por CookieId {serviceRoot}/msdynci_pageviews(cookieid='{cookieId}',top=10) Isso pode ser alterado para retornar até 200 exibições de página recentes
Obter cliques de página recentes (últimas 10) de um cliente por CookieId {serviceRoot}/msdynci_pageclicks(cookieid='{cookieId}',top=10) Isso pode ser alterado para retornar até 200 cliques de página recentes

Atividade unificada

Consultas de exemplo para a tabela UnifiedActivity:

Tipo de consulta Exemplo Observação
Obter todas as atividades de um cliente {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}'
Obter todas as atividades de um cliente dentro de um período {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
Obter todas as atividades de um activityType de um cliente {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytype eq '{ActivityType}'
Obter todas as atividades de um activityDisplayName de um cliente {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytypedisplay eq '{ActivityDisplayName}'
Obter todas as atividades de um cliente e classificá-las {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}'&$orderby=msdynci_activitytime asc

Outros exemplos

Consultas de exemplo para outras tabelas:

Tipo de consulta Exemplo Observação
Obter todas as medidas de um cliente {serviceRoot}/msdynci_customermeasures?$filter=msdynci_customerid eq '{CID}'
Obter marcas sofisticadas de um cliente {serviceRoot}/msdynci_enrichments?$filter=msdynci_customerid eq '{CID}' and msdynci_enrichmentprovider eq 'BrandShareOfVoiceFromMicrosoft'
Obter interesses sofisticados de um cliente {serviceRoot}/msdynci_enrichments?$filter=msdynci_customerid eq '{CID}' and msdynci_enrichmentprovider eq 'InterestShareOfVoiceFromMicrosoft'
Obter resultados do modelo de IA de um cliente {serviceRoot}/msdynci_predictions?$filter=msdynci_customerid eq '{CID}' and msdynci_modelprovider eq 'ChurnModel'

Próximas etapas