Endpoint de públicos
Um público-alvo é uma coleção de pessoas que compartilham comportamentos e/ou características semelhantes. Essas coleções de pessoas podem ser geradas usando o Adobe Experience Platform ou de fontes externas. Você pode usar o /audiences
endpoint na API de segmentação, que permite recuperar, criar, atualizar e excluir públicos de forma programática.
Introdução
Os endpoints usados neste guia fazem parte da Adobe Experience Platform Segmentation Service API. Antes de continuar, reveja o guia de introdução para obter informações importantes que você precisa saber para fazer chamadas com êxito para a API, incluindo cabeçalhos necessários e como ler chamadas de API de exemplo.
Recuperar uma lista de públicos list
Você pode recuperar uma lista de todos os públicos-alvo de sua organização fazendo uma solicitação GET para a /audiences
terminal.
Formato da API
A variável /audiences
O endpoint oferece suporte a vários parâmetros de consulta para ajudar a filtrar os resultados. Embora esses parâmetros sejam opcionais, seu uso é altamente recomendado para ajudar a reduzir a sobrecarga cara ao listar recursos. Se você fizer uma chamada para esse endpoint sem parâmetros, todos os públicos-alvo disponíveis para sua organização serão recuperados. Vários parâmetros podem ser incluídos, separados por "E" comercial (&
).
GET /audiences
GET /audiences?{QUERY_PARAMETERS}
Os seguintes parâmetros de consulta podem ser usados ao recuperar uma lista de públicos-alvo:
start
start=5
limit
limit=10
sort
attributeName:[desc/asc]
.sort=updateTime:desc
property
property=
property=audienceId==test-audience-id
name
name=Sample
description
description=Test Description
Solicitação
A solicitação a seguir recupera os dois últimos públicos-alvo criados em sua organização.
code language-shell |
---|
|
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com uma lista de públicos-alvo que foram criados em sua organização como JSON.
code language-json |
---|
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-row-3 12-row-3 13-row-3 14-row-3 15-row-3 16-row-3 17-row-3 18-row-3 | ||
---|---|---|
Propriedade | Tipo de público | Descrição |
id |
Ambos | Um identificador somente leitura gerado pelo sistema para o público-alvo. |
audienceId |
Ambos | Se o público-alvo for gerado pela Platform, ele terá o mesmo valor que o id . Se o público-alvo for gerado externamente, esse valor será fornecido pelo cliente. |
schema |
Ambos | O esquema do Experience Data Model (XDM) do público-alvo. |
imsOrgId |
Ambos | A ID da organização à qual o público pertence. |
sandbox |
Ambos | Informações sobre a sandbox à qual o público-alvo pertence. Mais informações sobre sandboxes podem ser encontradas no visão geral das sandboxes. |
name |
Ambos | O nome do público-alvo. |
description |
Ambos | Uma descrição do público. |
expression |
Gerado pela plataforma | A expressão Profile Query Language (PQL) do público-alvo. Mais informações sobre expressões PQL podem ser encontradas no Guia de expressões PQL. |
mergePolicyId |
Gerado pela plataforma | A ID da política de mesclagem à qual o público-alvo está associado. Mais informações sobre políticas de mesclagem podem ser encontradas no guia de políticas de mesclagem. |
evaluationInfo |
Gerado pela plataforma | Mostra como o público-alvo será avaliado. Os possíveis métodos de avaliação incluem batch, síncrono (streaming) ou contínuo (borda). Mais informações sobre os métodos de avaliação podem ser encontradas no visão geral da segmentação |
dependents |
Ambos | Uma matriz de IDs de público-alvo que dependem do público-alvo atual. Isso seria usado se você estivesse criando um público-alvo que é um segmento de um segmento. |
dependencies |
Ambos | Uma matriz de IDs de público-alvo das quais o público-alvo depende. Isso seria usado se você estivesse criando um público-alvo que é um segmento de um segmento. |
type |
Ambos | Um campo gerado pelo sistema que mostra se o público-alvo é gerado pela Platform ou um público-alvo gerado externamente. Os valores possíveis incluem SegmentDefinition e ExternalSegment . A SegmentDefinition refere-se a um público-alvo gerado na Platform, enquanto um ExternalSegment refere-se a um público-alvo que não foi gerado na Platform. |
originName |
Ambos | Um campo que se refere ao nome da origem do público-alvo. Para públicos gerados pela Platform, esse valor será REAL_TIME_CUSTOMER_PROFILE . Para públicos gerados no Audience Orchestration, esse valor será AUDIENCE_ORCHESTRATION . Para públicos gerados no Adobe Audience Manager, esse valor será AUDIENCE_MANAGER . Para outros públicos gerados externamente, esse valor será CUSTOM_UPLOAD . |
createdBy |
Ambos | A ID do usuário que criou o público-alvo. |
labels |
Ambos | Uso de dados no nível do objeto e rótulos de controle de acesso baseados em atributos que são relevantes para o público-alvo. |
namespace |
Ambos | O namespace ao qual o público-alvo pertence. Os valores possíveis incluem AAM , AAMSegments , AAMTraits , e AEPSegments . |
linkedAudienceRef |
Ambos | Um objeto que contém identificadores para outros sistemas relacionados ao público-alvo. |
Criar um novo público create
Você pode criar um novo público-alvo fazendo uma solicitação POST para a /audiences
terminal.
Formato da API
POST /audiences
Solicitação
accordion | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Um exemplo de solicitação para criar um público-alvo gerado pela Platform | ||||||||||||||||||||
|
accordion | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Um exemplo de solicitação para criar um público-alvo gerado externamente | ||||||||||||||||||||||||||||
|
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com informações sobre o público recém-criado.
accordion | ||
---|---|---|
Uma resposta de amostra ao recuperar um público-alvo gerado pela Platform. | ||
|
accordion | ||
---|---|---|
Uma resposta de amostra ao recuperar um público-alvo gerado externamente. | ||
|
Atualizar um campo em um público update-field
Você pode atualizar os campos de público-alvo específico fazendo uma solicitação PATCH para o /audiences
e fornecendo a ID do público-alvo que você deseja atualizar no caminho da solicitação.
Formato da API
PATCH /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
e é não o audienceId
campo.Solicitação
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 | |
---|---|
Propriedade | Descrição |
op |
Para atualizar públicos-alvo, esse valor sempre é add . |
path |
O caminho do campo que você deseja atualizar. |
value |
O valor para o qual você deseja atualizar o campo. |
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com informações sobre o público recém-atualizado.
code language-json |
---|
|
Atualizar um público put
Você pode atualizar (substituir) um público-alvo específico fazendo uma solicitação PUT para o /audiences
e fornecendo a ID do público-alvo que você deseja atualizar no caminho da solicitação.
Formato da API
PUT /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
e é não o audienceId
campo.Solicitação
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 | |
---|---|
Propriedade | Descrição |
audienceId |
A ID da audiência. Para públicos gerados externamente, esse valor pode ser fornecido pelo usuário. |
name |
O nome do público-alvo. |
namespace |
O namespace do público. |
description |
Uma descrição do público. |
type |
Um campo gerado pelo sistema que mostra se o público-alvo é gerado pela Platform ou um público-alvo gerado externamente. Os valores possíveis incluem SegmentDefinition e ExternalSegment . A SegmentDefinition refere-se a um público-alvo gerado na Platform, enquanto um ExternalSegment refere-se a um público-alvo que não foi gerado na Platform. |
lifecycleState |
O status do público. Os valores possíveis incluem draft , published , e inactive . draft representa quando o público é criado, published quando o público-alvo é publicado e inactive quando o público-alvo não estiver mais ativo. |
datasetId |
A ID do conjunto de dados em que os dados de público-alvo podem ser encontrados. |
labels |
Uso de dados no nível do objeto e rótulos de controle de acesso baseados em atributos que são relevantes para o público-alvo. |
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com detalhes do público recém-atualizado. Observe que os detalhes do seu público-alvo serão diferentes dependendo se for um público-alvo gerado pela Platform ou um público gerado externamente.
code language-json |
---|
|
Excluir um público delete
Você pode excluir um público-alvo específico fazendo uma solicitação DELETE para a /audiences
e fornecendo a ID do público-alvo que você deseja excluir no caminho da solicitação.
Formato da API
DELETE /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
e é não o audienceId
campo.Solicitação
code language-shell |
---|
|
Resposta
Uma resposta bem-sucedida retorna o status HTTP 204 sem mensagem.
Recuperar vários públicos-alvo bulk-get
Você pode recuperar vários públicos-alvo fazendo uma solicitação POST para a /audiences/bulk-get
e fornecendo as IDs dos públicos-alvo que você deseja recuperar.
Formato da API
POST /audiences/bulk-get
Solicitação
code language-shell |
---|
|
Resposta
Uma resposta bem-sucedida retorna o status HTTP 207 com informações com os públicos-alvo solicitados.
code language-json |
---|
|
Próximas etapas
Depois de ler este guia, você compreenderá melhor como criar, gerenciar e excluir públicos-alvo usando a API do Adobe Experience Platform. Para obter mais informações sobre o gerenciamento de público-alvo usando a interface do usuário, leia a guia da interface de segmentação.