המלצה שדורשת אירוע משתמש הקשרי.
בקשת HTTP
POST https://discoveryengine.googleapis.com/v1beta/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:recommend כתובות ה-URL כתובות בתחביר של gRPC Transcoding.
פרמטרים של נתיב
| פרמטרים | |
|---|---|
servingConfig |
חובה. שם המשאב המלא של כשיוצרים מנוע המלצות, נוצרת גם הגדרת ברירת מחדל אחת להצגת מודעות. מזהה המנוע משמש כמזהה של הגדרת ברירת המחדל להצגת מודעות. לדוגמה, במנוע |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{
"userEvent": {
object ( |
| שדות | |
|---|---|
userEvent |
חובה. הקשר לגבי המשתמש, מה הוא רואה ואיזו פעולה הוא ביצע כדי להפעיל את בקשת ההמלצה של servingConfigs. שימו לב: פרטי האירוע הזה של המשתמש לא ייכללו ביומני userEvent. לכן, נדרשת בקשת כתיבה נפרדת של userEvent לרישום האירוע ביומן. אל תגדירו את הערכים של |
pageSize |
המספר המקסימלי של תוצאות שיוחזרו. מגדירים את המאפיין הזה למספר התוצאות של ההמלצות שרוצים לקבל. אם הערך הוא אפס, השירות בוחר ברירת מחדל סבירה. הערך המקסימלי המותר הוא 100. ערכים מעל 100 מוגדרים כ-100. |
filter |
מסנן להגבלת תוצאות ההמלצות. אורך המסנן מוגבל ל-5,000 תווים. בשלב הזה, המערכת תומכת רק בביטויי מסננים במאפיין דוגמאות:
אם הערך של
אם המסנן חוסם את כל התוצאות, ה-API מחזיר מסמכים פופולריים כלליים (לא מסוננים). אם רוצים לקבל רק תוצאות שתואמות בדיוק למסננים, צריך להגדיר את שימו לב: ה-API אף פעם לא מחזיר |
validateOnly |
השתמשו במצב אימות בלבד לשאילתת ההמלצה הזו. אם הערך הוא |
params |
פרמטרים נוספים ספציפיים לדומיין להמלצות. ערכים מותרים:
|
userLabels |
התוויות של המשתמש שמוחלות על משאב צריכות לעמוד בדרישות הבאות:
מידע נוסף מפורט בדרישות לשימוש בתוויות. |
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של RecommendResponse.
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/discoveryengine.readwritehttps://www.googleapis.com/auth/discoveryengine.serving.readwrite
ניתן למצוא מידע נוסף כאן: Authentication Overview.
הרשאות IAM
נדרשת הרשאת IAM הבאה במשאב servingConfig:
discoveryengine.servingConfigs.recommend
מידע נוסף מופיע במאמרי העזרה בנושא IAM.