Method: projects.locations.dataStores.userEvents.purge

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

בקשת HTTP

POST https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:purge

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם המשאב של הקטלוג שבו נוצרים האירועים. הפורמט הוא projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "filter": string,
  "force": boolean
}
שדות
filter

string

חובה. מחרוזת הסינון שבה מציינים את האירועים שרוצים למחוק. אורך המחרוזת מוגבל ל-5,000 תווים. השדות שניתן לסנן הם:

  • ‫eventType: מחרוזת UserEvent.event_type במירכאות כפולות.
  • ‫eventTime: בפורמט ISO 8601 ‏'zulu'.
  • ‫userPseudoId: מחרוזת במירכאות כפולות. אם תציינו את זה, כל האירועים שמשויכים למבקר יימחקו.
  • ‫userId: מחרוזת במירכאות כפולות. אם תציינו את זה, כל האירועים שמשויכים למשתמש יימחקו.

הערה: ה-API הזה תומך רק במחיקה של טווח של עד 30 ימים.

דוגמאות:

  • מחיקת כל האירועים בטווח זמן: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
  • מחיקה של eventType ספציפי בטווח זמן: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
  • מחיקת כל האירועים של מבקר מסוים בטווח זמן מסוים: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
  • מחיקת אירועים מ-30 הימים האחרונים ב-DataStore: *

ההנחה היא ששדות הסינון כוללים AND משתמע.
force

boolean

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

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • discoveryengine.userEvents.purge

מידע נוסף מופיע במאמרי העזרה בנושא IAM.