Package google.ads.datamanager.v1

אינדקס

IngestionService

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

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
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. כדי להשבית רישיון, המתקשרים צריכים לעדכן את סטטוס הרישיון למושבת (DISABLED).

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

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. כדי להשבית רישיון, המתקשרים צריכים לעדכן את סטטוס הרישיון למושבת (DISABLED).

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

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

AdIdentifiers

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

שדות
session_attributes

string

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

string

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

string

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

string

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

DeviceInfo

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

AddressInfo

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

שדות
given_name

string

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

string

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

string

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

string

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

טווח גילים

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

טיפוסים בני מנייה (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 ומעלה.

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

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

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

AwsWrappedKeyInfo

מפתח להצפנת נתונים שעטוף במפתח 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

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

הגדרות ההסכמה של המשתמש בהתאם ל-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

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

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

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

ProductAccount

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

string

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

DeviceInfo

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

שדות
user_agent

string

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

string

אופציונלי. כתובת ה-IP של המכשיר בהקשר הנתון.

הערה: מערכת Google Ads לא תומכת בהתאמת כתובות IP של משתמשי קצה באזור הכלכלי האירופי (EEA), בבריטניה (UK) או בשווייץ (CH). אתם צריכים להוסיף לוגיקה כדי להחריג באופן מותנה שיתוף כתובות IP של משתמשים מהאזורים האלה. בנוסף, הקפידו לספק למשתמשים מידע ברור ומקיף על הנתונים שאתם אוספים באתרים, באפליקציות ובנכסים אחרים שלכם, ולקבל מהם הסכמה במקרים שבהם הדבר נדרש על פי חוק או על פי מדיניות רלוונטית של Google. פרטים נוספים זמינים במאמר מידע על ייבוא של נתוני המרות אופליין (OCI).

קידוד

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

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

EncryptionInfo

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

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

GcpWrappedKeyInfo

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

AwsWrappedKeyInfo

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

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 הפורמט של הערך שמקודד לפי HEX לא תקין.
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 הפורמט של מזהה הנייד לא תקין.
INVALID_USER_LIST_ID רשימת המשתמשים לא תקינה.
MULTIPLE_DATA_TYPES_NOT_ALLOWED אסור להטמיע כמה סוגי נתונים בבקשה אחת.
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER בכל ההגדרות של היעדים שכוללות חשבון התחברות של שותף נתונים, צריך להשתמש באותו חשבון התחברות.
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 נתוני האירועים לא מכילים מזהי משתמשים או מזהי פרסום.
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 ערך השדה ארוך מדי.
TOO_MANY_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 אי אפשר ליצור רשימות משתמשים של Partner Match דרך חשבונות ניהול.
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 בחשבון הלקוח יש קמפיינים שלא פטורים מהדרישה להצהרה לגבי פרסום שקשור לפוליטיקה באיחוד האירופי.

אירוע

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

שדות
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

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

double

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

EventParameter

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

שדות
parameter_name

string

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

string

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

EventSource

מקור האירוע.

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

ExperimentalField

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

שדות
field

string

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

string

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

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}

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

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

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

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

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 – מזהה שסופק על ידי שותף – מזהה שסופק על ידי בעל תוכן דיגיטלי – מזהה IDFA ב-iOS – מזהה פרסום ב-Android – מזהה Roku – מזהה Amazon Fire TV – מזהה Xbox או Microsoft

פריט

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

שדות
merchant_product_id

string

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

int64

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

double

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

string

אופציונלי. מזהה ייחודי לציון הפריט.
additional_item_parameters[]

ItemParameter

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

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
  • =
  • !=
  • >
  • >=
  • <
  • <=

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

  • ‫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
  • =
  • !=
  • >
  • >=
  • <
  • <=

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

  • ‫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
  • =
  • !=
  • >
  • >=
  • <
  • <=

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

  • ‫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
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • : (יש)

שדות נתמכים:

  • 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]).

MobileData

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

שדות
mobile_ids[]

string

חובה. הרשימה של מזהי המכשירים הניידים (מזהה פרסום/IDFA). אפשר לספק עד 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 מקור נתונים ליצירת קהלים של שותף הוא קהל מסוכנות או מספק.

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

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.

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 אירעה שגיאה בסנכרון התוכן ו/או המטא-נתונים של רשימת המשתמשים. אי אפשר להשתמש ברשימת המשתמשים.

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

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

WarningInfo

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

IngestAudienceMembersStatus

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

IngestEventsStatus

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

RemoveAudienceMembersStatus

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

IngestAudienceMembersStatus

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

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

IngestUserDataStatus

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

IngestMobileDataStatus

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

IngestPairDataStatus

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

IngestUserIdDataStatus

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

IngestPpidDataStatus

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

IngestEventsStatus

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

שדות
record_count

int64

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

IngestMobileDataStatus

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

שדות
record_count

int64

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

int64

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

IngestPairDataStatus

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

שדות
record_count

int64

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

int64

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

IngestPpidDataStatus

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

שדות
record_count

int64

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

int64

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

IngestUserDataStatus

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

שדות
record_count

int64

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

int64

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

MatchRateRange

טווח ההתאמה להגדרות של ההעלאה.

IngestUserIdDataStatus

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

שדות
record_count

int64

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

int64

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

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 מהיעד.

RemoveMobileDataStatus

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

שדות
record_count

int64

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

int64

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

RemovePairDataStatus

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

שדות
record_count

int64

המספר הכולל של חברי הקהל שנשלח בבקשת ההסרה. כל האנשים בקהל נכללים בבקשה, גם אם הם הוסרו בהצלחה וגם אם לא.
pair_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 הבקשה הצליחה.
PROCESSING הבקשה נמצאת בתהליך.
FAILED הבקשה נכשלה.
PARTIAL_SUCCESS הבקשה הצליחה באופן חלקי.

RetrieveInsightsRequest

הודעת בקשה ל-DM API 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

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

דוגמה: 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. אלה חברי הקהל שזמינים לטירגוט בקמפיינים לרשת החיפוש.

TargetNetworkInfo

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

שדות
eligible_for_display

bool

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

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. לדוגמה, הערך 2000000 מייצג 2 $אם currency_code הוא USD.
currency_code

string

אופציונלי. המטבע שבו מצוינות העלות והעלות המקסימלית. קוד מטבע בן 3 אותיות שמוגדר בתקן ISO 4217.
cost_type

UserListPricingCostType

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

אפשר להגדיר את הערך הזה רק בפעולה create. אי אפשר לעדכן רישיון קיים.
max_cost_micros

int64

אופציונלי. העלות המקסימלית לאלף חשיפות שקהל מסוג מסחר יכול לשלם כשמשתמשים בסוג העלות MEDIA_SHARE. הערך הוא ביחידות מיקרו (‎10^-6) ובמטבע שמצוין בשדה currency_code. לדוגמה, הערך 2000000 מייצג 2 $אם currency_code הוא USD.

המאפיין הזה רלוונטי רק כשהערך של 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

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

WarningCount

מספר האזהרות שקשורות לסיבת אזהרה מסוימת.

שדות
record_count

int64

מספר הרשומות שכוללות אזהרה.
reason

ProcessingWarningReason

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

WarningInfo

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

שדות
warning_counts[]

WarningCount

רשימה של אזהרות ומספרים לפי סיבת האזהרה.