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

בדף הזה מתוארים אירועי משתמשים באפליקציות Gemini Enterprise, כולל סוגי אירועי משתמשים, דרישות ודוגמאות לסוגי אירועי משתמשים.

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

אם אתם יוצרים את האפליקציה דרך מסוףGoogle Cloud , אתם לא צריכים לייבא באופן ידני אירועי משתמשים (ואתם לא צריכים לקרוא את הדף הזה).

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

סוגי אירועים של משתמשים

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

שם האירוע של המשתמש	פעולת המשתמש
view-item	צפייה בפרטים של מסמך.
search	חיפוש נתונים באפליקציית Gemini Enterprise.

לפרטים על אובייקט אירוע המשתמש, ראו [מאמרי העזרה של ה-API של UserEvent][user-event].

דוגמאות וסכימות של סוגי אירועי משתמשים

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

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

לפרטים נוספים על אובייקט אירוע המשתמש, קראו את [מאמרי העזרה של ה-API של UserEvent][user-event].

view-item

בהמשך מוצג פורמט נתוני האירוע של המשתמשים ב-view-item.

דרישות לאופטימיזציה של החיפוש לאירועי view-item

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

צריך להעלות אירועים לפחות פעם ביום, עם עיכוב של 24 שעות לכל היותר.

מדד האירועים	נפח/תדירות האירועים	תיאור
נפח של view-item אירועים	‫250 אלף צפיות בפריטים	כדי לבצע אופטימיזציה של חוויית החיפוש על סמך אירועים שהוטמעו, צריך לפחות 250,000 פריטים שנצפו.

האובייקט המינימלי הנדרש של view-item

בדוגמאות הבאות מוצגים רק שדות החובה של פורמט אירוע המשתמש view-item.

האובייקט documents מכיל את מזהה המסמך (id) ואת שם המשאב שלו (name).

• כשאתם מטמיעים או מתעדים אירועי משתמשים ברמת מאגר הנתונים, אתם יכולים לספק את מזהה המסמך (id) או את שם המשאב (name).
• כשמטמיעים או מתעדים אירועים ברמת המיקום, צריך לציין את שם המשאב של המסמך (name) כי הוא מציין את הנתיב המלא של המסמך ומתייחס למאגר הנתונים שבו המסמך נמצא. אפשר לספק את מזהה המסמך כמידע נוסף אופציונלי.

פיקסל JavaScript

var user_event = {
  "eventType": "view-item",
  "userPseudoId": "USER_PSEUDO_ID",
  "engine": "APP_ID",
  "eventTime": "2020-01-01T03:33:33.000001Z",
  "documents": [{
    "name": "DOCUMENT_NAME"
  }]
};

BigQuery

זוהי סכימת ה-JSON המלאה של סוג אירוע המשתמש הזה. צריך לציין את הסכימה הזו כשיוצרים טבלאות לסוג הזה של אירוע משתמש ב-BigQuery.

המצבים של שדות החובה מוגדרים כ-REQUIRED או כ-REPEATED. מצבים של שדות אופציונליים מוגדרים ל-NULLABLE.

שימו לב שצריך את eventTime כדי לייבא אירועים באמצעות BigQuery. ‫eventTime היא מחרוזת בפורמט של חותמת זמן.

[
  {
    "name": "eventType",
    "type": "STRING",
    "mode": "REQUIRED"
  },
  {
    "name": "userPseudoId",
    "type": "STRING",
    "mode": "REQUIRED"
  },
  {
    "name": "engine",
    "type": "STRING",
    "mode": "NULLABLE"
  },
  {
    "name": "eventTime",
    "type": "STRING",
    "mode": "REQUIRED"
  },
  {
    "name": "userInfo",
    "type": "RECORD",
    "mode": "NULLABLE",
    "fields": [
      {
        "name": "userId",
        "type": "STRING",
        "mode": "NULLABLE"
      },
      {
        "name": "userAgent",
        "type": "STRING",
        "mode": "NULLABLE"
      }
    ]
  },
  {
    "name": "pageInfo",
    "type": "RECORD",
    "mode": "NULLABLE",
    "fields": [
      {
        "name": "pageviewId",
        "type": "STRING",
        "mode": "NULLABLE"
      },
      {
        "name": "uri",
        "type": "STRING",
        "mode": "NULLABLE"
      },
      {
        "name": "referrerUri",
        "type": "STRING",
        "mode": "NULLABLE"
      }
    ]
  },
  {
    "name": "attributionToken",
    "type": "STRING",
    "mode": "NULLABLE"
  },
  {
    "name": "documents",
    "type": "RECORD",
    "mode": "REPEATED",
    "fields": [
      {
        "name": "id",
        "type": "STRING",
        "mode": "NULLABLE"
      }
    ]
  },
  {
    "name": "tagIds",
    "type": "STRING",
    "mode": "REPEATED"
  },
  {
    "name": "attributes",
    "type": "RECORD",
    "mode": "NULLABLE",
    "fields": [
      {
        "name": "example_text_attribute",
        "type": "RECORD",
        "mode": "NULLABLE",
        "fields": [
          {
            "name": "text",
            "type": "STRING",
            "mode": "REPEATED"
          }
        ]
      },
      {
        "name": "example_number_attribute",
        "type": "RECORD",
        "mode": "NULLABLE",
        "fields": [
          {
            "name": "numbers",
            "type": "NUMERIC",
            "mode": "REPEATED"
          }
        ]
      }
    ]
  }
]

דוגמה לאובייקט view-item מלא

הדוגמאות הבאות כוללות גם שדות חובה וגם שדות אופציונליים לאירוע המשתמש view-item.

פיקסל JavaScript

var user_event = {
  eventType: "view-item",
  userPseudoId: "visitor0",
  "engine": "APP_ID",
  eventTime: "2020-01-01T03:33:33.000001Z",
  userInfo: {
    userId: "[e-mail]",
    userAgent: "Mozilla/5.0",
  },
  pageInfo: {
    pageViewId: "currentPageUri",
    uri: "http://example",
    referrerUri: "https://google",
  },
  attributionToken: "abcd",
  documents: [
    {
      id: "abcd",
    },
  ],
  tagIds: ["Treatment_B"],
  attributes: {
    example_text_attribute: {
      text: ["text_1", "text_2"],
    },
    example_number_attribute: {
      numbers: [3.14, 42, 1.2345],
    },
  },
  panels: [
         {
           panelId: "HOME_RFY_1",
           documents: [
             {
               id: "123"
             },
             {
               id: "456"
             }
           ],
           panelPosition: 1,
           totalPanels: 2
         }
      ]
};

BigQuery

זוהי סכימת ה-JSON המלאה של סוג אירוע המשתמש הזה. צריך לציין את הסכימה הזו כשיוצרים טבלאות לסוג הזה של אירוע משתמש ב-BigQuery.

המצבים של שדות החובה מוגדרים כ-REQUIRED או כ-REPEATED. מצבים של שדות אופציונליים מוגדרים ל-NULLABLE.

שימו לב שצריך את eventTime כדי לייבא אירועים באמצעות BigQuery. ‫eventTime היא מחרוזת בפורמט של חותמת זמן.

[
  {
    "name": "eventType",
    "type": "STRING",
    "mode": "REQUIRED"
  },
  {
    "name": "userPseudoId",
    "type": "STRING",
    "mode": "REQUIRED"
  },
  {
    "name": "engine",
    "type": "STRING",
    "mode": "NULLABLE"
  },
  {
    "name": "eventTime",
    "type": "STRING",
    "mode": "REQUIRED"
  },
  {
    "name": "userInfo",
    "type": "RECORD",
    "mode": "NULLABLE",
    "fields": [
      {
        "name": "userId",
        "type": "STRING",
        "mode": "NULLABLE"
      },
      {
        "name": "userAgent",
        "type": "STRING",
        "mode": "NULLABLE"
      }
    ]
  },
  {
    "name": "pageInfo",
    "type": "RECORD",
    "mode": "NULLABLE",
    "fields": [
      {
        "name": "pageviewId",
        "type": "STRING",
        "mode": "NULLABLE"
      },
      {
        "name": "uri",
        "type": "STRING",
        "mode": "NULLABLE"
      },
      {
        "name": "referrerUri",
        "type": "STRING",
        "mode": "NULLABLE"
      }
    ]
  },
  {
    "name": "attributionToken",
    "type": "STRING",
    "mode": "NULLABLE"
  },
  {
    "name": "documents",
    "type": "RECORD",
    "mode": "REPEATED",
    "fields": [
      {
        "name": "id",
        "type": "STRING",
        "mode": "NULLABLE"
      }
    ]
  },
  {
    "name": "tagIds",
    "type": "STRING",
    "mode": "REPEATED"
  },
  {
    "name": "attributes",
    "type": "RECORD",
    "mode": "NULLABLE",
    "fields": [
      {
        "name": "example_text_attribute",
        "type": "RECORD",
        "mode": "NULLABLE",
        "fields": [
          {
            "name": "text",
            "type": "STRING",
            "mode": "REPEATED"
          }
        ]
      },
      {
        "name": "example_number_attribute",
        "type": "RECORD",
        "mode": "NULLABLE",
        "fields": [
          {
            "name": "numbers",
            "type": "NUMERIC",
            "mode": "REPEATED"
          }
        ]
      }
    ]
  }
]

search

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

דרישות לאופטימיזציה של אירועי חיפוש

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

צריך להעלות אירועים לפחות פעם ביום, עם עיכוב של 24 שעות לכל היותר.

מדד האירועים	נפח/תדירות האירועים	תיאור
נפח של search אירועים	‫100,000 חיפושים	צריך לפחות 100,000 חיפושים כדי לבצע אופטימיזציה של חוויית החיפוש על סמך האירועים שהוטמעו.

אובייקט החיפוש המינימלי הנדרש

בדוגמאות הבאות מוצגים רק שדות החובה של פורמט אירוע המשתמש search.

צריך לספק את searchQuery לאירועי חיפוש שבהם המשתמש הזין שאילתת טקסט.

הערך של attributionToken מוחזר עם תוצאות שאילתת החיפוש.

האובייקט documents מכיל את מזהה המסמך (id) ואת שם המשאב שלו (name).

• כשאתם מטמיעים או מתעדים אירועי משתמשים ברמת מאגר הנתונים, אתם יכולים לספק את מזהה המסמך (id) או את שם המשאב (name).
• כשמטמיעים או מתעדים אירועים ברמת המיקום, צריך לציין את שם המשאב של המסמך (name) כי הוא מציין את הנתיב המלא של המסמך ומתייחס למאגר הנתונים שבו המסמך נמצא. אפשר לספק את מזהה המסמך כמידע נוסף אופציונלי.

פיקסל JavaScript

var user_event = {
  "eventType": "search",
  "userPseudoId": "USER_PSEUDO_ID",
  "engine": "APP_ID",
  "eventTime": "2020-01-01T03:33:33.000001Z",
  "searchInfo": {
    "searchQuery": "SEARCH_QUERY",
  }, 
  "attributionToken": "ATTRIBUTION_TOKEN",
  "documents": [
    {
      "name": "DOCUMENT_NAME_1",
    },
    {
      "name": "DOCUMENT_NAME_2",
    },
  ]
};

BigQuery

זוהי סכימת ה-JSON המלאה של סוג אירוע המשתמש הזה. צריך לציין את הסכימה הזו כשיוצרים טבלאות לסוג הזה של אירוע משתמש ב-BigQuery.

המצבים של שדות החובה מוגדרים כ-REQUIRED או כ-REPEATED. מצבים של שדות אופציונליים מוגדרים ל-NULLABLE.

שימו לב שצריך את eventTime כדי לייבא אירועים באמצעות BigQuery. ‫eventTime היא מחרוזת בפורמט של חותמת זמן.

[
  {
    "name": "eventType",
    "type": "STRING",
    "mode": "REQUIRED"
  },
  {
    "name": "userPseudoId",
    "type": "STRING",
    "mode": "REQUIRED"
  },
  {
    "name": "engine",
    "type": "STRING",
    "mode": "NULLABLE"
  },
  {
    "name": "eventTime",
    "type": "STRING",
    "mode": "REQUIRED"
  },
  {
    "name": "searchInfo",
    "type": "RECORD",
    "mode": "NULLABLE",
    "fields": [
      {
        "name": "searchQuery",
        "type": "STRING",
        "mode": "NULLABLE"
      }
    ]
  },
  {
    "name": "pageInfo",
    "type": "RECORD",
    "mode": "NULLABLE",
    "fields": [
      {
        "name": "pageCategory",
        "type": "STRING",
        "mode": "NULLABLE"
      }
    ]
  },
  {
    "name": "attributionToken",
    "type": "STRING",
    "mode": "NULLABLE"
  },
  {
    "name": "documents",
    "type": "RECORD",
    "mode": "REPEATED",
    "fields": [
      {
        "name": "id",
        "type": "STRING",
        "mode": "NULLABLE"
      }
    ]
  }
]

מידע על פרטי המשתמשים

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

פרטי המשתמש ([UserInfo][user-info]) שנכללים כשמתעדים אירוע משתמש מכילים את הערך userPseudoId, ואם הוא זמין, גם את הערך userId. userId הוא אופציונלי, ואפשר להשתמש בו כמזהה ייחודי וקבוע של משתמש במכשירים שונים בכל פעם שהמשתמש מתחבר לאתר. כשמתעדים את ה-userId של משתמש, אפליקציות Gemini Enterprise יכולות ליצור תוצאות מותאמות אישית יותר למשתמש אחד בכמה מכשירים, כמו מכשיר נייד ודפדפן אינטרנט.

הערה: כדי לשמור על האנונימיות של המשתמשים ב-Gemini Enterprise ולהגן על הפרטיות שלהם, צריך להשתמש בפורמט מאובטח של מזהה ייחודי. באחריותך לצנזר פרטים אישיים מזהים (PII), כמו כתובות אימייל או כתובות מגורים, מהנתונים שלך.

מידע על חותמת הזמן

כשמתעדים אירוע משתמש, חשוב לכלול חותמת זמן מדויקת של מועד התרחשות האירוע. חותמות זמן מדויקות מבטיחות שהאירועים יישמרו בסדר הנכון. חותמות זמן מתועדות באופן אוטומטי לאירועים שנאספים באמצעות פיקסל JavaScript. כשמייבאים אירועים, צריך לציין את חותמת הזמן בשדה [eventTime][event-time] בפורמט שצוין ב-RFC 3339.

[rec-type-reqs]: /gemini/enterprise/docs/about-media-recommendations-types [record-events]: /gemini/enterprise/docs/record-user-events [event-time]: /gemini/enterprise/docs/reference/rest/v1/projects.locations.dataStores.userEvents#UserEvent.FIELDS.event_time [user-event]: /gemini/enterprise/docs/reference/rest/v1/projects.locations.dataStores.userEvents [user-info]: /gemini/enterprise/docs/reference/rest/v1/projects.locations.dataStores.userEvents#userinfo