此页面由 Cloud Translation API 翻译。

Package google.ads.datamanager.v1

索引

IngestionService（接口）
AdIdentifiers（消息）
AddressInfo（消息）
AudienceMember（消息）
CartData（消息）
Consent（消息）
ConsentStatus（枚举）
CustomVariable（消息）
CustomerType（枚举）
CustomerValueBucket（枚举）
Destination（消息）
DeviceInfo（消息）
Encoding（枚举）
EncryptionInfo（消息）
ErrorCount（消息）
ErrorInfo（消息）
ErrorReason（枚举）
Event（消息）
EventSource（枚举）
ExperimentalField（消息）
GcpWrappedKeyInfo（消息）
GcpWrappedKeyInfo.KeyType（枚举）
IngestAudienceMembersRequest（消息）
IngestAudienceMembersResponse（消息）
IngestEventsRequest（消息）
IngestEventsResponse（消息）
Item（消息）
MatchRateRange（枚举）
MobileData（消息）
PairData（消息）
ProcessingErrorReason（枚举）
ProcessingWarningReason（枚举）
Product（枚举）（已弃用）
ProductAccount（消息）
ProductAccount.AccountType（枚举）
RemoveAudienceMembersRequest（消息）
RemoveAudienceMembersResponse（消息）
RequestStatusPerDestination（消息）
RequestStatusPerDestination.IngestAudienceMembersStatus（消息）
RequestStatusPerDestination.IngestEventsStatus（消息）
RequestStatusPerDestination.IngestMobileDataStatus（消息）
RequestStatusPerDestination.IngestPairDataStatus（消息）
RequestStatusPerDestination.IngestUserDataStatus（消息）
RequestStatusPerDestination.RemoveAudienceMembersStatus（消息）
RequestStatusPerDestination.RemoveMobileDataStatus（消息）
RequestStatusPerDestination.RemovePairDataStatus（消息）
RequestStatusPerDestination.RemoveUserDataStatus（消息）
RequestStatusPerDestination.RequestStatus（枚举）
RetrieveRequestStatusRequest（消息）
RetrieveRequestStatusResponse（消息）
TermsOfService（消息）
TermsOfServiceStatus（枚举）
UserData（消息）
UserIdentifier（消息）
UserProperties（消息）
WarningCount（消息）
WarningInfo（消息）

IngestionService

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

IngestAudienceMembers

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

rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse)

将 AudienceMember 资源的列表上传到提供的 Destination。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/datamanager

IngestEvents

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

rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse)

从提供的 Destination 上传 Event 资源的列表。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/datamanager

RemoveAudienceMembers

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

rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)

从提供的 Destination 中移除 AudienceMember 资源列表。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/datamanager

RetrieveRequestStatus

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

rpc RetrieveRequestStatus(RetrieveRequestStatusRequest) returns (RetrieveRequestStatusResponse)

获取指定请求 ID 的请求的状态。

授权范围

需要以下 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` 必需。用户地址的邮政编码。

AudienceMember

要操作的观众成员。

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

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` 可选。与活动关联的商品列表。

字段

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

ad_user_data

ConsentStatus

可选。表示用户是否同意使用广告用户数据。

ad_personalization

ConsentStatus

可选。表示用户是否同意接收个性化广告。

ConsentStatus

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

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

CustomVariable

广告转化的自定义变量。

字段

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

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`	客户是高价值客户。

目的地

您要将数据发送到的 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 政策要求的情况下征得用户同意。如需了解详情，请参阅线下转化数据导入简介页面。

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 封装密钥信息。

联合字段 wrapped_key。用于加密数据的封装密钥。wrapped_key 只能是下列其中一项：

gcp_wrapped_key_info

GcpWrappedKeyInfo

Google Cloud Platform 封装密钥信息。

ErrorCount

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

字段

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

record_count

int64

因特定原因而未能上传的记录数。

reason

ProcessingErrorReason

失败记录的错误原因。

错误信息

每种类型的错误数量。

字段

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

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`	请求中的两个或更多目的地具有相同的参考。
`NO_IDENTIFIERS_PROVIDED`	事件数据不包含用户标识符或广告标识符。

事件

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

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

EventSource

事件的来源。

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

ExperimentalField

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

字段

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

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}”的格式。
`encrypted_dek`	`string` 必需。base64 编码的加密数据加密密钥。

KeyType

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

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

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。

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。

request_id

string

请求的自动生成的 ID。

项

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

字段

字段
`merchant_product_id`	`string` 可选。Merchant Center 账号中的商品 ID。
`quantity`	`int64` 可选。与相应事件相关联的相应商品的数量。
`unit_price`	`double` 可选。单价（不含税、运费及任何交易级折扣）。

merchant_product_id

string

可选。Merchant Center 账号中的商品 ID。

quantity

int64

可选。与相应事件相关联的相应商品的数量。

unit_price

double

可选。单价（不含税、运费及任何交易级折扣）。

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`。

mobile_ids[]

string

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

PairData

相应受众群体的 PAIR ID。至少需要一个 PAIR ID。

字段

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

pair_ids[]

string

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

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_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`	内部错误。

产品

已弃用。请改用 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`。如果两者都设置了，则值必须一致。

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`	数据合作伙伴。

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。

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` 配对数据注入到目标位置的状态。

IngestEventsStatus

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

字段

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

record_count

int64

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

IngestMobileDataStatus

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

字段

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

record_count

int64

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

mobile_id_count

int64

上传请求中为相应目标位置发送的移动设备 ID 总数。包括请求中的所有移动设备 ID，无论是否成功提取。

IngestPairDataStatus

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

字段

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

record_count

int64

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

pair_id_count

int64

上传请求中针对相应目的地的配对 ID 总数。包括请求中的所有配对 ID，无论是否成功提取。

IngestUserDataStatus

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

字段

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

record_count

int64

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

user_identifier_count

int64

上传请求中针对相应目标平台发送的用户标识符总数。包含请求中的所有用户标识符，无论是否成功提取。

upload_match_rate_range

MatchRateRange

上传的匹配率范围。

RemoveAudienceMembersStatus

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

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

RemoveMobileDataStatus

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

字段

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

record_count

int64

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

mobile_id_count

int64

移除要求中发送的移动设备 ID 总数。包含请求中的所有移动 ID，无论是否已成功移除。

RemovePairDataStatus

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

字段

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

record_count

int64

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

pair_id_count

int64

移除请求中发送的配对 ID 总数。包括请求中的所有配对 ID，无论是否已成功移除。

RemoveUserDataStatus

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

字段

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

record_count

int64

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

user_identifier_count

int64

移除请求中发送的用户标识符总数。包含请求中的所有用户标识符，无论是否已成功移除。

RequestStatus

请求状态。

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

RetrieveRequestStatusRequest

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

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

使用 REST 尝试

字段

request_id

string

必需。必需。Data Manager API 请求的请求 ID。

RetrieveRequestStatusResponse

来自 RetrieveRequestStatusRequest 的回答。

字段

request_status_per_destination[]

RequestStatusPerDestination

每个目的地的请求状态列表。状态的顺序与原始请求中目的地的顺序一致。

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`	状态，表示调用方已选择拒绝服务条款。

UserData

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

字段

user_identifiers[]

UserIdentifier

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

UserIdentifier

用户的单个标识符。

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

UserProperties

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

字段

customer_type

CustomerType

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

customer_value_bucket

CustomerValueBucket

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

WarningCount

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

字段

record_count

int64

具有警告的记录数。

reason

ProcessingWarningReason

警告原因。

WarningInfo

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

字段

warning_counts[]

WarningCount

警告列表以及每个警告原因的计数。

Package google.ads.datamanager.v1 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

索引

IngestionService

AdIdentifiers

AddressInfo

AudienceMember

CartData

同意

ConsentStatus

CustomVariable

CustomerType

CustomerValueBucket

目的地

DeviceInfo

编码

EncryptionInfo

ErrorCount

错误信息

ErrorReason

事件

EventSource

ExperimentalField

GcpWrappedKeyInfo

KeyType

IngestAudienceMembersRequest

IngestAudienceMembersResponse

IngestEventsRequest

IngestEventsResponse

项

MatchRateRange

MobileData

PairData

ProcessingErrorReason

ProcessingWarningReason

产品

ProductAccount

AccountType

RemoveAudienceMembersRequest

RemoveAudienceMembersResponse

RequestStatusPerDestination

IngestAudienceMembersStatus

IngestEventsStatus

IngestMobileDataStatus

IngestPairDataStatus

IngestUserDataStatus

RemoveAudienceMembersStatus

RemoveMobileDataStatus

RemovePairDataStatus

RemoveUserDataStatus

RequestStatus

RetrieveRequestStatusRequest

RetrieveRequestStatusResponse

TermsOfService

TermsOfServiceStatus

UserData

UserIdentifier

UserProperties

WarningCount

WarningInfo

Package google.ads.datamanager.v1