Package google.ads.datamanager.v1

索引

• IngestionService (介面)
• AdIdentifiers (訊息)
• AddressInfo (訊息)
• AudienceMember (訊息)
• AwsWrappedKeyInfo (訊息)
• AwsWrappedKeyInfo.KeyType (列舉)
• CartData (訊息)
• Consent (訊息)
• ConsentStatus (列舉)
• CustomVariable (訊息)
• CustomerType (列舉)
• CustomerValueBucket (列舉)
• Destination (訊息)
• DeviceInfo (訊息)
• Encoding (列舉)
• EncryptionInfo (訊息)
• ErrorCount (訊息)
• ErrorInfo (訊息)
• ErrorReason (列舉)
• Event (訊息)
• EventParameter (訊息)
• EventSource (列舉)
• ExperimentalField (訊息)
• GcpWrappedKeyInfo (訊息)
• GcpWrappedKeyInfo.KeyType (列舉)
• IngestAudienceMembersRequest (訊息)
• IngestAudienceMembersResponse (訊息)
• IngestEventsRequest (訊息)
• IngestEventsResponse (訊息)
• Item (訊息)
• ItemParameter (訊息)
• 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 (訊息)
• 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

AdIdentifiers

用於比對轉換事件與其他線上活動 (例如廣告點擊) 的 ID 和其他資訊。

欄位
session_attributes	string (選用步驟) 用於事件歸因和模擬的工作階段屬性。
gclid	string (選用步驟) 與這個事件相關聯的 Google 點擊 ID (gclid)。
gbraid	string (選用步驟) 與應用程式事件相關聯的點擊 ID，且點擊來自 iOS 裝置 (iOS14 以上版本)。
wbraid	string (選用步驟) 與網站事件相關聯的點擊 ID，且點擊來自 iOS 裝置 (iOS14 以上版本)。
landing_page_device_info	DeviceInfo (選用步驟) 使用者與廣告互動後，抵達廣告主網站時所用裝置的相關資訊 (如有)。

AddressInfo

使用者的地址資訊。

欄位
given_name	string 必要欄位。使用者名字 (不含標點符號、開頭或結尾的空白字元，且須全部小寫)，並以 SHA-256 雜湊處理。
family_name	string 必要欄位。使用者姓氏，須為全小寫，不得包含標點符號，開頭或結尾不得有空白字元，並以 SHA-256 雜湊處理。
region_code	string 必要欄位。使用者地址的 ISO-3166-1 alpha-2 二位字母區域代碼。
postal_code	string 必要欄位。使用者的地址郵遞區號。

AudienceMember

要接受手術的觀眾。

欄位
destination_references[]	string (選用步驟) 定義要將目標對象成員傳送至哪個 Destination。
consent	Consent (選用步驟) 使用者的同意聲明設定。
聯集欄位 data。要處理的識別資料類型。data 只能是下列其中一項：
user_data	UserData 可識別使用者的使用者提供資料。
pair_data	PairData 發布商及廣告主使用者身分資料比對 (PAIR) ID。
mobile_data	MobileData 可識別使用者行動裝置的資料。

AwsWrappedKeyInfo

由 AWS KMS 金鑰包裝的資料加密金鑰。

欄位
key_type	KeyType 必要欄位。用於加密資料的演算法類型。
role_arn	string 必要欄位。要代入的 IAM 角色 Amazon Resource Name，用於 KMS 解密存取權。格式應為「arn:{partition}:iam::{account_id}:role/{role_name}」
kek_uri	string 必要欄位。用於解密 DEK 的 AWS KMS 金鑰 URI。格式應為「arn:{partition}:kms:{region}:{account_id}:key/{key_id}」
encrypted_dek	string 必要欄位。Base64 編碼的加密資料加密金鑰。

KeyType

用於加密資料的演算法類型。

列舉
KEY_TYPE_UNSPECIFIED	未指定金鑰類型。請一律不使用這個值。
XCHACHA20_POLY1305	演算法 XChaCha20-Poly1305

CartData

與事件相關聯的購物車資料。

欄位
merchant_id	string (選用步驟) 與商品相關聯的 Merchant Center ID。
merchant_feed_label	string (選用步驟) 與商品動態饋給相關聯的 Merchant Center 動態饋給標籤。
merchant_feed_language_code	string (選用步驟) 與商品上傳目的地 Merchant Center 動態饋給相關聯的 ISO 639-1 語言代碼。
transaction_discount	double (選用步驟) 與交易相關的所有折扣總和。
items[]	Item (選用步驟) 與活動相關聯的項目清單。

同意聲明

使用者的數位市場法 (DMA) 同意聲明設定。

欄位
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。

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 不支援為歐洲經濟區、英國或瑞士的使用者比對 IP 位址。加入邏輯，有條件地排除分享來自這些地區使用者的 IP 位址，並確保提供清楚詳盡的資訊，讓使用者瞭解網站、應用程式及其他資源的資料收集活動，並在法律或任何適用的 Google 政策要求時，徵得使用者同意。詳情請參閱「關於離線轉換匯入」頁面。

編碼

已雜湊處理的識別資訊編碼類型。

列舉
ENCODING_UNSPECIFIED	未指定編碼類型。請一律不使用這個值。
HEX	十六進位編碼。
BASE64	Base64 編碼。

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 失敗記錄的錯誤原因。

ErrorInfo

各類型錯誤的錯誤計數。

欄位
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 個使用者 ID。
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	事件資料不含使用者 ID 或廣告 ID。
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	要求中的清單元素過多。

事件

代表使用者與廣告主網站或應用程式的互動事件。

欄位
destination_references[]	string (選用步驟) 用來判斷目的地的參照字串。如果留空，系統會將事件傳送至要求中的所有 destinations。
transaction_id	string (選用步驟) 這項事件的專屬 ID。使用多個資料來源追蹤轉換時，必須提供這項資訊。
event_timestamp	Timestamp 必要欄位。事件發生的時間。
last_updated_timestamp	Timestamp (選用步驟) 活動上次更新的時間。
user_data	UserData (選用步驟) 使用者提供的資料片段，代表與事件相關聯的使用者。
consent	Consent (選用步驟) 相關聯使用者是否已提供不同類型的同意聲明。
ad_identifiers	AdIdentifiers (選用步驟) 用於比對轉換事件與其他線上活動 (例如廣告點擊) 的 ID 和其他資訊。
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 (選用步驟) 廣告主評估事件發生時的使用者資訊。
event_name	string (選用步驟) 活動名稱。這是 GA4 事件的必填欄位。
client_id	string (選用步驟) 這個 GA4 網站資料串流的網站用戶端使用者例項專屬 ID。
user_id	string (選用步驟) 廣告主定義的使用者專屬 ID。
additional_event_parameters[]	EventParameter (選用步驟) 要納入事件的任何事件參數，這些參數尚未透過其他結構化欄位指定。

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}」。
encrypted_dek	string 必要欄位。Base64 編碼的加密資料加密金鑰。

KeyType

用於加密資料的演算法類型。

列舉
KEY_TYPE_UNSPECIFIED	未指定金鑰類型。請一律不使用這個值。
XCHACHA20_POLY1305	演算法 XChaCha20-Poly1305

IngestAudienceMembersRequest

要求將目標對象成員上傳至指定目的地。傳回 IngestAudienceMembersResponse。

您可以在 REST API 探索工具中試用這個方法：

使用 REST 試試看

欄位
destinations[]	Destination 必要欄位。要將目標對象成員帶往的到達網頁清單。
audience_members[]	AudienceMember 必要欄位。要傳送至指定目的地的使用者清單。單一要求最多可傳送 10000 個 AudienceMember 資源。
consent	Consent (選用步驟) 要求層級的同意聲明，適用於要求中的所有使用者。使用者層級同意聲明會覆寫要求層級同意聲明，且可在每個 AudienceMember 中指定。
validate_only	bool (選用步驟) 僅供測試用途。如果為 true，系統會驗證要求，但不會執行。系統只會傳回錯誤，不會傳回結果。
encoding	Encoding (選用步驟) 上傳 UserData 時必須提供這項資訊。使用者 ID 的編碼類型。如果是經過雜湊處理的使用者 ID，這是指雜湊字串的編碼類型。如果是加密的雜湊使用者 ID，這是外部加密字串的編碼類型，但不一定是內部雜湊字串的編碼類型，也就是說，內部雜湊字串的編碼方式可能與外部加密字串不同。如果上傳的不是 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 必要欄位。要傳送至指定目的地的事件清單。單一要求最多可傳送 2000 個 Event 資源。
consent	Consent (選用步驟) 要求層級的同意聲明，適用於要求中的所有使用者。使用者層級同意聲明會覆寫要求層級同意聲明，且可在每個 Event 中指定。
validate_only	bool (選用步驟) 僅供測試用途。如果為 true，系統會驗證要求，但不會執行。系統只會傳回錯誤，不會傳回結果。
encoding	Encoding (選用步驟) 上傳 UserData 時必須提供這項資訊。使用者 ID 的編碼類型。如果是經過雜湊處理的使用者 ID，這是指雜湊字串的編碼類型。如果是加密的雜湊使用者 ID，這是外部加密字串的編碼類型，但不一定是內部雜湊字串的編碼類型，也就是說，內部雜湊字串的編碼方式可能與外部加密字串不同。如果上傳的不是 UserData，系統會忽略這個欄位。
encryption_info	EncryptionInfo (選用步驟) UserData 上傳內容的加密資訊。如果未設定，系統會假設上傳的識別資訊已雜湊處理，但未加密。如果上傳的不是 UserData，系統會忽略這個欄位。

IngestEventsResponse

IngestEventsRequest 的回應。

欄位
request_id	string 系統自動產生的要求 ID。

項目

代表與活動相關聯的購物車項目。

欄位
merchant_product_id	string (選用步驟) Merchant Center 帳戶中的產品 ID。
quantity	int64 (選用步驟) 與活動相關的這項商品數量。
unit_price	double (選用步驟) 此為單位價格，不含稅金、運費和任何交易折扣。
item_id	string (選用步驟) 用於參照項目的專屬 ID。
additional_item_parameters[]	ItemParameter (選用步驟) 要納入事件的與項目相關的任何事件參數，這些參數尚未透過其他結構化欄位指定。

ItemParameter

要納入事件的與項目相關的任何事件參數，這些參數尚未透過其他結構化欄位指定。

欄位
parameter_name	string 必要欄位。要使用的參數名稱。
value	string 必要欄位。要設定的參數值字串表示法。

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/廣告識別碼) 清單。單一 AudienceMember 最多可提供 10 個 mobileIds。

PairData

目標對象的 PAIR ID。至少須提供一組 PAIR ID。

欄位
pair_ids[]	string 必要欄位。資料無塵室提供的 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 Ads 核心平台服務。
PROCESSING_ERROR_REASON_UNKNOWN_CONSENT	系統無法判斷這位使用者的整體同意聲明 (根據資料列層級同意聲明、要求層級同意聲明和帳戶設定判斷)
PROCESSING_ERROR_REASON_DUPLICATE_GCLID	系統中已有含有相同 Google 點擊 ID 和轉換時間的轉換資料。
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 格式不正確或不存在。
PROCESSING_ERROR_REASON_INVALID_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	使用者嘗試擷取事件，但廣告 ID 並非來自作業帳戶的廣告。

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 格式不正確或不存在。
PROCESSING_WARNING_REASON_INVALID_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。

RemoveAudienceMembersRequest

要求從指定目的地中的目標對象移除使用者。傳回 RemoveAudienceMembersResponse。

您可以在 REST API 探索工具中試用這個方法：

使用 REST 試試看

欄位
destinations[]	Destination 必要欄位。要從中移除使用者的目的地清單。
audience_members[]	AudienceMember 必要欄位。要移除的使用者清單。
validate_only	bool (選用步驟) 僅供測試用途。如果為 true，系統會驗證要求，但不會執行。系統只會傳回錯誤，不會傳回結果。
encoding	Encoding (選用步驟) 上傳 UserData 時必須提供這項資訊。使用者 ID 的編碼類型。僅適用於加密使用者 ID 的外部編碼。如果上傳的不是 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 將成對資料擷取至目的地的狀態。

IngestEventsStatus

事件擷取至目的地的狀態。

欄位
record_count	int64 上傳要求中傳送的事件總數。包括要求中的所有事件，無論是否成功擷取。

IngestMobileDataStatus

行動資料擷取至目的地的狀態，其中包含與擷取作業相關的統計資料。

欄位
record_count	int64 上傳要求中傳送至目的地的目標對象成員總數。包括要求中的所有目標對象成員，無論是否成功擷取。
mobile_id_count	int64 上傳要求中傳送至目的地的行動 ID 總數。包括請求中的所有行動 ID，無論是否成功擷取。

IngestPairDataStatus

成對資料擷取至目的地的狀態，包含與擷取作業相關的統計資料。

欄位
record_count	int64 上傳要求中傳送至目的地的目標對象成員總數。包括要求中的所有目標對象成員，無論是否成功擷取。
pair_id_count	int64 上傳要求中傳送至目的地的配對 ID 總數。包括要求中的所有配對 ID，無論是否成功擷取。

IngestUserDataStatus

使用者資料擷取至目的地的狀態，其中包含與擷取作業相關的統計資料。

欄位
record_count	int64 上傳要求中傳送至目的地的目標對象成員總數。包括要求中的所有目標對象成員，無論是否成功擷取。
user_identifier_count	int64 上傳要求中傳送至目的地的使用者 ID 總數。包括要求中的所有使用者 ID，無論是否成功擷取。
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，無論是否已成功移除。

RemovePairDataStatus

從目的地移除配對資料的狀態。

欄位
record_count	int64 移除要求中傳送的目標對象成員總數。包括要求中的所有目標對象成員，無論是否成功移除。
pair_id_count	int64 移除要求中傳送的配對 ID 總數。包括要求中的所有配對 ID，無論是否已成功移除。

RemoveUserDataStatus

從目的地移除使用者資料的狀態。

欄位
record_count	int64 移除要求中傳送的目標對象成員總數。包括要求中的所有目標對象成員，無論是否成功移除。
user_identifier_count	int64 移除要求中傳送的使用者 ID 總數。包括要求中的所有使用者 ID，無論是否已成功移除。

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

可識別使用者的資料。至少須提供一個 ID。

欄位
user_identifiers[]	UserIdentifier 必要欄位。使用者的 ID。您可以提供相同類型資料的多個執行個體 (例如多個電子郵件地址)。如要提高比對成功的機率，請盡可能提供多個 ID。單一 AudienceMember 或 Event 最多可提供 10 個 userIdentifiers。

UserIdentifier

使用者的單一 ID。

欄位
聯集欄位 identifier。必須指定其中一個。identifier 只能是下列其中一項：
email_address	string 經過正規化處理後，使用 SHA-256 雜湊函式雜湊處理的電子郵件地址。
phone_number	string 經過正規化 (E164 標準) 後，使用 SHA-256 雜湊函式雜湊處理的電話號碼。
address	AddressInfo 使用者地址的已知元件。包含一次比對的所有 ID 分組。

UserProperties

廣告主在事件發生時評估的使用者資訊。詳情請參閱 https://support.google.com/google-ads/answer/14007601。

欄位
customer_type	CustomerType (選用步驟) 與事件相關聯的顧客類型。
customer_value_bucket	CustomerValueBucket (選用步驟) 廣告主評估的顧客價值。
additional_user_properties[]	UserProperty (選用步驟) 與這個事件相關聯的使用者任何其他使用者屬性的 bucket。

UserProperty

與這個事件相關聯的使用者任何其他使用者屬性的 bucket。

欄位
property_name	string 必要欄位。要使用的使用者屬性名稱。
value	string 必要欄位。要使用的使用者屬性值字串表示。

WarningCount

特定警告原因的警告次數。

欄位
record_count	int64 含有警告的記錄數量。
reason	ProcessingWarningReason 警告原因。

WarningInfo

各類型警告的警告次數。

欄位
warning_counts[]	WarningCount 警告清單，以及每個警告原因的計數。