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

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

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

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

displayName
חובה השם המוצג של הרשימה. השם חייב להיות ייחודי מבין כל הרשימות שבבעלות החשבון.
description
תיאור קצר של הרשימה.
integrationCode
מזהה מהמערכת שלכם.
membershipDuration

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

אם משתמשים ב-JSON, מחשבים את מספר השניות על ידי הכפלת הערך של duration_days ב-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)

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

uploadKeyTypes

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

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

mobileIdInfo

הגדרת הודעה MobileIdInfo:

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

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

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

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

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

uploadKeyTypes

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

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

יצירת הבקשה

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

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

  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. חשוב לשים לב לערכים בשדות האלה כי תצטרכו אותם בבקשות להוספת חברים לקהל.

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

הקודם
סקירה כללית
הבא
העלאת חברים לקהל