Partager via

Service d’interface utilisateur de campagne

Remarque

Ce service est actuellement disponible pour un ensemble limité de clients et d’employés Microsoft uniquement.

Le service d’interface utilisateur de campagne inclut des méta-informations de campagne relatives aux paramètres d’approbation des pairs de campagne, y compris les informations sur le créateur de campagne et l’approbateur. Vous pouvez l’utiliser pour déterminer si l’approbation des pairs est requise pour les campagnes créées par un utilisateur spécifique.

Remarque

  • Les paramètres de l’interface utilisateur de campagne ne sont pas appliqués dans la couche de service pour l’activation de campagne. Ce service d’API n’interagit pas avec la logique d’API. Le service ne peut pas réellement modifier les paramètres de campagne et ne peut pas empêcher la création de campagnes non approuvées par un utilisateur dans l’API. Au lieu de cela, l’objectif du service d’interface utilisateur de campagne est exclusivement de conserver les autorisations pour les cas d’utilisation de l’interface utilisateur graphique concernant l’activation de campagne et d’aider à gérer les flux de travail dans.
  • Ce service n’est accessible qu’aux types d’utilisateurs suivants :
    • member
    • advertiser
    • member_advertiser

API REST

HTTP, méthode Endpoint Description
POST https://api.appnexus.com/campaign-ui
(JSON de l’interface utilisateur de campagne)		 Create un nouvel objet d’interface utilisateur de campagne.
PUT https://api.appnexus.com/campaign-ui?id=ID Modifier les données utilisateur contenues dans un objet d’interface utilisateur de campagne.
GET https://api.appnexus.com/campaign-ui Afficher tous les paramètres de l’interface utilisateur de campagne.
GET https://api.appnexus.com/campaign-ui?id=ID Afficher les paramètres de l’interface utilisateur d’une campagne spécifique.

Champs JSON

Champ Type Description
id int ID de la campagne correspondante. Les entrées en double de la même campagne ne sont pas autorisées.
Obligatoire On :PUT/DELETE, dans la chaîne de requête.
member_id int En lecture seule. ID du membre auquel appartient cette campagne.
user_id_creator int ID de l’utilisateur qui crée la campagne.
username_creator string (50) En lecture seule. Nom d’utilisateur de l’utilisateur qui crée la campagne.
first_name_creator string (50) En lecture seule. Prénom de l’utilisateur qui crée la campagne.
last_name_creator string (50) En lecture seule. Nom de l’utilisateur qui crée la campagne.
user_id_approver int ID de l’utilisateur qui approuve la campagne. Cet utilisateur et la campagne cible doivent appartenir au même membre.
username_approver string (50) En lecture seule. Nom d’utilisateur de l’utilisateur qui approuve la campagne.
first_name_approver string (50) En lecture seule. Prénom de l’utilisateur qui approuve la campagne.
last_name_approver string (50) En lecture seule. Nom de l’utilisateur qui approuve la campagne.

Exemples

Create un objet d’interface utilisateur de campagne associé à une campagne et à un utilisateur spécifiques

$ 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"
}
}

Modifier les informations de l’interface utilisateur de campagne

$ 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"
}
}

Afficher les informations de l’interface utilisateur d’une campagne spécifique

$ 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"
}
}

Supprimer un objet d’interface utilisateur de campagne

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