ایجاد مخاطب «مطابقت مشتری»

با ارسال CreateUserListRequest، مخاطب «انطباق مشتری» ایجاد کنید.

ساختن متن درخواست

منبع UserList ایجاد کنید. فیلدهای رایج برای تنظیم در اینجا آمده است.

displayName
الزامی نام نمایشی فهرست. نام باید در میان همه فهرست‌های متعلق به حساب منحصربه‌فرد باشد.
description
شرح مختصری از فهرست.
integrationCode
شناسه‌ای از سیستم شما.
membershipDuration

مدت زمانی که عضو مخاطب پس‌از اضافه شدن در فهرست باقی می‌ماند. مقدار باید با روزهای کامل مطابقت داشته باشد. اگر تنظیم نشده باشد، به‌طور پیش‌فرض روی حداکثر تنظیم می‌شود.

اگر از JSON استفاده می‌کنید، تعداد ثانیه‌ها را با ضرب کردن روزهای مدت در 86400 (تعداد ثانیه‌ها در روز) محاسبه کنید. سپس مقدار را روی نتیجه ضرب تنظیم کنید، و بعداز آن s را اضافه کنید. برای مثال، اگر می‌خواهید مدت عضویت ۹۰ روز باشد، از مقدار 7776000s استفاده کنید چون 90 * 86400 = 7776000.

If using the protocol buffer format, use the convenience method for constructing a Duration object based on the number of days, if such a convenience method exists. برای مثال، کتابخانه protobuf-java-util برای Java دارای fromDays() روش راحتی است. درغیراین‌صورت، تعداد ثانیه‌ها را با ضرب کردن تعداد روزهای مدت در 86400 (تعداد ثانیه‌ها در روز) محاسبه کنید و از نتیجه برای تنظیم فیلد seconds شیء Duration استفاده کنید.

فیلدهای الزامی برای «مطابقت مشتری»

فیلد ingestedUserListInfo برای مخاطب «مطابقت مشتری» الزامی است.

در اینجا فیلدهایی برای تنظیم در IngestedUserListInfo براساس نوع داده‌ای که می‌خواهید برای افزودن اعضای مخاطب به فهرست استفاده کنید آورده شده است.

فهرست اطلاعات تماس

اگر می‌خواهید از اطلاعات تماس (نشانی‌های ایمیل، شماره تلفن، یا نشانی‌های درهم‌سازی‌شده) برای تعریف اعضای مخاطبانتان استفاده کنید، فیلدهای زیر را تنظیم کنید:

uploadKeyTypes

روی فهرستی تنظیم شده است که حاوی نوع کلید بارگذاری CONTACT_ID است.

فهرست uploadKeyTypes باید فقط حاوی یک ورودی باشد.

contactIdInfo

روی پیام ContactIdInfo تنظیم کنید و dataSourceType را روی مقدار مناسب از شمارش DataSourceType تنظیم کنید.

فهرست شناسه همراه

اگر می‌خواهید از شناسه‌های تلفن همراه برای تعریف اعضای مخاطبانتان استفاده کنید، فیلدهای زیر را تنظیم کنید:

uploadKeyTypes

روی فهرستی تنظیم شده است که حاوی نوع کلید بارگذاری MOBILE_ID است.

فهرست uploadKeyTypes باید فقط حاوی یک ورودی باشد.

mobileIdInfo

تنظیم روی پیام MobileIdInfo:

  • dataSourceType را روی مقدار مناسب از DataSourceType enum تنظیم کنید.

  • 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 تعداد ثانیه‌ها در ۳۰ روز است. برای امتحان کردن درخواست، روی دکمه باز کردن در 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"
}

شناسه‌های کاربر

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

ارسال درخواست

درخواست را ارسال کنید و درصورت نیاز، سرایندهای درخواست مانند login-account یا linked-account را اضافه کنید.

اگر درخواست موفقیت‌آمیز باشد، پاسخ حاوی UserList ایجادشده با فیلدهای id و name فقط خروجی پرشده است.

اگر درخواست ناموفق بود، خطاها را بررسی کنید تا علت ناموفق بودن را تعیین کنید، درخواست و سرصفحه‌ها را به‌روز کنید تا مشکلات برطرف شود، و سپس درخواست و سرصفحه‌های به‌روزشده را ارسال کنید.