Package google.ads.datamanager.v1

索引

• IngestionService（界面）
• MarketingDataInsightsService（界面）
• PartnerLinkService（界面）
• UserListDirectLicenseService（界面）
• UserListGlobalLicenseService（界面）
• UserListService（界面）
• AdIdentifiers（消息）
• AddressInfo（消息）
• AgeRange（枚举）
• AudienceMember（消息）
• AwsWrappedKeyInfo（消息）
• AwsWrappedKeyInfo.KeyType（枚举）
• Baseline（消息）
• Baseline.Location（消息）
• CartData（消息）
• Consent（消息）
• ConsentStatus（枚举）
• ContactIdInfo（消息）
• CreatePartnerLinkRequest（消息）
• CreateUserListDirectLicenseRequest（消息）
• CreateUserListGlobalLicenseRequest（消息）
• CreateUserListRequest（消息）
• CustomVariable（消息）
• CustomerType（枚举）
• CustomerValueBucket（枚举）
• DataSourceType（枚举）
• DeletePartnerLinkRequest（消息）
• DeleteUserListRequest（消息）
• Destination（消息）
• DeviceInfo（消息）
• Encoding（枚举）
• EncryptionInfo（消息）
• ErrorCount（消息）
• ErrorInfo（消息）
• ErrorReason（枚举）
• Event（消息）
• EventParameter（消息）
• EventSource（枚举）
• ExperimentalField（消息）
• GcpWrappedKeyInfo（消息）
• GcpWrappedKeyInfo.KeyType（枚举）
• Gender（枚举）
• GetUserListDirectLicenseRequest（消息）
• GetUserListGlobalLicenseRequest（消息）
• GetUserListRequest（消息）
• IngestAudienceMembersRequest（消息）
• IngestAudienceMembersResponse（消息）
• IngestEventsRequest（消息）
• IngestEventsResponse（消息）
• IngestedUserListInfo（消息）
• IngestedUserListInfo.UploadKeyType（枚举）
• Item（消息）
• ItemParameter（消息）
• ListUserListDirectLicensesRequest（消息）
• ListUserListDirectLicensesResponse（消息）
• ListUserListGlobalLicenseCustomerInfosRequest（消息）
• ListUserListGlobalLicenseCustomerInfosResponse（消息）
• ListUserListGlobalLicensesRequest（消息）
• ListUserListGlobalLicensesResponse（消息）
• ListUserListsRequest（消息）
• ListUserListsResponse（消息）
• MatchRateRange（枚举）
• MobileData（消息）
• MobileIdInfo（消息）
• MobileIdInfo.KeySpace（枚举）
• PairData（消息）
• PairIdInfo（消息）
• PartnerAudienceInfo（消息）
• PartnerAudienceInfo.PartnerAudienceSource（枚举）
• PartnerLink（消息）
• PpidData（消息）
• ProcessingErrorReason（枚举）
• ProcessingWarningReason（枚举）
• Product（枚举）（已弃用）
• ProductAccount（消息）
• ProductAccount.AccountType（枚举）
• PseudonymousIdInfo（消息）
• PseudonymousIdInfo.SyncStatus（枚举）
• RemoveAudienceMembersRequest（消息）
• RemoveAudienceMembersResponse（消息）
• RequestStatusPerDestination（消息）
• RequestStatusPerDestination.IngestAudienceMembersStatus（消息）
• RequestStatusPerDestination.IngestEventsStatus（消息）
• RequestStatusPerDestination.IngestMobileDataStatus（消息）
• RequestStatusPerDestination.IngestPairDataStatus（消息）
• RequestStatusPerDestination.IngestPpidDataStatus（消息）
• RequestStatusPerDestination.IngestUserDataStatus（消息）
• RequestStatusPerDestination.IngestUserIdDataStatus（消息）
• RequestStatusPerDestination.RemoveAudienceMembersStatus（消息）
• RequestStatusPerDestination.RemoveMobileDataStatus（消息）
• RequestStatusPerDestination.RemovePairDataStatus（消息）
• RequestStatusPerDestination.RemovePpidDataStatus（消息）
• RequestStatusPerDestination.RemoveUserDataStatus（消息）
• RequestStatusPerDestination.RemoveUserIdDataStatus（消息）
• RequestStatusPerDestination.RequestStatus（枚举）
• RetrieveInsightsRequest（消息）
• RetrieveInsightsResponse（消息）
• RetrieveInsightsResponse.MarketingDataInsight（消息）
• RetrieveInsightsResponse.MarketingDataInsight.AudienceInsightsDimension（枚举）
• RetrieveInsightsResponse.MarketingDataInsight.MarketingDataInsightsAttribute（消息）
• RetrieveRequestStatusRequest（消息）
• RetrieveRequestStatusResponse（消息）
• SearchPartnerLinksRequest（消息）
• SearchPartnerLinksResponse（消息）
• SizeInfo（消息）
• TargetNetworkInfo（消息）
• TermsOfService（消息）
• TermsOfServiceStatus（枚举）
• UpdateUserListDirectLicenseRequest（消息）
• UpdateUserListGlobalLicenseRequest（消息）
• UpdateUserListRequest（消息）
• UserData（消息）
• UserIdData（消息）
• UserIdInfo（消息）
• UserIdentifier（消息）
• UserList（消息）
• UserList.AccessReason（枚举）
• UserList.AccessStatus（枚举）
• UserList.ClosingReason（枚举）
• UserList.MembershipStatus（枚举）
• UserListDirectLicense（消息）
• UserListGlobalLicense（消息）
• UserListGlobalLicenseCustomerInfo（消息）
• UserListGlobalLicenseType（枚举）
• UserListLicenseClientAccountType（枚举）
• UserListLicenseMetrics（消息）
• UserListLicensePricing（消息）
• UserListLicensePricing.UserListPricingBuyerApprovalState（枚举）
• UserListLicensePricing.UserListPricingCostType（枚举）
• UserListLicenseStatus（枚举）
• UserProperties（消息）
• UserProperty（消息）
• WarningCount（消息）
• WarningInfo（消息）

IngestionService

用于将受众群体数据发送到支持的目标位置的服务。

IngestAudienceMembers
rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse) 将 AudienceMember 资源的列表上传到提供的 Destination。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

IngestEvents
rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse) 从提供的 Destination 上传 Event 资源的列表。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

RemoveAudienceMembers
rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse) 从提供的 Destination 中移除 AudienceMember 资源列表。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

RetrieveRequestStatus
rpc RetrieveRequestStatus(RetrieveRequestStatusRequest) returns (RetrieveRequestStatusResponse) 获取指定请求 ID 的请求的状态。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

MarketingDataInsightsService

用于返回营销数据分析洞见的服务。

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

RetrieveInsights

rpc RetrieveInsights(RetrieveInsightsRequest) returns (RetrieveInsightsResponse) 检索指定用户名单的营销数据分析。 此功能仅适用于数据合作伙伴。 授权标头： 此方法支持以下可选标头，用于定义 API 如何授权对请求的访问权限： login-account：（可选）凭据的 Google 账号是用户的账号的资源名称。如果未设置，则默认为请求的账号。格式：accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account：（可选）与 login-account 建立了产品关联的账号的资源名称。格式：accountTypes/{linkedAccountType}/accounts/{linkedAccountId} 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

PartnerLinkService

用于管理合作伙伴链接的服务。

CreatePartnerLink

rpc CreatePartnerLink(CreatePartnerLinkRequest) returns (PartnerLink) 为指定账号创建合作伙伴链接。 授权标头： 此方法支持以下可选标头，用于定义 API 如何授权对请求的访问权限： login-account：（可选）凭据的 Google 账号是用户的账号的资源名称。如果未设置，则默认为请求的账号。格式：accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account：（可选）与 login-account 建立了产品关联的账号的资源名称。格式：accountTypes/{linkedAccountType}/accounts/{linkedAccountId} 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

DeletePartnerLink

rpc DeletePartnerLink(DeletePartnerLinkRequest) returns (Empty) 删除指定账号的合作伙伴链接。 授权标头： 此方法支持以下可选标头，用于定义 API 如何授权对请求的访问权限： login-account：（可选）凭据的 Google 账号是用户的账号的资源名称。如果未设置，则默认为请求的账号。格式：accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account：（可选）与 login-account 建立了产品关联的账号的资源名称。格式：accountTypes/{linkedAccountType}/accounts/{linkedAccountId} 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

SearchPartnerLinks

rpc SearchPartnerLinks(SearchPartnerLinksRequest) returns (SearchPartnerLinksResponse) 搜索指定账号的所有合作伙伴链接。 授权标头： 此方法支持以下可选标头，用于定义 API 如何授权对请求的访问权限： login-account：（可选）凭据的 Google 账号是用户的账号的资源名称。如果未设置，则默认为请求的账号。格式：accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account：（可选）与 login-account 建立了产品关联的账号的资源名称。格式：accountTypes/{linkedAccountType}/accounts/{linkedAccountId} 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

UserListDirectLicenseService

用于管理用户列表直接许可的服务。UserListDirectLicenses 不支持删除操作。调用方应将许可状态更新为 DISABLED，以停用许可。

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

CreateUserListDirectLicense
rpc CreateUserListDirectLicense(CreateUserListDirectLicenseRequest) returns (UserListDirectLicense) 创建用户列表直接许可。 此功能仅适用于数据合作伙伴。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

GetUserListDirectLicense
rpc GetUserListDirectLicense(GetUserListDirectLicenseRequest) returns (UserListDirectLicense) 检索用户列表直接许可。 此功能仅适用于数据合作伙伴。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

ListUserListDirectLicenses
rpc ListUserListDirectLicenses(ListUserListDirectLicensesRequest) returns (ListUserListDirectLicensesResponse) 列出父账号拥有的所有用户名单直接许可。 此功能仅适用于数据合作伙伴。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

UpdateUserListDirectLicense
rpc UpdateUserListDirectLicense(UpdateUserListDirectLicenseRequest) returns (UserListDirectLicense) 更新用户名单直接许可。 此功能仅适用于数据合作伙伴。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

UserListGlobalLicenseService

用于管理用户列表全局许可的服务。UserListGlobalLicenses 不支持删除操作。调用方应将许可状态更新为 DISABLED，以停用许可。

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

CreateUserListGlobalLicense
rpc CreateUserListGlobalLicense(CreateUserListGlobalLicenseRequest) returns (UserListGlobalLicense) 创建用户列表全局许可。 此功能仅适用于数据合作伙伴。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

GetUserListGlobalLicense
rpc GetUserListGlobalLicense(GetUserListGlobalLicenseRequest) returns (UserListGlobalLicense) 检索用户名单全局许可。 此功能仅适用于数据合作伙伴。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

ListUserListGlobalLicenseCustomerInfos
rpc ListUserListGlobalLicenseCustomerInfos(ListUserListGlobalLicenseCustomerInfosRequest) returns (ListUserListGlobalLicenseCustomerInfosResponse) 列出用户名单全局许可的所有客户信息。 此功能仅适用于数据合作伙伴。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

ListUserListGlobalLicenses
rpc ListUserListGlobalLicenses(ListUserListGlobalLicensesRequest) returns (ListUserListGlobalLicensesResponse) 列出父账号拥有的所有用户名单全局许可。 此功能仅适用于数据合作伙伴。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

UpdateUserListGlobalLicense
rpc UpdateUserListGlobalLicense(UpdateUserListGlobalLicenseRequest) returns (UserListGlobalLicense) 更新用户名单的全局许可。 此功能仅适用于数据合作伙伴。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

UserListService

用于管理 UserList 资源的服务。

CreateUserList

rpc CreateUserList(CreateUserListRequest) returns (UserList) 创建 UserList。 授权标头： 此方法支持以下可选标头，用于定义 API 如何授权对请求的访问权限： login-account：（可选）凭据的 Google 账号是用户的账号的资源名称。如果未设置，则默认为请求的账号。格式：accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account：（可选）与 login-account 建立了产品关联的账号的资源名称。格式：accountTypes/{linkedAccountType}/accounts/{linkedAccountId} 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

DeleteUserList

rpc DeleteUserList(DeleteUserListRequest) returns (Empty) 删除 UserList。 授权标头： 此方法支持以下可选标头，用于定义 API 如何授权对请求的访问权限： login-account：（可选）凭据的 Google 账号是用户的账号的资源名称。如果未设置，则默认为请求的账号。格式：accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account：（可选）与 login-account 建立了产品关联的账号的资源名称。格式：accountTypes/{linkedAccountType}/accounts/{linkedAccountId} 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

GetUserList

rpc GetUserList(GetUserListRequest) returns (UserList) 获取 UserList。 授权标头： 此方法支持以下可选标头，用于定义 API 如何授权对请求的访问权限： login-account：（可选）凭据的 Google 账号是用户的账号的资源名称。如果未设置，则默认为请求的账号。格式：accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account：（可选）与 login-account 建立了产品关联的账号的资源名称。格式：accountTypes/{linkedAccountType}/accounts/{linkedAccountId} 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

ListUserLists

rpc ListUserLists(ListUserListsRequest) returns (ListUserListsResponse) 列出 UserList。 授权标头： 此方法支持以下可选标头，用于定义 API 如何授权对请求的访问权限： login-account：（可选）凭据的 Google 账号是用户的账号的资源名称。如果未设置，则默认为请求的账号。格式：accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account：（可选）与 login-account 建立了产品关联的账号的资源名称。格式：accountTypes/{linkedAccountType}/accounts/{linkedAccountId} 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

UpdateUserList

rpc UpdateUserList(UpdateUserListRequest) returns (UserList) 更新 UserList。 授权标头： 此方法支持以下可选标头，用于定义 API 如何授权对请求的访问权限： login-account：（可选）凭据的 Google 账号是用户的账号的资源名称。如果未设置，则默认为请求的账号。格式：accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account：（可选）与 login-account 建立了产品关联的账号的资源名称。格式：accountTypes/{linkedAccountType}/accounts/{linkedAccountId} 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/datamanager

AdIdentifiers

用于将转化事件与其他线上活动（例如广告点击）进行匹配的标识符和其他信息。

字段
session_attributes	string 可选。用于事件归因和建模的会话属性。
gclid	string 可选。与此事件相关联的 Google 点击 ID (gclid)。
gbraid	string 可选。一种点击标识符，标识的是与应用事件相关联且源自 iOS14 及更高版本 iOS 设备的点击。
wbraid	string 可选。一种点击标识符，标识的是与网站事件相关联且源自 iOS14 及更高版本 iOS 设备的点击。
landing_page_device_info	DeviceInfo 可选。用户在与广告互动后访问广告客户网站时所用设备（如有）的相关信息。

AddressInfo

用户的地址信息。

字段
given_name	string 必需。用户的名字（第一个名字），全部小写，不含标点符号、前导或尾随空格，并以 SHA-256 格式进行哈希处理。
family_name	string 必需。用户的姓氏（全部小写），不含标点符号、前导或尾随空格，并以 SHA-256 格式进行哈希处理。
region_code	string 必需。用户的 ISO-3166-1 alpha-2 格式地址中 2 个字母的地区代码。
postal_code	string 必需。用户地址的邮政编码。

年龄范围

受众年龄段

枚举
AGE_RANGE_UNSPECIFIED	未指定。
AGE_RANGE_UNKNOWN	未知。
AGE_RANGE_18_24	年龄介于 18 至 24 岁之间。
AGE_RANGE_25_34	年龄在 25 至 34 岁之间。
AGE_RANGE_35_44	年龄介于 35 至 44 岁之间。
AGE_RANGE_45_54	年龄介于 45 至 54 岁之间。
AGE_RANGE_55_64	年龄介于 55 至 64 岁之间。
AGE_RANGE_65_UP	65 岁及以上。

AudienceMember

要操作的观众成员。

字段
destination_references[]	string 可选。定义将受众群体成员发送到哪个 Destination。
consent	Consent 可选。用户的意见征求设置。
联合字段 data。要处理的身份识别数据的类型。data 只能是下列其中一项：
user_data	UserData 用于标识用户的用户提供的数据。
pair_data	PairData 发布商与广告客户间用户身份匹配 (PAIR) ID。 此功能仅适用于数据合作伙伴。
mobile_data	MobileData 用于标识用户移动设备的数据。
user_id_data	UserIdData 与广告客户定义的用户唯一标识符相关的数据。
ppid_data	PpidData 与发布商提供的标识符相关的数据。 此功能仅适用于数据合作伙伴。

AwsWrappedKeyInfo

由 AWS KMS 密钥封装的数据加密密钥。

字段
key_type	KeyType 必需。用于加密数据的算法类型。
role_arn	string 必需。要为 KMS 解密访问权限承担的 IAM 角色的 Amazon 资源名称。应采用 arn:{partition}:iam::{account_id}:role/{role_name} 格式
kek_uri	string 必需。用于解密 DEK 的 AWS KMS 密钥的 URI。应采用 arn:{partition}:kms:{region}:{account_id}:key/{key_id} 或 aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id} 格式
encrypted_dek	string 必需。base64 编码的加密数据加密密钥。

KeyType

用于加密数据的算法类型。

枚举
KEY_TYPE_UNSPECIFIED	未指定密钥类型。不应使用此值。
XCHACHA20_POLY1305	算法 XChaCha20-Poly1305

基准

用于比较数据洞见的基准条件。

字段
联合字段 baseline。用于比较数据分析的基准位置。baseline 只能是下列其中一项：
baseline_location	Location 请求的基准位置。基准位置是所请求区域的 OR 列表。
location_auto_detection_enabled	bool 如果设置为 true，该服务将尝试自动检测数据洞见的基准位置。

位置

请求的基准位置。基准位置位于所请求区域的 ISO 3166-1 alpha-2 区域代码的 OR 列表中。

字段
region_codes[]	string ISO 3166-1 alpha-2 地区代码的列表。

CartData

与事件关联的购物车数据。

字段
merchant_id	string 可选。与商品关联的 Merchant Center ID。
merchant_feed_label	string 可选。与商品的 Feed 相关联的 Merchant Center Feed 标签。
merchant_feed_language_code	string 可选。与您上传商品的 Merchant Center Feed 相关联的 ISO 639-1 语言代码。
transaction_discount	double 可选。与交易相关的所有折扣的总和。
items[]	Item 可选。与活动关联的商品列表。

同意

用户的《数字市场法案》(DMA) 用户意见征求设置。

字段
ad_user_data	ConsentStatus 可选。表示用户是否同意使用广告用户数据。
ad_personalization	ConsentStatus 可选。表示用户是否同意接收个性化广告。

ConsentStatus

表示用户是否已表示同意、拒绝同意或尚未指定同意情况。

枚举
CONSENT_STATUS_UNSPECIFIED	未指定。
CONSENT_GRANTED	已授予。
CONSENT_DENIED	已拒绝。

ContactIdInfo

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

字段
match_rate_percentage	int32 仅限输出。目标客户匹配用户名单的匹配率。
data_source_type	DataSourceType 可选。不可变。上传数据的来源

CreatePartnerLinkRequest

创建 PartnerLink 资源的请求。返回 PartnerLink。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
parent	string 必需。拥有此合作伙伴链接集合的父级。格式：accountTypes/{account_type}/accounts/{account}
partner_link	PartnerLink 必需。要创建的合作伙伴链接。

CreateUserListDirectLicenseRequest

创建 UserListDirectLicense 资源的请求。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
parent	string 必需。拥有正在许可的用户名单的账号。应采用以下格式：accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
user_list_direct_license	UserListDirectLicense 必需。要创建的用户列表直接许可。

CreateUserListGlobalLicenseRequest

创建 UserListGlobalLicense 资源的请求。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
parent	string 必需。拥有正在许可的用户名单的账号。应采用以下格式：accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
user_list_global_license	UserListGlobalLicense 必需。要创建的用户列表全局许可。

CreateUserListRequest

针对 CreateUserList 的请求消息。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
parent	string 必需。将创建相应用户列表的父账号。格式：accountTypes/{account_type}/accounts/{account}
user_list	UserList 必需。要创建的用户列表。
validate_only	bool 可选。如果为 true，则验证请求，但不执行请求。

CustomVariable

广告转化的自定义变量。

字段
variable	string 可选。要设置的自定义变量的名称。如果找不到指定目标位置的变量，系统会忽略该变量。
value	string 可选。要为自定义变量存储的值。
destination_references[]	string 可选。用于确定应将自定义变量发送到哪个 Event.destination_references 的参考字符串。如果为空，则使用 Event.destination_references。

CustomerType

与活动关联的客户的类型。

枚举
CUSTOMER_TYPE_UNSPECIFIED	未指定 CustomerType。不应使用此值。
NEW	客户是广告客户的新客户。
RETURNING	客户再次访问广告客户的网站。
REENGAGED	客户再次与广告客户互动。

CustomerValueBucket

广告客户评估的客户价值。

枚举
CUSTOMER_VALUE_BUCKET_UNSPECIFIED	未指定的 CustomerValueBucket。不应使用此值。
LOW	客户价值较低。
MEDIUM	客户价值中等。
HIGH	客户价值高。

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	上传的数据是第三方合作伙伴数据。

DeletePartnerLinkRequest

用于删除 PartnerLink 资源的请求。返回 google.protobuf.Empty。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
name	string 必需。要删除的合作伙伴链接的资源名称。格式：accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

DeleteUserListRequest

针对 DeleteUserList 的请求消息。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
name	string 必需。要删除的用户列表的名称。格式：accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
validate_only	bool 可选。如果为 true，则验证请求，但不执行请求。

目的地

您要将数据发送到的 Google 产品。例如，Google Ads 账号。

字段
reference	string 可选。相应 Destination 资源的 ID，在请求中是唯一的。用于在 IngestEventsRequest 和 IngestAudienceMembersRequest 中引用此 Destination。
login_account	ProductAccount 可选。用于进行此 API 调用的账号。如需向 operating_account 添加数据或从中移除数据，此 login_account 必须具有对 operating_account 的写入权限。例如，operating_account的经理账号，或已与operating_account建立关联的账号。
linked_account	ProductAccount 可选。调用用户的 login_account 通过已建立的账号关联可访问的账号。例如，数据合作伙伴的 login_account 可能有权访问客户的 linked_account。合作伙伴可能会使用此字段将数据从 linked_account 发送到另一个 operating_account。
operating_account	ProductAccount 必需。要向其发送数据或从中移除数据的账号。
product_destination_id	string 必需。产品账号中要将数据提取到的对象。例如，Google Ads 受众群体 ID、Display & Video 360 受众群体 ID 或 Google Ads 转化操作 ID。

DeviceInfo

事件发生时所用设备（如有）的相关信息。

字段
user_agent	string 可选。相应上下文的设备的用户代理字符串。
ip_address	string 可选。相应上下文的设备的 IP 地址。 注意：Google Ads 不支持针对欧洲经济区 (EEA)、英国 (UK) 或瑞士 (CH) 的最终用户进行 IP 地址匹配。添加逻辑以有条件地排除来自这些地区的用户分享 IP 地址，并确保您清楚、全面地向用户提供与您在网站、应用和其他媒体资源上收集的数据有关的信息，并在法律或任何适用的 Google 政策要求的情况下征得用户同意。如需了解详情，请参阅线下转化数据导入简介页面。

编码

已哈希处理的身份识别信息的编码类型。

枚举
ENCODING_UNSPECIFIED	未指定编码类型。不应使用此值。
HEX	十六进制编码。
BASE64	Base 64 编码。

EncryptionInfo

要提取的数据的加密信息。

字段
联合字段 wrapped_key。用于加密数据的封装密钥。wrapped_key 只能是下列其中一项：
gcp_wrapped_key_info	GcpWrappedKeyInfo Google Cloud Platform 封装密钥信息。
aws_wrapped_key_info	AwsWrappedKeyInfo Amazon Web Services 封装的密钥信息。

ErrorCount

指定错误原因的错误计数。

字段
record_count	int64 因特定原因而未能上传的记录数。
reason	ProcessingErrorReason 失败记录的错误原因。

错误信息

每种类型错误的错误计数。

字段
error_counts[]	ErrorCount 按错误原因列出的错误列表和数量。可能不会在所有情况下填充。

ErrorReason

Data Manager API 的错误原因。注意：此枚举未冻结，将来可能会添加新值。

枚举
ERROR_REASON_UNSPECIFIED	请勿使用此默认值。
INTERNAL_ERROR	发生内部错误。
DEADLINE_EXCEEDED	请求的响应时间过长。
RESOURCE_EXHAUSTED	请求次数过多。
NOT_FOUND	找不到资源。
PERMISSION_DENIED	用户没有相应权限，或者找不到相应资源。
INVALID_ARGUMENT	该请求出现了问题。
REQUIRED_FIELD_MISSING	必填字段未填写。
INVALID_FORMAT	格式无效。
INVALID_HEX_ENCODING	十六进制编码值格式错误。
INVALID_BASE64_ENCODING	Base64 编码的值格式有误。
INVALID_SHA256_FORMAT	SHA256 编码值格式错误。
INVALID_POSTAL_CODE	邮政编码无效。
INVALID_COUNTRY_CODE	国家/地区代码无效。
INVALID_ENUM_VALUE	无法使用枚举值。
INVALID_USER_LIST_TYPE	用户名单的类型不适用于此请求。
INVALID_AUDIENCE_MEMBER	此观众成员无效。
TOO_MANY_AUDIENCE_MEMBERS	每个请求允许的受众群体成员数量上限为 10,000。
TOO_MANY_USER_IDENTIFIERS	每个受众群体成员允许的用户标识符数量上限为 10 个。
TOO_MANY_DESTINATIONS	每个请求允许的目标账号数量上限为 10。
INVALID_DESTINATION	此目的地无效。
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED	数据合作伙伴无权访问运营账号所拥有的用户列表。
INVALID_MOBILE_ID_FORMAT	移动设备 ID 格式无效。
INVALID_USER_LIST_ID	用户名单无效。
MULTIPLE_DATA_TYPES_NOT_ALLOWED	不允许在单个请求中提取多种数据类型。
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER	包含 DataPartner 登录账号的目标配置必须在所有目标配置中具有相同的登录账号。
TERMS_AND_CONDITIONS_NOT_SIGNED	未接受必需的条款及条件。
INVALID_NUMBER_FORMAT	数字格式无效。
INVALID_CONVERSION_ACTION_ID	转化操作 ID 无效。
INVALID_CONVERSION_ACTION_TYPE	转化操作类型无效。
INVALID_CURRENCY_CODE	货币代码不受支持。
INVALID_EVENT	此活动无效。
TOO_MANY_EVENTS	每个请求允许的事件数量上限为 10,000。
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS	目标账号未启用增强型潜在客户转化。
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS	由于 Google 客户数据政策，目标账号无法使用增强型转化。请与您的 Google 代表联系。
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED	目标账号尚未同意增强型转化的条款。
DUPLICATE_DESTINATION_REFERENCE	请求中的两个或更多目的地具有相同的参考。
UNSUPPORTED_OPERATING_ACCOUNT_FOR_DATA_PARTNER	数据合作伙伴授权所用的运营账号不受支持。
UNSUPPORTED_LINKED_ACCOUNT_FOR_DATA_PARTNER	数据合作伙伴授权不支持关联的账号。
NO_IDENTIFIERS_PROVIDED	事件数据不包含用户标识符或广告标识符。
INVALID_PROPERTY_TYPE	不支持相应媒体资源类型。
INVALID_STREAM_TYPE	不支持此视频串流类型。
LINKED_ACCOUNT_ONLY_ALLOWED_WITH_DATA_PARTNER_LOGIN_ACCOUNT	仅当登录账号为 DATA_PARTNER 账号时，才支持关联账号。
OPERATING_ACCOUNT_LOGIN_ACCOUNT_MISMATCH	登录账号必须与相应使用情形的运营账号相同。
EVENT_TIME_INVALID	相应事件未在可接受的时间范围内发生。
RESERVED_NAME_USED	参数使用了预留名称。
INVALID_EVENT_NAME	不支持该事件名称。
NOT_ALLOWLISTED	相应账号未列入相应功能的许可名单。
INVALID_REQUEST_ID	用于检索请求状态的请求 ID 无效。只有成功且不含 validate_only=true 的请求才能检索状态。
MULTIPLE_DESTINATIONS_FOR_GOOGLE_ANALYTICS_EVENT	相应事件具有 2 个或更多 Google Analytics 目的地。
FIELD_VALUE_TOO_LONG	字段值过长。
TOO_MANY_ELEMENTS	请求中的列表包含的元素过多。
ALREADY_EXISTS	资源已存在。
IMMUTABLE_FIELD_FOR_UPDATE	尝试为更新请求设置不可变字段。
INVALID_RESOURCE_NAME	资源名称无效。
INVALID_FILTER	查询过滤条件无效。
INVALID_UPDATE_MASK	更新掩码无效。
INVALID_PAGE_TOKEN	页面令牌无效。
CANNOT_UPDATE_DISABLED_LICENSE	无法更新已停用的许可。
CANNOT_CREATE_LICENSE_FOR_SENSITIVE_USERLIST	无法向此客户授予敏感用户名单的许可。
INSUFFICIENT_COST	相应许可的费用过低。
CANNOT_DISABLE_LICENSE	转销商许可正在使用中，因此无法停用。
INVALID_CLIENT_ACCOUNT_ID	无效的客户账号 ID。
PRICING_ONLY_ZERO_COST_ALLOWED	此客户账号不允许使用非零费用。
PRICE_TOO_HIGH	相应许可的费用过高。
CUSTOMER_NOT_ALLOWED_TO_CREATE_LICENSE	相应客户无权创建许可。
INVALID_PRICING_END_DATE	相应许可的价格结束日期无效。
CANNOT_LICENSE_LOGICAL_LIST_WITH_LICENSED_OR_SHARED_SEGMENT	包含共享细分受众群或许可细分受众群的逻辑用户名单无法获得许可。
MISMATCHED_ACCOUNT_TYPE	请求中的客户账号类型与客户的实际账号类型不匹配。
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_LICENSE_TYPE	许可类型不支持媒体分享费用。
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_CLIENT_CUSTOMER	客户客户类型不支持媒体分享费用。
INVALID_MEDIA_SHARE_COST	媒体份额费用无效。
INVALID_COST_TYPE	费用类型无效。
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_NON_COMMERCE_USER_LIST	UserList 类型不支持媒体分享费用。
MAX_COST_NOT_ALLOWED	只有当 cost_type 为 MEDIA_SHARE 时，才允许设置 max_cost。
COMMERCE_AUDIENCE_CAN_ONLY_BE_DIRECTLY_LICENSED	商业受众群体只能直接许可。
INVALID_DESCRIPTION	说明无效。
INVALID_DISPLAY_NAME	显示名称无效。
DISPLAY_NAME_ALREADY_USED	该显示名已用于相应账号的其他用户名单。
OWNERSHIP_REQUIRED_FOR_UPDATE	您必须是用户名单的所有者，才能修改用户名单。
USER_LIST_MUTATION_NOT_SUPPORTED	用户名单类型为只读，不支持变异。
SENSITIVE_USER_LIST_IMMUTABLE	外部用户无法更改涉及隐私权或法律禁止的用户名单。
BILLABLE_RECORD_COUNT_IMMUTABLE	再营销用户名单的可结算记录字段一经设置便无法修改。
USER_LIST_NAME_RESERVED	此用户名单名称专供系统名单使用。
ADVERTISER_NOT_ALLOWLISTED_FOR_UPLOADED_DATA	广告客户需要加入许可名单，才能使用根据广告客户上传的数据创建的再营销名单。
UNSUPPORTED_PARTNER_AUDIENCE_SOURCE	用户名单类型不支持合作伙伴受众群体来源。
COMMERCE_PARTNER_NOT_ALLOWED	仅当 partner_audience_source 为 COMMERCE_AUDIENCE 时，才支持设置 commerce_partner 字段。
UNSUPPORTED_PARTNER_AUDIENCE_INFO	用户名单类型不支持 partner_audience_info 字段。
PARTNER_MATCH_FOR_MANAGER_ACCOUNT_DISALLOWED	经理账号无法创建合作伙伴匹配用户名单。
DATA_PARTNER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA	相应数据合作伙伴未列入 THIRD_PARTY_PARTNER_DATA 的许可名单。
ADVERTISER_TOS_NOT_ACCEPTED	广告客户尚未接受合作伙伴的服务条款。
ADVERTISER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA	相应广告客户未列入 THIRD_PARTY_PARTNER_DATA 的许可名单。
USER_LIST_TYPE_NOT_SUPPORTED_FOR_ACCOUNT	相应账号不支持此用户名单类型。
INVALID_COMMERCE_PARTNER	commerce_partner 字段无效。
CUSTOMER_NOT_ALLOWLISTED_FOR_COMMERCE_AUDIENCE	相应数据提供方未列入可创建商业受众群体的许可名单。
UNSUPPORTED_USER_LIST_UPLOAD_KEY_TYPES	不支持用户名单上传密钥类型。
UNSUPPORTED_INGESTED_USER_LIST_INFO_CONFIG	不支持提取的用户名单信息配置。
UNSUPPORTED_ACCOUNT_TYPES_FOR_USER_LIST_TYPE	相应用户名单类型不支持这些账号类型。
UNSUPPORTED_ACCOUNT_TYPE_FOR_PARTNER_LINK	合作伙伴关联不支持这些账号类型。

事件

表示用户与广告客户的网站或应用互动的事件。

字段
destination_references[]	string 可选。用于确定目的地的参考字符串。如果为空，则会将事件发送到请求中的所有 destinations。
transaction_id	string 可选。相应事件的唯一标识符。对于使用多个数据源的转化，此参数是必需的。
event_timestamp	Timestamp 必需。事件发生的时间。
last_updated_timestamp	Timestamp 可选。上次更新活动的时间。
user_data	UserData 可选。用户提供的数据片段，表示事件所关联的用户。
consent	Consent 可选。关联用户是否已提供不同类型的同意声明。
ad_identifiers	AdIdentifiers 可选。用于将转化事件与其他线上活动（例如广告点击）进行匹配的标识符和其他信息。
currency	string 可选。与相应事件中的所有货币价值相关联的币种代码。
event_source	EventSource 可选。指明事件发生位置（网站、应用、实体店等）的信号。
event_device_info	DeviceInfo 可选。事件发生时收集的有关所用设备（如有）的信息。
cart_data	CartData 可选。与活动相关的交易和商品信息。
custom_variables[]	CustomVariable 可选。要发送到转化容器（转化操作或 Floodlight 活动）的其他键值对信息。
experimental_fields[]	ExperimentalField 可选。实验性字段的键值对列表，这些字段最终可能会升级为 API 的一部分。
user_properties	UserProperties 可选。广告客户在事件发生时评估的用户相关信息。
event_name	string 可选。事件名称。对于 GA4 事件为必需参数。
client_id	string 可选。相应 GA4 Web 数据流的 Web 客户端的用户实例的唯一标识符。
user_id	string 可选。广告客户定义的用户唯一标识符。
additional_event_parameters[]	EventParameter 可选。要包含在事件中的任何事件参数的存储分区，这些参数尚未通过其他结构化字段指定。
conversion_value	double 可选。与事件关联的转化价值（适用于基于价值的转化）。

EventParameter

GA4 事件的事件参数。

字段
parameter_name	string 必需。要使用的参数的名称。
value	string 必需。要设置的参数值的字符串表示形式。

EventSource

相应事件的来源。

枚举
EVENT_SOURCE_UNSPECIFIED	未指定的 EventSource。不应使用此值。
WEB	相应事件是通过网络浏览器生成的。
APP	相应事件是由应用生成的。
IN_STORE	相应活动是根据实体店交易生成的。
PHONE	相应事件是通过电话生成的。
OTHER	相应事件是从其他来源生成的。

ExperimentalField

表示非官方字段的实验性字段。

字段
field	string 可选。要使用的字段的名称。
value	string 可选。要设置的字段值。

GcpWrappedKeyInfo

有关 Google Cloud Platform 封装密钥的信息。

字段
key_type	KeyType 必需。用于加密数据的算法类型。
wip_provider	string 必需。使用 KEK 所需的 Workload Identity 池提供方。
kek_uri	string 必需。Google Cloud Platform Cloud Key Management Service 资源 ID。应采用 projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key} 或 gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key} 格式
encrypted_dek	string 必需。base64 编码的加密数据加密密钥。

KeyType

用于加密数据的算法类型。

枚举
KEY_TYPE_UNSPECIFIED	未指定密钥类型。不应使用此值。
XCHACHA20_POLY1305	算法 XChaCha20-Poly1305

性别

人口统计性别类型（例如女性）。

枚举
GENDER_UNSPECIFIED	未指定。
GENDER_UNKNOWN	未知。
GENDER_MALE	男性。
GENDER_FEMALE	女性。

GetUserListDirectLicenseRequest

获取 UserListDirectLicense 资源的请求。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
name	string 必需。用户名单直接许可的资源名称。

GetUserListGlobalLicenseRequest

获取 UserListGlobalLicense 资源的请求。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
name	string 必需。用户名单全局许可的资源名称。

GetUserListRequest

针对 GetUserList 的请求消息。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
name	string 必需。要检索的 UserList 的资源名称。格式：accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

IngestAudienceMembersRequest

请求将受众群体成员上传到指定的目标平台。返回 IngestAudienceMembersResponse。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
destinations[]	Destination 必需。要将受众群体成员发送到的目标平台的列表。
audience_members[]	AudienceMember 必需。要发送到指定目的地的用户列表。一次请求中最多可发送 10,000 个 AudienceMember 资源。
consent	Consent 可选。请求级意见征求，适用于请求中的所有用户。用户级意见征求会覆盖请求级意见征求，并且可以在每个 AudienceMember 中指定。
validate_only	bool 可选。用于测试目的。如果为 true，则系统会验证请求，但不会执行请求。仅返回错误，不返回结果。
encoding	Encoding 可选。上传 UserData 文件时必须填写该字段。用户标识符的编码类型。对于经过哈希处理的用户标识符，这是哈希处理后的字符串的编码类型。对于加密的哈希用户标识符，这是外部加密字符串的编码类型，但不一定是内部哈希字符串的编码类型，这意味着内部哈希字符串的编码方式可能与外部加密字符串不同。对于非 UserData 上传，此字段会被忽略。
encryption_info	EncryptionInfo 可选。UserData 上传的加密信息。如果未设置，则假定上传的身份识别信息已进行哈希处理，但未进行加密。对于非 UserData 上传，此字段会被忽略。
terms_of_service	TermsOfService 可选。用户已接受/拒绝的服务条款。

IngestAudienceMembersResponse

来自 IngestAudienceMembersRequest 的回答。

字段
request_id	string 请求的自动生成的 ID。

IngestEventsRequest

请求将受众群体成员上传到指定的目标平台。返回 IngestEventsResponse。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
destinations[]	Destination 必需。要将事件发送到的目的地列表。
events[]	Event 必需。要发送到指定目的地的事件列表。一次请求中最多可以发送 2,000 个 Event 资源。
consent	Consent 可选。请求级意见征求，适用于请求中的所有用户。用户级意见征求会覆盖请求级意见征求，并且可以在每个 Event 中指定。
validate_only	bool 可选。用于测试目的。如果为 true，则系统会验证请求，但不会执行请求。仅返回错误，不返回结果。
encoding	Encoding 可选。上传 UserData 文件时必须填写该字段。用户标识符的编码类型。对于经过哈希处理的用户标识符，这是哈希处理后的字符串的编码类型。对于加密的哈希用户标识符，这是外部加密字符串的编码类型，但不一定是内部哈希字符串的编码类型，这意味着内部哈希字符串的编码方式可能与外部加密字符串不同。对于非 UserData 上传，此字段会被忽略。
encryption_info	EncryptionInfo 可选。UserData 上传的加密信息。如果未设置，则假定上传的身份识别信息已进行哈希处理，但未进行加密。对于非 UserData 上传，此字段会被忽略。

IngestEventsResponse

来自 IngestEventsRequest 的回答。

字段
request_id	string 请求的自动生成的 ID。

IngestedUserListInfo

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

字段
upload_key_types[]	UploadKeyType 必需。不可变。相应用户名单的上传密钥类型。
contact_id_info	ContactIdInfo 可选。当 CONTACT_ID 是 upload_key_types 之一时的其他信息。
mobile_id_info	MobileIdInfo 可选。当 MOBILE_ID 是 upload_key_types 之一时的其他信息。
user_id_info	UserIdInfo 可选。当 USER_ID 是 upload_key_types 之一时的其他信息。
pair_id_info	PairIdInfo 可选。当 PAIR_ID 是 upload_key_types 之一时的其他信息。 此功能仅适用于数据合作伙伴。
pseudonymous_id_info	PseudonymousIdInfo 可选。PSEUDONYMOUS_ID 的其他信息是 upload_key_types 之一。
partner_audience_info	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

项

表示与活动关联的购物车中的商品。

字段
merchant_product_id	string 可选。Merchant Center 账号中的商品 ID。
quantity	int64 可选。与相应事件相关联的相应商品的数量。
unit_price	double 可选。单价（不含税、运费及任何交易级折扣）。
item_id	string 可选。用于引用商品的唯一标识符。
additional_item_parameters[]	ItemParameter 可选。要包含在事件中的任何与商品相关的事件参数的存储分区，这些参数尚未通过其他结构化字段指定。

ItemParameter

要包含在事件中的任何与商品相关的事件参数的存储分区，这些参数尚未通过其他结构化字段指定。

字段
parameter_name	string 必需。要使用的参数的名称。
value	string 必需。要设置的参数值的字符串表示形式。

ListUserListDirectLicensesRequest

请求列出指定账号的所有 UserListDirectLicense 资源。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
parent	string 必需。正在查询许可的账号。应采用以下格式：accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
filter	string 可选。要应用于列表请求的过滤条件。所有字段都必须位于每个条件的左侧（例如：user_list_id = 123）。 支持的操作： AND = != > >= < <= 不受支持的字段： name（请改用 get 方法） historical_pricings 及其所有子字段 pricing.start_time pricing.end_time
page_size	int32 可选。每页返回的许可数量上限。服务返回的值可能小于此值。如果未指定，则最多返回 50 个许可。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。
page_token	string 可选。从之前的 ListUserListDirectLicense 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时，提供给 ListUserListDirectLicense 的所有其他参数必须与提供页面令牌的调用匹配。

ListUserListDirectLicensesResponse

来自 ListUserListDirectLicensesRequest 的回答。

字段
user_list_direct_licenses[]	UserListDirectLicense 请求中指定的用户列表的许可。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListUserListGlobalLicenseCustomerInfosRequest

请求列出给定用户列表全局许可的所有 UserListGlobalLicenseCustomerInfo 资源。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
parent	string 必需。正在查询客户信息的全局许可。应采用以下格式：accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}。如需列出账号下的所有全局许可客户信息，请将用户列表全局许可 ID 替换为“-”（例如 accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-）
filter	string 可选。要应用于列表请求的过滤条件。所有字段都必须位于每个条件的左侧（例如：user_list_id = 123）。 支持的操作： AND = != > >= < <= 不受支持的字段： name（请改用 get 方法） historical_pricings 及其所有子字段 pricing.start_time pricing.end_time
page_size	int32 可选。要返回的许可数量上限。服务返回的值可能小于此值。如果未指定，则最多返回 50 个许可。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。
page_token	string 可选。从之前的 ListUserListDirectLicense 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时，提供给 ListUserListDirectLicense 的所有其他参数必须与提供页面令牌的调用匹配。

ListUserListGlobalLicenseCustomerInfosResponse

[ListUserListGlobalLicensesCustomerInfoRequest][google.ads.datamanager.v1.ListUserListGlobalLicensesCustomerInfoRequest] 的响应。

字段
user_list_global_license_customer_infos[]	UserListGlobalLicenseCustomerInfo 相应请求中指定许可的客户信息。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListUserListGlobalLicensesRequest

请求列出指定账号的所有 UserListGlobalLicense 资源。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
parent	string 必需。正在查询许可的账号。应采用以下格式：accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
filter	string 可选。要应用于列表请求的过滤条件。所有字段都必须位于每个条件的左侧（例如：user_list_id = 123）。 支持的操作： AND = != > >= < <= 不受支持的字段： name（请改用 get 方法） historical_pricings 及其所有子字段 pricing.start_time pricing.end_time
page_size	int32 可选。要返回的许可数量上限。服务返回的值可能小于此值。如果未指定，则最多返回 50 个许可。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。
page_token	string 可选。从之前的 ListUserListGlobalLicense 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时，提供给 ListUserListDirectLicense 的所有其他参数必须与提供页面令牌的调用匹配。

ListUserListGlobalLicensesResponse

来自 ListUserListGlobalLicensesRequest 的回答。

字段
user_list_global_licenses[]	UserListGlobalLicense 请求中指定的用户列表的许可。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListUserListsRequest

针对 ListUserLists 的请求消息。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
parent	string 必需。拥有此用户名单集合的父账号。格式：accountTypes/{account_type}/accounts/{account}
page_size	int32 可选。要返回的用户名单数量上限。服务返回的值可能小于此值。如果未指定，则最多返回 50 个用户列表。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。
page_token	string 可选。从之前的 ListUserLists 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时，提供给 ListUserLists 的所有其他参数必须与提供页面令牌的调用匹配。
filter	string 可选。过滤字符串。所有字段都需要位于每个条件的左侧（例如：display_name = "list 1"）。 支持的操作： AND = != > >= < <= :（有） 支持的字段： id display_name description membership_status integration_code access_reason ingested_user_list_info.upload_key_types

ListUserListsResponse

针对 ListUserLists 的响应消息。

字段
user_lists[]	UserList 指定账号中的用户列表。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

MatchRateRange

上传或用户名单的匹配率范围。

枚举
MATCH_RATE_RANGE_UNKNOWN	匹配率范围未知。
MATCH_RATE_RANGE_NOT_ELIGIBLE	匹配率范围不符合条件。
MATCH_RATE_RANGE_LESS_THAN_20	匹配率范围小于 20%（在区间 [0, 20) 内）。
MATCH_RATE_RANGE_20_TO_30	匹配率范围介于 20% 到 30% 之间（即 [20, 31) 区间）。
MATCH_RATE_RANGE_31_TO_40	匹配率范围介于 31% 和 40% 之间（在区间 [31, 41) 内）。
MATCH_RATE_RANGE_41_TO_50	匹配率范围介于 41% 和 50% 之间（区间为 [41, 51)）。
MATCH_RATE_RANGE_51_TO_60	匹配率范围介于 51% 和 60% 之间（即 [51, 61) 区间）。
MATCH_RATE_RANGE_61_TO_70	匹配率范围介于 61% 和 70% 之间（位于区间 [61, 71) 内）。
MATCH_RATE_RANGE_71_TO_80	匹配率范围介于 71% 和 80% 之间（在区间 [71, 81) 内）。
MATCH_RATE_RANGE_81_TO_90	匹配率范围介于 81% 和 90% 之间（在区间 [81, 91) 内）。
MATCH_RATE_RANGE_91_TO_100	匹配率范围介于 91% 到 100% 之间（区间为 [91, 100]）。

MobileData

相应受众群体的移动 ID。至少需要一个移动设备 ID。

字段
mobile_ids[]	string 必需。移动设备 ID（广告 ID/IDFA）的列表。单个 AudienceMember 中最多可提供 10 个 mobileIds。

MobileIdInfo

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

字段
data_source_type	DataSourceType 可选。不可变。上传数据的来源。
key_space	KeySpace 必需。不可变。移动 ID 的键空间。
app_id	string 必需。不可变。一个字符串，用于唯一标识从中收集数据的移动应用。

KeySpace

移动 ID 的键空间。

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

PairData

相应受众群体的 PAIR ID。必须提供至少一个配对 ID。

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

字段
pair_ids[]	string 必需。由 Cleanroom 提供的 PII 数据，使用 SHA256 进行哈希处理，并使用发布商密钥通过 EC 可交换密码进行加密，以用于 PAIR 用户名单。单个 AudienceMember 中最多可提供 10 个 pairIds。

PairIdInfo

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

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

字段
match_rate_percentage	int32 仅限输出。此字段表示相应发布商的第一方数据与此用户名单的会员匹配百分比。必须介于 0 到 100 之间（含边界值）。
advertiser_identifier_count	int64 仅限输出。已上传到数据净室提供商的广告客户第一方数据记录数。这并不表示 PAIR 用户名单的规模。
publisher_id	int64 必需。不可变。标识与发布商广告客户身份匹配用户名单进行匹配的发布商。此字段由清理室提供商提供，仅在相应清理室范围内具有唯一性。不能用作多个数据净室的全局标识符。
publisher_name	string 可选。要在界面中显示的发布商描述性名称，以便提供更出色的定位体验。
clean_room_identifier	string 必需。不可变。用于标识与一个或多个净室提供商之间的唯一广告客户与发布商关系。

PartnerAudienceInfo

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

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

字段
partner_audience_source	PartnerAudienceSource 必需。不可变。合作伙伴受众群体的来源。
commerce_partner	string 可选。商业合作伙伴名称。仅当 partner_audience_source 为 COMMERCE_AUDIENCE 时才允许。

PartnerAudienceSource

合作伙伴受众群体来源。

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

PartnerLink

所有者账号与合作伙伴账号之间的合作伙伴关联。

字段
name	string 标识符。合作伙伴链接的名称。格式：accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}
partner_link_id	string 仅限输出。合作伙伴链接 ID。
owning_account	ProductAccount 必需。授予合作伙伴账号访问权限的拥有账号。
partner_account	ProductAccount 必需。获得所有者账号授予的访问权限的合作伙伴账号。

PpidData

发布商提供的标识符数据，用于保存 PPID。必须至少提供一个 ppid。

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

字段
ppids[]	string 必需。用户的一组由发布商提供的标识符。

ProcessingErrorReason

处理错误原因。

枚举
PROCESSING_ERROR_REASON_UNSPECIFIED	处理错误原因未知。
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE	自定义变量无效。
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED	自定义变量的状态为“未启用”。
PROCESSING_ERROR_REASON_EVENT_TOO_OLD	相应转化时间早于支持的最早时间。
PROCESSING_ERROR_REASON_DENIED_CONSENT	用户或广告客户在默认设置中拒绝使用广告用户数据。
PROCESSING_ERROR_REASON_NO_CONSENT	广告客户未针对 Google 广告核心平台服务提供第三方同意声明。
PROCESSING_ERROR_REASON_UNKNOWN_CONSENT	无法确定相应用户的总体意见征求情况（根据行级意见征求情况、请求级意见征求情况和账号设置确定）
PROCESSING_ERROR_REASON_DUPLICATE_GCLID	系统中已存在 GCLID 和转化时间均相同的转化。
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID	已上传具有相同订单 ID 和转化操作组合的转化。
PROCESSING_ERROR_REASON_INVALID_GBRAID	无法解码 GBRAID。
PROCESSING_ERROR_REASON_INVALID_GCLID	无法对 Google 点击 ID 进行解码。
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID	商家 ID 包含非数字字符。
PROCESSING_ERROR_REASON_INVALID_WBRAID	无法解码 wbraid。
PROCESSING_ERROR_REASON_INTERNAL_ERROR	内部错误。
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED	目标账号中未签署增强型转化条款。
PROCESSING_ERROR_REASON_INVALID_EVENT	相应活动无效。
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS	匹配的交易次数低于最低阈值。
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS	交易金额低于最低阈值。
PROCESSING_ERROR_REASON_INVALID_FORMAT	活动格式有误。
PROCESSING_ERROR_REASON_DECRYPTION_ERROR	相应事件存在解密错误。
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR	未能成功解密 DEK。
PROCESSING_ERROR_REASON_INVALID_WIP	WIP 的格式不正确或 WIP 不存在。
PROCESSING_ERROR_REASON_INVALID_KEK	KEK 无法解密数据，因为它是错误的 KEK，或者它不存在。
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED	WIP 无法使用，因为它被其证明条件拒绝。
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED	系统没有访问 KEK 所需的权限。
PROCESSING_ERROR_REASON_AWS_AUTH_FAILED	系统未能通过 AWS 验证身份。
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR	未能使用 DEK 解密 UserIdentifier 数据。
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER	用户尝试提取的事件包含的广告标识符并非来自操作账号的广告。

ProcessingWarningReason

处理警告原因。

枚举
PROCESSING_WARNING_REASON_UNSPECIFIED	处理警告原因未知。
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED	系统没有访问 KEK 所需的权限。
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR	未能成功解密 DEK。
PROCESSING_WARNING_REASON_DECRYPTION_ERROR	相应事件存在解密错误。
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED	WIP 无法使用，因为它被其证明条件拒绝。
PROCESSING_WARNING_REASON_INVALID_WIP	WIP 的格式不正确或 WIP 不存在。
PROCESSING_WARNING_REASON_INVALID_KEK	KEK 无法解密数据，因为它是错误的 KEK，或者它不存在。
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR	未能使用 DEK 解密 UserIdentifier 数据。
PROCESSING_WARNING_REASON_INTERNAL_ERROR	内部错误。
PROCESSING_WARNING_REASON_AWS_AUTH_FAILED	系统未能通过 AWS 验证身份。

产品

此项已弃用！

已弃用。请改用 AccountType。表示特定的 Google 产品。

枚举
PRODUCT_UNSPECIFIED	未指定产品。不应使用此值。
GOOGLE_ADS	Google Ads。
DISPLAY_VIDEO_PARTNER	Display & Video 360 合作伙伴。
DISPLAY_VIDEO_ADVERTISER	Display & Video 360 广告客户。
DATA_PARTNER	数据合作伙伴。

ProductAccount

表示特定账号。

字段
product (deprecated)	Product 此项已弃用！ 已弃用。请改用 account_type。
account_id	string 必需。账号的 ID。例如，您的 Google Ads 账号 ID。
account_type	AccountType 可选。账号类型。例如，GOOGLE_ADS。必须提供 account_type 或已弃用的 product。如果两者都设置了，则值必须一致。

AccountType

表示 Google 账号类型。用于查找账号和目的地。

枚举
ACCOUNT_TYPE_UNSPECIFIED	未指定产品。不应使用此值。
GOOGLE_ADS	Google Ads。
DISPLAY_VIDEO_PARTNER	Display & Video 360 合作伙伴。
DISPLAY_VIDEO_ADVERTISER	Display & Video 360 广告客户。
DATA_PARTNER	数据合作伙伴。
GOOGLE_ANALYTICS_PROPERTY	Google Analytics。
GOOGLE_AD_MANAGER_AUDIENCE_LINK	Google Ad Manager 受众群体关联。

PseudonymousIdInfo

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

字段
sync_status	SyncStatus 仅限输出。用户名单的同步状态。
billable_record_count	int64 可选。不可变。可结算记录（例如，已上传或匹配）的数量。

SyncStatus

用户名单的同步状态。

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

RemoveAudienceMembersRequest

请求从指定的目标平台中的受众群体中移除用户。返回 RemoveAudienceMembersResponse。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
destinations[]	Destination 必需。要从中移除用户的目的地列表。
audience_members[]	AudienceMember 必需。要移除的用户列表。
validate_only	bool 可选。用于测试目的。如果为 true，则系统会验证请求，但不会执行请求。仅返回错误，不返回结果。
encoding	Encoding 可选。上传 UserData 文件时必须填写该字段。用户标识符的编码类型。仅适用于加密用户标识符的外部编码。对于非 UserData 上传，此字段会被忽略。
encryption_info	EncryptionInfo 可选。UserData 上传的加密信息。如果未设置，则假定上传的身份识别信息已进行哈希处理，但未进行加密。对于非 UserData 上传，此字段会被忽略。

RemoveAudienceMembersResponse

来自 RemoveAudienceMembersRequest 的回答。

字段
request_id	string 请求的自动生成的 ID。

RequestStatusPerDestination

每个目的地的请求状态。

字段
destination	Destination DM API 请求中的目的地。
request_status	RequestStatus 目的地的请求状态。
error_info	ErrorInfo 一种错误信息错误，包含与上传相关的错误原因和错误计数。
warning_info	WarningInfo 包含与上传相关的警告原因和警告次数的警告信息。
联合字段 status。目的地的状态。status 只能是下列其中一项：
audience_members_ingestion_status	IngestAudienceMembersStatus “纳入受众群体成员”请求的状态。
events_ingestion_status	IngestEventsStatus 提取事件请求的状态。
audience_members_removal_status	RemoveAudienceMembersStatus 移除受众群体成员请求的状态。

IngestAudienceMembersStatus

“纳入受众群体成员”请求的状态。

字段
联合字段 status。将受众群体成员数据提取到目标位置的状态。status 只能是下列其中一项：
user_data_ingestion_status	IngestUserDataStatus 用户数据提取到目标位置的状态。
mobile_data_ingestion_status	IngestMobileDataStatus 移动数据注入到目标位置的状态。
pair_data_ingestion_status	IngestPairDataStatus 配对数据注入到目标的状态。
user_id_data_ingestion_status	IngestUserIdDataStatus 用户 ID 数据提取到目标平台的状况。
ppid_data_ingestion_status	IngestPpidDataStatus 向目标位置注入 PPID 数据的状态。

IngestEventsStatus

将事件提取到目标位置的状态。

字段
record_count	int64 上传请求中发送的事件总数。包括请求中的所有事件，无论是否成功提取。

IngestMobileDataStatus

移动数据提取到包含与提取相关的统计信息的目标位置的状态。

字段
record_count	int64 上传请求中针对相应目标平台发送的受众群体成员总数。包括请求中的所有受众群体成员，无论是否成功提取。
mobile_id_count	int64 上传请求中为目标位置发送的移动设备 ID 总数。包括请求中的所有移动设备 ID，无论是否成功提取。

IngestPairDataStatus

配对数据提取到目标位置的状态，其中包含与提取相关的统计信息。

字段
record_count	int64 上传请求中针对相应目标平台发送的受众群体成员总数。包括请求中的所有受众群体成员，无论是否成功提取。
pair_id_count	int64 上传请求中针对相应目的地的配对 ID 总数。包括请求中的所有配对 ID，无论是否成功提取。

IngestPpidDataStatus

将 ppid 数据提取到包含与提取相关的统计信息的目标位置的状态。

字段
record_count	int64 上传请求中针对相应目标平台发送的受众群体成员总数。包括请求中的所有受众群体成员，无论是否成功提取。
ppid_count	int64 上传请求中针对相应目的地发送的 ppid 总数。包括请求中的所有 ppids，无论是否成功提取。

IngestUserDataStatus

用户数据提取到目标位置的状态，其中包含与提取相关的统计信息。

字段
record_count	int64 上传请求中针对相应目标平台发送的受众群体成员总数。包括请求中的所有受众群体成员，无论是否成功提取。
user_identifier_count	int64 上传请求中针对相应目标平台发送的用户标识符总数。包含请求中的所有用户标识符，无论是否成功提取。
upload_match_rate_range	MatchRateRange 上传内容的匹配率范围。

IngestUserIdDataStatus

用户 ID 数据提取到包含与提取相关的统计信息的目标的提取状态。

字段
record_count	int64 上传请求中针对相应目标平台发送的受众群体成员总数。包括请求中的所有受众群体成员，无论是否成功提取。
user_id_count	int64 上传请求中针对相应目标平台发送的用户 ID 总数。包含请求中的所有用户 ID，无论这些 ID 是否已成功提取。

RemoveAudienceMembersStatus

移除受众群体成员请求的状态。

字段
联合字段 status。从目标位置移除受众群体成员的状态。status 只能是下列其中一项：
user_data_removal_status	RemoveUserDataStatus 用户数据从目标位置移除的状态。
mobile_data_removal_status	RemoveMobileDataStatus 从目的地移除移动数据的状态。
pair_data_removal_status	RemovePairDataStatus 从目的地移除配对数据的状态。
user_id_data_removal_status	RemoveUserIdDataStatus 用户 ID 数据从目标位置移除的状态。
ppid_data_removal_status	RemovePpidDataStatus 从目标位置移除 ppid 数据的状态。

RemoveMobileDataStatus

从目的地移除移动数据的状态。

字段
record_count	int64 移除请求中发送的受众群体成员总数。包括请求中的所有受众群体成员，无论是否已成功移除。
mobile_id_count	int64 移除请求中发送的移动设备 ID 总数。包含请求中的所有移动 ID，无论是否已成功移除。

RemovePairDataStatus

从目的地移除配对数据的状态。

字段
record_count	int64 移除请求中发送的受众群体成员总数。包括请求中的所有受众群体成员，无论是否已成功移除。
pair_id_count	int64 移除请求中发送的配对 ID 总数。包含请求中的所有配对 ID，无论是否已成功移除。

RemovePpidDataStatus

从目标位置移除 ppid 数据的状态。

字段
record_count	int64 移除请求中发送的受众群体成员总数。包括请求中的所有受众群体成员，无论是否已成功移除。
ppid_count	int64 移除请求中发送的 ppid 总数。包括请求中的所有 ppid，无论是否已成功移除。

RemoveUserDataStatus

用户数据从目标位置移除的状态。

字段
record_count	int64 移除请求中发送的受众群体成员总数。包括请求中的所有受众群体成员，无论是否已成功移除。
user_identifier_count	int64 移除请求中发送的用户标识符总数。包含请求中的所有用户标识符，无论是否已成功移除。

RemoveUserIdDataStatus

用户 ID 数据从目标位置移除的状态。

字段
record_count	int64 移除请求中发送的受众群体成员总数。包括请求中的所有受众群体成员，无论是否已成功移除。
user_id_count	int64 移除请求中发送的用户 ID 总数。包含请求中的所有用户 ID，无论是否已成功移除。

RequestStatus

请求状态。

枚举
REQUEST_STATUS_UNKNOWN	请求状态未知。
SUCCESS	请求成功。
PROCESSING	请求正在处理中。
FAILED	请求失败。
PARTIAL_SUCCESS	请求部分成功。

RetrieveInsightsRequest

针对 DM API MarketingDataInsightsService.RetrieveInsights 的请求消息

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
parent	string 必需。拥有相应用户列表的父账号。格式：accountTypes/{account_type}/accounts/{account}
baseline	Baseline 必需。所请求数据分析的基准。
user_list_id	string 必需。请求获取效果分析的用户名单 ID。

RetrieveInsightsResponse

针对 DM API MarketingDataInsightsService.RetrieveInsights 的响应消息

字段
marketing_data_insights[]	MarketingDataInsight 包含营销数据的数据洞见。

MarketingDataInsight

营销数据分析。

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

字段
dimension	AudienceInsightsDimension 数据洞见所属的维度。
attributes[]	MarketingDataInsightsAttribute 针对指定维度的值提供的数据分析。

AudienceInsightsDimension

可用于生成数据洞见的维度。

枚举
AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED	未指定。
AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN	此版本中的值未知。
AFFINITY_USER_INTEREST	一种兴趣相似的受众群体 UserInterest。
IN_MARKET_USER_INTEREST	一种有购买意向的用户兴趣。
AGE_RANGE	年龄段。
GENDER	性别。

MarketingDataInsightsAttribute

同一维度的相关属性集合的数据洞见。

字段
user_interest_id	int64 用户兴趣 ID。
lift	float 与基准相比，受众群体对属性值的升幅。范围 [0-1]。
age_range	AgeRange 提供效果提升数据的受众群体的年龄段。
gender	Gender 提供效果提升数据的受众群体的性别。

RetrieveRequestStatusRequest

请求获取针对给定请求 ID 向 DM API 发出的请求的状态。返回 RetrieveRequestStatusResponse。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
request_id	string 必需。必需。Data Manager API 请求的请求 ID。

RetrieveRequestStatusResponse

来自 RetrieveRequestStatusRequest 的回答。

字段
request_status_per_destination[]	RequestStatusPerDestination 每个目的地的请求状态列表。状态的顺序与原始请求中目的地的顺序一致。

SearchPartnerLinksRequest

用于搜索 PartnerLink 资源的请求。返回 SearchPartnerLinksResponse。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
parent	string 必需。要搜索合作伙伴链接的账号。如果未指定 filter，则返回此账号是 owning_account 或 partner_account 的所有合作伙伴链接。 格式：accountTypes/{account_type}/accounts/{account}
page_size	int32 要返回的合作伙伴链接数量上限。服务返回的值可能小于此值。如果未指定，则最多返回 10 个合作伙伴链接。最大值为 100；大于 100 的值将被强制转换为 100。
page_token	string 从之前的 SearchPartnerLinks 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时，提供给 SearchPartnerLinks 的所有其他参数必须与提供页面令牌的调用匹配。
filter	string 可选。过滤字符串。所有字段都需要位于每个条件的左侧（例如：partner_link_id = 123456789）。 支持的操作： AND = != 支持的字段： partner_link_id owning_account.account_type owning_account.account_id partner_account.account_type partner_account.account_id 示例：owning_account.account_type = "GOOGLE_ADS" OR partner_account.account_id = 987654321

SearchPartnerLinksResponse

来自 SearchPartnerLinksRequest 的回答。

字段
partner_links[]	PartnerLink 指定账号的合作伙伴链接。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

SizeInfo

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

字段
display_network_members_count	int64 仅限输出。Google 展示广告网络上相应用户名单中的估算成员数量。
search_network_members_count	int64 仅限输出。google.com 网域中相应用户名单的估计成员数量。这些是可在搜索广告系列中定位的会员。

TargetNetworkInfo

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

字段
eligible_for_display	bool 仅限输出。表示相应用户名单符合 Google 展示广告网络的要求。
eligible_for_search	bool 可选。指明相应用户名单是否符合 Google 搜索网络的要求。

TermsOfService

用户已接受/拒绝的服务条款。

字段
customer_match_terms_of_service_status	TermsOfServiceStatus 可选。目标客户匹配服务的服务条款：https://support.google.com/adspolicy/answer/6299717。在提取 UserData 或 MobileData 时，必须接受此许可。对于合作伙伴匹配用户名单，此字段不是必需的。

TermsOfServiceStatus

表示调用方接受或拒绝服务条款的决定。

枚举
TERMS_OF_SERVICE_STATUS_UNSPECIFIED	未指定。
ACCEPTED	表示来电者已选择接受服务条款的状态。
REJECTED	状态，表示调用方已选择拒绝服务条款。

UpdateUserListDirectLicenseRequest

请求更新 UserListDirectLicense 资源。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
user_list_direct_license	UserListDirectLicense 必需。许可的 name 字段用于标识要更新的许可。
update_mask	FieldMask 可选。要更新的字段列表。 不支持特殊字符 *，如果使用该字符，系统会抛出 INVALID_UPDATE_MASK 错误。

UpdateUserListGlobalLicenseRequest

请求更新 UserListGlobalLicense 资源。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
user_list_global_license	UserListGlobalLicense 必需。许可的 name 字段用于标识要更新的许可。
update_mask	FieldMask 可选。要更新的字段列表。 不支持特殊字符 *，如果使用该字符，系统会抛出 INVALID_UPDATE_MASK 错误。

UpdateUserListRequest

针对 UpdateUserList 的请求消息。

您可以在 REST API 探索器中试用此方法：

使用 REST 尝试

字段
user_list	UserList 必需。要更新的用户列表。 用户列表的 name 字段用于标识要更新的用户列表。格式：accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
update_mask	FieldMask 可选。要更新的字段列表。
validate_only	bool 可选。如果为 true，则验证请求，但不执行请求。

UserData

用于识别用户的数据。必须至少提供一个标识符。

字段
user_identifiers[]	UserIdentifier 必需。用户的标识符。您可以提供同一类型数据的多个实例（例如，多个电子邮件地址）。为了提高成功匹配的几率，请尽可能提供更多标识符。在单个 AudienceMember 或 Event 中最多可以提供 10 个 userIdentifiers。

UserIdData

包含用户 ID 的 User-ID 数据。

字段
user_id	string 必需。广告客户定义的用户唯一标识符。

UserIdInfo

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

字段
data_source_type	DataSourceType 可选。不可变。上传数据的来源。

UserIdentifier

用户的单个标识符。

字段
联合字段 identifier。必须指定一个。identifier 只能是下列其中一项：
email_address	string 使用 SHA-256 哈希函数在标准化后对电子邮件地址进行哈希处理。
phone_number	string 使用 SHA-256 哈希函数在标准化（E164 标准）后进行哈希处理的电话号码。
address	AddressInfo 用户地址的已知组成部分。用于保存一次性匹配的标识符分组。

UserList

用户列表资源。

字段
name	string 标识符。用户列表的资源名称。格式：accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
id	int64 仅限输出。用户名单的唯一 ID。
read_only	bool 仅限输出。用于指示用户是否可以修改列表的选项。
membership_duration	Duration 可选。用户在用户列表中的保留时长。有效时长必须是 24 小时（86400 秒）的整数倍。如果提供的值不是 24 小时的精确倍数，则会导致 INVALID_ARGUMENT 错误。
access_reason	AccessReason 仅限输出。相应账号被授予名单访问权限的原因。
size_info	SizeInfo 仅限输出。相应用户名单在不同目标广告网络中的估计成员数量。
target_network_info	TargetNetworkInfo 可选。不同目标广告网络的资格要求信息。
display_name	string 必需。用户列表的显示名称。
description	string 可选。用户名单的说明。
membership_status	MembershipStatus 可选。相应用户名单的成员资格状态。
integration_code	string 可选。外部系统中的 ID。用户列表卖家使用此参数来关联其系统中的 ID。
closing_reason	ClosingReason 仅限输出。相应用户名单成员资格状态处于关闭状态的原因。
account_access_status	AccessStatus 可选。指示相应分享是否仍处于启用状态。当用户列表与账号共享时，此字段会设置为 ENABLED。之后，用户名单所有者可以决定撤消共享，并将其设为DISABLED。
联合字段 user_list_info。有关用户列表的其他信息。user_list_info 只能是下列其中一项：
ingested_user_list_info	IngestedUserListInfo 可选。表示由用户提取的数据填充的用户列表。

AccessReason

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

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

AccessStatus

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

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

ClosingReason

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

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

MembershipStatus

用户名单的状态。

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

UserListDirectLicense

用户列表直接许可。

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

字段
name	string 标识符。用户名单直接许可的资源名称。
user_list_display_name	string 仅限输出。正在许可的用户名单的名称。 此字段为只读字段。
client_account_display_name	string 仅限输出。用户名单的许可对象客户的名称。 此字段为只读字段。
pricing	UserListLicensePricing 可选。UserListDirectLicense 定价。
historical_pricings[]	UserListLicensePricing 仅限输出。相应用户名单许可的价格历史记录。 此字段为只读字段。
metrics	UserListLicenseMetrics 仅限输出。与此许可相关的指标 此字段为只读字段，仅当在 ListUserListDirectLicenses 调用中设置了开始日期和结束日期时，系统才会填充此字段
user_list_id	int64 不可变。正在许可的用户列表的 ID。
client_account_type	UserListLicenseClientAccountType 不可变。用户名单获得许可的客户的账号类型。
client_account_id	int64 不可变。用户名单的许可对象客户的 ID。
status	UserListLicenseStatus 可选。UserListDirectLicense 的状态 - ENABLED 或 DISABLED。

UserListGlobalLicense

用户列表全局许可。

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

字段
name	string 标识符。用户名单全局许可的资源名称。
user_list_display_name	string 仅限输出。正在许可的用户名单的名称。 此字段为只读字段。
pricing	UserListLicensePricing 可选。UserListGlobalLicense 定价。
historical_pricings[]	UserListLicensePricing 仅限输出。相应用户名单许可的价格历史记录。 此字段为只读字段。
metrics	UserListLicenseMetrics 仅限输出。与此许可相关的指标 此字段为只读字段，仅当在 ListUserListGlobalLicenses 调用中设置了开始日期和结束日期时，系统才会填充此字段
user_list_id	int64 不可变。正在许可的用户列表的 ID。
license_type	UserListGlobalLicenseType 不可变。用户名单的许可对象客户的产品类型。
status	UserListLicenseStatus 可选。UserListGlobalLicense 的状态 - ENABLED 或 DISABLED。

UserListGlobalLicenseCustomerInfo

有关用户名单全局许可的客户的信息。当客户购买全球许可时，系统会自动创建此许可。

字段
name	string 标识符。用户名单全球许可客户的资源名称。
user_list_id	int64 仅限输出。正在许可的用户列表的 ID。
user_list_display_name	string 仅限输出。正在许可的用户名单的名称。
license_type	UserListGlobalLicenseType 仅限输出。用户名单的许可对象客户的产品类型。
status	UserListLicenseStatus 仅限输出。UserListDirectLicense 的状态 - ENABLED 或 DISABLED。
pricing	UserListLicensePricing 仅限输出。UserListDirectLicense 定价。
client_account_type	UserListLicenseClientAccountType 仅限输出。用户名单的许可对象客户的产品类型。
client_account_id	int64 仅限输出。用户名单的许可对象客户的 ID。
client_account_display_name	string 仅限输出。用户名单的许可对象客户的名称。
historical_pricings[]	UserListLicensePricing 仅限输出。相应用户名单许可的价格历史记录。
metrics	UserListLicenseMetrics 仅限输出。与此许可相关的指标 只有在 ListUserListGlobalLicenseCustomerInfos 调用中设置了开始日期和结束日期时，系统才会填充此字段。

UserListGlobalLicenseType

用户列表全局许可类型。

枚举
USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED	未指定。
USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER	转销商许可。
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE	DataMart Sell Side 许可。
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE	DataMart Buy Side 许可。

UserListLicenseClientAccountType

用户名单许可的客户账号的可能产品。

枚举
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN	未知。
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS	Google Ads 客户。
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER	Display & Video 360 合作伙伴。
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER	Display & Video 360 广告客户。
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK	Google Ad Manager 受众群体关联。

UserListLicenseMetrics

与用户名单许可相关的指标。

字段
click_count	int64 仅限输出。用户名单许可的点击次数。
impression_count	int64 仅限输出。用户名单许可的展示次数。
revenue_usd_micros	int64 仅限输出。用户名单许可的收入（以百万分之一美元为单位）。
start_date	int64 仅限输出。指标的开始日期（含），格式为 YYYYMMDD。例如，20260102 表示 2026 年 1 月 2 日。如果过滤条件中使用了 end_date，则还必须使用 start_date。如果过滤条件中未包含 start_date 和 end_date，则响应中不会填充 UserListLicenseMetrics 字段。
end_date	int64 仅限输出。指标的结束日期（含），格式为 YYYYMMDD。例如，20260102 表示 2026 年 1 月 2 日。如果过滤条件中使用了 start_date，则还必须使用 end_date。如果过滤条件中未包含 start_date 和 end_date，则响应中不会填充 UserListLicenseMetrics 字段。

UserListLicensePricing

用户名单许可定价。

字段
pricing_id	int64 仅限输出。相应价格的 ID。
start_time	Timestamp 仅限输出。定价的开始时间。
end_time	Timestamp 可选。价格的结束时间。
pricing_active	bool 仅限输出。相应价格是否有效。
buyer_approval_state	UserListPricingBuyerApprovalState 仅限输出。相应价格的买方审批状态。 此字段为只读字段。
cost_micros	int64 可选。与模型关联的费用，以微单位 (10^-6) 表示，币种由 currency_code 字段指定。例如，如果 currency_code 为 USD，则 2000000 表示 2 美元。
currency_code	string 可选。指定费用和 max_cost 所用的币种。必须是 ISO 4217 中定义的三位字母货币代码。
cost_type	UserListPricingCostType 不可变。相应价格的费用类型。 只能在 create 操作中设置。无法针对现有许可进行更新。
max_cost_micros	int64 可选。使用 MEDIA_SHARE 费用类型时，商务受众群体可产生的最高每千次展示费用。该值以微单位 (10^-6) 表示，并以 currency_code 字段指定的币种表示。例如，如果 currency_code 为 USD，则 2000000 表示 2 美元。 仅当 cost_type 为 MEDIA_SHARE 时，此字段才相关。如果 cost_type 不是 MEDIA_SHARE，但设置了此字段，系统会返回 MAX_COST_NOT_ALLOWED 错误。如果未设置或设置为 0，则没有上限。

UserListPricingBuyerApprovalState

用户名单定价买方审批状态。

枚举
USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED	未指定。
PENDING	用户名单客户尚未接受用户名单所有者设置的定价条款。
APPROVED	用户名单客户已接受用户名单所有者设置的定价条款。
REJECTED	用户名单客户拒绝了用户名单所有者设置的定价条款。

UserListPricingCostType

用户名单定价费用类型。

枚举
USER_LIST_PRICING_COST_TYPE_UNSPECIFIED	未指定。
CPC	每次点击费用。
CPM	每千次展示费用。
MEDIA_SHARE	媒体分享。

UserListLicenseStatus

用户名单许可状态。

枚举
USER_LIST_LICENSE_STATUS_UNSPECIFIED	未知。
USER_LIST_LICENSE_STATUS_ENABLED	有效状态 - 用户名单仍在获得许可。
USER_LIST_LICENSE_STATUS_DISABLED	“非活跃”状态 - 用户名单不再获得许可。

UserProperties

广告客户在事件发生时评估的用户相关信息。如需了解详情，请访问 https://support.google.com/google-ads/answer/14007601。

字段
customer_type	CustomerType 可选。与活动关联的客户的类型。
customer_value_bucket	CustomerValueBucket 可选。广告客户评估的客户价值。
additional_user_properties[]	UserProperty 可选。与相应事件关联的用户的任何其他用户属性的存储分区。

UserProperty

与相应事件关联的用户的任何其他用户属性的存储分区。

字段
property_name	string 必需。要使用的用户属性的名称。
value	string 必需。要使用的用户属性值的字符串表示形式。

WarningCount

指定警告原因的警告次数。

字段
record_count	int64 具有警告的记录数。
reason	ProcessingWarningReason 警告原因。

WarningInfo

每种警告类型的警告数量。

字段
warning_counts[]	WarningCount 警告列表以及每个警告原因的计数。