استخدِم عمليات الربط في الجداول لربط طرق إدارة جمهور "مطابقة العملاء" والحقول في Display & Video 360 API بما يعادلها في Data Manager API.
المصادقة
تتطلّب واجهة Data Manager API بيانات اعتماد بنطاق مختلف عن واجهة Display & Video 360 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 |
ستعرض واجهة برمجة التطبيقات هذه شرائح جمهور "مطابقة العملاء" فقط. |
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
في 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) |
ملاحظات |
|---|---|---|
| رقم تعريف المعلِن أو الشريك الذي تم منح مستخدم "مساحة العرض والفيديو 360" إذن الوصول إليه. | loginAccount |
يجب ضبط هذا الإعداد فقط في سيناريو وصول الشريك إلى "مساحة العرض والفيديو 360"، حيث تكون شريحة الجمهور تابعة لأحد المعلِنين، ولكن تم منح مستخدم "مساحة العرض والفيديو 360" الذي يمكنه الوصول إلى الشريحة إذن الوصول إلى الشريك الرئيسي للمعلِن. وإلا، يمكن تركها بدون ضبط. |
| رقم تعريف المعلن الرئيسي أو الشريك الرئيسي لشريحة الجمهور | operatingAccount |
|
firstPartyAndPartnerAudienceId |
productDestinationId |
|
| بدون مكافئ | reference |