Field mappings

Use the mappings in the tables to map Customer Match audience management methods and fields in the Display & Video 360 API to their equivalent in the Data Manager API.

Method mapping

The following table maps Display & Video 360 API methods to equivalent Data Manager API methods:

Display & Video 360 API methods	Data Manager API methods	Notes
firstPartyAndPartnerAudiences.get	userLists.get	The Data Manager API can only retrieve Customer Match audiences.
firstPartyAndPartnerAudiences.list	userLists.list	The Data Manager API will only return Customer Match audiences.
firstPartyAndPartnerAudiences.create	userLists.create	User data must be uploaded in a subsequent request in the Data Manager API.
No equivalent	userLists.delete	Not available in Display & Video 360 API.
firstPartyAndPartnerAudiences.patch	userLists.patch
firstPartyAndPartnerAudiences.editCustomerMatchMembers	audienceMembers.ingest	Separate Data Manager API methods are used to add and remove members from Customer Match audiences.
firstPartyAndPartnerAudiences.editCustomerMatchMembers	audienceMembers.remove	Separate Data Manager API methods are used to add and remove members from Customer Match audiences.

Request mapping

The following tables map request fields of Display & Video 360 API methods to their equivalent in the Data Manager API.

userLists.get

firstPartyAndPartnerAudiences.get (Display & Video 360 API)	userLists.get (Data Manager API)	Notes
advertiserId partnerId firstPartyAndPartnerAudienceId	name	The UserList name contains both the ID of the parent advertiser or partner as well as the audience ID. See Resource names for details.

userLists.list

firstPartyAndPartnerAudiences.list (Display & Video 360 API)	userLists.list (Data Manager API)	Notes
advertiserId partnerId	parent	parent contains the ID of the parent advertiser or partner.
pageSize	pageSize	The maximum page size in the Data Manager API is 1000.
pageToken	pageToken
filter	filter
orderBy	No equivalent

userLists.create

firstPartyAndPartnerAudiences.create (Display & Video 360 API)	userLists.create (Data Manager API)	Notes
advertiserId partnerId	parent	parent contains the ID of the parent advertiser or partner of the new audience.
No equivalent	validateOnly
FirstPartyAndPartnerAudience request body	UserList request body	See UserList for the request body mapping.

userLists.update

firstPartyAndPartnerAudiences.patch (Display & Video 360 API)	userLists.patch (Data Manager API)	Notes
advertiserId firstPartyAndPartnerAudienceId	userList.name parameter	The resource name of the UserList to update.
updateMask	updateMask	This field is recommended but not required in the Data Manager API and will result in a full replace of all included fields if left empty.
No equivalent	validateOnly
FirstPartyAndPartnerAudience request body	UserList request body	See UserList for the request body mapping.

audienceMembers.ingest

firstPartyAndPartnerAudiences.editCustomerMatchMembers (Display & Video 360 API)	audienceMembers.ingest (Data Manager API)	Notes
advertiserId firstPartyAndPartnerAudienceId	destinations	Check out Configure destinations for details.
addedContactInfoList.contactInfos	audienceMembers	Individual user data is set in the userData field within AudienceMember objects.
addedContactInfoList.consent	consent	Consent can also be set in individual AudienceMember objects.
addedMobileDeviceIdList.mobileDeviceIds	audienceMembers	Individual mobile device IDs are set in the mobileData field within AudienceMember objects.
addedMobileDeviceIdList.consent	consent	Consent can also be set in individual AudienceMember objects.
No equivalent	validateOnly
No equivalent	encoding	Required. Set to the Encoding used for UserIdentifier values.
No equivalent	encryptionInfo	Set if the request contains encrypted values. See Encryption for details.
No equivalent	termsOfService	Required. Set to indicate that the user has accepted or rejected the terms of service for Customer Match.

audienceMembers.remove

firstPartyAndPartnerAudiences.editCustomerMatchMembers (Display & Video 360 API)	audienceMembers.remove (Data Manager API)	Notes
advertiserId firstPartyAndPartnerAudienceId	destinations
removedContactInfoList.contactInfos	audienceMembers	Individual user data is set in the userData field within AudienceMember objects. See UserData for details.
removedMobileDeviceIdList.mobileDeviceIds	audienceMembers	Individual mobile device IDs are set in the mobileData field within AudienceMember objects.
No equivalent	validateOnly
No equivalent	encoding	Required. Set to the Encoding used for UserIdentifier values.
No equivalent	encryptionInfo	Set if the request contains encrypted values. See Encryption for details.

Object field mappings

Here are the mappings from Display & Video 360 API objects to the equivalent objects in the Data Manager API.

UserList

FirstPartyAndPartnerAudience (Display & Video 360 API)	UserList (Data Manager API)	Notes
name	name	Uses a different resource name format. See Resource names for details.
firstPartyAndPartnerAudienceId	id
No equivalent	readOnly
displayName	displayName
description	description
No equivalent	membershipStatus
No equivalent	integrationCode
membershipDurationDays	membershipDuration
No equivalent	closingReason
No equivalent	accessReason
No equivalent	accountAccessStatus
displayAudienceSize	sizeInfo.displayNetworkMembersCount
No equivalent	sizeInfo.searchNetworkMembersCount
No equivalent	targetNetworkInfo
No equivalent	ingestedUserListInfo
firstPartyAndPartnerAudienceType	No equivalent
audienceType	No equivalent
audienceSource	No equivalent
activeDisplayAudienceSize	No equivalent
youtubeAudienceSize	No equivalent
gmailAudienceSize	No equivalent
displayMobileAppAudienceSize	No equivalent
displayMobileWebAudienceSize	No equivalent
displayDesktopAudienceSize	No equivalent
appId	ingestedUserListInfo.mobileIdInfo.appId
contactInfoList	audienceMembers methods	In the Data Manager API, add and remove members using the ingest and remove methods of audienceMembers.
mobileDeviceIdList	audienceMembers methods	In the Data Manager API, add and remove members using the ingest and remove methods of audienceMembers.

Resource names

The Data Manager API uses a different resource name format than the Display & Video 360 API.

Display & Video 360 API

In the Display & Video 360 API, a UserList resource name uses a format that only contains the audience ID:

firstAndThirdPartyAudiences/{first_and_third_party_audience_id}

Data Manager API

In the Data Manager API, a UserList resource name uses a format that contains the audience ID as well as the AccountType and account ID of the partner or advertiser that owns the audience:

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

UserData

ContactInfo (Display & Video 360 API)	UserData (Data Manager API)	Notes
hashedEmails	userIdentifiers.emailAddress	Set to the formatted and hashed email address. You can also encrypt the hashed email address. Multiple emails can be used to match a single user by using multiple UserIdentifier objects.
hashedPhoneNumbers	userIdentifiers.phoneNumber	Set to the formatted and hashed phone number. You can also encrypt the hashed phone number. Multiple phone numbers can be used to match a single user by using multiple UserIdentifier objects.
hashedFirstName	userIdentifiers.address.givenName	Set to the formatted and hashed given name. You can also encrypt the hashed given name.
hashedLastName	userIdentifiers.address.familyName	Set to the formatted and hashed family name. You can also encrypt the hashed family name.
countryCode	userIdentifiers.address.regionCode
zipCodes	userIdentifiers.address.postalCode	Multiple zip codes can be used to match a single user by using multiple UserIdentifier objects.

Destination

Display & Video 360 API	Destination (Data Manager API)	Notes
The ID of the advertiser or partner the Display & Video 360 user has been given access to.	loginAccount	This only needs to be set in a Display & Video 360 partner access scenario, where the audience is under an advertiser but the accessing Display & Video 360 user has been granted access to the advertiser's parent partner. Otherwise, it can be left unset.
The ID of the parent advertiser or partner of the audience.	operatingAccount
firstPartyAndPartnerAudienceId	productDestinationId
No equivalent	reference