Mapeamentos de campo

Use os mapeamentos nas tabelas para mapear os métodos e campos de gerenciamento de públicos-alvo segmentados 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 incluam 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 só vai retornar públicos-alvo segmentados 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 de 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 de públicos-alvo segmentados por lista de clientes.
Não há equivalente.	audienceMembers.removeAll	A API Data Manager permite remover todos os membros de um público-alvo com uma única solicitação.

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 Display & Video 360)	userLists.get (API Data Manager)	Observações
advertiserId partnerId firstPartyAndPartnerAudienceId	name	O nome de 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 Display & Video 360)	userLists.list (API Data Manager)	Observações
advertiserId partnerId	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 Display & Video 360)	userLists.create (API Data Manager)	Observações
advertiserId partnerId	parent	parent contém o ID do anunciante pai ou do parceiro do novo público-alvo.
Não há equivalente	validateOnly
Corpo da solicitação FirstPartyAndPartnerAudience	Corpo da solicitação UserList	Consulte UserList para ver o mapeamento do corpo da solicitação.

userLists.update

firstPartyAndPartnerAudiences.patch (API Display & Video 360)	userLists.patch (API Data Manager)	Observações
advertiserId firstPartyAndPartnerAudienceId	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 ver o mapeamento do corpo da solicitação.

audienceMembers.ingest

firstPartyAndPartnerAudiences.editCustomerMatchMembers (API Display & Video 360)	audienceMembers.ingest (API Data Manager)	Observações
advertiserId firstPartyAndPartnerAudienceId	destinations	Confira Configurar destinos para mais detalhes.
addedContactInfoList.contactInfos	audienceMembers	Os identificadores de usuário individuais podem ser definidos no campo compositeData.userData em 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 em 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. Defina como o Encoding usado para valores de UserIdentifier.
Não há equivalente	encryptionInfo	Defina se a solicitação contém valores criptografados. Consulte Criptografia para mais detalhes.
Não há equivalente	termsOfService	Obrigatório. Defina 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 Display & Video 360)	audienceMembers.remove (API Data Manager)	Observações
advertiserId firstPartyAndPartnerAudienceId	destinations
removedContactInfoList.contactInfos	audienceMembers	Os identificadores de usuário individuais podem ser definidos no campo compositeData.userData em 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 em objetos AudienceMember.
Não há equivalente	validateOnly
Não há equivalente	encoding	Obrigatório. Defina como o Encoding usado para valores de UserIdentifier.
Não há equivalente	encryptionInfo	Defina se a solicitação contém valores criptografados. Consulte Criptografia para mais detalhes.

Mapeamentos de campos de objetos

Confira os mapeamentos dos objetos da API Display & Video 360 para os objetos equivalentes na API Data Manager.

UserList

FirstPartyAndPartnerAudience (API 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, remove e removeAll de audienceMembers.
mobileDeviceIdList	Métodos audienceMembers	Na API Data Manager, adicione e remova membros usando os métodos ingest, remove e removeAll 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 UserList usa 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 UserList usa um formato que contém o ID do público-alvo, bem como o AccountType e o ID da conta do parceiro ou anunciante proprietário do público-alvo:

accountTypes/{accountType}/accounts/{account}/userLists/{userList}

Identificadores de usuários

Embora o userData ainda seja compatível, recomendamos o uso de compositeData para garantir que sua integração esteja preparada para melhorias futuras. Consulte Dados compostos para mais detalhes.

ContactInfo (API Display & Video 360)	CompositeData (API Data Manager)	Observações
hashedEmails	userData.userIdentifiers.emailAddress	Defina 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	Defina 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	Defina como o nome formatado e com hash. Também é possível criptografar o nome com hash.
hashedLastName	userData.userIdentifiers.address.familyName	Defina como o sobrenome formatado e com hash. Também é possível criptografar o nome de família com hash.
countryCode	userData.userIdentifiers.address.regionCode
zipCodes	userData.userIdentifiers.address.postalCode	Vários códigos postais 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á em um anunciante, mas o usuário do Display & Video 360 tem acesso ao parceiro principal do anunciante. Caso contrário, ele pode ser deixado sem definição.
É o ID do anunciante principal ou do parceiro do público-alvo.	operatingAccount
firstPartyAndPartnerAudienceId	productDestinationId
Não há equivalente	reference