Method: projects.locations.userEvents.write

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

בקשת HTTP

POST https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*}/userEvents:write

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

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

פרמטרים
parent

string

חובה. שם משאב האב. אם הפעולה 'כתיבת אירוע משתמש' מוחלת ברמה DataStore, הפורמט הוא: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. אם הפעולה 'כתיבת אירוע משתמש' מוחלת ברמה Location, למשל, האירוע עם Document בכמה DataStore, הפורמט הוא: projects/{project}/locations/{location}.

פרמטרים של שאילתה

פרמטרים
writeAsync

boolean

אם הערך הוא true, אירוע המשתמש נכתב באופן אסינכרוני אחרי האימות, וה-API מגיב בלי לחכות לכתיבה.

גוף הבקשה

גוף הבקשה מכיל מופע של UserEvent.

גוף התשובה

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

היקפי הרשאות

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

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