REST Resource: accountTypes.accounts.userLists

משאב: UserList

משאב של רשימת משתמשים.

ייצוג ב-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.
}
שדות
name

string

מזהה. שם המשאב של רשימת המשתמשים. פורמט: accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

פלט בלבד. המזהה הייחודי של רשימת המשתמשים.
readOnly

boolean

פלט בלבד. אפשרות שמציינת אם משתמש יכול לערוך רשימה.
membershipDuration

string (Duration format)

אופציונלי. משך הזמן שמשתמש נשאר ברשימת המשתמשים. משכי הזמן התקפים הם כפולות מדויקות של 24 שעות (86,400 שניות). אם תספקו ערך שלא מתחלק ב-24 ללא שארית, תופיע השגיאה INVALID_ARGUMENT.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה, שמסתיים ב-'s'. דוגמה: "3.5s".
accessReason

enum (AccessReason)

פלט בלבד. הסיבה שבגללה ניתנה לחשבון הזה גישה לרשימה.
sizeInfo

object (SizeInfo)

פלט בלבד. מספר המשתמשים המשוער ברשימת המשתמשים הזו ברשתות טירגוט שונות.
targetNetworkInfo

object (TargetNetworkInfo)

אופציונלי. מידע על דרישות הסף לרשתות יעד שונות.
displayName

string

חובה. השם המוצג של רשימת המשתמשים.
description

string

אופציונלי. תיאור של רשימת המשתמשים.
membershipStatus

enum (MembershipStatus)

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

string

אופציונלי. מזהה ממערכת חיצונית. הוא משמש מוכרים של רשימות משתמשים כדי ליצור קורלציה בין מזהים במערכות שלהם.
closingReason

enum (ClosingReason)

פלט בלבד. הסיבה לכך שסטטוס החברות ברשימת המשתמשים הזו הוא 'סגור'.
accountAccessStatus

enum (AccessStatus)

אופציונלי. מציין אם השיתוף הזה עדיין מופעל. כשמשתפים רשימת משתמשים עם החשבון, הערך בשדה הזה הוא ENABLED. בהמשך, הבעלים של רשימת המשתמשים יכול לבטל את השיתוף ולהפוך אותה לDISABLED.
שדה איחוד user_list_info. מידע נוסף על רשימת המשתמשים. הערך user_list_info יכול להיות רק אחד מהבאים:
ingestedUserListInfo

object (IngestedUserListInfo)

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

MembershipStatus

הסטטוס של רשימת המשתמשים.

טיפוסים בני מנייה (enum)
MEMBERSHIP_STATUS_UNSPECIFIED לא צוין.
OPEN סטטוס פתוח – רשימת המשתמשים צוברת חברים ואפשר לטרגט אותה.
CLOSED סטטוס סגור – לא מתווספים חברים חדשים לרשימה.

ClosingReason

מציין את הסיבה לסגירת רשימת המשתמשים. הספירה הזו משמשת רק כשהמערכת סוגרת רשימה באופן אוטומטי.

טיפוסים בני מנייה (enum)
CLOSING_REASON_UNSPECIFIED לא צוין.
UNUSED רשימת המשתמשים נסגרה כי לא נעשה בה שימוש בטירגוט לאחרונה. פרטים נוספים זמינים בכתובת https://support.google.com/google-ads/answer/2472738.

AccessReason

‫Enum שמתאר את הסיבות האפשריות לגישה.

טיפוסים בני מנייה (enum)
ACCESS_REASON_UNSPECIFIED לא צוין.
OWNED המשאב נמצא בבעלות המשתמש.
SHARED המשאב משותף עם המשתמש.
LICENSED המשאב מורשה למשתמש.
SUBSCRIBED המשתמש נרשם למשאב.
AFFILIATED למשתמש יש גישה למשאב.

AccessStatus

מציין אם ללקוח הזה עדיין יש גישה לרשימה.

טיפוסים בני מנייה (enum)
ACCESS_STATUS_UNSPECIFIED לא צוין.
ENABLED הגישה מופעלת.
DISABLED הגישה מושבתת.

SizeInfo

מספר המשתמשים המשוער ברשימת המשתמשים הזו ברשתות טירגוט שונות.

ייצוג ב-JSON 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string,
  "youtubeMembersCount": string,
  "gmailMembersCount": string
}
שדות
displayNetworkMembersCount

string (int64 format)

פלט בלבד. מספר מוערך של חברים ברשימת המשתמשים הזו ברשת המדיה של Google.
searchNetworkMembersCount

string (int64 format)

פלט בלבד. מספר החברים המשוער ברשימת המשתמשים הזו בדומיין google.com. אלה חברי הקהל שזמינים לטירגוט בקמפיינים לרשת החיפוש.
youtubeMembersCount

string (int64 format)

פלט בלבד. המספר המשוער של החברים ברשימת המשתמשים הזו ב-YouTube.
gmailMembersCount

string (int64 format)

פלט בלבד. מספר מוערך של משתמשים ברשימה הזו ב-Gmail.

TargetNetworkInfo

מידע על דרישות הסף לרשתות יעד שונות.

ייצוג ב-JSON 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
שדות
eligibleForDisplay

boolean

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

IngestedUserListInfo

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

ייצוג ב-JSON 
{
  "uploadKeyTypes": [
    enum (UploadKeyType)
  ],
  "contactIdInfo": {
    object (ContactIdInfo)
  },
  "mobileIdInfo": {
    object (MobileIdInfo)
  },
  "userIdInfo": {
    object (UserIdInfo)
  },
  "pairIdInfo": {
    object (PairIdInfo)
  },
  "pseudonymousIdInfo": {
    object (PseudonymousIdInfo)
  },
  "partnerAudienceInfo": {
    object (PartnerAudienceInfo)
  }
}
שדות
uploadKeyTypes[]

enum (UploadKeyType)

חובה. אי אפשר לשנות. סוגים של מפתחות העלאה של רשימת המשתמשים הזו.
contactIdInfo

object (ContactIdInfo)

אופציונלי. מידע נוסף אם CONTACT_ID הוא אחד מuploadKeyTypes.
mobileIdInfo

object (MobileIdInfo)

אופציונלי. מידע נוסף אם MOBILE_ID הוא אחד מuploadKeyTypes.
userIdInfo

object (UserIdInfo)

אופציונלי. מידע נוסף אם USER_ID הוא אחד מuploadKeyTypes.
pairIdInfo

object (PairIdInfo)

אופציונלי. מידע נוסף אם PAIR_ID הוא אחד מuploadKeyTypes.

התכונה הזו זמינה רק לשותפי נתונים.
pseudonymousIdInfo

object (PseudonymousIdInfo)

אופציונלי. המידע הנוסף על PSEUDONYMOUS_ID הוא אחד מuploadKeyTypes.
partnerAudienceInfo

object (PartnerAudienceInfo)

אופציונלי. מידע נוסף על קהלים של שותפים.

התכונה הזו זמינה רק לשותפי נתונים.

UploadKeyType

טיפוסים בני מנייה (enum) שמכילים את סוגי מפתחות ההעלאה האפשריים של רשימת משתמשים.

טיפוסים בני מנייה (enum)
UPLOAD_KEY_TYPE_UNSPECIFIED לא צוין.
CONTACT_ID פרטי לקוחות כמו כתובת אימייל, מספר טלפון או כתובת פיזית.
MOBILE_ID מזהים לצורכי פרסום במובייל.
USER_ID מזהי משתמש שסופקו על ידי צד שלישי.
PAIR_ID מזהים של בעלי תוכן דיגיטלי שמשמשים לתיאום זהות המפרסם.
PSEUDONYMOUS_ID מזהים של פלטפורמה לניהול נתונים: – מזהה משתמש ב-Google – מזהה שסופק על ידי השותף – מזהה שסופק על ידי בעל התוכן הדיגיטלי – מזהה IDFA ב-iOS – מזהה פרסום ב-Android – מזהה Roku – מזהה Amazon Fire TV – מזהה Xbox או Microsoft

ContactIdInfo

מידע נוסף אם CONTACT_ID הוא אחד מuploadKeyTypes.

ייצוג ב-JSON 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
שדות
matchRatePercentage

integer

פלט בלבד. אחוז ההתאמה לרשימות משתמשים מסוג 'התאמה ללקוחות'.
dataSourceType

enum (DataSourceType)

אופציונלי. אי אפשר לשנות. מקור נתוני ההעלאה

DataSourceType

מציין את המקור של נתוני ההעלאה.

טיפוסים בני מנייה (enum)
DATA_SOURCE_TYPE_UNSPECIFIED לא צוין.
DATA_SOURCE_TYPE_FIRST_PARTY הנתונים שהועלו הם נתונים מאינטראקציה ישירה (First-Party).
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU הנתונים שהועלו מגיעים מסוכנות אשראי של צד שלישי.
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE הנתונים שהועלו הם מקובץ נתוני מצביעים של צד שלישי.
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA הנתונים שהועלו הם נתונים של שותפים שהם צד שלישי.

MobileIdInfo

מידע נוסף אם MOBILE_ID הוא אחד מuploadKeyTypes.

ייצוג ב-JSON 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
שדות
dataSourceType

enum (DataSourceType)

אופציונלי. אי אפשר לשנות. המקור של נתוני ההעלאה.
keySpace

enum (KeySpace)

חובה. אי אפשר לשנות. מרחב המפתחות של מזהים לנייד.
appId

string

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

KeySpace

מרחב מפתחות למזהה בנייד.

טיפוסים בני מנייה (enum)
KEY_SPACE_UNSPECIFIED לא צוין.
IOS מרחב המפתחות של iOS.
ANDROID מרחב המפתחות של Android.

UserIdInfo

מידע נוסף אם USER_ID הוא אחד מuploadKeyTypes.

ייצוג ב-JSON 
{
  "dataSourceType": enum (DataSourceType)
}
שדות
dataSourceType

enum (DataSourceType)

אופציונלי. אי אפשר לשנות. המקור של נתוני ההעלאה.

PairIdInfo

מידע נוסף אם PAIR_ID הוא אחד מuploadKeyTypes.

התכונה הזו זמינה רק לשותפי נתונים.

ייצוג ב-JSON 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
שדות
publisherId

string (int64 format)

חובה. אי אפשר לשנות. מזהה את בעל התוכן הדיגיטלי שאיתו מתבצעת התאמה של רשימת המשתמשים של Publisher Advertiser Identity Reconciliation. השדה הזה מסופק על ידי ספק ה-cleanroom והוא ייחודי רק במסגרת ה-cleanroom הזה. אי אפשר להשתמש בזה כמזהה גלובלי בכמה מרכזי נתונים נקיים.
publisherName

string

חובה. שם תיאורי של בעל התוכן הדיגיטלי שיוצג בממשק המשתמש כדי לשפר את חוויית הטירגוט.
matchRatePercentage

integer

חובה. השדה הזה מציין את אחוז ההתאמה של החברות ברשימת המשתמשים הזו לנתונים מאינטראקציה ישירה (First-Party) של בעל האפליקציה התואם. הערך חייב להיות בין 0 ל-100, כולל.
advertiserIdentifierCount

string (int64 format)

אופציונלי. מספר הרשומות של נתונים מאינטראקציה ישירה (First-Party) של המפרסם שהועלו לספק חדרים נקיים. המספר הזה לא מציין את הגודל של רשימת משתמשים מסוג PAIR.
cleanRoomIdentifier

string

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

PseudonymousIdInfo

מידע נוסף אם PSEUDONYMOUS_ID הוא אחד מuploadKeyTypes.

ייצוג ב-JSON 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
שדות
syncStatus

enum (SyncStatus)

פלט בלבד. סטטוס הסנכרון של רשימת המשתמשים.
billableRecordCount

string (int64 format)

אופציונלי. אי אפשר לשנות. מספר הרשומות שניתן לחייב עליהן (למשל, רשומות שהועלו או רשומות שתואמות לתוכן).

SyncStatus

סטטוס הסנכרון של רשימת המשתמשים.

טיפוסים בני מנייה (enum)
SYNC_STATUS_UNSPECIFIED לא צוין.
CREATED רשימת המשתמשים נוצרה כ-placeholder. הסנכרון של רשימת התוכן או המטא-נתונים עדיין לא הסתיים. רשימת המשתמשים לא מוכנה לשימוש.
READY_FOR_USE רשימת המשתמשים מוכנה לשימוש. התוכן וקובצי ה-Cookie סונכרנו בצורה תקינה.
FAILED אירעה שגיאה בסנכרון התוכן ו/או המטא-נתונים של רשימת המשתמשים. אי אפשר להשתמש ברשימת המשתמשים.

PartnerAudienceInfo

מידע נוסף על קהלים של שותפים.

התכונה הזו זמינה רק לשותפי נתונים.

ייצוג ב-JSON 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
שדות
partnerAudienceSource

enum (PartnerAudienceSource)

חובה. אי אפשר לשנות. המקור של קהל השותפים.
commercePartner

string

אופציונלי. השם של שותף המסחר. מותר רק אם partnerAudienceSource הוא COMMERCE_AUDIENCE.

PartnerAudienceSource

מקור נתונים ליצירת קהלים של שותף.

טיפוסים בני מנייה (enum)
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED לא צוין.
COMMERCE_AUDIENCE מקור הנתונים ליצירת קהלים של השותף הוא קהל מסחרי.
LINEAR_TV_AUDIENCE מקור הנתונים ליצירת קהלים של השותף הוא קהל של טלוויזיה לינארית.
AGENCY_PROVIDER_AUDIENCE מקור נתונים ליצירת קהלים של שותף הוא קהל מסוכנות או מספק.

Methods

create

 יוצר רשימת משתמשים.

delete

 מחיקת רשימת משתמשים.

get

 מקבלים UserList.

list

 רשימת רשימות משתמשים.

patch

 עדכון של רשימת משתמשים.