Servicio de atributos

Información general

La API y los servicios de Yield Analytics se exponen a través de una interfaz basada en REST. Su objetivo es hacer que el desarrollo de la funcionalidad personalizada sea cómodo para los desarrolladores experimentados con Web 2.0, AJAX, REST y plataformas de desarrollo orientadas a servicios. Los desarrolladores deben estar familiarizados con los paradigmas de aplicaciones basadas en web, incluidos AJAX, XML, JSON y el protocolo HTTP (S) antes de intentar desarrollar con la API y los servicios de Yield Analytics.

El servicio de atributos actualmente expone interfaces relacionadas con:

Creación de traducción de atributos
Búsqueda de traducción de atributos

Tipos de contenido

La API de REST de servicio está diseñada actualmente para admitir el siguiente tipo de contenido:

JSON - using Content-type: application/json

Seleccionar el tipo de contenido deseado es una elección que el desarrollador de API debe hacer caso por caso. La funcionalidad de la API es simétrica entre los tipos de contenido. Los desarrolladores de API pueden especificar el tipo de contenido deseado en los parámetros del método HTTP GET o POST o a través de su biblioteca de cliente AJAX o HTTP.

Comprobación de errores y códigos de estado

Los desarrolladores de API deben comprobar los códigos de respuesta HTTP devueltos desde la API REST de servicio para detectar errores propagados a partir de llamadas API. Las llamadas correctas al servicio darán como resultado códigos de respuesta de 200 intervalos. Las respuestas HTTP de rango 400 y 500 denotan errores. Es probable que los códigos de respuesta y el texto específicos experimenten cambios durante el desarrollo BETA de la API, sin embargo, los rangos no lo harán.

Seguridad

La API de servicio expone los datos de la aplicación de forma segura. El uso de la funcionalidad de la API está restringido a los usuarios autenticados y se expone a través de protocolos de transporte seguros. El acceso a la API debe realizarse en el siguiente contexto:

Autenticación

Para obtener más información sobre la autenticación, consulte API de Yield Analytics - Proceso de autenticación.

Confidencialidad

La confidencialidad se mantiene mediante el uso de la comunicación basada en Secure Socket Layer para interactuar con la API de Yield Analytics. Los desarrolladores de API deben preferir el uso de HTTPS sobre una comunicación insegura de HTTP siempre que sea posible. Consulte la biblioteca de clientes HTTP para saber cómo habilitar HTTP sobre SSL al desarrollar fuera del contexto de un explorador web.

Host

https://api.appnexus.com/imf

Paths

Convertir identificadores externos en léxico de expresiones de Yield Analytics

POST /api/v1/rest/attributes/convert

Descripción

Pase identificadores externos para el atributo y los valores de atributo para convertirlos al léxico de segmentación de Yield Analytics.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema	Predeterminado
BodyParameter	attributeConverter	attributeConverter	true	AttributeConverter	ND
HeaderParameter	usuario	Su nombre de usuario para acceder a la API de Yield Analytics	true	string	ND
HeaderParameter	contraseña	Su contraseña para acceder a la API de Yield Analytics	true	string	ND

Respuestas

Código HTTP Descripción Esquema

200 Aceptar Respuesta de cadena
Consume

application/json
Produce

application/json
Tags

Recurso de atributo

Código HTTP	Descripción	Esquema
200	Aceptar	Respuesta de cadena

Ejemplo de solicitud de cURL

$ curl 'https://api.appnexus.com/imf/api/v1/rest/attributes/create' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}' -d '{
"attributeTranslation" : {
"inputAttribute" : "attribute1",
"inputValue" : "value1",
"targetAttribute" : "targetattribute1",
"targetValue" : "targetValue1",
"adServerType" : "XFP",
"invincible" : false
}
}'

Ejemplo de solicitud HTTP

POST /api/v1/rest/attributes/create HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
Host: https://api.appnexus.com/imf
Content-Length: 235

{
"attributeTranslation" : {
"inputAttribute" : "attribute1",
"inputValue" : "value1",
"targetAttribute" : "targetattribute1",
"targetValue" : "targetValue1",
"adServerType" : "XFP",
"invincible" : false
}
}

Ejemplo de respuesta HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 26

{
"result" : "Created"
}

Crear nueva traducción de atributos

POST /api/v1/rest/attributes/create

Descripción

Solo acepta un archivo con formato JSON, lo analiza y crea un nuevo atributo en la base de datos de Yield Analytics.