字段映射

使用下表中的映射，将 Display & Video 360 API 中的“目标客户匹配”受众群体管理方法和字段映射到 Data Manager API 中的等效方法和字段。

身份验证

Data Manager API 需要的凭据范围与 Display & Video 360 API 不同。按照设置 API 访问权限中的步骤生成包含 Data Manager API 范围的新凭据。

方法映射

下表列出了 Display & Video 360 API 方法与等效的 Data Manager API 方法之间的对应关系：

Display & Video 360 API 方法 Data Manager API 方法 备注
firstPartyAndPartnerAudiences.get userLists.get Data Manager API 只能检索目标客户匹配受众群体。
firstPartyAndPartnerAudiences.list userLists.list Data Manager API 将仅返回目标客户匹配受众群体。
firstPartyAndPartnerAudiences.create userLists.create 用户数据必须在 Data Manager API 的后续请求中上传。
无对应报告 userLists.delete 在 Display & Video 360 API 中不可用。
firstPartyAndPartnerAudiences.patch userLists.patch
firstPartyAndPartnerAudiences.editCustomerMatchMembers audienceMembers.ingest 您可以使用不同的 Data Manager API 方法向目标客户匹配受众群体添加成员和从中移除成员。
firstPartyAndPartnerAudiences.editCustomerMatchMembers audienceMembers.remove 您可以使用不同的 Data Manager API 方法向目标客户匹配受众群体添加成员和从中移除成员。

请求映射

下表列出了 Display & Video 360 API 方法的请求字段与 Data Manager API 中相应字段之间的对应关系。

userLists.get

firstPartyAndPartnerAudiences.get (Display & Video 360 API) userLists.get（数据管理器 API） 备注
  • advertiserId
  • partnerId
  • firstPartyAndPartnerAudienceId
 name UserList 名称同时包含父级广告客户或合作伙伴的 ID 以及受众群体 ID。如需了解详情，请参阅资源名称。

userLists.list

firstPartyAndPartnerAudiences.list (Display & Video 360 API) userLists.list（数据管理器 API） 备注
  • advertiserId
  • partnerId
 parent parent 包含父级广告客户或合作伙伴的 ID。
pageSize pageSize Data Manager API 中的最大页面大小为 1000。
pageToken pageToken
filter filter
orderBy 无对应报告

userLists.create

firstPartyAndPartnerAudiences.create (Display & Video 360 API) userLists.create（数据管理器 API） 备注
  • advertiserId
  • partnerId
 parent parent 包含新受众群体的父级广告客户或合作伙伴的 ID。
无对应报告 validateOnly
FirstPartyAndPartnerAudience 请求正文 UserList 请求正文 如需了解请求正文映射，请参阅 UserList。

userLists.update

firstPartyAndPartnerAudiences.patch (Display & Video 360 API) userLists.patch（数据管理器 API） 备注
  • advertiserId
  • firstPartyAndPartnerAudienceId
 userList.name 参数 要更新的 UserList 的资源名称。
updateMask updateMask 在 Data Manager API 中，建议使用此字段，但并非必需。如果留空，则会导致完全替换所有包含的字段。
无对应报告 validateOnly
FirstPartyAndPartnerAudience 请求正文 UserList 请求正文 如需了解请求正文映射，请参阅 UserList。

audienceMembers.ingest

firstPartyAndPartnerAudiences.editCustomerMatchMembers (Display & Video 360 API) audienceMembers.ingest（数据管理器 API） 备注
  • advertiserId
  • firstPartyAndPartnerAudienceId
 destinations 如需了解详情，请参阅配置目的地。
addedContactInfoList.contactInfos audienceMembers 您可以在 AudienceMember 对象内的 compositeData.userData 字段中设置各个用户标识符。如需了解详情，请参阅用户标识符。
addedContactInfoList.consent consent 也可以在各个 AudienceMember 对象中设置同意情况。
addedMobileDeviceIdList.mobileDeviceIds audienceMembers 各个移动设备 ID 在 AudienceMember 对象内的 mobileData 字段中设置。
addedMobileDeviceIdList.consent consent 也可以在各个 AudienceMember 对象中设置同意情况。
无对应报告 validateOnly
无对应报告 encoding 必需。设置为用于 UserIdentifier 值的 Encoding。
无对应报告 encryptionInfo 设置请求是否包含加密值。如需了解详情，请参阅加密。
无对应报告 termsOfService 必需。设置为指示用户已接受或拒绝目标客户匹配的服务条款。

audienceMembers.remove

firstPartyAndPartnerAudiences.editCustomerMatchMembers (Display & Video 360 API) audienceMembers.remove（数据管理器 API） 备注
  • advertiserId
  • firstPartyAndPartnerAudienceId
 destinations
removedContactInfoList.contactInfos audienceMembers 您可以在 AudienceMember 对象内的 compositeData.userData 字段中设置各个用户标识符。如需了解详情，请参阅用户标识符。
removedMobileDeviceIdList.mobileDeviceIds audienceMembers 各个移动设备 ID 在 AudienceMember 对象内的 mobileData 字段中设置。
无对应报告 validateOnly
无对应报告 encoding 必需。设置为用于 UserIdentifier 值的 Encoding。
无对应报告 encryptionInfo 设置请求是否包含加密值。如需了解详情，请参阅加密。

对象字段映射

下表列出了 Display & Video 360 API 对象与 Data Manager API 中等效对象的映射关系。

UserList

FirstPartyAndPartnerAudience (Display & Video 360 API) UserList（数据管理器 API） 备注
name name 使用其他资源名称格式。如需了解详情，请参阅资源名称。
firstPartyAndPartnerAudienceId id
无对应报告 readOnly
displayName displayName
description description
无对应报告 membershipStatus
无对应报告 integrationCode
membershipDurationDays membershipDuration
无对应报告 closingReason
无对应报告 accessReason
无对应报告 accountAccessStatus
displayAudienceSize sizeInfo.displayNetworkMembersCount
无对应报告 sizeInfo.searchNetworkMembersCount
无对应报告 targetNetworkInfo
无对应报告 ingestedUserListInfo
firstPartyAndPartnerAudienceType 无对应报告
audienceType 无对应报告
audienceSource 无对应报告
activeDisplayAudienceSize 无对应报告
youtubeAudienceSize 无对应报告
gmailAudienceSize 无对应报告
displayMobileAppAudienceSize 无对应报告
displayMobileWebAudienceSize 无对应报告
displayDesktopAudienceSize 无对应报告
appId ingestedUserListInfo.mobileIdInfo.appId
contactInfoList audienceMembers 方法 在 Data Manager API 中，使用 audienceMembers 的 ingest 和 remove 方法添加和移除成员。
mobileDeviceIdList audienceMembers 方法 在 Data Manager API 中，使用 audienceMembers 的 ingest 和 remove 方法添加和移除成员。

资源名称

Data Manager API 使用的资源名称格式与 Display & Video 360 API 不同。

Display & Video 360 API

在 Display & Video 360 API 中，UserList 资源名称使用的格式仅包含受众群体 ID：

firstAndThirdPartyAudiences/{first_and_third_party_audience_id}

Data Manager API

在 Data Manager API 中，UserList 资源名称采用的格式包含受众群体 ID 以及拥有相应受众群体的合作伙伴或广告客户的 AccountType 和账号 ID：

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

用户标识符

虽然我们仍支持 userData，但建议您使用 compositeData，以确保您的集成已为未来的改进做好准备。如需了解详情，请参阅复合数据。

ContactInfo (Display & Video 360 API) CompositeData（数据管理器 API） 备注
hashedEmails userData.userIdentifiers.emailAddress 设置为经过格式化和哈希处理的电子邮件地址。您还可以加密哈希处理后的电子邮件地址。您可以使用多个 UserIdentifier 对象，通过多个电子邮件地址来匹配单个用户。
hashedPhoneNumbers userData.userIdentifiers.phoneNumber 设置为已格式化和哈希处理的电话号码。您还可以对哈希处理后的电话号码进行加密。可以使用多个 UserIdentifier 对象，通过多个电话号码来匹配单个用户。
hashedFirstName userData.userIdentifiers.address.givenName 设置为格式化和哈希处理的给定名称。您还可以加密哈希处理后的给定名称。
hashedLastName userData.userIdentifiers.address.familyName 设置为已格式化和哈希处理的系列名称。您还可以加密哈希处理后的家人群组名称。
countryCode userData.userIdentifiers.address.regionCode
zipCodes userData.userIdentifiers.address.postalCode 您可以使用多个 UserIdentifier 对象，通过多个邮政编码来匹配单个用户。

目的地

Display & Video 360 API Destination（数据管理器 API） 备注
Display & Video 360 用户获准访问的广告客户或合作伙伴的 ID。 loginAccount 只有在Display & Video 360 合作伙伴访问权限方案中才需要设置此项，即受众群体位于某个广告客户下，但访问 Display & Video 360 的用户已被授予对相应广告客户的父合作伙伴的访问权限。否则，可以将其留空。
相应受众群体的父级广告客户或合作伙伴的 ID。 operatingAccount
firstPartyAndPartnerAudienceId productDestinationId
无对应报告 reference
上一页
升级步骤