استخدِم عمليات الربط في الجداول لربط طرق إدارة شرائح جمهور "مطابقة العملاء" والحقول في 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 |
لن تعرض 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 لإضافة أعضاء إلى شرائح جمهور "مطابقة العملاء" وإزالتهم منها. |
ربط الطلبات
تربط الجداول التالية حقول الطلبات الخاصة بطُرق 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 |
تحديد ما إذا كان الطلب يحتوي على قيم مشفّرة لمزيد من التفاصيل، يُرجى الاطّلاع على التشفير. |
عمليات ربط حقول العناصر
في ما يلي عمليات الربط من عناصر واجهة برمجة التطبيقات في "مساحة العرض والفيديو 360" إلى العناصر المكافئة في واجهة برمجة التطبيقات 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 في audienceMembers.
|
mobileDeviceIdList |
طُرق audienceMembers |
في Data Manager API، أضِف الأعضاء وأزِلهم باستخدام الطريقتَين ingest وremove في 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 |