Use os mapeamentos nas tabelas para mapear os métodos e campos de gerenciamento de público-alvo segmentado por lista de clientes na API Display & Video 360 para o equivalente na API Data Manager.
Autenticação
A API Data Manager exige credenciais com um escopo diferente da API Display & Video 360. Siga as etapas em Configurar o acesso à API para gerar novas credenciais que incluem o escopo da API Data Manager.
Mapeamento de métodos
A tabela a seguir mapeia os métodos da API Display & Video 360 para os métodos equivalentes da API Data Manager:
| Métodos da API Display & Video 360 | Métodos da API Data Manager | Observações |
|---|---|---|
firstPartyAndPartnerAudiences.get |
userLists.get |
A API Data Manager só pode recuperar públicos-alvo segmentados por lista de clientes. |
firstPartyAndPartnerAudiences.list |
userLists.list |
A API Data Manager retorna apenas públicos-alvo de segmentação por lista de clientes. |
firstPartyAndPartnerAudiences.create |
userLists.create |
Os dados do usuário precisam ser enviados em uma solicitação subsequente na API Data Manager. |
| Não há equivalente | userLists.delete |
Não disponível na API Display & Video 360. |
firstPartyAndPartnerAudiences.patch |
userLists.patch |
|
firstPartyAndPartnerAudiences.editCustomerMatchMembers |
audienceMembers.ingest |
Métodos separados da API Data Manager são usados para adicionar e remover membros dos públicos-alvo segmentados por lista de clientes. |
firstPartyAndPartnerAudiences.editCustomerMatchMembers |
audienceMembers.remove |
Métodos separados da API Data Manager são usados para adicionar e remover membros dos públicos-alvo segmentados por lista de clientes. |
Mapeamento de solicitações
As tabelas a seguir mapeiam os campos de solicitação dos métodos da API Display & Video 360 para os equivalentes na API Data Manager.
userLists.get
firstPartyAndPartnerAudiences.get (API do Display & Video 360) |
userLists.get (API Data Manager) |
Observações |
|---|---|---|
|
name |
O nome UserList contém o ID do anunciante ou parceiro principal e o ID do público-alvo. Consulte Nomes de recursos para mais detalhes. |
userLists.list
firstPartyAndPartnerAudiences.list (API do Display & Video 360) |
userLists.list (API Data Manager) |
Observações |
|---|---|---|
|
parent |
parent contém o ID do anunciante ou parceiro principal. |
pageSize |
pageSize |
O tamanho máximo da página na API Data Manager é 1000. |
pageToken |
pageToken |
|
filter |
filter |
|
orderBy |
Não há equivalente |
userLists.create
firstPartyAndPartnerAudiences.create (API do Display & Video 360) |
userLists.create (API Data Manager) |
Observações |
|---|---|---|
|
parent |
parent contém o ID do anunciante principal ou parceiro do novo público-alvo. |
| Não há equivalente | validateOnly |
|
Corpo da solicitação FirstPartyAndPartnerAudience |
Corpo da solicitação UserList |
Consulte UserList para o mapeamento do corpo da solicitação. |
userLists.update
firstPartyAndPartnerAudiences.patch (API do Display & Video 360) |
userLists.patch (API Data Manager) |
Observações |
|---|---|---|
|
Parâmetro userList.name |
O nome do recurso do UserList a ser atualizado. |
updateMask |
updateMask |
Esse campo é recomendado, mas não obrigatório na API Data Manager. Se ele for deixado em branco, todos os campos incluídos serão substituídos. |
| Não há equivalente | validateOnly |
|
Corpo da solicitação FirstPartyAndPartnerAudience |
Corpo da solicitação UserList |
Consulte UserList para o mapeamento do corpo da solicitação. |
audienceMembers.ingest
firstPartyAndPartnerAudiences.editCustomerMatchMembers (API do Display & Video 360) |
audienceMembers.ingest (API Data Manager) |
Observações |
|---|---|---|
|
destinations |
Confira Configurar destinos para mais detalhes. |
addedContactInfoList.contactInfos |
audienceMembers |
Os identificadores de usuários individuais podem ser definidos no campo compositeData.userData nos objetos AudienceMember. Consulte Identificadores de usuário para mais detalhes. |
addedContactInfoList.consent |
consent |
O consentimento também pode ser definido em objetos AudienceMember individuais. |
addedMobileDeviceIdList.mobileDeviceIds |
audienceMembers |
Os IDs de dispositivos móveis individuais são definidos no campo mobileData nos objetos AudienceMember. |
addedMobileDeviceIdList.consent |
consent |
O consentimento também pode ser definido em objetos AudienceMember individuais. |
| Não há equivalente | validateOnly |
|
| Não há equivalente | encoding |
Obrigatório. Definido como o Encoding usado para valores de UserIdentifier. |
| Não há equivalente | encryptionInfo |
Definido se a solicitação contém valores criptografados. Consulte Criptografia para mais detalhes. |
| Não há equivalente | termsOfService |
Obrigatório. Definido para indicar que o usuário aceitou ou rejeitou os Termos de Serviço da Segmentação por lista de clientes. |
audienceMembers.remove
firstPartyAndPartnerAudiences.editCustomerMatchMembers (API do Display & Video 360) |
audienceMembers.remove (API Data Manager) |
Observações |
|---|---|---|
|
destinations |
|
removedContactInfoList.contactInfos |
audienceMembers |
Os identificadores de usuários individuais podem ser definidos no campo compositeData.userData nos objetos AudienceMember. Consulte Identificadores de usuário para mais detalhes. |
removedMobileDeviceIdList.mobileDeviceIds |
audienceMembers |
Os IDs de dispositivos móveis individuais são definidos no campo mobileData nos objetos AudienceMember. |
| Não há equivalente | validateOnly |
|
| Não há equivalente | encoding |
Obrigatório. Definido como o Encoding usado para valores de UserIdentifier. |
| Não há equivalente | encryptionInfo |
Definido se a solicitação contém valores criptografados. Consulte Criptografia para mais detalhes. |
Mapeamentos de campos de objetos
Confira os mapeamentos de objetos da API Display & Video 360 para os objetos equivalentes na API Data Manager.
UserList
FirstPartyAndPartnerAudience (API do Display & Video 360) |
UserList (API Data Manager) |
Observações |
|---|---|---|
name |
name |
Usa um formato de nome de recurso diferente. Consulte Nomes de recursos para mais detalhes. |
firstPartyAndPartnerAudienceId |
id |
|
| Não há equivalente | readOnly |
|
displayName |
displayName |
|
description |
description |
|
| Não há equivalente | membershipStatus |
|
| Não há equivalente | integrationCode |
|
membershipDurationDays |
membershipDuration |
|
| Não há equivalente | closingReason |
|
| Não há equivalente | accessReason |
|
| Não há equivalente | accountAccessStatus |
|
displayAudienceSize |
sizeInfo.displayNetworkMembersCount |
|
| Não há equivalente | sizeInfo.searchNetworkMembersCount |
|
| Não há equivalente | targetNetworkInfo |
|
| Não há equivalente | ingestedUserListInfo |
|
firstPartyAndPartnerAudienceType |
Não há equivalente | |
audienceType |
Não há equivalente | |
audienceSource |
Não há equivalente | |
activeDisplayAudienceSize |
Não há equivalente | |
youtubeAudienceSize |
Não há equivalente | |
gmailAudienceSize |
Não há equivalente | |
displayMobileAppAudienceSize |
Não há equivalente | |
displayMobileWebAudienceSize |
Não há equivalente | |
displayDesktopAudienceSize |
Não há equivalente | |
appId |
ingestedUserListInfo.mobileIdInfo.appId |
|
contactInfoList |
Métodos audienceMembers |
Na API Data Manager, adicione e remova membros usando os métodos ingest e remove de audienceMembers.
|
mobileDeviceIdList |
Métodos audienceMembers |
Na API Data Manager, adicione e remova membros usando os métodos ingest e remove de audienceMembers.
|
Nomes de recursos
A API Data Manager usa um formato de nome de recurso diferente da API Display & Video 360.
- API Display & Video 360
Na API Display & Video 360, um nome de recurso
UserListusa um formato que contém apenas o ID do público-alvo:firstAndThirdPartyAudiences/{first_and_third_party_audience_id}- API Data Manager
Na API Data Manager, um nome de recurso
UserListusa um formato que contém o ID do público-alvo, além doAccountTypee do ID da conta do parceiro ou anunciante proprietário do público-alvo:accountTypes/{accountType}/accounts/{account}/userLists/{userList}
Identificadores do usuário
Embora userData
ainda tenha suporte, recomendamos usar
compositeData
para garantir que sua integração esteja preparada para melhorias futuras. Consulte Dados compostos para mais detalhes.
ContactInfo (API do Display & Video 360) |
CompositeData (API Data Manager) |
Observações |
|---|---|---|
hashedEmails |
userData.userIdentifiers.emailAddress |
Definido como o endereço de e-mail formatado e com hash. Também é possível criptografar o endereço de e-mail com hash. É possível usar vários e-mails para corresponder a um único usuário usando vários objetos UserIdentifier. |
hashedPhoneNumbers |
userData.userIdentifiers.phoneNumber |
Definido como o número de telefone formatado e com hash. Também é possível criptografar o número de telefone com hash. Vários números de telefone podem ser usados para corresponder a um único usuário usando vários objetos UserIdentifier. |
hashedFirstName |
userData.userIdentifiers.address.givenName |
Definido como o nome formatado e com hash. Também é possível criptografar o nome fornecido com hash. |
hashedLastName |
userData.userIdentifiers.address.familyName |
Definido como o nome da família formatado e com hash. Também é possível criptografar o nome da família com hash. |
countryCode |
userData.userIdentifiers.address.regionCode |
|
zipCodes |
userData.userIdentifiers.address.postalCode |
Vários CEPs podem ser usados para corresponder a um único usuário usando vários objetos UserIdentifier. |
Destino
| API Display & Video 360 | Destination (API Data Manager) |
Observações |
|---|---|---|
| O ID do anunciante ou parceiro a que o usuário do Display & Video 360 recebeu acesso. | loginAccount |
Isso só precisa ser definido em um cenário de acesso de parceiro do Display & Video 360, em que o público-alvo está sob um anunciante, mas o usuário do Display & Video 360 que está acessando recebeu acesso ao parceiro principal do anunciante. Caso contrário, ele pode ser deixado sem definição. |
| O ID do anunciante principal ou parceiro do público-alvo. | operatingAccount |
|
firstPartyAndPartnerAudienceId |
productDestinationId |
|
| Não há equivalente | reference |