Package google.ads.datamanager.v1

索引

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)

擷取特定使用者名單的行銷資料洞察。

這項功能僅供資料合作夥伴使用。

Authorization 標頭：

這個方法支援下列選用標頭，可定義 API 如何授權要求存取權：

  • login-account：(選用) 帳戶的資源名稱，憑證的 Google 帳戶是該帳戶的使用者。如未設定，預設為要求帳戶。格式：accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account：(選用) 帳戶的資源名稱，該帳戶已與 login-account 建立產品連結。格式：accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
授權範圍

需要下列 OAuth 範圍：

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

PartnerLinkService

用於管理合作夥伴連結的服務。

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。

Authorization 標頭：

這個方法支援下列選用標頭，可定義 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。

Authorization 標頭：

這個方法支援下列選用標頭，可定義 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。

Authorization 標頭：

這個方法支援下列選用標頭，可定義 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)

列出 UserLists。

Authorization 標頭：

這個方法支援下列選用標頭，可定義 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。

Authorization 標頭：

這個方法支援下列選用標頭，可定義 API 如何授權要求存取權：

  • login-account：(選用) 帳戶的資源名稱，憑證的 Google 帳戶是該帳戶的使用者。如未設定，預設為要求帳戶。格式：accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account：(選用) 帳戶的資源名稱，該帳戶已與 login-account 建立產品連結。格式：accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
授權範圍

需要下列 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

必填。使用者的地址郵遞區號。

年齡層

客層年齡範圍

列舉
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

與廣告主定義的使用者專屬 ID 相關的資料。
ppid_data

PpidData

與發布商提供的 ID 相關的資料。

這項功能僅供資料合作夥伴使用。

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} 或 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

(選用步驟) 與商品動態饋給相關聯的 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 已拒絕。

ContactIdInfo

如果 CONTACT_ID 是 upload_key_types 之一，則提供額外資訊。

欄位
match_rate_percentage

int32

僅供輸出。目標顧客比對使用者名單的媒合率。
data_source_type

DataSourceType

(選用步驟) 不可變動。上傳資料的來源

CreatePartnerLinkRequest

要求建立 PartnerLink 資源。傳回 PartnerLink。

您可以在 REST API Explorer 中試用這個方法：
使用 REST 試試看
欄位
parent

string

必填。擁有這組合作夥伴連結的父項。格式：accountTypes/{account_type}/accounts/{account}

CreateUserListDirectLicenseRequest

要求建立 UserListDirectLicense 資源。

您可以在 REST API Explorer 中試用這個方法：
使用 REST 試試看
欄位
parent

string

必填。擁有授權使用者名單的帳戶。格式應為 accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
user_list_direct_license

UserListDirectLicense

必填。要建立的使用者清單直接授權。

CreateUserListGlobalLicenseRequest

要求建立 UserListGlobalLicense 資源。

您可以在 REST API Explorer 中試用這個方法：
使用 REST 試試看
欄位
parent

string

必填。擁有授權使用者名單的帳戶。格式應為 accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
user_list_global_license

UserListGlobalLicense

必填。要建立的使用者清單全域授權。

CreateUserListRequest

CreateUserList 的要求訊息。

您可以在 REST API Explorer 中試用這個方法：
使用 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 Explorer 中試用這個方法：
使用 REST 試試看
欄位
name

string

必填。要刪除的合作夥伴連結資源名稱。格式：accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

DeleteUserListRequest

DeleteUserList 的要求訊息。

您可以在 REST API Explorer 中試用這個方法：
使用 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 不支援為歐洲經濟區、英國或瑞士的使用者比對 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 要求中的清單元素過多。
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 廣告主不在第三方合作夥伴資料的許可清單上。
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 帳戶類型不支援使用者名單類型。

事件

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

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

(選用步驟) 與此事件中所有金額相關聯的幣別代碼。
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

(選用步驟) 要納入事件的任何事件參數，這些參數尚未透過其他結構化欄位指定。
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 Explorer 中試用這個方法：
使用 REST 試試看
欄位
name

string

必填。使用者名單直接授權的資源名稱。

GetUserListGlobalLicenseRequest

要求取得 UserListGlobalLicense 資源。

您可以在 REST API Explorer 中試用這個方法：
使用 REST 試試看
欄位
name

string

必填。使用者名單全域授權的資源名稱。

GetUserListRequest

GetUserList 的要求訊息。

您可以在 REST API Explorer 中試用這個方法：
使用 REST 試試看
欄位
name

string

必填。要擷取的使用者名單資源名稱。格式：accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

IngestAudienceMembersRequest

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

您可以在 REST API Explorer 中試用這個方法：
使用 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 Explorer 中試用這個方法：
使用 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。

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 廣告識別碼 - 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

(選用步驟) 用於參照項目的專屬 ID。
additional_item_parameters[]

ItemParameter

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

ItemParameter

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

欄位
parameter_name

string

必填。要使用的參數名稱。
value

string

必填。要設定的參數值字串表示法。

ListUserListDirectLicensesRequest

要求列出指定帳戶的所有 UserListDirectLicense 資源。

您可以在 REST API Explorer 中試用這個方法：
使用 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 個授權。許可的最大值為 1000；超出的數值將一律指定為 1000。
page_token

string

(選用步驟) 屬於接收自前一個 ListUserListDirectLicense 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至 ListUserListDirectLicense 的所有其他參數須與提供網頁權杖的呼叫相符。

ListUserListDirectLicensesResponse

ListUserListDirectLicensesRequest 的回應。

欄位
user_list_direct_licenses[]

UserListDirectLicense

要求中指定使用者清單的授權。
next_page_token

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListUserListGlobalLicenseCustomerInfosRequest

要求列出特定使用者清單全域授權的所有 UserListGlobalLicenseCustomerInfo 資源。

您可以在 REST API Explorer 中試用這個方法：
使用 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 個授權。許可的最大值為 1000；超出的數值將一律指定為 1000。
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 Explorer 中試用這個方法：
使用 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 個授權。許可的最大值為 1000；超出的數值將一律指定為 1000。
page_token

string

(選用步驟) 屬於接收自前一個 ListUserListGlobalLicense 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至 ListUserListDirectLicense 的所有其他參數須與提供網頁權杖的呼叫相符。

ListUserListGlobalLicensesResponse

ListUserListGlobalLicensesRequest 的回應。

欄位
user_list_global_licenses[]

UserListGlobalLicense

要求中指定使用者清單的授權。
next_page_token

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListUserListsRequest

ListUserLists 的要求訊息。

您可以在 REST API Explorer 中試用這個方法：
使用 REST 試試看
欄位
parent

string

必填。擁有這組使用者名單的父項帳戶。格式：accountTypes/{account_type}/accounts/{account}
page_size

int32

(選用步驟) 要傳回的使用者名單數量上限。服務傳回的產品數量可能會少於這個值。如未指定，最多將傳回 50 個使用者名單。許可的最大值為 1000；超出的數值將一律指定為 1000。
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/廣告識別碼) 清單。單一 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。至少須提供一組 PAIR ID。

這項功能僅供資料合作夥伴使用。

欄位
pair_ids[]

string

必填。資料無塵室提供的 PII 資料 (以 SHA256 雜湊處理，並使用發布商金鑰透過 EC 可交換密碼加密)，適用於 PAIR 使用者名單。單一 AudienceMember 最多可提供 10 個 pairIds。

PairIdInfo

如果 PAIR_ID 是 upload_key_types 之一，則提供額外資訊。

這項功能僅供資料合作夥伴使用。

欄位
match_rate_percentage

int32

僅供輸出。這個欄位表示這份使用者名單與相應發布商第一方資料的會員比對百分比。必須介於 0 到 100 之間 (含 0 和 100)。
advertiser_identifier_count

int64

僅供輸出。已上傳至資料無塵室供應商的廣告主第一方資料記錄數。這不代表 PAIR 使用者名單的大小。
publisher_id

int64

必填。不可變動。用於識別與發布商及廣告主使用者身分資料比對使用者名單比對的發布商。這個欄位由資料無塵室供應商提供，且僅在該資料無塵室的範圍內是獨一無二的。這無法做為多個淨室的通用 ID。
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 合作夥伴目標對象來源為代理商/供應商目標對象。

PpidData

發布商提供的 ID 資料，其中包含 PPID。至少須提供一個 PPID。

這項功能僅供資料合作夥伴使用。

欄位
ppids[]

string

必填。使用者的發布商提供 ID 清單。

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

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 Explorer 中試用這個方法：
使用 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

將成對資料擷取至目的地的狀態。
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 總數。包括要求中的所有 PPID，無論是否成功擷取。

IngestUserDataStatus

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

欄位
record_count

int64

上傳要求中傳送至目的地的目標對象成員總數。包括要求中的所有目標對象成員，無論是否成功擷取都一樣。
user_identifier_count

int64

上傳要求中傳送至目的地的使用者 ID 總數。包括要求中的所有使用者 ID，無論是否成功擷取。
upload_match_rate_range

MatchRateRange

上傳內容的媒合率範圍。

IngestUserIdDataStatus

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

欄位
record_count

int64

上傳要求中傳送至目的地的目標對象成員總數。包括要求中的所有目標對象成員，無論是否成功擷取都一樣。
user_id_count

int64

上傳要求中傳送至目的地的使用者 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

移除要求中傳送的 ppids 總數。包括要求中的所有 ppid，無論是否已成功移除。

RemoveUserDataStatus

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

欄位
record_count

int64

移除要求中傳送的目標對象成員總數。包括要求中的所有目標對象成員，無論是否已成功移除。
user_identifier_count

int64

移除要求中傳送的使用者 ID 總數。包括要求中的所有使用者 ID，無論是否已成功移除。

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 Explorer 中試用這個方法：
使用 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 興趣相似使用者興趣。
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 Explorer 中試用這個方法：
使用 REST 試試看
欄位
request_id

string

必填。必填。Data Manager API 要求的 ID。

RetrieveRequestStatusResponse

RetrieveRequestStatusRequest 的回應。

欄位
request_status_per_destination[]

RequestStatusPerDestination

每個目的地的要求狀態清單。狀態的順序與原始要求中的目的地順序一致。

SearchPartnerLinksRequest

要求搜尋 PartnerLink 資源。傳回 SearchPartnerLinksResponse。

您可以在 REST API Explorer 中試用這個方法：
使用 REST 試試看
欄位
parent

string

必填。要搜尋合作夥伴連結的帳戶。如未指定 filter，系統會傳回所有合作夥伴連結，其中這個帳戶是 owning_account 或 partner_account。

格式：accountTypes/{account_type}/accounts/{account}
page_size

int32

要傳回的合作夥伴連結數量上限。服務傳回的產品數量可能會少於這個值。如未指定，最多將傳回 10 個合作夥伴連結。許可的最大值為 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 的回應。

欄位
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 多媒體廣告聯播網的資格。

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 Explorer 中試用這個方法：
使用 REST 試試看
欄位
user_list_direct_license

UserListDirectLicense

必填。授權的 name 欄位用於識別要更新的授權。
update_mask

FieldMask

(選用步驟) 要更新的欄位清單。系統不支援特殊字元 *，如果使用，會擲回 INVALID_UPDATE_MASK 錯誤。

UpdateUserListGlobalLicenseRequest

要求更新 UserListGlobalLicense 資源。

您可以在 REST API Explorer 中試用這個方法：
使用 REST 試試看
欄位
user_list_global_license

UserListGlobalLicense

必填。授權的 name 欄位用於識別要更新的授權。
update_mask

FieldMask

(選用步驟) 要更新的欄位清單。系統不支援特殊字元 *，如果使用，會擲回 INVALID_UPDATE_MASK 錯誤。

UpdateUserListRequest

UpdateUserList 的要求訊息。

您可以在 REST API Explorer 中試用這個方法：
使用 REST 試試看
欄位
user_list

UserList

必填。要更新的使用者清單。

使用者名單的 name 欄位用於識別要更新的使用者名單。格式：accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
update_mask

FieldMask

(選用步驟) 要更新的欄位清單。
validate_only

bool

(選用步驟) 如果為 true，系統會驗證要求，但不會執行要求。

UserData

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

欄位
user_identifiers[]

UserIdentifier

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

UserIdData

包含使用者 ID 的使用者 ID 資料。

欄位
user_id

string

必填。廣告主定義的使用者專屬 ID。

UserIdInfo

如果 USER_ID 是 upload_key_types 之一，則提供額外資訊。

欄位
data_source_type

DataSourceType

(選用步驟) 不可變動。上傳資料的來源。

UserIdentifier

使用者的單一 ID。

欄位
聯集欄位 identifier。必須指定一個選項。identifier 只能是下列其中一項：
email_address

string

使用 SHA-256 雜湊函式，對正規化後的電子郵件地址進行雜湊處理。
phone_number

string

經過正規化 (E164 標準) 後，使用 SHA-256 雜湊函式雜湊處理的電話號碼。
address

AddressInfo

使用者地址的已知元件。包含一次比對的所有 ID 分組。

UserList

使用者清單資源。

欄位
name

string

ID。使用者名單的資源名稱。格式：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

ID。使用者名單直接授權的資源名稱。
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

ID。使用者名單全域授權的資源名稱。
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

ID。使用者名單全域授權客戶的資源名稱。
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 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 廣告主。

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

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

UserProperty

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

欄位
property_name

string

必填。要使用的使用者屬性名稱。
value

string

必填。要使用的使用者屬性值字串表示。

WarningCount

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

欄位
record_count

int64

含有警告的記錄數量。
reason

ProcessingWarningReason

警告原因。

WarningInfo

各類型警告的警告次數。

欄位
warning_counts[]

WarningCount

警告清單，以及每個警告原因的計數。