Package google.ads.datamanager.v1

Chỉ mục

IngestionService

Dịch vụ gửi dữ liệu đối tượng đến các đích đến được hỗ trợ.

IngestAudienceMembers

rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse)

Tải danh sách AudienceMember tài nguyên lên Destination đã cung cấp.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse)

Tải danh sách Event tài nguyên lên từ Destination được cung cấp.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)

Xoá danh sách tài nguyên AudienceMember khỏi Destination đã cung cấp.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

rpc RetrieveRequestStatus(RetrieveRequestStatusRequest) returns (RetrieveRequestStatusResponse)

Lấy trạng thái của một yêu cầu theo mã yêu cầu đã cho.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

AdIdentifiers

Giá trị nhận dạng và thông tin khác được dùng để so khớp sự kiện chuyển đổi với hoạt động trực tuyến khác (chẳng hạn như lượt nhấp vào quảng cáo).

Trường
session_attributes

string

Không bắt buộc. Thuộc tính của phiên để phân bổ và lập mô hình sự kiện.

gclid

string

Không bắt buộc. Mã lượt nhấp của Google (gclid) được liên kết với sự kiện này.

gbraid

string

Không bắt buộc. Giá trị nhận dạng lượt nhấp cho các lượt nhấp được liên kết với sự kiện trong ứng dụng và bắt nguồn từ các thiết bị iOS bắt đầu từ iOS14.

wbraid

string

Không bắt buộc. Giá trị nhận dạng lượt nhấp cho các lượt nhấp được liên kết với sự kiện trên web và bắt nguồn từ các thiết bị iOS bắt đầu từ iOS14.

landing_page_device_info

DeviceInfo

Không bắt buộc. Thông tin được thu thập về thiết bị đang được sử dụng (nếu có) tại thời điểm người dùng truy cập vào trang web của nhà quảng cáo sau khi tương tác với quảng cáo.

AddressInfo

Thông tin địa chỉ của người dùng.

Trường
given_name

string

Bắt buộc. Tên (tên) của người dùng, tất cả đều là chữ thường, không có dấu câu, không có khoảng trắng ở đầu hoặc cuối và được băm dưới dạng SHA-256.

family_name

string

Bắt buộc. Họ của người dùng, tất cả đều là chữ thường, không có dấu câu, không có khoảng trắng ở đầu hoặc cuối và được băm dưới dạng SHA-256.

region_code

string

Bắt buộc. Mã vùng gồm 2 chữ cái theo chuẩn ISO-3166-1 alpha-2 trong địa chỉ của người dùng.

postal_code

string

Bắt buộc. Mã bưu chính của địa chỉ người dùng.

AudienceMember

Thành viên khán giả cần được thao tác.

Trường
destination_references[]

string

Không bắt buộc. Xác định Destination nào để gửi thành viên đối tượng đến.

consent

Consent

Không bắt buộc. Chế độ cài đặt sự đồng ý cho người dùng.

Trường nhóm data. Loại dữ liệu nhận dạng cần được xử lý. data chỉ có thể là một trong những trạng thái sau:
user_data

UserData

Dữ liệu do người dùng cung cấp để xác định người dùng.

pair_data

PairData

Mã nhận dạng Điều chỉnh danh tính giữa nhà xuất bản và nhà quảng cáo (PAIR).

mobile_data

MobileData

Dữ liệu xác định thiết bị di động của người dùng.

CartData

Dữ liệu giỏ hàng được liên kết với sự kiện.

Trường
merchant_id

string

Không bắt buộc. Mã truy cập Merchant Center được liên kết với các mặt hàng.

merchant_feed_label

string

Không bắt buộc. Nhãn nguồn cấp dữ liệu Merchant Center được liên kết với nguồn cấp dữ liệu của các mặt hàng.

merchant_feed_language_code

string

Không bắt buộc. Mã ngôn ngữ theo tiêu chuẩn ISO 639-1 liên kết với nguồn cấp dữ liệu Merchant Center của các mặt hàng nơi bạn tải mặt hàng lên.

transaction_discount

double

Không bắt buộc. Tổng tất cả các khoản chiết khấu liên quan đến giao dịch.

items[]

Item

Không bắt buộc. Danh sách các mặt hàng liên kết với sự kiện.

Chế độ cài đặt về sự đồng ý theo Đạo luật thị trường kỹ thuật số (DMA) cho người dùng.

Trường
ad_user_data

ConsentStatus

Không bắt buộc. Biểu thị việc người dùng có đồng ý với dữ liệu người dùng quảng cáo hay không.

ad_personalization

ConsentStatus

Không bắt buộc. Biểu thị việc người dùng có đồng ý với chế độ cá nhân hoá quảng cáo hay không.

ConsentStatus

Biểu thị việc người dùng đã đồng ý, từ chối hay chưa chỉ định sự đồng ý.

Enum
CONSENT_STATUS_UNSPECIFIED Chưa chỉ định.
CONSENT_GRANTED Đã cấp.
CONSENT_DENIED Bị từ chối.

CustomVariable

Biến tuỳ chỉnh cho lượt chuyển đổi từ quảng cáo.

Trường
variable

string

Không bắt buộc. Tên của biến tuỳ chỉnh cần đặt. Nếu không tìm thấy biến cho đích đến đã cho, biến đó sẽ bị bỏ qua.

value

string

Không bắt buộc. Giá trị cần lưu trữ cho biến tuỳ chỉnh.

destination_references[]

string

Không bắt buộc. Chuỗi tham chiếu dùng để xác định Event.destination_references nào mà biến tuỳ chỉnh sẽ được gửi đến. Nếu bạn để trống, Event.destination_references sẽ được sử dụng.

CustomerType

Loại khách hàng liên kết với sự kiện.

Enum
CUSTOMER_TYPE_UNSPECIFIED CustomerType chưa được chỉ định. Không bao giờ được sử dụng.
NEW Khách hàng đó là khách hàng mới của nhà quảng cáo.
RETURNING Khách hàng đang quay lại nhà quảng cáo.
REENGAGED Khách hàng đã tương tác lại với nhà quảng cáo.

CustomerValueBucket

Giá trị do nhà quảng cáo đánh giá về khách hàng.

Enum
CUSTOMER_VALUE_BUCKET_UNSPECIFIED CustomerValueBucket chưa được chỉ định. Không bao giờ được sử dụng.
LOW Khách hàng có giá trị thấp.
MEDIUM Khách hàng có giá trị trung bình.
HIGH Khách hàng có giá trị cao.

Đích đến

Sản phẩm của Google mà bạn đang gửi dữ liệu đến. Ví dụ: tài khoản Google Ads.

Trường
reference

string

Không bắt buộc. Mã nhận dạng của tài nguyên Destination này, là mã nhận dạng duy nhất trong yêu cầu. Dùng để tham chiếu Destination này trong IngestEventsRequestIngestAudienceMembersRequest.

login_account

ProductAccount

Không bắt buộc. Tài khoản được dùng để thực hiện lệnh gọi API này. Để thêm hoặc xoá dữ liệu khỏi operating_account, login_account này phải có quyền ghi vào operating_account. Ví dụ: tài khoản người quản lý của operating_account hoặc tài khoản đã liên kết với operating_account.

linked_account

ProductAccount

Không bắt buộc. Một tài khoản mà login_account của người dùng gọi có quyền truy cập thông qua một mối liên kết tài khoản đã được thiết lập. Ví dụ: login_account của một đối tác dữ liệu có thể có quyền truy cập vào linked_account của một khách hàng. Đối tác có thể sử dụng trường này để gửi dữ liệu từ linked_account đến một operating_account khác.

operating_account

ProductAccount

Bắt buộc. Tài khoản để gửi dữ liệu đến hoặc xoá dữ liệu khỏi.

product_destination_id

string

Bắt buộc. Đối tượng trong tài khoản sản phẩm để nhập vào. Ví dụ: mã nhận dạng đối tượng Google Ads, mã nhận dạng đối tượng Display & Video 360 hoặc mã nhận dạng hành động chuyển đổi Google Ads.

DeviceInfo

Thông tin về thiết bị đang được sử dụng (nếu có) khi sự kiện xảy ra.

Trường
user_agent

string

Không bắt buộc. Chuỗi tác nhân người dùng của thiết bị cho ngữ cảnh đã cho.

ip_address

string

Không bắt buộc. Địa chỉ IP của thiết bị cho ngữ cảnh đã cho.

Lưu ý: Google Ads không hỗ trợ tính năng so khớp địa chỉ IP cho người dùng cuối ở Khu vực kinh tế Châu Âu (EEA), Vương quốc Anh (UK) hoặc Thuỵ Sĩ (CH). Thêm logic để loại trừ có điều kiện việc chia sẻ địa chỉ IP của người dùng ở những khu vực này và đảm bảo rằng bạn cung cấp cho người dùng thông tin rõ ràng và đầy đủ về dữ liệu mà bạn thu thập trên các trang web, ứng dụng và tài sản khác của mình, đồng thời nhận được sự đồng ý khi pháp luật hoặc bất kỳ chính sách nào hiện hành của Google yêu cầu. Hãy xem trang Giới thiệu về tính năng nhập lượt chuyển đổi ngoại tuyến để biết thêm thông tin chi tiết.

Mã hoá

Loại mã hoá của thông tin nhận dạng đã băm.

Enum
ENCODING_UNSPECIFIED Loại mã hoá chưa được chỉ định. Không bao giờ được sử dụng.
HEX Mã hoá theo hệ thập lục phân.
BASE64 Mã hoá Base 64.

EncryptionInfo

Thông tin mã hoá cho dữ liệu đang được truyền tải.

Trường
Trường nhóm wrapped_key. Khoá được bao bọc dùng để mã hoá dữ liệu. wrapped_key chỉ có thể là một trong những trạng thái sau:
gcp_wrapped_key_info

GcpWrappedKeyInfo

Thông tin về khoá được bao bọc của Google Cloud Platform.

ErrorCount

Số lỗi cho một lý do gây lỗi nhất định.

Trường
record_count

int64

Số lượng bản ghi không tải lên được vì một lý do nào đó.

reason

ProcessingErrorReason

Lý do xảy ra lỗi của các bản ghi không thành công.

ErrorInfo

Số lượng lỗi cho từng loại lỗi.

Trường
error_counts[]

ErrorCount

Danh sách lỗi và số lượng lỗi theo từng lý do gây ra lỗi. Có thể không được điền sẵn trong một số trường hợp.

Sự kiện

Một sự kiện đại diện cho hoạt động tương tác của người dùng với trang web hoặc ứng dụng của nhà quảng cáo.

Trường
destination_references[]

string

Không bắt buộc. Chuỗi tham chiếu dùng để xác định đích đến. Nếu bạn để trống, sự kiện sẽ được gửi đến tất cả destinations trong yêu cầu.

transaction_id

string

Không bắt buộc. Giá trị nhận dạng riêng biệt của sự kiện này. Bắt buộc đối với lượt chuyển đổi sử dụng nhiều nguồn dữ liệu.

event_timestamp

Timestamp

Bắt buộc. Thời gian xảy ra sự kiện.

last_updated_timestamp

Timestamp

Không bắt buộc. Lần gần đây nhất sự kiện được cập nhật.

user_data

UserData

Không bắt buộc. Các phần dữ liệu do người dùng cung cấp, thể hiện người dùng mà sự kiện được liên kết.

consent

Consent

Không bắt buộc. Thông tin về việc người dùng được liên kết có đồng ý với các loại đồng ý khác nhau hay không.

ad_identifiers

AdIdentifiers

Không bắt buộc. Giá trị nhận dạng và thông tin khác được dùng để so khớp sự kiện chuyển đổi với hoạt động trực tuyến khác (chẳng hạn như lượt nhấp vào quảng cáo).

currency

string

Không bắt buộc. Mã đơn vị tiền tệ được liên kết với tất cả giá trị bằng tiền trong sự kiện này.

conversion_value

double

Không bắt buộc. Giá trị lượt chuyển đổi được liên kết với sự kiện, đối với lượt chuyển đổi dựa trên giá trị.

event_source

EventSource

Không bắt buộc. Tín hiệu cho biết nơi xảy ra sự kiện (trên web, ứng dụng, tại cửa hàng, v.v.).

event_device_info

DeviceInfo

Không bắt buộc. Thông tin được thu thập về thiết bị đang được sử dụng (nếu có) khi sự kiện xảy ra.

cart_data

CartData

Không bắt buộc. Thông tin về giao dịch và các mặt hàng liên quan đến sự kiện.

custom_variables[]

CustomVariable

Không bắt buộc. Thông tin bổ sung về cặp khoá/giá trị để gửi đến các vùng chứa lượt chuyển đổi (hành động chuyển đổi hoặc hoạt động FL).

experimental_fields[]

ExperimentalField

Không bắt buộc. Danh sách các cặp khoá/giá trị cho các trường thử nghiệm có thể cuối cùng sẽ được nâng cấp để trở thành một phần của API.

user_properties

UserProperties

Không bắt buộc. Thông tin do nhà quảng cáo đánh giá về người dùng tại thời điểm xảy ra sự kiện.

EventSource

Nguồn của sự kiện.

Enum
EVENT_SOURCE_UNSPECIFIED EventSource chưa được chỉ định. Không bao giờ được sử dụng.
WEB Sự kiện này được tạo từ một trình duyệt web.
APP Sự kiện này được tạo từ một ứng dụng.
IN_STORE Sự kiện này được tạo từ một giao dịch tại cửa hàng thực tế.
PHONE Sự kiện này được tạo từ một cuộc gọi điện thoại.
OTHER Sự kiện này được tạo từ các nguồn khác.

ExperimentalField

Trường thử nghiệm đại diện cho các trường không chính thức.

Trường
field

string

Không bắt buộc. Tên của trường cần sử dụng.

value

string

Không bắt buộc. Giá trị của trường cần đặt.

GcpWrappedKeyInfo

Thông tin về khoá được bao bọc của Google Cloud Platform.

Trường
key_type

KeyType

Bắt buộc. Loại thuật toán được dùng để mã hoá dữ liệu.

wip_provider

string

Bắt buộc. Nhà cung cấp nhóm Workload Identity bắt buộc phải sử dụng KEK.

kek_uri

string

Bắt buộc. Mã tài nguyên Dịch vụ quản lý khoá đám mây của Google Cloud Platform. Phải có định dạng "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}".

encrypted_dek

string

Bắt buộc. Khoá mã hoá dữ liệu đã mã hoá được mã hoá base64.

KeyType

Loại thuật toán được dùng để mã hoá dữ liệu.

Enum
KEY_TYPE_UNSPECIFIED Loại khoá chưa được chỉ định. Không bao giờ được sử dụng.
XCHACHA20_POLY1305 Thuật toán XChaCha20-Poly1305

IngestAudienceMembersRequest

Yêu cầu tải thành viên đối tượng lên các đích đến được cung cấp. Trả về một IngestAudienceMembersResponse.

Bạn có thể thử phương thức này trong REST APIs Explorer:
Trường
destinations[]

Destination

Bắt buộc. Danh sách đích đến để chuyển các thành viên trong đối tượng đến.

audience_members[]

AudienceMember

Bắt buộc. Danh sách người dùng cần gửi đến đích đến đã chỉ định. Bạn có thể gửi tối đa 10.000 AudienceMember tài nguyên trong một yêu cầu.

consent

Consent

Không bắt buộc. Sự đồng ý ở cấp yêu cầu sẽ áp dụng cho tất cả người dùng trong yêu cầu. Sự đồng ý ở cấp người dùng sẽ ghi đè sự đồng ý ở cấp yêu cầu và có thể được chỉ định trong mỗi AudienceMember.

validate_only

bool

Không bắt buộc. Chỉ dùng cho mục đích kiểm thử. Nếu true, yêu cầu sẽ được xác thực nhưng không được thực thi. Chỉ trả về lỗi, không trả về kết quả.

encoding

Encoding

Không bắt buộc. Bắt buộc đối với tệp tải lên UserData. Loại mã hoá của giá trị nhận dạng người dùng. Đối với giá trị nhận dạng người dùng đã băm, đây là loại mã hoá của chuỗi đã băm. Đối với giá trị nhận dạng người dùng được băm đã mã hoá, đây là loại mã hoá của chuỗi được mã hoá bên ngoài, nhưng không nhất thiết phải là chuỗi được băm bên trong. Tức là chuỗi được băm bên trong có thể được mã hoá theo cách khác với chuỗi được mã hoá bên ngoài. Đối với các tệp tải lên không phải UserData, trường này sẽ bị bỏ qua.

encryption_info

EncryptionInfo

Không bắt buộc. Thông tin mã hoá cho nội dung tải lên UserData. Nếu bạn không đặt, thì hệ thống sẽ giả định rằng thông tin nhận dạng được tải lên đã được băm nhưng chưa được mã hoá. Đối với các tệp tải lên không phải UserData, trường này sẽ bị bỏ qua.

terms_of_service

TermsOfService

Không bắt buộc. Điều khoản dịch vụ mà người dùng đã chấp nhận/từ chối.

IngestAudienceMembersResponse

Câu trả lời của IngestAudienceMembersRequest.

Trường
request_id

string

Mã nhận dạng được tạo tự động của yêu cầu.

IngestEventsRequest

Yêu cầu tải thành viên đối tượng lên các đích đến được cung cấp. Trả về một IngestEventsResponse.

Bạn có thể thử phương thức này trong REST APIs Explorer:
Trường
destinations[]

Destination

Bắt buộc. Danh sách đích đến để gửi sự kiện đến.

events[]

Event

Bắt buộc. Danh sách các sự kiện cần gửi đến những đích đến được chỉ định. Bạn có thể gửi tối đa 2.000 Event tài nguyên trong một yêu cầu duy nhất.

consent

Consent

Không bắt buộc. Sự đồng ý ở cấp yêu cầu sẽ áp dụng cho tất cả người dùng trong yêu cầu. Sự đồng ý ở cấp người dùng sẽ ghi đè sự đồng ý ở cấp yêu cầu và có thể được chỉ định trong mỗi Event.

validate_only

bool

Không bắt buộc. Chỉ dùng cho mục đích kiểm thử. Nếu true, yêu cầu sẽ được xác thực nhưng không được thực thi. Chỉ trả về lỗi, không trả về kết quả.

encoding

Encoding

Không bắt buộc. Bắt buộc đối với tệp tải lên UserData. Loại mã hoá của giá trị nhận dạng người dùng. Đối với giá trị nhận dạng người dùng đã băm, đây là loại mã hoá của chuỗi đã băm. Đối với giá trị nhận dạng người dùng được băm đã mã hoá, đây là loại mã hoá của chuỗi được mã hoá bên ngoài, nhưng không nhất thiết phải là chuỗi được băm bên trong. Tức là chuỗi được băm bên trong có thể được mã hoá theo cách khác với chuỗi được mã hoá bên ngoài. Đối với các tệp tải lên không phải UserData, trường này sẽ bị bỏ qua.

encryption_info

EncryptionInfo

Không bắt buộc. Thông tin mã hoá cho nội dung tải lên UserData. Nếu bạn không đặt, thì hệ thống sẽ giả định rằng thông tin nhận dạng được tải lên đã được băm nhưng chưa được mã hoá. Đối với các tệp tải lên không phải UserData, trường này sẽ bị bỏ qua.

IngestEventsResponse

Câu trả lời của IngestEventsRequest.

Trường
request_id

string

Mã nhận dạng được tạo tự động của yêu cầu.

Mục

Biểu thị một mặt hàng trong giỏ hàng được liên kết với sự kiện.

Trường
merchant_product_id

string

Không bắt buộc. Mã sản phẩm trong tài khoản Merchant Center.

quantity

int64

Không bắt buộc. Số lượng mặt hàng này được liên kết với sự kiện.

unit_price

double

Không bắt buộc. Giá của từng đơn vị hàng, chưa bao gồm thuế, phí vận chuyển và mọi khoản chiết khấu ở cấp giao dịch.

MatchRateRange

Phạm vi tỷ lệ khớp của tệp tải lên hoặc danh sách người dùng.

Enum
MATCH_RATE_RANGE_UNKNOWN Chưa xác định được phạm vi tỷ lệ trùng khớp.
MATCH_RATE_RANGE_NOT_ELIGIBLE Phạm vi tỷ lệ khớp không đủ điều kiện.
MATCH_RATE_RANGE_LESS_THAN_20 Phạm vi tỷ lệ khớp dưới 20% (trong khoảng [0, 20)).
MATCH_RATE_RANGE_20_TO_30 Phạm vi tỷ lệ khớp nằm trong khoảng từ 20% đến 30% (trong khoảng [20, 31)).
MATCH_RATE_RANGE_31_TO_40 Phạm vi tỷ lệ khớp nằm trong khoảng từ 31% đến 40% (trong khoảng [31, 41)).
MATCH_RATE_RANGE_41_TO_50 Phạm vi tỷ lệ khớp nằm trong khoảng từ 41% đến 50% (trong khoảng [41, 51)).
MATCH_RATE_RANGE_51_TO_60 Phạm vi tỷ lệ khớp nằm trong khoảng từ 51% đến 60% (trong khoảng [51, 61).
MATCH_RATE_RANGE_61_TO_70 Tỷ lệ khớp nằm trong khoảng từ 61% đến 70% (trong khoảng [61, 71)).
MATCH_RATE_RANGE_71_TO_80 Phạm vi tỷ lệ khớp nằm trong khoảng từ 71% đến 80% (trong khoảng [71, 81)).
MATCH_RATE_RANGE_81_TO_90 Phạm vi tỷ lệ khớp nằm trong khoảng từ 81% đến 90% (trong khoảng [81, 91)).
MATCH_RATE_RANGE_91_TO_100

Phạm vi tỷ lệ khớp là từ 91% đến 100% (trong khoảng [91, 100]).

MobileData

Mã nhận dạng thiết bị di động cho đối tượng. Bạn phải có ít nhất một mã nhận dạng thiết bị di động.

Trường
mobile_ids[]

string

Bắt buộc. Danh sách mã thiết bị di động (mã nhận dạng cho quảng cáo/IDFA). Bạn có thể cung cấp tối đa 10 mobileIds trong một AudienceMember.

PairData

PAIR cho đối tượng. Bạn phải có ít nhất một mã PAIR.

Trường
pair_ids[]

string

Bắt buộc. Dữ liệu PII do clean room cung cấp, được băm bằng SHA256 và mã hoá bằng mật mã giao hoán EC bằng khoá của nhà xuất bản cho danh sách người dùng PAIR. Bạn có thể cung cấp tối đa 10 pairIds trong một AudienceMember.

ProcessingErrorReason

Lý do xảy ra lỗi trong quá trình xử lý.

Enum
PROCESSING_ERROR_REASON_UNSPECIFIED Chưa xác định được lý do gây ra lỗi xử lý.
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE Biến tuỳ chỉnh không hợp lệ.
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED Trạng thái của biến tuỳ chỉnh là chưa bật.
PROCESSING_ERROR_REASON_EVENT_TOO_OLD Lượt chuyển đổi cũ hơn độ tuổi tối đa được hỗ trợ.
PROCESSING_ERROR_REASON_DUPLICATE_GCLID Đã có một lượt chuyển đổi có cùng GCLID và thời gian chuyển đổi trong hệ thống.
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID Một lượt chuyển đổi có cùng kết hợp mã đơn đặt hàng và hành động chuyển đổi đã được tải lên.
PROCESSING_ERROR_REASON_INVALID_GBRAID Không thể giải mã gbraid.
PROCESSING_ERROR_REASON_INVALID_GCLID Không thể giải mã mã lượt nhấp của Google.
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID Mã người bán chứa các ký tự không phải là chữ số.
PROCESSING_ERROR_REASON_INVALID_WBRAID Không thể giải mã wbraid.
PROCESSING_ERROR_REASON_INTERNAL_ERROR Lỗi nội bộ.
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED Bạn chưa ký các điều khoản về tính năng lượt chuyển đổi nâng cao trong tài khoản đích.
PROCESSING_ERROR_REASON_INVALID_EVENT Sự kiện này không hợp lệ.
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS Số giao dịch được so khớp thấp hơn ngưỡng tối thiểu.
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS Các giao dịch này có giá trị thấp hơn ngưỡng tối thiểu.
PROCESSING_ERROR_REASON_INVALID_FORMAT Sự kiện có lỗi định dạng.
PROCESSING_ERROR_REASON_DECRYPTION_ERROR Sự kiện có lỗi giải mã.
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR Không giải mã được DEK.
PROCESSING_ERROR_REASON_INVALID_WIP WIP có định dạng không chính xác hoặc không tồn tại.
PROCESSING_ERROR_REASON_INVALID_KEK KEK không thể giải mã dữ liệu vì đây là KEK không chính xác hoặc không tồn tại.
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED Không thể sử dụng WIP vì điều kiện chứng thực của WIP đã từ chối.
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED Hệ thống không có các quyền cần thiết để truy cập vào KEK.
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR Không giải mã được dữ liệu UserIdentifier bằng DEK.
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER Người dùng đã cố gắng truyền các sự kiện bằng một giá trị nhận dạng quảng cáo không phải từ quảng cáo của tài khoản đang hoạt động.

ProcessingWarningReason

Lý do xuất hiện cảnh báo xử lý.

Enum
PROCESSING_WARNING_REASON_UNSPECIFIED Không xác định được lý do cảnh báo xử lý.
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED Hệ thống không có các quyền cần thiết để truy cập vào KEK.
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR Không giải mã được DEK.
PROCESSING_WARNING_REASON_DECRYPTION_ERROR Sự kiện có lỗi giải mã.
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED Không thể sử dụng WIP vì điều kiện chứng thực của WIP đã từ chối.
PROCESSING_WARNING_REASON_INVALID_WIP WIP có định dạng không chính xác hoặc không tồn tại.
PROCESSING_WARNING_REASON_INVALID_KEK KEK không thể giải mã dữ liệu vì đây là KEK không chính xác hoặc không tồn tại.
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR Không giải mã được dữ liệu UserIdentifier bằng DEK.
PROCESSING_WARNING_REASON_INTERNAL_ERROR Lỗi nội bộ.

Sản phẩm

Không dùng nữa. Thay vào đó, hãy sử dụng AccountType. Đại diện cho một sản phẩm cụ thể của Google.

Enum
PRODUCT_UNSPECIFIED Sản phẩm không xác định. Không bao giờ được sử dụng.
GOOGLE_ADS Google Ads.
DISPLAY_VIDEO_PARTNER Đối tác của Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Nhà quảng cáo Display & Video 360.
DATA_PARTNER Đối tác dữ liệu.

ProductAccount

Đại diện cho một tài khoản cụ thể.

Trường
product
(deprecated)

Product

Không dùng nữa. Thay vào đó, hãy sử dụng account_type.

account_id

string

Bắt buộc. Mã nhận dạng của tài khoản. Ví dụ: mã tài khoản Google Ads của bạn.

account_type

AccountType

Không bắt buộc. Loại tài khoản. Ví dụ: GOOGLE_ADS. Bạn phải cung cấp account_type hoặc product (không dùng nữa). Nếu bạn đặt cả hai, thì các giá trị phải khớp nhau.

AccountType

Biểu thị các loại tài khoản Google. Dùng để xác định vị trí tài khoản và đích đến.

Enum
ACCOUNT_TYPE_UNSPECIFIED Sản phẩm không xác định. Không bao giờ được sử dụng.
GOOGLE_ADS Google Ads.
DISPLAY_VIDEO_PARTNER Đối tác của Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Nhà quảng cáo Display & Video 360.
DATA_PARTNER Đối tác dữ liệu.

RemoveAudienceMembersRequest

Yêu cầu xoá người dùng khỏi một đối tượng trong các đích đến được cung cấp. Trả về một RemoveAudienceMembersResponse.

Bạn có thể thử phương thức này trong REST APIs Explorer:
Trường
destinations[]

Destination

Bắt buộc. Danh sách đích đến mà bạn muốn xoá người dùng.

audience_members[]

AudienceMember

Bắt buộc. Danh sách người dùng cần xoá.

validate_only

bool

Không bắt buộc. Chỉ dùng cho mục đích kiểm thử. Nếu true, yêu cầu sẽ được xác thực nhưng không được thực thi. Chỉ trả về lỗi, không trả về kết quả.

encoding

Encoding

Không bắt buộc. Bắt buộc đối với tệp tải lên UserData. Loại mã hoá của giá trị nhận dạng người dùng. Chỉ áp dụng cho lớp mã hoá bên ngoài đối với giá trị nhận dạng người dùng được mã hoá. Đối với các tệp tải lên không phải UserData, trường này sẽ bị bỏ qua.

encryption_info

EncryptionInfo

Không bắt buộc. Thông tin mã hoá cho nội dung tải lên UserData. Nếu bạn không đặt, thì hệ thống sẽ giả định rằng thông tin nhận dạng được tải lên đã được băm nhưng chưa được mã hoá. Đối với các tệp tải lên không phải UserData, trường này sẽ bị bỏ qua.

RemoveAudienceMembersResponse

Câu trả lời của RemoveAudienceMembersRequest.

Trường
request_id

string

Mã nhận dạng được tạo tự động của yêu cầu.

RequestStatusPerDestination

Trạng thái yêu cầu cho mỗi đích đến.

Trường
destination

Destination

Một đích đến trong yêu cầu DM API.

request_status

RequestStatus

Trạng thái yêu cầu của đích đến.

error_info

ErrorInfo

Một lỗi thông tin lỗi chứa lý do lỗi và số lượng lỗi liên quan đến quá trình tải lên.

warning_info

WarningInfo

Thông tin cảnh báo chứa lý do cảnh báo và số lượng cảnh báo liên quan đến tệp tải lên.

Trường nhóm status. Trạng thái của đích đến. status chỉ có thể là một trong những trạng thái sau:
audience_members_ingestion_status

IngestAudienceMembersStatus

Trạng thái của yêu cầu về việc tiếp nhận hội viên là khán giả.

events_ingestion_status

IngestEventsStatus

Trạng thái của yêu cầu về sự kiện truyền trực tiếp.

audience_members_removal_status

RemoveAudienceMembersStatus

Trạng thái của yêu cầu xoá thành viên khỏi đối tượng.

IngestAudienceMembersStatus

Trạng thái của yêu cầu về việc tiếp nhận hội viên là khán giả.

Trường
Trường nhóm status. Trạng thái nhập thành viên đối tượng vào đích đến. status chỉ có thể là một trong những trạng thái sau:
user_data_ingestion_status

IngestUserDataStatus

Trạng thái của quá trình tiếp nhận dữ liệu người dùng vào đích đến.

mobile_data_ingestion_status

IngestMobileDataStatus

Trạng thái của quá trình nhập dữ liệu di động vào đích đến.

pair_data_ingestion_status

IngestPairDataStatus

Trạng thái của quá trình nhập dữ liệu theo cặp vào đích đến.

IngestEventsStatus

Trạng thái của việc chuyển đổi sự kiện sang đích đến.

Trường
record_count

int64

Tổng số sự kiện được gửi trong yêu cầu tải lên. Bao gồm tất cả sự kiện trong yêu cầu, bất kể sự kiện đó có được truyền tải thành công hay không.

IngestMobileDataStatus

Trạng thái của quá trình nhập dữ liệu di động vào đích đến chứa số liệu thống kê liên quan đến quá trình nhập.

Trường
record_count

int64

Tổng số thành viên đối tượng được gửi trong yêu cầu tải lên cho đích đến. Bao gồm tất cả thành viên đối tượng trong yêu cầu, bất kể họ có được tiếp nhận thành công hay không.

mobile_id_count

int64

Tổng số mã nhận dạng thiết bị di động được gửi trong yêu cầu tải lên cho đích đến. Bao gồm tất cả mã nhận dạng thiết bị di động trong yêu cầu, bất kể mã nhận dạng đó có được nhập thành công hay không.

IngestPairDataStatus

Trạng thái của quá trình nhập dữ liệu cặp vào đích đến chứa số liệu thống kê liên quan đến quá trình nhập.

Trường
record_count

int64

Tổng số thành viên đối tượng được gửi trong yêu cầu tải lên cho đích đến. Bao gồm tất cả thành viên đối tượng trong yêu cầu, bất kể họ có được tiếp nhận thành công hay không.

pair_id_count

int64

Tổng số mã nhận dạng theo cặp được gửi trong yêu cầu tải lên cho đích đến. Bao gồm tất cả mã nhận dạng cặp trong yêu cầu, bất kể chúng có được nhập thành công hay không.

IngestUserDataStatus

Trạng thái của quá trình truyền dữ liệu người dùng đến đích đến chứa số liệu thống kê liên quan đến quá trình truyền.

Trường
record_count

int64

Tổng số thành viên đối tượng được gửi trong yêu cầu tải lên cho đích đến. Bao gồm tất cả thành viên đối tượng trong yêu cầu, bất kể họ có được tiếp nhận thành công hay không.

user_identifier_count

int64

Tổng số giá trị nhận dạng người dùng được gửi trong yêu cầu tải lên cho đích đến. Bao gồm tất cả giá trị nhận dạng người dùng trong yêu cầu, bất kể giá trị đó có được truyền thành công hay không.

upload_match_rate_range

MatchRateRange

Phạm vi tỷ lệ khớp của nội dung tải lên.

RemoveAudienceMembersStatus

Trạng thái của yêu cầu xoá thành viên khỏi đối tượng.

Trường
Trường nhóm status. Trạng thái xoá thành viên đối tượng khỏi đích đến. status chỉ có thể là một trong những trạng thái sau:
user_data_removal_status

RemoveUserDataStatus

Trạng thái xoá dữ liệu người dùng khỏi đích đến.

mobile_data_removal_status

RemoveMobileDataStatus

Trạng thái xoá dữ liệu di động khỏi đích đến.

pair_data_removal_status

RemovePairDataStatus

Trạng thái xoá dữ liệu cặp khỏi đích đến.

RemoveMobileDataStatus

Trạng thái xoá dữ liệu di động khỏi đích đến.

Trường
record_count

int64

Tổng số thành viên trong đối tượng được gửi trong yêu cầu xoá. Bao gồm tất cả thành viên trong đối tượng trong yêu cầu, bất kể họ có được xoá thành công hay không.

mobile_id_count

int64

Tổng số mã nhận dạng thiết bị di động được gửi trong yêu cầu gỡ bỏ. Bao gồm tất cả mã nhận dạng thiết bị di động trong yêu cầu, bất kể mã nhận dạng đó có được xoá thành công hay không.

RemovePairDataStatus

Trạng thái xoá dữ liệu cặp khỏi đích đến.

Trường
record_count

int64

Tổng số thành viên trong đối tượng được gửi trong yêu cầu xoá. Bao gồm tất cả thành viên trong đối tượng trong yêu cầu, bất kể họ có được xoá thành công hay không.

pair_id_count

int64

Tổng số mã nhận dạng cặp được gửi trong yêu cầu gỡ bỏ. Bao gồm tất cả mã nhận dạng cặp trong yêu cầu, bất kể chúng có được xoá thành công hay không.

RemoveUserDataStatus

Trạng thái xoá dữ liệu người dùng khỏi đích đến.

Trường
record_count

int64

Tổng số thành viên trong đối tượng được gửi trong yêu cầu xoá. Bao gồm tất cả thành viên trong đối tượng trong yêu cầu, bất kể họ có được xoá thành công hay không.

user_identifier_count

int64

Tổng số giá trị nhận dạng người dùng được gửi trong yêu cầu xoá. Bao gồm tất cả giá trị nhận dạng người dùng trong yêu cầu, bất kể chúng có được xoá thành công hay không.

RequestStatus

Trạng thái yêu cầu.

Enum
REQUEST_STATUS_UNKNOWN Trạng thái của yêu cầu là không xác định.
SUCCESS Yêu cầu thành công.
PROCESSING Yêu cầu đang được xử lý.
FAILED Yêu cầu không thành công.
PARTIAL_SUCCESS Yêu cầu thành công một phần.

RetrieveRequestStatusRequest

Yêu cầu lấy trạng thái của yêu cầu được gửi đến DM API cho một mã yêu cầu nhất định. Trả về một RetrieveRequestStatusResponse.

Bạn có thể thử phương thức này trong REST APIs Explorer:
Trường
request_id

string

Bắt buộc. Bắt buộc. Mã yêu cầu của yêu cầu Data Manager API.

RetrieveRequestStatusResponse

Câu trả lời của RetrieveRequestStatusRequest.

Trường
request_status_per_destination[]

RequestStatusPerDestination

Danh sách trạng thái yêu cầu cho mỗi đích đến. Thứ tự của các trạng thái khớp với thứ tự của các đích đến trong yêu cầu ban đầu.

TermsOfService

Điều khoản dịch vụ mà người dùng đã chấp nhận/từ chối.

Trường
customer_match_terms_of_service_status

TermsOfServiceStatus

Không bắt buộc. Điều khoản dịch vụ về tính năng So khớp khách hàng: https://support.google.com/adspolicy/answer/6299717. Bạn phải chấp nhận điều này khi tiếp nhận UserData hoặc MobileData. Bạn không bắt buộc phải điền trường này cho Danh sách người dùng so khớp đối tác.

TermsOfServiceStatus

Biểu thị quyết định của người gọi về việc chấp nhận hoặc từ chối điều khoản dịch vụ.

Enum
TERMS_OF_SERVICE_STATUS_UNSPECIFIED Chưa chỉ định.
ACCEPTED Trạng thái cho biết người gọi đã chọn chấp nhận điều khoản dịch vụ.
REJECTED Trạng thái cho biết người gọi đã chọn từ chối điều khoản dịch vụ.

UserData

Dữ liệu nhận dạng người dùng. Bạn phải cung cấp ít nhất một giá trị nhận dạng.

Trường
user_identifiers[]

UserIdentifier

Bắt buộc. Giá trị nhận dạng của người dùng. Bạn có thể cung cấp nhiều phiên bản của cùng một loại dữ liệu (ví dụ: nhiều địa chỉ email). Để tăng khả năng trùng khớp, hãy cung cấp càng nhiều giá trị nhận dạng càng tốt. Bạn có thể cung cấp tối đa 10 userIdentifiers trong một AudienceMember hoặc Event.

UserIdentifier

Giá trị nhận dạng duy nhất cho người dùng.

Trường
Trường nhóm identifier. Bạn phải chỉ định đúng một. identifier chỉ có thể là một trong những trạng thái sau:
email_address

string

Địa chỉ email đã băm bằng hàm băm SHA-256 sau khi chuẩn hoá.

phone_number

string

Số điện thoại đã băm bằng hàm băm SHA-256 sau khi chuẩn hoá (tiêu chuẩn E164).

address

AddressInfo

Các thành phần đã biết trong địa chỉ của người dùng. Lưu trữ một nhóm giá trị nhận dạng được so khớp cùng một lúc.

UserProperties

Thông tin do nhà quảng cáo đánh giá về người dùng tại thời điểm xảy ra sự kiện. Hãy xem https://support.google.com/google-ads/answer/14007601 để biết thêm thông tin.

Trường
customer_type

CustomerType

Không bắt buộc. Loại khách hàng liên kết với sự kiện.

customer_value_bucket

CustomerValueBucket

Không bắt buộc. Giá trị do nhà quảng cáo đánh giá về khách hàng.

WarningCount

Số lượng cảnh báo cho một lý do cảnh báo nhất định.

Trường
record_count

int64

Số lượng bản ghi có cảnh báo.

reason

ProcessingWarningReason

Lý do cảnh báo.

WarningInfo

Số lượng cảnh báo cho từng loại cảnh báo.

Trường
warning_counts[]

WarningCount

Danh sách cảnh báo và số lượng theo từng lý do cảnh báo.