Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
« Utilisateur » fait référence aux personnes ou aux groupes capables de se connecter à l’API ou . Les utilisateurs sont classés par un user_type, qui détermine le type d’informations auxquels ils ont accès. Ce service permet aux utilisateurs de niveau membre de créer d’autres utilisateurs, ainsi que de modifier et de récupérer des informations sur les utilisateurs existants.
Types d'utilisateur
Remarque
Une fois qu’un utilisateur a été créé, le user_type ne peut pas être modifié. Pour accorder un nouveau user_type, vous devez créer un utilisateur pour cette personne. En outre, si vous créez un utilisateur via , le api_login champ est défini false sur par défaut (autrement dit, cet utilisateur n’aura pas accès à l’API). Vous pouvez uniquement modifier la valeur du api_login champ pour un utilisateur via l’API.
| Type d’utilisateur | Description |
|---|---|
member |
Utilisateur au niveau du réseau ayant accès à tous les aspects du compte du membre (annonceurs, éditeurs, applications, etc.). |
member_advertiser |
Un utilisateur de niveau réseau quelque peu limité ayant accès à un sous-ensemble d’annonceurs. Aucun accès à l’API par la stratégie Xandr. |
member_publisher |
Un utilisateur de niveau réseau limité ayant accès à un sous-ensemble d’éditeurs. Aucun accès à l’API par la stratégie Xandr. |
advertiser |
Utilisateur très limité ayant accès à un annonceur (principalement pour la création de rapports, disponible à la fois dans et l’API). Vous devez spécifier un advertiser_id lorsque vous créez cet utilisateur. |
publisher |
Utilisateur très limité ayant accès à un seul éditeur (principalement pour la création de rapports, disponible dans et l’API). Vous devez spécifier un publisher_id lorsque vous créez cet utilisateur. |
Mappage des termes de l’interface utilisateur aux termes de l’API
Pour plus d’informations sur les termes de l’interface utilisateur, consultez la documentation de votre application.
| Rôle d’utilisateur de l’interface utilisateur | API user_type |
Read_only |
|---|---|---|
| Réseau | member |
false |
| Network Observer | member |
true |
| Gestionnaire d’annonceurs réseau | member_advertiser |
false |
| Gestionnaire de serveur de publication réseau | member_publisher |
false |
| Annonceur | advertiser |
false |
| Éditeur | publisher |
false |
API REST
| HTTP, méthode | Endpoint | Description |
|---|---|---|
POST |
https://api.appnexus.com/user (json utilisateur) |
Ajoutez un nouvel utilisateur. |
PUT |
https://api.appnexus.com/user?id=user_id (json utilisateur) |
Modifier un utilisateur existant. |
GET |
https://api.appnexus.com/user | Afficher tous les utilisateurs associés à ce membre. |
GET |
https://api.appnexus.com/user?id=user_id | Afficher un utilisateur spécifique. |
GET |
https://api.appnexus.com/user?id=1,2,3 | Affichez plusieurs utilisateurs par ID à l’aide d’une liste séparée par des virgules. |
GET |
https://api.appnexus.com/user?current | Afficher l’utilisateur actuel. |
GET |
https://api.appnexus.com/user/meta | Découvrez les champs que vous pouvez filtrer et trier. |
Champs JSON
| Champ | Type | Description |
|---|---|---|
id |
int | ID interne associé à l’utilisateur. Obligatoire On : PUT, dans la chaîne de requête. |
state |
string | État de l’utilisateur. Valeurs possibles : - "active"- "inactive"Par défaut: "active" |
username |
string | Nom de connexion de l’utilisateur. Obligatoire sur : POST Note: Le nom d’utilisateur ne doit pas contenir de caractères spéciaux tels que $, #et . En outre, après la création d’un utilisateur, le nom d’utilisateur ne peut pas être modifié. |
password |
string | Mot de passe utilisé pour authentifier l’utilisateur. Non affiché sur les GET demandes.Obligatoire sur : POST |
email |
chaîne | Adresse e-mail de l’utilisateur. Obligatoire sur : POST |
first_name |
string | Prénom de l’utilisateur. Obligatoire sur : POST |
last_name |
string | Nom de famille de l’utilisateur. Obligatoire sur : POST |
custom Données |
chaîne | Toutes les informations pertinentes pour l’utilisateur peuvent être entrées ici. |
phone |
string | Numéro de téléphone du contact de l’utilisateur. |
user_type |
enum | Type d’utilisateur. Valeurs possibles : - "member"- "bidder"- "publisher"- "advertiser"- "member_advertiser"- "member_publisher"Pour plus d’informations sur chaque type d’utilisateur, consultez le tableau Types d’utilisateurs ci-dessus. Obligatoire sur : POSTNote: Ce champ ne peut pas être modifié sur PUT. Pour modifier le de user_type, vous devez ajouter un nouvel utilisateur. |
read_only |
valeur booléenne | Si truela valeur est , l’utilisateur n’est pas autorisé à apporter des modifications via l’API.Par défaut: false |
api_login |
valeur booléenne | Administration uniquement. Si la valeur est true, l’utilisateur peut accéder à l’API et l’utiliser.Par défaut: false |
entity_id |
int | ID de l’entité (membre ou soumissionnaire) à laquelle l’utilisateur appartient. Note: est entity_id le même que le member_id, qui est utilisé dans d’autres services.Obligatoire sur : POST (si user_type a la valeur "member"). |
entity_name |
string | Nom de l’entité (membre ou soumissionnaire) à laquelle l’utilisateur appartient. |
publisher_id |
int | ID du serveur de publication auquel l’utilisateur est associé, si user_type est "publisher".Obligatoire sur : POST (si user_type a la valeur "publisher"). |
advertiser_id |
int | ID de l’annonceur auquel l’utilisateur est associé, si user_type est "advertiser".Obligatoire sur : POST (si user_type a la valeur "advertiser"). |
advertiser_access |
tableau | Le ou les annonceurs auxquels l’utilisateur peut accéder, si user_type est "member_advertiser".Obligatoire sur : POST (si user_type a la valeur "member_advertiser"). |
publisher_access |
tableau | Le ou les éditeurs auxquels l’utilisateur peut accéder, si user_type est "member_publisher".Obligatoire sur : POST (si user_type a la valeur "member_advertiser"). |
reporting_decimal_type |
enum | Caractère utilisé pour les décimales dans les rapports. Valeurs possibles : - "comma"- "decimal" (point)Ce paramètre peut être remplacé au niveau du rapport (voir reporting_decimal_type dans le service de rapports).Par défaut: reporting_decimal_type à partir du membre. |
decimal_mark |
enum | Caractère séparant la partie entière de la partie fractionnaire d’un nombre. Valeurs possibles : - "period"- "comma"Ce caractère doit être différent de celui utilisé pour thousand_separator.Par défaut : "period"Note: Ce champ contrôle la façon dont l’utilisateur entre et affiche uniquement les nombres. Cela n’affecte pas les nombres dans l’API. |
thousand_separator |
enum | Caractère séparant des groupes de chiffres dans un nombre. Valeurs possibles : - "comma"- "space"- "period"Ce caractère doit être différent de celui utilisé pour decimal_mark.Par défaut: "comma" Note: Ce paramètre contrôle la façon dont l’utilisateur entre et affiche uniquement les groupes de chiffres. Elle n’affecte pas les groupes de chiffres dans l’API. |
send_safety_budget_notifications |
valeur booléenne | Si truela valeur est , l’utilisateur reçoit Notifications par e-mail lorsque le seuil du budget de sécurité quotidien est atteint. Pour plus d’informations, consultez le daily_budget champ sur le service membre.Par défaut: "false" |
is_developer |
valeur booléenne | En lecture seule. Cet indicateur donne à l’utilisateur des droits d’accès à certains services axés sur les développeurs, tels que les services de plug-in et d’instance de plug-in, qui sont utilisés par les applications. Il est défini true sur par un administrateur Xandr au cas par cas.Par défaut: "false" |
last_modified |
Timestamp | Date et heure de la dernière modification de l’utilisateur. |
timezone |
string | Fuseau horaire de l’utilisateur. |
password_expires_on |
Timestamp | Lorsque le mot de passe de l’utilisateur expire. |
entity_reporting_decimal_type |
enum | Indique si les valeurs numériques sont séparées par une virgule ou une décimale dans les rapports. Si ce champ est défini sur decimal, la valeur retournée est mise en forme comme suit : 1234.56. Alors que, si ce champ est défini sur comma, la valeur retournée est mise en forme comme suit : 1234.56.Valeurs possibles : - decimal- commaPar défaut: "decimal" |
Exemples
Ajouter un utilisateur réseau
$ 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
}
}
Ajouter un utilisateur d’observateur de réseau
$ 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
}
}
Ajouter un utilisateur d’éditeur
$ 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
}
}
Ajouter un utilisateur annonceur
$ 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
}
}
Afficher l’utilisateur actuel
$ 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
}
}
}