יצירת קהל מסוג 'התאמה ללקוחות'

כדי ליצור קהל מסוג "התאמה ללקוחות", שולחים בקשת CreateUserListRequest.

יצירת גוף הבקשה

יוצרים משאב UserList. אלה השדות הנפוצים שצריך להגדיר.

displayName

חובה השם המוצג של הרשימה. השם חייב להיות ייחודי מבין כל הרשימות שבבעלות החשבון.

description

תיאור קצר של הרשימה.

integrationCode

מזהה מהמערכת שלכם.

membershipDuration

משך הזמן שבו משתמש מקהל היעד נשאר ברשימה אחרי שהוא נוסף אליה. הערך חייב להיות בימים שלמים. אם לא מגדירים את הפרמטר, ברירת המחדל היא הערך המקסימלי.

אם משתמשים ב-JSON, מחשבים את מספר השניות על ידי הכפלת משך הזמן בימים ב-86400 (מספר השניות ביום). לאחר מכן מגדירים את הערך לתוצאת הכפל, ואחריה s. לדוגמה, אם רוצים להגדיר משך חברות של 90 יום, משתמשים בערך 7776000s כי 90 * 86400 = 7776000.

אם משתמשים בפורמט של מאגר אחסון לפרוטוקולים, צריך להשתמש בשיטה הנוחה ליצירת אובייקט Duration על סמך מספר הימים, אם קיימת שיטה נוחה כזו. לדוגמה, לספריית protobuf-java-util ל-Java יש שיטה נוחה בשם fromDays(). אחרת, מחשבים את מספר השניות על ידי הכפלת משך הזמן בימים ב-86400 (מספר השניות ביום), ומשתמשים בתוצאה כדי להגדיר את השדה seconds של האובייקט Duration.

שדות חובה להתאמה ללקוחות

השדה ingestedUserListInfo הוא שדה חובה בקהל מסוג "התאמה ללקוחות".

אלה השדות שצריך להגדיר ב-IngestedUserListInfo בהתאם לסוג הנתונים שבהם אתם רוצים להשתמש כדי להוסיף משתמשים מקהל היעד לרשימה.

רשימת פרטים ליצירת קשר

אם אתם רוצים להשתמש בפרטים ליצירת קשר (כתובות אימייל, מספרי טלפון או כתובות מגובבים) כדי להגדיר את המשתמשים מקהל היעד, אתם צריכים להגדיר את השדות הבאים:

uploadKeyTypes

צריך להגדיר רשימה שמכילה את סוג מפתח ההעלאה CONTACT_ID.

הרשימה uploadKeyTypes חייבת להכיל רק רשומה אחת.

contactIdInfo

מגדירים הודעת ContactIdInfo עם dataSourceType שמוגדר לערך המתאים מהמאפיין enum של DataSourceType.

רשימת Mobile ID (mID)

אם אתם רוצים להשתמש ב-Mobile ID (mID) כדי להגדיר את המשתמשים מקהל היעד, אתם צריכים להגדיר את השדות הבאים:

uploadKeyTypes

צריך להגדיר רשימה שמכילה את סוג מפתח ההעלאה MOBILE_ID.

הרשימה uploadKeyTypes חייבת להכיל רק רשומה אחת.

mobileIdInfo

מגדירים הודעת MobileIdInfo:

• מגדירים את dataSourceType לערך המתאים מה-enum של DataSourceType.

• מגדירים את keySpace לערך IOS או ANDROID.

• מגדירים את appId למחרוזת שמזהה באופן ייחודי את האפליקציה לנייד שממנה נאספו הנתונים.

  • ב-iOS, מחרוזת המזהה היא מחרוזת בת 9 ספרות שמופיעה בסוף כתובת ה-URL של App Store. לדוגמה, 476943146 לאפליקציה Flood-It!‎ עם הקישור ל-App Store‏ https://apps.apple.com/us/app/flood-it/id476943146.

  • ב-Android, מחרוזת המזהה היא שם החבילה של האפליקציה. לדוגמה, com.labpixies.flood לאפליקציה Flood-It!‎ עם הקישור ל-Google Play‏ https://play.google.com/store/apps/details?id=com.labpixies.flood.

יצירת הבקשה

כדי ליצור קהל מסוג "התאמה ללקוחות", צריך ליצור בקשת create למשאב UserList.

1. מגדירים את השדה parent לשם המשאב של החשבון. שם המשאב חייב להיות בפורמט accountTypes/{accountType}/accounts/{account}.

2. משתמשים ב-UserList שיצרתם לגוף הבקשה.

3. אם פרטי הכניסה שלכם הם לא לחשבון Google שמוגדר כמשתמש ב-parent, צריך להגדיר כותרות כמו שמתואר בקטע הגדרת יעדים וכותרות.

בהמשך מופיעות בקשות לדוגמה ב-JSON לסוגים השונים של פרטי המשתמשים. כל בקשה מגדירה את membershipDuration ל-2592000s, כאשר 2592000 הוא מספר השניות ב-30 ימים. כדי לנסות בקשה, לוחצים על הלחצן Open in API Explorer.

{
    "description": "Customer Match for contact info",
    "displayName": "Contact info audience",
    "ingestedUserListInfo": {
        "contactIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY"
        },
        "uploadKeyTypes": [
            "CONTACT_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

{
    "description": "Customer Match for mobile IDs",
    "displayName": "Mobile ID audience",
    "ingestedUserListInfo": {
        "mobileIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY",
            "keySpace": "ANDROID",
            "appId": "com.labpixies.flood"
        },
        "uploadKeyTypes": [
            "MOBILE_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

שליחת הבקשה

שולחים את הבקשה, ואם צריך, כוללים כותרות של בקשות כמו login-account או linked-account.

אם הבקשה מצליחה, התשובה מכילה את ה-UserList שנוצר, כשהשדות id ו-name לפלט בלבד מאוכלסים.

אם הבקשה נכשלת, בודקים את השגיאות כדי לזהות את הסיבה לכישלון, מעדכנים את הבקשה ואת הכותרות כדי לפתור את הבעיות, ואז שולחים את הבקשה והכותרות המעודכנות.