Utilisez les correspondances des tableaux pour mapper les méthodes et les champs de gestion des audiences de ciblage par liste de clients de l'API Display & Video 360 avec leurs équivalents dans l'API Data Manager.
Authentification
L'API Data Manager nécessite des identifiants dont le champ d'application est différent de celui de l'API Display & Video 360. Suivez la procédure décrite dans Configurer l'accès à l'API pour générer de nouveaux identifiants incluant le champ d'application de l'API Data Manager.
Mappage des méthodes
Le tableau suivant met en correspondance les méthodes de l'API Display & Video 360 avec les méthodes équivalentes de l'API Data Manager :
| Méthodes de l'API Display & Video 360 | Méthodes de l'API Data Manager | Remarques |
|---|---|---|
firstPartyAndPartnerAudiences.get |
userLists.get |
L'API Data Manager ne peut récupérer que les audiences de ciblage par liste de clients. |
firstPartyAndPartnerAudiences.list |
userLists.list |
L'API Data Manager ne renverra que les audiences de ciblage par liste de clients. |
firstPartyAndPartnerAudiences.create |
userLists.create |
Les données utilisateur doivent être importées dans une requête ultérieure dans l'API Data Manager. |
| Aucun équivalent | userLists.delete |
Non disponible dans l'API Display & Video 360. |
firstPartyAndPartnerAudiences.patch |
userLists.patch |
|
firstPartyAndPartnerAudiences.editCustomerMatchMembers |
audienceMembers.ingest |
Des méthodes distinctes de l'API Data Manager sont utilisées pour ajouter et supprimer des membres des audiences de ciblage par liste de clients. |
firstPartyAndPartnerAudiences.editCustomerMatchMembers |
audienceMembers.remove |
Des méthodes distinctes de l'API Data Manager sont utilisées pour ajouter et supprimer des membres des audiences de ciblage par liste de clients. |
| Aucun équivalent. | audienceMembers.removeAll |
L'API Data Manager permet de supprimer tous les membres d'une audience en une seule requête. |
Mappage de requêtes
Les tableaux suivants mettent en correspondance les champs de requête des méthodes de l'API Display & Video 360 avec leurs équivalents dans l'API Data Manager.
userLists.get
firstPartyAndPartnerAudiences.get (API Display & Video 360) |
userLists.get (API Data Manager) |
Remarques |
|---|---|---|
|
name |
Le nom UserList contient l'ID de l'annonceur ou du partenaire parent, ainsi que l'ID de l'audience. Pour en savoir plus, consultez Noms de ressources. |
userLists.list
firstPartyAndPartnerAudiences.list (API Display & Video 360) |
userLists.list (API Data Manager) |
Remarques |
|---|---|---|
|
parent |
parent contient l'ID de l'annonceur ou du partenaire parent. |
pageSize |
pageSize |
La taille de page maximale dans l'API Data Manager est de 1000. |
pageToken |
pageToken |
|
filter |
filter |
|
orderBy |
Aucun équivalent |
userLists.create
firstPartyAndPartnerAudiences.create (API Display & Video 360) |
userLists.create (API Data Manager) |
Remarques |
|---|---|---|
|
parent |
parent contient l'ID de l'annonceur ou du partenaire parent de la nouvelle audience. |
| Aucun équivalent | validateOnly |
|
Corps de la requête FirstPartyAndPartnerAudience |
Corps de la requête UserList |
Consultez UserList pour connaître le mappage du corps de la requête. |
userLists.update
firstPartyAndPartnerAudiences.patch (API Display & Video 360) |
userLists.patch (API Data Manager) |
Remarques |
|---|---|---|
|
Paramètre userList.name |
Nom de ressource de l'élément UserList à mettre à jour. |
updateMask |
updateMask |
Ce champ est recommandé, mais pas obligatoire dans l'API Data Manager. S'il est laissé vide, tous les champs inclus seront entièrement remplacés. |
| Aucun équivalent | validateOnly |
|
Corps de la requête FirstPartyAndPartnerAudience |
Corps de la requête UserList |
Consultez UserList pour connaître le mappage du corps de la requête. |
audienceMembers.ingest
firstPartyAndPartnerAudiences.editCustomerMatchMembers (API Display & Video 360) |
audienceMembers.ingest (API Data Manager) |
Remarques |
|---|---|---|
|
destinations |
Pour en savoir plus, consultez Configurer des destinations. |
addedContactInfoList.contactInfos |
audienceMembers |
Vous pouvez définir des identifiants utilisateur individuels dans le champ compositeData.userData des objets AudienceMember. Pour en savoir plus, consultez Identifiants utilisateur. |
addedContactInfoList.consent |
consent |
Le consentement peut également être défini dans des objets AudienceMember individuels. |
addedMobileDeviceIdList.mobileDeviceIds |
audienceMembers |
Les ID d'appareils mobiles individuels sont définis dans le champ mobileData des objets AudienceMember. |
addedMobileDeviceIdList.consent |
consent |
Le consentement peut également être défini dans des objets AudienceMember individuels. |
| Aucun équivalent | validateOnly |
|
| Aucun équivalent | encoding |
Obligatoire. Définissez sur le Encoding utilisé pour les valeurs UserIdentifier. |
| Aucun équivalent | encryptionInfo |
Définissez si la requête contient des valeurs chiffrées. Pour en savoir plus, consultez Chiffrement. |
| Aucun équivalent | termsOfService |
Obligatoire. Définissez ce paramètre pour indiquer que l'utilisateur a accepté ou refusé les conditions d'utilisation du ciblage par liste de clients. |
audienceMembers.remove
firstPartyAndPartnerAudiences.editCustomerMatchMembers (API Display & Video 360) |
audienceMembers.remove (API Data Manager) |
Remarques |
|---|---|---|
|
destinations |
|
removedContactInfoList.contactInfos |
audienceMembers |
Vous pouvez définir des identifiants utilisateur individuels dans le champ compositeData.userData des objets AudienceMember. Pour en savoir plus, consultez Identifiants utilisateur. |
removedMobileDeviceIdList.mobileDeviceIds |
audienceMembers |
Les ID d'appareils mobiles individuels sont définis dans le champ mobileData des objets AudienceMember. |
| Aucun équivalent | validateOnly |
|
| Aucun équivalent | encoding |
Obligatoire. Définissez sur le Encoding utilisé pour les valeurs UserIdentifier. |
| Aucun équivalent | encryptionInfo |
Définissez si la requête contient des valeurs chiffrées. Pour en savoir plus, consultez Chiffrement. |
Mappages de champs d'objets
Voici les correspondances entre les objets de l'API Display & Video 360 et les objets équivalents de l'API Data Manager.
UserList
FirstPartyAndPartnerAudience (API Display & Video 360) |
UserList (API Data Manager) |
Remarques |
|---|---|---|
name |
name |
Utilise un format de nom de ressource différent. Pour en savoir plus, consultez Noms de ressources. |
firstPartyAndPartnerAudienceId |
id |
|
| Aucun équivalent | readOnly |
|
displayName |
displayName |
|
description |
description |
|
| Aucun équivalent | membershipStatus |
|
| Aucun équivalent | integrationCode |
|
membershipDurationDays |
membershipDuration |
|
| Aucun équivalent | closingReason |
|
| Aucun équivalent | accessReason |
|
| Aucun équivalent | accountAccessStatus |
|
displayAudienceSize |
sizeInfo.displayNetworkMembersCount |
|
| Aucun équivalent | sizeInfo.searchNetworkMembersCount |
|
| Aucun équivalent | targetNetworkInfo |
|
| Aucun équivalent | ingestedUserListInfo |
|
firstPartyAndPartnerAudienceType |
Aucun équivalent | |
audienceType |
Aucun équivalent | |
audienceSource |
Aucun équivalent | |
activeDisplayAudienceSize |
Aucun équivalent | |
youtubeAudienceSize |
Aucun équivalent | |
gmailAudienceSize |
Aucun équivalent | |
displayMobileAppAudienceSize |
Aucun équivalent | |
displayMobileWebAudienceSize |
Aucun équivalent | |
displayDesktopAudienceSize |
Aucun équivalent | |
appId |
ingestedUserListInfo.mobileIdInfo.appId |
|
contactInfoList |
audienceMembers méthodes |
Dans l'API Data Manager, ajoutez et supprimez des membres à l'aide des méthodes ingest, remove et removeAll de audienceMembers.
|
mobileDeviceIdList |
audienceMembers méthodes |
Dans l'API Data Manager, ajoutez et supprimez des membres à l'aide des méthodes ingest, remove et removeAll de audienceMembers.
|
Noms de ressources
L'API Data Manager utilise un format de nom de ressource différent de celui de l'API Display & Video 360.
- API Display & Video 360
Dans l'API Display & Video 360, le nom d'une ressource
UserListutilise un format qui ne contient que l'ID d'audience :firstAndThirdPartyAudiences/{first_and_third_party_audience_id}- API Data Manager
Dans l'API Data Manager, le nom d'une ressource
UserListutilise un format qui contient l'ID d'audience, ainsi que l'ID de compteAccountTypeet l'ID de compte du partenaire ou de l'annonceur propriétaire de l'audience :accountTypes/{accountType}/accounts/{account}/userLists/{userList}
Identifiants utilisateur
Bien que userData soit toujours accepté, nous vous recommandons d'utiliser compositeData pour vous assurer que votre intégration est prête pour les améliorations futures. Pour en savoir plus, consultez Données composites.
ContactInfo (API Display & Video 360) |
CompositeData (API Data Manager) |
Remarques |
|---|---|---|
hashedEmails |
userData.userIdentifiers.emailAddress |
Définissez l'adresse e-mail mise en forme et hachée. Vous pouvez également chiffrer l'adresse e-mail hachée. Vous pouvez utiliser plusieurs adresses e-mail pour correspondre à un même utilisateur en utilisant plusieurs objets UserIdentifier. |
hashedPhoneNumbers |
userData.userIdentifiers.phoneNumber |
Définissez le numéro de téléphone mis en forme et haché. Vous pouvez également chiffrer le numéro de téléphone haché. Plusieurs numéros de téléphone peuvent être utilisés pour correspondre à un seul utilisateur à l'aide de plusieurs objets UserIdentifier. |
hashedFirstName |
userData.userIdentifiers.address.givenName |
Définissez le prénom mis en forme et haché. Vous pouvez également chiffrer le prénom haché. |
hashedLastName |
userData.userIdentifiers.address.familyName |
Définissez le nom de famille mis en forme et haché. Vous pouvez également chiffrer le nom de famille haché. |
countryCode |
userData.userIdentifiers.address.regionCode |
|
zipCodes |
userData.userIdentifiers.address.postalCode |
Vous pouvez utiliser plusieurs codes postaux pour correspondre à un même utilisateur en utilisant plusieurs objets UserIdentifier. |
Destination
| API Display & Video 360 | Destination (API Data Manager) |
Remarques |
|---|---|---|
| ID de l'annonceur ou du partenaire auquel l'utilisateur Display & Video 360 a accès. | loginAccount |
Cette option n'est nécessaire que dans un scénario d'accès partenaire Display & Video 360, où l'audience est sous un annonceur, mais où l'utilisateur Display & Video 360 qui y accède a obtenu l'accès au partenaire parent de l'annonceur. Sinon, vous pouvez ne pas le définir. |
| ID de l'annonceur ou du partenaire parent de l'audience. | operatingAccount |
|
firstPartyAndPartnerAudienceId |
productDestinationId |
|
| Aucun équivalent | reference |