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

MarketingDataInsightsService

Dịch vụ trả về thông tin chi tiết về dữ liệu tiếp thị.

Tính năng này chỉ dành cho các đối tác dữ liệu.

RetrieveInsights

rpc RetrieveInsights(RetrieveInsightsRequest) returns (RetrieveInsightsResponse)

Truy xuất thông tin chi tiết về dữ liệu tiếp thị cho một danh sách người dùng nhất định.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Tiêu đề uỷ quyền:

Phương thức này hỗ trợ các tiêu đề không bắt buộc sau đây để xác định cách API cho phép truy cập vào yêu cầu:

  • login-account: (Không bắt buộc) Tên tài nguyên của tài khoản mà Tài khoản Google của thông tin đăng nhập là người dùng. Nếu không được đặt, giá trị mặc định sẽ là tài khoản của yêu cầu. Định dạng: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (Không bắt buộc) Tên tài nguyên của tài khoản có một đường liên kết đến sản phẩm đã thiết lập với login-account. Định dạng: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
Phạm vi uỷ quyền

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

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

PartnerLinkService

Dịch vụ quản lý đường liên kết của đối tác.

UserListDirectLicenseService

Dịch vụ quản lý giấy phép trực tiếp cho danh sách người dùng. Xoá không phải là một thao tác được hỗ trợ cho UserListDirectLicenses. Người gọi nên cập nhật trạng thái giấy phép thành DISABLED (ĐÃ TẮT) thay vì vô hiệu hoá giấy phép.

Tính năng này chỉ dành cho các đối tác dữ liệu.

CreateUserListDirectLicense

rpc CreateUserListDirectLicense(CreateUserListDirectLicenseRequest) returns (UserListDirectLicense)

Tạo giấy phép trực tiếp cho danh sách người dùng.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Phạm vi uỷ quyền

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

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

rpc GetUserListDirectLicense(GetUserListDirectLicenseRequest) returns (UserListDirectLicense)

Truy xuất giấy phép trực tiếp cho danh sách người dùng.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Phạm vi uỷ quyền

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

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

rpc ListUserListDirectLicenses(ListUserListDirectLicensesRequest) returns (ListUserListDirectLicensesResponse)

Liệt kê tất cả giấy phép trực tiếp cho danh sách người dùng mà tài khoản mẹ sở hữu.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Phạm vi uỷ quyền

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

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

rpc UpdateUserListDirectLicense(UpdateUserListDirectLicenseRequest) returns (UserListDirectLicense)

Cập nhật giấy phép trực tiếp của danh sách người dùng.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Phạm vi uỷ quyền

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

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

UserListGlobalLicenseService

Dịch vụ quản lý giấy phép toàn cầu cho danh sách người dùng. Xoá không phải là một thao tác được hỗ trợ cho UserListGlobalLicenses. Người gọi nên cập nhật trạng thái giấy phép thành DISABLED (ĐÃ TẮT) thay vì vô hiệu hoá giấy phép.

Tính năng này chỉ dành cho các đối tác dữ liệu.

CreateUserListGlobalLicense

rpc CreateUserListGlobalLicense(CreateUserListGlobalLicenseRequest) returns (UserListGlobalLicense)

Tạo giấy phép toàn cầu cho danh sách người dùng.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Phạm vi uỷ quyền

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

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

rpc GetUserListGlobalLicense(GetUserListGlobalLicenseRequest) returns (UserListGlobalLicense)

Truy xuất giấy phép toàn cầu cho danh sách người dùng.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Phạm vi uỷ quyền

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

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

rpc ListUserListGlobalLicenseCustomerInfos(ListUserListGlobalLicenseCustomerInfosRequest) returns (ListUserListGlobalLicenseCustomerInfosResponse)

Liệt kê tất cả thông tin khách hàng cho giấy phép toàn cầu của danh sách người dùng.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Phạm vi uỷ quyền

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

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

rpc ListUserListGlobalLicenses(ListUserListGlobalLicensesRequest) returns (ListUserListGlobalLicensesResponse)

Liệt kê tất cả giấy phép toàn cầu cho danh sách người dùng mà tài khoản chính sở hữu.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Phạm vi uỷ quyền

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

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

rpc UpdateUserListGlobalLicense(UpdateUserListGlobalLicenseRequest) returns (UserListGlobalLicense)

Cập nhật giấy phép chung của danh sách người dùng.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Phạm vi uỷ quyền

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

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

UserListService

Dịch vụ để quản lý tài nguyên UserList.

CreateUserList

rpc CreateUserList(CreateUserListRequest) returns (UserList)

Tạo một UserList.

Tiêu đề uỷ quyền:

Phương thức này hỗ trợ các tiêu đề không bắt buộc sau đây để xác định cách API cho phép truy cập vào yêu cầu:

  • login-account: (Không bắt buộc) Tên tài nguyên của tài khoản mà Tài khoản Google của thông tin đăng nhập là người dùng. Nếu không được đặt, giá trị mặc định sẽ là tài khoản của yêu cầu. Định dạng: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (Không bắt buộc) Tên tài nguyên của tài khoản có một đường liên kết đến sản phẩm đã thiết lập với login-account. Định dạng: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
Phạm vi uỷ quyền

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

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

rpc DeleteUserList(DeleteUserListRequest) returns (Empty)

Xoá một UserList.

Tiêu đề uỷ quyền:

Phương thức này hỗ trợ các tiêu đề không bắt buộc sau đây để xác định cách API cho phép truy cập vào yêu cầu:

  • login-account: (Không bắt buộc) Tên tài nguyên của tài khoản mà Tài khoản Google của thông tin đăng nhập là người dùng. Nếu không được đặt, giá trị mặc định sẽ là tài khoản của yêu cầu. Định dạng: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (Không bắt buộc) Tên tài nguyên của tài khoản có một đường liên kết đến sản phẩm đã thiết lập với login-account. Định dạng: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
Phạm vi uỷ quyền

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

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

rpc GetUserList(GetUserListRequest) returns (UserList)

Lấy một UserList.

Tiêu đề uỷ quyền:

Phương thức này hỗ trợ các tiêu đề không bắt buộc sau đây để xác định cách API cho phép truy cập vào yêu cầu:

  • login-account: (Không bắt buộc) Tên tài nguyên của tài khoản mà Tài khoản Google của thông tin đăng nhập là người dùng. Nếu không được đặt, giá trị mặc định sẽ là tài khoản của yêu cầu. Định dạng: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (Không bắt buộc) Tên tài nguyên của tài khoản có một đường liên kết đến sản phẩm đã thiết lập với login-account. Định dạng: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
Phạm vi uỷ quyền

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

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

rpc ListUserLists(ListUserListsRequest) returns (ListUserListsResponse)

Liệt kê UserLists.

Tiêu đề uỷ quyền:

Phương thức này hỗ trợ các tiêu đề không bắt buộc sau đây để xác định cách API cho phép truy cập vào yêu cầu:

  • login-account: (Không bắt buộc) Tên tài nguyên của tài khoản mà Tài khoản Google của thông tin đăng nhập là người dùng. Nếu không được đặt, giá trị mặc định sẽ là tài khoản của yêu cầu. Định dạng: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (Không bắt buộc) Tên tài nguyên của tài khoản có một đường liên kết đến sản phẩm đã thiết lập với login-account. Định dạng: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
Phạm vi uỷ quyền

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

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

rpc UpdateUserList(UpdateUserListRequest) returns (UserList)

Cập nhật một UserList.

Tiêu đề uỷ quyền:

Phương thức này hỗ trợ các tiêu đề không bắt buộc sau đây để xác định cách API cho phép truy cập vào yêu cầu:

  • login-account: (Không bắt buộc) Tên tài nguyên của tài khoản mà Tài khoản Google của thông tin đăng nhập là người dùng. Nếu không được đặt, giá trị mặc định sẽ là tài khoản của yêu cầu. Định dạng: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (Không bắt buộc) Tên tài nguyên của tài khoản có một đường liên kết đến sản phẩm đã thiết lập với login-account. Định dạng: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
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. Mã lượt nhấp cho các lượt nhấp được liên kết với sự kiện ứ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.

Độ Tuổi

Phạm vi độ tuổi nhân khẩu học

Enum
AGE_RANGE_UNSPECIFIED Chưa chỉ định.
AGE_RANGE_UNKNOWN Không xác định.
AGE_RANGE_18_24 Từ 18 đến 24 tuổi.
AGE_RANGE_25_34 Từ 25 đến 34 tuổi.
AGE_RANGE_35_44 Từ 35 đến 44 tuổi.
AGE_RANGE_45_54 Từ 45 đến 54 tuổi.
AGE_RANGE_55_64 Từ 55 đến 64 tuổi.
AGE_RANGE_65_UP Từ 65 tuổi trở lên.

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

Tính năng này chỉ dành cho các đối tác dữ liệu.

mobile_data

MobileData

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

user_id_data

UserIdData

Dữ liệu liên quan đến giá trị nhận dạng riêng biệt cho một người dùng, do nhà quảng cáo xác định.

ppid_data

PpidData

Dữ liệu liên quan đến giá trị nhận dạng do nhà xuất bản cung cấp.

Tính năng này chỉ dành cho các đối tác dữ liệu.

AwsWrappedKeyInfo

Khoá mã hoá dữ liệu được gói bằng khoá AWS KMS.

Trường
key_type

KeyType

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

role_arn

string

Bắt buộc. Tên tài nguyên Amazon của vai trò IAM cần giả định để có quyền truy cập giải mã KMS. Phải ở định dạng arn:{partition}:iam::{account_id}:role/{role_name}

kek_uri

string

Bắt buộc. URI của khoá AWS KMS dùng để giải mã DEK. Phải ở định dạng arn:{partition}:kms:{region}:{account_id}:key/{key_id} hoặc aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id}

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

Đường cơ sở

Tiêu chí cơ sở để so sánh thông tin chi tiết.

Trường
Trường nhóm baseline. Vị trí cơ sở dùng để so sánh thông tin chi tiết. baseline chỉ có thể là một trong những trạng thái sau:
baseline_location

Location

Vị trí cơ sở của yêu cầu. Vị trí cơ sở là danh sách OR của các khu vực được yêu cầu.

location_auto_detection_enabled

bool

Nếu được đặt thành true, dịch vụ sẽ cố gắng tự động phát hiện vị trí cơ sở cho thông tin chi tiết.

Thông tin vị trí

Vị trí cơ sở của yêu cầu. Vị trí cơ sở nằm trong danh sách OR của mã vùng ISO 3166-1 alpha-2 của các vùng được yêu cầu.

Trường
region_codes[]

string

Danh sách mã vùng gồm 2 chữ cái theo định dạng ISO 3166-1.

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 ý 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 trạng thái đồng ý.

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

ContactIdInfo

Thông tin bổ sung khi CONTACT_ID là một trong các upload_key_types.

Trường
match_rate_percentage

int32

Chỉ có đầu ra. Tỷ lệ khớp cho danh sách người dùng so khớp khách hàng.

data_source_type

DataSourceType

Không bắt buộc. Không thể thay đổi. Nguồn dữ liệu tải lên

CreatePartnerLinkRequest

Yêu cầu tạo tài nguyên PartnerLink. Trả về một PartnerLink.

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

string

Bắt buộc. Tổ chức mẹ sở hữu bộ sưu tập đường liên kết đến đối tác này. Định dạng: accountTypes/{account_type}/accounts/{account}

CreateUserListDirectLicenseRequest

Yêu cầu tạo tài nguyên UserListDirectLicense.

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

string

Bắt buộc. Tài khoản sở hữu danh sách người dùng đang được cấp phép. Phải có định dạng accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

user_list_direct_license

UserListDirectLicense

Bắt buộc. Người dùng có giấy phép trực tiếp để tạo danh sách.

CreateUserListGlobalLicenseRequest

Yêu cầu tạo tài nguyên UserListGlobalLicense.

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

string

Bắt buộc. Tài khoản sở hữu danh sách người dùng đang được cấp phép. Phải có định dạng accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

user_list_global_license

UserListGlobalLicense

Bắt buộc. Giấy phép chung để tạo danh sách người dùng.

CreateUserListRequest

Thông báo yêu cầu cho CreateUserList.

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

string

Bắt buộc. Tài khoản mẹ nơi danh sách người dùng này sẽ được tạo. Định dạng: accountTypes/{account_type}/accounts/{account}

user_list

UserList

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

validate_only

bool

Không bắt buộc. Nếu đúng, yêu cầu sẽ được xác thực nhưng không được thực thi.

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 được 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.

DataSourceType

Cho biết nguồn dữ liệu tải lên.

Enum
DATA_SOURCE_TYPE_UNSPECIFIED Chưa chỉ định.
DATA_SOURCE_TYPE_FIRST_PARTY Dữ liệu được tải lên là dữ liệu của bên thứ nhất.
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU Dữ liệu được tải lên là của một văn phòng tín dụng bên thứ ba.
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE Dữ liệu được tải lên là từ một tệp cử tri của bên thứ ba.
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA Dữ liệu được tải lên là dữ liệu của đối tác bên thứ ba.

DeletePartnerLinkRequest

Yêu cầu xoá tài nguyên PartnerLink. Trả về một google.protobuf.Empty.

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

string

Bắt buộc. Tên tài nguyên của mối liên kết với đối tác cần xoá. Định dạng: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

DeleteUserListRequest

Thông báo yêu cầu cho DeleteUserList.

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

string

Bắt buộc. Tên của danh sách người dùng cần xoá. Định dạng: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

validate_only

bool

Không bắt buộc. Nếu đúng, yêu cầu sẽ được xác thực nhưng không được thực thi.

Đí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). Hãy 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 luật pháp 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ã hóa

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.

aws_wrapped_key_info

AwsWrappedKeyInfo

Thông tin khoá được bao bọc của Amazon Web Services.

ErrorCount

Số lỗi cho một lý do 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 nhất định.

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.

ErrorReason

Lý do xảy ra lỗi cho Data Manager API. LƯU Ý: Enum này không cố định và có thể thêm các giá trị mới trong tương lai.

Enum
ERROR_REASON_UNSPECIFIED Không sử dụng giá trị mặc định này.
INTERNAL_ERROR Đã xảy ra lỗi nội bộ.
DEADLINE_EXCEEDED Yêu cầu mất quá nhiều thời gian để phản hồi.
RESOURCE_EXHAUSTED Có quá nhiều yêu cầu.
NOT_FOUND Không tìm thấy tài nguyên.
PERMISSION_DENIED Người dùng không có quyền hoặc không tìm thấy tài nguyên.
INVALID_ARGUMENT Đã xảy ra sự cố với yêu cầu.
REQUIRED_FIELD_MISSING Thiếu trường bắt buộc.
INVALID_FORMAT Định dạng không hợp lệ.
INVALID_HEX_ENCODING Giá trị được mã hoá theo hệ thập lục phân sai định dạng.
INVALID_BASE64_ENCODING Giá trị được mã hoá base64 sai định dạng.
INVALID_SHA256_FORMAT Giá trị SHA256 được mã hoá sai định dạng.
INVALID_POSTAL_CODE Mã bưu chính không hợp lệ.
INVALID_COUNTRY_CODE Mã quốc gia không hợp lệ.
INVALID_ENUM_VALUE Không thể sử dụng giá trị enum.
INVALID_USER_LIST_TYPE Không thể áp dụng loại danh sách người dùng này cho yêu cầu này.
INVALID_AUDIENCE_MEMBER Thành viên đối tượng này không hợp lệ.
TOO_MANY_AUDIENCE_MEMBERS Số lượng thành viên tối đa được phép trong mỗi yêu cầu là 10.000.
TOO_MANY_USER_IDENTIFIERS Số lượng mã nhận dạng người dùng tối đa được phép cho mỗi thành viên đối tượng là 10.
TOO_MANY_DESTINATIONS Mỗi yêu cầu chỉ được phép có tối đa 10 đích đến.
INVALID_DESTINATION Điểm đến này không hợp lệ.
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED Đối tác dữ liệu không có quyền truy cập vào danh sách người dùng thuộc tài khoản hoạt động.
INVALID_MOBILE_ID_FORMAT Định dạng mã nhận dạng thiết bị di động không hợp lệ.
INVALID_USER_LIST_ID Danh sách người dùng không hợp lệ.
MULTIPLE_DATA_TYPES_NOT_ALLOWED Bạn không được phép nhập nhiều loại dữ liệu trong một yêu cầu.
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER Các cấu hình đích chứa tài khoản đăng nhập DataPartner phải có cùng tài khoản đăng nhập trên tất cả các cấu hình đích.
TERMS_AND_CONDITIONS_NOT_SIGNED Bạn chưa chấp nhận các điều khoản và điều kiện bắt buộc.
INVALID_NUMBER_FORMAT Định dạng số không hợp lệ.
INVALID_CONVERSION_ACTION_ID Mã hành động chuyển đổi không hợp lệ.
INVALID_CONVERSION_ACTION_TYPE Loại hành động chuyển đổi không hợp lệ.
INVALID_CURRENCY_CODE Mã đơn vị tiền tệ không được hỗ trợ.
INVALID_EVENT Sự kiện này không hợp lệ.
TOO_MANY_EVENTS Số lượng sự kiện tối đa được phép cho mỗi yêu cầu là 10.000.
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS Tài khoản đích chưa bật tính năng lượt chuyển đổi nâng cao cho khách hàng tiềm năng.
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS Không thể sử dụng tính năng lượt chuyển đổi nâng cao cho tài khoản đích do chính sách về dữ liệu khách hàng của Google. Liên hệ với người đại diện của Google.
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED Tài khoản đích chưa đồng ý với các điều khoản về tính năng lượt chuyển đổi nâng cao.
DUPLICATE_DESTINATION_REFERENCE Hai hoặc nhiều đích đến trong yêu cầu có cùng thông tin tham chiếu.
UNSUPPORTED_OPERATING_ACCOUNT_FOR_DATA_PARTNER Tài khoản hoạt động không được hỗ trợ để uỷ quyền cho đối tác dữ liệu.
UNSUPPORTED_LINKED_ACCOUNT_FOR_DATA_PARTNER Tài khoản được liên kết không được hỗ trợ để uỷ quyền cho đối tác dữ liệu.
NO_IDENTIFIERS_PROVIDED Dữ liệu sự kiện không chứa giá trị nhận dạng người dùng hoặc giá trị nhận dạng quảng cáo.
INVALID_PROPERTY_TYPE Loại tài sản không được hỗ trợ.
INVALID_STREAM_TYPE Loại luồng phát không được hỗ trợ.
LINKED_ACCOUNT_ONLY_ALLOWED_WITH_DATA_PARTNER_LOGIN_ACCOUNT Tài khoản được liên kết chỉ được hỗ trợ khi tài khoản đăng nhập là tài khoản DATA_PARTNER.
OPERATING_ACCOUNT_LOGIN_ACCOUNT_MISMATCH Tài khoản đăng nhập phải giống với tài khoản hoạt động cho trường hợp sử dụng đã cho.
EVENT_TIME_INVALID Sự kiện không xảy ra trong khoảng thời gian được chấp nhận.
RESERVED_NAME_USED Tham số sử dụng tên dành riêng.
INVALID_EVENT_NAME Tên sự kiện không được hỗ trợ.
NOT_ALLOWLISTED Tài khoản này không có trong danh sách cho phép sử dụng tính năng đã cho.
INVALID_REQUEST_ID Mã yêu cầu dùng để truy xuất trạng thái của một yêu cầu không hợp lệ. Bạn chỉ có thể truy xuất trạng thái cho những yêu cầu thành công và không có validate_only=true.
MULTIPLE_DESTINATIONS_FOR_GOOGLE_ANALYTICS_EVENT Một sự kiện có từ 2 đích đến trở lên trên Google Analytics.
FIELD_VALUE_TOO_LONG Giá trị trường quá dài.
TOO_MANY_ELEMENTS Có quá nhiều phần tử trong một danh sách trong yêu cầu.
ALREADY_EXISTS Tài nguyên này đã tồn tại.
IMMUTABLE_FIELD_FOR_UPDATE Đã cố gắng đặt một trường không thay đổi cho yêu cầu cập nhật.
INVALID_RESOURCE_NAME Tên tài nguyên không hợp lệ.
INVALID_FILTER Bộ lọc truy vấn không hợp lệ.
INVALID_UPDATE_MASK Mặt nạ cập nhật không hợp lệ.
INVALID_PAGE_TOKEN Mã thông báo trang không hợp lệ.
CANNOT_UPDATE_DISABLED_LICENSE Không thể cập nhật giấy phép đã bị vô hiệu hoá.
CANNOT_CREATE_LICENSE_FOR_SENSITIVE_USERLIST Không thể cấp phép danh sách người dùng nhạy cảm cho khách hàng này.
INSUFFICIENT_COST Chi phí quá thấp cho giấy phép này.
CANNOT_DISABLE_LICENSE Bạn không thể tắt giấy phép đại lý vì giấy phép này đang được sử dụng.
INVALID_CLIENT_ACCOUNT_ID Mã tài khoản khách hàng không hợp lệ.
PRICING_ONLY_ZERO_COST_ALLOWED Không được phép có chi phí khác 0 cho tài khoản khách hàng này.
PRICE_TOO_HIGH Chi phí quá cao đối với giấy phép này.
CUSTOMER_NOT_ALLOWED_TO_CREATE_LICENSE Khách hàng không được phép tạo giấy phép.
INVALID_PRICING_END_DATE Ngày kết thúc định giá không hợp lệ đối với giấy phép này.
CANNOT_LICENSE_LOGICAL_LIST_WITH_LICENSED_OR_SHARED_SEGMENT Không thể cấp phép danh sách người dùng logic có phân khúc được chia sẻ hoặc được cấp phép.
MISMATCHED_ACCOUNT_TYPE Loại tài khoản của khách hàng trong yêu cầu không khớp với loại tài khoản thực tế của khách hàng.
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_LICENSE_TYPE Loại giấy phép không hỗ trợ chi phí chia sẻ nội dung nghe nhìn.
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_CLIENT_CUSTOMER Loại khách hàng của ứng dụng không hỗ trợ chi phí chia sẻ nội dung nghe nhìn.
INVALID_MEDIA_SHARE_COST Chi phí chia sẻ nội dung nghe nhìn không hợp lệ.
INVALID_COST_TYPE Loại chi phí không hợp lệ.
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_NON_COMMERCE_USER_LIST Loại UserList không hỗ trợ chi phí chia sẻ nội dung nghe nhìn.
MAX_COST_NOT_ALLOWED Bạn chỉ được phép sử dụng chi phí tối đa cho cost_type MEDIA_SHARE.
COMMERCE_AUDIENCE_CAN_ONLY_BE_DIRECTLY_LICENSED Đối tượng thương mại chỉ có thể được cấp phép trực tiếp.
INVALID_DESCRIPTION Nội dung mô tả không hợp lệ.
INVALID_DISPLAY_NAME Tên hiển thị không hợp lệ.
DISPLAY_NAME_ALREADY_USED Tên hiển thị này đang được dùng cho một danh sách người dùng khác của tài khoản.
OWNERSHIP_REQUIRED_FOR_UPDATE Bạn phải là chủ sở hữu thì mới có thể sửa đổi danh sách người dùng.
USER_LIST_MUTATION_NOT_SUPPORTED Loại danh sách người dùng ở chế độ chỉ đọc và không hỗ trợ thao tác biến đổi.
SENSITIVE_USER_LIST_IMMUTABLE Người dùng bên ngoài không thể thay đổi danh sách người dùng nhạy cảm về quyền riêng tư hoặc bị từ chối theo pháp luật.
BILLABLE_RECORD_COUNT_IMMUTABLE Bạn không thể sửa đổi trường bản ghi có thể tính phí của danh sách người dùng tái tiếp thị sau khi đặt.
USER_LIST_NAME_RESERVED Tên danh sách người dùng dành riêng cho danh sách hệ thống.
ADVERTISER_NOT_ALLOWLISTED_FOR_UPLOADED_DATA Nhà quảng cáo cần được đưa vào danh sách cho phép để sử dụng danh sách tái tiếp thị được tạo từ dữ liệu do nhà quảng cáo tải lên.
UNSUPPORTED_PARTNER_AUDIENCE_SOURCE Nguồn đối tượng của đối tác không được hỗ trợ cho loại danh sách người dùng.
COMMERCE_PARTNER_NOT_ALLOWED Bạn chỉ có thể đặt trường commerce_partner nếu partner_audience_sourceCOMMERCE_AUDIENCE.
UNSUPPORTED_PARTNER_AUDIENCE_INFO Trường partner_audience_info không được hỗ trợ cho loại danh sách người dùng.
PARTNER_MATCH_FOR_MANAGER_ACCOUNT_DISALLOWED Tài khoản người quản lý không thể tạo danh sách người dùng So khớp với đối tác.
DATA_PARTNER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA Đối tác dữ liệu không có tên trong danh sách cho phép đối với THIRD_PARTY_PARTNER_DATA.
ADVERTISER_TOS_NOT_ACCEPTED Nhà quảng cáo chưa chấp nhận điều khoản dịch vụ của đối tác.
ADVERTISER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA Nhà quảng cáo không có tên trong danh sách cho phép đối với THIRD_PARTY_PARTNER_DATA.
USER_LIST_TYPE_NOT_SUPPORTED_FOR_ACCOUNT Loại danh sách người dùng này không được hỗ trợ cho tài khoản này.
INVALID_COMMERCE_PARTNER Trường commerce_partner không hợp lệ.
CUSTOMER_NOT_ALLOWLISTED_FOR_COMMERCE_AUDIENCE Nhà cung cấp dữ liệu không có tên trong danh sách cho phép tạo đối tượng thương mại.
UNSUPPORTED_USER_LIST_UPLOAD_KEY_TYPES Các loại khoá tải lên danh sách người dùng không được hỗ trợ.
UNSUPPORTED_INGESTED_USER_LIST_INFO_CONFIG Không hỗ trợ cấu hình thông tin danh sách người dùng được nhập.
UNSUPPORTED_ACCOUNT_TYPES_FOR_USER_LIST_TYPE Các loại tài khoản không được hỗ trợ cho loại danh sách người dùng.

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

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.

event_name

string

Không bắt buộc. Tên của sự kiện. Bắt buộc đối với sự kiện GA4.

client_id

string

Không bắt buộc. Giá trị nhận dạng riêng biệt cho phiên bản người dùng của một ứng dụng web cho luồng dữ liệu web GA4 này.

user_id

string

Không bắt buộc. Giá trị nhận dạng riêng biệt cho một người dùng, do nhà quảng cáo xác định.

additional_event_parameters[]

EventParameter

Không bắt buộc. Một nhóm gồm mọi thông số sự kiện sẽ được đưa vào sự kiện mà bạn chưa chỉ định bằng các trường có cấu trúc khác.

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

EventParameter

Thông số sự kiện cho sự kiện GA4.

Trường
parameter_name

string

Bắt buộc. Tên của thông số cần sử dụng.

value

string

Bắt buộc. Chuỗi biểu thị giá trị của thông số cần đặt.

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 ở định dạng projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key} hoặc gcp-kms://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

Giới tính

Loại giới tính nhân khẩu học (ví dụ: nữ).

Enum
GENDER_UNSPECIFIED Chưa chỉ định.
GENDER_UNKNOWN Không xác định.
GENDER_MALE Nam.
GENDER_FEMALE Nữ.

GetUserListDirectLicenseRequest

Yêu cầu lấy tài nguyên UserListDirectLicense.

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

string

Bắt buộc. Tên tài nguyên của giấy phép trực tiếp cho danh sách người dùng.

GetUserListGlobalLicenseRequest

Yêu cầu lấy tài nguyên UserListGlobalLicense.

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

string

Bắt buộc. Tên tài nguyên của giấy phép toàn cầu cho danh sách người dùng.

GetUserListRequest

Thông báo yêu cầu cho GetUserList.

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

string

Bắt buộc. Tên tài nguyên của UserList cần truy xuất. Định dạng: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

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 để gửi 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 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, 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.

IngestedUserListInfo

Biểu thị một danh sách người dùng được điền sẵn bằng dữ liệu do người dùng cung cấp.

Trường
upload_key_types[]

UploadKeyType

Bắt buộc. Không thể thay đổi. Loại khoá tải lên của danh sách người dùng này.

contact_id_info

ContactIdInfo

Không bắt buộc. Thông tin bổ sung khi CONTACT_ID là một trong các upload_key_types.

mobile_id_info

MobileIdInfo

Không bắt buộc. Thông tin bổ sung khi MOBILE_ID là một trong các upload_key_types.

user_id_info

UserIdInfo

Không bắt buộc. Thông tin bổ sung khi USER_ID là một trong các upload_key_types.

pair_id_info

PairIdInfo

Không bắt buộc. Thông tin bổ sung khi PAIR_ID là một trong các upload_key_types.

Tính năng này chỉ dành cho các đối tác dữ liệu.

pseudonymous_id_info

PseudonymousIdInfo

Không bắt buộc. Thông tin bổ sung cho PSEUDONYMOUS_ID là một trong những upload_key_types.

partner_audience_info

PartnerAudienceInfo

Không bắt buộc. Thông tin bổ sung cho đối tượng của đối tác.

Tính năng này chỉ dành cho các đối tác dữ liệu.

UploadKeyType

Enum chứa các loại khoá tải lên có thể có của một danh sách người dùng.

Enum
UPLOAD_KEY_TYPE_UNSPECIFIED Chưa chỉ định.
CONTACT_ID Thông tin khách hàng, chẳng hạn như địa chỉ email, số điện thoại hoặc địa chỉ thực tế.
MOBILE_ID Mã nhận dạng cho quảng cáo trên thiết bị di động.
USER_ID Mã nhận dạng người dùng do bên thứ ba cung cấp.
PAIR_ID 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.
PSEUDONYMOUS_ID Mã nhận dạng nền tảng quản lý dữ liệu: – Mã nhận dạng người dùng Google – Mã nhận dạng do đối tác cung cấp – Mã nhận dạng do nhà xuất bản cung cấp – IDFA trên iOS – Mã nhận dạng cho quảng cáo trên Android – Mã nhận dạng Roku – Mã nhận dạng Amazon Fire TV – Mã nhận dạng Xbox hoặc Microsoft

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.

item_id

string

Không bắt buộc. Giá trị nhận dạng riêng biệt để tham chiếu đến mặt hàng.

additional_item_parameters[]

ItemParameter

Không bắt buộc. Một nhóm gồm mọi thông số sự kiện liên quan đến một mặt hàng sẽ được đưa vào sự kiện mà bạn chưa chỉ định bằng các trường có cấu trúc khác.

ItemParameter

Một nhóm gồm mọi thông số sự kiện liên quan đến một mặt hàng sẽ được đưa vào sự kiện mà bạn chưa chỉ định bằng các trường có cấu trúc khác.

Trường
parameter_name

string

Bắt buộc. Tên của thông số cần sử dụng.

value

string

Bắt buộc. Chuỗi biểu thị giá trị của thông số cần đặt.

ListUserListDirectLicensesRequest

Yêu cầu liệt kê tất cả tài nguyên UserListDirectLicense cho một tài khoản nhất định.

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

string

Bắt buộc. Tài khoản có giấy phép đang được truy vấn. Phải có định dạng accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

filter

string

Không bắt buộc. Bộ lọc để áp dụng cho yêu cầu danh sách. Tất cả các trường đều phải nằm ở phía bên trái của mỗi điều kiện (ví dụ: user_list_id = 123).

Các thao tác được hỗ trợ:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=

Trường không được hỗ trợ:

  • name (thay vào đó, hãy sử dụng phương thức get)
  • historical_pricings và tất cả các trường phụ của nó
  • pricing.start_time
  • pricing.end_time
page_size

int32

Không bắt buộc. Số lượng giấy phép tối đa cần trả về trên mỗi trang. Dịch vụ có thể trả về ít hơn giá trị này. Nếu bạn không chỉ định, hệ thống sẽ trả về tối đa 50 giấy phép. Giá trị tối đa là 1000; các giá trị lớn hơn 1000 sẽ được chuyển đổi thành 1000.

page_token

string

Không bắt buộc. Mã thông báo trang nhận được từ một lệnh gọi ListUserListDirectLicense trước đó. Cung cấp thông tin này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các tham số khác được cung cấp cho ListUserListDirectLicense phải khớp với lệnh gọi đã cung cấp mã thông báo trang.

ListUserListDirectLicensesResponse

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

Trường
user_list_direct_licenses[]

UserListDirectLicense

Giấy phép cho danh sách người dùng đã cho trong yêu cầu.

next_page_token

string

Một mã thông báo có thể được gửi dưới dạng page_token để truy xuất trang tiếp theo. Nếu bạn bỏ qua trường này, thì sẽ không có trang tiếp theo.

ListUserListGlobalLicenseCustomerInfosRequest

Yêu cầu liệt kê tất cả tài nguyên UserListGlobalLicenseCustomerInfo cho một giấy phép toàn cầu của danh sách người dùng nhất định.

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

string

Bắt buộc. Giấy phép toàn cầu mà thông tin khách hàng đang được truy vấn. Phải ở định dạng accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. Để liệt kê tất cả thông tin khách hàng có giấy phép trên toàn cầu trong một tài khoản, hãy thay thế mã giấy phép trên toàn cầu của danh sách người dùng bằng dấu "-" (ví dụ: accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)

filter

string

Không bắt buộc. Bộ lọc để áp dụng cho yêu cầu danh sách. Tất cả các trường phải nằm ở phía bên trái của mỗi điều kiện (ví dụ: user_list_id = 123).

Các thao tác được hỗ trợ:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=

Trường không được hỗ trợ:

  • name (thay vào đó, hãy sử dụng phương thức get)
  • historical_pricings và tất cả các trường phụ của nó
  • pricing.start_time
  • pricing.end_time
page_size

int32

Không bắt buộc. Số lượng giấy phép tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu bạn không chỉ định, hệ thống sẽ trả về tối đa 50 giấy phép. Giá trị tối đa là 1000; các giá trị lớn hơn 1000 sẽ được chuyển đổi thành 1000.

page_token

string

Không bắt buộc. Mã thông báo trang nhận được từ một lệnh gọi ListUserListDirectLicense trước đó. Cung cấp thông tin này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các tham số khác được cung cấp cho ListUserListDirectLicense phải khớp với lệnh gọi đã cung cấp mã thông báo trang.

ListUserListGlobalLicenseCustomerInfosResponse

Phản hồi từ [ListUserListGlobalLicensesCustomerInfoRequest][google.ads.datamanager.v1.ListUserListGlobalLicensesCustomerInfoRequest].

Trường
user_list_global_license_customer_infos[]

UserListGlobalLicenseCustomerInfo

Thông tin khách hàng cho giấy phép cụ thể trong yêu cầu.

next_page_token

string

Một mã thông báo có thể được gửi dưới dạng page_token để truy xuất trang tiếp theo. Nếu bạn bỏ qua trường này, thì sẽ không có trang tiếp theo.

ListUserListGlobalLicensesRequest

Yêu cầu liệt kê tất cả tài nguyên UserListGlobalLicense cho một tài khoản nhất định.

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

string

Bắt buộc. Tài khoản có giấy phép đang được truy vấn. Phải có định dạng accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

filter

string

Không bắt buộc. Bộ lọc để áp dụng cho yêu cầu danh sách. Tất cả các trường đều phải nằm ở phía bên trái của mỗi điều kiện (ví dụ: user_list_id = 123).

Các thao tác được hỗ trợ:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=

Trường không được hỗ trợ:

  • name (thay vào đó, hãy sử dụng phương thức get)
  • historical_pricings và tất cả các trường phụ của nó
  • pricing.start_time
  • pricing.end_time
page_size

int32

Không bắt buộc. Số lượng giấy phép tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu bạn không chỉ định, hệ thống sẽ trả về tối đa 50 giấy phép. Giá trị tối đa là 1000; các giá trị lớn hơn 1000 sẽ được chuyển đổi thành 1000.

page_token

string

Không bắt buộc. Mã thông báo trang nhận được từ một lệnh gọi ListUserListGlobalLicense trước đó. Cung cấp thông tin này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các tham số khác được cung cấp cho ListUserListDirectLicense phải khớp với lệnh gọi đã cung cấp mã thông báo trang.

ListUserListGlobalLicensesResponse

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

Trường
user_list_global_licenses[]

UserListGlobalLicense

Giấy phép cho danh sách người dùng đã cho trong yêu cầu.

next_page_token

string

Một mã thông báo có thể được gửi dưới dạng page_token để truy xuất trang tiếp theo. Nếu bạn bỏ qua trường này, thì sẽ không có trang tiếp theo.

ListUserListsRequest

Thông báo yêu cầu cho ListUserLists.

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

string

Bắt buộc. Tài khoản mẹ sở hữu tập hợp danh sách người dùng này. Định dạng: accountTypes/{account_type}/accounts/{account}

page_size

int32

Không bắt buộc. Số lượng danh sách người dùng tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu không chỉ định, tối đa 50 danh sách người dùng sẽ được trả về. Giá trị tối đa là 1000; các giá trị lớn hơn 1000 sẽ được chuyển đổi thành 1000.

page_token

string

Không bắt buộc. Mã thông báo trang nhận được từ một lệnh gọi ListUserLists trước đó. Cung cấp thông tin này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các tham số khác được cung cấp cho ListUserLists phải khớp với lệnh gọi đã cung cấp mã thông báo trang.

filter

string

Không bắt buộc. Một chuỗi bộ lọc. Tất cả các trường đều phải nằm ở phía bên trái của mỗi điều kiện (ví dụ: display_name = "list 1").

Các thao tác được hỗ trợ:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • : (có)

Các trường được hỗ trợ:

  • id
  • display_name
  • description
  • membership_status
  • integration_code
  • access_reason
  • ingested_user_list_info.upload_key_types

ListUserListsResponse

Thông báo phản hồi cho ListUserLists.

Trường
user_lists[]

UserList

Danh sách người dùng từ tài khoản được chỉ định.

next_page_token

string

Một mã thông báo có thể được gửi dưới dạng page_token để truy xuất trang tiếp theo. Nếu bạn bỏ qua trường này, thì sẽ không có trang tiếp theo.

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.

MobileIdInfo

Thông tin bổ sung khi MOBILE_ID là một trong các upload_key_types.

Trường
data_source_type

DataSourceType

Không bắt buộc. Không thể thay đổi. Nguồn của dữ liệu tải lên.

key_space

KeySpace

Bắt buộc. Không thể thay đổi. Không gian khoá của mã nhận dạng thiết bị di động.

app_id

string

Bắt buộc. Không thể thay đổi. Một chuỗi xác định duy nhất một ứng dụng di động mà từ đó dữ liệu được thu thập.

KeySpace

Không gian khoá cho mã nhận dạng trên thiết bị di động.

Enum
KEY_SPACE_UNSPECIFIED Chưa chỉ định.
IOS Không gian khoá iOS.
ANDROID Không gian khoá Android.

PairData

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

Tính năng này chỉ dành cho các đối tác dữ liệu.

Trường
pair_ids[]

string

Bắt buộc. Dữ liệu PII do Cleanroom 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.

PairIdInfo

Thông tin bổ sung khi PAIR_ID là một trong các upload_key_types.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Trường
match_rate_percentage

int32

Chỉ có đầu ra. Trường này biểu thị tỷ lệ phần trăm mức độ trùng khớp thành viên của danh sách người dùng này với dữ liệu tương ứng của bên thứ nhất của nhà xuất bản. Phải nằm trong khoảng từ 0 đến 100.

advertiser_identifier_count

int64

Chỉ có đầu ra. Số lượng bản ghi dữ liệu của bên thứ nhất của nhà quảng cáo đã được tải lên một nhà cung cấp phòng sạch. Điều này không biểu thị quy mô của danh sách người dùng PAIR.

publisher_id

int64

Bắt buộc. Không thể thay đổi. Xác định nhà xuất bản mà danh sách người dùng Điều chỉnh danh tính nhà quảng cáo của nhà xuất bản được điều chỉnh. Trường này do nhà cung cấp phòng sạch cung cấp và chỉ có giá trị duy nhất trong phạm vi của phòng sạch đó. Bạn không thể dùng giá trị nhận dạng này làm giá trị nhận dạng chung trên nhiều phòng sạch.

publisher_name

string

Không bắt buộc. Tên mô tả của nhà xuất bản sẽ xuất hiện trong giao diện người dùng để có trải nghiệm nhắm mục tiêu tốt hơn.

clean_room_identifier

string

Bắt buộc. Không thể thay đổi. Xác định mối quan hệ duy nhất giữa nhà quảng cáo và nhà xuất bản với một nhà cung cấp phòng sạch hoặc trên nhiều nhà cung cấp phòng sạch.

PartnerAudienceInfo

Thông tin bổ sung cho đối tượng của đối tác.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Trường
partner_audience_source

PartnerAudienceSource

Bắt buộc. Không thể thay đổi. Nguồn của đối tượng đối tác.

commerce_partner

string

Không bắt buộc. Tên đối tác thương mại. Chỉ được phép nếu partner_audience_sourceCOMMERCE_AUDIENCE.

PartnerAudienceSource

Nguồn đối tượng của đối tác.

Enum
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED Chưa chỉ định.
COMMERCE_AUDIENCE Nguồn đối tượng của đối tác là đối tượng thương mại.
LINEAR_TV_AUDIENCE Nguồn đối tượng của đối tác là đối tượng xem truyền hình truyền thống.
AGENCY_PROVIDER_AUDIENCE Nguồn đối tượng của đối tác là đối tượng của công ty quảng cáo/nhà cung cấp.

PpidData

Dữ liệu giá trị nhận dạng do nhà xuất bản cung cấp lưu giữ các ppid. Bạn phải có ít nhất một ppid.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Trường
ppids[]

string

Bắt buộc. Danh sách giá trị nhận dạng do nhà xuất bản cung cấp cho một người dùng.

ProcessingErrorReason

Lý do xảy ra lỗi 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_AWS_AUTH_FAILED Hệ thống không xác thực được với AWS.
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 Chưa 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ộ.
PROCESSING_WARNING_REASON_AWS_AUTH_FAILED Hệ thống không xác thực được với AWS.

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.
GOOGLE_ANALYTICS_PROPERTY Google Analytics.

PseudonymousIdInfo

Thông tin bổ sung khi PSEUDONYMOUS_ID là một trong các upload_key_types.

Trường
sync_status

SyncStatus

Chỉ có đầu ra. Trạng thái đồng bộ hoá của danh sách người dùng.

billable_record_count

int64

Không bắt buộc. Không thể thay đổi. Số lượng bản ghi có tính phí (ví dụ: bản ghi được tải lên hoặc được so khớp).

SyncStatus

Trạng thái đồng bộ hoá của danh sách người dùng.

Enum
SYNC_STATUS_UNSPECIFIED Chưa chỉ định.
CREATED Danh sách người dùng đã được tạo dưới dạng phần giữ chỗ. Nội dung và/hoặc siêu dữ liệu của danh sách vẫn đang được đồng bộ hoá. Danh sách người dùng chưa sẵn sàng để sử dụng.
READY_FOR_USE Danh sách người dùng đã sẵn sàng để sử dụng. Nội dung và cookie đã được đồng bộ hoá đúng cách.
FAILED Đã xảy ra lỗi khi đồng bộ hoá nội dung và/hoặc siêu dữ liệu của danh sách người dùng. Không thể sử dụng danh sách người dùng.

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 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á hội viên.

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 của việc 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.

user_id_data_ingestion_status

IngestUserIdDataStatus

Trạng thái của việc truyền dữ liệu mã nhận dạng người dùng đến đích đến.

ppid_data_ingestion_status

IngestPpidDataStatus

Trạng thái của quá trình nhập dữ liệu ppid 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 truyền dữ liệu di độ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.

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ã đó 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 theo cặp trong yêu cầu, bất kể mã đó có được nhập thành công hay không.

IngestPpidDataStatus

Trạng thái của quá trình truyền dữ liệu ppid đế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.

ppid_count

int64

Tổng số ppid được gửi trong yêu cầu tải lên cho đích đến. Bao gồm tất cả ppid trong yêu cầu, bất kể yêu cầu 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ị nhận dạng đó có được tiếp nhậ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.

IngestUserIdDataStatus

Trạng thái của quá trình nhập dữ liệu mã nhận dạng người dù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.

user_id_count

int64

Tổng số mã 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ả mã nhận dạng người dùng trong yêu cầu, bất kể mã nhận dạng đó có được tiếp nhận thành công hay không.

RemoveAudienceMembersStatus

Trạng thái của yêu cầu xoá hội viên.

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.

user_id_data_removal_status

RemoveUserIdDataStatus

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

ppid_data_removal_status

RemovePpidDataStatus

Trạng thái xoá dữ liệu ppid 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 có 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 có 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 theo cặp trong yêu cầu, bất kể mã nhận dạng đó có được xoá thành công hay không.

RemovePpidDataStatus

Trạng thái xoá dữ liệu ppid 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 có trong yêu cầu, bất kể họ có được xoá thành công hay không.

ppid_count

int64

Tổng số ppid được gửi trong yêu cầu gỡ bỏ. Bao gồm tất cả ppid 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 có 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ể giá trị nhận dạng đó có được xoá thành công hay không.

RemoveUserIdDataStatus

Trạng thái xoá dữ liệu mã nhận dạng 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 có trong yêu cầu, bất kể họ có được xoá thành công hay không.

user_id_count

int64

Tổng số mã nhận dạng người dùng được gửi trong yêu cầu gỡ bỏ. Bao gồm tất cả mã nhận dạng người dùng trong yêu cầu, bất kể mã nhận dạ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.

RetrieveInsightsRequest

Thông báo yêu cầu cho DM API MarketingDataInsightsService.RetrieveInsights

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

string

Bắt buộc. Tài khoản mẹ sở hữu danh sách người dùng. Định dạng accountTypes/{account_type}/accounts/{account}

baseline

Baseline

Bắt buộc. Đường cơ sở cho thông tin chi tiết được yêu cầu.

user_list_id

string

Bắt buộc. Mã danh sách người dùng mà bạn yêu cầu thông tin chi tiết.

RetrieveInsightsResponse

Thông báo phản hồi cho DM API MarketingDataInsightsService.RetrieveInsights

Trường
marketing_data_insights[]

MarketingDataInsight

Chứa thông tin chi tiết về dữ liệu tiếp thị.

MarketingDataInsight

Thông tin chi tiết về dữ liệu tiếp thị.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Trường
dimension

AudienceInsightsDimension

Phương diện mà thông tin chi tiết thuộc về.

attributes[]

MarketingDataInsightsAttribute

Thông tin chi tiết về các giá trị của một phương diện nhất định.

AudienceInsightsDimension

Các phương diện có thể dùng để tạo thông tin chi tiết.

Enum
AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED Chưa chỉ định.
AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN Giá trị không xác định trong phiên bản này.
AFFINITY_USER_INTEREST UserInterest có mối quan hệ liên kết.
IN_MARKET_USER_INTEREST UserInterest đang cân nhắc mua hàng.
AGE_RANGE Độ tuổi.
GENDER Một giới tính.

MarketingDataInsightsAttribute

Thông tin chi tiết cho một tập hợp các thuộc tính có liên quan của cùng một phương diện.

Trường
user_interest_id

int64

Mã nhận dạng mối quan tâm của người dùng.

lift

float

Mức tăng mà đối tượng có được cho giá trị thuộc tính so với đường cơ sở. Phạm vi [0-1].

age_range

AgeRange

Phạm vi độ tuổi của đối tượng mà mức tăng được cung cấp.

gender

Gender

Giới tính của đối tượng mà mức tăng được cung cấp.

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.

SearchPartnerLinksRequest

Yêu cầu tìm kiếm tài nguyên PartnerLink. Trả về một SearchPartnerLinksResponse.

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

string

Bắt buộc. Tài khoản để tìm các mối liên kết với đối tác. Nếu bạn không chỉ định filter, thì tất cả các mối liên kết với đối tác mà tài khoản này là owning_account hoặc partner_account đều được trả về.

Định dạng accountTypes/{account_type}/accounts/{account}

page_size

int32

Số lượng đường liên kết tối đa của đối tác cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu không chỉ định, hệ thống sẽ trả về tối đa 10 đường liên kết đến đối tác. Giá trị tối đa là 100; các giá trị lớn hơn 100 sẽ được chuyển đổi thành 100.

page_token

string

Mã thông báo trang nhận được từ một lệnh gọi SearchPartnerLinks trước đó. Cung cấp thông tin này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các tham số khác được cung cấp cho SearchPartnerLinks phải khớp với lệnh gọi đã cung cấp mã thông báo trang.

filter

string

Không bắt buộc. Một chuỗi bộ lọc. Tất cả các trường đều phải nằm ở phía bên trái của mỗi điều kiện (ví dụ: partner_link_id = 123456789).

Các thao tác được hỗ trợ:

  • AND
  • =
  • !=

Các trường được hỗ trợ:

  • partner_link_id
  • owning_account.account_type
  • owning_account.account_id
  • partner_account.account_type
  • partner_account.account_id

Ví dụ: owning_account.account_type = "GOOGLE_ADS" OR partner_account.account_id = 987654321

SearchPartnerLinksResponse

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

Trường
next_page_token

string

Một mã thông báo có thể được gửi dưới dạng page_token để truy xuất trang tiếp theo. Nếu bạn bỏ qua trường này, thì sẽ không có trang tiếp theo.

SizeInfo

Số lượng thành viên ước tính trong danh sách người dùng này ở các mạng mục tiêu khác nhau.

Trường
display_network_members_count

int64

Chỉ có đầu ra. Số lượng thành viên ước tính trong danh sách người dùng này, trên Mạng Hiển thị của Google.

search_network_members_count

int64

Chỉ có đầu ra. Số lượng thành viên ước tính trong danh sách người dùng này trong miền google.com. Đây là những thành viên mà bạn có thể nhắm đến trong chiến dịch Tìm kiếm.

TargetNetworkInfo

Thông tin về điều kiện để được xuất hiện trên các mạng mục tiêu.

Trường
eligible_for_display

bool

Chỉ có đầu ra. Cho biết danh sách người dùng này đủ điều kiện cho Mạng Hiển thị của Google.

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 chấp nhận hoặc từ chối điều khoản dịch vụ của người gọi.

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

UpdateUserListDirectLicenseRequest

Yêu cầu cập nhật tài nguyên UserListDirectLicense.

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

UserListDirectLicense

Bắt buộc. Trường name của giấy phép được dùng để xác định giấy phép cần cập nhật.

update_mask

FieldMask

Không bắt buộc. Danh sách các trường cần cập nhật. Ký tự đặc biệt * không được hỗ trợ và lỗi INVALID_UPDATE_MASK sẽ xảy ra nếu bạn sử dụng ký tự này.

UpdateUserListGlobalLicenseRequest

Yêu cầu cập nhật tài nguyên UserListGlobalLicense.

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

UserListGlobalLicense

Bắt buộc. Trường name của giấy phép được dùng để xác định giấy phép cần cập nhật.

update_mask

FieldMask

Không bắt buộc. Danh sách các trường cần cập nhật. Ký tự đặc biệt * không được hỗ trợ và lỗi INVALID_UPDATE_MASK sẽ xảy ra nếu bạn sử dụng ký tự này.

UpdateUserListRequest

Thông báo yêu cầu cho UpdateUserList.

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

UserList

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

Trường name của danh sách người dùng được dùng để xác định danh sách người dùng cần cập nhật. Định dạng: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

update_mask

FieldMask

Không bắt buộc. Danh sách các trường cần cập nhật.

validate_only

bool

Không bắt buộc. Nếu đúng, yêu cầu sẽ được xác thực nhưng không được thực thi.

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 thực thể 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.

UserIdData

Dữ liệu mã nhận dạng người dùng lưu giữ mã nhận dạng người dùng.

Trường
user_id

string

Bắt buộc. Giá trị nhận dạng riêng biệt cho một người dùng, do nhà quảng cáo xác định.

UserIdInfo

Thông tin bổ sung khi USER_ID là một trong các upload_key_types.

Trường
data_source_type

DataSourceType

Không bắt buộc. Không thể thay đổi. Nguồn của dữ liệu tải lên.

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.

UserList

Tài nguyên danh sách người dùng.

Trường
name

string

Giá trị nhận dạng. Tên tài nguyên của danh sách người dùng. Định dạng: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

id

int64

Chỉ có đầu ra. Mã nhận dạng duy nhất của danh sách người dùng.

read_only

bool

Chỉ có đầu ra. Một lựa chọn cho biết liệu người dùng có thể chỉnh sửa danh sách hay không.

membership_duration

Duration

Không bắt buộc. Khoảng thời gian mà người dùng vẫn còn trong danh sách người dùng. Thời lượng hợp lệ phải là bội số chính xác của 24 giờ (86400 giây). Nếu bạn cung cấp một giá trị không phải là bội số chính xác của 24 giờ, thì sẽ xảy ra lỗi INVALID_ARGUMENT.

access_reason

AccessReason

Chỉ có đầu ra. Lý do tài khoản này được cấp quyền truy cập vào danh sách.

size_info

SizeInfo

Chỉ có đầu ra. Số lượng thành viên ước tính trong danh sách người dùng này ở các mạng mục tiêu khác nhau.

target_network_info

TargetNetworkInfo

Không bắt buộc. Thông tin về điều kiện để được xuất hiện trên các mạng mục tiêu.

display_name

string

Bắt buộc. Tên hiển thị của danh sách người dùng.

description

string

Không bắt buộc. Nội dung mô tả về danh sách người dùng.

membership_status

MembershipStatus

Không bắt buộc. Trạng thái thành viên của danh sách người dùng này.

integration_code

string

Không bắt buộc. Mã nhận dạng từ hệ thống bên ngoài. Người bán danh sách người dùng sử dụng mã này để tương quan các mã nhận dạng trên hệ thống của họ.

closing_reason

ClosingReason

Chỉ có đầu ra. Lý do khiến trạng thái thành viên của danh sách người dùng này là đã đóng.

account_access_status

AccessStatus

Không bắt buộc. Cho biết liệu chế độ chia sẻ này có còn được bật hay không. Khi một danh sách người dùng được chia sẻ với tài khoản, trường này được đặt thành ENABLED. Sau đó, chủ sở hữu danh sách người dùng có thể quyết định thu hồi quyền chia sẻ và đặt danh sách ở trạng thái DISABLED.

Trường nhóm user_list_info. Thông tin bổ sung về danh sách người dùng. user_list_info chỉ có thể là một trong những trạng thái sau:
ingested_user_list_info

IngestedUserListInfo

Không bắt buộc. Đại diện cho danh sách người dùng được điền sẵn bằng dữ liệu do người dùng nhập.

AccessReason

Liệt kê các lý do có thể dẫn đến việc truy cập.

Enum
ACCESS_REASON_UNSPECIFIED Chưa chỉ định.
OWNED Người dùng sở hữu tài nguyên này.
SHARED Tài nguyên được chia sẻ với người dùng.
LICENSED Tài nguyên được cấp phép cho người dùng.
SUBSCRIBED Người dùng đã đăng ký nhận tài nguyên.
AFFILIATED Người dùng có thể truy cập vào tài nguyên.

AccessStatus

Cho biết liệu ứng dụng này vẫn có quyền truy cập vào danh sách hay không.

Enum
ACCESS_STATUS_UNSPECIFIED Chưa chỉ định.
ENABLED Đã bật quyền truy cập.
DISABLED Quyền truy cập bị tắt.

ClosingReason

Cho biết lý do danh sách người dùng bị đóng. Enum này chỉ được dùng khi hệ thống tự động đóng một danh sách.

Enum
CLOSING_REASON_UNSPECIFIED Chưa chỉ định.
UNUSED Danh sách người dùng đã bị đóng vì gần đây không được dùng để nhắm mục tiêu. Hãy xem https://support.google.com/google-ads/answer/2472738 để biết thông tin chi tiết.

MembershipStatus

Trạng thái của danh sách người dùng.

Enum
MEMBERSHIP_STATUS_UNSPECIFIED Chưa chỉ định.
OPEN Trạng thái mở – Danh sách người dùng đang tích luỹ thành viên và có thể được nhắm đến.
CLOSED Trạng thái đã đóng – Không thêm thành viên mới.

UserListDirectLicense

Giấy phép trực tiếp cho danh sách người dùng.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Trường
name

string

Giá trị nhận dạng. Tên tài nguyên của giấy phép trực tiếp cho danh sách người dùng.

user_list_display_name

string

Chỉ có đầu ra. Tên của danh sách người dùng được cấp phép.

Trường này ở chế độ chỉ đọc.

client_account_display_name

string

Chỉ có đầu ra. Tên của khách hàng mà danh sách người dùng đang được cấp phép.

Trường này ở chế độ chỉ đọc.

pricing

UserListLicensePricing

Không bắt buộc. Giá UserListDirectLicense.

historical_pricings[]

UserListLicensePricing

Chỉ có đầu ra. Nhật ký định giá của giấy phép danh sách người dùng này.

Trường này ở chế độ chỉ đọc.

metrics

UserListLicenseMetrics

Chỉ có đầu ra. Các chỉ số liên quan đến giấy phép này

Trường này ở chế độ chỉ đọc và chỉ được điền sẵn nếu bạn đặt ngày bắt đầu và ngày kết thúc trong lệnh gọi ListUserListDirectLicenses

user_list_id

int64

Không thể thay đổi. Mã nhận dạng của danh sách người dùng đang được cấp phép.

client_account_type

UserListLicenseClientAccountType

Không thể thay đổi. Loại tài khoản của khách hàng mà danh sách người dùng đang được cấp phép.

client_account_id

int64

Không thể thay đổi. Mã nhận dạng khách hàng của khách hàng mà danh sách người dùng đang được cấp phép.

status

UserListLicenseStatus

Không bắt buộc. Trạng thái của UserListDirectLicense – ENABLED hoặc DISABLED.

UserListGlobalLicense

Giấy phép toàn cầu đối với danh sách người dùng.

Tính năng này chỉ dành cho các đối tác dữ liệu.

Trường
name

string

Giá trị nhận dạng. Tên tài nguyên của giấy phép toàn cầu cho danh sách người dùng.

user_list_display_name

string

Chỉ có đầu ra. Tên của danh sách người dùng được cấp phép.

Trường này ở chế độ chỉ đọc.

pricing

UserListLicensePricing

Không bắt buộc. Giá UserListGlobalLicense.

historical_pricings[]

UserListLicensePricing

Chỉ có đầu ra. Nhật ký định giá của giấy phép danh sách người dùng này.

Trường này ở chế độ chỉ đọc.

metrics

UserListLicenseMetrics

Chỉ có đầu ra. Các chỉ số liên quan đến giấy phép này

Trường này ở chế độ chỉ đọc và chỉ được điền sẵn nếu bạn đặt ngày bắt đầu và ngày kết thúc trong lệnh gọi ListUserListGlobalLicenses

user_list_id

int64

Không thể thay đổi. Mã nhận dạng của danh sách người dùng đang được cấp phép.

license_type

UserListGlobalLicenseType

Không thể thay đổi. Loại sản phẩm của khách hàng mà danh sách người dùng đang được cấp phép.

status

UserListLicenseStatus

Không bắt buộc. Trạng thái của UserListGlobalLicense – ENABLED hoặc DISABLED.

UserListGlobalLicenseCustomerInfo

Thông tin về khách hàng của giấy phép toàn cầu cho danh sách người dùng. Hệ thống sẽ tự động tạo nhóm này khi khách hàng mua giấy phép toàn cầu.

Trường
name

string

Giá trị nhận dạng. Tên tài nguyên của khách hàng có giấy phép toàn cầu cho danh sách người dùng.

user_list_id

int64

Chỉ có đầu ra. Mã nhận dạng của danh sách người dùng đang được cấp phép.

user_list_display_name

string

Chỉ có đầu ra. Tên của danh sách người dùng được cấp phép.

license_type

UserListGlobalLicenseType

Chỉ có đầu ra. Loại sản phẩm của khách hàng mà danh sách người dùng đang được cấp phép.

status

UserListLicenseStatus

Chỉ có đầu ra. Trạng thái của UserListDirectLicense – ENABLED hoặc DISABLED.

pricing

UserListLicensePricing

Chỉ có đầu ra. Giá UserListDirectLicense.

client_account_type

UserListLicenseClientAccountType

Chỉ có đầu ra. Loại sản phẩm của khách hàng mà danh sách người dùng đang được cấp phép.

client_account_id

int64

Chỉ có đầu ra. Mã nhận dạng khách hàng của khách hàng mà danh sách người dùng đang được cấp phép.

client_account_display_name

string

Chỉ có đầu ra. Tên của khách hàng mà danh sách người dùng đang được cấp phép.

historical_pricings[]

UserListLicensePricing

Chỉ có đầu ra. Nhật ký định giá của giấy phép danh sách người dùng này.

metrics

UserListLicenseMetrics

Chỉ có đầu ra. Các chỉ số liên quan đến giấy phép này

Trường này chỉ được điền nếu bạn đặt ngày bắt đầu và ngày kết thúc trong lệnh gọi ListUserListGlobalLicenseCustomerInfos.

UserListGlobalLicenseType

Các loại giấy phép toàn cầu cho danh sách người dùng.

Enum
USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED KHÔNG XÁC ĐỊNH.
USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER Giấy phép của người bán lại.
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE Giấy phép DataMart Sell Side.
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE Giấy phép DataMart Buy Side.

UserListLicenseClientAccountType

Sản phẩm có thể có của tài khoản khách hàng cho giấy phép danh sách người dùng.

Enum
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN Không xác định.
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS Khách hàng Google Ads.
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER Đối tác của Display & Video 360.
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER Nhà quảng cáo Display & Video 360.

UserListLicenseMetrics

Chỉ số liên quan đến giấy phép danh sách người dùng.

Trường
click_count

int64

Chỉ có đầu ra. Số lượt nhấp cho giấy phép danh sách người dùng.

impression_count

int64

Chỉ có đầu ra. Số lượt hiển thị cho giấy phép danh sách người dùng.

revenue_usd_micros

int64

Chỉ có đầu ra. Doanh thu từ giấy phép danh sách người dùng (tính bằng một phần triệu USD).

start_date

int64

Chỉ có đầu ra. Ngày bắt đầu (bao gồm) của các chỉ số ở định dạng YYYYMMDD. Ví dụ: 20260102 biểu thị ngày 2 tháng 1 năm 2026. Nếu bạn sử dụng end_date trong bộ lọc, thì bạn cũng phải sử dụng start_date. Nếu cả start_dateend_date đều không có trong bộ lọc, thì các trường UserListLicenseMetrics sẽ không được điền vào phản hồi.

end_date

int64

Chỉ có đầu ra. Ngày kết thúc (bao gồm) của các chỉ số ở định dạng YYYYMMDD. Ví dụ: 20260102 biểu thị ngày 2 tháng 1 năm 2026. Nếu bạn sử dụng start_date trong bộ lọc, thì bạn cũng phải sử dụng end_date. Nếu cả start_dateend_date đều không có trong bộ lọc, thì các trường UserListLicenseMetrics sẽ không được điền vào phản hồi.

UserListLicensePricing

Giá giấy phép danh sách người dùng.

Trường
pricing_id

int64

Chỉ có đầu ra. Mã của mức giá này.

start_time

Timestamp

Chỉ có đầu ra. Thời gian bắt đầu đặt giá.

end_time

Timestamp

Không bắt buộc. Thời gian kết thúc của giá.

pricing_active

bool

Chỉ có đầu ra. Mức giá này có đang hoạt động hay không.

buyer_approval_state

UserListPricingBuyerApprovalState

Chỉ có đầu ra. Trạng thái phê duyệt của người mua đối với mức giá này.

Trường này ở chế độ chỉ đọc.

cost_micros

int64

Không bắt buộc. Chi phí liên quan đến mô hình, tính bằng đơn vị một phần triệu (10^-6), theo đơn vị tiền tệ được chỉ định trong trường currency_code. Ví dụ: 2000000 có nghĩa là 2 đô la Mỹ nếu currency_codeUSD.

currency_code

string

Không bắt buộc. Đơn vị tiền tệ mà bạn chỉ định chi phí và max_cost. Phải là mã tiền tệ gồm 3 chữ cái theo tiêu chuẩn ISO 4217.

cost_type

UserListPricingCostType

Không thể thay đổi. Loại chi phí của mức giá này.

Chỉ có thể đặt trong thao tác create. Không thể cập nhật cho giấy phép hiện có.

max_cost_micros

int64

Không bắt buộc. CPM tối đa mà đối tượng thương mại có thể bị tính phí khi sử dụng loại chi phí MEDIA_SHARE. Giá trị được tính bằng đơn vị một phần triệu (10^-6) và bằng đơn vị tiền tệ do trường currency_code chỉ định. Ví dụ: 2000000 có nghĩa là 2 đô la Mỹ nếu currency_codeUSD.

Thông tin này chỉ liên quan khi cost_type là MEDIA_SHARE. Khi cost_type không phải là MEDIA_SHARE và bạn đặt trường này, hệ thống sẽ trả về lỗi MAX_COST_NOT_ALLOWED. Nếu bạn không đặt hoặc đặt thành 0, thì sẽ không có giới hạn.

UserListPricingBuyerApprovalState

Trạng thái phê duyệt của người mua đối với giá trong danh sách người dùng.

Enum
USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED KHÔNG XÁC ĐỊNH.
PENDING Ứng dụng danh sách người dùng chưa chấp nhận các điều khoản về giá do chủ sở hữu danh sách người dùng đặt ra.
APPROVED Ứng dụng danh sách người dùng đã chấp nhận các điều khoản về giá do chủ sở hữu danh sách người dùng đặt ra.
REJECTED Khách hàng danh sách người dùng đã từ chối các điều khoản về giá do chủ sở hữu danh sách người dùng đặt ra.

UserListPricingCostType

Loại chi phí định giá danh sách người dùng.

Enum
USER_LIST_PRICING_COST_TYPE_UNSPECIFIED Không xác định.
CPC Chi phí mỗi lượt nhấp.
CPM Chi phí mỗi nghìn lượt hiển thị.
MEDIA_SHARE Chia sẻ nội dung nghe nhìn.

UserListLicenseStatus

Trạng thái giấy phép của danh sách người dùng.

Enum
USER_LIST_LICENSE_STATUS_UNSPECIFIED Không xác định.
USER_LIST_LICENSE_STATUS_ENABLED Trạng thái đang hoạt động – danh sách người dùng vẫn đang được cấp phép.
USER_LIST_LICENSE_STATUS_DISABLED Trạng thái không hoạt động – danh sách người dùng không còn được cấp phép nữa.

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.

additional_user_properties[]

UserProperty

Không bắt buộc. Một nhóm gồm mọi thuộc tính người dùng bổ sung cho người dùng được liên kết với sự kiện này.

UserProperty

Một nhóm gồm mọi thuộc tính người dùng bổ sung cho người dùng được liên kết với sự kiện này.

Trường
property_name

string

Bắt buộc. Tên của thuộc tính người dùng cần sử dụng.

value

string

Bắt buộc. Chuỗi biểu thị giá trị của thuộc tính người dùng cần sử dụ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.