AppResponse

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

ייצוג 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

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

expectedInputs[]

object (ExpectedInput)

רשימת סוגי הקלט שהפעולה מצפה להם. כל קלט יכול להיות פעולות נפוצות ב-Google Intent (מתחילים ב-'actions.') או קלט שכולל רשימה של כוונות אפשריות. בשלב זה יש תמיכה בקלט אחד בלבד.

finalResponse

object (FinalResponse)

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

customPushMessage

object (CustomPushMessage)

הודעת Push בהתאמה אישית שמאפשרת למפתחים לשלוח נתונים מובְנים לפעולות ב-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 רוצה ש-Google תשתמש בהם לצורך הטיית דיבור. אפשר להזין עד 1,000 ביטויים.

InputPrompt

בקשת הקלט ל-Assistant כדי להדריך את המשתמש איך להזין קלט לשאלה באפליקציה.

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

object (SpeechResponse)

בקשות ראשוניות מהמשתמש להזין קלט. יש תמיכה רק ב-Initial_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. סוגים של פלט דיבור: המרת טקסט לדיבור או 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. לא ניתן להשתמש בפריט תגובה עשירה אם משתמשים ב-Intent actions.intent.OPTION ie 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, מדויקת לננו-שניות. דוגמה: "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) כולל מצב ACHED.

ייצוג 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 במקום זאת. פרטי הביטול כשהמצב הוא CANCELLED.

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

string

סיבת הביטול.

InTransitInfo

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

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

string (Timestamp format)

מועד עדכון אחרון של הובלה.

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

FulfillmentInfo

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

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

string (Timestamp format)

מתי ההזמנה תסופק.

חותמת זמן בפורמט "זולו" RFC3339 UTC, מדויקת לננו-שניות. דוגמה: "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)

תמונה ראשית (Hero) של הפריט בקרוסלה. אפשרות.

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)

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

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

הודעת Push בהתאמה אישית שכוללת נתונים מובְנים כדי לדחוף את הפעולות ל-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'.