REST Resource: accountTypes.accounts.userLists

Tài nguyên: UserList

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

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "id": string,
  "readOnly": boolean,
  "membershipDuration": string,
  "accessReason": enum (AccessReason),
  "sizeInfo": {
    object (SizeInfo)
  },
  "targetNetworkInfo": {
    object (TargetNetworkInfo)
  },
  "displayName": string,
  "description": string,
  "membershipStatus": enum (MembershipStatus),
  "integrationCode": string,
  "closingReason": enum (ClosingReason),
  "accountAccessStatus": enum (AccessStatus),

  // Union field user_list_info can be only one of the following:
  "ingestedUserListInfo": {
    object (IngestedUserListInfo)
  }
  // End of list of possible types for union field user_list_info.
}
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/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

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

boolean

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

string (Duration format)

Không bắt buộc. Khoảng thời gian mà người dùng vẫn nằm 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.

Thời lượng tính bằng giây, có tối đa 9 chữ số thập phân, kết thúc bằng "s". Ví dụ: "3.5s".
accessReason

enum (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.
sizeInfo

object (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.
targetNetworkInfo

object (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.
displayName

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

enum (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.
integrationCode

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

enum (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.
accountAccessStatus

enum (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:
ingestedUserListInfo

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

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.

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.

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.

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.

Biểu diễn dưới dạng JSON 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string,
  "youtubeMembersCount": string,
  "gmailMembersCount": string
}
Trường
displayNetworkMembersCount

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

TargetNetworkInfo

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

Biểu diễn dưới dạng JSON 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
Trường
eligibleForDisplay

boolean

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.

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.

Biểu diễn dưới dạng JSON 
{
  "uploadKeyTypes": [
    enum (UploadKeyType)
  ],
  "contactIdInfo": {
    object (ContactIdInfo)
  },
  "mobileIdInfo": {
    object (MobileIdInfo)
  },
  "userIdInfo": {
    object (UserIdInfo)
  },
  "pairIdInfo": {
    object (PairIdInfo)
  },
  "pseudonymousIdInfo": {
    object (PseudonymousIdInfo)
  },
  "partnerAudienceInfo": {
    object (PartnerAudienceInfo)
  }
}
Trường
uploadKeyTypes[]

enum (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.
contactIdInfo

object (ContactIdInfo)

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

object (MobileIdInfo)

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

object (UserIdInfo)

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

object (PairIdInfo)

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

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

object (PseudonymousIdInfo)

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

object (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

ContactIdInfo

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

Biểu diễn dưới dạng JSON 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
Trường
matchRatePercentage

integer

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

enum (DataSourceType)

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

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.

MobileIdInfo

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

Biểu diễn dưới dạng JSON 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
Trường
dataSourceType

enum (DataSourceType)

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

enum (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.
appId

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.

UserIdInfo

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

Biểu diễn dưới dạng JSON 
{
  "dataSourceType": enum (DataSourceType)
}
Trường
dataSourceType

enum (DataSourceType)

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

PairIdInfo

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

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

Biểu diễn dưới dạng JSON 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
Trường
publisherId

string (int64 format)

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

string

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

integer

Bắt buộc. 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 của bên thứ nhất tương ứng của nhà xuất bản. Phải nằm trong khoảng từ 0 đến 100.
advertiserIdentifierCount

string (int64 format)

Không bắt buộc. 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.
cleanRoomIdentifier

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.

PseudonymousIdInfo

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

Biểu diễn dưới dạng JSON 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
Trường
syncStatus

enum (SyncStatus)

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

string (int64 format)

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.

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.

Biểu diễn dưới dạng JSON 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
Trường
partnerAudienceSource

enum (PartnerAudienceSource)

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

string

Không bắt buộc. Tên đối tác thương mại. Chỉ được phép nếu partnerAudienceSource là COMMERCE_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.

Phương thức

create

 Tạo một UserList.

delete

 Xoá một UserList.

get

 Lấy một UserList.

list

 Liệt kê UserLists.

patch

 Cập nhật một UserList.