欄位對應

請使用表格中的對應項目，將 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 (Data Manager API) 附註
  • advertiserId
  • partnerId
  • firstPartyAndPartnerAudienceId
 name UserList 名稱包含上層廣告主或合作夥伴的 ID，以及目標對象 ID。詳情請參閱「資源名稱」。

userLists.list

firstPartyAndPartnerAudiences.list (Display & Video 360 API) userLists.list (Data Manager 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 (Data Manager API) 附註
  • advertiserId
  • partnerId
 parent parent 包含新目標對象的上層廣告主或合作夥伴 ID。
無對應報告 validateOnly
FirstPartyAndPartnerAudience 要求主體 UserList 要求主體 如需要求主體對應，請參閱 UserList。

userLists.update

firstPartyAndPartnerAudiences.patch (Display & Video 360 API) userLists.patch (Data Manager 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 (Data Manager API) 附註
  • advertiserId
  • firstPartyAndPartnerAudienceId
 destinations 詳情請參閱「設定目的地」。
addedContactInfoList.contactInfos audienceMembers 您可以在 AudienceMember 物件的 compositeData.userData 欄位中設定個別使用者 ID。詳情請參閱「使用者 ID」。
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 (Data Manager API) 附註
  • advertiserId
  • firstPartyAndPartnerAudienceId
 destinations
removedContactInfoList.contactInfos audienceMembers 您可以在 AudienceMember 物件的 compositeData.userData 欄位中設定個別使用者 ID。詳情請參閱「使用者 ID」。
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 (Data Manager 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 方法新增及移除成員。

資源名稱

資料管理工具 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}

使用者 ID

雖然我們仍支援 userData，但建議使用 compositeData，確保整合服務能因應日後的改善措施。詳情請參閱「複合資料」。

ContactInfo (Display & Video 360 API) CompositeData (Data Manager 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 (Data Manager API) 附註
Display & Video 360 使用者獲准存取的廣告主或合作夥伴 ID。 loginAccount 只有在Display & Video 360 夥伴存取情境中，才需要設定這項功能。在這種情境中，目標對象屬於廣告主，但存取 Display & Video 360 的使用者已獲准存取廣告主的上層夥伴。否則可以不設定。
目標對象的上層廣告主或合作夥伴 ID。 operatingAccount
firstPartyAndPartnerAudienceId productDestinationId
無對應報告 reference
上一頁
升級步驟