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. Está diseñado para que el desarrollo de funcionalidad personalizada sea cómodo para los desarrolladores experimentados con plataformas de desarrollo orientadas a servicios, AJAX, REST y Web 2.0. Los desarrolladores deben estar familiarizados con los paradigmas de aplicación basados en web, como AJAX, XML, JSON y el protocolo HTTP(S) antes de intentar el desarrollo con la API y los servicios de Yield Analytics.
El Servicio de atributos expone actualmente interfaces relacionadas con:
- Creación de traducción de atributos
- Búsqueda de traducción de atributos
Tipos de contenido
La API REST del servicio está diseñada actualmente para admitir el siguiente tipo de contenido:
- JSON: mediante
Content-type: application/json
Seleccionar el tipo de contenido deseado es una opción que el desarrollador de la API debe tomar caso por caso. La funcionalidad de 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 cliente AJAX o HTTP.
Códigos de estado y comprobación de errores
Los desarrolladores de API deben comprobar los códigos de respuesta HTTP devueltos desde la API REST del servicio para detectar los errores propagados por las llamadas API. Las llamadas correctas al servicio generarán 200 códigos de respuesta de intervalo. Las respuestas HTTP de intervalo 400 y 500 denotan errores. Es probable que los códigos de respuesta y el texto específicos cambien durante el desarrollo beta de la API; sin embargo, los intervalos no.
Seguridad
La API de servicio expone los datos de la aplicación de forma segura. El uso de la funcionalidad de API está restringido a los usuarios autenticados y se expone a través de protocolos de transporte seguros. El acceso a la API debe tener lugar en el contexto siguiente:
Ejemplo de autenticación cURL
La autenticación se produce pasando credenciales a través de encabezados HTTP en cada solicitud.
- username: curl -H "username:username" - password: curl -H "password:password" - source: curl -H "source:client_id"Autenticación HTTPS de ejemplo
GET /api/v1/rest/ HTTPS/1.1 Host: yieldanalytics.xandr.com Accept: application/xml, application/json Content-Type: application/json username: {{username}} password: {{password}} source: {{client_id}}Ejemplo de autenticación POSTMAN
Busque un ejemplo de configuración de encabezado en Postman a continuación:
Nota:
- "Autorización" se establece en "Sin autenticación"; la configuración siguiente se colocará en la pestaña "Encabezados".
- Para obtener un tutorial más detallado sobre el uso de Postman, consulte Uso de Postman con yield analytics API.
Confidencialidad
La confidencialidad se mantiene mediante la comunicación basada en capa de socket seguro para interactuar con yield analytics API. Los desarrolladores de API deben preferir el uso de HTTPS en lugar de una comunicación HTTP insegura siempre que sea posible. Consulte la biblioteca cliente HTTP sobre cómo habilitar HTTP a través de SSL al desarrollar fuera de un contexto de explorador web.
Paths
Conversión de identificadores externos al léxico de expresión de Yield Analytics
POST /api/v1/rest/attributes/convert
Descripción
Pase los identificadores externos de los valores de atributo y atributo para convertirlos al léxico de destino de Yield Analytics.
Parámetros
Tipo Nombre Descripción Obligatorio Esquema Predeterminada BodyParameter attributeConverter attributeConverter true AttributeConverter ND HeaderParameter usuario Nombre de usuario para acceder a Yield Analytics API true string ND HeaderParameter contraseña La contraseña para acceder a yield analytics API true string ND HeaderParameter source El origen de cliente para acceder a yield analytics API true string ND Respuestas
Código HTTP Description Esquema 200 Aceptar StringResponse Consume
application/json
Produce
application/json
Tags
Recurso de atributo
Solicitud cURL de ejemplo
$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/attributes/create' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}' -d '{ "attributeTranslation" : { "inputAttribute" : "attribute1", "inputValue" : "value1", "targetAttribute" : "targetattribute1", "targetValue" : "targetValue1", "adServerType" : "XFP", "invincible" : false } }'Solicitud HTTP de ejemplo
POST /api/v1/rest/attributes/create HTTP/1.1 Content-Type: application/json Accept: application/json username: {{username}} password: {{password}} source: {{source}} Host: https://{{client_url}}/api/v1/rest Content-Length: 235 { "attributeTranslation" : { "inputAttribute" : "attribute1", "inputValue" : "value1", "targetAttribute" : "targetattribute1", "targetValue" : "targetValue1", "adServerType" : "XFP", "invincible" : false } }Respuesta HTTP de ejemplo
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: 26 { "result" : "Created" }
Create nueva traducción de atributos
POST /api/v1/rest/attributes/create
Descripción
Esto solo acepta un archivo con formato JSON, lo analiza y crea un nuevo atributo en la base de datos de Yield Analytics.
Parámetros
Tipo Nombre Descripción Obligatorio Esquema Predeterminada BodyParameter attributeTranslation attributeTranslation true AttributeTranslation ND HeaderParameter usuario Nombre de usuario para acceder a Yield Analytics API true string ND HeaderParameter contraseña La contraseña para acceder a yield analytics API true string ND HeaderParameter source El origen de cliente para acceder a yield analytics API true string ND Respuestas
Código HTTP Description Esquema 200 Aceptar StringResponse Consume
application/json
Produce
application/json
Tags
Recurso de atributo
Solicitud cURL de ejemplo
$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/attributes/create' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}' -d '{ "attributeTranslation" : { "inputAttribute" : "attribute1", "inputValue" : "value1", "targetAttribute" : "targetattribute1", "targetValue" : "targetValue1", "adServerType" : "XFP", "invincible" : false } }'Solicitud HTTP de ejemplo
POST /api/v1/rest/attributes/create HTTP/1.1 Content-Type: application/json Accept: application/json username: {{username}} password: {{password}} source: {{source}} Host: https://{{client_url}}/api/v1/rest Content-Length: 235 { "attributeTranslation" : { "inputAttribute" : "attribute1", "inputValue" : "value1", "targetAttribute" : "targetattribute1", "targetValue" : "targetValue1", "adServerType" : "XFP", "invincible" : false } }Respuesta HTTP de ejemplo
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: 26 { "result" : "Created" }
Definiciones
AttributeConverter
| Nombre | Descripción | Obligatorio | Esquema |
|---|---|---|---|
| attributeConverter | false | AttributeConverter | |
| attributeName | Nombre del atributo | true | string |
| dfpTargetingIds | Identificadores DFP separados por comas que se van a traducir. | true | string |
| operator | El operador Inclusión o Exclusión. | true | string |
AttributeTranslation
| Nombre | Descripción | Obligatorio | Esquema |
|---|---|---|---|
| adServerType | Tipo adServer de la traducción de atributos | true | string |
| attributeTranslation | AttributeTranslation | ||
| inputAttribute | Atributo de entrada de la traducción de atributos | true | string |
| inputValue | Valor de entrada de la traducción de atributos | true | string |
| Invencible | Campo invencible de la traducción de atributos | true | booleano |
| targetAttribute | Atributo de destino de la traducción de atributos | true | string |
| targetValue | Valor de destino de la traducción de atributos | true | string |
StringResponse
Objeto JSON que contiene los resultados de cadena de las consultas de API.
| Nombre | Descripción | Obligatorio | Esquema |
|---|---|---|---|
| result | Resultado de la operación. | true | string |