REST Resource: projects.locations.dataStores.userEvents

משאב: UserEvent

האירוע UserEvent מתעד את כל נתוני המטא-נתונים ש-Discovery Engine API צריך לדעת על האינטראקציות של משתמשי הקצה עם האתר שלכם.

ייצוג ב-JSON 
{
  "eventType": string,
  "conversionType": string,
  "userPseudoId": string,
  "engine": string,
  "dataStore": string,
  "eventTime": string,
  "userInfo": {
    object (UserInfo)
  },
  "directUserRequest": boolean,
  "sessionId": string,
  "pageInfo": {
    object (PageInfo)
  },
  "attributionToken": string,
  "filter": string,
  "documents": [
    {
      object (DocumentInfo)
    }
  ],
  "panel": {
    object (PanelInfo)
  },
  "searchInfo": {
    object (SearchInfo)
  },
  "completionInfo": {
    object (CompletionInfo)
  },
  "transactionInfo": {
    object (TransactionInfo)
  },
  "tagIds": [
    string
  ],
  "promotionIds": [
    string
  ],
  "attributes": {
    string: {
      "text": [
        string
      ],
      "numbers": [
        number
      ]
    },
    ...
  },
  "mediaInfo": {
    object (MediaInfo)
  },
  "panels": [
    {
      object (PanelInfo)
    }
  ],
  "feedback": {
    object (Feedback)
  },
  "entity": string
}
שדות
eventType

string

חובה. סוג אירוע המשתמש. הערכים המותרים הם:

ערכים כלליים:

  • ‫search: חיפוש מסמכים.
  • ‫view-item: תצוגת דף מפורטת של מסמך.
  • ‫view-item-list: תצוגה של חלונית או רשימה מסודרת של מסמכים.
  • ‫view-home-page: צפייה בדף הבית.
  • ‫view-category-page: צפייה בדף קטגוריה, לדוגמה: דף הבית > גברים > ג'ינסים

ערכים שקשורים לקמעונאות:

  • ‫add-to-cart: הוספת פריטים לעגלת קניות, למשל בקניות קמעונאיות באינטרנט
  • ‫purchase: רכישת פריטים

ערכים שקשורים למדיה:

  • ‫media-play: הפעלה או המשך צפייה בסרטון, הפעלה של שיר וכו'.
  • ‫media-complete: צפייה בסרטון, האזנה לשיר וכו' שהסתיימו או שהופסקו באמצע.

ערך המרה מותאם אישית:

  • ‫conversion: אירוע המרה שהוגדר על ידי הלקוח.
conversionType

string

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

חובה אם הערך של UserEvent.event_type הוא conversion. זהו שם המרה שהוגדר על ידי הלקוח באותיות קטנות או במספרים שמופרדים באמצעות '-', כמו watch,‏ good-visit וכו'.

אם הערך של UserEvent.event_type הוא לא conversion, אל תגדירו את השדה. האירוע הזה משלב את אירוע ההמרה המותאם אישית עם אירועים מוגדרים מראש כמו search, ‏ view-item וכו'.
userPseudoId

string

חובה. מזהה ייחודי למעקב אחרי מבקרים.

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

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

השדה חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 128 תווים. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.

השדה לא יכול להכיל פרטים אישיים מזהים (PII) או נתוני משתמשים. מומלץ להשתמש במזהה לקוח של Google Analytics בשדה הזה.
engine

string

שם המשאב Engine, בפורמט projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}.

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

string

השם המלא של המשאב DataStore, בפורמט projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}.

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

string (Timestamp format)

נדרש רק לשיטת UserEventService.ImportUserEvents. חותמת הזמן של האירוע שקשור למשתמש.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
userInfo

object (UserInfo)

מידע על משתמש הקצה.
directUserRequest

boolean

צריך להגדיר את הערך כ-true אם הבקשה מגיעה ישירות ממשתמש הקצה. במקרה כזה, אפשר לאכלס את UserEvent.user_info.user_agent מתוך בקשת ה-HTTP.

צריך להגדיר את הדגל הזה רק אם בקשת ה-API מגיעה ישירות ממשתמש הקצה, למשל מאפליקציה לנייד (ולא אם שער או שרת מעבדים את אירועי המשתמש ושולחים אותם).

אין להגדיר את הערך הזה כשמשתמשים בתג JavaScript ב-UserEventService.CollectUserEvent.
sessionId

string

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

הנחיה כללית לאכלוס הערך sessionId:

  1. אם משתמש לא מבצע פעילות במשך 30 דקות, צריך להקצות לו sessionId חדש.
  2. מזהה הסשן צריך להיות ייחודי לכל המשתמשים. מומלץ להשתמש ב-UUID או להוסיף את הקידומת UserEvent.user_pseudo_id.
pageInfo

object (PageInfo)

מטא-נתונים של הדף, כמו קטגוריות ומידע חשוב אחר לסוגים מסוימים של אירועים, כמו view-category-page.
attributionToken

string

טוקן לשיוך תגובה מה-API לפעולות משתמש שהפעילו את האירוע.

מומלץ מאוד לאירועי משתמש שהם תוצאה של RecommendationService.Recommend. השדה הזה מאפשר שיוך מדויק של הביצועים של מודל ההמלצות.

הערך צריך להיות אחד מהערכים הבאים:

הטוקן הזה מאפשר לנו לשייך באופן מדויק את הצפייה בדף או את השלמת ההמרה בחזרה לאירוע ולתשובה הספציפית של התחזית שמכילה את המוצר הזה שנלחץ או נרכש. אם המשתמש לוחץ על מוצר K בתוצאות ההמלצות, צריך להעביר את הערך RecommendResponse.attribution_token כפרמטר של כתובת URL לדף של מוצר K. כשמתעדים אירועים בדף של מוצר K, צריך לרשום את הערך RecommendResponse.attribution_token בשדה הזה.
filter

string

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

לדוגמה, באירועים מסוג search, יכול להיות שהמאפיין המשויך SearchRequest יכיל ביטוי מסנן ב-SearchRequest.filter בהתאם ל-https://google.aip.dev/160#filtering.

באופן דומה, עבור אירועים מסוג view-item-list שנוצרים מ-RecommendRequest, יכול להיות שהשדה הזה יאוכלס ישירות מ-RecommendRequest.filter בהתאם ל-https://google.aip.dev/160#filtering.

הערך חייב להיות מחרוזת עם קידוד UTF-8, והאורך המקסימלי שלו הוא 1,000 תווים. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.
documents[]

object (DocumentInfo)

רשימה של Documents שמשויכים לאירוע המשתמש הזה.

השדה הזה הוא אופציונלי, למעט בסוגי האירועים הבאים:

  • view-item
  • add-to-cart
  • purchase
  • media-play
  • media-complete

באירוע search, השדה הזה מייצג את המסמכים שמוחזרים למשתמש הקצה בדף הנוכחי (יכול להיות שמשתמש הקצה עדיין לא סיים לעיין בכל הדף). כשדף חדש מוחזר למשתמש הקצה, אחרי חלוקה לדפים, סינון או מיון, גם אם מדובר באותה שאילתה, רצוי שיוחזר אירוע search חדש עם ערכי UserEvent.documents שונים.
panel

object (PanelInfo)

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

object (SearchInfo)

פרטים של SearchService.Search שקשורים לאירוע.

צריך להגדיר את השדה הזה לאירוע search.
completionInfo

object (CompletionInfo)

פרטים של CompletionService.CompleteQuery שקשורים לאירוע.

צריך להגדיר את השדה הזה לאירוע search כשהפונקציה להשלמה אוטומטית מופעלת והמשתמש לוחץ על הצעה לחיפוש.
transactionInfo

object (TransactionInfo)

המטא-נתונים של העסקה (אם יש) שמשויכים לאירוע המשתמש הזה.
tagIds[]

string

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

string

מזהי המבצעים אם מדובר באירוע שמשויך למבצעים. בשלב הזה, השדה הזה מוגבל למזהה אחד לכל היותר.
attributes

map (key: string, value: object)

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

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

השדה הזה צריך לעמוד בכל הקריטריונים הבאים, אחרת מוחזרת שגיאה INVALID_ARGUMENT:

  • המפתח צריך להיות מחרוזת בקידוד UTF-8, באורך של עד 5,000 תווים.
  • במאפייני טקסט, אפשר להזין עד 400 ערכים. אסור להשאיר שדות ריקים. כל ערך חייב להיות מחרוזת בקידוד UTF-8, באורך של עד 256 תווים.
  • במאפייני מספרים, אפשר להזין עד 400 ערכים.

לגבי המלצות למוצרים, דוגמה למידע נוסף על משתמשים היא traffic_channel, שמתארת איך משתמש מגיע לאתר. המשתמשים יכולים להגיע לאתר ישירות, דרך חיפוש Google או בדרכים אחרות.
attributes.text[]

string

הערכים הטקסטואליים של המאפיין המותאם אישית הזה. לדוגמה, ["yellow", "green"] אם המפתח הוא color.

אסור להשתמש במחרוזת ריקה. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.

צריך להגדיר בדיוק אחד מהערכים CustomAttribute.text או CustomAttribute.numbers. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.
attributes.numbers[]

number

הערכים המספריים של המאפיין המותאם אישית הזה. לדוגמה, [2.3, 15.4] כשהמפתח הוא lengths_cm.

צריך להגדיר בדיוק אחד מהערכים CustomAttribute.text או CustomAttribute.numbers. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.
mediaInfo

object (MediaInfo)

מידע ספציפי למדיה.
panels[]

object (PanelInfo)

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

object (Feedback)

זה שינוי אופציונלי. השדה הזה הוא אופציונלי, למעט סוגי האירועים add-feedback.
entity

string

זה שינוי אופציונלי. מייצג את הישות של לקוחות שעשויים להפעיל כמה ישויות, דומיינים, אתרים או אזורים שונים, למשל Google US, Google Ads, Waymo, google.com, youtube.com וכו'. מומלץ להגדיר את entity כדי לקבל תוצאות טובות יותר של חיפוש, השלמה וחיזוי לכל ישות.

PageInfo

מידע מפורט על הדף.

ייצוג ב-JSON 
{
  "pageviewId": string,
  "pageCategory": string,
  "uri": string,
  "referrerUri": string
}
שדות
pageviewId

string

מזהה ייחודי של צפייה בדף אינטרנט.

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

כשמשתמשים בדיווח על אירועים בצד הלקוח עם JavaScript Pixel ו-Google Tag Manager, הערך הזה מתעדכן אוטומטית.
pageCategory

string

הקטגוריה הספציפית ביותר שמשויכת לדף קטגוריה.

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

דפי קטגוריות כוללים דפים מיוחדים כמו מבצעים או קידומי מכירות. לדוגמה, דף מבצע מיוחד יכול לכלול את היררכיית הקטגוריות: "pageCategory" : "Sales > 2017 Black Friday Deals".

חובה לאירועים מסוג view-category-page. בשאר סוגי האירועים, אין להגדיר את השדה הזה. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.
uri

string

כתובת ה-URL המלאה (window.location.href) של הדף הנוכחי של המשתמש.

כשמשתמשים בדיווח על אירועים בצד הלקוח עם JavaScript Pixel ו-Google Tag Manager, הערך הזה מתעדכן אוטומטית. האורך המקסימלי הוא 5,000 תווים.
referrerUri

string

כתובת ה-URL המפנה של הדף הנוכחי.

כשמשתמשים בדיווח על אירועים בצד הלקוח עם JavaScript Pixel ו-Google Tag Manager, הערך הזה מתעדכן אוטומטית. עם זאת, יכול להיות שהשדה הזה יהיה ריק בגלל מגבלות פרטיות מסוימות בדפדפן.

DocumentInfo

מידע מפורט על מסמך שמשויך לאירוע של משתמש.

ייצוג ב-JSON 
{
  "promotionIds": [
    string
  ],
  "joined": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "id": string,
  "name": string,
  "uri": string
  // End of mutually exclusive fields.
  "quantity": integer,
  "conversionValue": number
}
שדות
promotionIds[]

string

מזהי המבצעים שמשויכים למסמך הזה. בשלב הזה, השדה הזה מוגבל למזהה אחד לכל היותר.
joined

boolean

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

תיאור חובה של Document המשויך.

  • אם מציינים את id, המערכת משתמשת בערכי ברירת המחדל של {location}, {collection_id}, {data_store_id} ו-{branch_id} כשמוסיפים הערות למסמך המאוחסן.

  • אם מציינים את name, הערכים שסופקו (מותרים ערכי ברירת מחדל) עבור {location},‏ {collection_id},‏ {data_store_id} ו-{branch_id} משמשים להוספת הערות באמצעות המסמך המאוחסן. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
id

string

מזהה המשאב Document.
name

string

השם המלא של משאב Document, בפורמט: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/branches/{branchId}/documents/{documentId}
uri

string

Document ה-URI – מותר רק למאגרי נתונים של אתרים.
סוף השדות הבלעדיים.
quantity

integer

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

לדוגמה, הערך בשדה הזה הוא 2 אם שני עותקים של אותו מסמך מעורבים באירוע add-to-cart.

חובה לאירועים מסוגי האירועים הבאים:

  • add-to-cart
  • purchase
conversionValue

number

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

לדוגמה, ערך של 1,000 מציין שמשתמש צפה במסמך במשך 1,000 שניות עבור watch סוג ההמרה.

PanelInfo

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

ייצוג ב-JSON 
{
  "panelId": string,
  "displayName": string,
  "documents": [
    {
      object (DocumentInfo)
    }
  ],
  "panelPosition": integer,
  "totalPanels": integer
}
שדות
panelId

string

חובה. מזהה הלוח.
displayName

string

השם המוצג של החלונית.
documents[]

object (DocumentInfo)

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

integer

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

integer

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

SearchInfo

מידע מפורט על החיפוש.

ייצוג ב-JSON 
{
  "searchQuery": string,
  "orderBy": string,
  "offset": integer
}
שדות
searchQuery

string

זה שינוי אופציונלי. שאילתת החיפוש של המשתמש.

הגדרה מופיעה בכתובת SearchRequest.query.

הערך חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 5,000 תווים. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.

צריך להגדיר לפחות אחד מהפרמטרים searchQuery או PageInfo.page_category לאירועים מסוג search. בשאר סוגי האירועים, אין להגדיר את השדה הזה. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.
orderBy

string

הסדר שבו המוצרים מוחזרים, אם רלוונטי.

הגדרה ותחביר מופיעים כאן: SearchRequest.order_by.

הערך חייב להיות מחרוזת עם קידוד UTF-8, והאורך המקסימלי שלו הוא 1,000 תווים. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.

אפשר להגדיר את זה רק לאירועים מסוג search. בשאר סוגי האירועים, אין להגדיר את השדה הזה. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.
offset

integer

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

הגדרה מופיעה בכתובת SearchRequest.offset.

אם הערך בשדה הזה שלילי, מוחזרת שגיאה INVALID_ARGUMENT.

אפשר להגדיר את זה רק לאירועים מסוג search. בשאר סוגי האירועים, אין להגדיר את השדה הזה. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.

CompletionInfo

פרטי השלמה מפורטים, כולל טוקן שיוך להשלמה ופרטי השלמה של קליקים.

ייצוג ב-JSON 
{
  "selectedSuggestion": string,
  "selectedPosition": integer
}
שדות
selectedSuggestion

string

זה שינוי אופציונלי. משתמש קצה נבחר CompleteQueryResponse.QuerySuggestion.suggestion.
selectedPosition

integer

המיקום שנבחר על ידי משתמש הקצה CompleteQueryResponse.QuerySuggestion.suggestion, החל מ-0.

TransactionInfo

עסקה מייצגת את כל עסקת הרכישה.

ייצוג ב-JSON 
{
  "currency": string,
  "transactionId": string,
  "value": number,
  "tax": number,
  "cost": number,
  "discountValue": number
}
שדות
currency

string

חובה. קוד מטבע. צריך להשתמש בקוד בן שלוש אותיות לפי תקן ISO-4217.
transactionId

string

מזהה הטרנזקציה, עם מגבלת אורך של 128 תווים.
value

number

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

number

כל המיסים שמשויכים לעסקה.
cost

number

כל העלויות שמשויכות למוצרים. העלויות האלה יכולות להיות עלויות ייצור, הוצאות משלוח שלא חלות על משתמש הקצה או כל עלות אחרת, כך ש:
discountValue

number

ערך ההנחות הכולל שחלות על העסקה הזו. הנתון הזה לא צריך להיכלל ב-TransactionInfo.value

לדוגמה, אם משתמש שילם סכום של TransactionInfo.value, הערך הנומינלי (לפני הנחה) של העסקה הוא הסכום של TransactionInfo.value ושל TransactionInfo.discount_value

המשמעות היא שהרווח מחושב באותו אופן, ללא קשר לערך ההנחה, ושהערך TransactionInfo.discount_value יכול להיות גדול מהערך TransactionInfo.value:

MediaInfo

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

ייצוג ב-JSON 
{
  "mediaProgressDuration": string,
  "mediaProgressPercentage": number
}
שדות
mediaProgressDuration

string (Duration format)

זמן ההתקדמות במדיה בשניות, אם רלוונטי. לדוגמה, אם משתמש הקצה סיים לצפות בסרטון באורך 90 שניות, הערך של MediaInfo.media_progress_duration.seconds צריך להיות 90.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. דוגמה: "3.5s".
mediaProgressPercentage

number

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

הערך צריך להיות בין [0, 1.0] (כולל).

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

משוב

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

ייצוג ב-JSON 
{
  "feedbackType": enum (FeedbackType),
  "reasons": [
    enum (Reason)
  ],
  "comment": string,
  "conversationInfo": {
    object (ConversationInfo)
  },
  "llmModelVersion": string,
  "feedbackSource": enum (FeedbackSource),
  "componentVersion": string,
  "dataTermsAccepted": boolean
}
שדות
feedbackType

enum (FeedbackType)

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

enum (Reason)

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

string

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

object (ConversationInfo)

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

string

גרסת מודל ה-LLM ששימשה ליצירת התשובה.
feedbackSource

enum (FeedbackSource)

זה שינוי אופציונלי. רכיב ממשק המשתמש שממנו מגיע משוב המשתמשים, שיכול להיות GOOGLE_CONSOLE,‏ GOOGLE_WIDGET או GOOGLE_WEBAPP.
componentVersion

string

זה שינוי אופציונלי. הגרסה של הרכיב שממנו נשלח הדוח הזה.
dataTermsAccepted

boolean

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

FeedbackType

סוג המשוב שהמשתמש נותן.

טיפוסים בני מנייה (enum)
FEEDBACK_TYPE_UNSPECIFIED סוג המשוב לא צוין.
LIKE המשתמש שולח משוב חיובי.
DISLIKE המשתמש שולח משוב שלילי.

סיבה

הסיבה לכך שהמשתמש נתן משוב שלילי.

טיפוסים בני מנייה (enum)
REASON_UNSPECIFIED סיבה לא מוגדרת.
INACCURATE_RESPONSE התשובה לא מדויקת.
NOT_RELEVANT התשובה לא רלוונטית.
INCOMPREHENSIVE התשובה לא מקיפה.
OFFENSIVE_OR_UNSAFE התשובה פוגענית או לא בטוחה.
FORMAT_AND_STYLES התשובה לא מעוצבת בצורה טובה.
BAD_CITATION התשובה לא קשורה לשאילתה.
CANVAS_NOT_GENERATED הקנבס הצפוי לא נוצר בתשובה.
CANVAS_QUALITY_BAD האיכות של הקנבס שנוצר נמוכה (למשל: לא מדויק, לא שלם, הפורמט לא טוב).
CANVAS_EXPORT_FAILED הייצוא של הלוח שנוצר נכשל (לדוגמה, ההורדה או פעולת הייצוא החיצונית לא הושלמו בהצלחה).

ConversationInfo

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

ייצוג ב-JSON 
{
  "questionIndex": integer,
  "session": string,
  "query": {
    object (Query)
  },
  "assistToken": string,
  "answerQueryToken": string,
  "taskName": string
}
שדות
questionIndex

integer

האינדקס של קלט המשתמש בהודעות בשיחה.
session

string

השם של הסשן החדש שנוצר או של הסשן שהמשכתם.
query

object (Query)

חובה. שאילתת החיפוש של המשתמש.
assistToken

string

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

string

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

string

זה שינוי אופציונלי. השם המלא של משאב המשימה של Sobi אם השיחה טופלה על ידי משימת סוכן ארוכת טווח. הפורמט: projects/{project}/locations/{location}/tasks/{taskId}

FeedbackSource

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

טיפוסים בני מנייה (enum)
FEEDBACK_SOURCE_UNSPECIFIED מקור משוב לא מוגדר.
GOOGLE_CONSOLE מקור המשוב הוא Google Console.
GOOGLE_WIDGET מקור המשוב הוא ווידג'ט חיפוש Google.
GOOGLE_WEBAPP מקור המשוב הוא אפליקציית אינטרנט של Google.
GOOGLE_AGENTSPACE_MOBILE מקור המשוב הוא אפליקציית Google AgentSpace לנייד.

Methods

collect

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

import

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

purge

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

write

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