Servicio de interfaz de usuario de campaña

Artículo
07/05/2024

Nota:

Este servicio está disponible actualmente para un conjunto limitado de clientes y empleados de Microsoft.

El servicio de interfaz de usuario de campaña incluye información meta de campaña relacionada con la configuración de aprobación del mismo nivel de campaña, incluida la información del creador y aprobador de la campaña. Puede usarlo para determinar si se requiere la aprobación del mismo nivel para las campañas creadas por un usuario específico.

Nota:

La configuración de la interfaz de usuario de campaña no se aplica en la capa de servicio para la activación de campañas. Este servicio de API no interactúa con la lógica de API. El servicio no puede cambiar realmente la configuración de la campaña y no puede impedir la creación de campañas no aprobadas por un usuario en la API. En su lugar, el propósito del servicio de interfaz de usuario de campaña es exclusivamente mantener los permisos para los casos de uso de la GUI en torno a la activación de la campaña y ayudar con la administración del flujo de trabajo en.
Este servicio solo es accesible para los siguientes tipos de usuario:
- member
- advertiser
- member_advertiser

API de REST

Http (método)	Endpoint	Description
`POST`	https://api.appnexus.com/campaign-ui (JSON de la interfaz de usuario de campaña)	Cree un nuevo objeto de interfaz de usuario de campaña.
`PUT`	https://api.appnexus.com/campaign-ui?id=ID	Modifique los datos de usuario contenidos en un objeto de interfaz de usuario de campaña.
`GET`	https://api.appnexus.com/campaign-ui	Ver toda la configuración de la interfaz de usuario de campaña.
`GET`	https://api.appnexus.com/campaign-ui?id=ID	Ver la configuración de la interfaz de usuario de la campaña para una campaña específica.

Campos JSON

Campo	Tipo	Descripción
`id`	Entero	Identificador de la campaña correspondiente. No se permiten entradas duplicadas de la misma campaña. Obligatorio On:`PUT`/`DELETE`, en la cadena de consulta.
`member_id`	Entero	Solo lectura. El identificador del miembro al que pertenece esta campaña.
`user_id_creator`	Entero	Identificador del usuario que crea la campaña.
`username_creator`	string (50)	Solo lectura. Nombre de usuario del usuario que crea la campaña.
`first_name_creator`	string (50)	Solo lectura. Nombre del usuario que crea la campaña.
`last_name_creator`	string (50)	Solo lectura. Apellido del usuario que crea la campaña.
`user_id_approver`	Entero	Identificador del usuario que aprueba la campaña. Este usuario y la campaña de destino deben pertenecer al mismo miembro.
`username_approver`	string (50)	Solo lectura. Nombre de usuario del usuario que aprueba la campaña.
`first_name_approver`	string (50)	Solo lectura. Nombre del usuario que aprueba la campaña.
`last_name_approver`	string (50)	Solo lectura. Apellido del usuario que aprueba la campaña.

Ejemplos

Creación de un objeto de interfaz de usuario de campaña asociado a una campaña y un usuario específicos

$ cat campaign-ui.json
{
"campaign-ui": {
"id": "393404",
"user_id_creator": "6698"
}
}
$ curl -b cookies -c cookies -X POST -d @campaign-ui.json 'https://api.appnexus.com/campaign-ui'
{
"response" : {
"count" : 1,
"campaign-ui" : {
"username_creator" : "lhuangTestUser2",
"user_id_approver" : null,
"first_name_approver" : null,
"first_name_creator" : "Ling",
"user_id_creator" : 6698,
"username_approver" : null,
"last_name_creator" : "Huang",
"last_name_approver" : null,
"member_id" : 3897,
"id" : 393404
},
"status" : "OK"
}
}

Modificación de la información de la interfaz de usuario de campaña

$ cat campaign-ui.json
{
"campaign-ui": {
"user_id_approver": "5771"
}
}

$ curl -b cookies -c cookies -X PUT -d @campaign-ui.json 'https://api.appnexus.com/campaign-ui?id=393404'
{
"response" : {
"count" : 1,
"campaign-ui" : {
"username_creator" : "lhuangTestUser2",
"user_id_approver" : 5771,
"first_name_approver" : "Lingshi",
"first_name_creator" : "Ling",
"user_id_creator" : 6698,
"username_approver" : "lhuang_test_member",
"last_name_creator" : "Huang",
"last_name_approver" : "Huang",
"id" : 393404
},
"status" : "OK"
}
}

Visualización de la información de la interfaz de usuario de la campaña para una campaña específica

$ curl -b cookies -c cookies -X GET 'https://api.appnexus.com/campaign-ui?id=393404'
{
"response" : {
"count" : 1,
"campaign-ui" : {
"username_creator" : "lhuangTestUser2",
"user_id_approver" : 5771,
"first_name_approver" : "Lingshi",
"first_name_creator" : "Ling",
"user_id_creator" : 6698,
"username_approver" : "lhuang_test_member",
"last_name_creator" : "Huang",
"last_name_approver" : "Huang",
"member_id" : 3897,
"id" : 393404
},
"status" : "OK"
}
}

Eliminación de un objeto de interfaz de usuario de campaña

$ curl -b cookies -c cookies -X DELETE 'https://api.appnexus.com/campaign-ui?id=393404'
{
"response" : {
"status" : "OK"
}
}

Compartir a través de