REST Resource: accountTypes.accounts.userLists

资源：UserList

用户列表资源。

JSON 表示法 
{
  "name": string,
  "id": string,
  "readOnly": boolean,
  "membershipDuration": string,
  "accessReason": enum (AccessReason),
  "sizeInfo": {
    object (SizeInfo)
  },
  "targetNetworkInfo": {
    object (TargetNetworkInfo)
  },
  "displayName": string,
  "description": string,
  "membershipStatus": enum (MembershipStatus),
  "integrationCode": string,
  "closingReason": enum (ClosingReason),
  "accountAccessStatus": enum (AccessStatus),

  // Union field user_list_info can be only one of the following:
  "ingestedUserListInfo": {
    object (IngestedUserListInfo)
  }
  // End of list of possible types for union field user_list_info.
}
字段
name

string

标识符。用户列表的资源名称。格式：accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

仅限输出。用户名单的唯一 ID。
readOnly

boolean

仅限输出。用于指示用户是否可以修改列表的选项。
membershipDuration

string (Duration format)

可选。用户在用户列表中的保留时长。有效时长必须是 24 小时（86400 秒）的整数倍。如果提供的值不是 24 小时的精确倍数，则会导致 INVALID_ARGUMENT 错误。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
accessReason

enum (AccessReason)

仅限输出。相应账号被授予名单访问权限的原因。
sizeInfo

object (SizeInfo)

仅限输出。相应用户名单在不同目标广告网络中的估计成员数量。
targetNetworkInfo

object (TargetNetworkInfo)

可选。不同目标广告网络的资格要求信息。
displayName

string

必需。用户列表的显示名称。
description

string

可选。用户名单的说明。
membershipStatus

enum (MembershipStatus)

可选。相应用户名单的成员资格状态。
integrationCode

string

可选。外部系统中的 ID。用户列表卖家使用此参数来关联其系统中的 ID。
closingReason

enum (ClosingReason)

仅限输出。相应用户名单成员资格状态处于关闭状态的原因。
accountAccessStatus

enum (AccessStatus)

可选。指示相应分享是否仍处于启用状态。当用户列表与账号共享时，此字段会设置为 ENABLED。之后，用户名单所有者可以决定撤消共享，并将其设为DISABLED。
联合字段 user_list_info。有关用户列表的其他信息。user_list_info 只能是下列其中一项：
ingestedUserListInfo

object (IngestedUserListInfo)

可选。表示由用户提取的数据填充的用户列表。

MembershipStatus

用户名单的状态。

枚举
MEMBERSHIP_STATUS_UNSPECIFIED 未指定。
OPEN 开放状态 - 用户名单正在累积成员，可用于定位。
CLOSED “已关闭”状态 - 不再添加新成员。

ClosingReason

表示用户列表关闭的原因。此枚举仅在列表由系统自动关闭时使用。

枚举
CLOSING_REASON_UNSPECIFIED 未指定。
UNUSED 该用户名单因近期未用于定位而被关闭。如需了解详情，请访问 https://support.google.com/google-ads/answer/2472738。

AccessReason

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

枚举
ACCESS_REASON_UNSPECIFIED 未指定。
OWNED 资源归用户所有。
SHARED 相应资源已与用户共享。
LICENSED 已向用户授予资源许可。
SUBSCRIBED 用户订阅了相应资源。
AFFILIATED 用户可以访问相应资源。

AccessStatus

指明相应客户是否仍有权访问相应列表。

枚举
ACCESS_STATUS_UNSPECIFIED 未指定。
ENABLED 相应访问权限已启用。
DISABLED 访问权限已被停用。

SizeInfo

相应用户名单在不同目标广告网络中的估计成员数量。

JSON 表示法 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string
}
字段
displayNetworkMembersCount

string (int64 format)

仅限输出。Google 展示广告网络上相应用户名单中的估算成员数量。
searchNetworkMembersCount

string (int64 format)

仅限输出。google.com 网域中相应用户名单的估计成员数量。这些是可在搜索广告系列中定位的会员。

TargetNetworkInfo

不同目标广告网络的资格要求信息。

JSON 表示法 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
字段
eligibleForDisplay

boolean

仅限输出。表示相应用户名单符合 Google 展示广告网络的要求。

IngestedUserListInfo

表示由用户提供的数据填充的用户列表。

JSON 表示法 
{
  "uploadKeyTypes": [
    enum (UploadKeyType)
  ],
  "contactIdInfo": {
    object (ContactIdInfo)
  },
  "mobileIdInfo": {
    object (MobileIdInfo)
  },
  "userIdInfo": {
    object (UserIdInfo)
  },
  "pairIdInfo": {
    object (PairIdInfo)
  },
  "pseudonymousIdInfo": {
    object (PseudonymousIdInfo)
  },
  "partnerAudienceInfo": {
    object (PartnerAudienceInfo)
  }
}
字段
uploadKeyTypes[]

enum (UploadKeyType)

必需。不可变。相应用户名单的上传密钥类型。
contactIdInfo

object (ContactIdInfo)

可选。当 CONTACT_ID 是 uploadKeyTypes 之一时的其他信息。
mobileIdInfo

object (MobileIdInfo)

可选。当 MOBILE_ID 是 uploadKeyTypes 之一时的其他信息。
userIdInfo

object (UserIdInfo)

可选。当 USER_ID 是 uploadKeyTypes 之一时的其他信息。
pairIdInfo

object (PairIdInfo)

可选。当 PAIR_ID 是 uploadKeyTypes 之一时的其他信息。

此功能仅适用于数据合作伙伴。
pseudonymousIdInfo

object (PseudonymousIdInfo)

可选。PSEUDONYMOUS_ID 的其他信息是 uploadKeyTypes 之一。
partnerAudienceInfo

object (PartnerAudienceInfo)

可选。面向合作伙伴受众群体的其他信息。

此功能仅适用于数据合作伙伴。

UploadKeyType

包含用户名单的可能上传密钥类型的枚举。

枚举
UPLOAD_KEY_TYPE_UNSPECIFIED 未指定。
CONTACT_ID 客户信息，例如电子邮件地址、电话号码或实际地址。
MOBILE_ID 移动广告 ID。
USER_ID 第三方提供的用户 ID。
PAIR_ID 发布商与广告客户间用户身份匹配 ID。
PSEUDONYMOUS_ID 数据管理平台 ID：- Google 用户 ID - 合作伙伴提供的 ID - 发布商提供的 ID - iOS IDFA - Android 广告 ID - Roku ID - Amazon Fire TV ID - Xbox 或 Microsoft ID

ContactIdInfo

当 CONTACT_ID 是 uploadKeyTypes 之一时的其他信息。

JSON 表示法 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
字段
matchRatePercentage

integer

仅限输出。目标客户匹配用户名单的匹配率。
dataSourceType

enum (DataSourceType)

可选。不可变。上传数据的来源

DataSourceType

表示上传数据的来源。

枚举
DATA_SOURCE_TYPE_UNSPECIFIED 未指定。
DATA_SOURCE_TYPE_FIRST_PARTY 上传的数据是第一方数据。
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU 上传的数据来自第三方征信机构。
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE 上传的数据来自第三方选民文件。
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA 上传的数据是第三方合作伙伴数据。

MobileIdInfo

当 MOBILE_ID 是 uploadKeyTypes 之一时的其他信息。

JSON 表示法 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
字段
dataSourceType

enum (DataSourceType)

可选。不可变。上传数据的来源。
keySpace

enum (KeySpace)

必需。不可变。移动 ID 的键空间。
appId

string

必需。不可变。一个字符串，用于唯一标识从中收集数据的移动应用。

KeySpace

移动 ID 的键空间。

枚举
KEY_SPACE_UNSPECIFIED 未指定。
IOS iOS 键空间。
ANDROID Android 键空间。

UserIdInfo

当 USER_ID 是 uploadKeyTypes 之一时的其他信息。

JSON 表示法 
{
  "dataSourceType": enum (DataSourceType)
}
字段
dataSourceType

enum (DataSourceType)

可选。不可变。上传数据的来源。

PairIdInfo

当 PAIR_ID 是 uploadKeyTypes 之一时的其他信息。

此功能仅适用于数据合作伙伴。

JSON 表示法 
{
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "publisherId": string,
  "publisherName": string,
  "cleanRoomIdentifier": string
}
字段
matchRatePercentage

integer

仅限输出。此字段表示相应发布商的第一方数据与此用户名单的会员匹配百分比。必须介于 0 到 100 之间（含边界值）。
advertiserIdentifierCount

string (int64 format)

仅限输出。已上传到数据净室提供商的广告客户第一方数据记录的数量。这并不表示 PAIR 用户名单的规模。
publisherId

string (int64 format)

必需。不可变。标识与发布商广告客户身份匹配用户名单进行匹配的发布商。此字段由清理室提供商提供，仅在相应清理室范围内具有唯一性。不能用作多个数据净室的全局标识符。
publisherName

string

可选。发布商的描述性名称，将在界面中显示，以提供更出色的定位体验。
cleanRoomIdentifier

string

必需。不可变。用于标识与一个或多个净室提供商之间的唯一广告客户与发布商关系。

PseudonymousIdInfo

当 PSEUDONYMOUS_ID 是 uploadKeyTypes 之一时的其他信息。

JSON 表示法 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
字段
syncStatus

enum (SyncStatus)

仅限输出。用户名单的同步状态。
billableRecordCount

string (int64 format)

可选。不可变。可结算记录（例如，已上传或匹配）的数量。

SyncStatus

用户名单的同步状态。

枚举
SYNC_STATUS_UNSPECIFIED 未指定。
CREATED 用户列表已创建为占位符。列表内容和/或元数据仍在同步。用户名单尚未准备就绪，无法使用。
READY_FOR_USE 用户列表已准备就绪。内容和 Cookie 已正确同步。
FAILED 同步用户列表内容和/或元数据时出错。无法使用用户名单。

PartnerAudienceInfo

面向合作伙伴受众群体的其他信息。

此功能仅适用于数据合作伙伴。

JSON 表示法 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
字段
partnerAudienceSource

enum (PartnerAudienceSource)

必需。不可变。合作伙伴受众群体的来源。
commercePartner

string

可选。商业合作伙伴名称。仅当 partnerAudienceSource 为 COMMERCE_AUDIENCE 时才允许。

PartnerAudienceSource

合作伙伴受众群体来源。

枚举
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED 未指定。
COMMERCE_AUDIENCE 合作伙伴受众群体来源是商务受众群体。
LINEAR_TV_AUDIENCE 合作伙伴受众群体来源是线性电视受众群体。
AGENCY_PROVIDER_AUDIENCE 合作伙伴受众群体来源是代理机构/提供商受众群体。

方法

create

 创建 UserList。

delete

 删除 UserList。

get

 获取 UserList。

list

 列出 UserList。

patch

 更新 UserList。