Service de configuration

Le service de configuration permet la récupération, la création et la modification des configurations Prebid Server Premium (PSP). Les configurations PSP sont des objets utilisés pour faciliter les dépenses PSP sur un objet de ciblage Xandr particulier (placement, groupe de placement, éditeur). Chaque configuration est associée à un tableau de paramètres de partenaire de demande, afin d’indiquer lequel des partenaires de demande PSP externes doit faciliter les dépenses pour cette configuration.

API REST

HTTP, méthode Endpoint Description
GET https://api.appnexus.com/prebid/config Retourne toutes les configurations Prebid.
GET https://api.appnexus.com/prebid/config/{prebidSettingsId} Retourne une configuration Prebid spécifique.
POST https://api.appnexus.com/prebid/config Ajoutez une nouvelle configuration Prebid.
PUT https://api.appnexus.com/prebid/config/{prebidSettingsId} Mettre à jour une configuration Prebid existante.
PATCH https://api.appnexus.com/prebid/config/{prebidSettingsId} Mettez à jour une partie d’une configuration Prebid existante.
DELETE https://api.appnexus.com/prebid/config/{prebidSettingsId} Supprimer une configuration Prebid existante.

GET

Retourne toutes les configurations prebid pour le membre de l’appelant. Les résultats sont retournés au format JSON.

Paramètres

Paramètre Portée Type Description
status_filter string Facultatif Filtrez les résultats selon qu’une configuration est activée ou désactivée. Passez l’argument status_filter dans la requête et définissez la valeur sur activé ou désactivé.

Exemple d’appel utilisant curl avec des arguments de filtre status

curl --header "Content-Type: application/json" https://api.appnexus.com/prebid/config?status_filter=enabled

Exemple d’appel utilisant curl pour retourner une configuration spécifique

Ajoutez l’ID de configuration comme dernier composant de l’URL.

curl --header "Content-Type: application/json"https://api.appnexus.com/prebid/config/{id}

Réponses

Une réponse réussie retourne un json contenant toutes les configurations Prebid pour le membre ou la configuration Prebid demandée.

Propriété Type Description
bidder_timeout_ms entier Délai d’expiration en millisecondes.
configs tableau Conteneur avec les objets configs pour le membre ou un objet config spécifique. Pour les éléments contenus dans un objet config, consultez le tableau des propriétés de configuration ci-dessous.
deleted valeur booléenne Si truela valeur est , indique que l’objet config n’est pas disponible, mais que ses données sont toujours visibles.
demand_partner_settings tableau Propriétés du partenaire de demande. Pour les éléments contenus dans l’objet demand_partner_settings , consultez le tableau des paramètres du partenaire de demande ci-dessous.
id entier Identificateur unique de l’objet config retourné. Cet ID est ensuite appelé prebid_settings_id dans d’autres points de terminaison de cette API.
last_modified string Date de modification la plus récente de l’objet config.
member_id entier ID de membre de l’appelant.
price_granularity objet Paramètre de granularité du compartiment de prix qui sera utilisé pour ce membre. Pour les éléments contenus dans un objet price_granularity, consultez le tableau des propriétés de granularité des prix ci-dessous.
total_configs entier Nombre de configurations retournées.

Paramètres de partenaire de demande

Propriété Type Description
bid_cpm_adjustment float Valeur multiplicateur appliquée au prix de l’offre CPM du partenaire Demand pour ajuster la façon dont les offres sont en concurrence dans les enchères.
enabled valeur booléenne Indique si le partenaire de demande a été activé ou désactivé.
id entier ID des paramètres du partenaire de demande.
name string Nom du partenaire de demande.

Propriétés de configuration

Propriété Type Description
demand_partner_config_params tableau Conteneur avec les paramètres de configuration des partenaires de demande. Pour les éléments contenus dans un objet demand_partner_config_params, consultez le tableau des propriétés de configuration du partenaire de demande ci-dessous.
enabled valeur booléenne Indique si la configuration est activée ou désactivée.
id entier ID de la configuration.
last_modified string Date de modification la plus récente de la configuration. Mise en forme en tant que date-heure.
media_types objet Types de médias associés à la configuration. Pour les éléments contenus dans un objet media_types, consultez le tableau des propriétés des types de média ci-dessous.
member_id entier Le member_id associé à la configuration.
name chaîne Nom de la configuration.
targeting_level_code entier Rang du type d’objet dans la hiérarchie de ciblage. Le placement a targeting_level_code 0, le groupe de placement est 1, l’éditeur est 2.
targeting_id entier ID de l’objet auquel la configuration est associée. Les demandes sont envoyées aux partenaires de demande lorsque cet objet ou un objet correspondant aux critères se trouve dans la demande.
targeting_level_name string Nom du niveau (exemple : publisher)
deleted valeur booléenne Si truela valeur est , indique que l’objet config n’est pas disponible, mais que ses données sont toujours visibles.
last_modified_by string Personne qui a apporté les dernières modifications aux paramètres partenaires de demande.
targeting_metadata objet Inclut des modificateurs pour l’objet de ciblage. Pour les éléments contenus dans l’objet targeting_metadata , consultez le tableau Propriétés des métadonnées de ciblage ci-dessous.

Types de médias

L’objet de type de média détermine les formats (actuellement bannière, natif et vidéo) et les tailles d’annonces qui sont inclus dans les demandes adressées aux partenaires à la demande.

Propriété Type Description
sizes objet Les partenaires demandent uniquement les demandes pour cette configuration lorsque ces tailles d’annonces sont présentes.
sizes.width entier Largeur de l’unité. Par exemple, 300.
sizes.height entier Hauteur de l’unité. Par exemple, 250.
sizes.is_standard valeur booléenne Indique si la taille a été définie comme standard par le membre.
types tableau Inclut le ou les types de média éligibles pour la configuration. Seuls ces types sont transmis aux partenaires à la demande dans les requêtes. Les valeurs sont bannière, native, vidéo.

Ciblage des propriétés de métadonnées

Propriété Type Description
os_family_ids tableau Les partenaires demandent uniquement les demandes pour cette configuration là où ces systèmes d’exploitation sont présents. Systèmes d’exploitation représentés par des ID entiers du service d'System-Families d’exploitation.

Propriétés de configuration du partenaire de demande

Propriété Type Description
enabled valeur booléenne Indique si le partenaire De demande a été activé ou désactivé. Pour plus d’informations, consultez Le service Demand Partner.
deleted valeur booléenne Si truela valeur est , indique que l’objet config n’est pas disponible, mais que ses données sont toujours visibles.
id entier ID des mappages de paramètres pour le partenaire de demande spécifique.
last_modified chaîne Date de modification la plus récente de .demand_partner_config
last_modified_by string Personne qui a apporté les dernières modifications au demand_partner_config.
member_id entier Le member_id associé à .demand_partner_config
name string Nom du soumissionnaire Prebid pour le partenaire Demand.
params objet Paramètres spécifiques au partenaire et valeurs mappées. Pour plus d’informations, consultez Le service Demand Partner.
prebid_settings_id entier ID de la configuration qui peut contenir plusieurs mappages de paramètres de partenaire de demande.

Granularité des prix

La granularité des prix définit les compartiments de prix CPM dans lesquels les offres des partenaires de demande seront regroupées. Cela est défini dans le service Paramètres inter-partenaires.

Propriété Type Description
label string Nom du niveau de compartiment de prix prebid par défaut. Pour plus d’informations, consultez Granularité des prix.
ranges objet Objet conteneur décrivant la plage de granularité des prix.
ranges.max entier Longueur maximale de la plage.
ranges.increment float Quantité à incrémenter au sein de la plage.
precision entier Nombre de décimales dans les plages de granularité des prix.
currency_code string Devise des compartiments de prix.

Pagination

Le nombre de réponses peut être limité en transmettant l’argument num_elements . Quel élément commencer à afficher peut être défini via l’argument start_element .

Champ Type Description
start_element int Nombre auquel commencer le comptage.
num_elements int Nombre d’éléments à retourner. Par exemple, commencez à l’objet n° 4 et retournez 3 objets, ou # 4, 5, 6.

Exemple d’appel pour limiter à quinze résultats et pour démarrer les résultats au dixième élément

Les éléments retournés seront indexés du 10 au vingt-cinquième.

GET https://api.appnexus.com/prebid/config?num_element=15&start_element=10

Cliquez pour afficher un exemple de réponse JSON

{
   "bidder_timeout_ms":750,
   "configs":[
      {
         "deleted":false,
         "demand_partner_config_params":[
            {
               "deleted":false,
               "enabled":true,
               "id":24682,
               "last_modified":"2020-02-20T15:48:36Z",
               "last_modified_by":"auser@9325",
               "member_id":9325,
               "name":"appnexus",
               "params":{
                  "invCode":null,
                  "inv_code":null,
                  "keywords":null,
                  "member":null,
                  "placementId":null,
                  "placement_id":null,
                  "position":null,
                  "private_sizes":null,
                  "reserve":null,
                  "targetingId":4887810,
                  "trafficSourceCode":null,
                  "traffic_source_code":null,
                  "use_pmt_rule":null
               },
               "prebid_settings_id":5084
            },
            {
               "deleted":false,
               "enabled":true,
               "id":24681,
               "last_modified":"2020-02-20T15:48:36Z",
               "last_modified_by":"auser@9325",
               "member_id":9325,
               "name":"pubmatic",
               "params":{
                  "adSlot":null,
                  "keywords":null,
                  "publisherId":"test123",
                  "wrapper":null
               },
               "prebid_settings_id":5084
            }
         ],
         "enabled":true,
         "id":5084,
         "last_modified":"2020-02-20T15:48:36Z",
         "last_modified_by":"auser@9325",
         "media_types":{
            "sizes":[
               {
                  "height":150,
                  "is_standard":false,
                  "width":180
               },
               {
                  "height":250,
                  "is_standard":false,
                  "width":300
               }
            ],
            "type":"banner"
         },
         "member_id":9325,
         "name":"Targeting Test",
         "targeting_id":4887810,
         "targeting_level_code":1,
         "targeting_level_name":"site",
         "targeting_metadata":{
            "os_family_ids":[
               ""
            ]
         }
      },
      {
         "deleted":false,
         "demand_partner_config_params":[
            {
               "deleted":false,
               "enabled":true,
               "id":14370,
               "last_modified":"2020-02-14T15:17:53Z",
               "last_modified_by":"auser@9325",
               "member_id":9325,
               "name":"pubmatic",
               "params":{
                  "adSlot":"Test Slot",
                  "keywords":null,
                  "publisherId":"9325",
                  "wrapper":null
               },
               "prebid_settings_id":1930
            },
            {
               "deleted":false,
               "enabled":true,
               "id":14371,
               "last_modified":"2020-02-14T15:17:53Z",
               "last_modified_by":"auser@9325",
               "member_id":9325,
               "name":"appnexus",
               "params":{
                  "invCode":null,
                  "inv_code":null,
                  "keywords":null,
                  "member":null,
                  "placementId":null,
                  "placement_id":null,
                  "position":null,
                  "private_sizes":null,
                  "reserve":null,
                  "targetingId":3589320,
                  "trafficSourceCode":null,
                  "traffic_source_code":null,
                  "use_pmt_rule":null
               },
               "prebid_settings_id":1930
            }
         ],
         "enabled":true,
         "id":1930,
         "last_modified":"2020-02-14T15:17:53Z",
         "last_modified_by":"auser@9325",
         "media_types":{
            "sizes":[
               {
                  "height":600,
                  "width":160
               }
            ],
            "type":"banner"
         },
         "member_id":9325,
         "name":"Test - Harish",
         "targeting_id":3589320,
         "targeting_level_code":1,
         "targeting_level_name":"site",
         "targeting_metadata":{
            "os_family_ids":[
               4
            ]
         }
      }
   ],
   "deleted":false,
   "demand_partner_settings":{
      "adform":{
         "bid_cpm_adjustment":2,
         "enabled":true,
         "id":102
      },
      "appnexus":{
         "bid_cpm_adjustment":1,
         "enabled":true,
         "id":65
      },
      "appnexus-video":{
         "bid_cpm_adjustment":4,
         "enabled":true,
         "id":118
      },
      "triplelift_native":{
         "bid_cpm_adjustment":1,
         "enabled":true,
         "id":320
      },
      "verizonmedia":{
         "bid_cpm_adjustment":1,
         "enabled":true,
         "id":240
      }
   },
   "id":2,
   "last_modified":"2020-02-12T18:06:33Z",
   "member_id":9325,
   "price_granularity":{
      "label":"Medium",
      "precision":2,
      "ranges":[
         {
            "increment":0.1,
            "max":20
         }
      ]
   },
   "total_configs":36
}

POST

Active la création d’un nouvel objet config.

Exemple d’appel utilisant curl

curl -d @config.json -X POST --header "Content-Type: application/json" 'https://api.appnexus.com/prebid/config'

POST:Paramètres

Propriété Type Portée Description
name string Obligatoire Nom de la configuration.
enabled valeur booléenne Obligatoire Indique si la configuration est activée ou désactivée.
demand_partner_config_params tableau Obligatoire Tableau contenant des objets demand_partner_config_params. Pour les éléments contenus dans un demand_partner_config_params objet, consultez le tableau des propriétés de configuration du partenaire de demande ci-dessous.
media_types objet Obligatoire Le media_types associé à la configuration. Pour les éléments contenus dans un media_type objet, consultez le tableau des propriétés de type de média ci-dessous.
targeting_id entier Obligatoire ID de l’objet auquel la configuration est associée. Les demandes sont envoyées aux partenaires de demande lorsque cet objet ou un objet correspondant aux critères se trouve dans la demande.
targeting_level_code entier Obligatoire Rang du type d’objet dans la hiérarchie de ciblage. Le placement a targeting_level_code 0, le groupe de placement est 1, l’éditeur est 2.
targeting_metadata objet Facultatif Inclut des modificateurs pour l’objet de ciblage. Pour les éléments contenus dans l’objet targeting_metadata , consultez le tableau Propriétés des métadonnées de ciblage ci-dessous.

POST: Propriétés de configuration du partenaire de demande

Propriété Type Portée Description
deleted valeur booléenne Obligatoire Si truela valeur est , indique que l’objet config n’est pas disponible, mais que ses données sont toujours visibles.
member_id entier Obligatoire Le member_id associé à .demand_partner_config
name chaîne Obligatoire Nom du soumissionnaire Prebid pour le partenaire Demand.
params objet Obligatoire Paramètres spécifiques au partenaire et valeurs mappées. Pour plus d’informations, consultez Le service Demand Partner.
prebid_settings_id entier Obligatoire ID de la configuration qui peut contenir plusieurs mappages de paramètres de partenaire de demande.

POST: types de média

L’objet de type de média détermine les formats (actuellement bannière, natif et vidéo) et les tailles d’annonces qui sont inclus dans les demandes adressées aux partenaires à la demande.

Propriété Type Portée Description
sizes objet Facultatif Les partenaires demandent uniquement les demandes pour cette configuration lorsque ces tailles d’annonces sont présentes.
sizes.width entier Facultatif Largeur de l’unité. Par exemple, 300.
sizes.height entier Facultatif Hauteur de l’unité. Par exemple, 250.
sizes.is_standard valeur booléenne Facultatif Indique si la taille a été définie comme standard par le membre.
types tableau Obligatoire Inclut le ou les types de média éligibles pour la configuration. Seuls ces types sont transmis aux partenaires à la demande dans les requêtes. Les valeurs sont bannière, native, vidéo.

POST: Ciblage des propriétés de métadonnées

Propriété Type Portée Description
os_family_ids tableau Facultatif Les partenaires demandent uniquement les demandes pour cette configuration là où ces systèmes d’exploitation sont présents. Systèmes d’exploitation représentés par des ID entiers du service d'System-Families d’exploitation.

Cliquez pour afficher un exemple de requête JSON

{
   "name":"test_configuration",
   "enabled":false,
   "demand_partner_config_params":[
      {
         "deleted":false,
         "enabled":true,
         "id":7466,
         "member_id":9325,
         "name":"rubicon",
         "params":{
            "accountId":1001,
            "inventory":null,
            "siteId":113932,
            "video":null,
            "visitor":null,
            "zoneId":535510
         }
      }
   ],
   "media_types":{
      "sizes":[
         {
            "height":600,
            "width":160
         }
      ],
      "type":"banner"
   }
}

Réponse

Une réponse réussie retourne le nouvel objet config.

POST: cliquez pour afficher un exemple de réponse JSON

[
   {
      "deleted":false,
      "demand_partner_config_params":[
         {
            "deleted":false,
            "enabled":true,
            "id":24679,
            "last_modified":"2020-02-19T17:53:36.674Z",
            "last_modified_by":"azacarias@9325",
            "member_id":9325,
            "name":"rubicon",
            "params":{
               "accountId":1001,
               "inventory":null,
               "siteId":113932,
               "video":null,
               "visitor":null,
               "zoneId":535510
            },
            "prebid_settings_id":5083
         },
         {
            "deleted":false,
            "enabled":true,
            "id":24680,
            "last_modified":"2020-02-19T17:53:36.674Z",
            "last_modified_by":"azacarias@9325",
            "member_id":9325,
            "name":"appnexus",
            "params":{
               
            },
            "prebid_settings_id":5083
         }
      ],
      "enabled":false,
      "id":5083,
      "last_modified":"2020-02-19T17:53:36.674Z",
      "last_modified_by":"azacarias@9325",
      "media_types":{
         "sizes":[
            {
               "height":600,
               "width":160
            }
         ],
         "type":"banner"
      },
      "member_id":9325,
      "name":"test_configuration",
      "targeting_id":null,
      "targeting_level_code":null,
      "targeting_metadata":null
   }
]

PUT

Mises à jour une configuration Prebid existante. Incluez comme prebidSettingsId dernier composant du chemin d’URL. Transmettez les informations de mise à jour au format JSON dans le corps de la demande.

PUT: Exemple d’appel à l’aide de curl

curl -d @config-update.json -X PUT --header "Content-Type: application/json https://api.appnexus.com/prebid/config/{prebidSettingsId}

PUT:Réponse

Renvoie un objet de configuration Prebid.

PATCH

Mettez à jour partiellement une configuration Prebid existante. Incluez comme prebidSettingsId dernier composant du chemin d’accès. Transmettez les informations de mise à jour au format JSON dans le corps de la demande.

PATCH: Exemple d’appel à l’aide de curl

curl -d @config-update.json -X PATCH --header "Content-Type: application/json https://api.appnexus.com/prebid/config/{prebidSettingsId}

PATCH:Réponse

Renvoie un objet de configuration Prebid.

DELETE

Supprimer une configuration Prebid existante. Incluez comme prebidSettingsId dernier composant du chemin d’accès.

DELETE: Exemple d’appel à l’aide de curl

curl -X DELETE https://api.appnexus.com/prebid/config/{prebidSettingsId}

DELETE:Réponse

En cas de réussite, la configuration indiquée est retournée en tant qu’objet JSON avec la propriété supprimée définie sur true. Il ne sera plus disponible dans le système. Tous les sous-objets seront également supprimés.

  • Last updated on