Segmenter le service

Le service segment vous permet de créer des ID de segment, qui sont ensuite utilisés pour créer des pixels de segment pour le placement sur les pages d’inventaire. Si vous travaillez avec des fournisseurs de données tiers via la plateforme Xandr, la liste des segments de ces fournisseurs s’affiche.

• Les segments sont associés à des membres et peuvent éventuellement être associés à un annonceur particulier.
• Toutes les données de segment sont stockées dans le magasin de cookies côté serveur et transmises au soumissionnaire associé au membre propriétaire à chaque demande d’offre.
• Une association d’annonceurs est à des fins de référence et d’utilisation dans notre interface utilisateur console.

API REST

Champs JSON

Pixels piggyback

Lorsque vous ajoutez des pixels piggyback, gardez les éléments suivants à l’esprit :

• Les pixels d’image peuvent uniquement se détacher d’autres pixels d’image, et les pixels JavaScript peuvent uniquement piggyback d’autres pixels JavaScript.
• Les pixels d’image ne peuvent avoir qu’un pixel piggyback. Si vous devez utiliser plusieurs pixels, veillez à utiliser un pixel JavaScript.
• Il n’existe aucune limite de caractères pour les pixels piggybackés dans Xandr, mais des limites d’URL de navigateur/serveur peuvent s’appliquer.

Chaque objet du piggyback_pixels tableau contient les champs suivants.

À propos des chaînes de requête

Xandr fournit deux méthodes de mappage de chaînes de requête pour permettre aux éditeurs de transmettre des informations spécifiques à l’inventaire ou à l’utilisateur dans les chaînes de requête de leurs balises de placement :

• mappage de chaîne de requête : dans lequel un ensemble de valeurs de paramètres est affecté au segment.
• valeur de clé de mappage de chaîne de requête : ce qui vous permet d’affecter une paire clé/valeur à un segment, puis de réutiliser la même clé avec une valeur différente dans un autre segment.

Pour les deux types de chaînes de requête mappées :

• Chaque fois qu’un appel publicitaire est effectué avec une chaîne de requête mappée, l’utilisateur associé est automatiquement ajouté au segment.
• Vous pouvez cibler la chaîne de requête dans une campagne (via les segment_targets champs ou segment_group_targets du service de profil).

Notez que vous pouvez choisir la durée pendant laquelle l’utilisateur sera conservé dans le segment. Si vous souhaitez conserver l’utilisateur dans le segment à des fins de reciblage, définissez expire_minutes sur le nombre correct de minutes (null définira sur la valeur maximale système 180 jours). Si vous souhaitez ajouter l’utilisateur au segment uniquement pendant la durée de l’appel publicitaire, définissez expire_minutes0sur .

Consultez les exemples ci-dessous pour différents scénarios et mise en forme.

Mappage de chaînes de requête

Le mappage de chaîne de requête vous permet d’affecter un paramètre à un segment à l’aide du querystring_mapping champ . Plusieurs valeurs peuvent être ajoutées à un paramètre. Cette méthode est utile dans les cas où une seule valeur est logique pour un utilisateur. Par exemple, l’âge, l’échelle de salaire ou l’expérience d’un utilisateur. Si un utilisateur est dans beginner le segment mais gagne plus d’expérience par la suite, l’utilisateur peut être déplacé vers le advanced segment et est automatiquement supprimé du beginner segment. Pour plus d’informations , consultez Exemples.

Dans ce type de chaîne de requête, le paramètre peut être fourni sans valeur. Par exemple : {"param": "car_model", "value_type": "none"}. Cela permet de fournir n’importe quelle valeur pour ce paramètre.

Valeur de clé de mappage de chaîne de requête

Le mappage clé/valeur de chaîne de requête vous permet d’affecter une seule paire clé-valeur à un segment à l’aide de l’objet querystring_mapping_key_value . Ce type de chaîne de requête permet à un utilisateur d’exister dans plusieurs segments et est utile dans les cas où plusieurs valeurs pour un paramètre ont un sens. Par exemple, les préférences musicales d’un utilisateur. Si un utilisateur est en rock segment mais qu’il aime funkégalement , il peut exister simultanément dans les deux segments. Pour plus d’informations , consultez Exemples.

Dans ce type de chaîne de requête, chaque qs_key doit avoir au moins un correspondant qs_value.

Exemples

Create un segment

$ cat segment

{
    "segment":{
        "member_id":25,
        "short_name":"remarketing - Warner Media user",
        "code":"WM08"
    }
}

$ curl -b cookies -c cookies -X POST -d @segment 'https://api.appnexus.com/segment?member_id=25'
                                            Or
$ curl -b cookies -c cookies -X POST -d @segment 'https://api.appnexus.com/segment'

{
   "response" : {
      "id" : 102,
      "count" : 1,
      "dbg_info" : {
         ...
      },
      "start_element" : 0,
      "num_elements" : 100,
      "segment" : {
         "object_type" : "default",
         "advertiser_id" : null,
         "enable_rm_piggyback" : true,
         "querystring_mapping_key_value" : null,
         "member_id" : 25,
         "expire_minutes" : null,
         "category" : null,
         "provider" : null,
         "parent_segment_id" : null,
         "querystring_mapping" : null,
         "short_name" : "yuichi-test",
         "max_usersync_pixels" : null,
         "code" : "yuichi-test-seg-02",
         "state" : "active",
         "description" : null,
         "id" : 102,
         "piggyback_pixels" : null,
         "last_modified" : "2019-08-14 17:26:29"
      },
      "status" : "OK"
   }
}

Afficher un segment

$ curl -b cookies -c cookies 'https://api.appnexus.com/segment?id=11836'

{
    "response": {
        "status": "OK",
        "segments": [
            {
                "id": 11836,
                "code": null,
                "state": "active",
                "short_name": "March 10",
                "description": null,
                "member_id": 185,
                "category": null,
                "price": "0",
                "expire_minutes": null,
                "enable_rm_piggyback": true,
                "max_usersync_pixels": 0,
                "last_modified": "2010-03-10 23:23:48",
                "provider": null,
                "parent_segment_id": null,
                "advertiser_id": 51,
                "piggyback_pixels": null
            }
        ]
    }
}

Afficher les segments internes non partagés

$ curl -b cookies -c cookies -X GET 'https://api.appnexus.com/segment?include_shared=0'

{
    "response": {
        "status": "OK",
        "segments": [
            {
                "id": 11836,
                "code": null,
                "state": "active",
                "short_name": "March 10",
                "description": null,
                "member_id": 185,
                "category": null,
                "price": "0",
                "expire_minutes": null,
                "enable_rm_piggyback": true,
                "max_usersync_pixels": 0,
                "last_modified": "2010-03-10 23:23:48",
                "provider": null,
                "parent_segment_id": null,
                "advertiser_id": 51,
                "piggyback_pixels": null
            }
        ]
    }
}

Passer d’un segment appartenant à l’annonceur à un segment appartenant au réseau

Pour modifier un segment au niveau de l’annonceur en segment de niveau réseau, vous effectuez un PUT appel en passant l’ID de segment et l’ID de membre dans la chaîne de requête et en définissant advertiser_id sur null dans le fichier JSON.

$ cat segment_update

{
    "segment": {
        "advertiser_id": null
    }
}

$ curl -b cookies -c cookies -X PUT -d @segment_update 'https://api.appnexus.com/segment?id=175196&member_id=1066'
 
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "175196",
        "start_element": 0,
        "num_elements": 100,
        "segment": {
            "id": 175196,
            "code": null,
            "state": "active",
            "short_name": "Users who have purchased software",
            "description": null,
            "member_id": 1066,
            "category": null,
            "price": 0,
            "expire_minutes": null,
            "enable_rm_piggyback": true,
            "max_usersync_pixels": null,
            "advertiser_id": null,
            "last_modified": "2013-10-18 20:34:27",
            "provider": null,
            "parent_segment_id": null,
            "piggyback_pixels": null,
            "querystring_mapping": null
        }
    }
}

Ajouter un mappage de chaîne de requête de texte à un segment

Scénario : Publisher 6 vous indique d’attendre l’une des valeurs suivantes dans la chaîne de requête de placement 596411 : «experience_level=beginner », «experience_level=intermediate » ou «experience_level=advanced ». Lorsque ce placement est fourni avec le paramètre «experience_level », vous souhaitez ajouter l’utilisateur associé à segmenter 25 avec la possibilité de faire la distinction entre les valeurs de débutant, intermédiaire et avancé dans le ciblage de campagne. Dans ce cas, vous devez créer le code JSON suivant et effectuer un PUT appel pour mettre à jour le segment.

$ cat segment_update

 {
    "segments": [
        {
            "id": 25,
            "member_id": 20,
            "querystring_mapping": {
                "param": "experience_level",
                "value_type": "text",
                "values": [
                    "beginner",
                    "intermediate",
                    "advanced"
                ],
                "publishers": [
                    {
                        "id": 6
                    }
                ],
                "placements": [
                    {
                        "id": 596411
                    }
                ]
            }
        }
    ]
}

 $ curl -b cookies -c cookies -X PUT -d @segment_update 'https://api.appnexus.com/segment?id=25'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "25",
        "start_element": null,
        "num_elements": null,
        "segment": {
            "id": 25,
            "code": null,
            "state": "active",
            "short_name": "test",
            "description": null,
            "member_id": 49,
            "category": null,
            "price": 23,
            "expire_minutes": 20,
            "enable_rm_piggyback": true,
            "max_usersync_pixels": null,
            "last_modified": "2012-01-24 20:15:18",
            "provider": null,
            "parent_segment_id": null,
            "advertiser_id": null,
            "piggyback_pixels": null,
            "querystring_mapping": {
                "param": "experience_level",
                "value_type": "text",
                "values": [
                    "beginner",
                    "intermediate",
                    "advanced"
                ],
                "publishers": [
                    {
                        "id": 6,
                        "name": "Publisher 6"
                    }
                ],
                "sites": null,
                "placements": [
                    {
                        "id": 596411,
                        "name": "Placement 596411"
                    }
                ]
            }
        }
    }
}

Ajouter un mappage de chaîne de requête numérique à un segment

Scénario : l’éditeur 30 automatique vous indique d’attendre le paramètre «car_year » suivi d’une année dans les chaînes de requête de ses placements. Lorsqu’un placement de ce serveur de publication est fourni avec "car_year=YYYY" dans sa chaîne de requête, vous pouvez ajouter l’utilisateur associé au segment 26. Dans ce cas, vous devez créer le code JSON suivant et effectuer un PUT appel pour mettre à jour le segment.

$ cat segment_update

{
   "segment": {
      "member_id": 20,
      "querystring_mapping": {
         "param": "car_year",
         "value_type": "numeric",
         "publishers": [
            {
               "id": 30
            }
         ]
      }
   }
}

$ curl -b cookies -c cookies -X PUT -d @segment 'https://api.appnexus.com/segment?id=26'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "26",
        "start_element": null,
        "num_elements": null,
        "segment": {
            "id": 26,
            "code": null,
            "state": "active",
            "short_name": "test",
            "description": null,
            "member_id": 20,
            "category": null,
            "price": 23,
            "expire_minutes": 20,
            "enable_rm_piggyback": true,
            "max_usersync_pixels": null,
            "last_modified": "2012-01-24 20:15:18",
            "provider": null,
            "parent_segment_id": null,
            "advertiser_id": null,
            "piggyback_pixels": null,
            "querystring_mapping": {
                "param": "car_year",
                "value_type": "numeric",
                "values": null,
                "publishers": [
                    {
                        "id": 30,
                        "name": "Publisher 30"
                    }
                ],
                "sites": null,
                "placements": null
            }
        }
    }
}

Ajouter un mappage de chaîne de requête sans valeurs à un segment

Scénario : les éditeurs 10 et 30 vous indiquent d’attendre le paramètre «car_model » (sans valeurs) dans leurs placements. Lorsqu’un placement de l’un de ces éditeurs est fourni avec «car_model » dans sa chaîne de requête, vous pouvez ajouter l’utilisateur associé au segment 2. Dans ce cas, vous devez créer le code JSON suivant et effectuer un PUT appel pour mettre à jour le segment.

$ cat segment_update

{
   "segment": {
      "member_id": 20,
      "querystring_mapping": {
         "param": "car_model",
         "value_type": "none",
         "publishers": [
            {
               "id": 10,
               "id": 30
            }
         ]
      }
   }
}

$ curl -b cookies -c cookies -X PUT -d @segment_update 'https://api.appnexus.com/segment?id=2'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "2",
        "start_element": null,
        "num_elements": null,
        "segment": {
            "id": 2,
            "code": null,
            "state": "active",
            "short_name": "test",
            "description": null,
            "member_id": 20,
            "category": null,
            "price": 23,
            "expire_minutes": 20,
            "enable_rm_piggyback": true,
            "max_usersync_pixels": null,
            "last_modified": "2012-01-24 20:15:18",
            "provider": null,
            "parent_segment_id": null,
            "advertiser_id": null,
            "piggyback_pixels": null,
            "querystring_mapping": {
                "param": "car_model",
                "value_type": "none",
                "values": null,
                "publishers": [
                    {
                        "id": 10,
                        "name": "Publisher 10"
                    },
                    {
                        "id": 30
                        "name": "Publisher 30"
                    }
                ],
                "sites": null,
                "placements": null
            }
        }
    }
}

Utiliser le mappage clé-valeur de chaîne de requête pour réutiliser une clé avec plusieurs valeurs

Scénario : les éditeurs souhaitent ajouter des utilisateurs à des segments en fonction de leurs préférences musicales. Vous souhaitez utiliser la même clé, «music_genre » et offrir plusieurs valeurs : «rock », «pop », «hard rock » et «funk », en les affectant à différents segments et en permettant aux utilisateurs d’être placés dans un ou plusieurs segments. Cela reflète le fait que les utilisateurs peuvent avoir des choix musicaux variés.

Dans ce cas, vous devez créer le code JSON suivant et effectuer un PUT appel pour mettre à jour les segments.

$ cat segment_update
{
    "segments": [
        {
            "id": 501,
            "querystring_mapping_key_value": {
                "qs_key": "music_genre",
                "qs_value": "rock"
            }
        },
        {
            "id": 502,
            "querystring_mapping_key_value": {
                "qs_key": "music_genre",
                "qs_value": "pop"
            }
        },
        {
            "id": 503,
            "querystring_mapping_key_value": {
                "qs_key": "music_genre",
                "qs_value": "hard rock"
            }
        },
        {
            "id": 504,
            "querystring_mapping_key_value": {
                "qs_key": "music_genre",
                "qs_value": "funk"
            }
        }
    ]
}

$ curl -b cookies -c cookies -X PUT -d @segment_update 'https://api.appnexus.com/segment?member_id=201'

{
    "response": {
        "status": "OK",
        "count": 2,
        "id": [
            501,
            502,
            503,
            504
        ],
        "start_element": 0,
        "num_elements": 100,
        "ids": [
            501,
            502,
            503,
            504
        ],
        "segments": {
            "501": {
                "id": 501,
                "code": null,
                "state": "active",
                "short_name": "rock",
                "description": null,
                "member_id": 201,
                "category": null,
                "price": 0,
                "expire_minutes": null,
                "enable_rm_piggyback": true,
                "max_usersync_pixels": null,
                "advertiser_id": null,
                "last_modified": "2015-06-02 16:39:40",
                "provider": null,
                "parent_segment_id": null,
                "piggyback_pixels": null,
                "querystring_mapping": null,
                "querystring_mapping_key_value": {
                    "qs_key": "music_genre",
                    "qs_value": "rock"
                }
            },
            "502": {
                "id": 502,
                "code": null,
                "state": "active",
                "short_name": "rock",
                "description": null,
                "member_id": 201,
                "category": null,
                "price": 0,
                "expire_minutes": null,
                "enable_rm_piggyback": true,
                "max_usersync_pixels": null,
                "advertiser_id": null,
                "last_modified": "2015-06-02 16:39:40",
                "provider": null,
                "parent_segment_id": null,
                "piggyback_pixels": null,
                "querystring_mapping": null,
                "querystring_mapping_key_value": {
                    "qs_key": "music_genre",
                    "qs_value": "pop"
                }
            },
            "503": {
                "id": 503,
                "code": null,
                "state": "active",
                "short_name": "rock",
                "description": null,
                "member_id": 201,
                "category": null,
                "price": 0,
                "expire_minutes": null,
                "enable_rm_piggyback": true,
                "max_usersync_pixels": null,
                "advertiser_id": null,
                "last_modified": "2015-06-02 16:39:40",
                "provider": null,
                "parent_segment_id": null,
                "piggyback_pixels": null,
                "querystring_mapping": null,
                "querystring_mapping_key_value": {
                    "qs_key": "music_genre",
                    "qs_value": "hard rock"
                }
            },
            "504": {
                "id": 504,
                "code": null,
                "state": "active",
                "short_name": null,
                "description": null,
                "member_id": 958,
                "category": null,
                "price": 0,
                "expire_minutes": null,
                "enable_rm_piggyback": true,
                "max_usersync_pixels": null,
                "advertiser_id": null,
                "last_modified": "2015-06-02 16:39:40",
                "provider": null,
                "parent_segment_id": null,
                "piggyback_pixels": null,
                "querystring_mapping": null,
                "querystring_mapping_key_value": {
                    "qs_key": "music_genre",
                    "qs_value": "funk"
                }
            }
        }
    }
}