Partilhar via

APIs do Dataverse para o Customer Insights - Data

  • Artigo

Se já estiver a utilizar APIs do Customer Insights - Data, como consultar um Perfil de Cliente ou obter associações a segmentos, recomendamos que, em vez disso, migre as suas APIs para APIs do Dataverse. O suporte para consultar metadados, como obter definição de segmento e a gestão de fluxos de trabalho, está prestes a chegar às APIs do Dataverse.

Se estiver a começar a consultar dados utilizando APIs, recomendamos que, em vez disso, utilize APIs do Dataverse.

Importante

Recomenda-se a utilização de APIs do Dataverse apenas para ler dados (GET) e não para escrever dados (POST/PATCH/PUT), pois podem causar problemas com o processamento do Customer Insights - Data.

As APIs do Dataverse têm as seguintes vantagens:

  • Capacidades expandidas para filtragem e ordenação

  • Dimensionamento e desempenho melhorados

  • Experiência consistente de API entre aplicações Dynamics 365 e Power Platform

Consultas de amostra

Para começar a utilizar APIs do Dataverse, crie um registo de aplicações no Azure e peça permissões para o Dataverse e conceda à sua aplicação permissões de Visualizador no Customer Insights - Data.

Modifique as amostras de consulta para as fazer funcionar nos ambientes de destino:

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

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

  • {AlternateKey}: identificador da chave primária de um registo de cliente numa origem de dados. Por exemplo: CNTID_1002.

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

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

  • {CookieId}: identificador para cada visitante do site. Isto é gerado automaticamente quando utiliza o script de monitorização da Web. Por exemplo: 3f43317e-d1ef-4cd3-9917-2d3342111d1a.

Cliente

Consultas de amostra para a tabela CustomerProfile e associações a segmentos.

Tipo de consulta Exemplo Nota
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
Obtenha atributos selecionados para um cliente {serviceRoot}/msdynci_customerprofiles?$select=msdynci_fullname&$filter=msdynci_customerid eq '{CID}'
Obter clientes por ID (In) {serviceRoot}/msdynci_customerprofiles?$filter=msdynci_customerid eq '{CID1}' or msdynci_customerid eq '{CID2}'
Obter clientes por Chaves Alternativas (In) {serviceRoot}/msdynci_customerprofiles?$filter={msdynci_alternate_column} eq '{AK1}' or {msdynci_alternate_column} eq '{AK2}'
Procurar clientes {serviceRoot}/msdynci_customerprofiles?$filter=contains(msdynci_lastname,'string')&$top=10
Obter todos os clientes que são membros de um segmento {serviceRoot}/msdynci_segmentmemberships?$filter=contains(msdynci_segments,'\"{SegmentName}\"')&$select=msdynci_customerid
Obter um cliente se 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 a segmentos de um cliente {serviceRoot}/msdynci_segmentmemberships?$filter=msdynci_customerid eq '{CID}'&$select=msdynci_segments

Personalização da Web

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

Tipo de consulta Exemplo Nota
Obter um cliente por CookieId {serviceRoot}/msdynci_p13nprofile(cookieid='{cookieId}')
Obter um cliente por CookieId e incluir Segmentos, Medidas, Atividades {serviceRoot}/msdynci_p13nprofile(cookieid='{cookieId}',include=['segmentmembership','measures','unifiedactivity'])
Obter visualizações de página recentes (últimas 10) de um cliente por CookieId {serviceRoot}/msdynci_pageviews(cookieid='{cookieId}',top=10) Isto pode ser alterado para devolver até 200 vistas de página recentes
Obter cliques de página recentes (últimos 10) de um cliente por CookieId {serviceRoot}/msdynci_pageclicks(cookieid='{cookieId}',top=10) Isto pode ser alterado para devolver até 200 cliques de página recentes

Atividade unificada

Consultas de amostra para a tabela UnifiedActivity:

Tipo de consulta Exemplo Nota
Obter todas as atividades de um cliente {serviceRoot}/msdynci_p13nprofile?$filter=msdynci_customerid eq '{CID}'
Obter todas as atividades de um cliente dentre de um período de tempo {serviceRoot}/msdynci_p13nprofile?$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_p13nprofile?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytype eq '{ActivityType}'
Obter todas as atividades de um activityDisplayName de um cliente {serviceRoot}/msdynci_p13nprofile?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytypedisplay eq '{ActivityDisplayName}'
Obter todas as atividades de um cliente e ordená-las {serviceRoot}/msdynci_p13nprofile?$filter=msdynci_customerid eq '{CID}'&$orderby=msdynci_activitytime asc

Outros exemplos

Consultas de amostra para outras tabelas:

Tipo de consulta Exemplo Nota
Obter todas as medidas de um cliente {serviceRoot}/msdynci_customermeasures?$filter=msdynci_customerid eq '{CID}'
Obter marcas melhoradas de um cliente {serviceRoot}/msdynci_enrichments?$filter=msdynci_customerid eq '{CID}' and msdynci_enrichmentprovider eq 'BrandShareOfVoiceFromMicrosoft'
Obter interesses melhorados de um cliente {serviceRoot}/msdynci_enrichments?$filter=msdynci_customerid eq '{CID}' and msdynci_enrichmentprovider eq 'InterestShareOfVoiceFromMicrosoft'
Obter resultados de modelo de IA de um cliente {serviceRoot}/msdynci_predictions?$filter=msdynci_customerid eq '{CID}' and msdynci_modelprovider eq 'ChurnModel'

Próximos passos