DOCUMENTACIÓN
- Para comenzar con la Plataforma Magenta Advertising
- Requisitos de cumplimiento para la recopilación de datos del editor
CONSOLA
API DE MARKETPLACE DE DATOS
TRASFERENCIA E INTEGRACIÓN DE DATOS
Atributos
Los atributos representan las etiquetas o segmentos de datos que tienes previsto ofrecer en Audience Marketplace. Cada atributo se compone de un campo obligatorio de Nombre y Descripción, que se mostrarán a los usuarios cuando creen segmentos personalizados y trabajen con tus datos.
Convenciones de nomenclatura para atributos
En lugar de declarar y gestionar complicadas estructuras jerárquicas para organizar tus Atributos, nuestra plataforma espera que nombres tus Atributos según una sencilla convención de nomenclatura. Seguir esta convención nos permite agrupar Atributos relacionados en la consola y al mismo tiempo te da la posibilidad de controlar la jerarquía con la que se muestran.
Recomendamos utilizar la secuencia " > " (espacio seguido de mayor que seguido de espacio) entre elementos jerárquicos.
Por ejemplo, Audience Marketplace organiza algunos de sus Atributos de la siguiente manera:
Intereses y actividades > Arte y entretenimiento > Amantes de la música
Intereses y actividades > Arte y entretenimiento > Amantes de la música > Asistentes a conciertos
Intereses y actividades > Arte y entretenimiento > Amantes de la música > Streamers de música
Intereses y actividades > Arte y entretenimiento > Entusiastas de la fotografía y el vídeo
Intereses y actividades > Arte y entretenimiento > Entusiastas de la fotografía y el vídeo > Editores de fotos
Intereses y actividades > Arte y entretenimiento > Entusiastas de la fotografía y el vídeo > Personas que imprimen fotos
Como puedes ver, esta convención de nomenclatura organiza una jerarquía visual de Atributos para que los clientes puedan elegir a la hora de construir segmentos.
Ten en cuenta que la plataforma Magenta Advertising no "reunirá" automáticamente los atributos. Por ejemplo, dada la lista de Atributos mencionada, si quiero que el Atributo "Amantes de la música" contenga todos los "Asistentes a conciertos" y " Streamers de música", tengo que añadir el atributo "Amantes de la música" a cada identificador de publicidad en el que ponga "Asistentes a conciertos" o "Streamers de música".
Recomendamos que el nombre real del segmento (último nodo del nombre del atributo) no
supere los 20 caracteres como máximo.
Otra advertencia: recomendamos que no incluya tu marca como componente de los nombres de los atributos. Nuestra interfaz de usuario mostrará tu marca cuando los clientes que trabajen en Audience Console vean tus Atributos.
Descripciones de atributos
Las descripciones de los atributos se muestran en la interfaz de usuario para ayudar a los posibles compradores a entender qué hay en cada segmento. Recomendamos proporcionar una descripción de 500 caracteres como máximo. Además, cuanto más específica sea la descripción del atributo, más ayudará a los clientes a encontrar tus atributos en los resultados de búsqueda.
Ejemplo:
Tiene la potencia de un toro, pero sobre todo corta césped. Toro Company es un fabricante estadounidense de equipos de jardinería, como cortacéspedes, quitanieves y sistemas de riego.
Declarar atributos
Los atributos deben declararse a la Magenta Advertising Platform mediante las API que se indican a continuación antes de que aparezcan en los archivos enviados a la Magenta Advertising Platform para su inclusión.
Al crear un atributo a través de las siguientes API, recibirás un identificador de Atributo. Este es el identificador que utilizarás en los archivos que nos envíes posteriormente para su incorporación.
Si prefieres usar tu propio identificador interno para cada Atributo, nuestra plataforma lo admite. Al declarar el Atributo a Magenta Advertising Platform, puedes proporcionar opcionalmente una "Clave externa de socio". Una vez que la hayas declarado, podrás utilizarla en los archivos de datos.
Atributo Cantidad de dispositivos
Un problema común a la hora de entregar tus datos a otras plataformas es saber si están incorporando los datos correctamente o no. La siguiente API te permite hacer consultas a la Magenta Advertising Platform por Atributo para ver la cantidad actual de dispositivos asociados a cada Atributo. Esto te permite validar que la incorporación se está realizando correctamente.
Endpoint de API
Todas las operaciones descritas a continuación están asociadas a
https://api.magentamarketing.com/v1/marketplace/attribute .
Listar atributos
Recoge una lista de todos los atributos que se han definido.
cURL
curl --header "Authorization: Bearer <APIKEY>" https://api.magentamarketing.com/v1/marketplace/attribute"
Response
JSON
[
{
"attribute_id":3,
"name":"Auto Shoppers",
"description":"People who have shopped for car in last 30 days",
"visible":true,
"device_count":"23456"
},
{
"attribute_id":4,
"name":"Job Hunter",
"description":"People who are hunting for a job",
"visible":false,
"device_count":"0"
}
]
Obtener atributo
Obtén un solo atributo.
cURL
curl --header "Authorization: Bearer <APIKEY>" https://api.magentamarketing.com/v1/marketplace/attribute/3"
Response
JSON
{
"attribute_id":3,
"name":"Auto Shoppers",
"description":"People who have shopped for car in last 30 days",
"visible":true,
"device_count":"23456"
}
Buscar atributo por nombre
Otra forma de obtener un solo atributo. Se introduce en name.
cURL
curl -X GET -H "Authorization: Bearer <APIKEY>" "https://api.magentamarketing.com/v1/marketplace/attribute?name=test3"
Response
JSON
{
"attribute_id": 4,
"name": "test3",
"description": "Another test",
"visible": false,
"device_count": "0",
"partner_foreign_key": null
}
Obtener atributo por clave externa de socio
Otra forma de obtener un solo atributo. Se introduce en partner_foreign_key.
cURL
curl -X GET -H "Authorization: Bearer <APIKEY>" "https://api.magentamarketing.com/v1/marketplace/attribute?partner_foreign_key=124"
Response
JSON
{
"attribute_id": 1,
"name": "Updated Test",
"description": "Updated Test",
"visible": false,
"device_count": "0",
"partner_foreign_key": "124"
}
Crear atributo
Crea un nuevo atributo
Parámetros
Field (Campo) | Obligatorio | Tipo | Descripción |
name | Y | cadena | Nombre del atributo. Descriptivo para el usuario final. Se muestra en la consola PushSpring. Debe ser único. |
description | Y | cadena | Descripción de lo que representa el atributo. Se muestra en la consola PushSpring. |
partner_foreign_key | N | cadena | Se introduce en el sistema del socio. Al importar datos, puede utilizarse el identificador de atributo o esta clave. Debe ser única. No puede incluir una , |
visible | N | booleano | Si no se especifica, el valor predeterminado es Falso. Si el atributo aparece o no en la consola MAP Marketplace. |
Muestra
cURL
curl -X POST -H "Authorization: Bearer <APIKEY>" -H "Content-Type: application/json" -d '{
"name": "Sample",
"description":"A sample attribute",
"category": "Sample"
}' "https://api.magentamarketing.com/v1/marketplace/attribute"
Response
JSON
{
"attribute_id":8
}
curl -X PATCH -H "Authorization: Bearer <APIKEY>" -H "Content-Type: application/json" -d '{
"description": "Updated Sample",
"visible": true
}' "https://api.magentamarketing.com/v1/marketplace/attribute/1"
Atributo actualizado
Actualiza un atributo. Solo se actualizan los parámetros incluidos.
Parámetros
Igual que Crear atributo
Muestra
cURL
curl -X PATCH -H "Authorization: Bearer <APIKEY>" -H "Content-Type: application/json" -d '{
"description": "Updated Sample",
"visible": true
}' "https://api.magentamarketing.com/v1/marketplace/attribute/1"
Response
Si tiene éxito devuelve un 204 Sin contenido