از نگاشتهای موجود در جدولها برای نگاشت روشها و فیلدهای مدیریت مخاطبان «مطابقت مشتری» در 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) |
یادداشتها |
|---|---|---|
|
name |
نام UserList هم حاوی شناسه تبلیغکننده یا شریک اصلی است و هم شناسه مخاطب. برای جزئیات، نام منابع را ببینید. |
userLists.list
firstPartyAndPartnerAudiences.list (Display & Video 360 API) |
userLists.list (Data Manager API) |
یادداشتها |
|---|---|---|
|
parent |
parent حاوی شناسه آگهیدهنده یا شریک اصلی است. |
pageSize |
pageSize |
حداکثر اندازه صفحه در Data Manager API 1000 است. |
pageToken |
pageToken |
|
filter |
filter |
|
orderBy |
بدون معادل |
userLists.create
firstPartyAndPartnerAudiences.create (Display & Video 360 API) |
userLists.create (Data Manager API) |
یادداشتها |
|---|---|---|
|
parent |
parent حاوی شناسه تبلیغکننده یا شریک اصلی مخاطب جدید است. |
| بدون معادل | validateOnly |
|
متن درخواست FirstPartyAndPartnerAudience |
متن درخواست UserList |
برای نگاشت بدنه درخواست، UserList را ببینید. |
userLists.update
firstPartyAndPartnerAudiences.patch (Display & Video 360 API) |
userLists.patch (Data Manager API) |
یادداشتها |
|---|---|---|
|
پارامتر 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) |
یادداشتها |
|---|---|---|
|
destinations |
برای جزئیات، پیکربندی مقصدها را بررسی کنید. |
addedContactInfoList.contactInfos |
audienceMembers |
شناسههای کاربر فردی را میتوان در فیلد compositeData.userData در اشیای AudienceMember تنظیم کرد. برای جزئیات، شناسههای کاربر را ببینید. |
addedContactInfoList.consent |
consent |
رضایت را میتوان در اشیای AudienceMember جداگانه نیز تنظیم کرد. |
addedMobileDeviceIdList.mobileDeviceIds |
audienceMembers |
شناسههای دستگاه همراه فردی در فیلد mobileData در اشیای AudienceMember تنظیم میشوند. |
addedMobileDeviceIdList.consent |
consent |
رضایت را میتوان در اشیای AudienceMember جداگانه نیز تنظیم کرد. |
| بدون معادل | validateOnly |
|
| بدون معادل | encoding |
الزامی. روی Encoding استفادهشده برای مقادیر UserIdentifier تنظیم کنید. |
| بدون معادل | encryptionInfo |
اگر درخواست حاوی مقادیر رمزگذاریشده باشد، تنظیم میشود. برای جزئیات، رمزگذاری را ببینید. |
| بدون معادل | termsOfService |
الزامی. تنظیم کنید تا نشان دهد کاربر شرایط خدمات «مطابقت مشتری» را پذیرفته یا رد کرده است. |
audienceMembers.remove
firstPartyAndPartnerAudiences.editCustomerMatchMembers (Display & Video 360 API) |
audienceMembers.remove (Data Manager API) |
یادداشتها |
|---|---|---|
|
destinations |
|
removedContactInfoList.contactInfos |
audienceMembers |
شناسههای کاربر فردی را میتوان در فیلد compositeData.userData در اشیای AudienceMember تنظیم کرد. برای جزئیات، شناسههای کاربر را ببینید. |
removedMobileDeviceIdList.mobileDeviceIds |
audienceMembers |
شناسههای دستگاه همراه فردی در فیلد mobileData در اشیای AudienceMember تنظیم میشوند. |
| بدون معادل | validateOnly |
|
| بدون معادل | encoding |
الزامی. روی Encoding استفادهشده برای مقادیر UserIdentifier تنظیم کنید. |
| بدون معادل | 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، اعضا را بااستفاده از روشهای ingest و remove و removeAll مربوط به audienceMembers اضافه و حذف کنید.
|
mobileDeviceIdList |
audienceMembers روش |
در Data Manager API، اعضا را بااستفاده از روشهای ingest و remove و removeAll مربوط به audienceMembers اضافه و حذف کنید.
|
نام منابع
Data Manager API از قالب نام منبع متفاوتی نسبت به Display & Video 360 API استفاده میکند.
- Display & Video 360 API
در Display & Video 360 API، نام منبع
UserListاز قالبی استفاده میکند که فقط حاوی شناسه مخاطب است:firstAndThirdPartyAudiences/{first_and_third_party_audience_id}- میانای برنامهسازی کاربردی مدیر دادهها
در Data Manager API، نام منبع
UserListاز قالبی استفاده میکند که حاوی شناسه مخاطب و همچنینAccountTypeو شناسه حساب شریک یا تبلیغکنندهای است که مالک مخاطب است:accountTypes/{accountType}/accounts/{account}/userLists/{userList}
شناسههای کاربر
درحالیکه 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 دسترسی داده شده است. | loginAccount |
این فقط باید در سناریوی دسترسی شریک Display & Video 360 تنظیم شود، جایی که مخاطب تحت یک تبلیغکننده است اما به کاربر Display & Video 360 دسترسی به شریک اصلی تبلیغکننده اعطا شده است. درغیراینصورت، میتوان آن را تنظیمنشده باقی گذاشت. |
| شناسه آگهیدهنده یا شریک اصلی مخاطب. | operatingAccount |
|
firstPartyAndPartnerAudienceId |
productDestinationId |
|
| بدون معادل | reference |