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

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

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

AudienceMember

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

שדות
destination_references[]

string

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

Consent

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

UserData

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

PairData

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

MobileData

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

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}
encrypted_dek

string

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

KeyType

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

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

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 נדחתה.

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 הלקוח רווחי.

יעד

מוצר 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 יש גישה אליו, באמצעות קישור חשבון קיים. לדוגמה, יכול להיות שלשותף נתונים מסוים יהיה גישה לlinked_account של לקוח מסוים.login_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

סיבות לשגיאות ב-API של המרכז לניהול נתונים.

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

אירוע

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

שדות
destination_references[]

string

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

string

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

Timestamp

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

Timestamp

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

UserData

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

Consent

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

AdIdentifiers

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

string

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

double

אופציונלי. ערך ההמרה שמשויך לאירוע, להמרות מבוססות-ערך.
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

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

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}‎'.
encrypted_dek

string

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

KeyType

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

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

IngestAudienceMembersRequest

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

אפשר לנסות את ה-method הזה ב-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.

אפשר לנסות את ה-method הזה ב-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

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

פריט

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

שדות
merchant_product_id

string

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

int64

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

double

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

string

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

ItemParameter

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

ItemParameter

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

שדות
parameter_name

string

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

string

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

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 אחד.

PairData

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

שדות
pair_ids[]

string

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

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.

RemoveAudienceMembersRequest

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

אפשר לנסות את ה-method הזה ב-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

יעד בבקשת DM API.
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

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

IngestEventsStatus

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

שדות
record_count

int64

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

IngestMobileDataStatus

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

שדות
record_count

int64

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

int64

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

IngestPairDataStatus

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

שדות
record_count

int64

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

int64

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

IngestUserDataStatus

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

שדות
record_count

int64

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

int64

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

MatchRateRange

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

RemoveAudienceMembersStatus

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

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

RemoveUserDataStatus

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

RemoveMobileDataStatus

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

RemovePairDataStatus

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

RemoveMobileDataStatus

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

שדות
record_count

int64

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

int64

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

RemovePairDataStatus

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

שדות
record_count

int64

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

int64

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

RemoveUserDataStatus

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

שדות
record_count

int64

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

int64

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

RequestStatus

סטטוס הבקשה.

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

RetrieveRequestStatusRequest

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

אפשר לנסות את ה-method הזה ב-REST APIs explorer:
לניסיון עם REST
שדות
request_id

string

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

RetrieveRequestStatusResponse

תגובה מRetrieveRequestStatusRequest.

שדות
request_status_per_destination[]

RequestStatusPerDestination

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

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

UserData

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

שדות
user_identifiers[]

UserIdentifier

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

UserIdentifier

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

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

string

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

string

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

AddressInfo

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

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

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