Service de transaction

Le service deal permet aux acheteurs, aux vendeurs et aux soumissionnaires externes de configurer et de gérer les transactions négociées. Les offres peuvent fournir aux acheteurs :

• Tarifs préférentiels sur les stocks
• Accès à l’inventaire exclusif
• Réduction de la concurrence sur les stocks
• Autres opportunités

Chaque transaction est valide pour un seul acheteur.

API REST

Champs JSON

Vendeur

L’objet seller contient les champs suivants :

Acheteur

L’objet acheteur peut être défini sur un POST, mais ne peut pas être mis à jour avec un PUT. Si vous souhaitez modifier l’acheteur, vous devez créer une nouvelle transaction.

L’objet buyer contient les champs suivants :

Exemple de l’objet buyer

"buyer": {
                "bidder_id": 2,
                "bidder_name": "Microsoft Invest",
                "id": 9155,
                "name": "Hearts & Science (AT&T)"
            },
"buyer_seats": null

Enchérisseurs d’acheteurs

L’objet buyer_bidders peut être défini sur un POSTet peut être mis à jour avec un PUT. Lorsqu’un vendeur est activé pour les transactions multi-acheteurs. l’objet buyer_bidders peut être défini en combinaison avec buyer_seats et buyer_members.

L’objet buyer_bidders contient les champs suivants :

Exemple de l’objet buyer_bidders

"buyer_bidders": [{
    "bidder_id": 1,
    "bidder_name": "Example Bidder"
}],

Membres acheteur

L’objet buyer_members peut être défini sur un POSTet peut être mis à jour avec un PUT. Lorsqu’un vendeur est activé pour les transactions multi-acheteurs, l’objet buyer_members peut être défini en combinaison avec buyer_seats et buyer_bidders.

L’objet buyer_members contient les champs suivants :

Exemple de l’objet buyer_members

"buyer_members": [{
    "bidder_id": 1,
    "bidder_name": "Example Bidder",
    "id": "456",
    "name": "Example Buyer Member"
}],

Sièges d’acheteur

Les transactions avec les sièges peuvent être configurées à l’aide de l’objet buyer_seats via l’API.

Lorsqu’une nouvelle transaction est configurée via avec, l’API est remplie avec l’objet buyer_seats . Vous pouvez utiliser l’ID de membre de l’acheteur Invest dans le code champ ainsi que bidder_id. De nouvelles offres avec des fournisseurs de services de sécurité externes peuvent également être configurées avec des ID de siège d’acheteur. Vous pouvez case activée les fournisseurs de services de sécurité externes qui utilisent des ID de siège d’acheteur ici.

L’objet buyer_seats contient les champs suivants :

Exemple de l’objet buyer_seats

"buyer": null,
"buyer_seats": [
                {
                    "bidder_id": 2,
                    "bidder_name": "",
                    "code": "9155",
                    "name": "Hearts & Science (AT&T)"
                }
            ],

Type

L’objet type contient les champs suivants :

Type d’enchère

L’objet auction_type contient les champs suivants :

Marques

Chaque brands objet contient les champs suivants :

Types de médias autorisés

Vous pouvez utiliser ce tableau pour limiter le type de média, le style d’affichage général des éléments créatifs, qui peuvent servir sur les placements qui font partie de cette offre.

Chaque allowed_media_types objet contient les champs suivants :

Sous-types de média autorisés

Vous pouvez utiliser ce tableau pour limiter le sous-type multimédia, le style d’affichage spécifique des créations, qui peut servir sur les placements qui font partie de cette offre.

Chaque allowed_media_subtypes objet contient les champs suivants :

Tailles autorisées

Chaque permitted_sizes objet contient les champs suivants :

Métadonnées externes

L’objet external_metadata s’applique aux transactions programmatiques garanties.

Chaque external_metadata objet contient les champs suivants :

Ressources natives

Chaque native_assets objet contient les champs suivants :

Catégories

Chaque categories objet contient les champs suivants :

Langages

Chaque languages objet contient les champs suivants :

Attributs techniques

Chaque technical_attribute objet contient les champs suivants :

Créatifs

Le creatives tableau est limité à 100 créations. Chaque creatives objet contient les champs suivants :

Listes de serveurs publicitaires

Chaque adserver_lists objet contient les champs suivants.

Ciblage restreint du vendeur

Une transaction peut spécifier les attributs qu’un acheteur Invest est autorisé à cibler tout en ciblant cette transaction. Les options disponibles sont les suivantes :

• aucune restriction - Les acheteurs d’investissement peuvent cibler tous les attributs sur leur article de ligne tout en ciblant cette transaction.
• certaines restrictions : les acheteurs d’investissement peuvent cibler certains attributs sur leur article de ligne.
• toutes les restrictions - Les acheteurs d’investissement ne peuvent cibler aucun autre attribut tout en ciblant cette transaction.

Votre membre peut être configuré pour utiliser l’un de ces paramètres par défaut lors de la création de nouvelles transactions.

Si une transaction est configurée pour certaines restrictions, le profil de visibilité associé à la transaction (voir le visibility_profile_id champ dans la section Champs JSON ) détermine la sélection des attributs qu’un acheteur peut cibler. Les champs de profil de visibilité suivants peuvent être utilisés pour restreindre le ciblage autorisé d’un acheteur :

Exemples

Ajouter une vente aux enchères privée avec un plancher de 2,50 $

$ cat new_deal
 
{
    "deal": {
        "name": "Private deal for buyer 1234 with floor of $2.50",
        "active": false,
        "start_date": "2016-12-01 00:00:00",
        "end_date": "2016-12-31 23:59:59",
        "floor_price": 2.5,
        "currency": "USD",
        "use_deal_floor": true,
        "buyer": {
                "id": 1234
        },
        "type": {
                "id": 2
        },
        "brands": [
                {
                        "id": 1
                }
            ]
    }
}
 
$ curl -b cookies -c cookies -X POST -d @new_deal.json 'https://api.appnexus.com/deal'
 
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 63,
        "start_element": 0,
        "num_elements": 100,
        "deal": {
            "id": 63,
            "code": null,
            "name": "Private deal for buyer 1234 with floor of $2.50",
            "description": null,
            "active": false,
            "seller_member_id": 2345,
            "start_date": "2013-12-01 00:00:00",
            "end_date": "2013-12-31 23:59:59",
            "profile_id": null,
            "package_id": null,
            "floor_price": 2.5,
            "currency": "USD",
            "use_deal_floor": true,
            "last_modified": "2013-12-04 20:39:57",
            "seller": {
                "id": 1066,
                "name": "Seller 123"
            },
            "buyer": {
                "id": 1234,
                "bidder_id": 6,
                "name": "Buyer 456"
            },
            "type": {
                "id": 2,
                "name": "Private Auction"
            },
            "brands": [
                {
                    "id": 1,
                                        "name": "Example Brand"
                }
            ],
            "ask_price": 0,
            "size_preference": null
        }
    }
}

Ajouter une vente aux enchères privée sans plancher

$ cat new_deal_nofloor
 
{
    "deal": {
        "name": "Private deal for buyer 1234 with no floor",
        "active": false,
        "start_date": "2016-12-01 00:00:00",
        "end_date": "2016-12-31 23:59:59",
        "floor_price": 0,
        "use_deal_floor": false,
        "buyer": {
                "id": 1234
        },
        "type": {
                "id": 2
        },
        "brands": [
                {
                        "id": 1
                }
            ]
    }
}
 
$ curl -b cookies -c cookies -X POST -d @new_deal_nofloor.json 'https://api.appnexus.com/deal'
 
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 64,
        "start_element": 0,
        "num_elements": 100,
        "deal": {
            "id": 64,
            "code": null,
            "name": "Private deal for buyer 1234 with no floor",
            "description": null,
            "active": false,
            "start_date": "2013-12-01 00:00:00",
            "end_date": "2013-12-31 23:59:59",
            "profile_id": null,
            "package_id": null,
            "floor_price": 0,
            "currency": "USD",
            "use_deal_floor": false,
            "last_modified": "2013-12-04 20:43:44",
            "seller": {
                "id": 2345,
                "name": "Seller 123"
            },
            "buyer": {
                "id": 1234,
                "bidder_id": 6,
                "name": "Buyer 456"
            },
            "type": {
                "id": 2,
                "name": "Private Auction"
            },
            "brands": [
                {
                    "id": 1,
                    "name": "Example Brand"
                }
            ],
            "ask_price": 0,
            "size_preference": null
        }
    }
}

Modifier une transaction

Dans cet exemple, nous ajoutons une autre marque éligible à la transaction et nous étendons la date de fin.

$ cat deal_update
 
{
    "deal": {
        "end_date": "2017-01-31 23:59:59",
        "brands": [
                {
                        "id": 1
                },
            {
                "id": 5
            }
            ]
    }
}
 
$ curl -b cookies -c cookies -X PUT -d @deal_update.json 'https://api.appnexus.com/deal?id=64'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "64",
        "start_element": 0,
        "num_elements": 100,
        "deal": {
            "id": 64,
            "code": null,
            "name": "Private deal for buyer 1234 with no floor",
            "description": null,
            "active": false,
            "start_date": "2016-12-01 00:00:00",
            "end_date": "2016-01-31 23:59:59",
            "profile_id": null,
            "package_id": null,
            "floor_price": 0,
            "currency": "USD",
            "use_deal_floor": false,
            "last_modified": "2016-12-04 20:51:35",
            "seller": {
                "id": 2345,
                "name": "Seller 123"
            },
            "buyer": {
                "id": 1234,
                "bidder_id": 6,
                "name": "Buyer 456"
            },
            "type": {
                "id": 2,
                "name": "Private Auction"
            },
            "brands": [
                {
                    "id": 1,
                    "name": "Example Brand"
                },
                {
                    "id": 5,
                    "name": "Another Brand"
                }
            ],
            "ask_price": 0,
            "size_preference": null
        }
    }
}

Modifier une transaction pour ajouter des remplacements et interdire certains contenus créatifs

Dans cet exemple, nous mettons à jour une offre pour permettre aux créations audio lancées automatiquement et par l’utilisateur de toujours servir, quels que soient les paramètres de qualité publicitaire. Nous interdrons également spécifiquement deux ID créatifs.

$ cat deal_override
 
{
    "deal": {
        "id": 201,
        "technical_attributes": [
            {
                "id": 7,
                "name": "Audio: user-initiated",
                "override": true
            },
            {
                "id": 8,
                "name": "Audio: auto-initiated",
                "override": true
            }
        ],
        "creatives": [
            {
                "id": 987654,
                "status": "banned"
            },
            {
                "id": 123456,
                "status": "banned"
            }
        ]
    }
}
 
$ curl -b cookies -c cookies -X PUT -d @deal_override.json 'https://api.appnexus.com/deal?id=64'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "64",
        "start_element": 0,
        "num_elements": 100,
        "deal": {
            "id": 201,
            "code": null,
            "name": "Private deal for buyer 1085 with no floor",
            "description": null,
            "active": false,
            "start_date": "2016-12-01 00:00:00",
            "end_date": "2017-01-31 23:59:59",
            "profile_id": null,
            "package_id": null,
            "floor_price": 0,
            "currency": "USD",
            "use_deal_floor": false,
            "last_modified": "2016-12-04 20:51:35",
            "seller": {
                "id": 2345,
                "name": "Seller 123"
            },
            "buyer": {
                "id": 1234,
                "bidder_id": 6,
                "name": "Buyer 456"
            },
            "type": {
                "id": 2,
                "name": "Private Auction"
            },
            "technical_attributes": [
                {
                    "id": 7,
                    "name": "Audio: user-initiated",
                    "override": true
                },
                {
                    "id": 8,
                    "name": "Audio: auto-initiated",
                    "override": true
                }
            ],
            "creatives": [
                {
                    "id": 987654,
                    "status": "banned"
                },
                {
                    "id": 123456,
                    "status": "banned"
                }
            ],
            "ask_price": 0,
            "size_preference": null
        }
    }
}

Afficher toutes les offres que vous avez avec les acheteurs

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal'
{
    "response": {
        "status": "OK",
        "count": 7,
        "start_element": 0,
        "num_elements": 100,
        "deals": [
            {
                "id": 63,
                "code": null,
                "name": "Private deal for buyer 1234 with floor of $2.50",
                "description": null,
                "active": false,
                "seller_member_id": 2345,
                "start_date": "2016-12-01 00:00:00",
                "end_date": "2016-12-31 23:59:59",
                "profile_id": null,
                "package_id": null,
                "floor_price": 2.5,
                "currency": "USD",
                "use_deal_floor": true,
                "last_modified": "2016-12-04 20:39:57",
                "seller": {
                    "id": 2345,
                    "name": "Seller 123"
                },
                "buyer": {
                    "id": 1234,
                    "bidder_id": 6,
                    "name": "Buyer 456"
                },
                "type": {
                    "id": 2,
                    "name": "Private Auction"
                },
                "brands": [
                    {
                        "id": 1,
                        "name": "Example Brand"
                    }
                ],
                "ask_price": 3,
                "size_preference": null
            },
            {
                "id": 64,
                "code": null,
                "name": "Private deal for buyer 1234 with no floor",
                "description": null,
                "active": false,
                "start_date": "2016-12-01 00:00:00",
                "end_date": "2016-12-31 23:59:59",
                "profile_id": null,
                "package_id": null,
                "floor_price": 1.2,
                "currency": "USD",
                "use_deal_floor": false,
                "last_modified": "2016-12-04 20:43:44",
                "seller": {
                    "id": 2345,
                    "name": "Seller 123"
                },
                "buyer": {
                    "id": 1234,
                    "bidder_id": 2,
                    "name": "Buyer ABC"
                },
                "type": {
                    "id": 2,
                    "name": "Private Auction"
                },
                "brands": [
                    {
                        "id": 1,
                        "name": "Example Brand"
                    }
                ],
                "ask_price": 0,
                "size_preference": null
            }
        ]
    }
}

Afficher une transaction spécifique

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal?id=64'
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": 0,
        "num_elements": 100,
        "deal": {
            "id": 64,
            "code": null,
            "name": "Private deal for buyer 1234 with no floor",
            "description": null,
            "active": false,
            "start_date": "2016-12-01 00:00:00",
            "end_date": "2017-01-31 23:59:59",
            "profile_id": null,
            "package_id": null,
            "floor_price": 1,
            "currency": "USD",
            "use_deal_floor": false,
            "last_modified": "2016-12-04 20:51:35",
            "seller": {
                "id": 2345,
                "name": "Seller 123"
            },
            "buyer": {
                "id": 1234,
                "bidder_id": 2,
                "name": "Buyer ABC"
            },
            "type": {
                "id": 2,
                "name": "Private Auction"
            },
            "brands": [
                {
                    "id": 1,
                    "name": "Example Brand"
                },
                {
                    "id": 5,
                    "name": "Another Brand"
                }
            ],
            "ask_price": 1.25,
            "size_preference": null
        }
    }
}

Supprimer une transaction

$ curl -b cookies -c cookies -X DELETE 'https://api.appnexus.com/deal?id=61'
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": null,
        "num_elements": null
    }
}