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

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 khác trên mạng (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 của địa chỉ 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
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 được liên kết với nguồn cấp dữ liệu Merchant Center của các mặt hàng mà bạn tải 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.

Đí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. Sử dụng để tham chiếu Destination này trong IngestEventsRequest.
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 hoặc mã nhận dạng đối tượng Display & Video 360.

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.

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.

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

string

Bắt buộc. Giá trị nhận dạng duy nhất của sự kiện này.
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 khác trên mạng (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ể được nâng cấp để trở thành một phần của API.

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.

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á trên đám mây của Google Cloud Platform.
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.

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 sẽ được gửi đến đích đến đã chỉ định. Bạn có thể gửi tối đa 10.000 tài nguyên AudienceMember 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. Điều này có nghĩa 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 tệp UserData tải lên. 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.

Trường
destinations[]

Destination

Bắt buộc. Danh sách đích đến để gửi sự kiệ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 tài nguyên Event 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 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. Điều này có nghĩa 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 tệp UserData tải lên. 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.

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

Mã 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.

Sản phẩm

Đại diện cho một sản phẩm cụ thể của Google. Dùng để xác định vị trí tài khoản và đích đến.

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

Product

Bắt buộc. Sản phẩm mà tài khoản thuộc về. Ví dụ: GOOGLE_ADS.
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.

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.

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 tệp UserData tải lên. 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.

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 cho tất cả các lượt tải lên danh sách người dùng So khớp khách hàng.

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. Chứa một nhóm giá trị nhận dạng được so khớp cùng một lúc.