מיפוי שדות

אתם יכולים להשתמש במיפויים שבטבלאות כדי למפות את השיטות והשדות לניהול קהלים מסוג "התאמה ללקוחות" ב-Display & Video 360 API למקבילים שלהם ב-Data Manager API.

אימות

‫Data Manager API דורש פרטי כניסה עם היקף שונה מזה של Display & Video 360 API. כדי ליצור פרטי כניסה חדשים שכוללים את ההיקף של Data Manager API, פועלים לפי השלבים שמפורטים בקטע הגדרת גישה ל-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 מכיל גם את המזהה של המפרסם או השותף הראשי וגם את מזהה הקהל. פרטים נוספים זמינים בקטע שמות של משאבים.

userLists.list

firstPartyAndPartnerAudiences.list (Display & Video 360 API) userLists.list (Data Manager API) הערות
  • advertiserId
  • partnerId
 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) הערות
  • advertiserId
  • partnerId
 parent השדה parent מכיל את המזהה של המפרסם או השותף הראשי של הקהל החדש.
אין דוח מקביל 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 אפשר להגדיר מזהי משתמשים ספציפיים בשדה 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) הערות
  • advertiserId
  • firstPartyAndPartnerAudienceId
 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 מגדירים את כתובת האימייל בפורמט הנכון ועם גיבוב (hash). אפשר גם להצפין את כתובת האימייל המגובבת. כדי להתאים כמה כתובות אימייל למשתמש אחד, אפשר להשתמש בכמה אובייקטים מסוג 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
הקודם
שלבים לשדרוג