Package google.ads.datamanager.v1

אינדקס

IngestionService

שירות לשליחת נתוני קהלים ליעדים נתמכים.

IngestAdEvents

rpc IngestAdEvents(IngestAdEventsRequest) returns (IngestAdEventsResponse)

העלאת רשימה של משאבי AdEvent ל-Google Analytics.

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
IngestAudienceMembers

rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse)

העלאה של רשימת משאבי AudienceMember אל Destination שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
IngestEvents

rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse)

העלאה של רשימת משאבים Event מהקובץ Destination שסופק.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
RemoveAllAudienceMembers

rpc RemoveAllAudienceMembers(RemoveAllAudienceMembersRequest) returns (RemoveAllAudienceMembersResponse)

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
RemoveAudienceMembers

rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)

הסרה של רשימת משאבי AudienceMember מה-Destination שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
RetrieveRequestStatus

rpc RetrieveRequestStatus(RetrieveRequestStatusRequest) returns (RetrieveRequestStatusResponse)

הפונקציה מקבלת את הסטטוס של בקשה לפי מזהה הבקשה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager

MarketingDataInsightsService

שירות להחזרת תובנות לגבי נתוני שיווק.

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

RetrieveInsights

rpc RetrieveInsights(RetrieveInsightsRequest) returns (RetrieveInsightsResponse)

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

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

כותרות הרשאות:

השיטה הזו תומכת בכותרות האופציונליות הבאות, שבעזרתן אפשר להגדיר איך ה-API מאשר גישה לבקשה:

  • ‫login-account: (אופציונלי) שם המשאב של החשבון שבו חשבון Google של פרטי הכניסה הוא משתמש. אם לא מגדירים את הפרמטר, ברירת המחדל היא החשבון של הבקשה. פורמט: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • ‫linked-account: (אופציונלי) שם המשאב של החשבון עם קישור מוצר מבוסס אל login-account. פורמט: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager

PartnerLinkService

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

UserListDirectLicenseService

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

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

CreateUserListDirectLicense

rpc CreateUserListDirectLicense(CreateUserListDirectLicenseRequest) returns (UserListDirectLicense)

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

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
GetUserListDirectLicense

rpc GetUserListDirectLicense(GetUserListDirectLicenseRequest) returns (UserListDirectLicense)

מאחזר רישיון ישיר של רשימת משתמשים.

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
ListUserListDirectLicenses

rpc ListUserListDirectLicenses(ListUserListDirectLicensesRequest) returns (ListUserListDirectLicensesResponse)

רשימה של כל הרישיונות הישירים לרשימות משתמשים שבבעלות חשבון ההורה.

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
UpdateUserListDirectLicense

rpc UpdateUserListDirectLicense(UpdateUserListDirectLicenseRequest) returns (UserListDirectLicense)

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

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager

UserListGlobalLicenseService

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

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

CreateUserListGlobalLicense

rpc CreateUserListGlobalLicense(CreateUserListGlobalLicenseRequest) returns (UserListGlobalLicense)

יוצר רישיון גלובלי לרשימת משתמשים.

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
GetUserListGlobalLicense

rpc GetUserListGlobalLicense(GetUserListGlobalLicenseRequest) returns (UserListGlobalLicense)

מאחזר רישיון גלובלי של רשימת משתמשים.

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
ListUserListGlobalLicenseCustomerInfos

rpc ListUserListGlobalLicenseCustomerInfos(ListUserListGlobalLicenseCustomerInfosRequest) returns (ListUserListGlobalLicenseCustomerInfosResponse)

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

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
ListUserListGlobalLicenses

rpc ListUserListGlobalLicenses(ListUserListGlobalLicensesRequest) returns (ListUserListGlobalLicensesResponse)

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

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
UpdateUserListGlobalLicense

rpc UpdateUserListGlobalLicense(UpdateUserListGlobalLicenseRequest) returns (UserListGlobalLicense)

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

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager

UserListService

שירות לניהול משאבי UserList.

CreateUserList

rpc CreateUserList(CreateUserListRequest) returns (UserList)

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

כותרות הרשאות:

השיטה הזו תומכת בכותרות האופציונליות הבאות, שבעזרתן אפשר להגדיר איך ה-API מאשר גישה לבקשה:

  • ‫login-account: (אופציונלי) שם המשאב של החשבון שבו חשבון Google של פרטי הכניסה הוא משתמש. אם לא מגדירים את הפרמטר, ברירת המחדל היא החשבון של הבקשה. פורמט: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • ‫linked-account: (אופציונלי) שם המשאב של החשבון עם קישור מוצר מבוסס אל login-account. פורמט: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
DeleteUserList

rpc DeleteUserList(DeleteUserListRequest) returns (Empty)

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

כותרות הרשאות:

השיטה הזו תומכת בכותרות האופציונליות הבאות, שבעזרתן אפשר להגדיר איך ה-API מאשר גישה לבקשה:

  • ‫login-account: (אופציונלי) שם המשאב של החשבון שבו חשבון Google של פרטי הכניסה הוא משתמש. אם לא מגדירים את הפרמטר, ברירת המחדל היא החשבון של הבקשה. פורמט: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • ‫linked-account: (אופציונלי) שם המשאב של החשבון עם קישור מוצר מבוסס אל login-account. פורמט: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
GetUserList

rpc GetUserList(GetUserListRequest) returns (UserList)

מקבלים UserList.

כותרות הרשאות:

השיטה הזו תומכת בכותרות האופציונליות הבאות, שבעזרתן אפשר להגדיר איך ה-API מאשר גישה לבקשה:

  • ‫login-account: (אופציונלי) שם המשאב של החשבון שבו חשבון Google של פרטי הכניסה הוא משתמש. אם לא מגדירים את הפרמטר, ברירת המחדל היא החשבון של הבקשה. פורמט: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • ‫linked-account: (אופציונלי) שם המשאב של החשבון עם קישור מוצר מבוסס אל login-account. פורמט: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
ListUserLists

rpc ListUserLists(ListUserListsRequest) returns (ListUserListsResponse)

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

כותרות הרשאות:

השיטה הזו תומכת בכותרות האופציונליות הבאות, שבעזרתן אפשר להגדיר איך ה-API מאשר גישה לבקשה:

  • ‫login-account: (אופציונלי) שם המשאב של החשבון שבו חשבון Google של פרטי הכניסה הוא משתמש. אם לא מגדירים את הפרמטר, ברירת המחדל היא החשבון של הבקשה. פורמט: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • ‫linked-account: (אופציונלי) שם המשאב של החשבון עם קישור מוצר מבוסס אל login-account. פורמט: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager
UpdateUserList

rpc UpdateUserList(UpdateUserListRequest) returns (UserList)

עדכון של UserList.

כותרות הרשאות:

השיטה הזו תומכת בכותרות האופציונליות הבאות, שבעזרתן אפשר להגדיר איך ה-API מאשר גישה לבקשה:

  • ‫login-account: (אופציונלי) שם המשאב של החשבון שבו חשבון Google של פרטי הכניסה הוא משתמש. אם לא מגדירים את הפרמטר, ברירת המחדל היא החשבון של הבקשה. פורמט: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • ‫linked-account: (אופציונלי) שם המשאב של החשבון עם קישור מוצר מבוסס אל login-account. פורמט: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/datamanager

AdEvent

אירוע מודעה.

שדות
advertiser_id

string

חובה. המזהה של המפרסם שמשויך לאירוע מודעה.

המזהה הזה צריך להיות זהה למזהה שנשלח בתהליך הקישור.
event_type

EventType

חובה. סוג האירוע.
timestamp

Timestamp

חובה. השעה שבה האירוע התרחש.
event_id

string

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

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

UserData

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

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

DeviceInfo

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

string

אופציונלי. כתובת ה-IP שמשמשת למדידה. הערך הזה חייב להיות זהה לערך של DeviceInfo.ip_address. אם לא רוצים לשתף את כתובת ה-IP לצורך מדידה, משאירים את השדה ריק.
mobile_device_id

string

אופציונלי. מזהה המכשיר שהמודעה הוצגה בו.
campaign_id

string

חובה. המזהה של הקמפיין המשויך.
campaign_name

string

חובה. השם של הקמפיין המשויך.
ad_group_id

string

אופציונלי. המזהה של קבוצת המודעות המשויכת.
ad_id

string

אופציונלי. המזהה של המודעה המשויכת בקבוצה.
ad_height

int32

אופציונלי. גובה המודעה בפיקסלים.
ad_width

int32

אופציונלי. רוחב המודעה בפיקסלים.
region_code

string

אופציונלי. המדינה וחלוקת המשנה שלה לפי תקן ISO 3166-2.
source

string

חובה. פלטפורמת המקור של המודעה, בדומה למקור ב-Google Analytics.
medium

string

חובה. אמצעי ההגעה לאתר של המודעה, בדומה לאמצעי ההגעה לאתר ב-Google Analytics.
attribution_hint

AttributionHint

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

האות הזה משמש רק כדי להראות איך השותף משייך את ההמרות, והוא לא משפיע על התוצאות הסופיות בדוחות.
viewability_info

ViewabilityInfo

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

שדה איחוד event_subtype_oneof. אופציונלי. סיווג נוסף של סוג אירוע המודעה.

כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הערך event_subtype_oneof יכול להיות רק אחד מהבאים:
event_subtype

EventSubtype

ערך enum לסוג משנה של אירוע.
event_subtype_string

string

ערך המחרוזת של סוג המשנה של האירוע.

שדה איחוד ad_type_oneof. אופציונלי. סוג המודעה שהוצגה.

כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הערך ad_type_oneof יכול להיות רק אחד מהבאים:
ad_type

AdType

ערך טיפוס בן מנייה (enum) של סוג המודעה.
ad_type_string

string

ערך מחרוזת לסוג המודעה.

שדה איחוד ad_format_oneof. אופציונלי. סוג המודעה שהוצגה.

כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הערך ad_format_oneof יכול להיות רק אחד מהבאים:
ad_format

AdFormat

ערך enum לפורמט מודעה.
ad_format_string

string

ערך מחרוזת לפורמט המודעה.

שדה איחוד ad_placement_oneof. אופציונלי. מיקום המודעה שהוצגה.

כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הערך ad_placement_oneof יכול להיות רק אחד מהבאים:
ad_placement

AdPlacement

ערך enum למיקום מודעה.
ad_placement_string

string

ערך מחרוזת למיקום המודעה.

שדה איחוד targeting_type_oneof. אופציונלי. סוג הטירגוט ששימש להצגת המודעה.

כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הערך targeting_type_oneof יכול להיות רק אחד מהבאים:
targeting_type

TargetingType

ערך טיפוס בן מנייה (enum) של סוג הטירגוט.
targeting_type_string

string

ערך מחרוזת של סוג הטירגוט.

שדה איחוד platform_type_oneof. אופציונלי. סוג הפלטפורמה שבה הוצגה המודעה.

כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הערך platform_type_oneof יכול להיות רק אחד מהבאים:
platform_type

PlatformType

ערך טיפוס בן מנייה (enum) לסוג הפלטפורמה.
platform_type_string

string

ערך המחרוזת של סוג הפלטפורמה.

שדה איחוד platform_oneof. אופציונלי. פרטים נוספים על הפלטפורמה שבה המודעה הוצגה.

כדי לטפל בערכים שאינם enum טהור, אפשר להשתמש במחרוזת גולמית. אם אפשר, עדיף להשתמש ב-enum. הערך platform_oneof יכול להיות רק אחד מהבאים:
platform

Platform

ערך enum של הפלטפורמה.
platform_string

string

ערך מחרוזת לפלטפורמה.
measurement_allowed

bool

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

EventSubtype

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

טיפוסים בני מנייה (enum)
EVENT_SUBTYPE_UNSPECIFIED לא צוין סוג משנה של אירוע.
EVENT_SUBTYPE_IMPRESSION אירוע חשיפה.
EVENT_SUBTYPE_ENGAGED_VIEW אירוע מסוג צפייה פעילה.
EVENT_SUBTYPE_ONSITE_CLICK אירוע מסוג קליק באתר.
EVENT_SUBTYPE_OUTBOUND_CLICK אירוע מסוג קליק יוצא.

EventType

סוג האירוע.

טיפוסים בני מנייה (enum)
EVENT_TYPE_UNSPECIFIED סוג האירוע לא צוין.
EVENT_TYPE_VIEW לצפייה באירוע.
EVENT_TYPE_CLICK אירוע מסוג קליק.

AdFormat

הפורמט של המודעה שהוצגה.

טיפוסים בני מנייה (enum)
AD_FORMAT_UNSPECIFIED פורמט המודעה לא צוין.
AD_FORMAT_AR מודעת AR.
AD_FORMAT_AUDIO מודעת אודיו.
AD_FORMAT_BANNER מודעת באנר.
AD_FORMAT_BUMPER מודעת באמפר.
AD_FORMAT_COLLECTION מודעת אוסף.
AD_FORMAT_IMAGE מודעת תמונה.
AD_FORMAT_INTERACTIVE מודעה אינטראקטיבית.
AD_FORMAT_INTERSTITIAL מודעת מעברון.
AD_FORMAT_IN_FEED מודעה בגוף הפיד.
AD_FORMAT_IN_STREAM מודעת וידאו In-stream.
AD_FORMAT_IN_STREAM_SKIPPABLE מודעת וידאו In-stream שאפשר לדלג עליה.
AD_FORMAT_IN_STREAM_NON_SKIPPABLE מודעת וידאו In-stream שלא ניתן לדלג עליה.
AD_FORMAT_NATIVE מודעה מותאמת.
AD_FORMAT_SHORTS מודעה ב-Shorts.
AD_FORMAT_STORY מודעת קרוסלה למובייל.
AD_FORMAT_SPONSORED מודעה ממומנת.
AD_FORMAT_VIDEO מודעת וידאו.

AdIdentifiers

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

שדות
session_attributes

string

אופציונלי. מאפייני סשן לשיוך אירועים ולבניית מודלים.
gclid

string

אופציונלי. מספר הקליק ב-Google‏ (gclid) שמשויך לאירוע הזה.
gbraid

string

אופציונלי. המזהה של קליקים שמשויכים לאירועים באפליקציה ומגיעים ממכשירי iOS בגרסה 14 ואילך.
wbraid

string

אופציונלי. המזהה של קליקים שמשויכים לאירועים באתר ומגיעים ממכשירי iOS בגרסה 14 ואילך.
landing_page_device_info

DeviceInfo

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

string

אופציונלי. המזהה לצורכי פרסום במובייל. המזהה הזה הוא IDFA ב-iOS,‏ AdID ב-Android או מזהים אחרים למפרסמים בפלטפורמות אחרות.
dclid

string

אופציונלי. מזהה הקליק ברשת המדיה שמשויך לאירוע הזה.
impression_id

string

אופציונלי. מזהה החשיפה שמשויך לאירוע הזה.
match_id

string

אופציונלי. השדה של מזהה ההתאמה שמשמש לצירוף האירוע הזה לאירוע קודם.
encrypted_user_ids[]

EncryptedUserId

אופציונלי. מספר כלשהו של מזהי משתמשים מוצפנים.
ppid

string

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

string

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

AdPlacement

מיקום המודעה שהוצגה.

טיפוסים בני מנייה (enum)
AD_PLACEMENT_UNSPECIFIED מיקום המודעה לא צוין.
AD_PLACEMENT_DISCOVER גילוי מיקום מודעה.
AD_PLACEMENT_FEED מיקום הפיד.
AD_PLACEMENT_HEADER מיקום הכותרת.
AD_PLACEMENT_HOME מיקום בדף הבית.
AD_PLACEMENT_IN_CONTENT מיקום בתוך התוכן.
AD_PLACEMENT_PROMOTED מיקום מקודם.
AD_PLACEMENT_STORY מיקום הסטורי.

AdType

סוג המודעה שהוצגה.

טיפוסים בני מנייה (enum)
AD_TYPE_UNSPECIFIED סוג המודעה לא צוין.
AD_TYPE_DISPLAY מודעה לרשת המדיה.
AD_TYPE_TEXT מודעת טקסט.
AD_TYPE_IMAGE מודעת תמונה.
AD_TYPE_RICH_MEDIA מודעת מדיה עשירה.
AD_TYPE_HTML מודעת HTML.
AD_TYPE_AUDIO מודעת אודיו.
AD_TYPE_VIDEO מודעת וידאו.

AddressInfo

פרטי הכתובת של המשתמש.

שדות
given_name

string

חובה. השם (הפרטי) של המשתמש, באותיות קטנות, ללא סימני פיסוק, ללא רווחים מובילים או נגררים, ועבר גיבוב לפי תקן SHA-256.
family_name

string

חובה. שם המשפחה של המשתמש, באותיות קטנות בלבד, ללא סימני פיסוק, ללא רווחים מובילים או נגררים, ומגובב כ-SHA-256.
region_code

string

חובה. קוד האזור בן 2 האותיות לפי תקן ISO 3166-1 alpha-2 של כתובת המשתמש.
postal_code

string

חובה. המיקוד של הכתובת של המשתמש.
address_line

string

אופציונלי. הרחוב ומספר הבית של הכתובת של המשתמש. הפרמטר הזה משמש רק ל-Google Analytics. השדה הזה עובר גיבוב (hash) ויכול להיות שהוא מוצפן.

לנרמל את הערך לפני הגיבוב:

  • הסרת תווים של סמלים
  • המרה לאותיות קטנות
  • הסרת רווחים לבנים בתחילת הטקסט ובסופו
city

string

אופציונלי. העיר שמופיעה בכתובת של המשתמש. הפרמטר הזה משמש רק ל-Google Analytics.

הערך צריך להיות מנורמל באופן הבא:

  • הסרת תווים של סמלים
  • המרה לאותיות קטנות
  • הסרת רווחים לבנים בתחילת הטקסט ובסופו
administrative_area

string

אופציונלי. האזור המנהלי (מדינה או מחוז) של הכתובת של המשתמש. הפרמטר הזה משמש רק ל-Google Analytics.

הערך צריך להיות מנורמל באופן הבא:

  • הסרת תווים של סמלים
  • המרה לאותיות קטנות
  • הסרת רווחים לבנים בתחילת הטקסט ובסופו

טווח גילים

טווח הגילאים הדמוגרפי

טיפוסים בני מנייה (enum)
AGE_RANGE_UNSPECIFIED לא צוין.
AGE_RANGE_UNKNOWN לא ידוע.
AGE_RANGE_18_24 בגיל 18 עד 24.
AGE_RANGE_25_34 בגיל 25 עד 34.
AGE_RANGE_35_44 בגיל 35 עד 44.
AGE_RANGE_45_54 בגיל 45 עד 54.
AGE_RANGE_55_64 בגיל 55 עד 64.
AGE_RANGE_65_UP גיל 65 ומעלה.

AttributionHint

סטטוס השיוך שהשותף משייך לאירוע המודעה הזה.

טיפוסים בני מנייה (enum)
ATTRIBUTION_HINT_UNSPECIFIED סטטוס השיוך לא ידוע.
ATTRIBUTION_HINT_CONVERTED סטטוס ההמרה.
ATTRIBUTION_HINT_NOT_CONVERTED סטטוס לא הומר.

AudienceMember

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

שדות
destination_references[]

string

אופציונלי. הגדרת הDestination שאליו יועבר חבר הקהל.
consent

Consent

אופציונלי. הגדרת ההסכמה של המשתמש.
שדה איחוד data. סוג הנתונים המזהים שעליהם תתבצע הפעולה. הערך data יכול להיות רק אחד מהבאים:
user_data

UserData

פרטים שהמשתמשים סיפקו ומזהים את המשתמש.
pair_data

PairData

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

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

MobileData

נתונים שמזהים את המכשירים הניידים של המשתמש.
user_id_data

UserIdData

נתונים שקשורים למזהים ייחודיים של משתמש, כפי שהוגדרו על ידי המפרסם.
ppid_data

PpidData

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

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

CompositeData

קבוצה של כמה סוגי מזהים.
google_user_id_data

GoogleUserIdData

מזהי משתמשים מוצפנים ב-Google.
partner_provided_id_data

PartnerProvidedIdData

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

AwsWrappedKeyInfo

מפתח להצפנת נתונים (DEK) שעטוף במפתח AWS KMS.

שדות
key_type

KeyType

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

string

חובה. שם משאב Amazon של תפקיד IAM שצריך להניח כדי לקבל גישה לפענוח KMS. הפורמט הנדרש הוא arn:{partition}:iam::{account_id}:role/{role_name}
kek_uri

string

חובה. כתובת ה-URI של מפתח AWS KMS שמשמש לפענוח ה-DEK. הפורמט צריך להיות arn:{partition}:kms:{region}:{account_id}:key/{key_id} או aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id}
encrypted_dek

string

חובה. המפתח המוצפן להצפנת נתונים בקידוד Base64.

KeyType

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

טיפוסים בני מנייה (enum)
KEY_TYPE_UNSPECIFIED סוג המפתח לא צוין. אסור להשתמש בו אף פעם.
XCHACHA20_POLY1305 אלגוריתם XChaCha20-Poly1305

בסיס להשוואה

קריטריונים בסיסיים להשוואה של התובנות.

שדות
שדה איחוד baseline. מיקום בסיסי שאליו משווים את התובנות. הערך baseline יכול להיות רק אחד מהבאים:
baseline_location

Location

מיקום הבסיס של הבקשה. מיקום בסיסי הוא רשימת OR של האזורים המבוקשים.
location_auto_detection_enabled

bool

אם הערך מוגדר כ-True, השירות ינסה לזהות באופן אוטומטי את מיקום הבסיס לתובנות.

מיקום

מיקום הבסיס של הבקשה. מיקום בסיסי נמצא ברשימת OR של קודי אזור לפי תקן ISO 3166-1 alpha-2 של האזורים המבוקשים.

שדות
region_codes[]

string

רשימה של קודי אזורים לפי תקן ISO 3166-1 alpha-2.

CartData

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

שדות
merchant_id

string

אופציונלי. מספר חשבון Merchant Center שמשויך לפריטים.
merchant_feed_label

string

אופציונלי. תווית הפיד ב-Merchant Center שמשויכת לפיד הפריטים.
merchant_feed_language_code

string

אופציונלי. קוד השפה לפי תקן ISO 639-1 שמשויך לפיד ב-Merchant Center שאליו מועלים הפריטים.
transaction_discount

double

אופציונלי. סכום כל ההנחות שמשויכות לעסקה.
items[]

Item

אופציונלי. רשימת הפריטים שמשויכים לאירוע.
coupon_codes[]

string

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

אם האירוע מיועד ליעד ב-Google Analytics, צריך לספק רק קוד שובר אחד. מערכת Google Analytics מתעלמת מקודי שוברים נוספים.

CompositeData

נתונים מורכבים שכוללים מזהים ונתונים משויכים של משתמש. צריך להוסיף לפחות אחד מהמאפיינים user_data או ip_data.

שדות
user_data

UserData

אופציונלי. פרטים שהמשתמשים סיפקו ומזהים את המשתמש.
ip_data[]

IpData

אופציונלי. נתוני כתובות IP שמייצגים אינטראקציה של לקוחות, שמשמשים ליצירת הקהל.

הגדרות ההסכמה של המשתמש בהתאם ל-Digital Markets Act (חוק השווקים הדיגיטליים, DMA).

שדות
ad_user_data

ConsentStatus

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

ConsentStatus

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

ConsentStatus

מייצג את מצב ההסכמה של המשתמש: הסכמה, דחייה או לא צוינה הסכמה.

טיפוסים בני מנייה (enum)
CONSENT_STATUS_UNSPECIFIED לא צוין.
CONSENT_GRANTED ניתנה הרשאה.
CONSENT_DENIED נדחתה.

ContactIdInfo

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

שדות
match_rate_percentage

int32

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

DataSourceType

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

CoordinatorKeyInfo

מידע על מפתח התיאום.

שדות
key_id

string

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

CreatePartnerLinkRequest

בקשה ליצירת משאב PartnerLink. הפונקציה מחזירה PartnerLink.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
parent

string

חובה. ההורה, שהוא הבעלים של אוסף הקישורים לשותפים. פורמט: accountTypes/{account_type}/accounts/{account}

CreateUserListDirectLicenseRequest

בקשה ליצירת משאב UserListDirectLicense.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
parent

string

חובה. החשבון שהרשימה של המשתמשים שקיבלו רישיון משויכת אליו. הפורמט צריך להיות accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
user_list_direct_license

UserListDirectLicense

חובה. הרשימה של המשתמשים שקיבלו רישיון ישירות ליצירה.

CreateUserListGlobalLicenseRequest

בקשה ליצירת משאב UserListGlobalLicense.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
parent

string

חובה. החשבון שהרשימה של המשתמשים שקיבלו רישיון משויכת אליו. הפורמט צריך להיות accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
user_list_global_license

UserListGlobalLicense

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

CreateUserListRequest

הודעת בקשה ל-CreateUserList.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
parent

string

חובה. חשבון ההורה שבו תיצור רשימת המשתמשים הזו. פורמט: accountTypes/{account_type}/accounts/{account}
user_list

UserList

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

bool

אופציונלי. אם הערך הוא true, הבקשה מאומתת אבל לא מבוצעת.

CustomVariable

משתנה מותאם אישית להמרות ממודעות.

שדות
variable

string

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

string

אופציונלי. הערך שרוצים לאחסן עבור המשתנה המותאם אישית.
destination_references[]

string

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

CustomerType

סוג הלקוח שמשויך לאירוע.

טיפוסים בני מנייה (enum)
CUSTOMER_TYPE_UNSPECIFIED סוג הלקוח לא צוין. אסור להשתמש בו אף פעם.
NEW הלקוח חדש עבור המפרסם.
RETURNING הלקוח חוזר אל המפרסם.
REENGAGED הלקוח יצר אינטראקציה חוזרת עם המפרסם.

CustomerValueBucket

הערך של הלקוח לפי הערכת המפרסם.

טיפוסים בני מנייה (enum)
CUSTOMER_VALUE_BUCKET_UNSPECIFIED ‫Unspecified CustomerValueBucket. אסור להשתמש בו אף פעם.
LOW הלקוח הוא בעל ערך נמוך.
MEDIUM הלקוח הוא בעל ערך בינוני.
HIGH הלקוח רווחי.

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 הנתונים שהועלו הם נתונים של שותפים שהם צד שלישי.

DeletePartnerLinkRequest

בקשה למחיקה של משאב PartnerLink. הפונקציה מחזירה google.protobuf.Empty.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
name

string

חובה. שם המשאב של הקישור לשותף שרוצים למחוק. פורמט: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

DeleteUserListRequest

הודעת בקשה ל-DeleteUserList.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
name

string

חובה. השם של רשימת המשתמשים למחיקה. פורמט: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
validate_only

bool

אופציונלי. אם הערך הוא true, הבקשה מאומתת אבל לא מבוצעת.

יעד

מוצר Google שאליו אתם שולחים נתונים. לדוגמה, חשבון Google Ads.

שדות
reference

string

אופציונלי. מזהה של משאב Destination, ייחודי בבקשה. משמש להפניה אל Destination ב-IngestEventsRequest וב-IngestAudienceMembersRequest.
login_account

ProductAccount

אופציונלי. החשבון ששימש לביצוע הקריאה הזו ל-API. כדי להוסיף או להסיר נתונים מ-operating_account, ל-login_account צריכה להיות גישת כתיבה ל-operating_account. לדוגמה, חשבון ניהול של operating_account, או חשבון עם קישור מבוסס ל-operating_account.
linked_account

ProductAccount

אופציונלי. חשבון שלמשתמש שביצע את הקריאהlogin_account יש גישה אליו דרך קישור חשבון קיים. לדוגמה, יכול להיות שלשותף נתונים מסויםlogin_account יהיה גישה לlinked_account של לקוח מסוים. השותף עשוי להשתמש בשדה הזה כדי לשלוח נתונים מlinked_account אל operating_account אחר.
operating_account

ProductAccount

חובה. החשבון שאליו רוצים לשלוח את הנתונים או שממנו רוצים להסיר את הנתונים.
product_destination_id

string

אופציונלי. האובייקט בחשבון המוצרים שאליו רוצים להעביר את הנתונים. לדוגמה, מזהה קהל ב-Google Ads, מזהה קהל ב-Display & Video 360 או מזהה פעולת המרה ב-Google Ads.

השדה הזה הוא אופציונלי כשמייבאים אירועים מ-Google Ad Manager ומייבאים משתמשים. חובה לכל תרחישי השימוש האחרים.

DeviceInfo

מידע על המכשיר שבו נעשה שימוש (אם יש) בזמן שהאירוע קרה.

שדות
user_agent

string

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

string

אופציונלי. כתובת ה-IP של המכשיר בהקשר הנתון. חובה להשתמש בתג הזה בAdEvent לבדיקות גיאוגרפיות.
category

string

אופציונלי. קטגוריית המכשיר. לדוגמה, 'מחשב', 'טאבלט', 'נייד', 'טלוויזיה חכמה'.
language_code

string

אופציונלי. השפה שבה המכשיר משתמש בפורמט ISO 639-1.
screen_height

int32

אופציונלי. גובה המסך בפיקסלים.
screen_width

int32

אופציונלי. רוחב המסך בפיקסלים.
operating_system

string

אופציונלי. מערכת ההפעלה או הפלטפורמה של המכשיר.
operating_system_version

string

אופציונלי. הגרסה של מערכת ההפעלה או הפלטפורמה.
model

string

אופציונלי. הדגם של המכשיר.
brand

string

אופציונלי. המותג של המכשיר.
browser

string

אופציונלי. המותג או הסוג של הדפדפן.
browser_version

string

אופציונלי. גרסת הדפדפן.

קידוד

סוג הקידוד של הפרטים האישיים המזהים שעברו גיבוב.

טיפוסים בני מנייה (enum)
ENCODING_UNSPECIFIED סוג הקידוד לא צוין. אסור להשתמש בו אף פעם.
HEX קידוד הקסדצימלי.
BASE64 קידוד Base64.

EncryptedUserId

מזהה משתמש שמונפק לשימוש לצורך שיוך (Attribution). חובה למלא את כל השדות אם משתמשים בהם.

שדות
encrypted_id

string

חובה. המזהה המוצפן האלפאנומרי.
entity_type

EncryptionEntityType

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

int64

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

EncryptionSource

חובה. המימד מתאר אם קובץ ה-Cookie המוצפן התקבל מפרסום מודעות (פקודת המאקרו ‎ %m) או מ-Data Transfer.

EncryptionEntityType

סוג ישות ההצפנה.

טיפוסים בני מנייה (enum)
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED סוג ישות ההצפנה לא צוין.
CAMPAIGN_MANAGER_ACCOUNT חשבון Campaign Manager 360.
CAMPAIGN_MANAGER_ADVERTISER מפרסם ב-Campaign Manager 360.
DISPLAY_VIDEO_PARTNER שותף ב-Display & Video 360.
DISPLAY_VIDEO_ADVERTISER מפרסם ב-Display & Video 360.
GOOGLE_ADS_CUSTOMER לקוח Google Ads.
GOOGLE_AD_MANAGER_NETWORK_CODE קוד הרשת ב-Google Ad Manager.

EncryptionSource

מקור ההצפנה.

טיפוסים בני מנייה (enum)
ENCRYPTION_SOURCE_UNSPECIFIED מקור ההצפנה לא צוין.
AD_SERVING מקור ההצפנה של הצגת המודעות.
DATA_TRANSFER מקור ההצפנה של העברת הנתונים.

EncryptionInfo

מידע על ההצפנה של הנתונים שמועברים.

שדות
שדה איחוד wrapped_key. המפתח העטוף שמשמש להצפנת הנתונים. הערך wrapped_key יכול להיות רק אחד מהבאים:
gcp_wrapped_key_info

GcpWrappedKeyInfo

מידע על מפתח עטוף ב-Google Cloud Platform.
aws_wrapped_key_info

AwsWrappedKeyInfo

פרטי מפתח מוצפן של Amazon Web Services.
coordinator_key_info

CoordinatorKeyInfo

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

אין תמיכה בשיטה הזו ב-methods‏ IngestEvents, IngestAudienceMembers ו-RemoveAudienceMembers.

ErrorCount

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

שדות
record_count

int64

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

ProcessingErrorReason

סיבת השגיאה של הרשומות שנכשלו.

ErrorInfo

מספר השגיאות לכל סוג שגיאה.

שדות
error_counts[]

ErrorCount

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

ErrorReason

סיבות לשגיאות ב-Data Manager API. הערה: ה-enum הזה לא קבוע, ויכול להיות שבעתיד יתווספו אליו ערכים חדשים.

טיפוסים בני מנייה (enum)
ERROR_REASON_UNSPECIFIED אין להשתמש בערך ברירת המחדל הזה.
INTERNAL_ERROR אירעה שגיאה פנימית.
DEADLINE_EXCEEDED התגובה לבקשה נמשכה יותר מדי זמן.
RESOURCE_EXHAUSTED יותר מדי בקשות.
NOT_FOUND המשאב לא נמצא
PERMISSION_DENIED למשתמש אין הרשאה או שהמשאב לא נמצא.
INVALID_ARGUMENT הייתה בעיה בבקשה.
REQUIRED_FIELD_MISSING חסר שדה חובה.
INVALID_FORMAT הפורמט לא תקין.
INVALID_HEX_ENCODING הפורמט של הערך שמקודד לפי הקסדצימלי לא תקין.
INVALID_BASE64_ENCODING הפורמט של הערך שמקודד לפי base64 לא תקין.
INVALID_SHA256_FORMAT הפורמט של הערך שמקודד לפי האלגוריתם SHA256 לא תקין.
INVALID_POSTAL_CODE המיקוד לא חוקי.
INVALID_COUNTRY_CODE

הוצא משימוש: לא נעשה שימוש ב-Enum ב-Data Manager API.
INVALID_ENUM_VALUE אי אפשר להשתמש בערך enum.
INVALID_USER_LIST_TYPE הסוג של רשימת המשתמשים לא רלוונטי לבקשה הזו.
INVALID_AUDIENCE_MEMBER המשתמש הזה לא נכלל בקהל.
TOO_MANY_AUDIENCE_MEMBERS כל בקשה יכולה לכלול עד 10,000 חברים בקהל.
TOO_MANY_USER_IDENTIFIERS מספר מזהי המשתמשים המקסימלי שמותר לכלול בכל משתתף בקהל הוא 10.
TOO_MANY_DESTINATIONS מספר היעדים המקסימלי שמותר לכלול בכל בקשה הוא 10.
INVALID_DESTINATION היעד הזה לא תקין.
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED לשותף הנתונים אין גישה לרשימת המשתמשים שבבעלות חשבון ההפעלה.
INVALID_MOBILE_ID_FORMAT הפורמט של Mobile ID (mID) לא תקין.
INVALID_USER_LIST_ID רשימת המשתמשים לא תקינה.
MULTIPLE_DATA_TYPES_NOT_ALLOWED אסור להטמיע כמה סוגי נתונים בבקשה אחת.
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER בכל ההגדרות של היעד צריך להשתמש באותו חשבון התחברות, אם ההגדרות כוללות חשבון התחברות של DataPartner.
TERMS_AND_CONDITIONS_NOT_SIGNED לא אישרת את התנאים וההגבלות הנדרשים.
INVALID_NUMBER_FORMAT פורמט מספר לא חוקי.
INVALID_CONVERSION_ACTION_ID מזהה פעולת ההמרה לא תקין.
INVALID_CONVERSION_ACTION_TYPE סוג פעולת ההמרה לא תקין.
INVALID_CURRENCY_CODE קוד המטבע לא אפשרי.
INVALID_EVENT האירוע הזה לא תקין.
TOO_MANY_EVENTS מספר האירועים המקסימלי שמותר לכלול בכל בקשה הוא 10,000.
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS ההמרות המשופרות לצורך שיוך ללידים לא מופעלות בחשבון היעד.
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS אי אפשר להשתמש בהמרות משופרות בחשבון היעד בגלל המדיניות של Google בנושא נתוני לקוחות. אפשר לפנות לנציג Google.
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED בחשבון היעד לא אושרו התנאים לשימוש בהמרות משופרות.
DUPLICATE_DESTINATION_REFERENCE לפחות לשני יעדים בבקשה יש אותו הפניה.
UNSUPPORTED_OPERATING_ACCOUNT_FOR_DATA_PARTNER חשבון הפעלה שלא נתמך להרשאת שותף נתונים.
UNSUPPORTED_LINKED_ACCOUNT_FOR_DATA_PARTNER חשבון מקושר שלא נתמך להרשאה של שותף נתונים.
NO_IDENTIFIERS_PROVIDED נתוני האירועים לא מכילים מזהי משתמשים או מזהי פרסום. במקרה של העברה של אירועים מ-Floodlight, השגיאה הזו מציינת שהבקשות לא מכילות מזהי מודעות.
INVALID_PROPERTY_TYPE סוג הנכס לא נתמך.
INVALID_STREAM_TYPE אין תמיכה בסוג הסטרימינג.
LINKED_ACCOUNT_ONLY_ALLOWED_WITH_DATA_PARTNER_LOGIN_ACCOUNT קישור חשבון נתמך רק אם חשבון הכניסה הוא חשבון DATA_PARTNER.
OPERATING_ACCOUNT_LOGIN_ACCOUNT_MISMATCH חשבון הכניסה צריך להיות זהה לחשבון התפעול לתרחיש השימוש הנתון.
EVENT_TIME_INVALID האירוע לא התרחש בחלון הזמן המקובל.
RESERVED_NAME_USED הפרמטר משתמש בשם שמור.
INVALID_EVENT_NAME שם האירוע לא נתמך.
NOT_ALLOWLISTED החשבון לא נכלל ברשימת ההיתרים של התכונה הנתונה.
INVALID_REQUEST_ID מזהה הבקשה שמשמש לאחזור הסטטוס של בקשה לא תקין. אפשר לאחזר את הסטטוס רק של בקשות שהסתיימו בהצלחה ולא כוללות את validate_only=true.
MULTIPLE_DESTINATIONS_FOR_GOOGLE_ANALYTICS_EVENT לאירוע היו 2 יעדים או יותר ב-Google Analytics.
FIELD_VALUE_TOO_LONG הערך בשדה ארוך מדי.
FIELD_VALUE_TOO_SHORT הערך בשדה קצר מדי.
TOO_MANY_ELEMENTS יש יותר מדי רכיבים ברשימה בבקשה.
TOO_FEW_ELEMENTS מעט מדי רכיבים ברשימה בבקשה.
ALREADY_EXISTS המשאב כבר קיים.
IMMUTABLE_FIELD_FOR_UPDATE הייתה ניסיון להגדיר שדה שלא ניתן לשינוי בבקשת עדכון.
INVALID_RESOURCE_NAME שם המשאב לא תקין.
INVALID_FILTER מסנן השאילתה לא תקין.
INVALID_UPDATE_MASK מסכת העדכון לא תקינה.
INVALID_PAGE_TOKEN טוקן הדף לא תקין.
CANNOT_UPDATE_DISABLED_LICENSE אי אפשר לעדכן רישיון שהושבת.
CANNOT_CREATE_LICENSE_FOR_SENSITIVE_USERLIST אי אפשר להעניק רישיון ללקוח הזה לרשימות משתמשים רגישות.
INSUFFICIENT_COST העלות נמוכה מדי בשביל הרישיון הזה.
CANNOT_DISABLE_LICENSE אי אפשר להשבית את הרישיון של המפיץ כי הוא נמצא בשימוש.
INVALID_CLIENT_ACCOUNT_ID מזהה חשבון לקוח לא חוקי.
PRICING_ONLY_ZERO_COST_ALLOWED אסור להגדיר עלות שונה מאפס בחשבון הלקוח הזה.
PRICE_TOO_HIGH העלות גבוהה מדי בשביל הרישיון הזה.
CUSTOMER_NOT_ALLOWED_TO_CREATE_LICENSE ללקוח אין הרשאה ליצור רישיון.
INVALID_PRICING_END_DATE תאריך הסיום של התמחור לא תקין לרישיון הזה.
CANNOT_LICENSE_LOGICAL_LIST_WITH_LICENSED_OR_SHARED_SEGMENT אי אפשר להעניק רישיון לרשימת משתמשים לוגית עם פלח משותף או פלח עם רישיון.
MISMATCHED_ACCOUNT_TYPE סוג החשבון של לקוח בחשבון לקוח שצוין בבקשה לא תואם לסוג החשבון בפועל של הלקוח.
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_LICENSE_TYPE סוג הרישיון לא תומך בעלות שיתוף המדיה.
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_CLIENT_CUSTOMER סוג הלקוח לא תומך בשיתוף עלויות של מדיה.
INVALID_MEDIA_SHARE_COST עלות שיתוף המדיה לא חוקית.
INVALID_COST_TYPE סוג העלות לא תקין.
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_NON_COMMERCE_USER_LIST סוג UserList לא תומך בעלות שיתוף המדיה.
MAX_COST_NOT_ALLOWED אפשר להשתמש בעלות מקסימלית רק אם סוג העלות (cost_type) הוא MEDIA_SHARE.
COMMERCE_AUDIENCE_CAN_ONLY_BE_DIRECTLY_LICENSED אפשר לקבל רישיון לקהל מסחרי רק באופן ישיר.
INVALID_DESCRIPTION התיאור לא תקין.
INVALID_DISPLAY_NAME השם לתצוגה לא תקין.
DISPLAY_NAME_ALREADY_USED השם המוצג כבר נמצא בשימוש ברשימת משתמשים אחרת בחשבון.
OWNERSHIP_REQUIRED_FOR_UPDATE כדי לשנות את רשימת המשתמשים, צריך להיות בעלים של הרשימה.
USER_LIST_MUTATION_NOT_SUPPORTED סוג רשימת המשתמשים הוא לקריאה בלבד ואין תמיכה במוטציה.
SENSITIVE_USER_LIST_IMMUTABLE משתמשים חיצוניים לא יכולים לשנות רשימת משתמשים שרגישה לפרטיות או שנדחתה מסיבות משפטיות.
BILLABLE_RECORD_COUNT_IMMUTABLE אחרי שמגדירים את השדה של רשומת המשתמשים לחיוב ברשימת הרימרקטינג, אי אפשר לשנות אותו.
USER_LIST_NAME_RESERVED שם רשימת המשתמשים שמור לרשימות מערכת.
ADVERTISER_NOT_ALLOWLISTED_FOR_UPLOADED_DATA כדי להשתמש ברשימות רימרקטינג שנוצרו מנתונים שהמפרסם העלה, המפרסם צריך להיות ברשימת ההיתרים.
UNSUPPORTED_PARTNER_AUDIENCE_SOURCE מקור נתונים ליצירת קהלים של השותף לא אפשרי בסוג רשימת המשתמשים.
COMMERCE_PARTNER_NOT_ALLOWED אפשר להגדיר את השדה commerce_partner רק אם הערך של partner_audience_source הוא COMMERCE_AUDIENCE.
UNSUPPORTED_PARTNER_AUDIENCE_INFO אין תמיכה בשדה partner_audience_info בסוג רשימת המשתמשים.
PARTNER_MATCH_FOR_MANAGER_ACCOUNT_DISALLOWED אי אפשר ליצור רשימות משתמשים של התאמה לשותפים דרך חשבונות ניהול.
DATA_PARTNER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA שותף הנתונים לא נכלל ברשימת ההיתרים לשימוש ב-THIRD_PARTY_PARTNER_DATA.
ADVERTISER_TOS_NOT_ACCEPTED המפרסם לא אישר את התנאים וההגבלות של השותף.
ADVERTISER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA המפרסם לא נכלל ברשימת ההיתרים לשימוש ב-THIRD_PARTY_PARTNER_DATA.
USER_LIST_TYPE_NOT_SUPPORTED_FOR_ACCOUNT סוג רשימת המשתמשים הזה לא נתמך בחשבון הזה.
INVALID_COMMERCE_PARTNER השדה commerce_partner לא תקין.
CUSTOMER_NOT_ALLOWLISTED_FOR_COMMERCE_AUDIENCE ספק הנתונים לא נכלל ברשימת ההיתרים ליצירת קהלים למסחר.
UNSUPPORTED_USER_LIST_UPLOAD_KEY_TYPES אין תמיכה בסוגים של מפתחות להעלאת רשימות משתמשים.
UNSUPPORTED_INGESTED_USER_LIST_INFO_CONFIG אין תמיכה בהגדרת פרטי רשימת המשתמשים שמיובאים.
UNSUPPORTED_ACCOUNT_TYPES_FOR_USER_LIST_TYPE סוגי החשבונות לא אפשריים עבור סוג רשימת המשתמשים.
MEMBERSHIP_DURATION_TOO_LONG משך החברות ברשימת המשתמשים ארוך מדי.
INVALID_MERCHANT_ID השדה merchant_id לא תקין.
EU_POLITICAL_ADVERTISING_DECLARATION_REQUIRED בחשבון הלקוח יש קמפיינים שלא פטורים מהדרישה להצהרה לגבי פרסום שקשור לפוליטיקה באיחוד האירופי.
ACCOUNT_INELIGIBLE_FOR_STORE_SALES החשבון לא כשיר לשימוש ביעד 'מכירות בחנות הפיזית'.
INVALID_MERCHANT_FEED_LANGUAGE_CODE קוד השפה של פיד המוצרים של המוכר לא תקין.
INVALID_REGION_CODE קוד האזור לא תקין.
INVALID_SUBDIVISION_CODE קוד החלוקה לא תקין.
INVALID_SUBCONTINENT_CODE קוד תת-היבשת לא תקין.
INVALID_CONTINENT_CODE קוד היבשת לא תקין.
INVALID_DEVICE_CATEGORY קטגוריית המכשיר לא תקינה.
BOTH_CLIENT_ID_AND_APP_INSTANCE_ID_NOT_ALLOWED הערכים של app_instance_id ו-client_id מוגדרים.
GOOGLE_ANALYTICS_SUBPROPERTY_OR_ROLLUP_PROPERTY_NOT_ALLOWED הנכס ב-Google Analytics הוא נכס משנה או נכס-על.
THIRD_PARTY_USER_DATA_NOT_ALLOWED רק שותפי נתונים יכולים להגדיר נתוני משתמשים של צד שלישי.
INVALID_COUPON_CODE קוד השובר לא תקין.
EVENT_SOURCE_AND_DESTINATION_MISMATCH סוג מקור האירוע לא תואם לסוג היעד.
DESTINATION_ACCOUNT_TYPE_MISMATCH סוג חשבון היעד לא תואם למזהה החשבון שצוין.
CUSTOM_VARIABLE_VALUE_CONTAINS_PII הערך של המשתנה המותאם אישית מכיל פרטים אישיים מזהים (PII).
CUSTOM_VARIABLE_NOT_ENABLED המשתנה המותאם אישית לא מופעל.
INVALID_CUSTOM_VARIABLE_VALUE הערך של המשתנה המותאם אישית לא תקין.
CUSTOM_VARIABLE_NOT_FOUND בחשבון היעד לא קיים משתנה מותאם אישית עם שם שתואם לערך variable שצוין.
BASELINE_LOCATION_AUTO_DETECTION_FAILED השדה location_auto_detection_enabled של הבקשה הוגדר לערך true, אבל הזיהוי האוטומטי של מיקום הבסיס נכשל.
INSIGHTS_MISSING_FOR_DIMENSION חסרות תובנות לגבי המאפיין הזה.
INVALID_REMOVE_AS_OF_TIME התאריך והשעה של ההסרה צריכים להיות בעבר או בהווה. אי אפשר להשתמש בחותמות זמן עתידיות כדי להסיר חברים מקהל.
REQUEST_TOO_OLD סטטוס הבקשה זמין רק למשך כ-50 ימים אחרי שה-API מקבל בקשה.
CONVERSION_ACTION_TOO_RECENTLY_CREATED פעולת ההמרה נוצרה לפני זמן קצר מדי.

אירוע

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

שדות
destination_references[]

string

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

string

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

Timestamp

חובה. השעה שבה האירוע התרחש.
last_updated_timestamp

Timestamp

אופציונלי. הפעם האחרונה שבה האירוע עודכן.
user_data

UserData

אופציונלי. חלקים מפרטים שהמשתמשים סיפקו, שמייצגים את המשתמש שהאירוע משויך אליו.
consent

Consent

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

AdIdentifiers

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

string

אופציונלי. קוד המטבע שמשויך לכל הערכים הכספיים באירוע הזה.
event_source

EventSource

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

DeviceInfo

אופציונלי. מידע שנאסף על המכשיר שבו נעשה שימוש (אם בכלל) כשהאירוע קרה.
cart_data

CartData

אופציונלי. מידע על העסקה ועל הפריטים שמשויכים לאירוע.
custom_variables[]

CustomVariable

אופציונלי. מידע נוסף על זוגות של מפתח/ערך לשליחה למאגרי התגים של ההמרות (פעולת המרה או פעילות FL).
experimental_fields[]

ExperimentalField

אופציונלי. רשימה של צמדי מפתח/ערך לשדות ניסיוניים שעשויים בסופו של דבר להיכלל ב-API.
user_properties

UserProperties

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

string

אופציונלי. שם האירוע. חובה לאירועים ב-GA4.
client_id

string

אופציונלי. מזהה ייחודי של מופע המשתמש של לקוח אינטרנט במקור לנתוני האתר הזה ב-GA4.
user_id

string

אופציונלי. מזהה ייחודי של משתמש, כפי שהוגדר על ידי המפרסם.
additional_event_parameters[]

EventParameter

אופציונלי. מאגר של פרמטרים של אירועים שייכללו באירוע, שלא צוינו כבר באמצעות שדות מובנים אחרים.
third_party_user_data

UserData

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

EventLocation

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

string

אופציונלי. מזהה ייחודי של מופע המשתמש של לקוח האפליקציה במקור הנתונים הזה של האפליקציה ב-GA4.
conversion_value

double

אופציונלי. ערך ההמרה שמשויך לאירוע, להמרות מבוססות-ערך.
conversion_count

double

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

EventLocation

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

שדות
store_id

string

אופציונלי. חובה לדיווח על מכירות בחנות. המזהה שמייצג חנות פיזית שבה התרחש האירוע.
city

string

אופציונלי. שם העיר שבה התרחש האירוע.
subdivision_code

string

אופציונלי. קוד חלוקת המשנה לפי תקן ISO 3166-2 שבו התרחש האירוע.
region_code

string

אופציונלי. קוד האזור בן 2 האותיות במאגר CLDR שמופיע בכתובת של המשתמש.
subcontinent_code

string

אופציונלי. קוד תת-היבשת בפורמט UN M49 שבה התרחש האירוע.
continent_code

string

אופציונלי. קוד היבשת בפורמט UN M49 שבה התרחש האירוע.

EventParameter

פרמטר של אירוע לאירועים ב-GA4.

שדות
parameter_name

string

חובה. שם הפרמטר שבו רוצים להשתמש.
value

string

חובה. הייצוג של ערך הפרמטר שרוצים להגדיר כמחרוזת.

EventSource

מקור האירוע.

טיפוסים בני מנייה (enum)
EVENT_SOURCE_UNSPECIFIED מקור האירוע לא צוין. אסור להשתמש בו אף פעם.
WEB האירוע נוצר מדפדפן אינטרנט.
APP האירוע נוצר מאפליקציה.
IN_STORE האירוע נוצר מעסקה בחנות.
PHONE האירוע נוצר משיחה טלפונית.
MESSAGE האירוע נוצר מהודעה.
OTHER האירוע נוצר ממקורות אחרים.

ExperimentalField

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

שדות
field

string

אופציונלי. שם השדה שבו רוצים להשתמש.
value

string

אופציונלי. הערך של השדה שרוצים להגדיר.

FeatureSet

מערך התכונות הנתמכות בקישור שותף.

טיפוסים בני מנייה (enum)
FEATURE_SET_UNSPECIFIED מערך תכונות לא מוגדר. אם לא מצוין ערך, התנהגות המערכת היא FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT כברירת מחדל.
FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT מציין קישור שמשמש לניהול קהלים ואירועים.
FEATURE_SET_AD_EVENT_MANAGEMENT קישור שמשמש לניהול אירועים שקשורים למודעות.

FieldWarning

אזהרה מפורטת ברמת השורה עם נתיבי שדות.

שדות
reason

WarningReason

הסיבה לאזהרה.
description

string

הודעת האזהרה המפורטת שמתארת את הבעיה.
field

string

נתיב השדה שהפעיל את האזהרה. הפורמט זהה לזה של google.rpc.BadRequest.FieldViolation.field.

GcpWrappedKeyInfo

מידע על המפתח העוטף של Google Cloud Platform.

שדות
key_type

KeyType

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

string

חובה. הספק של מאגר הזהויות של כוח העבודה (Workload Identity) שנדרש לשימוש ב-KEK.
kek_uri

string

חובה. מזהה המשאב של Cloud Key Management Service ב-Google Cloud Platform. הפורמט צריך להיות projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key} או gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}
encrypted_dek

string

חובה. המפתח המוצפן להצפנת נתונים בקידוד Base64.

KeyType

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

טיפוסים בני מנייה (enum)
KEY_TYPE_UNSPECIFIED סוג המפתח לא צוין. אסור להשתמש בו אף פעם.
XCHACHA20_POLY1305 אלגוריתם XChaCha20-Poly1305

מגדר

סוג המגדר הדמוגרפי (לדוגמה, נקבה).

טיפוסים בני מנייה (enum)
GENDER_UNSPECIFIED לא צוין.
GENDER_UNKNOWN לא ידוע.
GENDER_MALE זכר.
GENDER_FEMALE נקבה.

GetUserListDirectLicenseRequest

בקשה לקבל משאב UserListDirectLicense.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
name

string

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

GetUserListGlobalLicenseRequest

בקשה לקבל משאב UserListGlobalLicense.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
name

string

חובה. שם המשאב של הרישיון הגלובלי לרשימת המשתמשים.

GetUserListRequest

הודעת הבקשה של GetUserList.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
name

string

חובה. שם המשאב של רשימת המשתמשים לאחזור. פורמט: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

GoogleUserIdData

נתונים של מזהי משתמשים ב-Google שמכילים מזהי משתמשים מוצפנים ב-Google. צריך לציין לפחות מזהה משתמש אחד ב-Google.

שדות
google_user_ids[]

string

חובה. רשימה של מזהי משתמשי Google מוצפנים.

IngestAdEventsRequest

בקשה להעלאת אירועים שקשורים למודעות.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
ad_events[]

AdEvent

חובה. חובה (לפחות 1). רשימה של אירועי מודעות.
encryption_info

EncryptionInfo

אופציונלי. מידע על מפתחות ההצפנה שמשמשים להצפנת הנתונים. חובה לציין את השדה הזה כשאירועים שקשורים למודעות מכילים את הערך UserData.
validate_only
(deprecated)

bool

אופציונלי. אם הערך הוא true, הבקשה מאומתת אבל לא מבוצעת.

IngestAdEventsResponse

בסוג הזה אין שדות.

תגובה מפעולת הטמעה של אירוע מודעה.

IngestAudienceMembersRequest

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

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
destinations[]

Destination

חובה. רשימת היעדים שאליהם יישלחו חברי הקהל.
audience_members[]

AudienceMember

חובה. רשימת המשתמשים שאליהם יישלחו היעדים שצוינו. אפשר לשלוח עד 10,000 משאבי AudienceMember בבקשה אחת.
consent

Consent

אופציונלי. הסכמה ברמת הבקשה תחול על כל המשתמשים בבקשה. הסכמה ברמת המשתמש מבטלת את ההסכמה ברמת הבקשה, ואפשר לציין אותה בכל AudienceMember.
validate_only

bool

אופציונלי. למטרות בדיקה. אם true, הבקשה מאומתת אבל לא מבוצעת. מוחזרות רק שגיאות, ולא תוצאות.
encoding

Encoding

אופציונלי. חובה לספק את הערך הזה להעלאות של קובצי UserData. סוג הקידוד של מזהי המשתמשים. במקרה של מזהי משתמש שעברו גיבוב, זהו סוג הקידוד של המחרוזת שעברה גיבוב. במקרה של מזהי משתמש מוצפנים עם גיבוב, זהו סוג הקידוד של המחרוזת החיצונית המוצפנת, אבל לא בהכרח של המחרוזת הפנימית עם הגיבוב. כלומר, המחרוזת הפנימית עם הגיבוב יכולה להיות מקודדת בצורה שונה מהמחרוזת החיצונית המוצפנת. אם לא מדובר בהעלאות של UserData, המערכת מתעלמת מהשדה הזה.
encryption_info

EncryptionInfo

אופציונלי. מידע על ההצפנה של העלאות ב-UserData. אם לא מוגדר, ההנחה היא שהפרטים האישיים המזהים שהועלו מגובבים אבל לא מוצפנים. אם לא מדובר בהעלאות של UserData, המערכת מתעלמת מהשדה הזה.
terms_of_service

TermsOfService

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

IngestAudienceMembersResponse

תגובה מIngestAudienceMembersRequest.

שדות
request_id

string

המזהה שנוצר אוטומטית של הבקשה.
field_warnings[]

FieldWarning

אזהרות מפורטות ברמת השורה עם נתיבי שדות.

IngestEventsRequest

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

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
destinations[]

Destination

חובה. רשימת היעדים שאליהם יישלחו האירועים.
events[]

Event

חובה. רשימת האירועים שיישלחו ליעדים שצוינו. אפשר לשלוח עד 2,000 משאבים מסוג Event בבקשה אחת.
consent

Consent

אופציונלי. הסכמה ברמת הבקשה תחול על כל המשתמשים בבקשה. הסכמה ברמת המשתמש מבטלת את ההסכמה ברמת הבקשה, ואפשר לציין אותה בכל Event.
validate_only

bool

אופציונלי. למטרות בדיקה. אם true, הבקשה מאומתת אבל לא מבוצעת. מוחזרות רק שגיאות, ולא תוצאות.
encoding

Encoding

אופציונלי. חובה לספק את הערך הזה להעלאות של קובצי UserData. סוג הקידוד של מזהי המשתמשים. במקרה של מזהי משתמש שעברו גיבוב, זהו סוג הקידוד של המחרוזת שעברה גיבוב. במקרה של מזהי משתמש מוצפנים עם גיבוב, זהו סוג הקידוד של המחרוזת החיצונית המוצפנת, אבל לא בהכרח של המחרוזת הפנימית עם הגיבוב. כלומר, המחרוזת הפנימית עם הגיבוב יכולה להיות מקודדת בצורה שונה מהמחרוזת החיצונית המוצפנת. אם לא מדובר בהעלאות של UserData, המערכת מתעלמת מהשדה הזה.
encryption_info

EncryptionInfo

אופציונלי. מידע על ההצפנה של העלאות ב-UserData. אם לא מוגדר, ההנחה היא שהפרטים האישיים המזהים שהועלו מגובבים אבל לא מוצפנים. אם לא מדובר בהעלאות של UserData, המערכת מתעלמת מהשדה הזה.

IngestEventsResponse

תגובה מIngestEventsRequest.

שדות
request_id

string

המזהה שנוצר אוטומטית של הבקשה.
field_warnings[]

FieldWarning

אזהרות מפורטות ברמת השורה עם נתיבי שדות.

IngestedUserListInfo

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

שדות
upload_key_types[]

UploadKeyType

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

ContactIdInfo

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

MobileIdInfo

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

UserIdInfo

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

PairIdInfo

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

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

PseudonymousIdInfo

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

PartnerAudienceInfo

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

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

UploadKeyType

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

טיפוסים בני מנייה (enum)
UPLOAD_KEY_TYPE_UNSPECIFIED לא צוין.
CONTACT_ID פרטי לקוחות כמו כתובת אימייל, מספר טלפון או כתובת פיזית.
MOBILE_ID מזהים לצורכי פרסום במובייל.
USER_ID מזהי משתמש שסופקו על ידי צד שלישי.
PAIR_ID מזהים של בעלי תוכן דיגיטלי שמשמשים לתיאום זהות המפרסם.
PSEUDONYMOUS_ID

מזהים של פלטפורמות לניהול נתונים:

  • מזהה משתמש Google
  • מזהה שסופק על ידי השותף
  • מזהה שניתן על ידי בעל התוכן הדיגיטלי (PPID)
  • מזהה למפרסמים ב-iOS‏ (IDFA)
  • מזהה הפרסום ב-Android
  • מזהה Roku
  • מזהה Amazon Fire TV
  • מזהה Xbox או מזהה Microsoft
  • מזהה מכשיר גנרי

IpData

מידע על כתובת ה-IP של משתמש. מומלץ לכלול את הפרמטרים observe_start_time ו-observe_end_time כדי לשפר את שיעורי ההתאמה של התאמה ללקוחות.

שדות
ip_address

string

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

Timestamp

אופציונלי. מועד האינטראקציה הראשון שתועד מכתובת ה-IP הזו בסשן.
observe_end_time

Timestamp

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

פריט

מייצג פריט בעגלת הקניות שמשויך לאירוע.

שדות
merchant_product_id

string

אופציונלי. מזהה המוצר בחשבון Merchant Center.
quantity

int64

אופציונלי. מספר הפריט שמשויך לאירוע.
unit_price

double

אופציונלי. המחיר ליחידה, לא כולל מס, משלוח והנחות ברמת העסקה.
item_id

string

אופציונלי. מזהה ייחודי שאפשר להשתמש בו כדי להתייחס לפריט.
additional_item_parameters[]

ItemParameter

אופציונלי. מאגר של פרמטרים של אירועים שקשורים לפריט שרוצים לכלול באירוע, שלא צוינו כבר באמצעות שדות מובנים אחרים.
merchant_id

string

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

string

אופציונלי. תווית הפיד של פיד Merchant Center. אם עדיין נעשה שימוש במדינות, אפשר להשתמש במקום זאת בקוד המדינה בן 2 האותיות לפי תקן ISO-3166-1 alpha-2. באירועים של מכירות בחנות פיזית, הערך הזה יבטל את הערך שהוגדר ברמת עגלת הקניות. המערכת מתעלמת מהשדה הזה באירועים אחרים.
merchant_feed_language_code

string

אופציונלי. קוד השפה לפי תקן ISO 639-1 שמשויך לפיד ב-Merchant Center שאליו מועלים הפריטים.
custom_variables[]

ItemCustomVariable

אופציונלי. מידע נוסף על צמדי מפתח/ערך לשליחה למאגרי התגים של ההמרות (פעולת המרה או פעילות ב-Floodlight), כשעוקבים אחרי המרות ברמת הפריט.
conversion_value

double

אופציונלי. ערך ההמרה שמשויך לפריט הזה באירוע, במקרים שבהם ערך ההמרה שונה לכל פריט.

ItemCustomVariable

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

שדות
variable

string

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

string

אופציונלי. הערך שרוצים לאחסן עבור המשתנה המותאם אישית.
destination_references[]

string

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

ItemParameter

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

שדות
parameter_name

string

חובה. שם הפרמטר שבו רוצים להשתמש.
value

string

חובה. הייצוג של ערך הפרמטר שרוצים להגדיר כמחרוזת.

ListUserListDirectLicensesRequest

בקשה להצגת רשימה של כל המשאבים של UserListDirectLicense בחשבון נתון.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
parent

string

חובה. החשבון שעבורו מתבצעת השאילתה לגבי הרישיונות. הפורמט צריך להיות accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
filter

string

אופציונלי. מחרוזת מסנן להחלה על בקשת הרשימה. כל השדות צריכים להיות בצד ימין של כל תנאי (לדוגמה: user_list_id = 123). צריך לציין את השדות באמצעות camel case או snake case. אל תשתמשו בשילוב של camel case ו-snake case.

פעולות נתמכות:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=

פונקציות נתמכות: – IN(field, value1, value2, ...): מחזירה true אם השדה תואם לאחד מהערכים. דוגמה: IN(user_list_id, 123, 456)

שדות שלא נתמכים:

  • ‫name (צריך להשתמש בשיטת get)
  • ‫historical_pricings וכל שדות המשנה שלו
  • pricing.start_time
  • pricing.end_time
page_size

int32

אופציונלי. המספר המקסימלי של רישיונות שיוחזרו בכל דף. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, המערכת תחזיר עד 50 רישיונות. הערך המקסימלי הוא 1,000. ערכים גבוהים יותר יומרו ל-1,000.
page_token

string

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של ListUserListDirectLicense. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-ListUserListDirectLicense חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.

ListUserListDirectLicensesResponse

תגובה מListUserListDirectLicensesRequest.

שדות
user_list_direct_licenses[]

UserListDirectLicense

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

string

טוקן שאפשר לשלוח כ-page_token כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

ListUserListGlobalLicenseCustomerInfosRequest

מבקשים לרשום את כל המשאבים של UserListGlobalLicenseCustomerInfo עבור רישיון גלובלי של רשימת משתמשים נתונה.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
parent

string

חובה. הרישיון הגלובלי שפרטי הלקוח שלו נשלחים לבקשה. הפורמט הנדרש הוא accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. כדי לכלול את כל פרטי הלקוחות של רישיון גלובלי בחשבון, מחליפים את מזהה הרישיון הגלובלי של רשימת המשתמשים בסימן '-' (לדוגמה, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)
filter

string

אופציונלי. מחרוזת מסנן להחלה על בקשת הרשימה. כל השדות צריכים להיות בצד ימין של כל תנאי (לדוגמה: user_list_id = 123). צריך לציין את השדות באמצעות camel case או snake case. אל תשתמשו בשילוב של camel case ו-snake case.

פעולות נתמכות:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=

פונקציות נתמכות: – IN(field, value1, value2, ...): מחזירה true אם השדה תואם לאחד מהערכים. דוגמה: IN(user_list_id, 123, 456)

שדות שלא נתמכים:

  • ‫name (צריך להשתמש בשיטת get)
  • ‫historical_pricings וכל שדות המשנה שלו
  • pricing.start_time
  • pricing.end_time
page_size

int32

אופציונלי. המספר המקסימלי של הרישיונות שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, המערכת תחזיר עד 50 רישיונות. הערך המקסימלי הוא 1,000. ערכים גבוהים יותר יומרו ל-1,000.
page_token

string

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של ListUserListDirectLicense. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-ListUserListDirectLicense חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.

ListUserListGlobalLicenseCustomerInfosResponse

תגובה מ- [ListUserListGlobalLicensesCustomerInfoRequest][google.ads.datamanager.v1.ListUserListGlobalLicensesCustomerInfoRequest].

שדות
user_list_global_license_customer_infos[]

UserListGlobalLicenseCustomerInfo

נתוני הלקוח של הרישיון שצוין בבקשה.
next_page_token

string

טוקן שאפשר לשלוח כ-page_token כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

ListUserListGlobalLicensesRequest

בקשה להצגת רשימה של כל המשאבים של UserListGlobalLicense בחשבון נתון.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
parent

string

חובה. החשבון שעבורו מתבצעת השאילתה לגבי הרישיונות. הפורמט צריך להיות accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
filter

string

אופציונלי. מחרוזת מסנן להחלה על בקשת הרשימה. כל השדות צריכים להיות בצד ימין של כל תנאי (לדוגמה: user_list_id = 123). צריך לציין את השדות באמצעות camel case או snake case. אל תשתמשו בשילוב של camel case ו-snake case.

פעולות נתמכות:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=

פונקציות נתמכות: – IN(field, value1, value2, ...): מחזירה true אם השדה תואם לאחד מהערכים. דוגמה: IN(user_list_id, 123, 456)

שדות שלא נתמכים:

  • ‫name (צריך להשתמש בשיטת get)
  • ‫historical_pricings וכל שדות המשנה שלו
  • pricing.start_time
  • pricing.end_time
page_size

int32

אופציונלי. המספר המקסימלי של הרישיונות שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, המערכת תחזיר עד 50 רישיונות. הערך המקסימלי הוא 1,000. ערכים גבוהים יותר יומרו ל-1,000.
page_token

string

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של ListUserListGlobalLicense. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-ListUserListDirectLicense חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.

ListUserListGlobalLicensesResponse

תגובה מListUserListGlobalLicensesRequest.

שדות
user_list_global_licenses[]

UserListGlobalLicense

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

string

טוקן שאפשר לשלוח כ-page_token כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

ListUserListsRequest

הודעת בקשה ל-ListUserLists.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
parent

string

חובה. חשבון ההורה שבבעלותו נמצאת קבוצת רשימות המשתמשים הזו. פורמט: accountTypes/{account_type}/accounts/{account}
page_size

int32

אופציונלי. מספר רשימות המשתמשים המקסימלי שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, המערכת תחזיר עד 50 רשימות משתמשים. הערך המקסימלי הוא 1,000. ערכים גבוהים יותר יומרו ל-1,000.
page_token

string

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של ListUserLists. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-ListUserLists חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.
filter

string

אופציונלי. מחרוזת סינון. כל השדות צריכים להיות בצד ימין של כל תנאי (לדוגמה: display_name = "list 1"). צריך לציין את השדות באמצעות camel case או snake case. אל תשתמשו בשילוב של camel case ו-snake case.

פעולות נתמכות:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • : (יש)

פונקציות נתמכות: – IN(field, value1, value2, ...): מחזירה true אם השדה תואם לאחד מהערכים. דוגמה: IN(display_name, "name1", "name2")

שדות נתמכים:

  • id
  • display_name
  • description
  • membership_status
  • integration_code
  • access_reason
  • ingested_user_list_info.upload_key_types

ListUserListsResponse

הודעת התגובה של ListUserLists.

שדות
user_lists[]

UserList

רשימות המשתמשים מהחשבון שצוין.
next_page_token

string

טוקן שאפשר לשלוח כ-page_token כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

MatchRateRange

טווח אחוז ההתאמה של ההעלאה או של רשימת המשתמשים.

טיפוסים בני מנייה (enum)
MATCH_RATE_RANGE_UNKNOWN טווח שיעור ההתאמה לא ידוע.
MATCH_RATE_RANGE_NOT_ELIGIBLE טווח שיעור ההתאמה לא כשירה.
MATCH_RATE_RANGE_LESS_THAN_20 טווח שיעור ההתאמה הוא פחות מ-20% (במרווח [0, 20)).
MATCH_RATE_RANGE_20_TO_30 טווח שיעור ההתאמה הוא בין 20% ל-30% (במרווח [20, 31)).
MATCH_RATE_RANGE_31_TO_40 טווח שיעור ההתאמה הוא בין 31% ל-40% (במרווח [31, 41)).
MATCH_RATE_RANGE_41_TO_50 טווח שיעור ההתאמה הוא בין 41% ל-50% (במרווח [41, 51)).
MATCH_RATE_RANGE_51_TO_60 טווח שיעור ההתאמה הוא בין 51% ל-60% (במרווח [51, 61).
MATCH_RATE_RANGE_61_TO_70 טווח שיעור ההתאמה הוא בין 61% ל-70% (במרווח [61, 71)).
MATCH_RATE_RANGE_71_TO_80 טווח שיעור ההתאמה הוא בין 71% ל-80% (במרווח [71, 81)).
MATCH_RATE_RANGE_81_TO_90 טווח שיעור ההתאמה הוא בין 81% ל-90% (במרווח [81, 91)).
MATCH_RATE_RANGE_91_TO_100

טווח שיעור ההתאמה הוא בין 91% ל-100% (במרווח [91, 100]).

MediaQuartile

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

טיפוסים בני מנייה (enum)
MEDIA_QUARTILE_UNSPECIFIED רבעון לא מוגדר של מדיה.
MEDIA_QUARTILE_START התחלה.
MEDIA_QUARTILE_FIRST_QUARTILE רבעון ראשון.
MEDIA_QUARTILE_MIDPOINT נקודת אמצע.
MEDIA_QUARTILE_THIRD_QUARTILE רבעון שלישי.
MEDIA_QUARTILE_COMPLETE הפעולה הושלמה.

MobileData

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

שדות
mobile_ids[]

string

חובה. רשימת מזהי מכשירים ניידים (מזהה פרסום ב-Android, מזהה IDFA ב-iOS לרשימות משתמשים מסוג 'התאמה ללקוחות', מזהה פרסום ב-Android, מזהה IDFA ב-iOS, מזהה Xbox או Microsoft, מזהה Amazon Fire TV, מזהה Roku, מזהה מכשיר כללי לרשימות משתמשים בסיסיות). אפשר לספק עד 10 mobileIds ב-AudienceMember אחד.

MobileIdInfo

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

שדות
data_source_type

DataSourceType

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

KeySpace

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

string

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

KeySpace

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

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

PairData

מזהי PAIR של הקהל. נדרש לפחות מזהה זוג אחד.

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

שדות
pair_ids[]

string

חובה. נתונים שמכילים פרטים אישיים מזהים (PII) שסופקו על ידי Cleanroom, עברו גיבוב באמצעות SHA256 והוצפנו באמצעות צופן קומוטטיבי של EC עם מפתח של בעל התוכן הדיגיטלי עבור רשימת המשתמשים PAIR. אפשר לספק עד 10 pairIds ב-AudienceMember אחד.

PairIdInfo

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

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

שדות
publisher_id

int64

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

string

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

int32

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

int64

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

string

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

PartnerAudienceInfo

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

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

שדות
partner_audience_source

PartnerAudienceSource

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

string

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

PartnerAudienceSource

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

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

PartnerCustomerAccount

מייצג חשבון לקוח במערכת של השותף.

שדות
account_id

string

חובה. המזהה של חשבון הלקוח במרחב המזהים של השותף.
account_name

string

אופציונלי. שם החשבון.
account_type

string

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

PartnerLinkMetadata

מייצג מטא-נתונים שמשויכים לקישור שותף.

שדות
implicit_accounts[]

PartnerCustomerAccount

אופציונלי. רשימת החשבונות המשתמעים.

PartnerProvidedIdData

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

שדות
partner_provided_ids[]

string

חובה. רשימת המזהים שסופקו על ידי השותף.

פלטפורמה

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

טיפוסים בני מנייה (enum)
PLATFORM_UNSPECIFIED פלטפורמה לא צוינה.
PLATFORM_IOS פלטפורמת iOS.
PLATFORM_ANDROID פלטפורמת Android.
PLATFORM_WEB פלטפורמה לאינטרנט.

PlatformType

סוג הפלטפורמה שבה הוצגה המודעה.

טיפוסים בני מנייה (enum)
PLATFORM_TYPE_UNSPECIFIED סוג הפלטפורמה לא צוין.
PLATFORM_TYPE_MOBILE פלטפורמה לנייד.
PLATFORM_TYPE_DESKTOP פלטפורמת מחשב.
PLATFORM_TYPE_CTV פלטפורמת CTV.
PLATFORM_TYPE_PHONE פלטפורמת טלפון.
PLATFORM_TYPE_TABLET פלטפורמת הטאבלט.

PpidData

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

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

שדות
ppids[]

string

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

ProcessingErrorReason

סיבת שגיאת העיבוד. יכול להיות שבעתיד נוסיף סיבות חדשות.

טיפוסים בני מנייה (enum)
PROCESSING_ERROR_REASON_UNSPECIFIED הסיבה לשגיאת העיבוד לא ידועה.
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE המשתנה המותאם אישית לא תקין.
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED הסטטוס של המשתנה המותאם אישית לא מוגדר כ'מופעל'.
PROCESSING_ERROR_REASON_EVENT_TOO_OLD ההמרה ישנה יותר מהגיל המקסימלי הנתמך.
PROCESSING_ERROR_REASON_DUPLICATE_GCLID כבר קיימת במערכת המרה עם אותו GCLID ואותו מועד המרה.
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID כבר העלית המרה עם שילוב זהה של מזהה הזמנה ופעולת המרה.
PROCESSING_ERROR_REASON_INVALID_GBRAID לא ניתן לפענח את ה-GBRAID.
PROCESSING_ERROR_REASON_INVALID_GCLID לא הצלחנו לפענח את מספר הקליק ב-Google.
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID מספר החשבון Merchant מכיל תווים שהם לא ספרות.
PROCESSING_ERROR_REASON_INVALID_WBRAID לא ניתן היה לפענח את ה-WBRAID.
PROCESSING_ERROR_REASON_INTERNAL_ERROR שגיאה פנימית.
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED התנאים של ההמרות המשופרות לא נחתמו בחשבון היעד.
PROCESSING_ERROR_REASON_INVALID_EVENT האירוע לא תקין.
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS מספר העסקאות התואמות נמוך מסף המינימום.
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS העסקאות נמוכות מהסף המינימלי.
PROCESSING_ERROR_REASON_INVALID_FORMAT יש שגיאת פורמט באירוע.
PROCESSING_ERROR_REASON_DECRYPTION_ERROR יש שגיאת פענוח באירוע.
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR פענוח המפתח להצפנת נתונים (DEK) נכשל.
PROCESSING_ERROR_REASON_INVALID_WIP ה-WIP לא בפורמט הנכון או שהוא לא קיים.
PROCESSING_ERROR_REASON_INVALID_KEK המפתח להצפנת מפתחות הצפנה (KEK) לא יכול לפענח נתונים כי הוא לא נכון או לא קיים.
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED אי אפשר להשתמש ב-WIP כי הוא נדחה בגלל תנאי האימות שלו.
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED למערכת לא היו ההרשאות שנדרשות כדי לגשת למפתח ה-KEK.
PROCESSING_ERROR_REASON_AWS_AUTH_FAILED המערכת לא הצליחה לבצע אימות מול AWS.
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR פענוח הנתונים של UserIdentifier באמצעות המפתח להצפנת נתונים (DEK) נכשל.
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER המשתמש ניסה להעביר אירועים עם מזהה פרסום שלא שייך למודעות של החשבון הפעיל.
PROCESSING_ERROR_REASON_ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID אי אפשר להשתמש בפרמטרים של BRAID עם פעולות המרה שמוגדרת להן שיטת הספירה 'המרה אחת לקליק'.
PROCESSING_ERROR_REASON_MATCH_ID_NOT_FOUND לא ניתן למצוא את מזהה המשחק.
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_MATCH_ID לא נמצא מזהה משתמש למזהה ההתאמה.
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_GCLID לא מצאנו את מזהה המשתמש שמשויך ל-GCLID.
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_DCLID לא ניתן למצוא את מזהה המשתמש עבור מזהה הקליק.
PROCESSING_ERROR_REASON_INVALID_AD_IDENTIFIERS יש מזהי מודעות לא תקינים.
PROCESSING_ERROR_REASON_INVALID_MOBILE_ID_FORMAT הפורמט של מזהה הנייד לא תקין.
PROCESSING_ERROR_REASON_ORIGINAL_CONVERSIONS_NOT_FOUND לא ניתן למצוא את ההמרות המקוריות.
PROCESSING_ERROR_REASON_EVENT_ID_DECODE_ERROR לא ניתן לפענח את מזהה האירוע (dclid או מזהה החשיפה).
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_IMPRESSION_ID לא ניתן למצוא את מזהה המשתמש עבור מזהה החשיפה שצוין.
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND לא ניתן למצוא את מזהה המשתמש.
PROCESSING_ERROR_REASON_CONVERSION_PRECEDES_CLICK חותמת הזמן של האירוע הייתה מוקדמת יותר מהקליק המשויך.
PROCESSING_ERROR_REASON_TOO_RECENT_CLICK הקליק התרחש לפני זמן קצר מדי.
PROCESSING_ERROR_REASON_INVALID_CLICK אי אפשר לשייך את האירוע לקליק (GCLID). יכול להיות שהקליק לא הגיע מקמפיין של Google Ads, למשל.
PROCESSING_ERROR_REASON_INVALID_OPERATING_ACCOUNT_FOR_CLICK הקליק מהאירוע לא משויך ל-operating_account של היעד.
PROCESSING_ERROR_REASON_CLICK_NOT_FOUND לא נמצא קליק תואם שמתאים למאפיינים שצוינו.
PROCESSING_ERROR_REASON_EXTERNAL_ATTRIBUTION_DATA_MISSING חסרים נתוני שיוך חיצוניים. אין תמיכה בשליחת אירועים ליעד עבור פעולת המרה של שיוך (Attribution) חיצוני.

ProcessingWarningReason

הסיבה לאזהרה לגבי העיבוד.

טיפוסים בני מנייה (enum)
PROCESSING_WARNING_REASON_UNSPECIFIED הסיבה לאזהרת העיבוד לא ידועה.
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED למערכת לא היו ההרשאות שנדרשות כדי לגשת למפתח ה-KEK.
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR פענוח המפתח להצפנת נתונים (DEK) נכשל.
PROCESSING_WARNING_REASON_DECRYPTION_ERROR יש שגיאת פענוח באירוע.
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED אי אפשר להשתמש ב-WIP כי הוא נדחה בגלל תנאי האימות שלו.
PROCESSING_WARNING_REASON_INVALID_WIP ה-WIP לא בפורמט הנכון או שהוא לא קיים.
PROCESSING_WARNING_REASON_INVALID_KEK המפתח להצפנת מפתחות הצפנה (KEK) לא יכול לפענח נתונים כי הוא לא נכון או לא קיים.
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR פענוח הנתונים של UserIdentifier באמצעות המפתח להצפנת נתונים (DEK) נכשל.
PROCESSING_WARNING_REASON_INTERNAL_ERROR שגיאה פנימית.
PROCESSING_WARNING_REASON_AWS_AUTH_FAILED המערכת לא הצליחה לבצע אימות מול AWS.

מוצר

הוצא משימוש. במקום זאת, אתם צריכים להשתמש ב-AccountType. מייצג מוצר ספציפי של Google.

טיפוסים בני מנייה (enum)
PRODUCT_UNSPECIFIED מוצר לא מזוהה. אסור להשתמש בו אף פעם.
GOOGLE_ADS Google Ads.
DISPLAY_VIDEO_PARTNER שותף ב-Display & Video 360.
DISPLAY_VIDEO_ADVERTISER מפרסם ב-Display & Video 360.
DATA_PARTNER שותף נתונים.

ProductAccount

מייצג חשבון ספציפי.

שדות
product
(deprecated)

Product

הוצא משימוש. במקום זאת, אתם צריכים להשתמש ב-account_type.
account_id

string

חובה. מזהה החשבון. לדוגמה, מספר החשבון ב-Google Ads.
account_type

AccountType

חובה. סוג החשבון. לדוגמה, GOOGLE_ADS. חובה לציין את account_type או את המאפיין product שיצא משימוש. אם שניהם מוגדרים, הערכים חייבים להיות זהים.

AccountType

מייצג סוגים של חשבונות Google. משמש לאיתור חשבונות ויעדים.

טיפוסים בני מנייה (enum)
ACCOUNT_TYPE_UNSPECIFIED מוצר לא מזוהה. אסור להשתמש בו אף פעם.
GOOGLE_ADS Google Ads.
DISPLAY_VIDEO_PARTNER שותף ב-Display & Video 360.
DISPLAY_VIDEO_ADVERTISER מפרסם ב-Display & Video 360.
DATA_PARTNER שותף נתונים.
GOOGLE_ANALYTICS_PROPERTY Google Analytics.
FLOODLIGHT_CONFIG הגדרת Floodlight.
GOOGLE_AD_MANAGER Google Ad Manager.

PseudonymousIdInfo

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

שדות
sync_status

SyncStatus

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

int64

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

SyncStatus

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

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

RemoveAllAudienceMembersRequest

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

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
destinations[]

Destination

חובה. רשימת היעדים שמהם רוצים להסיר את המשתמשים.
remove_as_of_time

Timestamp

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

bool

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

RemoveAllAudienceMembersResponse

תגובה מRemoveAllAudienceMembersRequest.

שדות
request_id

string

המזהה שנוצר אוטומטית של הבקשה.

RemoveAudienceMembersRequest

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

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
destinations[]

Destination

חובה. רשימת היעדים שמהם רוצים להסיר את המשתמשים.
audience_members[]

AudienceMember

חובה. רשימת המשתמשים להסרה.
validate_only

bool

אופציונלי. למטרות בדיקה. אם true, הבקשה מאומתת אבל לא מבוצעת. מוחזרות רק שגיאות, ולא תוצאות.
encoding

Encoding

אופציונלי. חובה לספק את הערך הזה להעלאות של קובצי UserData. סוג הקידוד של מזהי המשתמשים. ההגדרה חלה רק על הקידוד החיצוני של מזהי משתמשים מוצפנים. אם לא מדובר בהעלאות של UserData, המערכת מתעלמת מהשדה הזה.
encryption_info

EncryptionInfo

אופציונלי. מידע על ההצפנה של העלאות ב-UserData. אם לא מוגדר, ההנחה היא שהפרטים האישיים המזהים שהועלו מגובבים אבל לא מוצפנים. אם לא מדובר בהעלאות של UserData, המערכת מתעלמת מהשדה הזה.

RemoveAudienceMembersResponse

תגובה מRemoveAudienceMembersRequest.

שדות
request_id

string

המזהה שנוצר אוטומטית של הבקשה.

RequestStatusPerDestination

סטטוס בקשה לכל יעד.

שדות
destination

Destination

יעד בבקשת API של DM.
request_status

RequestStatus

סטטוס הבקשה של היעד.
error_info

ErrorInfo

שגיאה בפרטי השגיאה שמכילה את סיבת השגיאה ואת מספר השגיאות שקשורות להעלאה. השדה הזה מאוכלס רק אם הערך של request_status הוא FAILED או PARTIAL_SUCCESS. השדה הזה לא מאוכלס בזמן שהבקשה נמצאת במצב request_status מתוך PROCESSING.
warning_info

WarningInfo

מידע על אזהרה שכולל את הסיבה לאזהרה ואת מספר האזהרות שקשורות להעלאה. השדה הזה לא מאוכלס בזמן שהבקשה נמצאת במצב request_status מתוך PROCESSING.
שדה איחוד status. הסטטוס של היעד. הערך status יכול להיות רק אחד מהבאים:
audience_members_ingestion_status

IngestAudienceMembersStatus

הסטטוס של הבקשה להוספת חברים לקהל.
events_ingestion_status

IngestEventsStatus

הסטטוס של הבקשה להוספת אירועים.
audience_members_removal_status

RemoveAudienceMembersStatus

הסטטוס של הבקשה להסרת חברים מהקהל.
remove_all_audience_members_status

RemoveAllAudienceMembersStatus

הסטטוס של הבקשה להסרת כל חברי הקהל.

DataType

סוג הנתונים.

טיפוסים בני מנייה (enum)
DATA_TYPE_UNSPECIFIED סוג הנתונים לא צוין.
EMAIL הנתונים הם כתובת אימייל.
PHONE_NUMBER הנתונים הם מספר טלפון.
ADDRESS הנתונים הם כתובת פיזית.
IP_ADDRESS הנתונים הם כתובת IP.

DataTypeCount

הספירה של סוג נתונים ספציפי.

שדות
type

DataType

סוג הנתונים.
count

int64

הספירה של סוג הנתונים הזה.

IngestAudienceMembersStatus

הסטטוס של הבקשה להוספת חברים לקהל.

שדות
שדה איחוד status. הסטטוס של העברת החברים בקהל ליעד. הערך status יכול להיות רק אחד מהבאים:
user_data_ingestion_status

IngestUserDataStatus

הסטטוס של הטמעת נתוני המשתמש ביעד.
mobile_data_ingestion_status

IngestMobileDataStatus

הסטטוס של הטמעת נתונים ניידים ליעד.
pair_data_ingestion_status

IngestPairDataStatus

הסטטוס של הטמעת נתוני הצמד ביעד.
user_id_data_ingestion_status

IngestUserIdDataStatus

הסטטוס של הטמעת נתוני מזהה המשתמש ביעד.
ppid_data_ingestion_status

IngestPpidDataStatus

הסטטוס של הטמעת נתוני ה-PPID ביעד.
composite_data_ingestion_status

IngestCompositeDataStatus

הסטטוס של הטמעת הנתונים המורכבים ביעד.
google_user_id_data_ingestion_status

IngestGoogleUserIdDataStatus

הסטטוס של הטמעת נתוני מזהה המשתמש ב-Google ביעד.
partner_provided_id_data_ingestion_status

IngestPartnerProvidedIdDataStatus

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

IngestCompositeDataStatus

הסטטוס של הטמעת הנתונים המורכבים ביעד שמכיל נתונים סטטיסטיים שקשורים להטמעה.

שדות
record_count

int64

המספר הכולל של חברי הקהל שנשלח בבקשת ההעלאה ליעד. כולל את כל חברי הקהל בבקשה, בלי קשר לשאלה אם הם הוטמעו בהצלחה או לא.
data_type_counts[]

DataTypeCount

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

MatchRateRange

טווח אחוז הלקוחות לטירגוט בהעלאה.

IngestEventsStatus

הסטטוס של הטמעת האירועים ביעד.

שדות
record_count

int64

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

IngestGoogleUserIdDataStatus

הסטטוס של הטמעת נתוני מזהה המשתמש ב-Google ביעד שמכיל נתונים סטטיסטיים שקשורים להטמעה.

שדות
record_count

int64

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

int64

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

IngestMobileDataStatus

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

שדות
record_count

int64

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

int64

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

IngestPairDataStatus

הסטטוס של הטמעת נתוני הצמד ביעד, כולל נתונים סטטיסטיים שקשורים להטמעה.

שדות
record_count

int64

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

int64

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

IngestPartnerProvidedIdDataStatus

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

שדות
record_count

int64

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

int64

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

IngestPpidDataStatus

הסטטוס של הטמעת נתוני ה-PPID ביעד שמכיל נתונים סטטיסטיים שקשורים להטמעה.

שדות
record_count

int64

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

int64

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

IngestUserDataStatus

הסטטוס של הטמעת נתוני המשתמשים ביעד שמכיל נתונים סטטיסטיים שקשורים להטמעה.

שדות
record_count

int64

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

int64

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

MatchRateRange

טווח אחוז הלקוחות לטירגוט בהעלאה.

IngestUserIdDataStatus

הסטטוס של הטמעת נתוני מזהה המשתמש ביעד שמכיל נתונים סטטיסטיים שקשורים להטמעה.

שדות
record_count

int64

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

int64

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

RemoveAllAudienceMembersStatus

בסוג הזה אין שדות.

הסטטוס של הבקשה להסרת כל חברי הקהל.

RemoveAudienceMembersStatus

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

שדות
שדה איחוד status. הסטטוס של הסרת חברי הקהל מהיעד. הערך status יכול להיות רק אחד מהבאים:
user_data_removal_status

RemoveUserDataStatus

הסטטוס של הסרת נתוני המשתמש מיעד ההעברה.
mobile_data_removal_status

RemoveMobileDataStatus

הסטטוס של הסרת חבילת הגלישה מהיעד.
pair_data_removal_status

RemovePairDataStatus

הסטטוס של הסרת נתוני הזוג מהיעד.
user_id_data_removal_status

RemoveUserIdDataStatus

הסטטוס של הסרת נתוני ה-User-ID מיעד ההעברה.
ppid_data_removal_status

RemovePpidDataStatus

הסטטוס של הסרת נתוני ה-PPID מהיעד.
composite_data_removal_status

RemoveCompositeDataStatus

הסטטוס של הסרת הנתונים המורכבים מהיעד.
google_user_id_data_removal_status

RemoveGoogleUserIdDataStatus

הסטטוס של הסרת נתוני מזהה משתמש Google מהיעד.
partner_provided_id_data_removal_status

RemovePartnerProvidedIdDataStatus

הסטטוס של ההסרה של נתוני המזהה שסופקו על ידי השותף מיעד ההסרה.

RemoveCompositeDataStatus

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

שדות
record_count

int64

המספר הכולל של חברי הקהל שנשלח בבקשת ההסרה. כולל את כל חברי הקהל בבקשה, בלי קשר להצלחה או לכישלון בהסרתם.
data_type_counts[]

DataTypeCount

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

RemoveGoogleUserIdDataStatus

הסטטוס של הסרת נתוני מזהה משתמש Google מהיעד.

שדות
record_count

int64

המספר הכולל של חברי הקהל שנשלח בבקשת ההסרה. כולל את כל חברי הקהל בבקשה, בלי קשר להצלחה או לכישלון בהסרתם.
google_user_id_count

int64

המספר הכולל של מזהי משתמשים ב-Google שנשלחו בבקשת ההסרה. כולל את כל מזהי המשתמשים ב-Google בבקשה, בלי קשר לשאלה אם הם הוסרו בהצלחה או לא.

RemoveMobileDataStatus

הסטטוס של הסרת חבילת הגלישה מהיעד.

שדות
record_count

int64

המספר הכולל של חברי הקהל שנשלח בבקשת ההסרה. כולל את כל חברי הקהל בבקשה, בלי קשר להצלחה או לכישלון בהסרתם.
mobile_id_count

int64

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

RemovePairDataStatus

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

שדות
record_count

int64

המספר הכולל של חברי הקהל שנשלח בבקשת ההסרה. כולל את כל חברי הקהל בבקשה, בלי קשר להצלחה או לכישלון בהסרתם.
pair_id_count

int64

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

RemovePartnerProvidedIdDataStatus

הסטטוס של ההסרה של נתוני המזהה שסופקו על ידי השותף מיעד ההסרה.

שדות
record_count

int64

המספר הכולל של חברי הקהל שנשלח בבקשת ההסרה. כולל את כל חברי הקהל בבקשה, בלי קשר להצלחה או לכישלון בהסרתם.
partner_provided_id_count

int64

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

RemovePpidDataStatus

הסטטוס של הסרת נתוני ה-PPID מהיעד.

שדות
record_count

int64

המספר הכולל של חברי הקהל שנשלח בבקשת ההסרה. כולל את כל חברי הקהל בבקשה, בלי קשר להצלחה או לכישלון בהסרתם.
ppid_count

int64

המספר הכולל של מספרי PPID שנשלחו בבקשת ההסרה. כולל את כל מספרי ה-PPID בבקשה, גם אם הם הוסרו בהצלחה וגם אם לא.

RemoveUserDataStatus

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

שדות
record_count

int64

המספר הכולל של חברי הקהל שנשלח בבקשת ההסרה. כולל את כל חברי הקהל בבקשה, בלי קשר להצלחה או לכישלון בהסרתם.
user_identifier_count

int64

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

RemoveUserIdDataStatus

הסטטוס של הסרת נתוני ה-User-ID מיעד ההעברה.

שדות
record_count

int64

המספר הכולל של חברי הקהל שנשלח בבקשת ההסרה. כולל את כל חברי הקהל בבקשה, בלי קשר להצלחה או לכישלון בהסרתם.
user_id_count

int64

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

RequestStatus

סטטוס הבקשה.

טיפוסים בני מנייה (enum)
REQUEST_STATUS_UNKNOWN סטטוס הבקשה לא ידוע.
SUCCESS העיבוד של כל הרשומות הושלם בהצלחה ללא שגיאות. עם זאת, יכול להיות שיופיעו אזהרות בשדה warning_info.
PROCESSING הבקשה נמצאת בתהליך.
FAILED העיבוד נכשל לכל הרשומות. כדי לראות את פרטי השגיאה, בודקים את השדה error_info. כדי לראות את פרטי האזהרה, בודקים את השדה warning_info.
PARTIAL_SUCCESS העיבוד הושלם בהצלחה ללא שגיאות בחלק מהרשומות, אבל נכשל עם שגיאות ברשומות אחרות. כדי לראות את פרטי השגיאה, בודקים את השדה error_info. כדי לראות את פרטי האזהרה, בודקים את השדה warning_info.

RetrieveInsightsRequest

הודעת בקשה ל-API של DM MarketingDataInsightsService.RetrieveInsights

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
parent

string

חובה. חשבון ההורה שהרשימה משויכת אליו. פורמט: accountTypes/{account_type}/accounts/{account}
baseline

Baseline

חובה. קהל הבסיס להשוואה לתובנות המבוקשות.
user_list_id

string

חובה. מזהה רשימת המשתמשים שעבורה מתבקשות תובנות.

RetrieveInsightsResponse

הודעת תגובה ל-DM API MarketingDataInsightsService.RetrieveInsights

שדות
marketing_data_insights[]

MarketingDataInsight

מכיל את התובנות לגבי נתוני השיווק.

MarketingDataInsight

תובנות לגבי נתוני שיווק.

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

שדות
dimension

AudienceInsightsDimension

המאפיין שאליו שייכת התובנה.
attributes[]

MarketingDataInsightsAttribute

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

AudienceInsightsDimension

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

טיפוסים בני מנייה (enum)
AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED לא צוין.
AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN הערך לא ידוע בגרסה הזו.
AFFINITY_USER_INTEREST תחום עניין משותף של משתמש.
IN_MARKET_USER_INTEREST תחום עניין של משתמש עם כוונת רכישה.
AGE_RANGE טווח גילאים.
GENDER מגדר.

MarketingDataInsightsAttribute

תובנות לגבי אוסף של מאפיינים קשורים של אותו מאפיין.

שדות
user_interest_id

int64

מזהה תחום העניין של המשתמש.
lift

float

מדד העלייה שקהל היעד השיג בערך המאפיין בהשוואה לערך הבסיס. הטווח [0-1].
age_range

AgeRange

טווח הגילאים של הקהל שעבורו מוצגות נתוני העלייה.
gender

Gender

המגדר של הקהל שעבורו מסופקת העלייה.

RetrieveRequestStatusRequest

בקשה לקבלת הסטטוס של בקשה שנשלחה אל DM API עבור מזהה בקשה נתון. הפונקציה מחזירה RetrieveRequestStatusResponse.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
request_id

string

חובה. חובה. מזהה הבקשה של בקשת Data Manager API.

RetrieveRequestStatusResponse

תגובה מRetrieveRequestStatusRequest.

שדות
request_status_per_destination[]

RequestStatusPerDestination

רשימה של סטטוסי הבקשות לכל יעד. סדר הסטטוסים תואם לסדר היעדים בבקשה המקורית.

SearchPartnerLinksRequest

תבקש לחפש משאבים של PartnerLink. הפונקציה מחזירה SearchPartnerLinksResponse.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
parent

string

חובה. החשבון שבו רוצים לחפש קישורים לשותפים. אם לא מציינים filter, יוחזרו כל הקישורים לשותפים שבהם החשבון הזה הוא owning_account או partner_account.

פורמט: accountTypes/{account_type}/accounts/{account}
page_size

int32

מספר הקישורים המקסימלי לשותפים שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, יוחזרו עד 50 קישורים לשותפים. הערך המקסימלי הוא 100. ערכים גבוהים יותר יומרו ל-100.
page_token

string

טוקן של דף שהתקבל מקריאה קודמת של SearchPartnerLinks. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-SearchPartnerLinks חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.
filter

string

אופציונלי. מחרוזת סינון. כל השדות צריכים להיות בצד ימין של כל תנאי (לדוגמה: partner_link_id = 123456789). צריך לציין את השדות באמצעות camel case או snake case. אל תשתמשו בשילוב של camel case ו-snake case.

פעולות נתמכות:

  • AND
  • =
  • !=

שדות נתמכים:

  • partner_link_id
  • owning_account.account_type
  • owning_account.account_id
  • partner_account.account_type
  • partner_account.account_id
  • feature_set

בקישורים לשותפים עם קבוצת התכונות FEATURE_SET_AD_EVENT_MANAGEMENT, נתמכים גם השדות הבאים:

  • partner_customer_account.account_id
  • partner_link_metadata.implicit_accounts.account_id

לדוגמה: owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321

SearchPartnerLinksResponse

תגובה מSearchPartnerLinksRequest.

שדות
next_page_token

string

טוקן שאפשר לשלוח כ-page_token כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

SizeInfo

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

שדות
display_network_members_count

int64

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

int64

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

int64

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

int64

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

TargetNetworkInfo

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

שדות
eligible_for_display

bool

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

TargetingType

סוג הטירגוט ששימש להצגת המודעה.

טיפוסים בני מנייה (enum)
TARGETING_TYPE_UNSPECIFIED סוג הטירגוט לא צוין.
TARGETING_TYPE_AUDIENCE טירגוט לפי קהל.
TARGETING_TYPE_CONTEXTUAL טירגוט לפי הקשר.
TARGETING_TYPE_DEMOGRAPHIC טירגוט דמוגרפי.
TARGETING_TYPE_DEVICE טירגוט לפי מכשיר.
TARGETING_TYPE_GEO טירגוט גיאוגרפי.
TARGETING_TYPE_INTEREST טירגוט לפי תחומי עניין.
TARGETING_TYPE_PURCHASE_INTENT טירגוט לפי כוונת רכישה.
TARGETING_TYPE_REMARKETING טירגוט לרימרקטינג.

TermsOfService

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

שדות
customer_match_terms_of_service_status

TermsOfServiceStatus

אופציונלי. התנאים וההגבלות של התאמה ללקוחות: https://support.google.com/adspolicy/answer/6299717. צריך לאשר את התנאים האלה כשמבצעים המרה של UserData או MobileData. השדה הזה לא נדרש לרשימת משתמשים בתכונה 'התאמה לשותפים'.

TermsOfServiceStatus

מייצג את ההחלטה של המתקשר לאשר או לדחות את התנאים וההגבלות.

טיפוסים בני מנייה (enum)
TERMS_OF_SERVICE_STATUS_UNSPECIFIED לא צוין.
ACCEPTED סטטוס שמציין שהמתקשר בחר לאשר את התנאים וההגבלות.
REJECTED סטטוס שמציין שהמתקשר בחר לדחות את התנאים וההגבלות.

UpdateUserListDirectLicenseRequest

בקשה לעדכון משאב UserListDirectLicense.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
user_list_direct_license

UserListDirectLicense

חובה. השדה name של הרישיונות משמש לזיהוי הרישיון שרוצים לעדכן.
update_mask

FieldMask

אופציונלי. רשימת השדות לעדכון. התו המיוחד * לא נתמך, ואם משתמשים בו תוצג השגיאה INVALID_UPDATE_MASK.

UpdateUserListGlobalLicenseRequest

בקשה לעדכון משאב UserListGlobalLicense.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
user_list_global_license

UserListGlobalLicense

חובה. השדה name של הרישיונות משמש לזיהוי הרישיון שרוצים לעדכן.
update_mask

FieldMask

אופציונלי. רשימת השדות לעדכון. התו המיוחד * לא נתמך, ואם משתמשים בו תוצג השגיאה INVALID_UPDATE_MASK.

UpdateUserListRequest

הודעת בקשה ל-UpdateUserList.

אפשר לנסות את השיטה הזו ב-REST APIs explorer:
איך משתמשים ב-REST
שדות
user_list

UserList

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

השדה name ברשימת המשתמשים משמש לזיהוי רשימת המשתמשים שצריך לעדכן. פורמט: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
update_mask

FieldMask

אופציונלי. רשימת השדות לעדכון.
validate_only

bool

אופציונלי. אם הערך הוא true, הבקשה מאומתת אבל לא מבוצעת.

UserData

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

שדות
user_identifiers[]

UserIdentifier

חובה. המזהים של המשתמש. אפשר לספק כמה מופעים של אותו סוג נתונים (לדוגמה, כמה כתובות אימייל). כדי להגדיל את הסיכוי להתאמה, מומלץ לספק כמה שיותר מזהים. אפשר לספק עד 10 userIdentifiers ב-AudienceMember או ב-Event אחד.

UserIdData

נתוני User-ID שמכילים את מזהה המשתמש.

שדות
user_id

string

חובה. מזהה ייחודי של משתמש, כפי שהוגדר על ידי המפרסם.

UserIdInfo

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

שדות
data_source_type

DataSourceType

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

UserIdentifier

מזהה יחיד של המשתמש.

שדות
שדה איחוד identifier. חובה לציין בדיוק אחד מהם. הערך identifier יכול להיות רק אחד מהבאים:
email_address

string

כתובת אימייל שעברה גיבוב באמצעות פונקציית הגיבוב SHA-256 אחרי נרמול.
phone_number

string

מספר טלפון מגובב באמצעות פונקציית הגיבוב SHA-256 אחרי נירמול (תקן E164).
address

AddressInfo

הרכיבים הידועים של כתובת המשתמש. מכיל קיבוץ של מזהים שתואמים בבת אחת.

UserList

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

שדות
name

string

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

int64

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

bool

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

Duration

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

AccessReason

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

SizeInfo

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

TargetNetworkInfo

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

string

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

string

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

MembershipStatus

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

string

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

ClosingReason

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

AccessStatus

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

IngestedUserListInfo

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

AccessReason

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

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

AccessStatus

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

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

ClosingReason

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

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

MembershipStatus

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

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

UserListDirectLicense

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

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

שדות
name

string

מזהה. שם המשאב של הרישיון הישיר לרשימת המשתמשים.
user_list_display_name

string

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

השדה הזה הוא לקריאה בלבד.
client_account_display_name

string

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

השדה הזה הוא לקריאה בלבד.
pricing

UserListLicensePricing

אופציונלי. תמחור של UserListDirectLicense.
historical_pricings[]

UserListLicensePricing

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

השדה הזה הוא לקריאה בלבד.
metrics

UserListLicenseMetrics

פלט בלבד. מדדים שקשורים לרישיון הזה

השדה הזה הוא לקריאה בלבד והוא מתמלא רק אם תאריכי ההתחלה והסיום מוגדרים בקריאה ListUserListDirectLicenses
user_list_id

int64

אי אפשר לשנות. המזהה של רשימת המשתמשים שמוקצה לה רישיון.
client_account_type

UserListLicenseClientAccountType

אי אפשר לשנות. סוג החשבון של לקוח הקמפיין שאליו מוענקת הרשאה לשימוש ברשימת המשתמשים.
client_account_id

int64

אי אפשר לשנות. המזהה של לקוח הקמפיין שאליו מוענקת הרשאה לשימוש ברשימת המשתמשים.
status

UserListLicenseStatus

אופציונלי. הסטטוס של UserListDirectLicense – ENABLED או DISABLED.

UserListGlobalLicense

רישיון גלובלי לרשימת משתמשים.

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

שדות
name

string

מזהה. שם המשאב של הרישיון הגלובלי לרשימת המשתמשים.
user_list_display_name

string

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

השדה הזה הוא לקריאה בלבד.
pricing

UserListLicensePricing

אופציונלי. תמחור של UserListGlobalLicense.
historical_pricings[]

UserListLicensePricing

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

השדה הזה הוא לקריאה בלבד.
metrics

UserListLicenseMetrics

פלט בלבד. מדדים שקשורים לרישיון הזה

השדה הזה הוא לקריאה בלבד והוא מתמלא רק אם תאריכי ההתחלה והסיום מוגדרים בקריאה ListUserListGlobalLicenses
user_list_id

int64

אי אפשר לשנות. המזהה של רשימת המשתמשים שמוקצה לה רישיון.
license_type

UserListGlobalLicenseType

אי אפשר לשנות. סוג המוצר של לקוח הקצה שלרשימת המשתמשים מוענקת רישיון.
status

UserListLicenseStatus

אופציונלי. הסטטוס של UserListGlobalLicense – ENABLED או DISABLED.

UserListGlobalLicenseCustomerInfo

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

שדות
name

string

מזהה. שם המשאב של הלקוח עם רישיון גלובלי לרשימת משתמשים.
user_list_id

int64

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

string

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

UserListGlobalLicenseType

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

UserListLicenseStatus

פלט בלבד. הסטטוס של UserListDirectLicense – ENABLED או DISABLED.
pricing

UserListLicensePricing

פלט בלבד. תמחור של UserListDirectLicense.
client_account_type

UserListLicenseClientAccountType

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

int64

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

string

פלט בלבד. השם של הלקוח שאליו מוענקת הרשאה לשימוש ברשימת המשתמשים.
historical_pricings[]

UserListLicensePricing

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

UserListLicenseMetrics

פלט בלבד. מדדים שקשורים לרישיון הזה

השדה הזה מתמלא רק אם תאריכי ההתחלה והסיום מוגדרים בקריאה ListUserListGlobalLicenseCustomerInfos.

UserListGlobalLicenseType

סוגי רישיונות גלובליים של רשימות משתמשים.

טיפוסים בני מנייה (enum)
USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED UNSPECIFIED.
USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER רישיון למפיץ.
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE רישיון DataMart Sell Side.
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE רישיון DataMart Buy Side.

UserListLicenseClientAccountType

מוצר אפשרי של רישיון לרשימת משתמשים בחשבון לקוח.

טיפוסים בני מנייה (enum)
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN לא ידוע.
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS לקוח Google Ads.
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER שותף ב-Display & Video 360.
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER מפרסם ב-Display & Video 360.

UserListLicenseMetrics

מדדים שקשורים לרישיון של רשימת משתמשים.

שדות
click_count

int64

פלט בלבד. מספר הקליקים עבור רישיון רשימת המשתמשים.
impression_count

int64

פלט בלבד. מספר החשיפות של רישיון רשימת המשתמשים.
revenue_usd_micros

int64

פלט בלבד. ההכנסות מרישיון לרשימת משתמשים במיקרו-דולר ארה"ב.
start_date

int64

פלט בלבד. תאריך ההתחלה (כולל) של המדדים בפורמט YYYYMMDD. לדוגמה, 20260102 מייצג את התאריך 2 בינואר 2026. אם משתמשים ב-end_date במסנן, צריך להשתמש גם ב-start_date. אם אף אחד מהמסננים start_date ו-end_date לא נכלל במסנן, השדות UserListLicenseMetrics לא יאוכלסו בתגובה.
end_date

int64

פלט בלבד. תאריך הסיום (כולל) של המדדים בפורמט YYYYMMDD. לדוגמה, 20260102 מייצג את התאריך 2 בינואר 2026. אם משתמשים ב-start_date במסנן, צריך להשתמש גם ב-end_date. אם אף אחד מהמסננים start_date ו-end_date לא נכלל במסנן, השדות UserListLicenseMetrics לא יאוכלסו בתגובה.

UserListLicensePricing

תמחור רישיונות של רשימת משתמשים.

שדות
pricing_id

int64

פלט בלבד. המזהה של התמחור הזה.
start_time

Timestamp

פלט בלבד. שעת ההתחלה של התמחור.
end_time

Timestamp

אופציונלי. שעת הסיום של התמחור.
pricing_active

bool

פלט בלבד. האם התמחור הזה פעיל.
buyer_approval_state

UserListPricingBuyerApprovalState

פלט בלבד. סטטוס האישור של הקונה למחיר הזה.

השדה הזה הוא לקריאה בלבד.
cost_micros

int64

אופציונלי. העלות שמשויכת למודל, ביחידות מיקרו (‎10^-6), במטבע שצוין בשדה currency_code. לדוגמה, אם הערך של currency_code הוא USD, הערך 2000000 מייצג 2$.
currency_code

string

אופציונלי. המטבע שבו מצוינים העלות והערך של max_cost. קוד מטבע בן שלוש אותיות שמוגדר בתקן ISO 4217.
cost_type

UserListPricingCostType

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

אפשר להגדיר את הערך הזה רק בפעולה create. אי אפשר לעדכן רישיון קיים.
max_cost_micros

int64

אופציונלי. העלות המקסימלית לאלף חשיפות שניתן לחייב קהל מסחרי כשמשתמשים בסוג העלות MEDIA_SHARE. הערך הוא ביחידות מיקרו (‎10^-6) ובמטבע שצוין בשדה currency_code. לדוגמה, אם הערך של currency_code הוא USD, הערך 2000000 מייצג 2$.

המאפיין הזה רלוונטי רק אם הערך של cost_type הוא MEDIA_SHARE. אם הערך של cost_type הוא לא MEDIA_SHARE, והשדה הזה מוגדר, תוחזר השגיאה MAX_COST_NOT_ALLOWED. אם המדיניות לא מוגדרת או מוגדרת לערך0, אין הגבלה.

UserListPricingBuyerApprovalState

סטטוס האישור של הקונה לגבי תמחור רשימת משתמשים.

טיפוסים בני מנייה (enum)
USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED UNSPECIFIED.
PENDING הלקוח של רשימת המשתמשים עדיין לא אישר את תנאי התמחור שהוגדרו על ידי הבעלים של רשימת המשתמשים.
APPROVED הלקוח של רשימת המשתמשים אישר את תנאי התמחור שהוגדרו על ידי הבעלים של רשימת המשתמשים.
REJECTED הלקוח של רשימת המשתמשים דחה את תנאי התמחור שהוגדרו על ידי הבעלים של רשימת המשתמשים.

UserListPricingCostType

סוג העלות של תמחור רשימת משתמשים.

טיפוסים בני מנייה (enum)
USER_LIST_PRICING_COST_TYPE_UNSPECIFIED לא צוין.
CPC עלות לקליק.
CPM עלות לאלף חשיפות.
MEDIA_SHARE שיתוף מדיה.

UserListLicenseStatus

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

טיפוסים בני מנייה (enum)
USER_LIST_LICENSE_STATUS_UNSPECIFIED לא ידוע.
USER_LIST_LICENSE_STATUS_ENABLED סטטוס פעיל – הרישיון לרשימת המשתמשים עדיין בתוקף.
USER_LIST_LICENSE_STATUS_DISABLED סטטוס לא פעיל – רשימת המשתמשים כבר לא מורשית.

UserProperties

מידע שהמפרסם מעריך לגבי המשתמש בזמן שהאירוע התרחש. פרטים נוספים זמינים בכתובת https://support.google.com/google-ads/answer/14007601.

שדות
customer_type

CustomerType

אופציונלי. סוג הלקוח שמשויך לאירוע.
customer_value_bucket

CustomerValueBucket

אופציונלי. הערך של הלקוח לפי הערכת המפרסם.
additional_user_properties[]

UserProperty

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

UserProperty

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

שדות
property_name

string

חובה. השם של מאפיין המשתמש שבו רוצים להשתמש.
value

string

חובה. ייצוג המחרוזת של הערך של מאפיין המשתמש שבו רוצים להשתמש.

ViewType

סוג האירוע.

טיפוסים בני מנייה (enum)
VIEW_TYPE_UNSPECIFIED סוג התצוגה לא צוין.
VIEW_TYPE_MRC_VIEWED צפייה שאושרה על ידי MRC.
VIEW_TYPE_MRC_RENDERED הסרטון עבר עיבוד על ידי MRC.

ViewabilityInfo

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

שדות
view_type

ViewType

חובה. סוג האירוע.
viewable_percent

int32

אופציונלי. האחוז המספרי (0-100) של הפיקסלים שהיו ניתנים לצפייה.
viewable_duration

Duration

אופציונלי. משך הזמן שבו המודעה הייתה ניתנת לצפייה.
media_skippable

bool

אופציונלי. האם המדיה של המודעה הייתה ניתנת לדילוג או לא.
media_quartile

MediaQuartile

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

Duration

אופציונלי. משך הזמן של המדיה במודעה.
media_volume_percent

int32

אופציונלי. האחוז המספרי (0-100) של עוצמת הקול של הפעלת המדיה.
playback_duration

Duration

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

WarningCount

מספר האזהרות שקשורות לסיבת אזהרה מסוימת.

שדות
record_count

int64

מספר הרשומות שכוללות אזהרה.
reason

ProcessingWarningReason

הסיבה לאזהרה.

WarningInfo

מספר האזהרות לכל סוג אזהרה.

שדות
warning_counts[]

WarningCount

רשימה של אזהרות ומספרים לפי סיבת האזהרה.

WarningReason

סיבות לאזהרות לא חוסמות שמוחזרות במהלך ההעברה.

טיפוסים בני מנייה (enum)
WARNING_REASON_UNSPECIFIED הסיבה לאזהרה לא צוינה.
WARNING_REASON_CUSTOM_VARIABLE_NOT_ENABLED משתנה מותאם אישית ב-custom_variables לא מופעל בחשבון.
WARNING_REASON_CUSTOM_VARIABLE_NOT_PREDEFINED ערך של משתנה מותאם אישית ב-custom_variables לא נכלל בין הערכים המותרים שהוגדרו מראש למשתנה המותאם אישית בחשבון היעד.
WARNING_REASON_CART_DATA_NOT_SUPPORTED_WITH_GBRAID_OR_WBRAID אין תמיכה ב-cart_data ב-gbraid או ב-wbraid.
WARNING_REASON_CART_DATA_ITEM_MERCHANT_PRODUCT_ID_MISSING המאפיין merchant_product_id חסר בפריט בעגלת הקניות.
WARNING_REASON_CART_DATA_ITEM_UNIT_PRICE_MISSING המאפיין unit_price חסר בפריט בעגלת הקניות.
WARNING_REASON_GENERIC סיבת אזהרה כללית לבעיות שלא מתאימות לקטגוריות ספציפיות אחרות.
WARNING_REASON_INVALID_CLIENT_ID הערך של client_id לא תקין.
WARNING_REASON_INVALID_SUBDIVISION_CODE הערך של subdivision_code לא תקין.
WARNING_REASON_INVALID_REGION_CODE הערך של region_code לא תקין.
WARNING_REASON_INVALID_SUBCONTINENT_CODE הערך של subcontinent_code לא תקין.
WARNING_REASON_INVALID_CONTINENT_CODE הערך של continent_code לא תקין.
WARNING_REASON_INVALID_DEVICE_CATEGORY המכשיר category לא תקין.
WARNING_REASON_INVALID_DEVICE_SCREEN_RESOLUTION המכשיר screen_height או screen_width לא תקין.
WARNING_REASON_INVALID_MERCHANT_ID הערך של merchant_id לא תקין.