Insights do Cliente do Dynamics 365 (versão prévia)
O conector do Dynamics 365 Customer Insights fornece um conjunto de APIs para interagir com instâncias do Dynamics 365 Customer Insights.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Microsoft |
| URL |
Suporte do Microsoft LogicApps Suporte do Microsoft Power Automate Suporte do Microsoft Power Apps |
| Metadados do conector | |
|---|---|
| Publicador | Microsoft |
Para se inscrever no Dynamics 365 Customer Insights, clique aqui.
Para usar esse conector no Power Apps, saiba mais aqui.
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Criar item (versão prévia) |
Esta operação cria um item em uma entidade |
| Envia o relatório de status |
Envia o relatório de status. |
| Envia o relatório de status V2 |
Envia o relatório de status V2. |
| Item de atualização (versão prévia) |
Esta operação atualiza um item em uma entidade |
| Obter entidades |
Esta operação obtém entidades de uma instância |
| Obter item |
Esta operação obtém um item de uma entidade |
| Obter itens de uma entidade |
Essa operação obtém itens de uma entidade. Dependendo da entidade, os campos podem ser definidos como filtros:
|
| Recuperar dados de uma partição (versão prévia) |
Recuperar dados de uma partição. |
| Recuperar partições para uma entidade (versão prévia) |
Recuperar partições para uma entidade. |
| Recuperar partições para uma entidade V2 (versão prévia) |
Recuperar partições para uma entidade V2. |
Criar item (versão prévia)
Esta operação cria um item em uma entidade
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
instanceId
|
dataset | True | string |
Identificador de uma instância |
|
entityName
|
table | True | string |
Nome de uma entidade |
|
recordItem
|
item | True | dynamic |
Registro a ser criado |
Envia o relatório de status
Envia o relatório de status.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da instância
|
dataset | True | string |
Selecione uma instância. |
|
Tipo de relatório
|
reportType | True | string |
Selecione um tipo de relatório. |
Envia o relatório de status V2
Envia o relatório de status V2.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da instância
|
dataset | True | string |
Selecione uma instância. |
|
Tipo de relatório
|
reportType | True | string |
Selecione um tipo de relatório. |
Item de atualização (versão prévia)
Esta operação atualiza um item em uma entidade
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
instanceId
|
dataset | True | string |
Identificador de uma instância |
|
entityName
|
table | True | string |
Nome de uma entidade |
|
itemIdentifier
|
id | True | string |
Identificador do item |
|
recordItem
|
item | True | dynamic |
Registro a ser atualizado |
Retornos
Obter entidades
Esta operação obtém entidades de uma instância
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
instanceId
|
dataset | True | string |
Identificador de uma instância |
Retornos
Representa uma lista de tabelas.
- Corpo
- TablesList
Obter item
Esta operação obtém um item de uma entidade
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
instanceId
|
dataset | True | string |
Identificador de uma instância |
|
entityName
|
table | True | string |
Nome de uma entidade |
|
itemIdentifier
|
id | True | string |
Identificador do item |
Retornos
Obter itens de uma entidade
Essa operação obtém itens de uma entidade. Dependendo da entidade, os campos podem ser definidos como filtros:
- Entidade UnifiedActivity: campos ActivityId e CustomerId
- Entidade do cliente: campo CustomerId e quaisquer outros campos indexados na instância do Customer Insights
- Quaisquer outras entidades: campo CustomerId.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
instanceId
|
dataset | True | string |
Identificador de uma instância |
|
entityName
|
table | True | string |
Nome de uma entidade |
|
Filtrar Consulta
|
$filter | string |
Uma consulta de filtro ODATA para restringir as entradas retornadas (por exemplo, stringColumn eq 'string' OR numberColumn lt 123). |
|
|
Contagem superior
|
$top | integer |
Número total de entradas a serem recuperadas (padrão = todas). |
|
|
Selecionar Consulta
|
$select | string |
Campos específicos a serem recuperados de entradas (padrão = todos). |
Retornos
Recuperar dados de uma partição (versão prévia)
Recuperar dados de uma partição.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O conjunto de dados do Customer Insights
|
dataset | True | string |
O conjunto de dados do Customer Insights. |
|
A entidade
|
table | True | string |
A entidade. |
|
A referência (URI ou Nome) da partição
|
partitionUri | True | string |
A referência (URI ou Nome) da partição. |
|
Uma linha de colunas separada por vírgulas
|
select | string |
Uma linha de colunas separada por vírgulas. |
|
|
Posição de onde começar a ler, em bytes
|
offsetStart | integer |
Posição de onde começar a ler, em bytes. |
|
|
Máximo de bytes a serem lidos
|
maxSize | integer |
Máximo de bytes a serem lidos. |
|
|
Número máximo de registros a serem retornados
|
maxResults | integer |
Número máximo de registros a serem retornados. |
Retornos
Os dados de uma partição.
- Corpo
- PartitionDataResponse
Recuperar partições para uma entidade (versão prévia)
Recuperar partições para uma entidade.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O conjunto de dados do Customer Insights
|
dataset | True | string |
O conjunto de dados do Customer Insights. |
|
A entidade
|
table | True | string |
A entidade. |
Retornos
- response
- array of Table
Recuperar partições para uma entidade V2 (versão prévia)
Recuperar partições para uma entidade V2.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O conjunto de dados do Customer Insights
|
dataset | True | string |
O conjunto de dados do Customer Insights. |
|
A entidade
|
table | True | string |
A entidade. |
|
O valor partitionDisplayName para o qual filtrar
|
partitionDisplayName | string |
O valor partitionDisplayName para o qual filtrar. |
Retornos
A lista de partições
- Corpo
- PartitionListResponse
Gatilhos
| Dispara um fluxo da fonte de dados quando a atualização é concluída |
Essa operação dispara um fluxo da fonte de dados quando a atualização é concluída no Dynamics 365 Customer Insights. |
| Dispara um fluxo da fonte de dados quando falha na atualização |
Essa operação dispara um fluxo da fonte de dados quando a atualização falha no Dynamics 365 Customer Insights. |
| Dispara um fluxo quando um limite de medida de negócios é cruzado |
Essa operação dispara um fluxo quando um limite de medida de negócios é cruzado no Dynamics 365 Customer Insights. |
| Dispara um fluxo quando um limite de segmento é cruzado |
Essa operação dispara um fluxo quando um limite de segmento é cruzado no Dynamics 365 Customer Insights. |
| Dispara um fluxo quando um processo no Customer Insights é concluído |
Um fluxo é disparado para atualizações agendadas do processo selecionado. Além disso, você pode optar por disparar um fluxo para atualizações manuais. |
| Dispara um fluxo quando uma atualização completa do Customer Insights é concluída |
Essa operação dispara um fluxo quando uma atualização completa do Customer Insights (fontes de dados, segmentos, medidas,...) é concluída. |
Dispara um fluxo da fonte de dados quando a atualização é concluída
Essa operação dispara um fluxo da fonte de dados quando a atualização é concluída no Dynamics 365 Customer Insights.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Ambiente
|
dataset | True | string |
nome do conjunto de dados. |
Retornos
DataSourcesList
- Corpo
- DataSourcesList
Dispara um fluxo da fonte de dados quando falha na atualização
Essa operação dispara um fluxo da fonte de dados quando a atualização falha no Dynamics 365 Customer Insights.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Ambiente
|
dataset | True | string |
nome do conjunto de dados. |
Retornos
DataSourcesList
- Corpo
- DataSourcesList
Dispara um fluxo quando um limite de medida de negócios é cruzado
Essa operação dispara um fluxo quando um limite de medida de negócios é cruzado no Dynamics 365 Customer Insights.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da instância
|
dataset | True | string |
Selecione uma instância. |
|
Nome da Medida Comercial
|
measure | True | string |
Selecione uma medida. |
|
Limite
|
threshold | True | double |
Defina qualquer número como limite. |
Retornos
Dados da Medida comercial
- Corpo
- MeasureData
Dispara um fluxo quando um limite de segmento é cruzado
Essa operação dispara um fluxo quando um limite de segmento é cruzado no Dynamics 365 Customer Insights.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da instância
|
dataset | True | string |
Selecione uma instância. |
|
Nome do segmento
|
segment | True | string |
Selecione um segmento. |
|
Limite
|
threshold | True | integer |
Defina qualquer número como limite. |
Retornos
Dados do segmento
- Corpo
- SegmentData
Dispara um fluxo quando um processo no Customer Insights é concluído
Um fluxo é disparado para atualizações agendadas do processo selecionado. Além disso, você pode optar por disparar um fluxo para atualizações manuais.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da instância
|
dataset | True | string |
Selecione uma instância. |
|
Processo
|
process | string |
Selecione um processo. |
|
|
Incluir processo disparado manualmente
|
includingManualRefreshes | boolean |
Selecione sim se o processo disparado manualmente deve ser incluído. |
Retornos
As informações sobre o processo executado
- Corpo
- ProcessData
Dispara um fluxo quando uma atualização completa do Customer Insights é concluída
Essa operação dispara um fluxo quando uma atualização completa do Customer Insights (fontes de dados, segmentos, medidas,...) é concluída.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da instância
|
dataset | True | string |
Selecione uma instância. |
Retornos
As informações sobre a atualização completa executada
- Corpo
- FullRefreshProcessData
Definições
DataSourcesList
DataSourcesList
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of DataSource |
Lista de fontes de dados |
Fonte de Dados
Classe DataSource
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
RefreshType
|
RefreshType | string |
O tipo de atualização de dados |
|
RefreshObjectId
|
RefreshObjectId | string |
A ID do objeto de atualização |
|
RefreshObjectVersion
|
RefreshObjectVersion | integer |
A versão do objeto refresh |
|
Operation
|
Operation | string |
O nome da operação |
|
JobType
|
JobType | string |
O tipo de trabalho |
|
ErrorCode
|
ErrorCode | string |
O código de erro durante a atualização de dados. |
|
Mensagem de Erro
|
ErrorMessage | string |
A mensagem de erro durante a atualização |
|
ErrorSeverity
|
ErrorSeverity | string |
A servidoridade de erro durante a atualização |
|
StartTimeUtc
|
StartTimeUtc | string |
A hora de início da atualização de dados |
|
EndTimeUtc
|
EndTimeUtc | string |
A hora de término da atualização de dados |
SegmentData
Dados do segmento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
Name | string |
O nome do segmento |
|
DisplayName
|
DisplayName | string |
O nome de exibição do segmento |
|
EvaluationDate
|
EvaluationDate | date-time |
A data de avaliação do segmento |
|
EntityCount
|
EntityCount | integer |
A contagem real de membros do segmento |
|
Limite
|
Threshold | integer |
O limite do segmento |
MeasureData
Dados da Medida comercial
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
Name | string |
O nome da medida |
|
DisplayName
|
DisplayName | string |
O nome de exibição da medida |
|
EvaluationDate
|
EvaluationDate | date-time |
A data de avaliação da medida |
|
Value
|
Value | double |
O valor da medida |
|
ValueDisplayName
|
ValueDisplayName | string |
O nome de exibição do valor |
|
Limite
|
Threshold | double |
O limite de medida |
FullRefreshProcessData
As informações sobre a atualização completa executada
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
NumberOfFailedTasks
|
NumberOfFailedTasks | integer |
O número de tarefas com falha |
|
StartTime
|
StartTime | date-time |
A hora de início da etapa de fluxo de trabalho |
|
EndTime
|
EndTime | date-time |
A hora de término da etapa de fluxo de trabalho |
|
Duração
|
Duration | integer |
A duração do processo em minutos |
|
Situação
|
Status | string |
O status da etapa de fluxo de trabalho |
|
Página de Status
|
StatusPage | string |
O link para a página de status |
ProcessData
As informações sobre o processo executado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
StartTime
|
StartTime | date-time |
A hora de início da etapa de fluxo de trabalho |
|
EndTime
|
EndTime | date-time |
A hora de término da etapa de fluxo de trabalho |
|
Duração
|
Duration | integer |
A duração do processo em minutos |
|
Situação
|
Status | string |
O status da etapa de fluxo de trabalho |
|
Página de Status
|
StatusPage | string |
O link para a página de status |
Table
Representa uma tabela.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
Name | string |
O nome da tabela. O nome é usado no runtime. |
|
DisplayName
|
DisplayName | string |
O nome de exibição da tabela. |
|
DynamicProperties
|
DynamicProperties | object |
Propriedades de tabela adicionais fornecidas pelo conector para os clientes. |
PartitionListResponse
A lista de partições
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Header
|
Header | string |
Cabeçalho que contém os atributos da entidade |
|
Partitions
|
Partitions | array of Table |
Lista de partições |
PartitionDataResponse
Os dados de uma partição.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
OffsetStart
|
OffsetStart | integer |
O deslocamento inicial. |
|
OffsetEnd
|
OffsetEnd | integer |
O deslocamento final. |
|
Tamanho
|
Size | integer |
O número de dados retornados. |
|
Itens
|
Items | array of object |
O dicionário que contém dados do máximo de itens 'Size' de uma partição, de deslocamento 'OffsetStart' para 'OffsetEnd'. |
|
items
|
Items | object |
TablesList
Representa uma lista de tabelas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of Table |
Lista de tabelas |