Extremo de audiencias
Una audiencia es un conjunto de personas que comparten comportamientos o características similares. Estas colecciones de personas se pueden generar mediante Adobe Experience Platform o desde fuentes externas. Puede usar el complemento /audiences
en la API de segmentación, lo que le permite recuperar, crear, actualizar y eliminar audiencias mediante programación.
Introducción
Los extremos utilizados en esta guía forman parte del Adobe Experience Platform Segmentation Service API. Antes de continuar, consulte la guía de introducción para obtener información importante que necesita conocer para realizar llamadas correctamente a la API de, incluidos los encabezados obligatorios y cómo leer llamadas de API de ejemplo.
Recuperación de una lista de audiencias list
Puede recuperar una lista de todas las audiencias de su organización realizando una solicitud de GET a /audiences
punto final.
Formato de API
El /audiences
el punto de conexión admite varios parámetros de consulta para filtrar los resultados. Aunque estos parámetros son opcionales, se recomienda encarecidamente su uso para ayudar a reducir la costosa sobrecarga al enumerar recursos. Si realiza una llamada a este extremo sin parámetros, se recuperarán todas las audiencias disponibles para su organización. Se pueden incluir varios parámetros separados por el símbolo et (&
).
GET /audiences
GET /audiences?{QUERY_PARAMETERS}
Al recuperar una lista de audiencias, se pueden utilizar los siguientes parámetros de consulta:
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
Solicitud
La siguiente solicitud recupera las dos últimas audiencias creadas en su organización.
code language-shell |
---|
|
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con una lista de audiencias creadas en su organización 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 | ||
---|---|---|
Propiedad | Tipo de audiencia | Descripción |
id |
Ambas | Un identificador de solo lectura generado por el sistema para la audiencia. |
audienceId |
Ambas | Si la audiencia es una audiencia generada por Platform, este es el mismo valor que la id . Si la audiencia se genera externamente, el cliente proporciona este valor. |
schema |
Ambas | El esquema Experience Data Model (XDM) de la audiencia. |
imsOrgId |
Ambas | El ID de la organización a la que pertenece la audiencia. |
sandbox |
Ambas | Información sobre la zona protegida a la que pertenece la audiencia. Encontrará más información sobre las zonas protegidas en la información general sobre zonas protegidas. |
name |
Ambas | El nombre de la audiencia. |
description |
Ambas | Una descripción de la audiencia. |
expression |
Generado por Platform | La expresión de lenguaje de consulta de perfil (PQL) de la audiencia. Puede encontrar más información sobre las expresiones PQL en la Guía de expresiones PQL. |
mergePolicyId |
Generado por Platform | El ID de la política de combinación a la que está asociada la audiencia. Encontrará más información sobre las políticas de combinación en la guía de políticas de combinación. |
evaluationInfo |
Generado por Platform | Muestra cómo se evaluará la audiencia. Los posibles métodos de evaluación incluyen por lotes, sincrónico (streaming) o continuo (edge). Encontrará más información sobre los métodos de evaluación en la resumen de segmentación |
dependents |
Ambas | Una matriz de ID de audiencia que dependen de la audiencia actual. Se utilizaría si va a crear una audiencia que sea un segmento de un segmento. |
dependencies |
Ambas | Una matriz de ID de audiencia de los que depende la audiencia. Se utilizaría si va a crear una audiencia que sea un segmento de un segmento. |
type |
Ambas | Campo generado por el sistema que muestra si la audiencia es generada por Platform o por un público generado externamente. Los valores posibles incluyen SegmentDefinition y ExternalSegment . A SegmentDefinition hace referencia a una audiencia generada en Platform, mientras que un ExternalSegment hace referencia a una audiencia que no se generó en Platform. |
originName |
Ambas | Campo que hace referencia al nombre del origen de la audiencia. Para audiencias generadas por Platform, este valor es REAL_TIME_CUSTOMER_PROFILE . Para las audiencias generadas en Audience Orchestration, este valor es AUDIENCE_ORCHESTRATION . Para las audiencias generadas en Adobe Audience Manager, este valor es AUDIENCE_MANAGER . Para otras audiencias generadas externamente, este valor será CUSTOM_UPLOAD . |
createdBy |
Ambas | El ID del usuario que creó la audiencia. |
labels |
Ambas | Etiquetas de uso de datos a nivel de objeto y de control de acceso basadas en atributos que son relevantes para la audiencia. |
namespace |
Ambas | El área de nombres al que pertenece la audiencia. Los valores posibles incluyen AAM , AAMSegments , AAMTraits , y AEPSegments . |
linkedAudienceRef |
Ambas | Un objeto que contiene identificadores de otros sistemas relacionados con la audiencia. |
Creación de una nueva audiencia create
Puede crear una audiencia nueva realizando una solicitud de POST a /audiences
punto final.
Formato de API
POST /audiences
Solicitud
accordion | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Una solicitud de ejemplo para crear una audiencia generada por Platform | ||||||||||||||||||||
|
accordion | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Una solicitud de ejemplo para crear una audiencia generada externamente | ||||||||||||||||||||||||||||
|
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con información sobre la audiencia recién creada.
accordion | ||
---|---|---|
Respuesta de ejemplo al recuperar una audiencia generada por Platform. | ||
|
accordion | ||
---|---|---|
Una respuesta de ejemplo al recuperar una audiencia generada externamente. | ||
|
Actualización de un campo en una audiencia update-field
Puede actualizar los campos de una audiencia específica realizando una solicitud al PATCH de la /audiences
y proporciona el ID de la audiencia que desea actualizar en la ruta de solicitud.
Formato de API
PATCH /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
, y es no el audienceId
field.Solicitud
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 | |
---|---|
Propiedad | Descripción |
op |
Para actualizar audiencias, este valor siempre es add . |
path |
La ruta del campo que desea actualizar. |
value |
El valor al que desea actualizar el campo. |
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con información sobre la audiencia recién actualizada.
code language-json |
---|
|
Actualización de una audiencia put
Puede actualizar (sobrescribir) una audiencia específica realizando una solicitud de PUT a /audiences
y proporciona el ID de la audiencia que desea actualizar en la ruta de solicitud.
Formato de API
PUT /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
, y es no el audienceId
field.Solicitud
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 | |
---|---|
Propiedad | Descripción |
audienceId |
El ID de la audiencia. Para audiencias generadas externamente, este valor lo puede proporcionar el usuario. |
name |
El nombre de la audiencia. |
namespace |
El área de nombres de la audiencia. |
description |
Una descripción de la audiencia. |
type |
Campo generado por el sistema que muestra si la audiencia es generada por Platform o por un público generado externamente. Los valores posibles incluyen SegmentDefinition y ExternalSegment . A SegmentDefinition hace referencia a una audiencia generada en Platform, mientras que un ExternalSegment hace referencia a una audiencia que no se generó en Platform. |
lifecycleState |
El estado de la audiencia. Los valores posibles incluyen draft , published , y inactive . draft representa cuándo se crea la audiencia, published cuando se publique la audiencia, y inactive cuando la audiencia ya no está activa. |
datasetId |
El ID del conjunto de datos en el que se pueden encontrar los datos de audiencia. |
labels |
Etiquetas de uso de datos a nivel de objeto y de control de acceso basadas en atributos que son relevantes para la audiencia. |
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con detalles de la audiencia recién actualizada. Tenga en cuenta que los detalles de la audiencia variarán según se trate de una audiencia generada por Platform o por un público generado externamente.
code language-json |
---|
|
Eliminar una audiencia delete
Puede eliminar una audiencia específica realizando una solicitud de DELETE a /audiences
y proporciona el ID de la audiencia que desea eliminar en la ruta de solicitud.
Formato de API
DELETE /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
, y es no el audienceId
field.Solicitud
code language-shell |
---|
|
Respuesta
Una respuesta correcta devuelve el estado HTTP 204 sin mensaje.
Recuperar varias audiencias bulk-get
Puede recuperar varias audiencias realizando una solicitud al POST de /audiences/bulk-get
y proporciona los ID de las audiencias que desea recuperar.
Formato de API
POST /audiences/bulk-get
Solicitud
code language-shell |
---|
|
Respuesta
Una respuesta correcta devuelve el estado HTTP 207 con información sobre las audiencias solicitadas.
code language-json |
---|
|
Pasos siguientes
Después de leer esta guía, ahora comprende mejor cómo crear, administrar y eliminar audiencias mediante la API de Adobe Experience Platform. Para obtener más información sobre la gestión de público mediante la interfaz de usuario de, lea la Guía de IU de segmentación.