REST Resource: customers.userLists

Tài nguyên: UserList

Xác định danh sách người dùng do Ads Data Hub quản lý.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "userListId": string,
  "adsDataCustomerId": string,
  "title": string,
  "description": string,
  "type": enum (UserListType),
  "createEmail": string,
  "listSize": string,
  "populateTime": string,
  "recipientAdsDataLinks": [
    string
  ],
  "state": enum (State),

  // Union field user_list can be only one of the following:
  "frequencyList": {
    object (FrequencyBasedListInfo)
  },
  "remarketingList": {
    object (RemarketingListInfo)
  }
  // End of list of possible types for union field user_list.
}
Các trường
name

string

Chỉ đầu ra. Tên xác định duy nhất một danh sách người dùng của Ads Data Hub. Thông tin đó có dạng khách hàng/[customerId]/userLists/[userListId]
userListId

string (int64 format)

Chỉ đầu ra. Mã danh sách người dùng. Trường này do dịch vụ tạo và dùng để điền Danh sách người dùng.
adsDataCustomerId

string (int64 format)

Không thể thay đổi. Mã khách hàng Trung tâm dữ liệu quảng cáo được liên kết liên kết với danh sách người dùng này. Mã này phải được chỉ định làm adsDataCustomerId khi chạy các công việc UserListQuery sử dụng danh sách người dùng này. Nếu không có cột này, hệ thống sẽ dùng khách hàng chính. Bạn không thể thay đổi lựa chọn này sau khi tạo danh sách.
title

string

Bắt buộc. Tiêu đề danh sách người dùng, là duy nhất cho adsDataCustomerId được chỉ định.
description

string

Bắt buộc. Nội dung mô tả danh sách người dùng.
type

enum (UserListType)

Chỉ đầu ra. Các giá trị loại UserList phải nhất quán với userList. Giá trị này là Chỉ có thể đọc và có thể truy cập được khi có yêu cầu tải/danh sách.
createEmail

string

Chỉ đầu ra. Địa chỉ email của người dùng đã tạo danh sách người dùng này.
listSize

string (int64 format)

Chỉ đầu ra. Số người dùng trong danh sách người dùng. Quy trình cập nhật quy mô danh sách có thể bị chậm trễ.
populateTime

string (Timestamp format)

Chỉ đầu ra. Thời gian điền danh sách lần gần đây nhất.

Dấu thời gian ở định dạng RFC3339 UTC "Zulu" với độ phân giải nano giây và tối đa chín chữ số thập phân. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Chỉ đầu ra. Trạng thái của danh sách người dùng (Đang hoạt động/Đã xóa). Giá trị này là Chỉ có thể đọc và có thể truy cập được khi có yêu cầu tải/danh sách.

Trường liên kết user_list. Cấu hình thêm tùy thuộc vào loại danh sách người dùng.

Phải đặt chính xác một thuộc tính. user_list chỉ có thể là một trong những giá trị sau:
frequencyList

object (FrequencyBasedListInfo)

Danh sách người dùng cho tính năng giới hạn tần suất.
remarketingList

object (RemarketingListInfo)

Danh sách tiếp thị lại.

Loại danh sách người dùng

Loại danh sách người dùng. Tạo danh sách người dùng và sử dụng tại thời điểm nhắm mục tiêu tùy thuộc vào giá trị enum này. Không thể chuyển đổi loại danh sách sau khi tạo.

Enum
USER_LIST_TYPE_UNSPECIFIED Giá trị mặc định: không được sử dụng.
REMARKETING Đối tượng tiếp thị lại được tạo bằng các truy vấn SQL trên ADH. Bạn có thể sử dụng danh sách tiếp thị lại để nhắm mục tiêu khẳng định và phủ định.
FREQUENCY_BASED Đối tượng bị giới hạn tần suất. Những đối tượng thuộc loại này bị hạn chế nhắm mục tiêu phủ định.

Tần suất dựa trên thông tin danh sách

Siêu dữ liệu cho Danh sách người dùng dựa trên tần suất.

Biểu diễn dưới dạng JSON 
{
  "dv360LineitemIds": [
    string
  ],
  "cmCampaignIds": [
    string
  ],
  "googleAdsCampaignIds": [
    string
  ],
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ],
  "frequencyConstraint": {
    object (FrequencyConstraint)
  },
  "slidingWindowDays": integer
}
Các trường
dv360LineitemIds[]
(deprecated)

string (int64 format)

Mã cho các mục hàng DV360 góp phần vào tần suất.
cmCampaignIds[]
(deprecated)

string (int64 format)

Mã cho các chiến dịch CM đóng góp vào tần suất.
googleAdsCampaignIds[]
(deprecated)

string (int64 format)

Mã cho các chiến dịch trên Google Ads góp phần vào tần suất.
eventMatchers[]

object (EventMatcher)

Những sự kiện đóng góp với tần suất. Khi tạo danh sách người dùng dựa trên tần suất, eventMatchers được ưu tiên để chỉ định các sự kiện đóng góp vào tần suất. dv360LineitemIds, cmCampaignIds và googleAdsCampaignIds sẽ được sử dụng nếu eventMatchers trống.
frequencyConstraint

object (FrequencyConstraint)

Mô tả thời điểm người dùng được thêm vào danh sách.
slidingWindowDays

integer

Bắt buộc. Kích thước khoảng thời gian được sử dụng khi tính tần suất của từng sự kiện. Chỉ số này được tính bằng ngày

EventMatcher

Sự kiện chung góp phần tạo nên tần suất.

Biểu diễn dưới dạng JSON 
{
  "matchType": enum (MatchType),
  "value": string
}
Các trường
matchType

enum (MatchType)

Loại quy tắc ràng buộc sẽ được đưa vào số lượng tần suất.
value

string

Giá trị của điều kiện ràng buộc. Ví dụ: để chỉ định một mã chiến dịch Google Ads = 1234, kiểu khớp sẽ là GOOGLE_ADS_CAMPAIGN_ID và giá trị sẽ là # 39;1234&hl=vi3; Những sự kiện có giá trị này cho MatchType tương ứng sẽ được tính vào số lượng tần suất.

Kiểu khớp

Các loại ràng buộc được hỗ trợ để đếm tần suất. Sau này, có thể có nhiều loại khác được thêm vào enum này để hỗ trợ các hạn chế khác. Bạn có thể chỉ định một bộ lọc trên MatchType trongDescriptionValidFrequencyLimitingEventMatchersRequest để hạn chế trình so khớp sự kiện được trả về trong kết quả chỉ ở những trình được API của bạn hỗ trợ. Ví dụ: việc đặt bộ lọc là "eventMatcher.match_type= CM_CAMPAIGN_ID OR eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID" sẽ chỉ trả về eventMatchers của hai loại đó.

Enum
MATCH_TYPE_UNSPECIFIED Giá trị mặc định. Giá trị này không được sử dụng.
CM_CAMPAIGN_ID Loại ràng buộc đại diện cho mã chiến dịch Campaign Manager.
DV360_INSERTION_ORDER_ID Loại điều kiện ràng buộc thể hiện Mã đơn đặt hàng quảng cáo DV360.
DV360_LINE_ITEM_ID Loại quy tắc ràng buộc biểu thị mã mục hàng Display & Video 360.
GOOGLE_ADS_CAMPAIGN_ID Loại quy tắc ràng buộc biểu thị mã chiến dịch trên Google Ads.

Giới hạn tần suất

Chỉ định số lượng sự kiện tối thiểu cho giới hạn.

Biểu diễn dưới dạng JSON 
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
Các trường
eventType

enum (EventType)

Không thể thay đổi. Loại sự kiện sẽ được tính theo NgưỡngEventCount. Hiện tại, chúng tôi không trình bày rõ ràng các hạn chế khi so sánh nếu giả sử tất cả đều là REMAINING_OR_equal.
thresholdEventCount

string (int64 format)

Bắt buộc. Mỗi người dùng phải xuất hiện trong ít nhất K sự kiện.

Loại sự kiện

Các loại sự kiện có thể dùng để tính tần suất.

Enum
EVENT_TYPE_UNSPECIFIED Giá trị mặc định: không được sử dụng.
IMPRESSIONS Đếm tất cả các lượt hiển thị.

Danh sách tiếp thị lại

Siêu dữ liệu cho danh sách tái tiếp thị.

Biểu diễn dưới dạng JSON 
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
Các trường
userListQuery

string

Không thể thay đổi. Tài nguyên truy vấn danh sách người dùng của Ads Data Hub chỉ định cách thêm người dùng vào đối tượng này. Có dạng: customer/[customerId]/userListQueries/[query_resource_id]
populatingUserListQueries[]

string

Chỉ đầu ra. Tài nguyên truy vấn danh sách người dùng của Ads Data Hub đã điền sẵn đối tượng này. Đây là trường cũ để hỗ trợ danh sách người dùng được điền bởi nhiều truy vấn trước khi danh sách người dùng 1:1 có giới hạn truy vấn có hiệu lực. Có dạng: customer/[customerId]/userListQueries/[query_resource_id]

Tiểu bang

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

Enum
STATE_UNSPECIFIED Giá trị mặc định / chưa đặt.
STATE_ACTIVE Danh sách người dùng vẫn mở và hoạt động.
STATE_DELETED Danh sách người dùng được đánh dấu là đã xóa và không được dùng để nhắm mục tiêu nữa

Phương pháp

addEventMatchers

 Thêm trình so khớp sự kiện vào danh sách người dùng dựa trên tần suất.

addRecipients

 Thêm các thực thể vào người nhận của danh sách người dùng do Ads Data Hub quản lý.

create

 Tạo danh sách người dùng do Ads Data Hub quản lý.

delete

 Xóa danh sách người dùng do Ads Data Hub quản lý đã yêu cầu.

generateFrequencyListMemberships

 Tạo tư cách thành viên cho Danh sách người dùng.

get

 Truy xuất danh sách người dùng do Ads Data Hub quản lý.

list

 Liệt kê các danh sách người dùng do khách hàng Ads Data Hub được chỉ định quản lý.

patch

 Cập nhật danh sách người dùng do Ads Data Hub quản lý.

removeRecipients

 Xoá các thực thể khỏi người nhận của danh sách người dùng do Ads Data Hub quản lý.