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

כדי ליצור קהל מסוג "התאמה ללקוחות", שולחים 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 בהודעה לערך המתאים מתוך ה-enum‏ DataSourceType.dataSourceType

רשימת מזהי מכשירים ניידים

אם רוצים להשתמש במזהי מכשירים ניידים כדי להגדיר את חברי הקהל, צריך להגדיר את השדות הבאים:

uploadKeyTypes

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

הרשימה uploadKeyTypes חייבת להכיל רק ערך אחד.

mobileIdInfo

ההגדרה היא הודעה MobileIdInfo:

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

• מגדירים את 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.

רשימה של מזהי משתמשים

אם רוצים להשתמש במזהי משתמשים כדי להגדיר את חברי הקהל, צריך להגדיר את השדות הבאים:

uploadKeyTypes

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

הרשימה uploadKeyTypes חייבת להכיל רק ערך אחד.

הרכבת הבקשה

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

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

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

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

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

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

פתיחה ב-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"
}

מזהי מכשירים ניידים

פתיחה ב-API Explorer

{
    "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"
}

מזהי משתמשים

פתיחה ב-API Explorer

{
    "description": "Customer Match for user IDs",
    "displayName": "User ID audience",
    "ingestedUserListInfo": {
        "userIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY"
        },
        "uploadKeyTypes": [
            "USER_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

שליחת הבקשה

שולחים את הבקשה, ואם צריך, כוללים כותרות בקשה.

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

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