REST Resource: customers.userLists

משאב: רשימת משתמשים

הגדרה של רשימת משתמשים המנוהלת ב-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 כשמפעילים משימות של רשימת משתמשים באמצעות רשימת המשתמשים הזו. אם הוא לא נמצא, המערכת תשתמש בלקוח ההורה שלך. לא ניתן לשנות את הבחירה הזו לאחר יצירת הרשימה.
title

string

חובה. השם של רשימת המשתמשים, שהוא ייחודי ל-AdsDataCustomerId שצוין.
description

string

חובה. תיאור רשימת משתמשים.
type

enum (UserListType)

פלט בלבד. ערכי סוגים של רשימות משתמשים צריכים להיות תואמים לערכים של רשימת המשתמשים. הערך הזה הוא לקריאה בלבד והוא יהיה נגיש בבקשות get/list.
createEmail

string

פלט בלבד. כתובת האימייל של המשתמש שיצר את רשימת המשתמשים הזו.
listSize

string (int64 format)

פלט בלבד. מספר המשתמשים ברשימת המשתמשים. ייתכן עיכוב בעדכון גודל הרשימה.
populateTime

string (Timestamp format)

פלט בלבד. שעת אכלוס הרשימה האחרונה.

חותמת זמן בפורמט RFC3339 UTC "Zulu" עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
state

enum (State)

פלט בלבד. המצב של רשימת המשתמשים (פעילה/נמחקה). הערך הזה הוא לקריאה בלבד והוא יהיה נגיש בבקשות get/list.

שדה איחוד user_list. תצורה נוספת בהתאם לסוג של רשימת המשתמשים.

יש להגדיר ערך אחד בלבד. user_list יכול להיות רק אחד מאלה:
frequencyList

object (FrequencyBasedListInfo)

רשימת משתמשים למכסת תדירות.
remarketingList

object (RemarketingListInfo)

רשימת רימרקטינג.

סוג של רשימת משתמשים

סוג של רשימת משתמשים. יצירה של רשימת משתמשים ושימוש בהם בזמן הטירגוט תלויה במספר הזה. לא ניתן לשנות את סוג הרשימה לאחר היצירה.

Enums
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, הערך 'סוג התאמה' יהיה GOOGLE_ADS_CAMPAIGN_ID והערך יהיה '1234' אירועים בעלי ערך זה עבור סוג ההתאמה המתאים ייכללו בספירת התדירות.

סוג התאמה

סוגי אילוצים הנתמכים לספירת התדירות. יכול להיות שנוסיף סוגים נוספים בעתיד למספר הזה כדי לתמוך במגבלות נוספות. אפשר לציין מסנן ב-TypeType ב-DescribevalidFrequencyLimitingEvent MatchersRequest כדי להגביל את ההתאמות של האירועים המוחזרות בתוצאות רק לאלו שנתמכות על ידי ה-API. לדוגמה, הגדרת המסנן "eventMATCHer.match_type= CM_CAMPAIGN_ID OR eventMATCHer.match_type=GOOGLE_ADS_CAMPAIGN_ID" תחזיר את Event Matchers רק משני הסוגים האלה.

Enums
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)

בלתי ניתן לשינוי. סוג האירוע שייספר בסף של EventEventCount. בשלב זה אנחנו לא מייצגים באופן מפורש את אילוצי ההשוואה, בהנחה שהכול הוא GREATER_OR_EQUAL.
thresholdEventCount

string (int64 format)

חובה. כל משתמש צריך להופיע ב-K אירועים לפחות.

סוג האירוע

סוגי האירועים שבהם ניתן להשתמש כדי לספור את התדירות.

Enums
EVENT_TYPE_UNSPECIFIED ערך ברירת המחדל: אין להשתמש במערכת.
IMPRESSIONS ספירת כל החשיפות.

מידע על רשימת רימרקטינג

מטא-נתונים עבור רשימות רימרקטינג.

ייצוג JSON 
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
שדות
userListQuery

string

בלתי ניתן לשינוי. משאב השאילתה של רשימת המשתמשים ב-Ads Data Hub שקובע איך משתמשים יתווספו לקהל הזה. תבנית של: הלקוחות/[customerId]/userListQuery/[query_resource_id]
populatingUserListQueries[]

string

פלט בלבד. משאבי השאילתה של רשימת המשתמשים אכלוס הקהל הזה ב-Ads Data Hub. השדה הזה נועד לשמש כשדה מדור קודם כדי לתמוך ברשימות משתמשים שאוכלסו על ידי מספר שאילתות לפני שהגבלות מסוג 1:1 של רשימת המשתמשים:משתמשים נכנסו לתוקף. תבנית של: הלקוחות/[customerId]/userListQuery/[query_resource_id]

מדינה

המצב של רשימת המשתמשים.

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