AppResponse

AppResponse היא התשובה שנשלחת על ידי מילוי ההזמנה אל Google Assistant. דוגמאות לאופן השימוש במאפיין הזה ב-Actions on Google זמינות בכתובת https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json#conversation-response-body.

ייצוג JSON
{
  "conversationToken": string,
  "userStorage": string,
  "resetUserStorage": boolean,
  "expectUserResponse": boolean,
  "expectedInputs": [
    {
      object (ExpectedInput)
    }
  ],
  "finalResponse": {
    object (FinalResponse)
  },
  "customPushMessage": {
    object (CustomPushMessage)
  },
  "isInSandbox": boolean
}
שדות
conversationToken

string

אסימון אטום שמופץ מחדש לפעולה בכל פעם ששיחה תורפה.

userStorage

string

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

resetUserStorage

boolean

האם לנקות את ה-userStorage הקבוע. אם המדיניות מוגדרת כ-True, באינטראקציה הבאה עם המשתמש השדה userStorage יהיה ריק.

expectUserResponse

boolean

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

expectedInputs[]

object (ExpectedInput)

רשימת קלט כרגע יש תמיכה רק בקלט אחד.

finalResponse

object (FinalResponse)

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

customPushMessage

object (CustomPushMessage)

הודעה בדחיפה מותאמת אישית שמאפשרת למפתחים לשלוח נתונים מובְנים לפעולות ב-Google.

isInSandbox

boolean

מציין אם צריך לטפל בתגובה במצב ארגז חול. הביט הזה נדרש כדי לדחוף נתונים מובְנים ל-Google במצב ארגז חול.

ExpectedInput

ייצוג JSON
{
  "inputPrompt": {
    object (InputPrompt)
  },
  "possibleIntents": [
    {
      object (ExpectedIntent)
    }
  ],
  "speechBiasingHints": [
    string
  ]
}
שדות
inputPrompt

object (InputPrompt)

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

possibleIntents[]

object (ExpectedIntent)

רשימת כוונות שאפשר להשתמש בהן כדי למלא את הקלט הזה. כדי שפעולות ב-Google יחזירו רק את הקלט הגולמי של המשתמש, האפליקציה צריכה לבקש את ה-Intent 'actions.intent.TEXT'.

speechBiasingHints[]

string

רשימת ביטויים שהפעולה רוצה ש-Google תשתמש בהם לצורך הטיית דיבור. מותר להשתמש ב-1,000 ביטויים לכל היותר.

InputPrompt

הודעת הקלט שמשמשת ל-Assistant כדי להנחות את המשתמש להזין קלט לשאלה של האפליקציה.

ייצוג JSON
{
  "initialPrompts": [
    {
      object (SpeechResponse)
    }
  ],
  "richInitialPrompt": {
    object (RichResponse)
  },
  "noInputPrompts": [
    {
      object (SimpleResponse)
    }
  ]
}
שדות
initialPrompts[]
(deprecated)

object (SpeechResponse)

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

richInitialPrompt

object (RichResponse)

מטען ייעודי (payload) של הצעה לפעולה.

noInputPrompts[]

object (SimpleResponse)

בקשה שנשלחת למשתמש כאשר אין קלט מהמשתמש.

SpeechResponse

תשובה שמכילה רק דיבור. הוצא משימוש.

ייצוג JSON
{

  // Union field type can be only one of the following:
  "textToSpeech": string,
  "ssml": string
  // End of list of possible types for union field type.
}
שדות
שדה איחוד type. סוגי פלט דיבור: המרת טקסט לדיבור (TTS) או SSML. type יכול להיות רק אחת מהאפשרויות הבאות:
textToSpeech

string

טקסט פשוט של פלט הדיבור, למשל: "לאן אתה רוצה ללכת?"/

ssml

string

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

RichResponse

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

ייצוג JSON
{
  "items": [
    {
      object (Item)
    }
  ],
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "linkOutSuggestion": {
    object (LinkOutSuggestion)
  }
}
שדות
items[]

object (Item)

רשימה של רכיבי ממשק המשתמש שמרכיבים את התגובה. הפריטים צריכים לעמוד בדרישות הבאות: 1. הפריט הראשון חייב להיות SimpleResponse 2. לכל היותר שני SimpleResponse 3. לכל היותר פריט אחד של תגובה עשירה (למשל BasicCard, StructuredResponse, MediaResponse או HtmlResponse) 4. אי אפשר להשתמש בפריט של תגובה מתקדמת אם משתמשים ב- actions.intent.OPTIONIntent כלומר ListSelect או CarouselSelect

suggestions[]

object (Suggestion)

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

פריט

פריטים בתשובה.

ייצוג JSON
{
  "name": string,

  // Union field item can be only one of the following:
  "simpleResponse": {
    object (SimpleResponse)
  },
  "basicCard": {
    object (BasicCard)
  },
  "structuredResponse": {
    object (StructuredResponse)
  },
  "mediaResponse": {
    object (MediaResponse)
  },
  "carouselBrowse": {
    object (CarouselBrowse)
  },
  "tableCard": {
    object (TableCard)
  },
  "htmlResponse": {
    object (HtmlResponse)
  }
  // End of list of possible types for union field item.
}
שדות
name

string

מזהה אופציונלי בעל שם של הפריט הזה.

שדה איחוד item. סוג הפריט. item יכול להיות רק אחת מהאפשרויות הבאות:
simpleResponse

object (SimpleResponse)

תשובה באמצעות הודעות קוליות וטקסט בלבד.

basicCard

object (BasicCard)

כרטיס בסיסי.

structuredResponse

object (StructuredResponse)

מטען ייעודי (payload) מובנה שעובר עיבוד על ידי Google.

mediaResponse

object (MediaResponse)

תגובה שמציינת קבוצת מדיה להפעלה.

carouselBrowse

object (CarouselBrowse)

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

tableCard

object (TableCard)

כרטיס טבלה.

htmlResponse

object (HtmlResponse)

תגובת HTML משמשת לעיבוד בלוח הציור.

SimpleResponse

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

ייצוג JSON
{
  "textToSpeech": string,
  "ssml": string,
  "displayText": string
}
שדות
textToSpeech

string

טקסט פשוט של פלט הדיבור, למשל: "לאן אתה רוצה ללכת?" בלעדי באופן הדדי עם ssml.

ssml

string

תגובה קולית מובנית למשתמש בפורמט SSML, למשל <speak> Say animal name after the sound. <audio src = 'https://www.pullstring.com/moo.mps' />, what’s the animal? </speak> בלעדי באופן הדדי עם textToSpeech.

displayText

string

טקסט אופציונלי להצגה בבועת הצ'אט. אם לא ניתן, ייעשה שימוש ברינדור תצוגה של ה-textToSpeech או ה-ssml שלמעלה. מוגבל ל-640 תווים.

BasicCard

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

ייצוג JSON
{
  "title": string,
  "subtitle": string,
  "formattedText": string,
  "image": {
    object (Image)
  },
  "buttons": [
    {
      object (Button)
    }
  ],
  "imageDisplayOptions": enum (ImageDisplayOptions)
}
שדות
title

string

הכותרת הכוללת של הכרטיס. זה שינוי אופציונלי.

subtitle

string

זה שינוי אופציונלי.

formattedText

string

הטקסט של תוכן הכרטיס. תומך בקבוצה מוגבלת של תחביר Markdown לעיצוב. חובה, אלא אם יש תמונה.

image

object (Image)

תמונה ראשית (Hero) של הכרטיס. הגובה קבוע ל-192dp. זה שינוי אופציונלי.

buttons[]

object (Button)

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

imageDisplayOptions

enum (ImageDisplayOptions)

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

לחצן

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

ייצוג JSON
{
  "title": string,
  "openUrlAction": {
    object (OpenUrlAction)
  }
}
שדות
title

string

כותרת הלחצן. חובה.

openUrlAction

object (OpenUrlAction)

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

StructuredResponse

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

ייצוג JSON
{

  // Union field data can be only one of the following:
  "orderUpdate": {
    object (OrderUpdate)
  },
  "orderUpdateV3": {
    object (OrderUpdate)
  }
  // End of list of possible types for union field data.
}
שדות
שדה איחוד data. הקונטיינר של תגובת מטען ייעודי (payload) מסוכני צד שלישי. data יכול להיות רק אחת מהאפשרויות הבאות:
orderUpdate

object (OrderUpdate)

האפליקציה מספקת עדכון הזמנה (למשל, Receipt) לאחר קבלת ההזמנה.

orderUpdateV3

object (OrderUpdate)

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

OrderUpdate

הוצא משימוש: שימוש ב-V3 Proto במקום זאת. צריך לעדכן את ההזמנה.

ייצוג JSON
{
  "googleOrderId": string,
  "actionOrderId": string,
  "orderState": {
    object (OrderState)
  },
  "orderManagementActions": [
    {
      object (Action)
    }
  ],
  "receipt": {
    object (Receipt)
  },
  "updateTime": string,
  "totalPrice": {
    object (Price)
  },
  "lineItemUpdates": {
    string: {
      object(LineItemUpdate)
    },
    ...
  },
  "userNotification": {
    object (UserNotification)
  },
  "infoExtension": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field info can be only one of the following:
  "rejectionInfo": {
    object (RejectionInfo)
  },
  "cancellationInfo": {
    object (CancellationInfo)
  },
  "inTransitInfo": {
    object (InTransitInfo)
  },
  "fulfillmentInfo": {
    object (FulfillmentInfo)
  },
  "returnInfo": {
    object (ReturnInfo)
  }
  // End of list of possible types for union field info.
}
שדות
googleOrderId

string

מזהה ההזמנה הוא המזהה שהונפק על ידי Google.

actionOrderId

string

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

orderState

object (OrderState)

המצב החדש של הצו.

orderManagementActions[]

object (Action)

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

receipt

object (Receipt)

קבלה על ההזמנה.

updateTime

string (Timestamp format)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' , מדויק לננו-שניות. דוגמה: "2014-10-02T15:01:23.045123456Z"

totalPrice

object (Price)

המחיר הכולל החדש של ההזמנה

lineItemUpdates

map (key: string, value: object (LineItemUpdate))

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

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

userNotification

object (UserNotification)

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

infoExtension

object

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

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI המזהה את הסוג. לדוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }.

שדה איחוד info. מידע נוסף שמשויך למצב הצו. info יכול להיות רק אחת מהאפשרויות הבאות:
rejectionInfo

object (RejectionInfo)

מידע על מצב הדחייה.

cancellationInfo

object (CancellationInfo)

מידע על מצב הביטול.

inTransitInfo

object (InTransitInfo)

מידע על מצב התחבורה הציבורית.

fulfillmentInfo

object (FulfillmentInfo)

מידע על מצב האספקה.

returnInfo

object (ReturnInfo)

מידע על מצב ההחזרה.

פעולה

פעולת המשך שמשויכת לעדכון ההזמנה.

ייצוג JSON
{
  "type": enum (ActionType),
  "button": {
    object (Button)
  }
}
שדות
type

enum (ActionType)

סוג הפעולה.

button

object (Button)

תווית הלחצן וקישור.

קבלה

הוצא משימוש: שימוש ב-V3 Proto במקום זאת. קבלה כשהמדינה מאושרת או כל מדינה אחרת (למשל: IN_TRANSIT, FULFILLED) כולל מצב 'מאושר'.

ייצוג JSON
{
  "confirmedActionOrderId": string,
  "userVisibleOrderId": string
}
שדות
confirmedActionOrderId
(deprecated)

string

מזהה ההזמנה אושר כשההזמנה התקבלה על ידי מבצע השילוב. זהו מזהה ההזמנה הקנוני המשמש במערכת השילוב מתייחס להזמנה, ולאחר מכן ניתן להשתמש בו כדי לזהות את ההזמנה כ-actionOrderId.

חשוב לשים לב שהשדה הזה הוצא משימוש. במקום זאת, יש להעביר את השדה דרך OrderUpdate.action_order_id.

userVisibleOrderId

string

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

RejectionInfo

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

ייצוג JSON
{
  "type": enum (ReasonType),
  "reason": string
}
שדות
type

enum (ReasonType)

סוג הדחייה.

reason

string

סיבת השגיאה.

CancellationInfo

הוצא משימוש: שימוש ב-V3 Proto במקום זאת. פרטי הביטול כשהמצב מבוטל.

ייצוג JSON
{
  "reason": string
}
שדות
reason

string

סיבת הביטול.

InTransitInfo

הוצא משימוש: שימוש ב-V3 Proto במקום זאת. המידע לגבי התחבורה הציבורית כשהמדינה היא IN_TRANSIT

ייצוג JSON
{
  "updatedTime": string
}
שדות
updatedTime

string (Timestamp format)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' , מדויק לננו-שניות. דוגמה: "2014-10-02T15:01:23.045123456Z"

FulfillmentInfo

הוצא משימוש: שימוש ב-V3 Proto במקום זאת. פרטי מילוי ההזמנה כשהמצב הוא FULFILLED.

ייצוג JSON
{
  "deliveryTime": string
}
שדות
deliveryTime

string (Timestamp format)

מתי ההזמנה תושלם.

חותמת זמן ב-RFC3339 UTC 'Zulu' , מדויק לננו-שניות. דוגמה: "2014-10-02T15:01:23.045123456Z"

ReturnInfo

הוצא משימוש: שימוש ב-V3 Proto במקום זאת. פרטי ההחזרה כשהמדינה נדחתה.

ייצוג JSON
{
  "reason": string
}
שדות
reason

string

סיבה להחזרה.

UserNotification

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

ייצוג JSON
{
  "title": string,
  "text": string
}
שדות
title

string

הכותרת של ההודעה למשתמש.

text

string

תוכן ההתראה.

MediaResponse

התשובה שמציינת קבוצת מדיה להפעלה בשיחה.

ייצוג JSON
{
  "mediaType": enum (MediaType),
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}
שדות
mediaType

enum (MediaType)

סוג המדיה בתשובה הזו.

mediaObjects[]

object (MediaObject)

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

MediaObject

מייצג אובייקט מדיה אחד שמוחזר עם MediaResponse. מכיל מידע על המדיה, כמו שם, תיאור, כתובת URL וכו'.

ייצוג JSON
{
  "name": string,
  "description": string,
  "contentUrl": string,

  // Union field image can be only one of the following:
  "largeImage": {
    object (Image)
  },
  "icon": {
    object (Image)
  }
  // End of list of possible types for union field image.
}
שדות
name

string

השם של אובייקט המדיה הזה.

description

string

בתיאור של אובייקט המדיה הזה.

contentUrl

string

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

שדה איחוד image. תמונה להצגה עם כרטיס המדיה. image יכול להיות רק אחת מהאפשרויות הבאות:
largeImage

object (Image)

תמונה גדולה, כמו עטיפת האלבום וכו'.

icon

object (Image)

סמל של תמונה קטנה שמוצג משמאל לכותרת. הגודל שלו מוקטן ל-36x36dp.

CarouselBrowse

הצגת קבוצה של מסמכי AMP כקרוסלה של פריטים בפורמט משבצות גדולות. אפשר לבחור פריטים כדי להפעיל את מסמך ה-AMP המשויך אליהם במציג AMP.

ייצוג JSON
{
  "items": [
    {
      object (Item)
    }
  ],
  "imageDisplayOptions": enum (ImageDisplayOptions)
}
שדות
items[]

object (Item)

מינימום: 2. מקסימום: 10.

imageDisplayOptions

enum (ImageDisplayOptions)

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

פריט

פריט בקרוסלה.

ייצוג JSON
{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (Image)
  },
  "openUrlAction": {
    object (OpenUrlAction)
  }
}
שדות
title

string

הכותרת של פריט הקרוסלה. חובה.

description

string

בתיאור של פריט הקרוסלה. זה שינוי אופציונלי.

footer

string

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

image

object (Image)

התמונה הראשית של פריט הקרוסלה. זה שינוי אופציונלי.

openUrlAction

object (OpenUrlAction)

כתובת ה-URL של המסמך המשויך לפריט הקרוסלה. המסמך יכול להכיל תוכן HTML או, אם urlTypeHint. מוגדרת כ-AMP_CONTENT, תוכן AMP. חובה.

TableCard

כרטיס טבלה להצגת טבלה של טקסט.

ייצוג JSON
{
  "title": string,
  "subtitle": string,
  "image": {
    object (Image)
  },
  "columnProperties": [
    {
      object (ColumnProperties)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "buttons": [
    {
      object (Button)
    }
  ]
}
שדות
title

string

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

subtitle

string

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

image

object (Image)

התמונה שמשויכת לטבלה. זה שינוי אופציונלי.

columnProperties[]

object (ColumnProperties)

כותרות ויישור עמודות.

rows[]

object (Row)

נתוני השורה בטבלה. מובטח ש-3 השורות הראשונות יוצגו, אבל יכול להיות ששורות אחרות ייחתכו בפלטפורמות מסוימות. אפשר לנסות באמצעות הסימולטור כדי לראות אילו שורות יוצגו בפלטפורמה מסוימת. בפלטפורמות שתומכות ביכולת WEB_BROWSER, ניתן להפנות את המשתמש לדף אינטרנט שמכיל יותר נתונים.

buttons[]

object (Button)

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

ColumnProperties

שומר את המאפיינים של עמודות (כולל כותרות).

ייצוג JSON
{
  "header": string,
  "horizontalAlignment": enum (HorizontalAlignment)
}
שדות
header

string

טקסט הכותרת של העמודה.

horizontalAlignment

enum (HorizontalAlignment)

יישור אופקי של תוכן עם עמודת w.r.t. אם לא צוין, התוכן יותאם לקצה העליון.

שורה

מתאר שורה בטבלה.

ייצוג JSON
{
  "cells": [
    {
      object (Cell)
    }
  ],
  "dividerAfter": boolean
}
שדות
cells[]

object (Cell)

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

dividerAfter

boolean

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

תא

מתאר תא בשורה.

ייצוג JSON
{
  "text": string
}
שדות
text

string

תוכן הטקסט של התא.

HtmlResponse

תגובה שמציגה HTML באמצעות תכונת הקנבס האינטראקטיבית. הגודל המרבי של גודל התגובה הוא 50,000 בייטים.

ייצוג JSON
{
  "updatedState": value,
  "suppressMic": boolean,
  "url": string
}
שדות
updatedState

value (Value format)

מעבירים לאפליקציה את אובייקט ה-JSON הבא.

suppressMic

boolean

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

url

string

כתובת ה-URL של האפליקציה.

הצעה

צ'יפ של הצעה שהמשתמש יכול להקיש עליו כדי לפרסם תשובה לשיחה במהירות.

ייצוג JSON
{
  "title": string
}
שדות
title

string

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

LinkOutSuggestion

יוצר צ'יפ של הצעה שמאפשר למשתמש להיכנס לאפליקציה או לאתר שמשויכים לנציג הזה.

ייצוג JSON
{
  "destinationName": string,
  "url": string,
  "openUrlAction": {
    object (OpenUrlAction)
  }
}
שדות
destinationName

string

שם האפליקציה או האתר שהצ'יפ הזה מקשר אליהם. הצ'יפ יוצג בשם 'פתוח' . עד 20 תווים. חובה.

url
(deprecated)

string

הוצא משימוש. במקומו צריך להשתמש ב-OpenUrlAction.

openUrlAction

object (OpenUrlAction)

כתובת ה-URL של האפליקציה או האתר שייפתחו כשהמשתמש יקיש על צ'יפ ההצעה. חובה לאמת את הבעלות על האפליקציה או כתובת ה-URL הזו בפעולות ב-Google Developer Console, אחרת ההצעה לא תוצג למשתמש. התכונה 'פעולה של כתובת URL פתוחה' תומכת בכתובות URL מסוג http, https ו-Intent. לכתובות URL של Intent יש לעיין בכתובת: https://developer.chrome.com/multidevice/android/intents

ExpectedIntent

הכוונה הצפויה שהאפליקציה מבקשת מ-Assistant לספק.

ייצוג JSON
{
  "intent": string,
  "inputValueData": {
    "@type": string,
    field1: ...,
    ...
  },
  "parameterName": string
}
שדות
intent

string

השם של ה-Intent המובנה, למשל actions.intent.TEXT, או כוונות שהוגדרו בחבילת הפעולות. אם הכוונה שצוינה היא לא כוונה מובנית, היא משמשת רק להטיית דיבור, והקלט שסופק על ידי Google Assistant יהיה Intent מסוג actions.intent.TEXT.

inputValueData

object

נתוני הגדרה נוספים שנדרשים ל-Intent מובנה. ערכים אפשריים לאובייקטים המובנים של Intent: actions.intent.OPTION -> google.actions.v2.OptionValueSpec, actions.intent.CONFIRMATION -> google.actions.v2.ConfirmationValueSpec, actions.intent.TRANSACTION_REQUIREMENTS_CHECK -> google.actions.v2.TransactionRequirementsCheckSpec, actions.intent.DELIVERY_ADDRESS -> google.actions.v2.DeliveryAddressValueSpec, actions.intent.TRANSACTION_DECISION -> google.actions.v2.TransactionDecisionValueSpec, actions.intent.PLACE -> google.actions.v2.PlaceValueSpec, actions.intent.Link -> google.actions.v2.LinkValueSpec

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI המזהה את הסוג. לדוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }.

parameterName

string

אופציונלי, פרמטר של ה-Intent המבוקש. תקף רק לאובייקטים מבוקשים. משמש להטיית דיבור.

FinalResponse

התשובה הסופית כאשר לא צפוי קלט של משתמשים.

ייצוג JSON
{

  // Union field response can be only one of the following:
  "speechResponse": {
    object (SpeechResponse)
  },
  "richResponse": {
    object (RichResponse)
  }
  // End of list of possible types for union field response.
}
שדות
שדה איחוד response. סוגי תגובות אפשריים. response יכול להיות רק אחת מהאפשרויות הבאות:
speechResponse
(deprecated)

object (SpeechResponse)

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

richResponse

object (RichResponse)

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

CustomPushMessage

הודעת דחיפה בהתאמה אישית שמכילה נתונים מובְנים לצורך אימות הפעולות של Fulfillment API.

ייצוג JSON
{
  "target": {
    object (Target)
  },

  // Union field content can be only one of the following:
  "orderUpdate": {
    object (OrderUpdate)
  },
  "userNotification": {
    object (UserNotification)
  }
  // End of list of possible types for union field content.
}
שדות
target

object (Target)

היעד שצוין לבקשת הדחיפה.

שדה איחוד content. הסוגים השונים של מטען ייעודי (payload). content יכול להיות רק אחת מהאפשרויות הבאות:
orderUpdate

object (OrderUpdate)

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

userNotification

object (UserNotification)

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

UserNotification

התראה למשתמש שתוצג עם בקשה.

ייצוג JSON
{
  "title": string,
  "text": string
}
שדות
title

string

כותרת ההתראה.

text

string

תוכן ההתראה.

יעד

היעד שצוין לבקשת הדחיפה.

ייצוג JSON
{
  "userId": string,
  "intent": string,
  "argument": {
    object (Argument)
  },
  "locale": string
}
שדות
userId

string

המשתמש שצריך לטרגט.

intent

string

הכוונה לטרגט.

argument

object (Argument)

הארגומנט שצריך לטרגט ל-Intent. ב-V1 יש תמיכה רק בארגומנט אחד.

locale

string

הלוקאל שאליו צריך לטרגט. לפי קוד השפה IETF BCP-47. אפשר להשתמש באפליקציה בכמה שפות כדי לטרגט משתמש באפליקציה ספציפית שמותאמת לשוק המקומי. אם לא תציינו את הערך הזה, ברירת המחדל תהיה en-US.