REST Resource: firstPartyAndPartnerAudiences

Tài nguyên: Đối tượng bên thứ nhất và đối tác

Mô tả danh sách đối tượng của bên thứ nhất hoặc đối tác dùng để nhắm mục tiêu. Đối tượng bên thứ nhất được tạo thông qua việc sử dụng dữ liệu khách hàng. Đối tượng đối tác do Nhà cung cấp dữ liệu 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,
  "firstPartyAndPartnerAudienceId": string,
  "displayName": string,
  "description": string,
  "firstPartyAndPartnerAudienceType": enum (FirstPartyAndPartnerAudienceType),
  "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à đối tượng đối tác.
firstPartyAndPartnerAudienceId

string (int64 format)

Giá trị nhận dạng. Mã nhận dạng duy nhất của đối tượng bên thứ nhất và đối tượng đối tác. Do hệ thống chỉ định.
displayName

string

Chỉ có đầu ra. Tên hiển thị của đối tượng bên thứ nhất và đối tượng đối tác.
description

string

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

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

enum (FirstPartyAndPartnerAudienceType)

Chỉ có đầu ra. Liệu đối tượng có phải là đối tượng bên thứ nhất và đối tượng đối tác hay không.
audienceType

enum (AudienceType)

Chỉ có đầu ra. Loại đối tượng.
audienceSource

enum (AudienceSource)

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

string (int64 format)

Chỉ có đầu ra. 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 gian hết hạn, hãy đặt giá trị của trường này thành 10000. Nếu không, giá trị được đặ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 dưới 1000, số lượng sẽ bị ẩn và hệ thống sẽ trả về giá trị 0 vì lý do liên quan đến quyền riêng 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 trước.

Nếu kích thước dưới 1000, số lượng sẽ bị ẩn và hệ thống sẽ trả về giá trị 0 vì lý do liên quan đến quyền riêng 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ô đối tượng ước tính cho mạng YouTube.

Nếu kích thước dưới 1000, số lượng sẽ bị ẩn và hệ thống sẽ trả về giá trị 0 vì lý do liên quan đến quyền riêng 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 dưới 1000, số lượng sẽ bị ẩn và hệ thống sẽ trả về giá trị 0 vì lý do liên quan đến quyền riêng 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 trong ứng dụng di động trên Mạng Hiển thị.

Nếu kích thước dưới 1000, số lượng sẽ bị ẩn và hệ thống sẽ trả về giá trị 0 vì lý do liên quan đến quyền riêng 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 dưới 1000, số lượng sẽ bị ẩn và hệ thống sẽ trả về giá trị 0 vì lý do liên quan đến quyền riêng 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 ước tính trên máy tính trong Mạng Hiển thị.

Nếu kích thước dưới 1000, số lượng sẽ bị ẩn và hệ thống sẽ trả về giá trị 0 vì lý do liên quan đến quyền riêng 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

Không bắt buộc. appId khớp với loại mobileDeviceId đang được tải lên.

Chỉ áp dụng cho audienceType CUSTOMER_MATCH_DEVICE_ID
Trường hợp hợp nhất members. Các thành viên ban đầu của đối tượng So khớp khách hàng. members chỉ có thể là một trong những giá trị sau:
contactInfoList

object (ContactInfoList)

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

Chỉ áp dụng cho audienceType CUSTOMER_MATCH_CONTACT_INFO
mobileDeviceIdList

object (MobileDeviceIdList)

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

Chỉ áp dụng cho audienceType CUSTOMER_MATCH_DEVICE_ID

FirstPartyAndPartnerAudienceType

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

Enum
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED Giá trị mặc định khi không chỉ định hoặc không xác định được loại.
TYPE_FIRST_PARTY Đối tượng được tạo thông qua việc sử dụng dữ liệu khách hàng.
TYPE_PARTNER Đối tượng do Nhà cung cấp dữ liệu 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 không chỉ định hoặc không xác định được loại.
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 các mã thiết bị di động đã biết.
CUSTOMER_MATCH_USER_ID Đối tượng được tạo thông qua việc so khớp khách hàng với Mã 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à họ đã nhận được.
TAG_BASED Đối tượng được tạo dựa trên các biến tuỳ chỉnh được đính kèm vào pixel.
YOUTUBE_USERS Đối tượng được tạo dựa trên các lượt tương tác trước đây với video, quảng cáo trên YouTube hoặc kênh YouTube.
THIRD_PARTY Đối tượng đã được cấp phép sử dụng từ bên thứ ba.
COMMERCE Đối tượng do các đối tác thương mại cung cấp có tính phí.
LINEAR Đối tượng của nội dung truyền hình truyền thống.

AudienceSource

Các 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 được.
DISPLAY_VIDEO_360 Xuất phát từ Display & Video 360.
CAMPAIGN_MANAGER Xuất phát từ Campaign Manager 360.
AD_MANAGER Xuất phát từ Google Ad Manager.
SEARCH_ADS_360 Xuất phát từ Search Ads 360.
YOUTUBE Xuất phát từ YouTube.
ADS_DATA_HUB Xuất phát từ Ads Data Hub.

ContactInfoList

Thông báo trình bao bọc cho danh sách 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 
{
  "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 trong đối tượng So khớp khách hàng. Kích thước của các thành phần sau khi 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.

Việc không đặt trường này cho biết rằng bạn không chỉ định sự đồng ý.

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

ContactInfo

Thông tin liên hệ xác định một thành viên trong đố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 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 ở dạng chữ thường.
hashedPhoneNumbers[]

string

Danh sách số điện thoại đã băm SHA256 của thành viên. Trước khi băm, tất cả số điện thoại phải được định dạng theo định dạng E.164 và bao gồm mã vùng của quốc gia.
zipCodes[]

string

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

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

string

Tên đã băm 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 ở dạng chữ thường.

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

string

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

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

string

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

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

ConsentStatus

Trạng thái đồng ý.

Enum
CONSENT_STATUS_UNSPECIFIED Giá trị loại chưa đượ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 Từ chối đồng ý.

MobileDeviceIdList

Thông báo trình bao bọc cho danh sách mã thiết bị di động 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 
{
  "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.

Việc không đặt trường này cho biết rằng bạn không chỉ định sự đồng ý.

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

Phương thức

create

 Tạo FirstPartyAndPartnerAudience.

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

 Nhận đối tượng của bên thứ nhất hoặc đối tác.

list

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

patch

 Cập nhật FirstPartyAndPartnerAudience hiện có.