创建目标客户匹配受众群体

通过发送 CreateUserListRequest 创建目标客户匹配受众群体。

构建请求正文

创建 UserList 资源。以下是需要设置的常见字段。

displayName
必需。列表的显示名称。该名称在相应账号拥有的所有列表中必须是唯一的。
description
列表的简要说明。
integrationCode
您系统中的 ID。
membershipDuration

受众群体成员被添加到名单后,在名单中保留的时长。该值必须对应于整天数。如果未设置,则默认为最大值。

如果使用 JSON,请将天数乘以 86400(每天的秒数),计算出秒数。然后,将该值设置为乘法结果,后跟 s。例如,如果您希望会员时长为 90 天,请使用值 7776000s,因为 90 * 86400 = 7776000

如果使用协议缓冲区格式,请使用根据天数构建 Duration 对象的便捷方法(如果存在此类便捷方法)。例如,Java 的 protobuf-java-util 库具有 fromDays() 便捷方法。否则,将持续时间天数乘以 86400(每天的秒数)来计算秒数,并使用计算结果设置 Duration 对象的 seconds 字段。

目标客户匹配功能的必填字段

对于目标客户匹配受众群体,ingestedUserListInfo 字段是必填字段。

以下是根据您要用于向名单添加受众群体成员的数据类型,需要在 IngestedUserListInfo 上设置的字段。

联系信息列表

如果您想使用联系信息(经过哈希处理的电子邮件地址、电话号码或地址)来定义受众群体成员,请设置以下字段:

uploadKeyTypes

设置为包含 CONTACT_ID 上传密钥类型的列表。

uploadKeyTypes 列表只能包含一个条目。

contactIdInfo

设置为 ContactIdInfo 消息,并将 dataSourceType 设置为 DataSourceType 枚举中的相应值。

移动 ID 列表

如果您想使用移动 ID 来定义受众群体成员,请设置以下字段:

uploadKeyTypes

设置为包含 MOBILE_ID 上传密钥类型的列表。

uploadKeyTypes 列表只能包含一个条目。

mobileIdInfo

设置为 MobileIdInfo 消息:

构建请求

如需创建目标客户匹配受众群体,请为 UserList 资源构建 create 请求

  1. parent 字段设置为相应账号的资源名称。资源名称必须采用 accountTypes/{accountType}/accounts/{account_id} 格式。

  2. 使用您为请求正文构建的 UserList

  3. 如果您的凭据不适用于 parent 上的用户所对应的 Google 账号,请按照配置目的地和标头中的说明设置标头。

以下是不同类型的用户信息的 JSON 请求示例。 每个请求都将 membershipDuration 设置为 2592000s,其中 2592000 是 30 天内的秒数。点击在 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"
}

移动 ID

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

发送请求

发送请求,并根据需要添加请求标头

如果请求成功,响应将包含已创建的 UserList,其中填充了 idname。请记下这些字段中的值,因为您需要在向受众群体添加受众群体成员的请求中使用这些值。

如果请求失败,请检查错误以确定失败原因,更新请求和标头以解决任何问题,然后发送更新后的请求和标头。