Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Remarque
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.
Le service Type d’identité dans Identity Management Framework peut être utilisé pour récupérer, créer, mettre à jour et supprimer un identificateur dans la plateforme. En outre, ce service permet aux propriétaires de gérer les autorisations pour leurs solutions d’identité. À l’aide de ce service, les propriétaires d’identité peuvent :
- Déterminez le ou les éditeurs autorisés à utiliser leur identificateur dans le bidstream.
- Déterminez le ou les partenaires sur la plateforme qui peuvent incorporer des données à l’aide de leur identificateur.
- Choisissez le ou les soumissionnaires externes qui sont éligibles pour accéder à leur identificateur.
- Sélectionnez le ou les partenaires sur la plateforme qui sont éligibles pour recevoir la valeur de l’identificateur dans leurs flux de données au niveau du journal.
Importante
Pour inscrire ou créer un identificateur, contactez votre représentant de compte Microsoft, car cette fonctionnalité est limitée au rôle Microsoft Administration.
API REST
| HTTP, méthode | Endpoint | Description |
|---|---|---|
GET |
https://api.appnexus.com/identity-type?id=IDENTITY_ID1 | Afficher un identificateur spécifique par son ID. Voici un IDENTITY_ID1 exemple d’ID d’identificateur. |
GET |
https://api.appnexus.com/identity-type?id=IDENTITY_ID1,IDENTITY_ID2,IDENTITY_ID3 | Affichez plusieurs identificateurs par leurs ID à l’aide d’une liste séparée par des virgules. |
GET |
https://api.appnexus.com/identity-type?source=SOURCE1 | Afficher un identificateur spécifique par une source telle que LiveRamp, Warner Media, etc. SOURCE1 Voici un exemple de la source d’un identificateur. |
GET |
https://api.appnexus.com/identity-type?source=SOURCE1,SOURCE2 | Affichez plusieurs identificateurs par source à l’aide d’une liste séparée par des virgules. |
GET |
https://api.appnexus.com/identity-type?member_owner_id=OWNERID1 | Affichez les identificateurs par l’ID d’un propriétaire d’identité. |
GET |
https://api.appnexus.com/identity-type?member_owner_id=OWNERID1,OWNERID2 | Affichez plusieurs identificateurs par plusieurs ID de propriétaires à l’aide d’une liste séparée par des virgules. |
PUT |
https://api.appnexus.com/identity-type?id=IDENTITY_ID1 | Mettez à jour un identificateur spécifique par son ID. |
POST |
https://api.appnexus.com/identity-type | Ajoutez un identificateur à l’aide de la charge utile JSON, comme indiqué dans l’exemple. Champ Administrateur Microsoft uniquement. |
DELETE |
https://api.appnexus.com/identity-type?id=IDENTITY_ID1& member_id=MEMBER_ID1 | Supprimer un identificateur existant appartenant à un membre. Champ Administrateur Microsoft uniquement. |
Champs JSON
Champs d’inscription avec contrôle administrateur uniquement
| Champ | Type | Description |
|---|---|---|
id |
int | Microsoft a créé l’ID de l’identificateur. En lecture seule. Obligatoire sur : PUT et DELETE. |
member_owner_id |
int | ID de membre du propriétaire de l’identificateur (généralement un éditeur). Obligatoire sur : POSTChamp d’écriture uniquement de l’administrateur Microsoft. |
source |
string | Source de l’identificateur. Par exemple, LiveRamp, Warner Media, etc. La source doit être unique à l’identificateur. Obligatoire sur : POST |
requires_platform_resolution |
valeur booléenne | Résolution de plateforme requise par un identificateur pour l’encodage et le décodage. Obligatoire sur : POST |
requires_seat_resolution |
valeur booléenne | Résolution de siège requise par l’identificateur de chaque soumissionnaire (RampID). |
identity_resolver_check |
||
is_auction_usage_single_context |
valeur booléenne | Contexte d’identificateur défini pour l’utilisation pertinente de la confidentialité (CPRA). Si l’identificateur est utilisé pour identifier un utilisateur sur au moins 2 domaines/sites web, il doit être défini sur false.Obligatoire sur : POST |
is_passthrough |
valeur booléenne | Les paramètres master pour autoriser la limitation de fréquence et la segmentation de l’audience sur la plateforme. Par défaut: False |
requires_rti_partner_match |
valeur booléenne | Champ requis pour les identificateurs associés à The Trade Desk. |
rti_partner |
valeur booléenne | Champ requis pour les identificateurs associés à The Trade Desk. |
is_experimental |
valeur booléenne | Champ utilisé pour FLoC/Topics. Pour plus d’informations sur FLoC, consultez Federated Learning of Cohorts (FLoC) |
opt_out_default |
valeur booléenne | Quand truela valeur est , l’identificateur de type secteur est désactivé par défaut et vice versa.Lorsque le type d’identité est activé, il n’est pas nécessaire de consulter le programme de résolution d’identité pour vérifier s’il existe un refus. Toutefois, lorsque le type d’identité est initialement désactivé par défaut, le programme de résolution d’identité doit déterminer si l’identificateur doit être activé ou désactivé. |
enforce_adx_specification |
valeur booléenne | Le champ spécifie si la longueur de l’ID de validation du lecteur dans Impression Bus est supérieure à 32. |
Paramètres de contrôle master pour un propriétaire d’identificateur
| Champ | Type | Description |
|---|---|---|
status |
string | Le status de l’identificateur, qu’il s’agisse de ou activeinactive. |
auction_participation_control |
objet | Le paramètre master pour contrôler si d’autres éditeurs peuvent utiliser cet identificateur et spécifier ceux qui sont autorisés à le faire. Pour plus d’informations, voir Auction Participation Contols ci-dessous. |
audience_segmentation_control |
objet | Le paramètre master pour contrôler les autorisations accordées à d’autres membres pour la segmentation de l’audience à l’aide de l’identificateur. Ce champ de la demande définit la liste des membres pour lesquels l’intégration de segments est autorisée pour l’identificateur inscrit. |
external_bidder_control |
objet | Le paramètre master pour contrôler si l’identificateur peut être envoyé aux soumissionnaires externes et spécifier les soumissionnaires externes éligibles. Ce champ définit la liste par défaut des soumissionnaires qui recevront la source et l’identificateur nouvellement enregistrés. Par défaut, les participants membres peuvent utiliser les soumissionnaires définis au niveau de l’identificateur ou ils peuvent remplacer à l’aide de l’API de participant de type d’identité. |
lld_exposure_control |
objet | Le paramètre master pour déterminer si l’identificateur peut être utilisé dans les données de niveau journal (LLD) et déterminer les destinataires autorisés. Ce champ définit la liste des membres qui pourront voir les valeurs d’ID réelles dans le flux LLD pour la source et l’identificateur nouvellement inscrits. Par défaut, les participants membres peuvent utiliser les membres définis au niveau de l’identificateur ou ils peuvent remplacer l’API de participant de type d’identité. |
Contrôle de la participation aux enchères
Le paramètre master pour contrôler si d’autres éditeurs peuvent utiliser cet identificateur et spécifier ceux qui sont autorisés à le faire. Ce champ de la demande définit la liste des membres pour lesquels la vente aux enchères est activée. Les membres activés pour les enchères deviennent les participants d’un identificateur dans l’infrastructure.
| Champ | Type | Description |
|---|---|---|
allow_participation |
string | Vendeurs activés pour la participation aux enchères : Options : - "all"- "none"- “include_subset” |
participant_member_list |
tableau d’entiers | Liste des member_id activés pour : “include_subset” |
Contrôle de segmentation d’audience
Le paramètre master pour contrôler les autorisations accordées à d’autres membres pour la segmentation de l’audience à l’aide de l’identificateur. Ce champ de la demande définit la liste des membres pour lesquels l’intégration de segments est autorisée pour l’identificateur inscrit.
| Champ | Type | Description |
|---|---|---|
allow_segmentation |
string | Membres activés pour la segmentation d’audience : Options : - "all"- "none"- “include_subset” |
segmentation_member_list |
tableau d’entiers | Liste des member_id activés pour : “include_subset” |
Contrôle des soumissionnaires externes
Le paramètre master pour contrôler si l’identificateur peut être envoyé aux soumissionnaires externes et spécifier les soumissionnaires externes éligibles. Ce champ définit la liste par défaut des soumissionnaires qui recevront la source et l’identificateur nouvellement enregistrés. Par défaut, les participants membres peuvent utiliser les soumissionnaires définis au niveau de l’identificateur ou ils peuvent remplacer à l’aide de l’API de participant de type d’identité.
| Champ | Type | Description |
|---|---|---|
allow_bidders |
tableau | Soumissionnaires externes Membres autorisés à recevoir l’identificateur : Options : - "all"- "none"- “include_subset” |
external_bidder_list |
tableau d’entiers | Liste des member_id activés pour : “include_subset” |
Contrôle d’exposition des données au niveau du journal
Le paramètre master pour déterminer si l’identificateur peut être utilisé dans les données de niveau journal (LLD) et déterminer les destinataires autorisés. Ce champ définit la liste des membres qui pourront voir les valeurs d’ID réelles dans le flux LLD pour la source et l’identificateur nouvellement inscrits. Par défaut, les participants membres peuvent utiliser les membres définis au niveau de l’identificateur ou ils peuvent remplacer l’API de participant de type d’identité où les éditeurs ont la possibilité d’utiliser le service participant pour exercer un contrôle supplémentaire sur la façon dont l’identificateur qu’ils fournissent est utilisé et exposé par la plateforme.
| Champ | Type | Description |
|---|---|---|
lld_exposure_allowed |
tableau | Membres autorisés à recevoir des valeurs d’identificateur dans LLD. Options : - "all"- "none"- “include_subset”- "participant_only" |
exposure_member_list |
tableau d’entiers | Liste des member_id activés pour : “include_subset” |
Exemples
Create un identificateur
$ cat new_identifier.json
{
"identity_type": {
"source": "test.com",
"member_owner_id": 958,
"requires_platform_resolution": true,
"identity_resolver_check": true,
"is_auction_usage_single_context": true,
"is_passthrough": true,
"requires_seat_resolution": false,
"requires_rti_partner_match": false,
"rti_partner": "",
"is_experimental": false,
"opt_out_default": false,
"status": "active",
"enforce_adx_specification": false,
"auction_participation_control": {
"allow_participation": "include_subset",
"participant_member_list": [
123,
456
]
},
"audience_segmentation_control": {
"allow_segmentation": "include_subset",
"segmentation_member_list": [
456
]
},
"external_bidder_control": {
"allow_bidders": "all",
"external_bidder_list": [
111,
112
]
},
"lld_exposure_control": {
"lld_exposure_allowed": "include_subset",
"exposure_member_list": [
311,
312
]
}
}
}
$ curl -b cookie -c cookie -X POST 'https://api.appnexus.com/identity-type'
{
"response": {
"status":"OK",
"id":IDENTITY_ID_001
}
}
Remarque
Pour les sources nouvellement inscrites, les ID sont générés dans l’ordre incrémentiel, tandis que les autres valeurs de champ sont stockées dans la base de données en fonction de la requête envoyée via l’API.
Afficher les détails d’un identificateur spécifique
$ curl -b cookies -c cookies 'https://api.appnexus.com/identity-type?id=IDENTITY_ID_001'
{
"response": {
"status": "OK",
"identity_type": {
"id": IDENTITY_ID_001,
"source": "test.com",
"member_owner_id": 958,
"requires_platform_resolution": true,
"identity_resolver_check": true,
"is_auction_usage_single_context": true,
"is_passthrough": true,
"requires_seat_resolution": false,
"requires_rti_partner_match": false,
"rti_partner": "",
"is_experimental": false,
"opt_out_default": false,
"status": "active",
"enforce_adx_specification": false,
"auction_participation_control": {
"allow_participation": "include_subset",
"participant_member_list": [
123,
456
]
},
"audience_segmentation_control": {
"allow_segmentation": "include_subset",
"segmentation_member_list": [
456
]
},
"external_bidder_control": {
"allow_bidders": "all",
"external_bidder_list": [
111,
112
]
},
"lld_exposure_control": {
"lld_exposure_allowed": "include_subset",
"exposure_member_list": [
311,
312
]
}
}
}
}