UserList

用户列表。这是客户可定位的用户列表。

JSON 表示法 
{
  "resourceName": string,
  "membershipStatus": enum (UserListMembershipStatus),
  "sizeRangeForDisplay": enum (UserListSizeRange),
  "sizeRangeForSearch": enum (UserListSizeRange),
  "type": enum (UserListType),
  "closingReason": enum (UserListClosingReason),
  "accessReason": enum (AccessReason),
  "accountUserListStatus": enum (UserListAccessStatus),
  "id": string,
  "readOnly": boolean,
  "name": string,
  "description": string,
  "integrationCode": string,
  "membershipLifeSpan": string,
  "sizeForDisplay": string,
  "sizeForSearch": string,
  "eligibleForSearch": boolean,
  "eligibleForDisplay": boolean,
  "matchRatePercentage": integer,

  // Union field user_list can be only one of the following:
  "crmBasedUserList": {
    object (CrmBasedUserListInfo)
  },
  "similarUserList": {
    object (SimilarUserListInfo)
  },
  "ruleBasedUserList": {
    object (RuleBasedUserListInfo)
  },
  "logicalUserList": {
    object (LogicalUserListInfo)
  },
  "basicUserList": {
    object (BasicUserListInfo)
  },
  "lookalikeUserList": {
    object (LookalikeUserListInfo)
  }
  // End of list of possible types for union field user_list.
}
字段
resourceName

string

不可变。用户列表的资源名称。用户列表资源名称采用以下格式：

customers/{customerId}/userLists/{userListId}
membershipStatus

enum (UserListMembershipStatus)

此用户列表的成员资格状态。指明用户列表是处于开放状态还是有效状态。只有开放的用户列表可以积累更多的用户，并且只能定位到开放的用户列表。
sizeRangeForDisplay

enum (UserListSizeRange)

仅限输出。Google 展示广告网络中的 UserList 用户数量的大小范围。

此字段为只读字段。
type

enum (UserListType)

仅限输出。此列表的类型。

此字段为只读字段。
closingReason

enum (UserListClosingReason)

指明此用户列表成员资格关闭的原因。它仅会填充因处于非活动状态而自动关闭的列表，并且会在列表成员资格变为开放状态时被清除。
accessReason

enum (AccessReason)

仅限输出。指明向此账号授予列表访问权限的原因。原因可以是“SHARED”、“OWNED”、“LICENSED”或“较大”。

此字段为只读字段。
accountUserListStatus

enum (UserListAccessStatus)

指明此共享是否仍处于启用状态。当用户与此用户共享 UserList 时，此字段会设置为 ENABLED。之后，userList 的所有者可以决定撤消该共享，并将其设为 DISABLED。此字段的默认值设为“已启用”。
id

string (int64 format)

仅限输出。用户列表的 ID。
readOnly

boolean

仅限输出。指示用户是否可以修改列表的选项。取决于列表所有权和列表类型。例如，外部的再营销用户名单不可修改。

此字段为只读字段。
name

string

此用户名单的名称。根据其 accessReason 的不同，用户列表名称可能不是唯一的（例如，如果 accessReason=SHARED）
description

string

此用户列表的说明。
integrationCode

string

来自外部系统的 ID。用户列表卖家使用它来关联系统上的 ID。
membershipLifeSpan

string (int64 format)

自用户最近添加到列表以来，用户的 Cookie 在列表中保留的天数。此字段必须介于 0 到 540 之间（含 0 和 540）。不过，对于基于 CRM 的用户列表，此字段可设置为 10000，表示没有到期时间。

对于 logicalUserList 和 ruleBasedUserList 类型，此字段会被忽略。这些类型列表的成员资格取决于列表定义的规则。
sizeForDisplay

string (int64 format)

仅限输出。此用户名单中 Google 展示广告网络上的用户估算数量。如果用户数尚未确定，则此值为 null。

此字段为只读字段。
eligibleForDisplay

boolean

仅限输出。表明此用户列表符合在 Google 展示广告网络中展示的条件。

此字段为只读字段。
matchRatePercentage

integer

仅限输出。指明目标客户匹配名单的匹配率。此字段的范围为 [0-100]。对于其他列表类型，或者当无法计算匹配率时，此值将为 null。

此字段为只读字段。

联合字段 user_list。用户列表。

您只能设置一个。user_list 只能是下列其中一项：
crmBasedUserList

object (CrmBasedUserListInfo)

广告客户提供的 CRM 用户的用户名单。
similarUserList

object (SimilarUserListInfo)

仅限输出。与其他 UserList 中的用户类似的用户列表。这些列表都是只读的，由 Google 自动创建。
ruleBasedUserList

object (RuleBasedUserListInfo)

由规则生成的用户列表。
logicalUserList

object (LogicalUserListInfo)

用户名单，由用户名单和用户兴趣组合而成。
basicUserList

object (BasicUserListInfo)

以一系列转化或再营销操作的集合形式进行的用户名单定位。
lookalikeUserList

object (LookalikeUserListInfo)

不可变。相似用户名单。

UserListMembershipStatus

包含可能的用户名单成员资格状态的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
OPEN 开放状态 - 名单正在累积成员，可定位到名单。
CLOSED 封闭状态 - 无法再增加新成员。无法用于定位。

UserListSizeRange

包含可能的用户名单大小范围的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
LESS_THAN_FIVE_HUNDRED 用户名单中包含的用户数少于 500。
LESS_THAN_ONE_THOUSAND 用户名单中的用户数介于 500 到 1000 之间。
ONE_THOUSAND_TO_TEN_THOUSAND 用户名单中的用户数介于 1,000 到 10,000 之间。
TEN_THOUSAND_TO_FIFTY_THOUSAND 用户名单中的用户数介于 10,000 到 50,000 之间。
FIFTY_THOUSAND_TO_ONE_HUNDRED_THOUSAND 用户名单中的用户数介于 50,000 到 100,000 之间。
ONE_HUNDRED_THOUSAND_TO_THREE_HUNDRED_THOUSAND 用户名单中的用户数介于 100,000 到 300,000 之间。
THREE_HUNDRED_THOUSAND_TO_FIVE_HUNDRED_THOUSAND 用户名单中的用户数介于 300,000 到 500,000 之间。
FIVE_HUNDRED_THOUSAND_TO_ONE_MILLION 用户名单中的用户数介于 500,000 到 100 万之间。
ONE_MILLION_TO_TWO_MILLION 用户名单中的用户数量介于 100 万到 200 万之间。
TWO_MILLION_TO_THREE_MILLION 用户名单中的用户数量介于 200 万到 300 万之间。
THREE_MILLION_TO_FIVE_MILLION 用户名单中的用户数量介于 300 万到 500 万之间。
FIVE_MILLION_TO_TEN_MILLION 用户名单中的用户数量介于 500 万到 1000 万之间。
TEN_MILLION_TO_TWENTY_MILLION 用户名单中的用户数量介于 1000 万到 2000 万之间。
TWENTY_MILLION_TO_THIRTY_MILLION 用户列表中的用户数介于 2,000 万到 3,000 万之间。
THIRTY_MILLION_TO_FIFTY_MILLION 用户名单中的用户数量在 3000 万到 5000 万之间。
OVER_FIFTY_MILLION 用户名单拥有超过 5000 万用户。

UserListType

包含可能的用户名单类型的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
REMARKETING 表示为转化类型集合的 UserList。
LOGICAL 表示为其他用户列表/兴趣组合的 UserList。
EXTERNAL_REMARKETING 在 Google Ad Manager 平台中创建的用户列表。
RULE_BASED 与规则关联的 UserList。
SIMILAR 包含与其他 UserList 的用户类似的用户的 UserList。
CRM_BASED 广告客户以电子邮件或其他格式提供的第一方 CRM 数据的用户名单。
LOOKALIKE LookalikeUserlist，由与可配置种子（一组 UserList）的用户类似的用户组成

UserListClosingReason

描述可能的用户名单关闭原因的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
UNUSED 该用户列表已被关闭，因为闲置时间已超过 1 年。

AccessReason

描述可能的访问原因的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
OWNED 资源归用户所有。
SHARED 相应资源与用户共享。
LICENSED 向用户授予资源许可。
SUBSCRIBED 用户订阅了资源。
AFFILIATED 用户可以访问相应资源。

UserListAccessStatus

包含可能的用户名单访问权限状态的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
ENABLED 访问权限已启用。
DISABLED 访问权限已被停用。

CrmBasedUserListInfo

广告客户提供的 CRM 用户的用户名单。

JSON 表示法 
{
  "uploadKeyType": enum (CustomerMatchUploadKeyType),
  "dataSourceType": enum (UserListCrmDataSourceType),
  "appId": string
}
字段
uploadKeyType

enum (CustomerMatchUploadKeyType)

列表的匹配键类型。同一列表中不允许包含多种数据类型。对于 ADD 操作，必须填写此字段。
dataSourceType

enum (UserListCrmDataSourceType)

列表的数据源。默认值为 FIRST_PARTY。只有许可名单中的客户才能创建基于第三方的 CRM 列表。
appId

string

用于唯一标识从中收集数据的移动应用的字符串。对于 iOS，ID 字符串是显示在 App Store 网址末尾的 9 位数字符串（例如，“476943146”表示“Flood-It!2 英寸App Store 链接为 http://itunes.apple.com/us/app/flood-it!-2/id476943146)。对于 Android，ID 字符串是应用的软件包名称（例如，Google Play 链接 https://play.google.com/store/apps/details?id=com.labpixies.colordrips) 对应的“Color Drips”对应的 ID 字符串为“com.labpixies.colordrips”）。在创建用于上传移动广告 ID 的 CrmBasedUserList 时必填。

CustomerMatchUploadKeyType

描述可能的目标客户匹配上传密钥类型的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
CONTACT_INFO 系统会根据电子邮件地址、电话号码或实际地址等客户信息来匹配会员。
CRM_ID 成员将根据广告客户生成和分配的用户 ID 进行匹配。
MOBILE_ADVERTISING_ID 系统会从移动广告 ID 中匹配成员。

UserListCrmDataSourceType

描述可能的用户名单客户关系管理数据源类型的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
FIRST_PARTY 上传的数据是第一方数据。
THIRD_PARTY_CREDIT_BUREAU 上传的数据来自第三方征信机构。
THIRD_PARTY_VOTER_FILE 上传的数据来自第三方选民文件。

SimilarUserListInfo

SimilarUserList 是一个用户列表，这些用户列表与其他 UserList 中的用户类似。这些列表都是只读的，由 Google 自动创建。

JSON 表示法 
{
  "seedUserList": string
}
字段
seedUserList

string

派生此列表的种子 UserList。

RuleBasedUserListInfo

表示由规则生成的用户名单。

JSON 表示法 
{
  "prepopulationStatus": enum (UserListPrepopulationStatus),
  "flexibleRuleUserList": {
    object (FlexibleRuleUserListInfo)
  }
}
字段
prepopulationStatus

enum (UserListPrepopulationStatus)

预填充的状态。如果未设置，此字段将默认设为“无”，这意味着将不考虑之前的用户。如果设为 REQUESTED，符合列表定义的过往网站访问者或应用用户就会包含在列表中（仅适用于展示广告网络）。这样只会添加过去 30 天内的过往用户，具体时间取决于名单的成员资格有效期以及添加再营销代码的日期。请求处理完毕后，状态会更新为“FINISHED”；如果请求失败，状态会更新为“FAILED”。
flexibleRuleUserList

object (FlexibleRuleUserListInfo)

通过灵活规则表示具有一项或多项操作的访问者。灵活的用户列表由两个操作数列表定义 - 键入内容“包含数”和“独占操作数”；每个操作数都代表基于用户在给定时间范围内执行的操作的一组用户。这些运算数列表使用 AND_NOT 运算符合并，这样，由包含性运算数表示的用户包含在用户列表中，减去由独占运算数表示的用户。

UserListPrepopulationStatus

描述可能的用户名单预填充状态的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
REQUESTED 正在请求准备。
FINISHED 预填充已完成。
FAILED 预填充失败。

FlexibleRuleUserListInfo

通过灵活规则表示具有一项或多项操作的访问者。灵活的用户列表由两个操作数列表定义 - 键入内容“包含数”和“独占操作数”；每个操作数都代表基于用户在给定时间范围内执行的操作的一组用户。这些运算数列表使用 AND_NOT 运算符合并，这样，由包含性运算数表示的用户包含在用户列表中，减去由独占运算数表示的用户。

JSON 表示法 
{
  "inclusiveRuleOperator": enum (UserListFlexibleRuleOperator),
  "inclusiveOperands": [
    {
      object (FlexibleRuleOperandInfo)
    }
  ],
  "exclusiveOperands": [
    {
      object (FlexibleRuleOperandInfo)
    }
  ]
}
字段
inclusiveRuleOperator

enum (UserListFlexibleRuleOperator)

用于定义包含性运算数的组合方式的运算符。
inclusiveOperands[]

object (FlexibleRuleOperandInfo)

用于表示应加入用户列表的用户的规则。这些运算符位于 AND_NOT 运算符的左侧，并通过 AND/OR（由 inclusiveRuleOperator 指定）连接在一起。
exclusiveOperands[]

object (FlexibleRuleOperandInfo)

用于表示应从用户名单中排除的用户的规则。这些运算符位于 AND_NOT 运算符的右侧，并通过 OR 连接在一起。

UserListFlexibleRuleOperator

描述可能的用户名单组合规则运算符的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
AND A 和 B。
OR A 或 B。

FlexibleRuleOperandInfo

封装通用规则和回溯期的灵活规则。

JSON 表示法 
{
  "rule": {
    object (UserListRuleInfo)
  },
  "lookbackWindowDays": string
}
字段
rule

object (UserListRuleInfo)

定义此规则的规则项组列表。规则项组会归为一组。
lookbackWindowDays

string (int64 format)

此规则的回溯期（以天为单位）。从现在到 X 天前。

UserListRuleInfo

客户端定义的规则，基于由网站发送或由广告客户上传的自定义参数。

JSON 表示法 
{
  "ruleType": enum (UserListRuleType),
  "ruleItemGroups": [
    {
      object (UserListRuleItemGroupInfo)
    }
  ]
}
字段
ruleType

enum (UserListRuleType)

规则类型用于确定如何对规则项进行分组。

默认为 AND 的 OR（析取范式）。也就是说，规则项目组内的规则项目将通过 AND 连接，而各组本身将通过 OR 连接在一起。

AND 或 AND 是 flexRuleUserList 唯一支持的类型。
ruleItemGroups[]

object (UserListRuleItemGroupInfo)

定义此规则的规则项组列表。规则项目组根据 ruleType 进行分组。

UserListRuleType

描述可能的用户名单规则类型的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
AND_OF_ORS 合取范式。
OR_OF_ANDS 析取范式。

UserListRuleItemGroupInfo

一组规则项。

JSON 表示法 
{
  "ruleItems": [
    {
      object (UserListRuleItemInfo)
    }
  ]
}
字段
ruleItems[]

object (UserListRuleItemInfo)

根据 rulesType 归为一组的规则项。

UserListRuleItemInfo

原子规则项。

JSON 表示法 
{
  "name": string,

  // Union field rule_item can be only one of the following:
  "numberRuleItem": {
    object (UserListNumberRuleItemInfo)
  },
  "stringRuleItem": {
    object (UserListStringRuleItemInfo)
  },
  "dateRuleItem": {
    object (UserListDateRuleItemInfo)
  }
  // End of list of possible types for union field rule_item.
}
字段
name

string

规则变量名称。它应与像素触发的相应键名称一致。名称必须以 US-ascii 字母或下划线或大于 127 的 UTF8 代码开头，并由 US-ascii 字母/数字、下划线或大于 127 的 UTF8 代码组成。对于网站，有两个内置变量网址（名称 = 'url__'）和引荐来源网址（名称 = 'ref_url__'）。创建新规则项时，必须填写此字段。
联合字段 rule_item。原子规则项。rule_item 只能是下列其中一项：
numberRuleItem

object (UserListNumberRuleItemInfo)

由数字操作组成的原子规则项。
stringRuleItem

object (UserListStringRuleItemInfo)

由字符串操作组成的原子规则项。
dateRuleItem

object (UserListDateRuleItemInfo)

由日期操作组成的原子规则项。

UserListNumberRuleItemInfo

由数字运算组成的规则项。

JSON 表示法 
{
  "operator": enum (UserListNumberRuleItemOperator),
  "value": number
}
字段
operator

enum (UserListNumberRuleItemOperator)

数字比较运算符。此字段是必填字段，在创建新的数字规则项时必须填写。
value

number

要与变量进行比较的数值。此字段是必填字段，在创建新的数字规则项时必须填写。

UserListNumberRuleItemOperator

描述可能的用户名单编号规则项运算符的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
GREATER_THAN 大于。
GREATER_THAN_OR_EQUAL 大于或等于。
EQUALS 等于。
NOT_EQUALS 不等于。
LESS_THAN 小于。
LESS_THAN_OR_EQUAL 小于或等于。

UserListStringRuleItemInfo

由字符串操作组成的规则项。

JSON 表示法 
{
  "operator": enum (UserListStringRuleItemOperator),
  "value": string
}
字段
operator

enum (UserListStringRuleItemOperator)

字符串比较运算符。此字段是必填字段，在创建新的字符串规则项时必须填写。
value

string

字符串规则项的右侧。对于网址或引荐来源网址，该值不能包含非法的网址字符，如换行符、引号、制表符或括号。此字段是必填字段，在创建新的字符串规则项时必须填写。

UserListStringRuleItemOperator

描述可能的用户名单字符串规则项运算符的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
CONTAINS 包含。
EQUALS 等于。
STARTS_WITH 开头为。
ENDS_WITH 结尾为。
NOT_EQUALS 不等于。
NOT_CONTAINS 不包含。
NOT_STARTS_WITH 开头不是。
NOT_ENDS_WITH 结尾不是。

UserListDateRuleItemInfo

由日期操作组成的规则项。

JSON 表示法 
{
  "operator": enum (UserListDateRuleItemOperator),
  "value": string,
  "offsetInDays": string
}
字段
operator

enum (UserListDateRuleItemOperator)

日期比较运算符。此字段是必填字段，在创建新的日期规则项时必须填写。
value

string

字符串，表示要与规则变量进行比较的日期值。支持的日期格式为 YYYY-MM-DD。报告时间采用客户所在的时区。
offsetInDays

string (int64 format)

右侧的相对日期值，通过从现在起偏移的天数表示。当二者都存在时，值字段会覆盖此字段。

UserListDateRuleItemOperator

描述可能的用户名单日期规则项运算符的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
EQUALS 等于。
NOT_EQUALS 不等于。
BEFORE 之前。
AFTER 之后。

LogicalUserListInfo

表示用户名单，它是自定义的用户名单组合。

JSON 表示法 
{
  "rules": [
    {
      object (UserListLogicalRuleInfo)
    }
  ]
}
字段
rules[]

object (UserListLogicalRuleInfo)

用于定义此用户列表的逻辑列表规则。这些规则以逻辑运算符（ALL/ANY/NONE）和用户列表的形式定义。所有规则在求值时均为 AND 关系。

创建逻辑用户列表时必填。

UserListLogicalRuleInfo

用户列表逻辑规则。规则包含一个逻辑运算符（和/或/非）和一个作为操作数的用户名单列表。

JSON 表示法 
{
  "operator": enum (UserListLogicalRuleOperator),
  "ruleOperands": [
    {
      object (LogicalUserListOperandInfo)
    }
  ]
}
字段
operator

enum (UserListLogicalRuleOperator)

规则的逻辑运算符。
ruleOperands[]

object (LogicalUserListOperandInfo)

规则的操作数列表。

UserListLogicalRuleOperator

描述可能的用户列表逻辑规则运算符的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 仅用于返回值。表示此版本中未知的值。
ALL And - 所有操作数。
ANY Or - 至少一个操作数。
NONE Not - 无操作数。

LogicalUserListOperandInfo

包含用户列表的逻辑用户列表的操作数。

JSON 表示法 
{
  "userList": string
}
字段
userList

string

作为操作数的用户名单的资源名称。

BasicUserListInfo

以一系列转化或再营销操作的集合形式进行的用户名单定位。

JSON 表示法 
{
  "actions": [
    {
      object (UserListActionInfo)
    }
  ]
}
字段
actions[]

object (UserListActionInfo)

与此用户列表相关联的操作。

UserListActionInfo

表示用于构建再营销用户列表的操作类型。

JSON 表示法 
{

  // Union field user_list_action can be only one of the following:
  "conversionAction": string,
  "remarketingAction": string
  // End of list of possible types for union field user_list_action.
}
字段
联合字段 user_list_action。用户列表操作的子类型。user_list_action 只能是下列其中一项：
conversionAction

string

不是通过再营销生成的转化操作。
remarketingAction

string

再营销操作。

LookalikeUserListInfo

LookalikeUserlist，由与可配置种子（一组 UserList）的用户类似的用户组成

JSON 表示法 
{
  "seedUserListIds": [
    string
  ],
  "expansionLevel": enum (LookalikeExpansionLevel),
  "countryCodes": [
    string
  ]
}
字段
seedUserListIds[]

string (int64 format)

派生此列表的种子 UserList ID，由用户提供。
expansionLevel

enum (LookalikeExpansionLevel)

扩展级别，反映相似受众群体的规模
countryCodes[]

string

相似细分受众群定位到的国家/地区。由 ISO-3166 定义的双字母国家/地区代码

LookalikeExpansionLevel

扩展级别，反映相似受众群体的规模

枚举
UNSPECIFIED 未指定。
UNKNOWN 展开级别无效。
NARROW 扩展到与种子名单类似的一小部分用户
BALANCED 扩展到与种子名单类似的中等用户群。包含“EXPANSION_LEVEL_NARROW”等的所有用户。
BROAD 扩展到与种子名单类似的大量用户。包含“EXPANSION_LEVEL_BALANCED”的所有用户以及更多用户。