Usa las asignaciones de las tablas para correlacionar los métodos y campos de administración de públicos de la Segmentación por clientes en la API de Display & Video 360 con sus equivalentes en la API de Data Manager.
Autenticación
La API de Data Manager requiere credenciales con un permiso diferente al de la API de Display & Video 360. Sigue los pasos que se indican en Configura el acceso a la API para generar credenciales nuevas que incluyan el alcance de la API de Data Manager.
Asignación de métodos
En la siguiente tabla, se asignan los métodos de la API de Display & Video 360 a los métodos equivalentes de la API de Data Manager:
| Métodos de la API de Display & Video 360 | Métodos de la API de Data Manager | Notas |
|---|---|---|
firstPartyAndPartnerAudiences.get |
userLists.get |
La API de Data Manager solo puede recuperar públicos de Segmentación por clientes. |
firstPartyAndPartnerAudiences.list |
userLists.list |
La API de Data Manager solo devolverá públicos de la Segmentación por clientes. |
firstPartyAndPartnerAudiences.create |
userLists.create |
Los datos del usuario se deben subir en una solicitud posterior en la API de Data Manager. |
| Sin equivalente | userLists.delete |
No está disponible en la API de Display & Video 360. |
firstPartyAndPartnerAudiences.patch |
userLists.patch |
|
firstPartyAndPartnerAudiences.editCustomerMatchMembers |
audienceMembers.ingest |
Se usan métodos separados de la API de Data Manager para agregar y quitar miembros de los públicos de Segmentación por clientes. |
firstPartyAndPartnerAudiences.editCustomerMatchMembers |
audienceMembers.remove |
Se usan métodos separados de la API de Data Manager para agregar y quitar miembros de los públicos de Segmentación por clientes. |
Asignación de solicitudes
En las siguientes tablas, se asignan los campos de solicitud de los métodos de la API de Display & Video 360 a sus equivalentes en la API de Data Manager.
userLists.get
firstPartyAndPartnerAudiences.get (API de Display & Video 360) |
userLists.get (API de Data Manager) |
Notas |
|---|---|---|
|
name |
El nombre de UserList contiene el ID del socio o anunciante principal, así como el ID del público. Consulta Nombres de recursos para obtener más detalles. |
userLists.list
firstPartyAndPartnerAudiences.list (API de Display & Video 360) |
userLists.list (API de Data Manager) |
Notas |
|---|---|---|
|
parent |
parent contiene el ID del socio o anunciante principal. |
pageSize |
pageSize |
El tamaño máximo de página en la API de Data Manager es de 1000. |
pageToken |
pageToken |
|
filter |
filter |
|
orderBy |
Sin equivalente |
userLists.create
firstPartyAndPartnerAudiences.create (API de Display & Video 360) |
userLists.create (API de Data Manager) |
Notas |
|---|---|---|
|
parent |
parent contiene el ID del socio o anunciante principal del público nuevo. |
| Sin equivalente | validateOnly |
|
Cuerpo de la solicitud de FirstPartyAndPartnerAudience |
Cuerpo de la solicitud de UserList |
Consulta UserList para ver la asignación del cuerpo de la solicitud. |
userLists.update
firstPartyAndPartnerAudiences.patch (API de Display & Video 360) |
userLists.patch (API de Data Manager) |
Notas |
|---|---|---|
|
Parámetro userList.name |
El nombre del recurso del UserList que se actualizará. |
updateMask |
updateMask |
Este campo se recomienda, pero no es obligatorio en la API de Data Manager, y generará un reemplazo completo de todos los campos incluidos si se deja vacío. |
| Sin equivalente | validateOnly |
|
Cuerpo de la solicitud de FirstPartyAndPartnerAudience |
Cuerpo de la solicitud de UserList |
Consulta UserList para ver la asignación del cuerpo de la solicitud. |
audienceMembers.ingest
firstPartyAndPartnerAudiences.editCustomerMatchMembers (API de Display & Video 360) |
audienceMembers.ingest (API de Data Manager) |
Notas |
|---|---|---|
|
destinations |
Consulta Configura destinos para obtener más detalles. |
addedContactInfoList.contactInfos |
audienceMembers |
Los identificadores de usuarios individuales se pueden establecer en el campo compositeData.userData dentro de los objetos AudienceMember. Consulta Identificadores de usuario para obtener más detalles. |
addedContactInfoList.consent |
consent |
El consentimiento también se puede establecer en objetos AudienceMember individuales. |
addedMobileDeviceIdList.mobileDeviceIds |
audienceMembers |
Los IDs de dispositivos móviles individuales se configuran en el campo mobileData dentro de los objetos AudienceMember. |
addedMobileDeviceIdList.consent |
consent |
El consentimiento también se puede establecer en objetos AudienceMember individuales. |
| Sin equivalente | validateOnly |
|
| Sin equivalente | encoding |
Obligatorio. Se establece en el Encoding que se usa para los valores de UserIdentifier. |
| Sin equivalente | encryptionInfo |
Indica si la solicitud contiene valores encriptados. Consulta Encriptación para obtener más detalles. |
| Sin equivalente | termsOfService |
Obligatorio. Se configura para indicar que el usuario aceptó o rechazó las Condiciones del Servicio de la Segmentación por clientes. |
audienceMembers.remove
firstPartyAndPartnerAudiences.editCustomerMatchMembers (API de Display & Video 360) |
audienceMembers.remove (API de Data Manager) |
Notas |
|---|---|---|
|
destinations |
|
removedContactInfoList.contactInfos |
audienceMembers |
Los identificadores de usuarios individuales se pueden establecer en el campo compositeData.userData dentro de los objetos AudienceMember. Consulta Identificadores de usuario para obtener más detalles. |
removedMobileDeviceIdList.mobileDeviceIds |
audienceMembers |
Los IDs de dispositivos móviles individuales se configuran en el campo mobileData dentro de los objetos AudienceMember. |
| Sin equivalente | validateOnly |
|
| Sin equivalente | encoding |
Obligatorio. Se establece en el Encoding que se usa para los valores de UserIdentifier. |
| Sin equivalente | encryptionInfo |
Indica si la solicitud contiene valores encriptados. Consulta Encriptación para obtener más detalles. |
Asignaciones de campos de objetos
A continuación, se muestran las asignaciones de los objetos de la API de Display & Video 360 a los objetos equivalentes en la API de Data Manager.
UserList
FirstPartyAndPartnerAudience (API de Display & Video 360) |
UserList (API de Data Manager) |
Notas |
|---|---|---|
name |
name |
Usa un formato de nombre de recurso diferente. Consulta Nombres de recursos para obtener más detalles. |
firstPartyAndPartnerAudienceId |
id |
|
| Sin equivalente | readOnly |
|
displayName |
displayName |
|
description |
description |
|
| Sin equivalente | membershipStatus |
|
| Sin equivalente | integrationCode |
|
membershipDurationDays |
membershipDuration |
|
| Sin equivalente | closingReason |
|
| Sin equivalente | accessReason |
|
| Sin equivalente | accountAccessStatus |
|
displayAudienceSize |
sizeInfo.displayNetworkMembersCount |
|
| Sin equivalente | sizeInfo.searchNetworkMembersCount |
|
| Sin equivalente | targetNetworkInfo |
|
| Sin equivalente | ingestedUserListInfo |
|
firstPartyAndPartnerAudienceType |
Sin equivalente | |
audienceType |
Sin equivalente | |
audienceSource |
Sin equivalente | |
activeDisplayAudienceSize |
Sin equivalente | |
youtubeAudienceSize |
Sin equivalente | |
gmailAudienceSize |
Sin equivalente | |
displayMobileAppAudienceSize |
Sin equivalente | |
displayMobileWebAudienceSize |
Sin equivalente | |
displayDesktopAudienceSize |
Sin equivalente | |
appId |
ingestedUserListInfo.mobileIdInfo.appId |
|
contactInfoList |
Métodos audienceMembers |
En la API de Data Manager, agrega y quita miembros con los métodos ingest y remove de audienceMembers.
|
mobileDeviceIdList |
Métodos audienceMembers |
En la API de Data Manager, agrega y quita miembros con los métodos ingest y remove de audienceMembers.
|
Nombres de recursos
La API de Data Manager usa un formato de nombre de recurso diferente al de la API de Display & Video 360.
- API de Display & Video 360
En la API de Display & Video 360, el nombre de un recurso
UserListusa un formato que solo contiene el ID del público:firstAndThirdPartyAudiences/{first_and_third_party_audience_id}- API de Data Manager
En la API de Data Manager, el nombre de un recurso
UserListusa un formato que contiene el ID del público, así como elAccountTypey el ID de la cuenta del socio o anunciante propietario del público:accountTypes/{accountType}/accounts/{account}/userLists/{userList}
Identificadores de usuario
Si bien userData
aún es compatible, te recomendamos que uses
compositeData
para asegurarte de que tu integración esté preparada para futuras mejoras. Consulta Datos compuestos para obtener más detalles.
ContactInfo (API de Display & Video 360) |
CompositeData (API de Data Manager) |
Notas |
|---|---|---|
hashedEmails |
userData.userIdentifiers.emailAddress |
Se establece en la dirección de correo electrónico con formato y hash. También puedes encriptar la dirección de correo electrónico hasheada. Se pueden usar varios correos electrónicos para hacer coincidir a un solo usuario con varios objetos UserIdentifier. |
hashedPhoneNumbers |
userData.userIdentifiers.phoneNumber |
Se establece en el número de teléfono con formato y codificado con hash. También puedes encriptar el número de teléfono codificado con hash. Se pueden usar varios números de teléfono para correlacionar a un solo usuario con varios objetos UserIdentifier. |
hashedFirstName |
userData.userIdentifiers.address.givenName |
Se establece en el nombre proporcionado con formato y hash. También puedes encriptar el nombre proporcionado con hash. |
hashedLastName |
userData.userIdentifiers.address.familyName |
Se establece en el nombre de familia con formato y hash. También puedes encriptar el nombre de la familia hasheado. |
countryCode |
userData.userIdentifiers.address.regionCode |
|
zipCodes |
userData.userIdentifiers.address.postalCode |
Se pueden usar varios códigos postales para hacer coincidir a un solo usuario con varios objetos UserIdentifier. |
Destino
| API de Display & Video 360 | Destination (API de Data Manager) |
Notas |
|---|---|---|
| Es el ID del anunciante o socio al que se le otorgó acceso al usuario de Display & Video 360. | loginAccount |
Esto solo debe configurarse en una situación de acceso de socio de Display & Video 360, en la que el público se encuentra en un anunciante, pero al usuario de Display & Video 360 que accede se le otorgó acceso al socio principal del anunciante. De lo contrario, se puede dejar sin configurar. |
| Es el ID del socio o anunciante principal del público. | operatingAccount |
|
firstPartyAndPartnerAudienceId |
productDestinationId |
|
| Sin equivalente | reference |