استخدِم عمليات الربط في الجداول لربط طرق إدارة شرائح جمهور "مطابقة العملاء" والحقول في واجهة برمجة التطبيقات "مساحة العرض والفيديو 360" بمثيلاتها في 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 |
لن تعرض Data Manager API سوى شرائح جمهور "مطابقة العملاء". |
firstPartyAndPartnerAudiences.create |
userLists.create |
يجب تحميل بيانات المستخدمين في طلب لاحق في Data Manager API. |
| بدون مكافئ | userLists.delete |
غير متوفّرة في واجهة برمجة التطبيقات الخاصة بـ "مساحة العرض والفيديو 360". |
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 (واجهة برمجة التطبيقات في "مساحة العرض والفيديو 360") |
userLists.get (Data Manager API) |
ملاحظات |
|---|---|---|
|
name |
يحتوي الاسم UserList على رقم تعريف المعلِن أو الشريك الرئيسي بالإضافة إلى رقم تعريف الجمهور. لمزيد من التفاصيل، يمكنك الاطّلاع على أسماء الموارد. |
userLists.list
firstPartyAndPartnerAudiences.list (واجهة برمجة التطبيقات في "مساحة العرض والفيديو 360") |
userLists.list (Data Manager API) |
ملاحظات |
|---|---|---|
|
parent |
يحتوي parent على رقم تعريف المعلِن أو الشريك الرئيسي. |
pageSize |
pageSize |
الحد الأقصى لحجم الصفحة في Data Manager API هو 1000. |
pageToken |
pageToken |
|
filter |
filter |
|
orderBy |
بدون مكافئ |
userLists.create
firstPartyAndPartnerAudiences.create (واجهة برمجة التطبيقات في "مساحة العرض والفيديو 360") |
userLists.create (Data Manager API) |
ملاحظات |
|---|---|---|
|
parent |
يحتوي الحقل parent على رقم تعريف المعلِن أو الشريك الرئيسي لشريحة الجمهور الجديدة. |
| بدون مكافئ | validateOnly |
|
نص طلب FirstPartyAndPartnerAudience |
نص طلب UserList |
راجِع UserList لمعرفة عملية ربط نص الطلب. |
userLists.update
firstPartyAndPartnerAudiences.patch (واجهة برمجة التطبيقات في "مساحة العرض والفيديو 360") |
userLists.patch (Data Manager API) |
ملاحظات |
|---|---|---|
|
المَعلمة userList.name |
اسم المورد الخاص بـ UserList المطلوب تعديله. |
updateMask |
updateMask |
يُنصح باستخدام هذا الحقل ولكنّه ليس مطلوبًا في Data Manager API، وسيؤدي إلى استبدال جميع الحقول المضمّنة بالكامل إذا تم تركه فارغًا. |
| بدون مكافئ | validateOnly |
|
نص طلب FirstPartyAndPartnerAudience |
نص طلب UserList |
راجِع UserList لمعرفة عملية ربط نص الطلب. |
audienceMembers.ingest
firstPartyAndPartnerAudiences.editCustomerMatchMembers (واجهة برمجة التطبيقات في "مساحة العرض والفيديو 360") |
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 (واجهة برمجة التطبيقات في "مساحة العرض والفيديو 360") |
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 (واجهة برمجة التطبيقات في "مساحة العرض والفيديو 360") |
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.
- واجهة برمجة التطبيقات في "مساحة العرض والفيديو 360"
في واجهة برمجة التطبيقات 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 (واجهة برمجة التطبيقات في "مساحة العرض والفيديو 360") |
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 متعددة. |
الوجهة
| واجهة برمجة التطبيقات في "مساحة العرض والفيديو 360" | Destination (Data Manager API) |
ملاحظات |
|---|---|---|
| رقم تعريف المعلِن أو الشريك الذي تم منح مستخدم "مساحة العرض والفيديو 360" إذن الوصول إليه. | loginAccount |
يجب ضبط هذا الإعداد فقط في سيناريو وصول الشريك إلى "مساحة العرض والفيديو 360"، حيث تكون شريحة الجمهور ضمن حساب معلِن ولكن تم منح المستخدم الذي يمكنه الوصول إلى "مساحة العرض والفيديو 360" إذن الوصول إلى الشريك الرئيسي للمعلِن. وفي حال عدم توفّرها، يمكن تركها بدون تحديد. |
| رقم تعريف المعلِن أو الشريك الرئيسي لشريحة الجمهور | operatingAccount |
|
firstPartyAndPartnerAudienceId |
productDestinationId |
|
| بدون مكافئ | reference |