Exemplos de consultas de OData
Nota
As tabelas Customer Insights - Data também podem ser acedidas através de APIs Dataverse. Recomendamos que utilize APIs Dataverse para consultar dados do Customer Insights, uma vez que oferecem filtragem mais extensiva, maior débito e menor latência. Para mais informações, consulte APIs do Dataverse para o Customer Insights.
O Protocolo de Dados Aberto (OData) é um protocolo de acesso a dados criado com protocolos base, como HTTP. Utiliza metodologias normalmente aceites como o REST para a Web. Existem vários tipos de bibliotecas e ferramentas que podem ser utilizadas para consumir serviços de OData.
Para o ajudar a criar implementações próprias com base nas APIs do Dynamics 365 Customer Insights - Data, reveja alguns exemplos de consultas frequentes.
Modifique as amostras de consulta para as fazer funcionar nos ambientes de destino:
- {serviceRoot}:
https://api.ci.ai.dynamics.com/v1/instances/{instanceId}onde {instanceId} está o GUID do ambiente do Customer Insights - Data que pretende consultar. A operação ListAllInstances permite-lhe encontrar a {InstanceId} a que tem acesso. - {CID}: GUID de um registo de cliente unificado. Exemplo:
ce759201f786d590bf2134bff576c369. - {AlternateKey}: identificador da chave primária de um registo de cliente numa origem de dados. Exemplo:
CNTID_1002 - {DSname}: cadeia com o nome da tabela de uma origem de dados que é ingerida no Customer Insights - Data. Exemplo:
Website_contacts. - {SegmentName}: cadeia com o nome da tabela de saída de um segmento no Customer Insights - Data. Exemplo:
Male_under_40.
Cliente
Consultas de amostra para a tabela Cliente.
| Tipo de consulta | Exemplo | Nota |
|---|---|---|
| ID de cliente único | {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}' |
|
| Chave alternativa | {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} eq '{AlternateKey}' |
As chaves alternativas persistem na tabela de cliente unificada |
| Selecione | {serviceRoot}/data/Customer?$select=CustomerId,FullName&$filter=customerid eq '1' |
|
| Está presente em | {serviceRoot}/data/Customer?$filter=CustomerId in ('{CID1}',’{CID2}’) |
|
| Chave Alternativa + In | {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} in ('{AlternateKey}','{AlternateKey}') |
|
| Pesquisar | {serviceRoot}/data/Customer?$top=10&$skip=0&$search="string" |
Devolve os 10 resultados principais de uma cadeia de pesquisa |
| Associação a segmentos | {serviceRoot}/data/Customer?select=*&$filter=IsMemberOfSegment('{SegmentName}')&$top=10 |
Devolve um número predefinido de linhas da tabela de segmentação. |
| Associação a segmentos para um cliente | {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}'&IsMemberOfSegment('{SegmentName}') |
Devolve o perfil de cliente se for membro de um determinado segmento |
Atividade unificada
Consultas de amostra para a tabela UnifiedActivity:
| Tipo de consulta | Exemplo | Nota |
|---|---|---|
| Atividade de CID | {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' |
Lista atividades de um perfil de cliente específico |
| Intervalo de tempo da atividade | {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 |
Atividades de um perfil de cliente num período de tempo |
| Tipo de atividade | {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' and ActivityType eq '{ActivityName}' |
|
| Atividade por nome a apresentar | {serviceRoot}/data/UnifiedActivity$filter=CustomerId eq ‘{CID}’ and ActivityTypeDisplay eq ‘{ActivityDisplayName}’ |
|
| Ordenação de atividades | {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq ‘{CID}’ & $orderby=ActivityTime asc |
Ordenar atividades por ordem ascendente ou descendente |
| Todas as atividades e medidas de um cliente | {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId eq '{CID}' |
As atividades e medidas são pares de chaves/valores adicionais no perfil do cliente obtido |
Gerir fluxo de trabalho
Consultas de amostra relacionadas com processos no Customer Insights - Data, como exemplo, atualizar uma origem de dados, unificar dados ou obter o estado de uma tarefa de unificação.
| Tipo de consulta | Exemplo | Nota |
|---|---|---|
| Obter IDs de origem de dados | {serviceRoot}/manage/datasources/v2 |
Devolve todas as origens de dados no seu ambiente. A partir da resposta, pode verificar o "friendlyName" para uma origem de dados específica e, em seguida, utilizar o respetivo "dataSourceId". |
| Atualizar uma origem de dados | {serviceRoot}/manage/workflows/main/jobs?operationType=Ingestion&identifiers='{dataSourceId}'&forceRunRequested=true |
Utilize o "dataSourceId" da resposta acima para atualizar uma origem de dados. Este é um pedido POST. |
| Executar uma atualização completa | {serviceRoot}/manage/workflows/main/jobs?operationType=all&forceRunRequested=true |
Atualiza todos os processos no seu ambiente. Este é um pedido POST. |
| Obter o estado dos processos | {serviceRoot}/manage/workflows/main/jobs |
Outros exemplos
Consultas de amostra para outras tabelas:
| Tipo de consulta | Exemplo | Nota |
|---|---|---|
| Medidas de CID | {serviceRoot}/data/Customer_Measure?$filter=CustomerId eq '{CID}' |
|
| Conteúdo melhorado de CID | {serviceRoot}/data/BrandShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}' |
|
| Melhoramento de interesses de CID | {serviceRoot}/data/InterestShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}' |
|
| Na cláusula + Expandir | {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId in ('{CID}', '{CID}') |
Limitações
Por predefinição, a API Customer Insights obtém um máximo de 100 objetos. Pode analisar mais de 100 objetos obtidos utilizando técnicas de paginação padrão. Alternativamente, pode exportar os seus dados.
As seguintes consultas não são suportadas:
-
$filterem tabelas de origem ingeridas. Só pode executar consultas $filter em tabelas de sistema criadas pelo Customer Insights - Data. -
$expanda partir de uma consulta$search. Por exemplo:Customer?$expand=UnifiedActivity$top=10&$skip=0&$search="corey". -
$expanda partir de$selectse apenas um subconjunto de atributos estiver selecionado. Por exemplo:Customer?$select=CustomerId,FullName&$expand=UnifiedActivity&$filter=CustomerId eq '{CID}'. -
$expandmelhorou afinidades de marca e de interesse para um determinado cliente. Por exemplo:Customer?$expand=BrandShareOfVoiceFromMicrosoft&$filter=CustomerId eq '518291faaa12f6d853c417835d40eb10'. - Consulte tabelas de saída do modelo de predição através de chave alternativa. Por exemplo:
OOBModelOutputTable?$filter=HotelCustomerID eq '{AK}'.
-