משאב: AgentMessage
הודעה שנשלחה מהנציג למשתמש.
ייצוג JSON |
---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
שדות | |
---|---|
name |
השדה הזה מוגדר על ידי הפלטפורמה של RBM. חשוב לא לכלול אותה כשיוצרים הודעה לנציג תמיכה. הערך בשדה יהיה 'phones/{E.164}/agentMessages/{messageId}', כאשר {E.164} הוא מספר הטלפון של המשתמש בפורמט E.164 ו-{messageId} הוא המזהה שהוקצה על ידי הסוכן של ההודעה לנציג. |
sendTime |
השדה הזה מוגדר על ידי הפלטפורמה של RBM. חשוב לא לכלול אותה כשיוצרים הודעה לנציג תמיכה. השדה הזה מציין את השעה שבה ההודעה נשלחת למשתמש. חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
contentMessage |
תוכן ההודעה של הנציג. |
שדה איחוד
|
|
expireTime |
זה שינוי אופציונלי. חותמת הזמן לפי שעון UTC שמציינת שהתוקף של המשאב הזה פג. הערך הזה מופיע בפלט אם הוא מוגדר או אם השדה TTL מוגדר. חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
ttl |
זה שינוי אופציונלי. קלט בלבד. משך הזמן שבו ההודעה תוצג עד שהיא תבוטל באופן אוטומטי. משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-' |
AgentContentMessage
תוכן ההודעה שנשלחה מהנציג למשתמש.
ייצוג JSON |
---|
{ "suggestions": [ { object ( |
שדות | |
---|---|
suggestions[] |
רשימה של הצעות לתשובות והצעות לפעולות שמופיעות כרשימה של צ'יפים של הצעות אחרי ההודעה של הנציג הרלוונטי. עד 11 הצעות. הצ'יפים מוצגים רק כשההודעה המשויכת לנציג היא ההודעה האחרונה בשיחה (כולל הודעות לנציג וגם הודעות למשתמשים). המשתמש יכול להקיש על הצעה לתשובה כדי לשלוח את התשובה בהודעת הטקסט לנציג, או להקיש על הצעה לפעולה להפעלת פעולה מותאמת במכשיר. |
שדה איחוד content . התוכן של ההודעה לנציג content יכול להיות רק אחד מהפריטים הבאים: |
|
text |
הטקסט מקודד ב-UTF-8. |
fileName |
השם הייחודי של קובץ. כשנציג מעלה קובץ, פלטפורמת RBM מחזירה שם של קובץ. הוצא משימוש לטובת UploadRbmFile למטה |
uploadedRbmFile |
יש מזהים של קובץ ותמונה ממוזערת שהועלו לשרת של RBM והוצגו על ידיו. |
richCard |
צ'אט אינטראקטיבי נפרד. |
contentInfo |
מידע על קובץ, כולל כתובת ה-URL שלו וכתובת ה-URL של התמונה הממוזערת שלו. הפלטפורמה של RBM מציגה תוכן מהמטמון, אבל סוכן יכול לאלץ את הפלטפורמה של RBM לאחזר גרסה חדשה של התוכן ולרענן את המטמון. |
UploadedRbmFile
הודעה שמכילה מידע על הקובץ והתמונה הממוזערת
ייצוג JSON |
---|
{ "fileName": string, "thumbnailName": string } |
שדות | |
---|---|
fileName |
שם הקובץ, שהוחזר על ידי הפלטפורמה של RBM כשהקובץ הועלה. |
thumbnailName |
שם התמונה הממוזערת, שהוחזר על ידי הפלטפורמה של RBM כאשר התמונה הממוזערת הועלתה. |
RichCard
צ'אט אינטראקטיבי נפרד או קרוסלה של כרטיסי חיפוש מתקדמים שנשלחים מהנציג למשתמש.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד card . כרטיס עצמאי או קרוסלה של כרטיסים. card יכול להיות רק אחת מהאפשרויות הבאות: |
|
carouselCard |
קרוסלה של כרטיסים. |
standaloneCard |
כרטיס להצגה באופן עצמאי. |
CarouselCard
קרוסלה של כרטיסים.
ייצוג JSON |
---|
{ "cardWidth": enum ( |
שדות | |
---|---|
cardWidth |
רוחב הכרטיסים בקרוסלה. |
cardContents[] |
רשימת התוכן לכל כרטיס בקרוסלה. קרוסלה יכולה לכלול עד 2 כרטיסים ועד 10 כרטיסים. |
CarouselCard.CardWidth
רוחב הכרטיסים בקרוסלה.
טיפוסים בני מנייה (enum) | |
---|---|
CARD_WIDTH_UNSPECIFIED |
לא צוין. |
SMALL |
120 DP. הערה: אי אפשר להשתמש במדיה גבוהה. |
MEDIUM |
232 DP. |
CardContent
תוכן הכרטיס
ייצוג JSON |
---|
{ "title": string, "description": string, "media": { object ( |
שדות | |
---|---|
title |
(אופציונלי) כותרת הכרטיס. עד 200 תווים. |
description |
(אופציונלי) תיאור הכרטיס. עד 2,000 תווים. |
media |
(אופציונלי) מדיה (תמונה, GIF, סרטון) שיש לכלול בכרטיס. |
suggestions[] |
(אופציונלי) רשימת הצעות שייכללו בכרטיס. עד 4 הצעות. |
מדיה
קובץ מדיה בתוך כרטיס מתקדם.
ייצוג JSON |
---|
{ "height": enum ( |
שדות | |
---|---|
height |
גובה המדיה בתוך כרטיס מתקדם בפריסה אנכית. בכרטיס עצמאי עם פריסה אופקית, לא ניתן להתאים אישית את הגובה והמערכת מתעלמת מהשדה הזה. |
שדה איחוד content . תוכן המדיה content יכול להיות רק אחת מהאפשרויות הבאות: |
|
fileName |
השם הייחודי של הקובץ, שהוחזר על ידי הפלטפורמה של RBM כשהקובץ הועלה. הוצא משימוש לטובת UploadRbmFile למטה |
uploadedRbmFile |
יש מזהים של קובץ ותמונה ממוזערת שהועלו לשרת של RBM והוצגו על ידיו. |
contentInfo |
מידע על קובץ, כולל כתובת ה-URL שלו וכתובת ה-URL של התמונה הממוזערת שלו. הפלטפורמה של RBM מציגה תוכן מהמטמון, אבל סוכן יכול לאלץ את הפלטפורמה של RBM לאחזר גרסה חדשה של התוכן ולרענן את המטמון. |
ContentInfo
הודעה שמכילה את פרטי התוכן.
ייצוג JSON |
---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean } |
שדות | |
---|---|
fileUrl |
כתובת ה-URL של הקובץ שגלויה לכולם. פלטפורמת RBM קובעת את סוג ה-MIME של הקובץ מהשדה של סוג התוכן בכותרות ה-HTTP כשהפלטפורמה מאחזרת את הקובץ. השדה של סוג התוכן חייב להיות נוכח ומדויק בתגובת ה-HTTP מכתובת האתר. גודל הקובץ המקסימלי המומלץ: 100MB. |
thumbnailUrl |
(אופציונלי, בקובצי תמונה, אודיו ווידאו בלבד) כתובת URL של התמונה הממוזערת שגלויה לכולם. גודל מקסימלי של 100kB. אם לא תספקו כתובת URL של תמונה ממוזערת, פלטפורמת RBM תציג תמונה ממוזערת ריקה כ-placeholder, עד שהמכשיר של המשתמש יוריד את הקובץ. בהתאם להגדרת המשתמש, ייתכן שההורדה של הקובץ לא תתבצע אוטומטית והמשתמש יצטרך להקיש על לחצן ההורדה. |
forceRefresh |
אם המדיניות מוגדרת, פלטפורמת RBM מאחזרת את הקובץ ואת התמונה הממוזערת מכתובות ה-URL שצוינו, גם אם יש בפלטפורמה עותקים של הקובץ (ו/או של התמונה הממוזערת) שנשמרו במטמון. |
Media.Height
גובה מדיה
טיפוסים בני מנייה (enum) | |
---|---|
HEIGHT_UNSPECIFIED |
לא צוין. |
SHORT |
112 DP. |
MEDIUM |
168 DP. |
TALL |
264 DP. האפשרות הזו לא זמינה לקרוסלות עם כרטיסים מתקדמים אם רוחב הכרטיס מוגדר לקטן. |
הצעה
הצעה לתשובה או הצעה לפעולה בתוך כרטיס מתקדם או ברשימת צ'יפים של הצעות.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד option . הצעה לתשובה או הצעה לפעולה option יכולות להיות רק אחת מהאפשרויות הבאות: |
|
reply |
המשתמשים יכולים להקיש על הצעה לתשובה כדי לשלוח את התשובה בהודעת הטקסט לנציג. |
action |
המשתמשים יכולים להקיש על הצעה לפעולה כדי להפעיל את הפעולה המקורית התואמת במכשיר. |
SuggestedReply
כשמקישים על הלחצן, התשובה נשלחת בחזרה לנציג.
ייצוג JSON |
---|
{ "text": string, "postbackData": string } |
שדות | |
---|---|
text |
טקסט שמוצג בתשובה המוצעת ונשלח חזרה לנציג כאשר המשתמש יקיש עליו. 25 תווים לכל היותר. |
postbackData |
המטען הייעודי (payload) בקידוד base64 שהסוכן מקבל באירוע של משתמש כשהמשתמש מקיש על התשובה המוצעת. |
SuggestedAction
הקשה על הלחצן מפעילה את הפעולה המותאמת במכשיר.
ייצוג JSON |
---|
{ "text": string, "postbackData": string, "fallbackUrl": string, // Union field |
שדות | |
---|---|
text |
הטקסט שמוצג בפעולה המוצעת. 25 תווים לכל היותר. |
postbackData |
מטען ייעודי (payload) (בקידוד base64) שיישלח לסוכן באירוע של המשתמש שמתרחש כשהמשתמש יקיש על הפעולה המוצעת |
fallbackUrl |
(אופציונלי) כתובת URL חלופית לשימוש אם הלקוח לא תומך בפעולה מוצעת. כתובות URL חלופיות נפתחות בחלונות חדשים בדפדפן. |
שדה איחוד action . הפעולה המותאמת שמופעלת במכשיר כשהמשתמש מקיש על ההצעה לפעולה action יכולה להיות רק אחת מהאפשרויות הבאות: |
|
dialAction |
פתיחה של אפליקציית החייגן שמוגדרת כברירת מחדל כאשר ממולא מספר הטלפון שצוין על ידי הסוכן. |
viewLocationAction |
פותח את אפליקציית המפות שמוגדרת כברירת מחדל ובוחר את המיקום שצוין בסוכן או מחפש מידע על המיקום של המשתמש בהתאם לשאילתה שצוינה בסוכן. |
createCalendarEventAction |
פותח את אפליקציית היומן שמוגדרת כברירת מחדל ומתחיל תהליך חדש של אירועים ביומן כאשר נתוני האירוע שצוינו על ידי הסוכן ממולאים מראש. |
openUrlAction |
פותח את אפליקציית ברירת המחדל של המשתמש לדפדפן האינטרנט לכתובת ה-URL הנתונה. אם למשתמש יש אפליקציה מותקנת ורשומה כ-handler ברירת המחדל לכתובת ה-URL, האפליקציה הזו תיפתח במקום זאת והסמל שלה ישמש בממשק המשתמש של הפעולות המומלצות. |
shareLocationAction |
פותח את בוחר המיקום של אפליקציית RCS כדי שהמשתמש יוכל לבחור מיקום לשלוח לנציג. |
DialAction
פתיחה של אפליקציית החייגן שמוגדרת כברירת מחדל כאשר ממולא מספר הטלפון שצוין על ידי הסוכן.
ייצוג JSON |
---|
{ "phoneNumber": string } |
שדות | |
---|---|
phoneNumber |
מספר הטלפון בפורמט E.164, למשל +12223334444. |
ViewLocationAction
פותח את אפליקציית המפות שמוגדרת כברירת מחדל ובוחר את המיקום שצוין בסוכן או מחפש מידע על המיקום של המשתמש בהתאם לשאילתה שצוינה בסוכן.
ייצוג JSON |
---|
{
"latLong": {
object ( |
שדות | |
---|---|
latLong |
(אופציונלי) קו הרוחב וקו האורך של המיקום שצוין. |
label |
(אופציונלי) התווית של הסיכה הופחתה ב-latLong. |
query |
(אופציונלי, האפשרות נתמכת רק בלקוחות Android Messages) במקום לציין latLong (ואפשר גם להוסיף תווית), הסוכן יכול לציין מחרוזת שאילתה. באפליקציות מיפוי שמוגדרות כברירת מחדל שתומכות בפונקציונליות חיפוש (כולל מפות Google), הקשה על ההצעה הזו לפעולה מובילה לחיפוש מיקום שמבוסס על המיקום הנוכחי של המשתמש. אם השאילתה ספציפית מספיק, הנציגים יוכלו להשתמש בה כדי לבחור כל מיקום בעולם. לדוגמה, הגדרת מחרוזת השאילתה כ-"Growing Tree Bank" יציג את כל המיקומים של בנק עצים שנמצאים בקרבת המשתמש. הגדרת מחרוזת השאילתה ל"1600 Amphitheater Parkway, Mountain View, CA 94043" יבחר את הכתובת הספציפית הזו, בלי קשר למיקום של המשתמש. |
LatLng
אובייקט שמייצג צמד של קו רוחב/קו אורך. הערך הזה מבוטאת כצמד של כפולים כדי לייצג מעלות קו רוחב ומעלות קו אורך. האובייקט חייב לעמוד ב תקן WGS84, אלא אם צוין אחרת. הערכים חייבים להיות בטווחים מנורמלים.
ייצוג JSON |
---|
{ "latitude": number, "longitude": number } |
שדות | |
---|---|
latitude |
קו הרוחב במעלות. הוא חייב להיות בטווח [-90.0, +90.0]. |
longitude |
קו האורך במעלות. הוא חייב להיות בטווח [-180.0, +180.0]. |
CreateCalendarEventAction
פותח את אפליקציית היומן שמוגדרת כברירת מחדל ומתחיל תהליך חדש של אירוע ביומן כאשר נתוני האירוע שצוינו על ידי הסוכן ממולאים מראש.
ייצוג JSON |
---|
{ "startTime": string, "endTime": string, "title": string, "description": string } |
שדות | |
---|---|
startTime |
שעת ההתחלה של האירוע. חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
endTime |
שעת הסיום של האירוע. חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
title |
כותרת האירוע. |
description |
תיאור האירוע. |
OpenUrlAction
פותח את אפליקציית ברירת המחדל של המשתמש לדפדפן האינטרנט לכתובת ה-URL שצוינה. אם למשתמש יש אפליקציה מותקנת ורשומה כ-handler שמוגדר כברירת מחדל בכתובת ה-URL, האפליקציה הזו תיפתח במקום זאת, והסמל שלה ישמש בממשק המשתמש של הפעולות המומלצות.
ייצוג JSON |
---|
{ "url": string } |
שדות | |
---|---|
url |
כתובת URL |
StandaloneCard
כרטיס עצמאי
ייצוג JSON |
---|
{ "cardOrientation": enum ( |
שדות | |
---|---|
cardOrientation |
כיוון הכרטיס. |
thumbnailImageAlignment |
יישור התצוגה המקדימה של התמונות לכרטיסים נפרדים עם פריסה אופקית. |
cardContent |
תוכן הכרטיס. |
StandaloneCard.CardOrientation
כיוון הכרטיס.
טיפוסים בני מנייה (enum) | |
---|---|
CARD_ORIENTATION_UNSPECIFIED |
לא צוין. |
HORIZONTAL |
פריסה אופקית. אם השדה |
VERTICAL |
פריסה אנכית. |
StandaloneCard.ThumbnailImageAlignment
יישור התצוגה המקדימה של התמונות לכרטיסים נפרדים עם פריסה אופקית.
טיפוסים בני מנייה (enum) | |
---|---|
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED |
לא צוין. |
LEFT |
התצוגה המקדימה של הקובץ מיושרת לשמאל. |
RIGHT |
התצוגה המקדימה של הקובץ מיושרת לימין. |
שיטות |
|
---|---|
|
ההודעות נשלחות מהנציג למשתמש. |
|
ביטול הודעה שנשלחה לנציג תמיכה אבל עדיין לא נמסרה. |