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

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

string

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

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

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

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

השדה לא יכול להכיל פרטים אישיים מזהים או נתוני משתמש. מומלץ להשתמש במזהה לקוח של 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. ה-sessionId צריך להיות ייחודי בין משתמשים, מומלץ להשתמש ב-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 כדי לקבל תוצאות טובות יותר של חיפוש, השלמה וחיזוי לכל ישות.

UserInfo

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

ייצוג JSON 
{
  "userId": string,
  "userAgent": string,
  "timeZone": string,
  "preciseLocation": {
    object (PreciseLocation)
  }
}
שדות
userId

string

מומלץ מאוד למשתמשים שמחוברים לחשבון. מזהה ייחודי של משתמש מחובר, כמו שם משתמש. לא להגדיר למשתמשים אנונימיים.

תמיד להשתמש בערך מגובב למזהה הזה.

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

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

מייצג מזהה אטום ל-Search API. ה-API של החיפוש לא מפרש את הערך בשום צורה. השדה הזה משמש לשיוך אירועים למשתמש בסשנים שונים, אם האירועים מועלים.
userAgent

string

סוכן משתמש כפי שהוא מופיע בכותרת ה-HTTP.

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

אין להגדיר את הפרמטר הזה כשמשתמשים בדיווח אירועים בצד הלקוח עם GTM או תג JavaScript ב-UserEventService.CollectUserEvent, או אם הפרמטר UserEvent.direct_user_request מוגדר.
timeZone

string

זה שינוי אופציונלי. אזור זמן בפורמט IANA, למשל Europe/Budapest.
preciseLocation

object (PreciseLocation)

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

PreciseLocation

פרטי מיקום מדויקים עם כמה אפשרויות ייצוג.

ייצוג JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "point": {
    object (LatLng)
  },
  "address": string
  // End of mutually exclusive fields.
}
שדות
בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה:
point

object (LatLng)

אופציונלי. מיקום שמיוצג על ידי נקודת קו רוחב/קו אורך.
address

string

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

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

ה-URI של Document - מותר רק עבור מאגרי נתוני אתרים.
סוף השדות הבלעדיים.
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
}
שדות
questionIndex

integer

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

string

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

object (Query)

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

string

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

string

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

FeedbackSource

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

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

Methods

collect

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

import

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

purge

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

write

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