Service Demand Partner

Le service Demand Partner retourne tous les partenaires de demande pour le membre de l’appelant. Il permet à l’utilisateur de créer un partenaire à la demande et de mettre à jour ou de supprimer un partenaire de demande existant.

Dans le contexte de PSP, les partenaires demandent, généralement des plateformes côté offre (SSP) comme, créent des adaptateurs pour Prebid Server qui reçoivent et interprètent les demandes d’en-tête d’enchères. Les partenaires de demande organisent une enchère parmi leurs sources de demande (généralement des plateformes côté demande (DSP)) pour collecter des offres sur ces demandes de publicité et renvoyer les enchères à PSP, qui organise une autre enchère.

API REST

HTTP, méthode Endpoint Description
GET https://api.appnexus.com/prebid/demand-partner Obtenez tous les partenaires à la demande.
POST https://api.appnexus.com/prebid/demand-partner Create un nouveau partenaire de demande.
PUT https://api.appnexus.com/prebid/demand-partner/{id} Mettre à jour un partenaire de demande existant.
PATCH https://api.appnexus.com/prebid/demand-partner/{id} Mettre à jour une partie d’un partenaire de demande existant.
DELETE https://api.appnexus.com/prebid/demand-partner/{id} Supprimer un partenaire à la demande.

GET

Obtenez tout ou un partenaire de demande spécifique. Pour récupérer un partenaire de demande spécifique, ajoutez l’ID de partenaire de demande comme dernier composant du chemin d’URL. Retourne un tableau JSON d’objets partenaires à la demande.

Une réponse réussie retourne un tableau JSON d’objets de partenaire de demande.

Champ Type Description
bid_cpm_adjustment entier 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. Cela ne modifie pas l’offre réelle ou le revenu payé, mais seulement le classement de l’offre dans l’enchère. La valeur par défaut est 1,00. Dans ce cas, les offres de tous les partenaires sont en concurrence égale sans ajustement. L’ajustement peut être utilisé pour prendre en compte les frais des partenaires ou pour l’optimisation. Si vous avez besoin d’ajustements CPM à un niveau plus granulaire que Demand Partner, consultez Create une règle de biais.
deleted valeur booléenne Cela indique que l’objet de partenaire de demande a été supprimé du système.
demand_partner_id entier ID du partenaire de demande sur la plateforme Xandr.
Remarque : cette propriété retourne nullà présent .
enabled valeur booléenne Indique si le partenaire de demande est activé ou désactivé.
id entier ID de partenaire de demande spécifique au membre de l’appelant.
last_modified string Date à laquelle l’objet de partenaire de demande a été modifié.
member_id entier ID de membre.
name string Nom du partenaire de demande.
pub_id_settings objet Options relatives aux ID utilisateur fournis par l’éditeur. Consultez le tableau des paramètres d’ID fournis par l’éditeur ci-dessous.

Paramètres d’ID fournis par l’éditeur

Propriété Type Description
id entier Identificateur unique représentant la source.
source string Chaîne unique représentant la source.
member_owner_id entier Identificateur unique du membre propriétaire de la source.
status string Indique si la source est active. Nécessite une entrée de chaîne de "active" ou "inactive".

Exemple de réponse

[
    {
        "bid_cpm_adjustment": 2,
        "deleted": false,
        "demand_partner_id": null,
        "enabled": true,
        "id": 102,
        "last_modified": "2019-09-13T17:39:36Z",
        "member_id": 9325,
        "name": "adform",
        "pub_id_settings": {
            "sources": [
                {
                    "id": 12345,
                    "source": "sourcename",
                    "member_owner_id": 9325,
                    "status": "active"
                }
            ]
        }
    },
    {
        "bid_cpm_adjustment": 1,
        "deleted": false,
        "demand_partner_id": 2,
        "enabled": true,
        "id": 65,
        "last_modified": "2018-11-02T15:33:54Z",
        "member_id": 9325,
        "name": "appnexus",
        "pub_id_settings": null
    },
    {
        "bid_cpm_adjustment": 1,
        "deleted": false,
        "demand_partner_id": null,
        "enabled": true,
        "id": 68,
        "last_modified": "2018-11-02T18:32:03Z",
        "member_id": 9325,
        "name": "openx",
        "pub_id_settings": null
    },
    {
        "bid_cpm_adjustment": 1,
        "deleted": false,
        "demand_partner_id": null,
        "enabled": true,
        "id": 69,
        "last_modified": "2018-11-02T18:32:31Z",
        "member_id": 9325,
        "name": "ix",
        "pub_id_settings": null
    }
]

POST

Create un nouveau partenaire de demande.

Exemple d’appel utilisant curl

curl -d @demand-partner.json -X POST 'https://api.appnexus.com/prebid/demand-partner'
Nom Type Portée Description
bid_cpm_adjustment entier Obligatoire Ajustement CPM de l’offre.
enabled valeur booléenne Obligatoire Indique si le partenaire de demande est activé ou désactivé.
name chaîne Obligatoire Nom du partenaire de demande.
pub_id_settings objet Obligatoire Options pertinentes pour les ID utilisateur fournis par l’éditeur. Consultez le tableau des paramètres d’ID fournis par l’éditeur ci-dessus.

Exemple JSON

{
    "bid_cpm_adjustment": 1,
    "enabled": true,
    "name": "test-demand-partner",
    "pub_id_settings": {
        "sources": [
            {
                "id": 12345,
                "source": "sourcename",
                "member_owner_id": 9325,
                "status": "active"
            }
        ]
    }
}

Réponse

Une réponse réussie retourne le nouveau partenaire de demande en tant qu’objet JSON.

{
    "bid_cpm_adjustment": 1,
    "deleted": false,
    "demand_partner_id": null,
    "enabled": true,
    "id": 999,
    "last_modified": "2020-02-25T18:32:31Z",
    "member_id": 9325,
    "name": "test-demand-partner",
    "pub_id_settings": {
        "sources": [
            {
                "id": 12345,
                "source": "sourcename",
                "member_owner_id": 9325,
                "status": "active"
            }
        ]
    }
}

PUT

Mises à jour un partenaire de demande Prebid existant. Incluez l’ID comme dernier composant du chemin d’accès. Transmettez les informations de mise à jour au format JSON dans le corps de la demande.

Exemple d’appel utilisant curl

curl https://api.appnexus.com/prebid/demand-partner/1234

Réponse

Retourne l’objet partenaire de demande Prebid mis à jour.

PATCH

Mettre à jour partiellement un partenaire de demande Prebid existant. Incluez l’ID comme dernier composant du chemin d’accès. Transmettez les informations de mise à jour au format JSON dans le corps de la demande.

Exemple d’appel utilisant curl

curl https://api.appnexus.com/prebid/demand-partner/1234

Réponse

Retourne l’objet partenaire de demande Prebid mis à jour.

SUPPRIMER

Supprimez un partenaire de demande Prebid existant. Incluez l’ID comme dernier composant du chemin d’accès.

Exemple d’appel utilisant curl

curl https://api.appnexus.com/prebid/demand-partner/1234

Réponse

La réponse de réussite de l’objet partenaire de demande Prebid est retournée en tant qu’objet JSON avec la propriété supprimée définie sur true. Le partenaire de demande Prebid ne sera plus disponible dans le système. Tous les sous-objets seront également supprimés.

Gestion des sources d’identité

Remarque

  • Chaque source d’identificateur doit avoir l’autorisation au niveau du membre Microsoft, du soumissionnaire (Prébid Server Premium, ID 443) et du partenaire de demande pour pouvoir transmettre correctement les demandes aux partenaires à la demande.
  • Pour plus d’informations sur le processus d’inscription des identificateurs et la gestion des identificateurs, consultez l’API Identity Service.
  • À l’avenir, l’interface utilisateur Identity Management permettra une gestion holistique des autorisations d’identificateur.
  • Ce service est actuellement en alpha. Il est encore en cours d’élaboration et peut être modifié sans préavis. Contactez votre représentant de compte Microsoft pour l’activer.