REST Resource: customers.userLists

แหล่งข้อมูล: UserList

กําหนดรายชื่อผู้ใช้ที่จัดการโดย Ads Data Hub

การแสดง 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.
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อที่ระบุรายชื่อผู้ใช้ Ads Data Hub ที่ไม่ซ้ํากัน ซึ่งมีแบบฟอร์ม customer/[customerId]/userLists/[userListId]
userListId

string (int64 format)

เอาต์พุตเท่านั้น รหัสรายชื่อผู้ใช้ ช่องนี้สร้างขึ้นโดยบริการและใช้เพื่อป้อนข้อมูลรายชื่อผู้ใช้
adsDataCustomerId

string (int64 format)

เปลี่ยนแปลงไม่ได้ รหัสลูกค้า Ads Data Hub ที่ลิงก์อยู่กับรายชื่อผู้ใช้นี้ ต้องระบุรหัสนี้เป็น adsDataCustomerId เมื่อเรียกใช้งาน UserListQuery โดยใช้รายชื่อผู้ใช้นี้ หากไม่มี ระบบจะใช้ลูกค้าหลัก เมื่อสร้างแล้วจะเปลี่ยนแปลงไม่ได้
title

string

ต้องระบุ ชื่อรายชื่อผู้ใช้ ซึ่งไม่ซ้ํากันสําหรับ adsDataCustomerId ที่ระบุ
description

string

ต้องระบุ คําอธิบายรายการผู้ใช้
type

enum (UserListType)

เอาต์พุตเท่านั้น ค่าประเภทรายการผู้ใช้ควรสอดคล้องกับรายการผู้ใช้ ค่านี้คืออ่านอย่างเดียวและจะเข้าถึงได้ตามคําขอ/รับรายการ
createEmail

string

เอาต์พุตเท่านั้น อีเมลของผู้ใช้ที่สร้างรายชื่อผู้ใช้นี้
listSize

string (int64 format)

เอาต์พุตเท่านั้น จํานวนผู้ใช้ในรายชื่อผู้ใช้ การอัปเดตขนาดรายการอาจล่าช้า
populateTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่ป้อนข้อมูลรายการครั้งล่าสุด

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดในระดับนาโนวินาทีและอาจใช้ตัวเลขไม่เกิน 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
state

enum (State)

เอาต์พุตเท่านั้น สถานะรายชื่อผู้ใช้ (ใช้งานอยู่/ลบ) ค่านี้คืออ่านอย่างเดียวและจะเข้าถึงได้ตามคําขอ/รับรายการ

ช่อง Union user_list การกําหนดค่าเพิ่มเติมจะขึ้นอยู่กับประเภทของรายชื่อผู้ใช้

ต้องตั้งค่าแอปหนึ่งรายการเท่านั้น user_list ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้เท่านั้น
frequencyList

object (FrequencyBasedListInfo)

รายชื่อผู้ใช้สําหรับการกําหนดความถี่สูงสุด
remarketingList

object (RemarketingListInfo)

รายการรีมาร์เก็ตติ้ง

ประเภทรายการผู้ใช้

ประเภทรายชื่อผู้ใช้ การสร้างและการใช้งานรายการผู้ใช้ ณ เวลาที่กําหนดเป้าหมายจะขึ้นอยู่กับการแจกแจงนี้ รายการไม่สามารถสลับประเภทได้หลังจากสร้าง

Enum
USER_LIST_TYPE_UNSPECIFIED ค่าเริ่มต้น: ไม่ควรใช้
REMARKETING กลุ่มเป้าหมายรีมาร์เก็ตติ้งที่สร้างด้วยการค้นหา SQL ใน ADH รายการรีมาร์เก็ตติ้งใช้ได้กับการกําหนดเป้าหมายเชิงบวกและเชิงลบ
FREQUENCY_BASED กลุ่มเป้าหมายที่จํากัดความถี่ กลุ่มเป้าหมายประเภทนี้จํากัดเฉพาะการกําหนดเป้าหมายเชิงลบ

ข้อมูลรายการความถี่

ข้อมูลเมตาสําหรับรายชื่อผู้ใช้ตามความถี่

การแสดง JSON 
{
  "dv360LineitemIds": [
    string
  ],
  "cmCampaignIds": [
    string
  ],
  "googleAdsCampaignIds": [
    string
  ],
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ],
  "frequencyConstraint": {
    object (FrequencyConstraint)
  },
  "slidingWindowDays": integer
}
ช่อง
dv360LineitemIds[]
(deprecated)

string (int64 format)

รหัสสําหรับรายการโฆษณา DV360 ที่ส่งผลต่อความถี่
cmCampaignIds[]
(deprecated)

string (int64 format)

รหัสสําหรับแคมเปญ CM ที่ส่งผลต่อความถี่
googleAdsCampaignIds[]
(deprecated)

string (int64 format)

รหัสของแคมเปญ Google Ads ที่ส่งผลต่อความถี่
eventMatchers[]

object (EventMatcher)

เหตุการณ์ใดที่ส่งผลต่อความถี่ เมื่อสร้างรายการตามความถี่ ระบบจะเลือกใช้ eventMatchers เพื่อระบุเหตุการณ์ที่ส่งผลต่อความถี่ ระบบจะใช้ dv360LineitemIds, cmCampaignIds และ googleAdsCampaignIds หาก eventMatchers ว่างเปล่า
frequencyConstraint

object (FrequencyConstraint)

อธิบายว่าจะมีการเพิ่มผู้ใช้ลงในรายการเมื่อใด
slidingWindowDays

integer

ต้องระบุ ขนาดกรอบเวลาที่ใช้ในการคํานวณความถี่ของแต่ละเหตุการณ์ ซึ่งวัดเป็นหน่วยวัน

ตัวจับคู่เหตุการณ์

เหตุการณ์ทั่วไปที่ส่งผลต่อความถี่

การแสดง JSON 
{
  "matchType": enum (MatchType),
  "value": string
}
ช่อง
matchType

enum (MatchType)

ประเภทของข้อจํากัดที่จะรวมอยู่ในจํานวนความถี่
value

string

ค่าของข้อจํากัด ตัวอย่างเช่น การระบุรหัสแคมเปญ Google Ads = 1234 จะทําให้ matchType เป็น GOOGLE_ADS_CAMPAIGN_ID และค่าจะเป็น '1234' เหตุการณ์ที่มีค่านี้สําหรับ MatchType ที่เกี่ยวข้องจะรวมอยู่ในจํานวนความถี่

ประเภทการจับคู่

ประเภทของข้อจํากัดที่รองรับสําหรับความถี่ ทั้งนี้อาจมีการเพิ่มประเภทอื่นๆ ไปยัง Enum นี้ในอนาคตเพื่อรองรับข้อจํากัดเพิ่มเติม คุณจะระบุตัวกรองใน MatchType ได้ใน ExplainvalidWidthLimitingEventMatchersRequest เพื่อจํากัดตัวจับคู่เหตุการณ์ที่แสดงในผลการค้นหาเพื่อแสดงเฉพาะตัวที่ API รองรับเท่านั้น เช่น การตั้งค่าตัวกรองเป็น "eventMatcher.match_type= CM_CAMPAIGN_ID OR eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID" จะแสดง EventMatchers เพียง 2 ประเภทเท่านั้น

Enum
MATCH_TYPE_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้
CM_CAMPAIGN_ID ประเภทข้อจํากัดที่แสดงรหัสแคมเปญ Campaign Manager
DV360_INSERTION_ORDER_ID ประเภทข้อจํากัดที่แสดงรหัสใบสั่งซื้อการใส่โฆษณา DV360
DV360_LINE_ITEM_ID ประเภทข้อจํากัดที่แทนรหัสรายการโฆษณา DV360
GOOGLE_ADS_CAMPAIGN_ID ประเภทข้อจํากัดที่สื่อถึงรหัสแคมเปญ Google Ads

ข้อจํากัดด้านความถี่

ระบุจํานวนเหตุการณ์ขั้นต่ําสําหรับขีดจํากัดสูงสุด

การแสดง JSON 
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
ช่อง
eventType

enum (EventType)

เปลี่ยนแปลงไม่ได้ ประเภทของเหตุการณ์ที่จะนับเทียบกับเกณฑ์เหตุการณ์ สําหรับตอนนี้เราไม่ได้แสดงข้อจํากัดการเปรียบเทียบอย่างชัดเจนหากสมมติว่าทั้งหมดเป็น GREATER_OR_EQUAL
thresholdEventCount

string (int64 format)

ต้องระบุ ผู้ใช้แต่ละคนควรปรากฏในเหตุการณ์อย่างน้อย K รายการ

ประเภทเหตุการณ์

ประเภทของเหตุการณ์ที่ใช้นับความถี่ได้

Enum
EVENT_TYPE_UNSPECIFIED ค่าเริ่มต้น: ไม่ควรใช้
IMPRESSIONS นับการแสดงผลทั้งหมด

ข้อมูลรายการรีมาร์เก็ตติ้ง

ข้อมูลเมตาสําหรับรายการรีมาร์เก็ตติ้ง

การแสดง JSON 
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
ช่อง
userListQuery

string

เปลี่ยนแปลงไม่ได้ แหล่งข้อมูลการค้นหารายชื่อผู้ใช้ Ads Data Hub ซึ่งระบุวิธีเพิ่มผู้ใช้ลงในกลุ่มเป้าหมายนี้ มีรูปแบบต่อไปนี้: customer/[customerId]/userListQuery/[query_resource_id]
populatingUserListQueries[]

string

เอาต์พุตเท่านั้น แหล่งข้อมูลการค้นหารายชื่อผู้ใช้ Ads Data Hub ที่มีกลุ่มเป้าหมายนี้ ซึ่งมีไว้เพื่อเป็นช่องเดิมเพื่อรองรับรายการผู้ใช้ที่ป้อนข้อมูลโดยการค้นหาหลายรายการก่อนที่ข้อจํากัดรายชื่อผู้ใช้ 1:1 จะมีผล มีรูปแบบต่อไปนี้: customer/[customerId]/userListQuery/[query_resource_id]

รัฐ

สถานะรายการผู้ใช้

Enum
STATE_UNSPECIFIED ค่าเริ่มต้น / ไม่ได้ตั้งค่า
STATE_ACTIVE รายการผู้ใช้ยังเปิดอยู่และใช้งานอยู่
STATE_DELETED มีการทําเครื่องหมายรายการผู้ใช้ว่าลบแล้ว และไม่ควรใช้เพื่อกําหนดเป้าหมาย

เมธอด

addEventMatchers

 เพิ่มตัวจับคู่เหตุการณ์ลงในรายการผู้ใช้ตามความถี่

addRecipients

 เพิ่มเอนทิตีไปยังผู้รับรายชื่อผู้ใช้ที่จัดการโดย Ads Data Hub

create

 สร้างรายการผู้ใช้ที่จัดการโดย Ads Data Hub

delete

 ลบรายชื่อผู้ใช้ที่จัดการโดย Ads Data Hub ตามที่ขอ

generateFrequencyListMemberships

 สร้างการเป็นสมาชิกสําหรับรายการผู้ใช้

get

 เรียกรายการผู้ใช้ที่จัดการโดย Ads Data Hub ที่ขอ

list

 แสดงรายชื่อผู้ใช้ที่จัดการโดยลูกค้า Ads Data Hub ที่ระบุ

patch

 อัปเดตรายชื่อผู้ใช้ที่จัดการโดย Ads Data Hub ที่ขอ

removeRecipients

 นําเอนทิตีออกจากผู้รับรายชื่อผู้ใช้ที่จัดการโดย Ads Data Hub