API de plataforma digital: servicio de usuario

Artículo
05/18/2024

"Usuario" hace referencia a personas o grupos que pueden iniciar sesión en o API. Los usuarios se clasifican mediante un user_typeobjeto , que determina a qué tipo de información tienen acceso. Este servicio permite a los usuarios de nivel de miembro crear otros usuarios, así como modificar y recuperar información sobre los usuarios existentes.

Tipos de usuario

Nota:

Una vez creado un usuario, user_type no se puede cambiar. Para conceder a alguien un nuevo user_type, debe crear un nuevo usuario para esa persona. Además, si crea un usuario a través de , el api_login campo se establece false en de forma predeterminada (es decir, ese usuario no tendrá acceso a la API). Solo puede cambiar el valor del api_login campo para un usuario a través de la API.

Tipo de usuario	Descripción
`member`	Usuario de nivel de red con acceso a todos los aspectos de la cuenta del miembro (anunciantes, publicadores, aplicaciones, etc.).
`member_advertiser`	Un usuario de nivel de red algo limitado con acceso a un subconjunto de anunciantes. No hay acceso a LA API por parte de la directiva Xandr.
`member_publisher`	Usuario de nivel de red algo limitado con acceso a un subconjunto de publicadores. No hay acceso a LA API por parte de la directiva Xandr.
`advertiser`	Usuario muy limitado con acceso a un anunciante (principalmente para la generación de informes, disponible tanto en la API como en la API). Debe especificar cuando `advertiser_id` cree este usuario.
`publisher`	Usuario muy limitado con acceso a un publicador (principalmente para la generación de informes, disponible tanto en la API como en la API). Debe especificar al `publisher_id` crear este usuario.

Asignación de términos de interfaz de usuario a términos de API

Para obtener más información sobre los términos de la interfaz de usuario, consulte la documentación de la aplicación.

Rol de usuario de la interfaz de usuario	API `user_type`	Read_only
Red	`member`	false
Network Observer	`member`	true
Administrador de anunciantes de red	`member_advertiser`	false
Administrador de editores de red	`member_publisher`	false
Anunciante	`advertiser`	false
Publisher	`publisher`	false

API de REST

Http (método)	Endpoint	Description
`POST`	https://api.appnexus.com/user (JSON de usuario)	Agregar un nuevo usuario.
`PUT`	https://api.appnexus.com/user?id=user_id (JSON de usuario)	Modificar un usuario existente.
`GET`	https://api.appnexus.com/user	Ver todos los usuarios asociados a este miembro.
`GET`	https://api.appnexus.com/user?id=user_id	Ver un usuario específico.
`GET`	https://api.appnexus.com/user?id=1,2,3	Vea varios usuarios por identificador mediante una lista separada por comas.
`GET`	https://api.appnexus.com/user?current	Ver el usuario actual.
`GET`	https://api.appnexus.com/user/meta	Averigüe por qué campos puede filtrar y ordenar.

Campos JSON

Campo	Tipo	Descripción
`id`	Entero	Identificador interno asociado al usuario. Obligatorio On:`PUT`, en la cadena de consulta.
`state`	string	Estado del usuario. Posibles valores: - `"active"` - `"inactive"` Predeterminado:`"active"`
`username`	string	Nombre de inicio de sesión del usuario. Obligatorio activado:`POST` Nota: El nombre de usuario no debe contener caracteres especiales como $, #y ". Además, una vez creado un usuario, no se puede cambiar el nombre de usuario.
`password`	string	Contraseña usada para autenticar al usuario. No se muestra en las `GET` solicitudes. Obligatorio activado:`POST`
`email`	string	La dirección de correo electrónico del usuario. Obligatorio activado:`POST`
`first_name`	string	Nombre del usuario. Obligatorio activado:`POST`
`last_name`	string	Apellidos del usuario. Obligatorio activado:`POST`
`custom` datos	string	Cualquier información relevante para el usuario se puede escribir aquí.
`phone`	string	Número de teléfono de contacto del usuario.
`user_type`	enumeración	Tipo de usuario. Posibles valores: - `"member"` - `"bidder"` - `"publisher"` - `"advertiser"` - `"member_advertiser"` - `"member_publisher"` Para obtener más información sobre cada tipo de usuario, consulte la tabla Tipos de usuario anterior. Obligatorio activado:`POST` Nota: Este campo no se puede modificar en `PUT`. Para cambiar el valor de `user_type`un usuario, debe agregar un nuevo usuario.
`read_only`	booleano	Si `true`es , el usuario no puede realizar cambios a través de la API. Predeterminado:`false`
`api_login`	booleano	Solo para administradores. Si `true`es , el usuario puede acceder a la API y usarla. Predeterminado:`false`
`entity_id`	Entero	Identificador de la entidad (miembro o licitador) a la que pertenece el usuario. Nota:`entity_id` es el mismo que , `member_id`que se usa en otros servicios. Obligatorio activado:`POST` (si `user_type` es `"member"`).
`entity_name`	string	Nombre de la entidad (miembro o licitador) a la que pertenece el usuario.
`publisher_id`	Entero	Identificador del publicador con el que está asociado el usuario, si `user_type` es `"publisher"`. Obligatorio activado:`POST` (si `user_type` es `"publisher"`).
`advertiser_id`	Entero	Identificador del anunciante con el que está asociado el usuario, si `user_type` es `"advertiser"`. Obligatorio activado:`POST` (si `user_type` es `"advertiser"`).
`advertiser_access`	matriz	Los anunciantes a los que el usuario puede acceder, si `user_type` es `"member_advertiser"`. Obligatorio activado:`POST` (si `user_type` es `"member_advertiser"`).
`publisher_access`	matriz	Los publicadores a los que el usuario puede acceder, si `user_type` es `"member_publisher"`. Obligatorio activado:`POST` (si `user_type` es `"member_advertiser"`).
`reporting_decimal_type`	enumeración	Carácter usado para decimales en los informes. Posibles valores: - `"comma"` - `"decimal"` (punto) Esta configuración se puede invalidar en el nivel de informe (consulte `reporting_decimal_type` en el servicio de informes). Predeterminado:`reporting_decimal_type` de miembro.
`decimal_mark`	enumeración	Carácter que separa la parte entera de la parte fraccionaria de un número. Posibles valores: - `"period"` - `"comma"` Este carácter debe ser diferente del carácter usado para `thousand_separator`. Valor predeterminado: `"period"` Nota: Este campo controla cómo el usuario escribe y ve los números solo en . No afecta a los números de la API.
`thousand_separator`	enumeración	Carácter que separa los grupos de dígitos en un número. Posibles valores: - `"comma"` - `"space"` - `"period"` Este carácter debe ser diferente del carácter usado para `decimal_mark`. Predeterminado:`"comma"` Nota: Esta configuración controla cómo el usuario entra y ve grupos de dígitos solo en . No afecta a los grupos de dígitos de la API.
`send_safety_budget_notifications`	booleano	Si `true`es , el usuario recibirá notificaciones por correo electrónico cuando se acerque el umbral diario del presupuesto de seguridad. Para obtener más información, consulte el `daily_budget` campo en el servicio para miembros. Predeterminado:`"false"`
`is_developer`	booleano	Solo lectura. Esta marca proporciona a un usuario derechos para acceder a determinados servicios centrados en desarrolladores, como los servicios de complemento e instancia de complemento, que usan las aplicaciones. Un administrador de Xandr lo establece `true` en caso por caso. Predeterminado:`"false"`
`last_modified`	Timestamp	Fecha y hora en que se modificó por última vez el usuario.
`timezone`	string	Zona horaria del usuario.
`password_expires_on`	Timestamp	Cuando expire la contraseña del usuario.
`entity_reporting_decimal_type`	enumeración	Si los valores numéricos están separados por una coma o un decimal en los informes. Si este campo se establece en `decimal`, el valor devuelto tendría el formato siguiente: `1234.56`. Mientras que, si este campo se establece en `comma`, el valor devuelto tendría el formato siguiente: `1234.56`. Posibles valores: - `decimal` - `comma` Predeterminado:`"decimal"`

Ejemplos

Agregar un usuario de red

$ cat user
{
    "user":{
        "username":"testuser",
        "password":"testpassword",
        "user_type":"member",
        "entity_id":123,
        "first_name":"Test",
        "last_name":"User",
        "email":"test@testuser.com"
    }
}
$ curl -b cookies -X POST -d @user 'https://api.appnexus.com/user'
{
    "response":{
        "status":"OK",
        "id":258
    }
}

Adición de un usuario de observador de red

$ cat user
{
    "user":{
        "username":"testuser",
        "password":"testpassword",
        "user_type":"member",
        "entity_id":123,
        "first_name":"Test",
        "last_name":"User",
        "email":"test@testuser.com",
        "read_only": true
    }
}
$ curl -b cookies -X POST -d @user 'https://api.appnexus.com/user'
{
    "response":{
        "status":"OK",
        "id":259
    }
}

Adición de un usuario del publicador

$ cat user
{
    "user":{
        "username":"testuser",
        "password":"testpassword",
        "user_type":"publisher",
        "publisher_id":1234,
        "first_name":"Test",
        "last_name":"User",
        "email":"test@testuser.com"
    }
}
$ curl -b cookies -X POST -d @user 'https://api.appnexus.com/user'
{
    "response":{
        "status":"OK",
        "id":260
    }
}

Incorporación de un usuario anunciante

$ cat user
{
    "user":{
        "username":"testuser",
        "password":"testpassword",
        "user_type":"advertiser",
        "advertiser_id":1234,
        "first_name":"Test",
        "last_name":"User",
        "email":"test@testuser.com"
    }
}
$ curl -b cookies -X POST -d @user 'https://api.appnexus.com/user'
{
    "response":{
        "status":"OK",
        "id":261
    }
}

Visualización del usuario actual

$ curl -b cookies 'https://api.appnexus.com/user?current'
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": 0,
        "num_elements": 100,
        "user": {
            "id": 2513,
            "first_name": "Ron",
            "last_name": "Jacob",
            "phone": "",
            "username": "rjacob",
            "email": "rjacob@example.com",
            "user_type": "member",
            "read_only": false,
            "api_login": true,
            "entity_id": 1446,
            "publisher_id": null,
            "advertiser_id": null,
            "custom_data": null,
            "send_safety_budget_notifications": false,
            "entity_name": "Test Member",
            "timezone": "EST5EDT",
            "entity_reporting_decimal_type": "decimal",
            "reporting_decimal_type": null,
            "decimal_mark": "period",
            "thousand_separator": "comma",
            "last_modified": "2012-06-27 21:53:38",
            "is_developer": false,
            "state": "active",
            "advertiser_access": null,
            "publisher_access": null
        }
    }
}

Compartir a través de