Ciblage du service de clé

Le service de clé de ciblage fonctionne conjointement avec le service targeting-value pour vous permettre de définir vos propres combinaisons clé/valeur à utiliser dans le ciblage sur des éléments de ligne, des campagnes, etc. Pour plus d’informations, consultez Ciblage de valeur de clé personnalisée .

API REST

HTTP, méthode	Endpoint	Description
`POST`	`https://api.appnexus.com/targeting-key` (`create_target_key` JSON)	Ajoutez une nouvelle clé de ciblage.
`PUT`	`https://api.appnexus.com/targeting-key?id=TARGETING_KEY_ID` (`update_targeting_key` JSON)	Modifier une clé de ciblage.
`GET`	`https://api.appnexus.com/targeting-key`	Afficher toutes les clés de ciblage.
`GET`	`https://api.appnexus.com/targeting-key?id=TARGETING_KEY_ID`	Afficher une clé de ciblage spécifique.
`GET`	`https://api.appnexus.com/targeting-key?name=TARGETING_KEY_NAME1,TARGETING_KEY_NAME2,TARGETING_KEY_NAME3`	Afficher un ensemble de clés de ciblage par nom.
`DELETE`	`https://api.appnexus.com/targeting-key?id=TARGETING_KEY_ID`	Supprimer une clé de ciblage.

Champs JSON

Généralités

Champ	Type (Longueur)	Description
`id`	int	ID de la clé de ciblage. Par défaut : nombre généré automatiquement Obligatoire Sur : `PUT`/ `DELETE`, dans la chaîne de requête
`type`	enum	Type de données de la clé et ses valeurs associées. Doit être l’une des valeurs suivantes : - `string` - `numeric` Obligatoire sur : `POST`
`name`	string	Nom de la clé de ciblage. La valeur doit être un mot, sans espace. Ce nom doit être unique au sein de votre membre. Obligatoire sur : `POST`
`label`	string	Une étiquette pour la clé, à utiliser pour la création de rapports. Cette valeur n’est pas obligatoire, mais si vous incluez une valeur, elle doit être unique au sein de votre membre. L’étiquette peut comporter un maximum de 190 caractères.
`state`	enum	État de la clé de ciblage. Les valeurs possibles sont `active` et `inactive`. Par défaut : `active`
`created_on`	date	En lecture seule. Date et heure de création de la clé de ciblage.
`last_modified`	date	En lecture seule. Date et heure de la dernière modification de la clé de ciblage.

Conditions requises pour les clés

Nombre de clés

Vous pouvez avoir jusqu’à 500 clés actives à la fois.
Vous pouvez avoir jusqu’à 100 000 valeurs par clé.
Vous pouvez avoir jusqu’à 2 500 000 valeurs actives au total à la fois.

Nommage de clé

Les noms de clé ne respectent pas la casse.
La longueur maximale du nom de clé est de 50 caractères.
Les noms de clé doivent être d’un mot, sans espace blanc.
Les noms de clé ne peuvent contenir aucun des caractères spéciaux suivants :
- " (guillemets doubles)
- ' (apostrophe)
- = (signe égal)
- ! (point d’exclamation)
- + (signe plus)
- # (hashtag)
- * (astérisque)
- ~ (tilde)
- ; (point-virgule)
- ^ (caret)
- () (parenthèses)
- < > (crochets)
- [] (crochets)
- , (virgule)
- & (esperluette)
- @ (at)
- : (deux-points)
- ? (point d’interrogation)
- % (signe de pourcentage)
- / (barre oblique)

Exemples

Afficher toutes les clés de ciblage

$ curl -b cookies 'https://api.appnexus.com/targeting-key'

{
    "targeting-keys": [
        {
            "id": 7,
            "type": "string",
            "name": "key1",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:29:29",
            "last_modified": "2016-08-26 06:29:29"
        },
        {
            "id": 11,
            "type": "string",
            "name": "testkey",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:30:37",
            "last_modified": "2016-08-26 06:30:37"
        },
        {
            "id": 12,
            "type": "string",
            "name": "testkey3",
            "label": "This is a test",
            "state": "active",
            "created_on": "2016-08-26 08:04:42",
            "last_modified": "2016-08-26 08:15:02"
        }
    ]...
}

Afficher une clé de ciblage spécifique

$ curl -b cookies 'https://api.appnexus.com/targeting-key?id=12'
 
{
    "targeting-key": {
        "id": 12,
        "type": "string",
        "name": "testkey3",
        "label": "This is a test",
        "state": "active",
        "created_on": "2016-08-26 08:04:42",
        "last_modified": "2016-08-26 08:15:02"
    }...
}

Ajouter une clé de ciblage

$ cat create_targeting_key.json
{
    "targeting-key": {
        "name": "testkey4",
        "type": "string"
    } 
}
 
$ curl -b cookies -H "Content-Type:application/json" -X POST -d '@create_targeting_key.json' 'https://api.appnexus.com/targeting-key'

Modifier une clé de ciblage

$ cat update_targeting_key.json
{
    "targeting-key": {
        "name": "newtestkey3",
        "label": "This is a test"
    } 
}
 
$ curl -b cookies -H "Content-Type:application/json" -X PUT -d @update_target_key.json 'https://api.appnexus.com/targeting-key?id=12'

Filtrer les clés de ciblage par nom

$ curl -b cookies 'https://api.appnexus.com/targeting-key?name=key1,key2'

{
    "targeting-keys": [
        {
            "id": 7,
            "type": "string",
            "name": "key1",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:29:29",
            "last_modified": "2016-08-26 06:29:29"
        },
        {
            "id": 8,
            "type": "string",
            "name": "key2",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:30:37",
            "last_modified": "2016-08-26 06:30:37"
        }
    ]...
}

Rechercher dans un nom ou une étiquette

Cet exemple recherche la chaîne "car" n’importe où dans les name champs ou label .

$ curl -b cookies 'https://api.appnexus.com/targeting-key?search=car'

{
    "targeting-keys": [
        {
            "id": 1,
            "type": "string",
            "name": "bluecar",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:29:29",
            "last_modified": "2016-08-26 06:29:29"
        },
        {
            "id": 2,
            "type": "string",
            "name": "key5",
            "label": "Scary values",
            "state": "active",
            "created_on": "2016-08-26 06:29:29",
            "last_modified": "2016-08-26 06:29:29"
        },
        {
            "id": 3,
            "type": "string",
            "name": "car",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:30:37",
            "last_modified": "2016-08-26 06:30:37"
        }
    ]...
}

Trier par date de dernière modification

Vous pouvez trier vos résultats par id, name, labelcreated_on, ou last_modified. Vous pouvez trier par ordre croissant (asc) ou décroissant (desc).

$ curl -b cookies 'https://api.appnexus.com/targeting-key?sort=last_modified.asc'

{
    "targeting-keys": [
        {
            "id": 7,
            "type": "string",
            "name": "key1",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:29:29",
            "last_modified": "2016-08-26 06:29:29"
        },
        {
            "id": 10,
            "type": "string",
            "name": "akey",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 04:45:07",
            "last_modified": "2016-08-26 12:52:29"
        },
        {
            "id": 8,
            "type": "string",
            "name": "key2",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:30:37",
            "last_modified": "2016-08-30 10:34:37"
        }
    ]...
}

Supprimer une clé de ciblage

La suppression d’une clé de ciblage supprime automatiquement toutes les valeurs sous cette clé.

$ curl -b cookies -X DELETE 'https://api.appnexus.com/targeting-key?id=12'

Last updated on 2025-10-22

Partager via