API de plateforme numérique - Service de profil publicitaire

Un réseau peut vouloir créer des « profils d’approbation publicitaire » pour définir les types de marques et de créations qui peuvent et ne peuvent pas s’exécuter sur les pages de leurs éditeurs. Le service de profil publicitaire vous permet de créer vos profils d’approbation publicitaire au niveau du membre ou de l’éditeur. Pour les créer au niveau de l’éditeur, incluez un ID d’éditeur. Si aucun ID d’éditeur n’est inclus, il s’agit d’un profil de niveau réseau disponible pour une utilisation avec tous les éditeurs.

Les profils publicitaires se composent de plusieurs éléments : membres, marques, créations, langage, attributs techniques, catégories et serveurs publicitaires. Lors de la création d’un profil publicitaire, vous pouvez approuver ou interdire chaque création dans le système individuellement, mais vous préférerez peut-être gagner du temps en approuvant ou en interdisant des marques ou des membres entiers.

• Un membre doit être approuvé : Si vous pensez que leurs annonces seront toujours acceptables. Par instance, vous pouvez « faire confiance » au réseau A pour diffuser des publicités de qualité, ce qui vous permet d’éviter d’avoir à auditer chacune de leurs créations.
• Une marque doit être approuvée : Si vous pensez que les publicités de cette marque seront presque toujours acceptables. Toutefois, vous aurez toujours la possibilité d’interdire un créatif spécifique même s’il fait partie d’une marque de confiance. Si la création spécifique n’est pas interdite, elle s’exécute par défaut.
• Une marque doit être interdite : Si vous pensez que les publicités de cette marque ne seront jamais acceptables. Vous aurez toujours la possibilité d’approuver un créateur spécifique affecté à une marque « interdite », sauf si le membre est interdit.
• Le profil par défaut (vide ou ID défini sur ) interdit les publicités non auditées d’autres membres (c’est-à-dire 0lorsque le member_id du créatif est différent de celui member_id du TinyTag).

API REST

Champs JSON

Members

Marques

Créatifs

Langages

Serveurs publicitaires

Catégories

Attributs techniques

Limites de fréquence

Exemples

Create un nouveau profil publicitaire

Il s’agit d’un profil assez complexe. Ci-dessous, nous avons utilisé la cat commande pour générer un exemple de fichier JSON de profil publicitaire.

$ cat ad_profile
{
    "ad-profile": {
        "description": "Network Level ad profile",
        "member_id": 326,
        "brands": [
            {
                "id": "168",
                "status": "banned"
            },
            {
                "id": "255",
                "status": "banned"
            },
            {
                "id": "1072",
                "status": "trusted"
            },
            {
                "id": "1090",
                "status": "trusted"
            }
        ],
        "creatives": [
            {
                "id": "5",
                "approved": true
            }
        ],
        "notes": "This is a great ad profile",
        "default_language_status": "banned",
        "default_ad_server_status": "trusted",
        "default_category_status": "trusted",
        "default_technical_attribute_status": "trusted",
        "excluded_landing_page_urls": ["https://www.netflix.com","https://www.blockbuster.com"],
        "languages": [
            {
                "id": 1,
                "status": "trusted"
            }
        ],
        "ad_servers": null,
        "categories": [
            {
                "id": 41,
                "status": "banned"
            },
            {
                "id": 43,
                "status": "trusted"
            }
        ]
    }
}

Mettre à jour un profil publicitaire existant

Étant donné le profil d’annonce JSON dans le premier exemple, supposons que vous souhaitez mettre à jour le categories tableau pour inclure un autre élément. Dans un cas d’usage réel, il peut y avoir 47 catégories dans le tableau. La sémantique de PUT signifie que pour ajouter une autre catégorie au tableau, vous devez passer les 47 catégories existantes plus la nouvelle.

Vous pouvez éviter ce travail supplémentaire en ajoutant les paramètres append=true de chaîne de requête à votre requête, comme illustré dans l’exemple ci-dessous. Pour des raisons de compatibilité descendante, les paramètres append_only=true fonctionnent également.

$ cat ad-profile-update.json
{
  "ad-profiles":
  [
    {
      "id": 984276,
      "categories" : [
        {
          "id" : 42,
          "status" : "banned"
        }
      ]
    }
  ]
}
$ curl -b cookies -X PUT -d '@/tmp/ad-profile-update.json' \
'https://api.appnexus.com/ad-profile?id=984276&member_id=1282&append=true'
{
   "response" : {
      "id" : 984276,
      "ad-profile" : {
         "id" : 984276,
         "description" : "Rich's Crazy Reseller - Network Ad Profile",
         "categories" : [
            {
               "id" : 41,
               "status" : "banned"
            },
            {
               "id" : 42,
               "status" : "banned"
            },
            {
               "id" : 43,
               "status" : "trusted"
            }
         ],
         // many other fields...
         "default_category_status" : "trusted"
      },
      "status" : "OK",
      "count" : 1,
      "start_element" : 0,
      "num_elements" : 100,
   }
}

Ajouter un profil publicitaire à votre membre

$ curl -b cookies -c cookies -X POST -d @ad_profile  "https://api.appnexus.com/ad-profile"
{
    "response": {
        "status": "OK",
        "id": "1317"
    }
}

Afficher un profil publicitaire

$ curl -b cookies -c cookies "https://api.appnexus.com/ad-profile?id=1317"
{
  "response": {
    "status": "OK",
    "ad-profile": {
      "id": 1317,
      "state": "active",
      "description": "Network Level ad profile",
      "member_id": 326,
      "default_brand_status": "trusted",
      "members": null,
      "brands": [
        {
          "id": "168",
          "status": "banned"
        },
        {
          "id": "255",
          "status": "banned"
        },
        {
          "id": "1072",
          "status": "trusted"
        },
        {
          "id": "1090",
          "status": "trusted"
        }
      ],
      "creatives": [
        {
          "id": "5",
          "approved": true
        }
      ],
      "total_creative_count": 8369,
      "approved_creative_count": 1,
      "banned_creative_count": 8368,
      "creatives_approved_percent": 0.011948858883977,
      "creatives_unreviewed": 8367,
      "brands_unreviewed": null,
      "exclude_unaudited": true,
      "exclude_unaudited_direct": false,
      "notes": "This is a great ad profile.",
      "publisher_id": null,
      "last_modified": "2010-07-23 16:15:49",
      "default_language_status": "banned",
      "default_ad_server_status": "trusted",
      "default_category_status": "trusted",
      "excluded_landing_page_urls": ["https://www.netflix.com","https://www.blockbuster.com"],
      "default_technical_attribute_status": "trusted",
      "languages": [
        {
          "id": 1,
          "status": "trusted"
        }
      ],
      "ad_servers": null,
      "categories": [
        {
          "id": 41,
          "status": "banned"
        },
        {
          "id": 43,
          "status": "trusted"
        }
      ],
      "technical_attributes": null
    }
  }
}

Exemples de limitation de fréquence d’attributs créatifs

Ajouter une règle de limite de fréquence à un profil publicitaire

Le {{"frequency_caps"}} champ sera d’abord {{null}} :

$ curl -b cookies -c cookies -X GET "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "ad-profile": {
      "id": 199943,
      "state": "active",
      "description": null,
      "member_id": 941,
      ...
      "frequency_caps": null
    }
}

Ajouter une règle de limite de fréquence

$ cat add_freq_cap_rule.json
{
   "ad-profile": {
      "id": 199943,
      "frequency_caps": [
        {
          "max_day_imps": 5,
          "min_minutes_per_imp": 120,
          "technical_attributes": [ {"id":4},{"id":6} ],
          "categories": [ {"id":59},{"id":37} ]
        }
      ]
   }
}
$ curl -b cookies -c cookies -X PUT --data-binary @add_freq_cap_rule.json "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "id": "199943"
  }
}

Le profil d’annonce aura désormais la règle de limite de fréquence

$ curl -b cookies -c cookies -X GET "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "ad-profile": {
      "id": 199943,
      "state": "active",
      "description": null,
      "member_id": 941,
      ...
      "frequency_caps": [
        {
          "id": 64,
          "max_session_imps": null,
          "max_day_imps": 5,
          "min_minutes_per_imp": 120,
          "member_id": 941,
          "technical_attributes": [
            {
              "id": 4,
              "name": "Video"
            },
            {
              "id": 6,
              "name": "Expandable"
            }
          ],
          "categories": [
            {
              "id": 37,
              "name": "Politics"
            },
            {
              "id": 59,
              "name": "Get Rich Quick"
            }
          ]
        }
      ]
      ...

Modifier une règle de limite de fréquence

Utilisez la {{PUT}} commande sur le {{ad-profile}} service. L’ID de la limite de fréquence doit être spécifié dans le json de mise à jour. Si l’ID de limite de fréquence n’est pas spécifié, la règle existante est supprimée et une nouvelle règle est créée.

{code}
$ cat update_freq_cap_rule.json
{
   "ad-profile": {
      "id": 199943,
      "frequency_caps": [
        {
          "id": 64,
          "technical_attributes": [ {"id":4} ],
          "categories": [ ],
          "max_day_imps": 20
        }
      ]
   }
}
$ curl -b cookies -c cookies -X PUT --data-binary @update_freq_cap_rule.json "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "id": "199943"
  }
}
{code}

Vérifiez le profil d’annonce pour voir la règle mise à jour

$ curl -b cookies -c cookies -X GET "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "ad-profile": {
      "id": 199943,
      "state": "active",
      "description": null,
      "member_id": 941,
      ...
      "frequency_caps": [
        {
          "id": 64,
          "max_session_imps": null,
          "max_day_imps": 20,
          "min_minutes_per_imp": 120,
          "member_id": 941,
          "technical_attributes": [
            {
              "id": 4,
              "name": "Video"
            }
          ],
          "categories": null
        }
      ]
      ...