Package google.ads.datamanager.v1

索引

IngestionService

這項服務可將目標對象資料傳送至支援的目的地。

IngestAdEvents

rpc IngestAdEvents(IngestAdEventsRequest) returns (IngestAdEventsResponse)

將 AdEvent 資源清單上傳至 Google Analytics。

這項功能僅適用於已加入許可清單的帳戶。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/datamanager
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
IngestUsers

rpc IngestUsers(IngestUsersRequest) returns (IngestUsersResponse)

將使用者清單上傳至指定目的地。與 IngestAudienceMembers (將使用者加入特定廣告主目標對象名單，以便指定目標) 不同，IngestUsers 會擷取帳戶層級的身分連結資料 (例如連結至行動 ID 的使用者 ID)，與特定目標對象區隔無關。

這項功能僅適用於已加入許可清單的帳戶。

授權範圍

需要下列 OAuth 範圍：

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

rpc RemoveAllAudienceMembers(RemoveAllAudienceMembersRequest) returns (RemoveAllAudienceMembersResponse)

從提供的目的地移除所有目標對象成員。

授權範圍

需要下列 OAuth 範圍：

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

rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)

從提供的 Destination 中移除 AudienceMember 資源清單。

授權範圍

需要下列 OAuth 範圍：

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

rpc RemoveUsers(RemoveUsersRequest) returns (RemoveUsersResponse)

從指定目的地移除使用者清單。

這項功能僅適用於已加入許可清單的帳戶。

授權範圍

需要下列 OAuth 範圍：

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

rpc RetrieveRequestStatus(RetrieveRequestStatusRequest) returns (RetrieveRequestStatusResponse)

根據要求 ID 取得要求狀態。

授權範圍

需要下列 OAuth 範圍：

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

MarketingDataInsightsService

這項服務會傳回行銷資料的洞察資訊。

這項功能僅適用於資料合作夥伴。

RetrieveInsights

rpc RetrieveInsights(RetrieveInsightsRequest) returns (RetrieveInsightsResponse)

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

這項功能僅適用於資料合作夥伴。

授權標頭：

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

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

需要下列 OAuth 範圍：

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

PartnerLinkService

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

UserListDirectLicenseService

用於管理使用者名單直接授權的服務。UserListDirectLicenses 不支援刪除作業。呼叫端應將授權狀態更新為 DISABLED，藉此停用授權。

這項功能僅適用於資料合作夥伴。

CreateUserListDirectLicense

rpc CreateUserListDirectLicense(CreateUserListDirectLicenseRequest) returns (UserListDirectLicense)

建立使用者清單直接授權。

這項功能僅適用於資料合作夥伴。

授權範圍

需要下列 OAuth 範圍：

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

rpc GetUserListDirectLicense(GetUserListDirectLicenseRequest) returns (UserListDirectLicense)

擷取使用者清單直接授權。

這項功能僅適用於資料合作夥伴。

授權範圍

需要下列 OAuth 範圍：

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

rpc ListUserListDirectLicenses(ListUserListDirectLicensesRequest) returns (ListUserListDirectLicensesResponse)

列出父項帳戶擁有的所有使用者名單直接授權。

這項功能僅適用於資料合作夥伴。

授權範圍

需要下列 OAuth 範圍：

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

rpc UpdateUserListDirectLicense(UpdateUserListDirectLicenseRequest) returns (UserListDirectLicense)

更新使用者清單的直接授權。

這項功能僅適用於資料合作夥伴。

授權範圍

需要下列 OAuth 範圍：

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

UserListGlobalLicenseService

用於管理使用者清單全域授權的服務。UserListGlobalLicenses 不支援刪除作業。呼叫端應將授權狀態更新為 DISABLED，藉此停用授權。

這項功能僅適用於資料合作夥伴。

CreateUserListGlobalLicense

rpc CreateUserListGlobalLicense(CreateUserListGlobalLicenseRequest) returns (UserListGlobalLicense)

建立使用者清單全域授權。

這項功能僅適用於資料合作夥伴。

授權範圍

需要下列 OAuth 範圍：

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

rpc GetUserListGlobalLicense(GetUserListGlobalLicenseRequest) returns (UserListGlobalLicense)

擷取使用者清單全域授權。

這項功能僅適用於資料合作夥伴。

授權範圍

需要下列 OAuth 範圍：

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

rpc ListUserListGlobalLicenseCustomerInfos(ListUserListGlobalLicenseCustomerInfosRequest) returns (ListUserListGlobalLicenseCustomerInfosResponse)

列出使用者清單全域授權的所有客戶資訊。

這項功能僅適用於資料合作夥伴。

授權範圍

需要下列 OAuth 範圍：

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

rpc ListUserListGlobalLicenses(ListUserListGlobalLicensesRequest) returns (ListUserListGlobalLicensesResponse)

列出家長帳戶擁有的所有使用者名單全域授權。

這項功能僅適用於資料合作夥伴。

授權範圍

需要下列 OAuth 範圍：

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

rpc UpdateUserListGlobalLicense(UpdateUserListGlobalLicenseRequest) returns (UserListGlobalLicense)

更新使用者清單的全球授權。

這項功能僅適用於資料合作夥伴。

授權範圍

需要下列 OAuth 範圍：

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

UserListService

用於管理 UserList 資源的服務。

CreateUserList

rpc CreateUserList(CreateUserListRequest) returns (UserList)

建立 UserList。

授權標頭：

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

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

需要下列 OAuth 範圍：

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

rpc DeleteUserList(DeleteUserListRequest) returns (Empty)

刪除 UserList。

授權標頭：

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

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

需要下列 OAuth 範圍：

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

rpc GetUserList(GetUserListRequest) returns (UserList)

取得 UserList。

授權標頭：

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

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

需要下列 OAuth 範圍：

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

rpc ListUserLists(ListUserListsRequest) returns (ListUserListsResponse)

列出 UserLists。

授權標頭：

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

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

需要下列 OAuth 範圍：

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

rpc UpdateUserList(UpdateUserListRequest) returns (UserList)

更新 UserList。

授權標頭：

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

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

需要下列 OAuth 範圍：

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

AdEvent

廣告事件。

欄位
advertiser_id

string

必填。廣告事件的廣告主 ID。

必須與連結流程中傳送的 ID 相符。
event_type

EventType

必填。事件的類型。
timestamp

Timestamp

必填。事件發生的時間。
event_id

string

(選用步驟) 由呼叫端建立及管理的 ID，可專屬識別這個事件。

如要為多個請求中包含的廣告事件去重複，則為必要欄位。否則，這個欄位為選填。
user_data

UserData

(選用步驟) 多筆使用者提供的資料，代表與事件相關聯的使用者。

您可以提供相同類型資料的多個執行個體 (例如電子郵件地址)。提供的資料越多，就越有可能找到相符的資料。
device_info

DeviceInfo

必填。廣告事件發生時所用裝置的相關資訊。
ip_address

string

(選用步驟) 用於評估的 IP 位址。此值必須與 DeviceInfo.ip_address 相同。如不想分享 IP 進行評估，請將此欄位留空。
mobile_device_id

string

(選用步驟) 放送廣告的裝置 ID。
campaign_id

string

必填。相關聯廣告活動的 ID。
campaign_name

string

必填。相關聯廣告活動的名稱。
ad_group_id

string

(選用步驟) 相關聯廣告群組的 ID。
ad_id

string

(選用步驟) 群組中相關聯廣告的 ID。
ad_height

int32

(選用步驟) 廣告高度 (以像素為單位)。
ad_width

int32

(選用步驟) 廣告寬度 (以像素為單位)。
region_code

string

(選用步驟) ISO 3166-2 國家/地區和子區域。
source

string

必填。廣告的平台來源，類似於 Google Analytics 來源。
medium

string

必填。廣告的媒介，類似於 Google Analytics 媒介。
attribution_hint

AttributionHint

(選用步驟) 合作夥伴為這個廣告事件假設的歸因狀態。

這項資訊僅做為合作夥伴假設歸因結果的信號，不會強制最終報表顯示特定結果。
viewability_info

ViewabilityInfo

必填。已放送廣告的可視度詳細資料。

聯集欄位 event_subtype_oneof。(選用步驟) 廣告事件類型的額外分類。

系統會接受原始字串，以處理純列舉以外的值。如果可以，建議使用列舉。event_subtype_oneof 只能是下列之一：
event_subtype

EventSubtype

活動子類型的列舉值。
event_subtype_string

string

活動子類型的字串值。

聯集欄位 ad_type_oneof。(選用步驟) 放送的廣告類型。

系統會接受原始字串，以處理純列舉以外的值。如果可以，建議使用列舉。ad_type_oneof 只能是下列之一：
ad_type

AdType

廣告類型的列舉值。
ad_type_string

string

廣告類型的字串值。

聯集欄位 ad_format_oneof。(選用步驟) 放送的廣告類型。

系統會接受原始字串，以處理純列舉以外的值。如果可以，建議使用列舉。ad_format_oneof 只能是下列之一：
ad_format

AdFormat

廣告格式的列舉值。
ad_format_string

string

廣告格式的字串值。

聯集欄位 ad_placement_oneof。(選用步驟) 放送廣告的刊登位置。

系統會接受原始字串，以處理純列舉以外的值。如果可以，建議使用列舉。ad_placement_oneof 只能是下列之一：
ad_placement

AdPlacement

廣告刊登位置的列舉值。
ad_placement_string

string

廣告刊登位置的字串值。

聯集欄位 targeting_type_oneof。(選用步驟) 用於放送廣告的指定目標類型。

系統會接受原始字串，以處理純列舉以外的值。如果可以，建議使用列舉。targeting_type_oneof 只能是下列之一：
targeting_type

TargetingType

指定類型的列舉值。
targeting_type_string

string

指定類型的字串值。

聯集欄位 platform_type_oneof。(選用步驟) 放送廣告的平台類型。

系統會接受原始字串，以處理純列舉以外的值。如果可以，建議使用列舉。platform_type_oneof 只能是下列之一：
platform_type

PlatformType

平台類型的列舉值。
platform_type_string

string

平台類型的字串值。

聯集欄位 platform_oneof。(選用步驟) 放送廣告的平台詳細資料。

系統會接受原始字串，以處理純列舉以外的值。如果可以，建議使用列舉。platform_oneof 只能是下列之一：
platform

Platform

平台的列舉值。
platform_string

string

平台的字串值。
measurement_allowed

bool

(選用步驟) 表示是否允許將資料列用於評估用途，這類用途受區域管轄範圍內適用的隱私權法律規範。

EventSubtype

廣告事件類型的額外分類。

列舉
EVENT_SUBTYPE_UNSPECIFIED 未指定事件子類型。
EVENT_SUBTYPE_IMPRESSION 曝光事件。
EVENT_SUBTYPE_ENGAGED_VIEW 參與收視事件。
EVENT_SUBTYPE_ONSITE_CLICK 網站點擊事件。
EVENT_SUBTYPE_OUTBOUND_CLICK 外連點擊事件。

EventType

事件的類型。

列舉
EVENT_TYPE_UNSPECIFIED 未指定的事件類型。
EVENT_TYPE_VIEW 查看活動。
EVENT_TYPE_CLICK 點擊事件。

AdFormat

放送的廣告格式。

列舉
AD_FORMAT_UNSPECIFIED 未指定廣告格式。
AD_FORMAT_AR AR 廣告。
AD_FORMAT_AUDIO 音訊廣告。
AD_FORMAT_BANNER 橫幅廣告。
AD_FORMAT_BUMPER 串場廣告。
AD_FORMAT_COLLECTION 集合廣告。
AD_FORMAT_IMAGE 圖像廣告。
AD_FORMAT_INTERACTIVE 互動式廣告。
AD_FORMAT_INTERSTITIAL 插頁式廣告。
AD_FORMAT_IN_FEED 動態內廣告。
AD_FORMAT_IN_STREAM 串流內廣告。
AD_FORMAT_IN_STREAM_SKIPPABLE 可略過的串流內廣告。
AD_FORMAT_IN_STREAM_NON_SKIPPABLE 不可略過的串流內廣告。
AD_FORMAT_NATIVE 原生廣告。
AD_FORMAT_SHORTS Shorts 廣告。
AD_FORMAT_STORY 故事廣告。
AD_FORMAT_SPONSORED 贊助廣告。
AD_FORMAT_VIDEO 影片廣告。

AdIdentifiers

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

欄位
session_attributes

string

(選用步驟) 用於事件歸因和模擬的工作階段屬性。
gclid

string

(選用步驟) 與這個事件相關聯的 Google 點擊 ID (gclid)。
gbraid

string

(選用步驟) 源自搭載 iOS 14 以上版本的裝置，且與應用程式事件相關聯的點擊 ID。
wbraid

string

(選用步驟) 源自搭載 iOS 14 以上版本的裝置，且與網站事件相關聯的點擊 ID。
landing_page_device_info

DeviceInfo

(選用步驟) 使用者與廣告互動後到達廣告主網站時所用裝置的相關資訊 (如有)。
mobile_device_id

string

(選用步驟) 廣告主的行動 ID。這類 ID 包括 iOS 的廣告識別碼、Android 的廣告 ID，以及其他平台的廣告主 ID。
dclid

string

(選用步驟) 與這個事件相關聯的多媒體廣告點擊 ID。
impression_id

string

(選用步驟) 與這個事件相關聯的曝光 ID。
match_id

string

(選用步驟) 用來將這個事件與先前事件彙整的相符 ID 欄位。
encrypted_user_ids[]

EncryptedUserId

(選用步驟) 任意數量的加密使用者 ID。
ppid

string

(選用步驟) 發布商定義的已驗證使用者 (已登入) 專屬 ID。
visitor_ppid

string

(選用步驟) 發布商定義的未經驗證使用者 (未登入的使用者) 專屬 ID。

AdPlacement

放送廣告的刊登位置。

列舉
AD_PLACEMENT_UNSPECIFIED 未指定廣告刊登位置。
AD_PLACEMENT_DISCOVER 探索刊登位置。
AD_PLACEMENT_FEED 動態饋給刊登位置。
AD_PLACEMENT_HEADER 標頭位置。
AD_PLACEMENT_HOME 首頁刊登位置。
AD_PLACEMENT_IN_CONTENT 內容中刊登位置。
AD_PLACEMENT_PROMOTED 宣傳刊登位置。
AD_PLACEMENT_STORY 故事刊登位置。

AdType

放送的廣告類型。

列舉
AD_TYPE_UNSPECIFIED 未指定廣告類型。
AD_TYPE_DISPLAY 多媒體廣告。
AD_TYPE_TEXT 。
AD_TYPE_IMAGE 圖像廣告。
AD_TYPE_RICH_MEDIA 互動式多媒體廣告。
AD_TYPE_HTML HTML 廣告。
AD_TYPE_AUDIO 音訊廣告。
AD_TYPE_VIDEO 影片廣告。

AddressInfo

使用者的地址資訊。

欄位
given_name

string

必填。使用者名字 (不含標點符號、開頭或結尾的空白字元，且一律為小寫)，並以 SHA-256 雜湊處理。
family_name

string

必填。使用者姓氏，一律為小寫，不得包含標點符號，開頭或結尾不得有空白字元，並以 SHA-256 雜湊處理。
region_code

string

必填。使用者地址的 ISO-3166-1 alpha-2 雙字母區域代碼。
postal_code

string

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

string

(選用步驟) 使用者的街道地址和門牌號碼。僅適用於 Google Analytics。這個欄位已經過雜湊處理，可能也經過加密。

先將值標準化，再進行雜湊處理：

  • 移除符號字元
  • 轉換為小寫
  • 移除開頭和結尾的空白字元
city

string

(選用步驟) 使用者地址的城市。僅適用於 Google Analytics。

值應正規化如下：

  • 移除符號字元
  • 轉換為小寫
  • 移除開頭和結尾的空白字元
administrative_area

string

(選用步驟) 使用者地址的行政區 (州/省)。僅適用於 Google Analytics。

值應正規化如下：

  • 移除符號字元
  • 轉換為小寫
  • 移除開頭和結尾的空白字元

年齡層

客層年齡範圍

列舉
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 歲以上。

AttributionHint

合作夥伴為這個廣告事件假設的歸因狀態。

列舉
ATTRIBUTION_HINT_UNSPECIFIED 歸因狀態不明。
ATTRIBUTION_HINT_CONVERTED 轉換狀態。
ATTRIBUTION_HINT_NOT_CONVERTED 未轉換狀態。

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 相關的資料。

這項功能僅適用於資料合作夥伴。
composite_data

CompositeData

多個 ID 類型組成的群組。
google_user_id_data

GoogleUserIdData

加密的 Google 使用者 ID。
partner_provided_id_data

PartnerProvidedIdData

合作夥伴提供的 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

(選用步驟) 與活動相關聯的項目清單。
coupon_codes[]

string

(選用步驟) 已套用至購物車的優待券代碼清單。購物車層級和項目層級的優待券代碼各自獨立。

如果事件是針對 Google Analytics 目的地，請只提供單一優待券代碼。Google Analytics 會忽略額外的優待券代碼。

CompositeData

包含使用者 ID 和相關資料的複合資料。至少必須有一個 user_data 或 ip_data。

欄位
user_data

UserData

(選用步驟) 可識別使用者的使用者提供資料。
ip_data[]

IpData

(選用步驟) 代表顧客互動的 IP 位址資料，用於建立目標對象。

使用者的《數位市場法》(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

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

CoordinatorKeyInfo

協調員金鑰的相關資訊。

欄位
key_id

string

必填。所選協調器金鑰的 ID。

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。

對於 Google Ad Manager 事件擷取和使用者擷取作業，這個欄位為選填。其他用途則必須提供。

DeviceInfo

事件發生時使用的裝置資訊 (如有)。

欄位
user_agent

string

(選用步驟) 指定脈絡的裝置使用者代理程式字串。
ip_address

string

(選用步驟) 指定情境的裝置 IP 位址。在 AdEvent 中用於地理位置檢查時，必須提供這項屬性。
category

string

(選用步驟) 裝置類別。例如「電腦」、「平板電腦」、「行動裝置」、「智慧型電視」。
language_code

string

(選用步驟) 裝置使用的語言，格式為 ISO 639-1。
screen_height

int32

(選用步驟) 螢幕高度 (以像素為單位)。
screen_width

int32

(選用步驟) 螢幕寬度 (以像素為單位)。
operating_system

string

(選用步驟) 裝置的作業系統或平台。
operating_system_version

string

(選用步驟) 作業系統或平台的版本。
model

string

(選用步驟) 裝置型號。
brand

string

(選用步驟) 裝置品牌。
browser

string

(選用步驟) 瀏覽器的品牌或類型。
browser_version

string

(選用步驟) 瀏覽器版本。

編碼

經過雜湊處理的個人識別資訊編碼類型。

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

EncryptedUserId

系統核發的使用者 ID，用於歸因。如要使用這項功能，所有欄位均為必填。

欄位
encrypted_id

string

必填。英數字元加密 ID。
entity_type

EncryptionEntityType

必填。加密實體類型。這項設定應與廣告放送或資料移轉的加密設定相符。
entity_id

int64

必填。加密實體 ID。這項設定應與廣告放送或資料移轉的加密設定相符。
source

EncryptionSource

必填。說明加密 Cookie 是從廣告放送 (巨集 %m) 還是資料移轉收到。

EncryptionEntityType

加密實體類型。

列舉
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED 未指定加密實體類型。
CAMPAIGN_MANAGER_ACCOUNT Campaign Manager 360 帳戶。
CAMPAIGN_MANAGER_ADVERTISER Campaign Manager 360 廣告主。
DISPLAY_VIDEO_PARTNER Display & Video 360 合作夥伴。
DISPLAY_VIDEO_ADVERTISER Display & Video 360 廣告主。
GOOGLE_ADS_CUSTOMER Google Ads 客戶。
GOOGLE_AD_MANAGER_NETWORK_CODE Google Ad Manager 聯播網代碼。

EncryptionSource

加密來源。

列舉
ENCRYPTION_SOURCE_UNSPECIFIED 未指定加密來源。
AD_SERVING 廣告放送加密來源。
DATA_TRANSFER 資料移轉加密來源。

EncryptionInfo

要擷取資料的加密資訊。

欄位
聯集欄位 wrapped_key。用於加密資料的包裝金鑰。wrapped_key 只能是下列之一：
gcp_wrapped_key_info

GcpWrappedKeyInfo

Google Cloud Platform 包裝金鑰資訊。
aws_wrapped_key_info

AwsWrappedKeyInfo

Amazon Web Services 包裝金鑰資訊。
coordinator_key_info

CoordinatorKeyInfo

所選協調器金鑰的重要資訊。

IngestEvents、IngestAudienceMembers 和 RemoveAudienceMembers 方法不支援這項功能。

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

已淘汰：Data Manager API 未使用列舉。
INVALID_ENUM_VALUE 無法使用列舉值。
INVALID_USER_LIST_TYPE 使用者名單的類型不適用於這項要求。
INVALID_AUDIENCE_MEMBER 這個目標對象成員無效。
TOO_MANY_AUDIENCE_MEMBERS 每項要求允許的目標對象成員數量上限為 10,000 人。
TOO_MANY_USER_IDENTIFIERS 每筆記錄允許的使用者 ID 數量上限為 10 個。
TOO_MANY_DESTINATIONS 每項要求最多可有 10 個目的地。
INVALID_DESTINATION 這個目的地無效。
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED 資料合作夥伴無法存取作業帳戶擁有的使用者名單。
INVALID_MOBILE_ID_FORMAT 行動 ID 格式無效。
INVALID_USER_LIST_ID 使用者名單無效。
MULTIPLE_DATA_TYPES_NOT_ALLOWED 單一要求不得擷取多種資料類型。
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER 含有 DataPartner 登入帳戶的目標設定，在所有目標設定中都必須使用相同的登入帳戶。
TERMS_AND_CONDITIONS_NOT_SIGNED 未接受必要條款及細則。
INVALID_NUMBER_FORMAT 數字格式無效。
INVALID_CONVERSION_ACTION_ID 轉換動作 ID 無效。
INVALID_CONVERSION_ACTION_TYPE 轉換動作類型無效。
INVALID_CURRENCY_CODE 系統不支援此貨幣代碼。
INVALID_EVENT 這個事件無效。
TOO_MANY_EVENTS 每項要求允許的事件數量上限為 10,000 個。
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS 目標帳戶未啟用待開發客戶強化轉換。
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS 根據 Google 客戶資料政策，目標帳戶無法使用強化轉換。請與 Google 代表聯絡。
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED 目標帳戶尚未同意強化轉換的條款。
DUPLICATE_DESTINATION_REFERENCE 要求中的兩個以上目的地具有相同的參照。
UNSUPPORTED_OPERATING_ACCOUNT_FOR_DATA_PARTNER 不支援授權資料合作夥伴的營運帳戶。
UNSUPPORTED_LINKED_ACCOUNT_FOR_DATA_PARTNER 不支援連結的帳戶，無法授權資料合作夥伴。
NO_IDENTIFIERS_PROVIDED 事件資料不含使用者 ID 或廣告 ID。如果是 Floodlight 事件擷取，這項錯誤表示要求不含任何廣告 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 欄位值過長。
FIELD_VALUE_TOO_SHORT 欄位值長度過短。
TOO_MANY_ELEMENTS 要求中的清單元素過多。
TOO_FEW_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 使用者名單類型不支援這些帳戶類型。
MEMBERSHIP_DURATION_TOO_LONG 使用者名單再行銷效期過長。
INVALID_MERCHANT_ID 「merchant_id」欄位無效。
EU_POLITICAL_ADVERTISING_DECLARATION_REQUIRED 客戶含有未豁免的廣告活動，但沒有歐盟政治廣告聲明。
ACCOUNT_INELIGIBLE_FOR_STORE_SALES 帳戶不符合商店銷售資格。
INVALID_MERCHANT_FEED_LANGUAGE_CODE 商家動態饋給語言代碼無效。
INVALID_REGION_CODE 區域代碼無效。
INVALID_SUBDIVISION_CODE 次分區代碼無效。
INVALID_SUBCONTINENT_CODE 次大陸代碼無效。
INVALID_CONTINENT_CODE 洲別代碼無效。
INVALID_DEVICE_CATEGORY 裝置類別無效。
BOTH_CLIENT_ID_AND_APP_INSTANCE_ID_NOT_ALLOWED 已設定 app_instance_id 和 client_id。
GOOGLE_ANALYTICS_SUBPROPERTY_OR_ROLLUP_PROPERTY_NOT_ALLOWED Google Analytics 資源是子資源或綜覽資源。
THIRD_PARTY_USER_DATA_NOT_ALLOWED 第三方使用者資料只能由資料合作夥伴設定。
INVALID_COUPON_CODE 優待券代碼無效。
EVENT_SOURCE_AND_DESTINATION_MISMATCH 活動來源類型與目的地類型不符。
DESTINATION_ACCOUNT_TYPE_MISMATCH 目標帳戶類型與指定的帳戶 ID 不符。
CUSTOM_VARIABLE_VALUE_CONTAINS_PII 自訂變數值包含個人識別資訊 (PII)。
CUSTOM_VARIABLE_NOT_ENABLED 未啟用自訂變數。
INVALID_CUSTOM_VARIABLE_VALUE 自訂變數的值無效。
CUSTOM_VARIABLE_NOT_FOUND 目的地沒有名稱與指定 variable 相符的自訂變數。
TOO_MANY_USERS 每項要求允許的使用者人數上限為 10,000 人。
BASELINE_LOCATION_AUTO_DETECTION_FAILED 要求的 location_auto_detection_enabled 欄位已設為 true，但系統無法自動偵測基準位置。
INSIGHTS_MISSING_FOR_DIMENSION 這個維度缺少洞察資料。
INVALID_REMOVE_AS_OF_TIME 移除時間必須是過去或現在。移除目標對象成員時，不得使用未來的時間戳記。
REQUEST_TOO_OLD API 收到要求後，要求狀態只會保留約 50 天。
CONVERSION_ACTION_TOO_RECENTLY_CREATED 轉換動作最近才剛建立。
INVALID_AD_IDENTIFIER_FOR_ACCOUNT

廣告 ID 不屬於該帳戶。

舉例來說，gclid 與到達網頁的 operating_account 和 product_destination_id 無關。
UNSUPPORTED_ACCOUNT_TYPE_FOR_USER_LIST_DIRECT_LICENSE 帳戶類型不是 UserListDirectLicense 支援的 client_account_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

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

UserData

(選用步驟) 與 user_data 中提供的資料類型相同，但明確標示為第三方擁有的資料，而非第一方廣告主資料。
event_location

EventLocation

(選用步驟) 系統在事件發生時收集到的使用者位置資訊。
app_instance_id

string

(選用步驟) 這個 GA4 應用程式資料串流的應用程式用戶端使用者執行個體專屬 ID。
conversion_value

double

(選用步驟) 與事件相關的轉換價值 (適用於以價值為準的轉換)。
conversion_count

double

(選用步驟) 與事件相關的轉換數量 (適用於以計數為準的轉換)。

EventLocation

事件發生的位置。

欄位
store_id

string

(選用步驟) 商店銷售必填。代表發生事件的實體商店的 ID。
city

string

(選用步驟) 事件發生的城市名稱。
subdivision_code

string

(選用步驟) 事件發生的 ISO 3166-2 行政分區代碼。
region_code

string

(選用步驟) 使用者地址的 2 字母 CLDR 區域代碼。
subcontinent_code

string

(選用步驟) 事件發生地的子洲別代碼 (採用 UN M49 格式)。
continent_code

string

(選用步驟) 事件發生的洲別代碼 (採用 UN M49 格式)。

EventParameter

GA4 事件的事件參數。

欄位
parameter_name

string

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

string

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

EventSource

事件的來源。

列舉
EVENT_SOURCE_UNSPECIFIED 未指定 EventSource。請一律不使用這個值。
WEB 這項活動是透過網路瀏覽器產生。
APP 活動是由應用程式產生。
IN_STORE 這項活動是根據店內交易產生。
PHONE 這項活動是根據電話通話內容產生。
MESSAGE 這項活動是根據訊息產生。
OTHER 事件是從其他來源產生。

ExperimentalField

代表非正式欄位的實驗性欄位。

欄位
field

string

(選用步驟) 要使用的欄位名稱。
value

string

(選用步驟) 要設定的欄位值。

FeatureSet

合作夥伴連結支援的功能集。

列舉
FEATURE_SET_UNSPECIFIED 未指定功能集。如未指定，系統行為預設為 FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT。
FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT 指出用於管理目標對象和事件的連結。
FEATURE_SET_AD_EVENT_MANAGEMENT 指出用於管理廣告事件的連結。

FieldWarning

詳細的資料列層級警告，並附上欄位路徑。

欄位
reason

WarningReason

警告原因。
description

string

詳細的警告訊息，說明問題。
field

string

觸發警告的欄位路徑。格式與 google.rpc.BadRequest.FieldViolation.field 相同。

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}

GoogleUserIdData

Google 使用者 ID 資料，內含加密的 Google 使用者 ID。至少需要一個 Google 使用者 ID。

欄位
google_user_ids[]

string

必填。已加密 Google 使用者 ID 清單。

IngestAdEventsRequest

要求上傳廣告事件。

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

AdEvent

必填。必要 (至少 1 個)。廣告事件清單。
encryption_info

EncryptionInfo

(選用步驟) 用於加密資料的加密金鑰相關資訊。如果廣告事件包含 UserData，則必須提供這個欄位。
validate_only
(deprecated)

bool

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

IngestAdEventsResponse

這個類型沒有任何欄位。

廣告事件擷取作業的回覆。

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。
field_warnings[]

FieldWarning

提供詳細的資料列層級警告，並附上欄位路徑。

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。
field_warnings[]

FieldWarning

提供詳細的資料列層級警告，並附上欄位路徑。

IngestUsersRequest

要求將使用者上傳至指定目的地。

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

Destination

必填。可能的擷取目的地清單。
users[]

User

必填。要擷取的使用者清單。
encryption_info

EncryptionInfo

(選用步驟) 用於加密資料的加密金鑰相關加密資訊。
validate_only

bool

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

Encoding

必填。使用者 ID 的編碼類型。如果是加密的使用者 ID，這項限制只適用於外部編碼。

IngestUsersResponse

IngestUsersRequest 的回應。

欄位
request_id

string

擷取要求的產生要求 ID。

IngestedUserListInfo

代表由使用者提供資料填入的使用者名單。

欄位
upload_key_types[]

UploadKeyType

必填。不可變動。這份使用者名單的上傳金鑰類型。
contact_id_info

ContactIdInfo

(選用步驟) 如果 CONTACT_ID 是 upload_key_types 之一，則為其他資訊。
mobile_id_info

MobileIdInfo

(選用步驟) 如果 MOBILE_ID 是 upload_key_types 之一，則為其他資訊。
user_id_info

UserIdInfo

(選用步驟) 如果 USER_ID 是 upload_key_types 之一，則為其他資訊。
pair_id_info

PairIdInfo

(選用步驟) 如果 PAIR_ID 是 upload_key_types 之一，則為其他資訊。

這項功能僅適用於資料合作夥伴。
pseudonymous_id_info

PseudonymousIdInfo

(選用步驟) 「PSEUDONYMOUS_ID」的其他資訊是「upload_key_types」之一。
partner_audience_info

PartnerAudienceInfo

(選用步驟) 合作夥伴目標對象的其他資訊。

這項功能僅適用於資料合作夥伴。

UploadKeyType

列舉，內含使用者名單可能有的上傳金鑰類型。

列舉
UPLOAD_KEY_TYPE_UNSPECIFIED 不指定。
CONTACT_ID 顧客資訊，例如電子郵件地址、電話號碼或實際地址。
MOBILE_ID 行動廣告 ID。
USER_ID 第三方提供的使用者 ID。
PAIR_ID 發布商及廣告主使用者身分資料比對 ID。
PSEUDONYMOUS_ID

資料管理平台 ID：

  • Google 使用者 ID
  • 合作夥伴提供的 ID
  • 發布商提供的 ID
  • iOS IDFA
  • Android 廣告 ID
  • Roku ID
  • Amazon Fire TV ID
  • Xbox 或 Microsoft ID
  • 一般裝置 ID

IpData

使用者的 IP 位址資訊。建議加入 observe_start_time 和 observe_end_time，以提高目標顧客比對的媒合率。

欄位
ip_address

string

必填。在顧客互動時擷取的 IP 位址。接受 IPv4 和 IPv6 的標準字串格式。
observe_start_time

Timestamp

(選用步驟) 工作階段中，此 IP 位址首次記錄到的互動時間。
observe_end_time

Timestamp

(選用步驟) 這個 IP 位址在工作階段中上次記錄到的互動時間。

項目

代表與事件相關聯的購物車項目。

欄位
merchant_product_id

string

(選用步驟) Merchant Center 帳戶中的產品 ID。
quantity

int64

(選用步驟) 與事件相關的這項商品數量。
unit_price

double

(選用步驟) 單一商品的價格 (不含稅金、運費和任何交易層級折扣)。
item_id

string

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

ItemParameter

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

string

(選用步驟) 與項目相關聯的 Merchant Center ID。如果是商店銷售事件，這項參數會覆寫購物車層級設定的值。如果是其他事件，系統會忽略這個欄位。
merchant_feed_label

string

(選用步驟) Merchant Center 動態饋給的動態饋給標籤。如果仍在使用國家/地區，則可改用 ISO-3166-1 alpha-2 的雙字母國家/地區代碼。如果是商店銷售事件，這項參數會覆寫購物車層級設定的值。如果是其他事件，系統會忽略這個欄位。
merchant_feed_language_code

string

(選用步驟) 與上傳商品所在 Merchant Center 動態饋給相關聯的 ISO 639-1 語言代碼。
custom_variables[]

ItemCustomVariable

(選用步驟) 追蹤單一項目轉換時，要傳送至轉換容器 (轉換動作或 Floodlight 活動) 的其他鍵/值組資訊。
conversion_value

double

(選用步驟) 事件中與這個項目相關聯的轉換價值，適用於每個項目的轉換價值不同時。

ItemCustomVariable

廣告轉換的項目層級自訂變數。

欄位
variable

string

(選用步驟) 要設定的自訂變數名稱。如果系統找不到指定目的地的變數，就會略過該變數。
value

string

(選用步驟) 要為自訂變數儲存的值。
destination_references[]

string

(選用步驟) 參考字串，用於判斷應將哪個 Event.destination_references 自訂變數傳送至。如果留空，系統會使用 Event.destination_references。

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
  • =
  • !=
  • >
  • >=
  • <
  • <=

支援的函式：- IN(field, value1, value2, ...)：如果欄位符合任何值，則傳回 true。範例：IN(user_list_id, 123, 456)

不支援的欄位：

  • 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
  • =
  • !=
  • >
  • >=
  • <
  • <=

支援的函式：- IN(field, value1, value2, ...)：如果欄位符合任何值，則傳回 true。範例：IN(user_list_id, 123, 456)

不支援的欄位：

  • 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
  • =
  • !=
  • >
  • >=
  • <
  • <=

支援的函式：- IN(field, value1, value2, ...)：如果欄位符合任何值，則傳回 true。範例：IN(user_list_id, 123, 456)

不支援的欄位：

  • 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
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • : (有)

支援的函式：- IN(field, value1, value2, ...)：如果欄位符合任何值，則傳回 true。範例：IN(display_name, "name1", "name2")

支援的欄位：

  • 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])。

MediaQuartile

媒體播放量 (以四分位數表示)。

列舉
MEDIA_QUARTILE_UNSPECIFIED 未指定媒體四分位數。
MEDIA_QUARTILE_START 。
MEDIA_QUARTILE_FIRST_QUARTILE 播完四分之一。
MEDIA_QUARTILE_MIDPOINT 中點。
MEDIA_QUARTILE_THIRD_QUARTILE 播完四分之三。
MEDIA_QUARTILE_COMPLETE 完成。

MobileData

目標對象的行動 ID。至少需要一個行動 ID。

欄位
mobile_ids[]

string

必填。行動裝置 ID 清單 (Android 廣告 ID、iOS 廣告識別碼，適用於目標顧客比對使用者名單；Android 廣告 ID、iOS 廣告識別碼、Xbox 或 Microsoft ID、Amazon Fire TV ID、Roku 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

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

PairIdInfo

如果 PAIR_ID 是 upload_key_types 之一，則為其他資訊。

這項功能僅適用於資料合作夥伴。

欄位
publisher_id

int64

必填。不可變動。用於識別與發布商及廣告主使用者身分資料比對使用者名單比對的發布商。這個欄位由資料無塵室供應商提供，且僅在該無塵室範圍內具有唯一性。這無法做為多個淨室的通用 ID。
publisher_name

string

必填。發布商的描述性名稱，會顯示在使用者介面中，提供更優質的指定目標體驗。
match_rate_percentage

int32

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

int64

(選用步驟) 已上傳至資料無塵室供應商的廣告主第一方資料記錄數。這不代表 PAIR 使用者名單的大小。
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 合作夥伴目標對象來源為代理商/供應商目標對象。

PartnerCustomerAccount

代表合作夥伴系統中的客戶帳戶。

欄位
account_id

string

必填。合作夥伴 ID 空間中的客戶帳戶 ID。
account_name

string

(選用步驟) 帳戶名稱。
account_type

string

(選用步驟) 帳戶類型。可用於區分廣告主帳戶和商家層級帳戶等。

PartnerLinkMetadata

代表與合作夥伴連結相關聯的中繼資料。

欄位
implicit_accounts[]

PartnerCustomerAccount

(選用步驟) 隱含帳戶清單。

PartnerProvidedIdData

合作夥伴提供的資料，其中包含合作夥伴提供的 ID。至少需要一個合作夥伴提供的 ID。

欄位
partner_provided_ids[]

string

必填。合作夥伴提供的 ID 清單。

平台

放送廣告的平台詳細資料。

列舉
PLATFORM_UNSPECIFIED 未指定平台。
PLATFORM_IOS iOS 平台。
PLATFORM_ANDROID Android 平台。
PLATFORM_WEB 網路平台。

平台類型

放送廣告的平台類型。

列舉
PLATFORM_TYPE_UNSPECIFIED 未指定平台類型。
PLATFORM_TYPE_MOBILE 行動平台。
PLATFORM_TYPE_DESKTOP 桌機平台。
PLATFORM_TYPE_CTV 連網電視平台。
PLATFORM_TYPE_PHONE 手機平台。
PLATFORM_TYPE_TABLET 平板電腦平台。

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 並非來自作業帳戶的廣告。
PROCESSING_ERROR_REASON_ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID 「單次點擊單次轉換」轉換動作無法與 BRAID 搭配使用。
PROCESSING_ERROR_REASON_MATCH_ID_NOT_FOUND 找不到比賽 ID。
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_MATCH_ID 找不到相符 ID 的使用者 ID。
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_GCLID 找不到 Google 點擊 ID 的使用者 ID。
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_DCLID 找不到 DCLID 的使用者 ID。
PROCESSING_ERROR_REASON_INVALID_AD_IDENTIFIERS 廣告 ID 無效。
PROCESSING_ERROR_REASON_INVALID_MOBILE_ID_FORMAT 行動 ID 格式無效。
PROCESSING_ERROR_REASON_ORIGINAL_CONVERSIONS_NOT_FOUND 找不到原始轉換。
PROCESSING_ERROR_REASON_EVENT_ID_DECODE_ERROR 無法解碼事件 ID (dclid 或曝光 ID)。
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_IMPRESSION_ID 系統找不到指定曝光 ID 的使用者 ID。
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND 找不到使用者 ID。
PROCESSING_ERROR_REASON_CONVERSION_PRECEDES_CLICK 事件的時間戳記早於相關聯的點擊。
PROCESSING_ERROR_REASON_TOO_RECENT_CLICK 點擊時間太近。
PROCESSING_ERROR_REASON_INVALID_CLICK 事件無法歸功於特定點擊 (Google 點擊 ID)，舉例來說，這可能是因為該點擊並非來自 Google Ads 廣告活動。
PROCESSING_ERROR_REASON_INVALID_OPERATING_ACCOUNT_FOR_CLICK 事件中的點擊與目的地的 operating_account 無關。
PROCESSING_ERROR_REASON_CLICK_NOT_FOUND 找不到與所提供屬性相符的點擊。
PROCESSING_ERROR_REASON_EXTERNAL_ATTRIBUTION_DATA_MISSING 缺少外部歸因資料。系統不支援將事件傳送至外部歸因轉換動作的目的地。
PROCESSING_ERROR_REASON_DESTINATION_TOO_RECENTLY_CREATED 目的地最近才剛建立。請過幾小時後再試一次。
PROCESSING_ERROR_REASON_EXPIRED_CLICK 相符的點擊時間早於轉換動作設定的點閱後轉換回溯期 (或 90 天的點擊 TTL)。

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。
FLOODLIGHT_CONFIG Floodlight 設定。
GOOGLE_AD_MANAGER Google Ad Manager。

PseudonymousIdInfo

如果 PSEUDONYMOUS_ID 是 upload_key_types 之一，則為其他資訊。

欄位
sync_status

SyncStatus

僅供輸出。使用者清單的同步狀態。
billable_record_count

int64

(選用步驟) 不可變動。可計費記錄的數量 (例如上傳或比對的記錄)。

SyncStatus

使用者清單的同步狀態。

列舉
SYNC_STATUS_UNSPECIFIED 不指定。
CREATED 使用者清單已建立為預留位置。清單內容和/或中繼資料仍在同步處理中。使用者名單尚未準備就緒，無法使用。
READY_FOR_USE 使用者清單已可使用。內容和 Cookie 已正確同步。
FAILED 同步處理使用者清單內容和/或中繼資料時發生錯誤。無法使用使用者清單。

RemoveAllAudienceMembersRequest

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

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

Destination

必填。要從中移除使用者的目的地清單。
remove_as_of_time

Timestamp

(選用步驟) 移除時間。如果設定，系統只會移除在此時間前最後新增的目標對象成員。如未設定，則預設為目前時間。移除時間不得設在未來。
validate_only

bool

(選用步驟) 僅供測試用途。如果是 true，系統會驗證要求，但不會執行。只會傳回錯誤，不會傳回結果。

RemoveAllAudienceMembersResponse

RemoveAllAudienceMembersRequest 的回覆。

欄位
request_id

string

系統自動產生的要求 ID。

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。

RemoveUsersRequest

要求從提供的目的地移除使用者。

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

Destination

必填。可能的擷取目的地清單。
user_data[]

UserData

必填。做為使用者移除鍵的個別 UserData 位元。
encryption_info

EncryptionInfo

(選用步驟) 用於加密資料的加密金鑰相關加密資訊。
validate_only

bool

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

Encoding

必填。使用者 ID 的編碼類型。如果是加密的使用者 ID，這項限制只適用於外部編碼。

RemoveUsersResponse

RemoveUsersRequest 的回應。

欄位
request_id

string

擷取要求的產生要求 ID。

RequestStatusPerDestination

每個目的地的要求狀態。

欄位
destination

Destination

DM API 要求中的目的地。
request_status

RequestStatus

目的地的要求狀態。
error_info

ErrorInfo

包含上傳相關錯誤原因和錯誤計數的錯誤資訊錯誤。只有在 request_status 為 FAILED 或 PARTIAL_SUCCESS 時，才會填入這項資料。要求處於 request_status 狀態時，這個欄位不會填入任何內容。PROCESSING
warning_info

WarningInfo

警告資訊，內含與上傳作業相關的警告原因和警告次數。要求處於 request_status 狀態時，這個欄位不會填入任何內容。PROCESSING
聯集欄位 status。目的地的狀態。status 只能是下列其中一項：
audience_members_ingestion_status

IngestAudienceMembersStatus

擷取目標對象成員要求的狀態。
events_ingestion_status

IngestEventsStatus

擷取事件要求的狀態。
audience_members_removal_status

RemoveAudienceMembersStatus

移除目標對象成員要求的狀態。
remove_all_audience_members_status

RemoveAllAudienceMembersStatus

移除所有目標對象成員要求的狀態。

DataType

資料類型。

列舉
DATA_TYPE_UNSPECIFIED 未指定資料類型。
EMAIL 資料為電子郵件地址。
PHONE_NUMBER 資料為電話號碼。
ADDRESS 這項資料是實際地址。
IP_ADDRESS 這項資料是 IP 位址。

DataTypeCount

特定資料類型的數量。

欄位
type

DataType

資料類型。
count

int64

這類資料的數量。

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 資料擷取至目的地的狀態。
composite_data_ingestion_status

IngestCompositeDataStatus

複合資料擷取至目的地的狀態。
google_user_id_data_ingestion_status

IngestGoogleUserIdDataStatus

Google 使用者 ID 資料擷取至目的地的狀態。
partner_provided_id_data_ingestion_status

IngestPartnerProvidedIdDataStatus

合作夥伴提供的 ID 資料擷取至目的地的狀態。

IngestCompositeDataStatus

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

欄位
record_count

int64

上傳至目標的觀眾成員總數。包括要求中的所有目標對象成員，無論是否成功擷取都一樣。
data_type_counts[]

DataTypeCount

上傳要求傳送至目的地的資料類型總數，並依資料類型細分。包括要求中的所有資料類型，無論是否成功擷取。
upload_match_rate_range

MatchRateRange

上傳內容的相符率範圍。

IngestEventsStatus

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

欄位
record_count

int64

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

IngestGoogleUserIdDataStatus

Google 使用者 ID 資料的擷取狀態，以及擷取相關統計資料。

欄位
record_count

int64

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

int64

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

IngestMobileDataStatus

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

欄位
record_count

int64

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

int64

上傳要求中傳送至目的地的行動 ID 總數。包括請求中的所有行動 ID，無論是否已成功擷取。

IngestPairDataStatus

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

欄位
record_count

int64

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

int64

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

IngestPartnerProvidedIdDataStatus

合作夥伴提供的 ID 資料擷取至目的地的狀態，其中包含擷取相關統計資料。

欄位
record_count

int64

上傳至目標的觀眾成員總數。包括要求中的所有目標對象成員，無論是否成功擷取都一樣。
partner_provided_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，無論是否成功擷取。

RemoveAllAudienceMembersStatus

這個類型沒有任何欄位。

移除所有目標對象成員要求的狀態。

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 資料的狀態。
composite_data_removal_status

RemoveCompositeDataStatus

從目的地移除複合資料的狀態。
google_user_id_data_removal_status

RemoveGoogleUserIdDataStatus

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

RemovePartnerProvidedIdDataStatus

從目的地移除合作夥伴提供的 ID 資料的狀態。

RemoveCompositeDataStatus

從目的地移除複合資料的狀態。

欄位
record_count

int64

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

DataTypeCount

移除要求中傳送的資料類型總數，並按資料類型細分。包括要求中的所有資料類型，無論是否已成功移除。

RemoveGoogleUserIdDataStatus

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

欄位
record_count

int64

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

int64

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

RemoveMobileDataStatus

從目的地移除行動資料的狀態。

欄位
record_count

int64

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

int64

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

RemovePairDataStatus

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

欄位
record_count

int64

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

int64

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

RemovePartnerProvidedIdDataStatus

從目的地移除合作夥伴提供的 ID 資料的狀態。

欄位
record_count

int64

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

int64

移除要求中傳送的合作夥伴提供 ID 總數。包括要求中所有合作夥伴提供的 ID，無論是否已成功移除。

RemovePpidDataStatus

從目的地移除 PPID 資料的狀態。

欄位
record_count

int64

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

int64

移除要求中傳送的 PPID 總數。包括要求中的所有 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 所有記錄都已成功處理，未發生任何錯誤。不過，「warning_info」欄位中可能會出現警告。
PROCESSING 系統正在處理要求。
FAILED 所有記錄的處理作業皆失敗。查看「error_info」欄位瞭解錯誤詳細資料，並查看「warning_info」欄位瞭解警告詳細資料。
PARTIAL_SUCCESS 部分記錄已順利處理完畢，但其他記錄發生錯誤。查看「error_info」欄位瞭解錯誤詳細資料，並查看「warning_info」欄位瞭解警告詳細資料。

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

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

如果合作夥伴連結包含 FEATURE_SET_AD_EVENT_MANAGEMENT 特徵集，則也支援下列欄位：

  • partner_customer_account.account_id
  • partner_link_metadata.implicit_accounts.account_id

範例：owning_account.account_type = "GOOGLE_ADS" AND 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 網域中，這份使用者名單的預估成員人數。這些成員可供搜尋廣告活動指定目標。
youtube_members_count

int64

僅供輸出。YouTube 上這個使用者清單的預估成員人數。
gmail_members_count

int64

僅供輸出。Gmail 中這個使用者名單的預估成員人數。

TargetNetworkInfo

不同目標聯播網的資格資訊。

欄位
eligible_for_display

bool

僅供輸出。指出這份使用者名單符合 Google 多媒體廣告聯播網的資格。

TargetingType

用於放送廣告的指定目標類型。

列舉
TARGETING_TYPE_UNSPECIFIED 未指定指定類型。
TARGETING_TYPE_AUDIENCE 指定目標對象。
TARGETING_TYPE_CONTEXTUAL 內容比對。
TARGETING_TYPE_DEMOGRAPHIC 指定客層。
TARGETING_TYPE_DEVICE 指定裝置。
TARGETING_TYPE_GEO 指定地理區域。
TARGETING_TYPE_INTEREST 指定興趣。
TARGETING_TYPE_PURCHASE_INTENT 購買意願指定目標。
TARGETING_TYPE_REMARKETING 再行銷指定目標。

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，系統會驗證要求，但不會執行要求。

使用者

代表單一使用者，包含個人識別資訊和行動裝置 ID 等 ID，這些 ID 都指向同一位使用者。

欄位
user_data

UserData

必填。多個使用者提供的資料，用來識別使用者。
mobile_data

MobileData

必填。多個行動裝置 ID 字串，代表單一使用者。

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

使用 SHA-256 雜湊函式，對經過正規化 (E164 標準) 的電話號碼進行雜湊處理。
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

與這個事件相關聯的使用者任何額外的使用者屬性。

欄位
property_name

string

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

string

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

ViewType

事件的類型。

列舉
VIEW_TYPE_UNSPECIFIED 未指定檢視畫面類型。
VIEW_TYPE_MRC_VIEWED 已查看 MRC。
VIEW_TYPE_MRC_RENDERED MRC 呈現。

ViewabilityInfo

已放送廣告的可視度詳細資料。

欄位
view_type

ViewType

必填。事件的類型。
viewable_percent

int32

(選用步驟) 可視像素的百分比 (0 到 100)。
viewable_duration

Duration

(選用步驟) 廣告可視時間長度。
media_skippable

bool

(選用步驟) 廣告媒體是否可略過。
media_quartile

MediaQuartile

(選用步驟) 媒體播放量 (以四分位數表示)。
media_duration

Duration

(選用步驟) 廣告媒體的時間長度。
media_volume_percent

int32

(選用步驟) 媒體播放音量的百分比 (0 到 100)。
playback_duration

Duration

(選用步驟) 廣告媒體的播放時間長度，無論廣告是否可視。

WarningCount

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

欄位
record_count

int64

有警告的記錄數量。
reason

ProcessingWarningReason

警告原因。

WarningInfo

各類型警告的警告次數。

欄位
warning_counts[]

WarningCount

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

WarningReason

在擷取期間傳回非封鎖警告的原因。

列舉
WARNING_REASON_UNSPECIFIED 未指定警告原因。
WARNING_REASON_CUSTOM_VARIABLE_NOT_ENABLED 帳戶未啟用 custom_variables 中的自訂變數。
WARNING_REASON_CUSTOM_VARIABLE_NOT_PREDEFINED custom_variables 中的自訂變數值不在目標帳戶為自訂變數設定的預先定義允許值中。
WARNING_REASON_CART_DATA_NOT_SUPPORTED_WITH_GBRAID_OR_WBRAID cart_data 不支援 gbraid 或 wbraid。
WARNING_REASON_CART_DATA_ITEM_MERCHANT_PRODUCT_ID_MISSING 購物車商品缺少「merchant_product_id」。
WARNING_REASON_CART_DATA_ITEM_UNIT_PRICE_MISSING 購物車商品缺少「unit_price」。
WARNING_REASON_GENERIC 不屬於其他特定類別的問題，會顯示一般警告原因。
WARNING_REASON_INVALID_CLIENT_ID client_id 無效。
WARNING_REASON_INVALID_SUBDIVISION_CODE subdivision_code 無效。
WARNING_REASON_INVALID_REGION_CODE region_code 無效。
WARNING_REASON_INVALID_SUBCONTINENT_CODE subcontinent_code 無效。
WARNING_REASON_INVALID_CONTINENT_CODE continent_code 無效。
WARNING_REASON_INVALID_DEVICE_CATEGORY 裝置 category 無效。
WARNING_REASON_INVALID_DEVICE_SCREEN_RESOLUTION 裝置 screen_height 或 screen_width 無效。
WARNING_REASON_INVALID_MERCHANT_ID merchant_id 無效。