REST Resource: firstAndThirdPartyAudiences

Tài nguyên: FirstAndSecondPartyAudience

Mô tả danh sách đối tượng của bên thứ nhất hoặc bên thứ ba dùng để nhắm mục tiêu. Đối tượng của bên thứ nhất được tạo bằng cách sử dụng dữ liệu của khách hàng. Đối tượng của bên thứ ba do nhà cung cấp dữ liệu của Bên thứ ba cung cấp và chỉ có thể được cấp phép cho khách hàng.

Biểu diễn dưới dạng JSON
{
  "name": string,
  "firstAndThirdPartyAudienceId": string,
  "displayName": string,
  "description": string,
  "firstAndThirdPartyAudienceType": enum (FirstAndThirdPartyAudienceType),
  "audienceType": enum (AudienceType),
  "audienceSource": enum (AudienceSource),
  "membershipDurationDays": string,
  "displayAudienceSize": string,
  "activeDisplayAudienceSize": string,
  "youtubeAudienceSize": string,
  "gmailAudienceSize": string,
  "displayMobileAppAudienceSize": string,
  "displayMobileWebAudienceSize": string,
  "displayDesktopAudienceSize": string,
  "appId": string,

  // Union field members can be only one of the following:
  "contactInfoList": {
    object (ContactInfoList)
  },
  "mobileDeviceIdList": {
    object (MobileDeviceIdList)
  }
  // End of list of possible types for union field members.
}
Trường
name

string

Chỉ có đầu ra. Tên tài nguyên của đối tượng bên thứ nhất và bên thứ ba.

firstAndThirdPartyAudienceId

string (int64 format)

Chỉ có đầu ra. Mã nhận dạng duy nhất của đối tượng thứ nhất và bên thứ ba. Do hệ thống chỉ định.

displayName

string

Tên hiển thị của đối tượng thứ nhất và bên thứ ba.

description

string

Nội dung mô tả về đối tượng do người dùng cung cấp.

Chỉ áp dụng cho đối tượng bên thứ nhất.

firstAndThirdPartyAudienceType

enum (FirstAndThirdPartyAudienceType)

Đối tượng là đối tượng thứ nhất hay bên thứ ba.

audienceType

enum (AudienceType)

Kiểu đối tượng.

audienceSource

enum (AudienceSource)

Chỉ có đầu ra. Nguồn của đối tượng.

membershipDurationDays

string (int64 format)

Khoảng thời gian tính bằng ngày mà một mục nhập vẫn nằm trong đối tượng sau sự kiện đủ điều kiện. Nếu đối tượng không có thời hạn, hãy đặt giá trị của trường này thành 10000. Nếu không, giá trị đã đặt phải lớn hơn 0 và nhỏ hơn hoặc bằng 540.

Chỉ áp dụng cho đối tượng bên thứ nhất.

Trường này là bắt buộc nếu bạn sử dụng một trong các audienceType sau:

  • CUSTOMER_MATCH_CONTACT_INFO
  • CUSTOMER_MATCH_DEVICE_ID
displayAudienceSize

string (int64 format)

Chỉ có đầu ra. Quy mô đối tượng ước tính cho Mạng Hiển thị.

Nếu kích thước nhỏ hơn 1000, số này sẽ bị ẩn và 0 sẽ được trả về vì lý do bảo mật. Nếu không, số sẽ được làm tròn thành hai chữ số có nghĩa.

Chỉ được trả về trong yêu cầu GET.

activeDisplayAudienceSize

string (int64 format)

Chỉ có đầu ra. Quy mô đối tượng ước tính cho Mạng Hiển thị trong tháng qua.

Nếu kích thước nhỏ hơn 1000, số này sẽ bị ẩn và 0 sẽ được trả về vì lý do bảo mật. Nếu không, số sẽ được làm tròn thành hai chữ số có nghĩa.

Chỉ được trả về trong yêu cầu GET.

youtubeAudienceSize

string (int64 format)

Chỉ có đầu ra. Quy mô khán giả ước tính cho mạng YouTube.

Nếu kích thước nhỏ hơn 1000, số này sẽ bị ẩn và 0 sẽ được trả về vì lý do bảo mật. Nếu không, số sẽ được làm tròn thành hai chữ số có nghĩa.

Chỉ áp dụng cho đối tượng bên thứ nhất.

Chỉ được trả về trong yêu cầu GET.

gmailAudienceSize

string (int64 format)

Chỉ có đầu ra. Quy mô đối tượng ước tính cho mạng Gmail.

Nếu kích thước nhỏ hơn 1000, số này sẽ bị ẩn và 0 sẽ được trả về vì lý do bảo mật. Nếu không, số sẽ được làm tròn thành hai chữ số có nghĩa.

Chỉ áp dụng cho đối tượng bên thứ nhất.

Chỉ được trả về trong yêu cầu GET.

displayMobileAppAudienceSize

string (int64 format)

Chỉ có đầu ra. Quy mô đối tượng ước tính của ứng dụng dành cho thiết bị di động trong Mạng Hiển thị.

Nếu kích thước nhỏ hơn 1000, số này sẽ bị ẩn và 0 sẽ được trả về vì lý do bảo mật. Nếu không, số sẽ được làm tròn thành hai chữ số có nghĩa.

Chỉ áp dụng cho đối tượng bên thứ nhất.

Chỉ được trả về trong yêu cầu GET.

displayMobileWebAudienceSize

string (int64 format)

Chỉ có đầu ra. Quy mô đối tượng ước tính trên web dành cho thiết bị di động trong Mạng Hiển thị.

Nếu kích thước nhỏ hơn 1000, số này sẽ bị ẩn và 0 sẽ được trả về vì lý do bảo mật. Nếu không, số sẽ được làm tròn thành hai chữ số có nghĩa.

Chỉ áp dụng cho đối tượng bên thứ nhất.

Chỉ được trả về trong yêu cầu GET.

displayDesktopAudienceSize

string (int64 format)

Chỉ có đầu ra. Quy mô đối tượng trên máy tính ước tính trong Mạng Hiển thị.

Nếu kích thước nhỏ hơn 1000, số này sẽ bị ẩn và 0 sẽ được trả về vì lý do bảo mật. Nếu không, số sẽ được làm tròn thành hai chữ số có nghĩa.

Chỉ áp dụng cho đối tượng bên thứ nhất.

Chỉ được trả về trong yêu cầu GET.

appId

string

appId khớp với loại mobileDeviceIds đang được tải lên.

Chỉ áp dụng cho CUSTOMER_MATCH_DEVICE_ID audienceType

Trường nhóm members. Các thành viên đầu tiên của đối tượng So khớp khách hàng. members chỉ có thể là một trong những trạng thái sau đây:
contactInfoList

object (ContactInfoList)

Chỉ nhập. Danh sách thông tin liên hệ để xác định các thành viên ban đầu của đối tượng.

Chỉ áp dụng cho CUSTOMER_MATCH_CONTACT_INFO audienceType

mobileDeviceIdList

object (MobileDeviceIdList)

Chỉ nhập. Danh sách mã thiết bị di động để xác định các thành viên trong đối tượng ban đầu.

Chỉ áp dụng cho CUSTOMER_MATCH_DEVICE_ID audienceType

FirstAndThirdPartyAudienceType

Các loại tài nguyên đối tượng bên thứ nhất và bên thứ ba có thể có.

Enum
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_UNSPECIFIED Giá trị mặc định khi loại không được chỉ định hoặc không xác định.
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY Đối tượng được tạo bằng cách sử dụng dữ liệu của ứng dụng.
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY Đối tượng do nhà cung cấp dữ liệu của Bên thứ ba cung cấp.

AudienceType

Các loại đối tượng có thể có.

Enum
AUDIENCE_TYPE_UNSPECIFIED Giá trị mặc định khi loại không được chỉ định hoặc không xác định.
CUSTOMER_MATCH_CONTACT_INFO Đối tượng được tạo bằng cách so khớp khách hàng với thông tin liên hệ đã biết.
CUSTOMER_MATCH_DEVICE_ID Đối tượng được tạo bằng cách so khớp khách hàng với Mã thiết bị di động đã biết.
CUSTOMER_MATCH_USER_ID Đối tượng được tạo bằng cách so khớp khách hàng với Mã nhận dạng người dùng đã biết.
ACTIVITY_BASED

Đối tượng được tạo dựa trên hoạt động của chiến dịch.

FREQUENCY_CAP

Đối tượng được tạo dựa trên việc loại trừ số lượt hiển thị mà đối tượng được phân phát.

TAG_BASED Đối tượng được tạo dựa trên các biến tuỳ chỉnh đính kèm với pixel.
YOUTUBE_USERS Đối tượng được tạo dựa trên những hoạt động tương tác trước đây với video, quảng cáo trên YouTube hoặc kênh YouTube.
LICENSED Loại phụ của loại đối tượng bên thứ ba.

AudienceSource

Nguồn đối tượng có thể có.

Enum
AUDIENCE_SOURCE_UNSPECIFIED Giá trị mặc định khi nguồn đối tượng không được chỉ định hoặc không xác định.
DISPLAY_VIDEO_360 Bắt nguồn từ Display & Video 360.
CAMPAIGN_MANAGER Bắt nguồn từ Campaign Manager 360.
AD_MANAGER Bắt nguồn từ Google Ad Manager.
SEARCH_ADS_360 Bắt nguồn từ Search Ads 360.
YOUTUBE Bắt nguồn từ YouTube.
ADS_DATA_HUB Bắt nguồn từ Ads Data Hub.

ContactInfoList

Thông báo bao bọc cho danh sách thông tin liên hệ xác định thành viên của đối tượng So khớp khách hàng.

Biểu diễn dưới dạng JSON
{
  "contactInfos": [
    {
      object (ContactInfo)
    }
  ],
  "consent": {
    object (Consent)
  }
}
Trường
contactInfos[]

object (ContactInfo)

Danh sách các đối tượng ContactInfo xác định thành viên của đối tượng So khớp khách hàng. Kích thước của các thành viên sau khi chia tách ContactInfos không được lớn hơn 500.000.

consent

object (Consent)

Chỉ nhập. Chế độ cài đặt về sự đồng ý cho người dùng trong contactInfos.

Nếu bạn không đặt trường này, thì tức là chưa chỉ định sự đồng ý.

Nếu bạn đặt các trường adUserData hoặc adPersonalization thành CONSENT_STATUS_DENIED, thì yêu cầu sẽ trả về một lỗi.

ContactInfo

Thông tin liên hệ xác định thành viên đối tượng So khớp khách hàng.

Biểu diễn dưới dạng JSON
{
  "hashedEmails": [
    string
  ],
  "hashedPhoneNumbers": [
    string
  ],
  "zipCodes": [
    string
  ],
  "hashedFirstName": string,
  "hashedLastName": string,
  "countryCode": string
}
Trường
hashedEmails[]

string

Danh sách email đã băm bằng thuật toán SHA256 của thành viên. Trước khi băm, hãy xoá tất cả khoảng trắng và đảm bảo chuỗi đều là chữ thường.

hashedPhoneNumbers[]

string

Danh sách các số điện thoại đã băm bằng thuật toán SHA256 của thành viên. Trước khi băm, tất cả các số điện thoại phải được định dạng bằng định dạng E.164 và có mã gọi quốc gia.

zipCodes[]

string

Danh sách mã bưu chính của thành viên.

Cũng phải đặt các trường sau:

hashedFirstName

string

SHA256 đã băm tên của thành viên. Trước khi băm, hãy xoá tất cả khoảng trắng và đảm bảo chuỗi đều là chữ thường.

Cũng phải đặt các trường sau:

hashedLastName

string

Hàm SHA256 đã băm họ của thành viên. Trước khi băm, hãy xoá tất cả khoảng trắng và đảm bảo chuỗi đều là chữ thường.

Cũng phải đặt các trường sau:

countryCode

string

Mã quốc gia của thành viên.

Cũng phải đặt các trường sau:

ConsentStatus

Trạng thái đồng ý.

Enum
CONSENT_STATUS_UNSPECIFIED Giá trị loại không được chỉ định hoặc không xác định trong phiên bản này.
CONSENT_STATUS_GRANTED Người dùng đã đồng ý.
CONSENT_STATUS_DENIED Không đồng ý.

MobileDeviceIdList

Thông báo bao bọc cho danh sách mã thiết bị di động xác định thành viên của đối tượng So khớp khách hàng.

Biểu diễn dưới dạng JSON
{
  "mobileDeviceIds": [
    string
  ],
  "consent": {
    object (Consent)
  }
}
Trường
mobileDeviceIds[]

string

Danh sách mã thiết bị di động xác định thành viên của đối tượng So khớp khách hàng. Kích thước của mobileDeviceIds không được lớn hơn 500.000.

consent

object (Consent)

Chỉ nhập. Chế độ cài đặt về sự đồng ý cho người dùng trong mobileDeviceIds.

Nếu bạn không đặt trường này, thì tức là chưa chỉ định sự đồng ý.

Nếu bạn đặt các trường adUserData hoặc adPersonalization thành CONSENT_STATUS_DENIED, thì yêu cầu sẽ trả về một lỗi.

Phương thức

create

Tạo FirstAndFirstPartyAudience.

editCustomerMatchMembers

Cập nhật danh sách thành viên của đối tượng So khớp khách hàng.

get

Có được đối tượng bên thứ nhất và bên thứ ba.

list

Liệt kê đối tượng bên thứ nhất và đối tượng bên thứ ba.

patch

Cập nhật một FirstAndSecondPartyAudience hiện có.