欄位對應

請使用表格中的對應關係，將 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 方法，在目標顧客比對目標對象中新增及移除成員。
沒有效果相當的功能。 audienceMembers.removeAll 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 和 removeAll 方法新增及移除成員。
mobileDeviceIdList audienceMembers 方法 在 Data Manager API 中，使用 audienceMembers 的 ingest、remove 和 removeAll 方法新增及移除成員。

資源名稱

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}

使用者 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
上一頁
升級步驟