Method: fulfill

RPC שמייצג את ה-API למילוי הזמנות

בקשת HTTP

POST https://webhook_handler_service.googleapis.com/fulfill

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "handler": {
    object (Handler)
  },
  "intent": {
    object (Intent)
  },
  "scene": {
    object (Scene)
  },
  "session": {
    object (Session)
  },
  "user": {
    object (User)
  },
  "home": {
    object (Home)
  },
  "device": {
    object (Device)
  },
  "context": {
    object (Context)
  }
}
שדות
handler

object (Handler)

חובה. מידע למילוי הזמנות לגבי אופן הטיפול בבקשה. לדוגמה, בקשה מתוך כוונה לקבל עובדה עשויה לכלול handler עם השם 'getFact'.
intent

object (Intent)

חובה. מייצג את הכוונה האחרונה שהותאמו. מידע נוסף מופיע בכתובת https://developers.google.com/assistant/conversational/intents.
scene

object (Scene)

זה שינוי אופציונלי. מידע על הסצנה הנוכחית והסצנה הבאה בזמן הקריאה לפונקציה. השדה הזה ימולא כשבקשת מילוי ההזמנה תתבצע בטווח של סצנה. פרטים נוספים זמינים בכתובת https://developers.google.com/assistant/conversational/scenes.
session

object (Session)

חובה. מכילה נתוני סשן, כמו מזהה הסשן ופרמטרים של הסשן.
user

object (User)

חובה. המשתמש שיזם את השיחה.
home

object (Home)

זה שינוי אופציונלי. מידע שקשור למבנה Home Graph שאליו שייך מכשיר היעד. מידע נוסף זמין בכתובת https://developers.google.com/actions/smarthome/concepts/homegraph.
device

object (Device)

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

object (Context)

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

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

מייצג תשובה שנשלחה ממילוי הזמנות של המפתח אל Actions on Google.

ייצוג JSON 
{
  "prompt": {
    object (Prompt)
  },
  "scene": {
    object (Scene)
  },
  "session": {
    object (Session)
  },
  "user": {
    object (User)
  },
  "home": {
    object (Home)
  },
  "device": {
    object (Device)
  },
  "expected": {
    object (Expected)
  }
}
שדות
prompt

object (Prompt)

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

object (Scene)

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

object (Session)

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

object (User)

זה שינוי אופציונלי. משמש לציון פרמטרים של משתמשים לשליחה חזרה.
home

object (Home)

זה שינוי אופציונלי. משמש לציון פרמטרים שקשורים למבנה Home Graph שאליו שייך מכשיר היעד. מידע נוסף זמין בכתובת https://developers.google.com/actions/smarthome/concepts/homegraph.
device

object (Device)

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

object (Expected)

זה שינוי אופציונלי. מתאר את הציפיות לפנייה הבאה בתיבת הדו-שיח.

מטפל

מייצג גורם handler של מילוי הזמנות שממפה את פרטי האירוע מ-Actions on Google למילוי הזמנות. משתמשים בשם ה-handler כדי לקבוע איזה קוד צריך להריץ במילוי ההזמנות. לדוגמה, handler עשוי לשמש לקבלת מידע על פרטי הזמנה של משתמש, עם שם של handler, כמו "OrderLookup". ואילו מודל אחר עשוי לקבל פרטי מוצר ממסד נתונים, עם שם handler כמו "GetProductInfo".

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

string

זה שינוי אופציונלי. שם ה-handler.

כוונת רכישה

מייצג כוונה. מידע נוסף מופיע בכתובת https://developers.google.com/assistant/conversational/intents.

ייצוג JSON 
{
  "name": string,
  "params": {
    string: {
      object (IntentParameterValue)
    },
    ...
  },
  "query": string
}
שדות
name

string

חובה. השם של ה-Intent האחרון שנמצאה בו התאמה.
params

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

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

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

string

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

IntentParameterValue

מייצג ערך של פרמטר Intent. מידע נוסף זמין בכתובת https://developers.google.com/assistant/conversational/types.

ייצוג JSON 
{
  "original": string,
  "resolved": value
}
שדות
original

string

חובה. ערך הטקסט המקורי חולץ מביטוי המשתמש.
resolved

value (Value format)

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

סצינה

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

ייצוג JSON 
{
  "name": string,
  "slotFillingStatus": enum (SlotFillingStatus),
  "slots": {
    string: {
      object (Slot)
    },
    ...
  },
  "next": {
    object (NextScene)
  }
}
שדות
name

string

חובה. השם של הסצנה הנוכחית.
slotFillingStatus

enum (SlotFillingStatus)

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

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

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

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

object (NextScene)

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

SlotFillingStatus

הסטטוס הנוכחי של מילוי המשבצות.

טיפוסים בני מנייה (enum)
UNSPECIFIED ערך חלופי כששדה השימוש לא מאוכלס.
INITIALIZED המשבצות אותחלו, אבל מילוי המשבצות לא התחיל.
COLLECTING המערכת אוספת את ערכי המשבצות.
FINAL כל הערכים של מיקומי המודעות הם סופיים ואי אפשר לשנות אותם.

משבצת

מייצג משבצת.

ייצוג JSON 
{
  "mode": enum (SlotMode),
  "status": enum (SlotStatus),
  "value": value,
  "updated": boolean,
  "prompt": {
    object (Prompt)
  }
}
שדות
mode

enum (SlotMode)

המצב של יחידת הקיבולת (חובה או אופציונלי). אפשר להגדיר זאת על ידי המפתח.
status

enum (SlotStatus)

הסטטוס של המשבצת.
value

value (Value format)

הערך של המשבצת. שינוי של הערך הזה בתשובה ישנה את הערך במילוי המשבצות.
updated

boolean

שדה זה מציין אם הערך של יחידת הקיבולת (Slot) נאסף בפנייה האחרונה. השדה הזה הוא לקריאה בלבד.
prompt

object (Prompt)

זה שינוי אופציונלי. ההנחיה הזאת נשלחת למשתמש כשצריך למלא את המשבצת הנדרשת. ההנחיה הזאת מבטלת את ההנחיה הקיימת שמוגדרת במסוף. השדה הזה לא נכלל בבקשת ה-webhook.

SlotMode

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

טיפוסים בני מנייה (enum)
MODE_UNSPECIFIED ערך חלופי כששדה השימוש לא מאוכלס.
OPTIONAL מציין שהמשבצת לא נדרשת כדי להשלים את מילוי המשבצות.
REQUIRED מציין שהמשבצת נדרשת כדי להשלים את מילוי המשבצות.

SlotStatus

הסטטוס של יחידת הקיבולת.

טיפוסים בני מנייה (enum)
SLOT_UNSPECIFIED ערך חלופי כששדה השימוש לא מאוכלס.
EMPTY מציין שהמשבצת לא מכילה ערכים. אי אפשר לשנות את הסטטוס הזה באמצעות התשובה.
INVALID מציין שערך המיקום לא חוקי. אפשר לשנות את הסטטוס הזה באמצעות התשובה.
FILLED מציין שלמשבצת יש ערך. אי אפשר לשנות את הסטטוס הזה באמצעות התשובה.

הנחיה

ייצוג תגובה למשתמש. מידע נוסף מופיע בכתובת https://developers.google.com/assistant/conversational/prompts.

ייצוג JSON 
{
  "override": boolean,
  "firstSimple": {
    object (Simple)
  },
  "content": {
    object (Content)
  },
  "lastSimple": {
    object (Simple)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (Link)
  },
  "canvas": {
    object (Canvas)
  },
  "orderUpdate": {
    object (OrderUpdate)
  }
}
שדות
override

boolean

זה שינוי אופציונלי. מצב לאופן שבו יש למזג את ההודעות האלה עם הודעות שהוגדרו קודם לכן. "true" ניקוי כל ההודעות שהוגדרו קודם לכן (הראשונה והאחרונה, תוכן, קישור להצעות וקנבס) והוספה של הודעות שהוגדרו בהנחיה הזו. "false" הוספה של הודעות שהוגדרו בהנחיה הזו להודעות שהוגדרו בתשובות הקודמות. השארת השדה הזה בסטטוס 'לא נכון' מאפשרת גם להוסיף לשדות מסוימים הנחיות פשוטות, את ההנחיה 'הצעות' ואת ההנחיה של לוח הציור (חלק משורת התוכן). הודעות התוכן והקישור תמיד מוחלפות אם הן מוגדרות בהנחיה. ערך ברירת המחדל הוא 'false'.
firstSimple

object (Simple)

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

object (Content)

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

object (Simple)

זה שינוי אופציונלי. התשובה האחרונה מסוג טקסט וקול.
suggestions[]

object (Suggestion)

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

object (Canvas)

זה שינוי אופציונלי. מייצג תגובה אינטראקטיבית של לוח הציור שתישלח למשתמש.
orderUpdate

object (OrderUpdate)

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

פשוט

מייצג הנחיה פשוטה שצריך לשלוח למשתמש. מידע נוסף מופיע בכתובת https://developers.google.com/assistant/conversational/prompts-simple.

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

string

זה שינוי אופציונלי. מייצג את הדיבור שיש לומר למשתמש. הקובץ יכול להיות בפורמט SSML או המרת טקסט לדיבור (TTS). אם האפשרות 'ביטול השינוי' בשדה שמכיל את ההנחיה הוא 'true', הדיבור שהוגדר בשדה יחליף את הדיבור בהנחיה הפשוטה הקודמת. פרטים נוספים זמינים בכתובת https://developers.google.com/assistant/conversational/ssml.
text

string

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

תוכן

אובייקט קונטיינר להנחיות עשירות או להנחיות בחירה.

ייצוג JSON 
{

  // Union field content can be only one of the following:
  "card": {
    object (Card)
  },
  "image": {
    object (Image)
  },
  "table": {
    object (Table)
  },
  "media": {
    object (Media)
  },
  "collection": {
    object (Collection)
  },
  "list": {
    object (List)
  },
  "collectionBrowse": {
    object (CollectionBrowse)
  }
  // End of list of possible types for union field content.
}
שדות

שדה איחוד content.

content יכול להיות רק אחת מהאפשרויות הבאות:
card

object (Card)

כרטיס בסיסי.
image

object (Image)

תמונה.
table

object (Table)

כרטיס טבלה.
media

object (Media)

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

object (Collection)

כרטיס שמציג אוסף של אפשרויות לבחירה.
list

object (List)

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

object (CollectionBrowse)

כרטיס שמציג אוסף של דפי אינטרנט לפתיחה.

קלפים

כרטיס בסיסי להצגה של מידע מסוים, למשל תמונה ו/או טקסט. מידע נוסף מופיע בכתובת https://developers.google.com/assistant/conversational/prompts-rich#basic_card.

ייצוג JSON 
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (Image)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (Link)
  }
}
שדות
title

string

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

string

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

string

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

object (Image)

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

enum (ImageFill)

איך הרקע של התמונה יתמלא. זה שינוי אופציונלי.
button

object (Link)

לחצן עם קישור לאתר אחר. זה שינוי אופציונלי.

תמונה

תמונה שמוצגת בכרטיס. מידע נוסף מופיע בכתובת https://developers.google.com/assistant/conversational/prompts-rich#image-cards.

ייצוג JSON 
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
שדות
url

string

כתובת ה-URL של המקור של התמונה. התמונות יכולות להיות JPG, PNG ו-GIF (מונפשות ולא מונפשות). לדוגמה,https://www.agentx.com/logo.png חובה.
alt

string

תיאור טקסטואלי של התמונה שישמש לצורך נגישות, לדוגמה. בקוראי מסך. חובה.
height

integer

גובה התמונה בפיקסלים. זה שינוי אופציונלי.
width

integer

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

ImageFill

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

טיפוסים בני מנייה (enum)
UNSPECIFIED
GRAY ממלאים את הפערים בין התמונה לבין מאגר התמונה באמצעות פסים אפורים.
WHITE ממלאים את הפערים בין התמונה לבין מאגר התמונה באמצעות פסים לבנים.
CROPPED קנה המידה של התמונה מוגדל כך שרוחב התמונה והגובה שלה יהיו זהים למידות המכל, או יחרגו מהן. במקרה כזה, התמונה עשויה לחתוך את החלק העליון והתחתון של התמונה אם גובה התמונה המותאם אישית גדול מגובה המכל. לחלופין, ניתן לחתוך את התמונה השמאלית והימנית אם רוחב התמונה המותאמת גדול מרוחב המאגר. הפעולה הזו דומה ל'מצב זום' בטלוויזיה במסך רחב בעת הפעלת סרטון 4:3.

OpenUrl

ייצוג JSON 
{
  "url": string,
  "hint": enum (UrlHint)
}
שדות
url

string

שדה כתובת האתר שיכול להיות כל אחת מהאפשרויות: - כתובות URL מסוג http או https לפתיחת אפליקציה או דף אינטרנט שמקושרים לאפליקציה
hint

enum (UrlHint)

מציין רמז לסוג כתובת ה-URL.

UrlHint

סוגים שונים של רמזים לכתובות URL.

טיפוסים בני מנייה (enum)
AMP כתובת URL שמפנה ישירות לתוכן AMP או לכתובת URL קנונית שמפנה לתוכן AMP דרך . פרטים נוספים זמינים בכתובת https://amp.dev/.

טבלה

כרטיס טבלה להצגת טבלה של טקסט. מידע נוסף מופיע בכתובת https://developers.google.com/assistant/conversational/prompts-rich#table_cards.

ייצוג JSON 
{
  "title": string,
  "subtitle": string,
  "image": {
    object (Image)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (Link)
  }
}
שדות
title

string

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

string

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

object (Image)

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

object (TableColumn)

כותרות ויישור עמודות.
rows[]

object (TableRow)

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

object (Link)

לחצן.

TableColumn

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

string

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

enum (HorizontalAlignment)

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

HorizontalAlignment

היישור של התוכן בתא.

טיפוסים בני מנייה (enum)
UNSPECIFIED
LEADING הקצה הראשי של התא. (זוהי ברירת המחדל)
CENTER התוכן מיושר למרכז העמודה.
TRAILING התוכן מיושר לקצה האחרון של העמודה.

TableRow

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

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

object (TableCell)

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

boolean

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

TableCell

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

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

string

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

מדיה

מייצג אובייקט מדיה אחד. מידע על המדיה, כמו שם, תיאור, כתובת URL וכו'. מידע נוסף זמין בכתובת https://developers.google.com/assistant/conversational/prompts-media.

ייצוג JSON 
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ],
  "repeatMode": enum (RepeatMode),
  "firstMediaObjectIndex": integer
}
שדות
mediaType

enum (MediaType)
startOffset

string (Duration format)

היסט ההתחלה של אובייקט המדיה הראשון.

משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s'. לדוגמה: "3.5s".
optionalMediaControls[]

enum (OptionalMediaControls)

סוגים אופציונליים של פקדי מדיה שבהם הסשן הזה יכול לתמוך. אם המדיניות מוגדרת, הבקשה תישלח לצד שלישי כשיתרחש אירוע מדיה מסוים. אם לא מוגדרת, ה-3p עדיין צריך לטפל בשני סוגי בקרה שמוגדרים כברירת מחדל: FINISHED ו-FAILED.
mediaObjects[]

object (MediaObject)

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

enum (RepeatMode)

מצב החזרה של רשימת האובייקטים של המדיה.
firstMediaObjectIndex

integer

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

MediaType

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

טיפוסים בני מנייה (enum)
MEDIA_TYPE_UNSPECIFIED
AUDIO קובץ אודיו.
MEDIA_STATUS_ACK תשובה לאישור דוח סטטוס מדיה.

OptionalMediaControls

סוגים אופציונליים של פקדי מדיה שתגובת המדיה יכולה לתמוך בהם

טיפוסים בני מנייה (enum)
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED ערך לא מוגדר
PAUSED האירוע הושהה. מופעל כשהמשתמש משהה את המדיה.
STOPPED האירוע הופסק. מופעל כשהמשתמש יוצא מסשן של צד שלישי במהלך הפעלת מדיה.

MediaObject

מייצג אובייקט מדיה יחיד

ייצוג JSON 
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
שדות
name

string

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

string

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

string

כתובת ה-URL שמפנה לתוכן המדיה. קובצי MP3 צריכים להתארח בשרת אינטרנט ולהיות זמינים לציבור דרך כתובת URL מסוג HTTPS. סטרימינג בשידור חי נתמך רק בפורמט MP3.
image

object (MediaImage)

תמונה להצגה עם כרטיס המדיה.

MediaImage

ייצוג JSON 
{

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

שדה איחוד image.

image יכול להיות רק אחת מהאפשרויות הבאות:
large

object (Image)

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

object (Image)

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

RepeatMode

סוגי מצב החזרה של רשימת אובייקטים של מדיה.

טיפוסים בני מנייה (enum)
REPEAT_MODE_UNSPECIFIED זהה למצב 'כבוי'.
OFF סיום סשן המדיה בסוף אובייקט המדיה האחרון.
ALL הגעה בלולאה לתחילת אובייקט המדיה הראשון כשמגיעים לסופו של אובייקט המדיה האחרון.

אוסף

כרטיס להצגת אוסף של אפשרויות לבחירה. פרטים נוספים זמינים בכתובת https://developers.google.com/assistant/conversational/prompts-selection#collection

ייצוג JSON 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
שדות
title

string

שם האוסף. זה שינוי אופציונלי.
subtitle

string

כותרת המשנה של האוסף. זה שינוי אופציונלי.
items[]

object (CollectionItem)

רשימת פריטים. אפשר להזין עד 2 עד 10.
imageFill

enum (ImageFill)

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

CollectionItem

פריט באוסף

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

string

חובה. מפתח ה-NLU שתואם לשם של מפתח הכניסה בסוג המשויך.

רשימה

כרטיס להצגת רשימה של אפשרויות לבחירה. פרטים נוספים זמינים בכתובת https://developers.google.com/assistant/conversational/prompts-selection#list

ייצוג JSON 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
שדות
title

string

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

string

כותרת המשנה של הרשימה. זה שינוי אופציונלי.
items[]

object (ListItem)

רשימת פריטים. אפשר להזין עד 2 עד 30.

ListItem

פריט ברשימה

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

string

חובה. מפתח ה-NLU שתואם לשם של מפתח הכניסה בסוג המשויך.

CollectionBrowse

מציג קבוצה של מסמכי אינטרנט כאוסף של פריטים בפורמט אריחים גדולים. ניתן לבחור פריטים כדי לפתוח את מסמך האינטרנט המשויך שלהם במציג אינטרנט. פרטים נוספים זמינים בכתובת https://developers.google.com/assistant/conversational/prompts-selection#collectionBrowse.

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

object (Item)

רשימת פריטים. אפשר להזין עד 2 עד 10.
imageFill

enum (ImageFill)

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

פריט

פריט באוסף.

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

string

חובה. השם של פריט האוסף.
description

string

תיאור של פריט האוסף.
footer

string

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

object (Image)

תמונה של הפריט באוסף.
openUriAction

object (OpenUrl)

חובה. URI לפתיחה אם הפריט נבחר.

הצעה

ההצעות מספקות למשתמשים צ'יפים של הצעות במכשירים עם יכולות תצוגה, כש-Assistant מציגה את ההודעה. תוכלו להשתמש בצ'יפים של הצעות כדי לרמוז על תגובות המשתמשים כדי להמשיך את השיחה או לשנות את הכיווניות שלה. כשמקישים עליה, צ'יפ ההצעה מחזיר את הטקסט שמוצג לשיחה מילה במילה, כאילו המשתמש הקליד אותו. אפשר לעיין בכתובת https://developers.google.com/assistant/conversational/prompts#suggestions,

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

string

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

קנבס

מייצג תגובה אינטראקטיבית של לוח הציור שתישלח למשתמש. אפשר להשתמש באפשרות הזו בשילוב עם "firstSple" בשדה שמכיל את ההנחיה כדי לדבר אל המשתמש, בנוסף להצגת תגובה אינטראקטיבית של אזור העריכה. הגודל המקסימלי של התגובה הוא 50,000 בייטים. מידע נוסף זמין בכתובת https://developers.google.com/assistant/interactivecanvas.

ייצוג JSON 
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "continuousMatchConfig": {
    object (ContinuousMatchConfig)
  }
}
שדות
url

string

כתובת ה-URL של אפליקציית האינטרנט של לוח הציור האינטראקטיבי לטעינה. אם המדיניות לא מוגדרת, ייעשה שימוש חוזר בכתובת ה-URL מאזור העריכה הפעיל הנוכחי.
data[]

value (Value format)

זה שינוי אופציונלי. נתוני JSON שיועברו לדף האינטרנט של החוויה העשירה כאירוע. אם האפשרות 'ביטול השינוי' בשדה המכיל את ההנחיה הוא 'FALSE' ערכי הנתונים שמוגדרים בהודעה הזו על קנבס יתווספו אחרי ערכי הנתונים שהוגדרו בהנחיות הקודמות של לוח הציור.
suppressMic

boolean

זה שינוי אופציונלי. ערך ברירת המחדל: false.
continuousMatchConfig

object (ContinuousMatchConfig)

ההגדרות האישיות שמשמשות להפעלת מצב התאמה רציפה (CD)

ContinuousMatchConfig

ההגדרות האישיות שמשמשות להפעלת מצב התאמה רציפה (CD)

ייצוג JSON 
{
  "expectedPhrases": [
    {
      object (ExpectedPhrase)
    }
  ],
  "durationSeconds": integer
}
שדות
expectedPhrases[]

object (ExpectedPhrase)

כל הביטויים הצפויים האפשריים במהלך הסשן הזה של מצב ההתאמה המתמשכת.
durationSeconds

integer

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

ExpectedPhrase

ייצוג JSON 
{
  "phrase": string,
  "alternativePhrases": [
    string
  ]
}
שדות
phrase

string

הביטוי שצריך להתאים במהלך סשן במצב התאמה רציפה.
alternativePhrases[]

string

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

OrderUpdate

צריך לעדכן את ההזמנה.

ייצוג JSON 
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
שדות
type
(deprecated)

enum (Type)

הוצא משימוש: במקומו, אפשר להשתמש ב-OrderUpdate.update_mask. אם type = SNAPSHOT, הפונקציה OrderUpdate.order צריכה להיות כל ההזמנה. אם הסוג = ORDER_STATUS, זהו השינוי בסטטוס ההזמנה. בוחרים רק את הפרמטר order.last_update_time והסטטוס האנכי הזה. הערה: type.ORDER_STATUS תומך רק בעדכוני סטטוס של PucahaseOrderExtension ואין תוכנית להרחיב את התמיכה הזו. במקום זאת, מומלץ להשתמש ב-updateMask כי היא שיטה כללית יותר, ניתנת להרחבה ואפשר להשתמש בה בכל הענפים.
order

object (Order)
updateMask

string (FieldMask format)

הערה: יש שיקולים/המלצות נוספים בשדות המיוחדים הבאים: 1. order.last_update_time יעודכן תמיד כחלק מבקשת העדכון. המערכת תתעלם מ-order.create_time, order.google_order_id ו-order.merchant_order_id אם יסופק כחלק מה-updateMask.

זוהי רשימה מופרדת בפסיקים של שמות שדות מלאים. דוגמה: "user.displayName,photo"
userNotification

object (UserNotification)

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

string

הסיבה לשינוי או לעדכון.

סוג

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

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג לא צוין, אין להגדיר זאת באופן מפורש.
ORDER_STATUS יש לעדכן רק את סטטוס ההזמנה.
SNAPSHOT עדכון תמונת המצב של ההזמנה.

הזמנה

ישות ההזמנה. הערה: 1. כל המחרוזות בכל הרמות חייבות להיות באורך של פחות מ-1,000 תווים, אלא אם צוין אחרת. 2. מספר השדות החוזרים בכל הרמות חייב להיות קטן מ-50, אלא אם צוין אחרת. 3. כל חותמות הזמן בכל הרמות, אם צוינו, חייבות להיות חותמות זמן חוקיות.

ייצוג JSON 
{
  "googleOrderId": string,
  "merchantOrderId": string,
  "userVisibleOrderId": string,
  "userVisibleStateLabel": string,
  "buyerInfo": {
    object (UserInfo)
  },
  "image": {
    object (Image)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "transactionMerchant": {
    object (Merchant)
  },
  "contents": {
    object (Contents)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "paymentData": {
    object (PaymentData)
  },
  "termsOfServiceUrl": string,
  "note": string,
  "promotions": [
    {
      object (Promotion)
    }
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseOrderExtension)
  },
  "ticket": {
    object (TicketOrderExtension)
  }
  // End of list of possible types for union field verticals.
}
שדות
googleOrderId

string

מזהה ההזמנה ש-Google הקצתה.
merchantOrderId

string

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

string

המזהה שגלוי למשתמש שמתייחס להזמנה הנוכחית. המזהה הזה צריך להיות תואם למזהה שמוצג להזמנה הזו בהקשרים אחרים, כולל אתרים, אפליקציות ואימייל.
userVisibleStateLabel
(deprecated)

string

הוצא משימוש: יש להשתמש בסטטוס Orderתוספים במקום זאת. תווית גלויה למשתמש של מצב ההזמנה הזו.
buyerInfo

object (UserInfo)

מידע על הקונה.
image

object (Image)

תמונה שמשויכת להזמנה.
createTime

string (Timestamp format)

חובה: התאריך והשעה שבהם ההזמנה נוצרה.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
lastUpdateTime

string (Timestamp format)

התאריך והשעה שבהם ההזמנה עודכנה לאחרונה. נדרש עבור OrderUpdate.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
transactionMerchant

object (Merchant)

המוכר שאימץ את תהליך התשלום. זה יכול להיות שונה מספק ברמת הפריט. דוגמה: הזמנת Expedia עם פריט מ-ANA.
contents

object (Contents)

חובה: תוכן ההזמנה הוא קבוצה של פריטים.
priceAttributes[]

object (PriceAttribute)

מחיר, הנחות, מיסים וכו'.
followUpActions[]

object (Action)

פעולות המשך ברמת ההזמנה.
paymentData

object (PaymentData)

נתונים שקשורים לתשלום בהזמנה.
termsOfServiceUrl

string

קישור לתנאים ולהגבלות שחלים על ההזמנה/ההצעה.
note

string

פתקים שמצורפים להזמנה.
promotions[]

object (Promotion)

כל המבצעים שמשויכים להזמנה הזו.
disclosures[]

object (Disclosure)

גילוי נאות שמשויך להזמנה הזו.
vertical
(deprecated)

object

הוצא משימוש: במקום זאת, יש להשתמש בפורמט אנכי. המאפיינים האלה יחולו על כל הפריטים, אלא אם הם יבוטלו בפריט מסוים. הקטגוריה הזו צריכה להתאים לסוג האנכי ברמת הפריט. ערכים אפשריים: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

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

object (PurchaseOrderExtension)

הזמנת רכש
ticket

object (TicketOrderExtension)

הזמנת כרטיס

UserInfo

מידע על המשתמש. משמש לייצוג מידע על המשתמש שמשויך להזמנה.

ייצוג JSON 
{
  "email": string,
  "firstName": string,
  "lastName": string,
  "displayName": string,
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ]
}
שדות
email

string

כתובת האימייל של המשתמש, לדוגמה: janedoe@gmail.com.
firstName

string

השם הפרטי של המשתמש.
lastName

string

שם המשפחה של המשתמש.
displayName

string

השם המוצג של המשתמש, יכול להיות שונה מהשם הפרטי או מהשם המשפחה.
phoneNumbers[]

object (PhoneNumber)

מספרי הטלפון של המשתמש.

מספר טלפון

ייצוג סטנדרטי של מספר טלפון.

ייצוג JSON 
{
  "e164PhoneNumber": string,
  "extension": string,
  "preferredDomesticCarrierCode": string
}
שדות
e164PhoneNumber

string

מספר טלפון בפורמט E.164, כפי שמוגדר בהמלצה E.164 של איגוד הטלקומוניקציה הבינלאומי (ITU). קישור ל-wiki: https://en.wikipedia.org/wiki/E.164
extension

string

התוסף לא סטנדרטי בהמלצות ITU, למעט שהן מוגדרות כסדרת מספרים עם אורך מקסימלי של 40 ספרות. היא מוגדרת כמחרוזת כאן כדי לאפשר שימוש אפשרי באפס בתחילת התוסף (לארגונים יש חופש מלא לעשות זאת, מכיוון שלא הוגדר תקן). מלבד ספרות, תווי חיוג אחרים כגון "," (מצביע על המתנה) ייתכן שיאוחסן כאן. לדוגמה, ב-xxx-xxx-xxxx. 123, "123" הוא התוסף.
preferredDomesticCarrierCode

string

קוד בחירת הספק המועדף כשמתקשרים למספר טלפון מקומי. בכך נכללים גם קודים שצריך לחייג במדינות מסוימות כאשר מתקשרים מטלפונים נייחים לניידים, או להפך. לדוגמה, בקולומביה, המספר "3" צריך לחייג לפני מספר הטלפון עצמו כשמתקשרים מטלפון נייד לטלפון קווי מקומי ולהפך. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code

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

תמונה

תמונה שמוצגת בכרטיס.

ייצוג JSON 
{
  "url": string,
  "accessibilityText": string,
  "height": integer,
  "width": integer
}
שדות
url

string

כתובת ה-URL של המקור של התמונה. התמונות יכולות להיות JPG, PNG ו-GIF (מונפשות ולא מונפשות). לדוגמה,https://www.agentx.com/logo.png חובה.
accessibilityText

string

תיאור טקסטואלי של התמונה שישמש לצורך נגישות, לדוגמה. בקוראי מסך. חובה.
height

integer

גובה התמונה בפיקסלים. זה שינוי אופציונלי.
width

integer

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

מוֹכר

המוֹכר של עגלת הקניות/ההזמנה/הפריט.

ייצוג JSON 
{
  "id": string,
  "name": string,
  "image": {
    object (Image)
  },
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "address": {
    object (Location)
  }
}
שדות
id

string

מזהה אופציונלי שהוקצה למוכר, אם יש כזה.
name

string

שם המוכר, למשל "Panera Bread".
image

object (Image)

התמונה שמשויכת למוֹכר.
phoneNumbers[]

object (PhoneNumber)

מספרי טלפון של מוכרים.
address

object (Location)

הכתובת של המוכר.

מיקום

מאגר שמייצג מיקום.

ייצוג JSON 
{
  "coordinates": {
    object (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "name": string,
  "phoneNumber": string,
  "notes": string,
  "placeId": string
}
שדות
coordinates

object (LatLng)

קואורדינטות גיאוגרפיות. נדרש [DEVICE_PRECISE_LOCATION] ההרשאה [google.actions.v2.permission.DEVICE_PRECISE_LOCATION].
formattedAddress

string

כתובת לתצוגה, למשל " 1600 Amphitheatre Pkwy, Mountain View, CA 94043". נדרש [DEVICE_PRECISE_LOCATION] ההרשאה [google.actions.v2.permission.DEVICE_PRECISE_LOCATION].
zipCode

string

מיקוד. נדרש [DEVICE_PRECISE_LOCATION] [google.actions.v2.permission.DEVICE_PRECISE_LOCATION] או [DEVICE_COARSE_LOCATION] ההרשאה [google.actions.v2.permission.DEVICE_COARSE_LOCATION].
city

string

עיר. נדרש [DEVICE_PRECISE_LOCATION] [google.actions.v2.permission.DEVICE_PRECISE_LOCATION] או [DEVICE_COARSE_LOCATION] ההרשאה [google.actions.v2.permission.DEVICE_COARSE_LOCATION].
postalAddress

object (PostalAddress)

כתובת לדברי דואר. נדרש [DEVICE_PRECISE_LOCATION] [google.actions.v2.permission.DEVICE_PRECISE_LOCATION] או [DEVICE_COARSE_LOCATION] ההרשאה [google.actions.v2.permission.DEVICE_COARSE_LOCATION].
name

string

שם המקום.
phoneNumber

string

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

string

הערות לגבי המיקום.
placeId

string

השדה PlaceId משמש ב-Places API כדי לאחזר פרטים של מקום. מידע נוסף זמין בכתובת https://developers.google.com/places/web-service/place-id

LatLng

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

ייצוג JSON 
{
  "latitude": number,
  "longitude": number
}
שדות
latitude

number

קו הרוחב במעלות. הוא חייב להיות בטווח [-90.0, +90.0].
longitude

number

קו האורך במעלות. הוא חייב להיות בטווח [-180.0, +180.0].

PostalAddress

מייצג כתובת למשלוח דואר, למשל עבור כתובות למשלוח דואר או תשלומים. אם תספקו כתובת למשלוח דואר, שירות הדואר יכול לשלוח פריטים לעסק שלכם, P.O. Box או דומה. הוא לא נועד לבנות מודלים של מיקומים גיאוגרפיים (כבישים, ערים, הרים).

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

עצות לגבי קלט / עריכה של כתובת: - השתמשו בווידג'ט של כתובת שמוכן ל-i18n כמו https://github.com/google/libaddressinput) - אסור להציג למשתמשים רכיבי ממשק משתמש לקלט או לעריכה של שדות מחוץ למדינות שבהן השדה הזה נמצא בשימוש.

הנחיות נוספות לשימוש בסכימה הזו זמינות בכתובת https://support.google.com/business/answer/6397478

ייצוג JSON 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
שדות
revision

integer

הגרסה הקודמת של הסכימה של PostalAddress. יש להגדיר את הערך כ-0, שהוא הגרסה האחרונה.

כל הגרסאות החדשות חייבות להיות תואמות לאחור לגרסאות קודמות.
regionCode

string

חובה. קוד האזור במאגר CLDR של המדינה או האזור של הכתובת. אף פעם לא מסיקים את זה, ובאחריות המשתמש לוודא שהערך נכון. פרטים נוספים זמינים בכתובת http://cldr.unicode.org/ ובכתובת http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. דוגמה: 'CH' עבור שווייץ.
languageCode

string

זה שינוי אופציונלי. קוד שפה BCP-47 של תוכן הכתובת הזו (אם ידוע). לרוב זוהי שפת ממשק המשתמש של טופס הקלט, או שהיא אמורה להתאים לאחת מהשפות שציינת בכתובת מדינה/אזור, או את המקבילים בתעתיק שלהם. הפעולה הזו יכולה להשפיע על הפורמט במדינות מסוימות, אבל היא לא קריטית לנכונות של הנתונים ולא תשפיע אף פעם על אימות או על פעולות אחרות שלא קשורות לעיצוב.

אם הערך לא ידוע, יש להשמיט אותו (במקום לציין ברירת מחדל שעשויה להיות שגויה).

דוגמאות: 'zh-Hant', 'ja', 'ja-Latn', 'en'.
postalCode

string

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

string

זה שינוי אופציונלי. קוד מיון נוסף ספציפי למדינה. ברוב האזורים לא נעשה שימוש בהרשאה הזו. במקומות שבהם משתמשים בו, הערך הוא מחרוזת כמו CEDEX, ואחריו מספר (למשל CEDEX 7) או מספר בלבד, שמייצג את 'קוד המגזר'. (ג'מייקה), "אינדיקטור אזור למשלוחים" (מלאווי) או "אינדיקטור של סניף דואר" (למשל, חוף השנהב).
administrativeArea

string

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

string

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

string

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

string

שורות כתובת לא מובנות, שמתארות את הרמות הנמוכות יותר של כתובת.

מכיוון שערכים ב-addressLines לא כוללים פרטי סוג ולפעמים הם עשויים להכיל ערכים מרובים בשדה יחיד (למשל "Austin, TX"), חשוב שסדר השורות יהיה ברור. סדר שורות הכתובת צריך להיות "סדר מעטפה" עבור המדינה/האזור של הכתובת. במקומות שבהם הערך הזה יכול להשתנות (למשל, יפן), משתמשים ב-address_language כדי לציין אותה באופן מפורש (למשל 'ja' לסידור מהגדול לקטן ו-'ja-Latn' או 'en' לקטן לגדול). כך ניתן לבחור את שורת הכתובת הספציפית ביותר בהתאם לשפה.

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

יצירת כתובת שמכילה רק regionCode ושורות כתובת, ולאחר מכן קידוד גיאוגרפי היא הדרך המומלצת לטיפול בכתובות לא מובנות לחלוטין (בניגוד לניחוש אילו חלקים של הכתובת צריכים להיות רשויות מוניציפאליות או אזורים מנהליים).
recipients[]

string

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

string

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

תוכן עניינים

wrapper של פריטים.

ייצוג JSON 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
שדות
lineItems[]

object (LineItem)

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

LineItem

פריט אחד מכיל אנכי אחד. הזמנה או עגלת קניות יכולים לכלול מספר פריטים מאותה קטגוריה. יש להגדיר פריטים/תוספים וכו' של שורת משנה בפרוטוקולים אנכיים בהתאם לתרחישי השימוש שלהם. הערה: 1. כל המחרוזות בכל הרמות חייבות להיות באורך של פחות מ-1,000 תווים, אלא אם צוין אחרת. 2. מספר השדות החוזרים בכל הרמות חייב להיות קטן מ-50, אלא אם צוין אחרת. 3. כל חותמות הזמן בכל הרמות, אם צוינו, חייבות להיות חותמות זמן חוקיות.

ייצוג JSON 
{
  "id": string,
  "name": string,
  "userVisibleStateLabel": string,
  "provider": {
    object (Merchant)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "recipients": [
    {
      object (UserInfo)
    }
  ],
  "image": {
    object (Image)
  },
  "description": string,
  "notes": [
    string
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseItemExtension)
  },
  "reservation": {
    object (ReservationItemExtension)
  }
  // End of list of possible types for union field verticals.
}
שדות
id

string

חובה: מזהה שהוקצה לפריט על ידי המוכר. משמש לזיהוי פריט קיים בהחלת עדכונים חלקיים. האורך המקסימלי הוא 64 תווים.
name

string

שם הפריט כפי שמוצג בקבלה. האורך המקסימלי המותר הוא 100 תווים.
userVisibleStateLabel
(deprecated)

string

הוצא משימוש. במקום זאת, אפשר להשתמש בסטטוס ברמה האנכית. לדוגמה, לרכישות, משתמשים ב-PurchaseOrderExtension.status. תווית גלויה למשתמש למצב הפריט הזה.
provider

object (Merchant)

הספק של הפריט הספציפי, אם הוא שונה מההזמנה הכוללת. דוגמה: הזמנת Expedia עם ספק הפריט ANA.
priceAttributes[]

object (PriceAttribute)

מחיר והתאמות ברמת הפריט.
followUpActions[]

object (Action)

פעולות המשך בפריט.
recipients[]

object (UserInfo)

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

object (Image)

תמונה קטנה שמשויכת לפריט הזה, אם יש כזה.
description

string

תיאור הפריט.
notes[]

string

הערות נוספות שרלוונטיות לפריט הספציפי הזה, לדוגמה מדיניות ביטולים.
disclosures[]

object (Disclosure)

גילוי נאות שמשויך לפריט הזה.
vertical
(deprecated)

object

הוצא משימוש: במקום זאת, יש להשתמש בפורמט אנכי. חובה: התוכן הסמנטי של הפריט על סמך הסוג או הענף שלו. כל קטגוריה צריכה לכלול פרטי מילוי הזמנות משלה. חייב להיות אחד מהערכים הבאים: google.actions.orders.v3.verticals.purchase.PurchaseItemExtension google.actions.orders.v3.verticals.reservation.ReservationItemExtension google.actions.orders.v3.verticals.ticket.TicketItemExtension

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

object (PurchaseItemExtension)

הזמנות רכש כמו מוצרים, אוכל וכו'
reservation

object (ReservationItemExtension)

הזמנות מקום, כמו מסעדה, תספורת וכו'

PriceAttribute

מאפיין המחיר של הזמנה או של פריט.

ייצוג JSON 
{
  "type": enum (Type),
  "name": string,
  "id": string,
  "state": enum (State),
  "taxIncluded": boolean,

  // Union field spec can be only one of the following:
  "amount": {
    object (Money)
  },
  "amountMillipercentage": integer
  // End of list of possible types for union field spec.
}
שדות
type

enum (Type)

חובה: מאפיין סוג הכסף.
name

string

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

string

אופציונלי: מזהה של הפריט שהמחיר הזה תואם לו.
state

enum (State)

חובה: מצב המחיר: הערכה לעומת הערך בפועל.
taxIncluded

boolean

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

object (Money)

סכום כספי.
amountMillipercentage
(deprecated)

integer

מפרט האחוזים, ל-1/1,000 מהאחוז. לדוגמה: 8.750% מיוצג כ-8750, באחוזים שליליים מייצגים הנחות באחוזים. אנחנו מוציאים את השדה הזה משימוש. כדאי להוסיף חזרה כאשר יש צורך בתרחיש לדוגמה מוצק.

סוג

מייצג את סוג הכסף.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED הסוג לא צוין, הלקוחות לא צריכים להגדיר אותו במפורש.
REGULAR המחיר הרגיל בתצוגה, לפני שאנחנו מחילים הנחות וכו'.
DISCOUNT לניכוי מסכום הביניים.
TAX כדי להתווסף לסיכום הביניים.
DELIVERY כדי להתווסף לסיכום הביניים.
SUBTOTAL סכום ביניים, לפני שיתווספו עמלות.
FEE כל עמלה נוספת.
GRATUITY כדי להתווסף לסיכום הביניים.
TOTAL המחיר המוצג של ההזמנה או הפריט.

מדינה

מייצג את מצב המחיר.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לא צוין.
ESTIMATE המחיר הוא אומדן בלבד, אבל הסכום הסופי יהיה קרוב לסכום הזה. דוגמה: במקרים שבהם סכום המס לא ידוע במדויק בזמן העסקה, הסכום הכולל יהיה סכום משוער.
ACTUAL המחיר בפועל שיחויב עבור המשתמש.

כסף

מייצג סכום כסף בסוג המטבע שלו.

ייצוג JSON 
{
  "currencyCode": string,
  "amountInMicros": string
}
שדות
currencyCode

string

קוד מטבע בן 3 אותיות שמוגדר בתקן ISO 4217.
amountInMicros

string (int64 format)

כמות במיליוניות השנייה. לדוגמה, הגדרת השדה הזה צריכה להיות 1990000$ עבור $1.99.

פעולה

פעולת המשך שמשויכת להזמנה או לפריט.

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

enum (Type)

חובה: סוג הפעולה.
title

string

הכותרת או התווית של הפעולה, שמוצגות למשתמש. האורך המקסימלי המותר הוא 100 תווים.
openUrlAction

object (OpenUrlAction)

הפעולה שצריך לבצע.
actionMetadata

object (ActionMetadata)

מטא-נתונים שמשויכים לפעולה.

סוג

פעולות אפשריות להמשך.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED פעולה לא מוגדרת.
VIEW_DETAILS הצגת הפעולה בפרטי ההזמנה.
MODIFY שינוי פעולת ההזמנה.
CANCEL ביטול ההזמנה.
RETURN פעולת החזרה להזמנה.
EXCHANGE פעולת הזמנת המרה.
EMAIL

פעולה באימייל. הסוגים EMAIL ו-CALL הוצאו משימוש. ניתן להשתמש ב-openUrlAction.url כמספר טלפון או כאימייל.
CALL

פעולת קריאה.
REORDER שינוי המיקום של הפעולה.
REVIEW בדיקת פעולת ההזמנה.
CUSTOMER_SERVICE יצירת קשר עם שירות הלקוחות.
FIX_ISSUE צריך להפנות את המשתמשים לאתר או לאפליקציה של המוכר כדי לפתור את הבעיה.
DIRECTION קישור למסלול.

OpenUrlAction

פתיחת כתובת ה-URL הנתונה.

ייצוג JSON 
{
  "url": string,
  "androidApp": {
    object (AndroidApp)
  },
  "urlTypeHint": enum (UrlTypeHint)
}
שדות
url

string

שדה כתובת האתר שיכול להיות כל אחת מהאפשרויות: - כתובות URL מסוג http או https לפתיחת אפליקציה או דף אינטרנט שמקושרים לאפליקציה
androidApp

object (AndroidApp)

מידע על האפליקציה ל-Android, אם אפליקציה ל-Android צפויה למלא את כתובת ה-URL.
urlTypeHint

enum (UrlTypeHint)

מציין רמז לסוג כתובת ה-URL.

AndroidApp

מפרט האפליקציה ל-Android בנוגע להגבלות על מילוי הזמנות

ייצוג JSON 
{
  "packageName": string,
  "versions": [
    {
      object (VersionFilter)
    }
  ]
}
שדות
packageName

string

שם החבילה צריך לציין את שם החבילה כשמציינים את Android Fulfillment.
versions[]

object (VersionFilter)

אם ציינת כמה מסננים, כל התאמת מסנן תפעיל את האפליקציה.

VersionFilter

אם נדרשות גרסאות ספציפיות של האפליקציה, צריך לכלול את VersionFilter.

ייצוג JSON 
{
  "minVersion": integer,
  "maxVersion": integer
}
שדות
minVersion

integer

קוד גרסה מינימלי או 0, כולל.
maxVersion

integer

קוד גרסה מקסימלי, כולל. הטווח החישוב הוא [minVersion:maxVersion]. טווח null מציין כל גרסה. דוגמאות: כדי לציין גרסה יחידה, צריך להשתמש בפורמט: [target_version:target_version]. כדי לציין גרסה כלשהי, צריך להשאיר את minVersion ו-maxVersion לא צוינו. כדי לציין את כל הגרסאות עד maxVersion, צריך להשאיר את minVersion ללא ציון. כדי לציין את כל הגרסאות מ-minVersion, צריך להשאיר את MaxVersion ללא ציון.

UrlTypeHint

סוגים שונים של רמזים לכתובות URL.

טיפוסים בני מנייה (enum)
URL_TYPE_HINT_UNSPECIFIED לא צוין
AMP_CONTENT כתובת URL שמפנה ישירות לתוכן AMP, או לכתובת URL קנונית שמפנה לתוכן AMP דרך <link rel="amphtml"> .

ActionMetadata

מטא-נתונים קשורים לכל פעולה.

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

string (Timestamp format)

השעה שבה יפוג תוקף הפעולה.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

גילוי נאות

גילוי נאות לגבי מוצר, שירות או מדיניות שעשוי להיות מוצג למשתמש.

ייצוג JSON 
{
  "title": string,
  "disclosureText": {
    object (DisclosureText)
  },
  "presentationOptions": {
    object (DisclosurePresentationOptions)
  }
}
שדות
title

string

הכותרת של הודעת הגילוי הנאות. דוגמה: 'מידע על בטיחות'.
disclosureText

object (DisclosureText)

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

object (DisclosurePresentationOptions)

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

DisclosureText

מייצג טקסט פשוט עם קישורים לאינטרנט.

ייצוג JSON 
{
  "template": string,
  "textLinks": [
    {
      object (TextLink)
    }
  ]
}
שדות
template

string

טקסט להצגה, שמכיל ערכי placeholder כמו "{0}" וגם '{1}' לכל קישור טקסט שצריך להוסיף. דוגמה: "אזהרה: המוצר הזה עלול לחשוף אתכם לכימיקלים שידועים למדינת קליפורניה כגורמים לסרטן. מידע נוסף זמין בכתובת {0}." אין לכלול בטקסט הגילוי הנאות תוכן שיווקי או תוכן דמוי מודעה.

DisclosurePresentationOptions

אפשרויות להצגת הודעת גילוי נאות.

ייצוג JSON 
{
  "presentationRequirement": enum (PresentationRequirement),
  "initiallyExpanded": boolean
}
שדות
presentationRequirement

enum (PresentationRequirement)

הדרישה להציג את הגילוי הנאות.
initiallyExpanded

boolean

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

PresentationRequirement

דרישה להצגת הגילוי הנאות.

טיפוסים בני מנייה (enum)
REQUIREMENT_UNSPECIFIED דרישה לא מוגדרת. אין להגדיר זאת במפורש.
REQUIREMENT_OPTIONAL הגילוי הנאות הוא אופציונלי. אפשר לדלג על השלב הזה אם המכשיר לא תומך בהצגת גילוי נאות.
REQUIREMENT_REQUIRED חובה לכלול את הגילוי הנאות. אם המכשיר לא תומך בהצגת גילוי נאות, השיחה תצורף לשיחה.

PurchaseItemExtension

תוכן הפריט בקטגוריה 'רכישה'.

ייצוג JSON 
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "productId": string,
  "quantity": integer,
  "unitMeasure": {
    object (MerchantUnitMeasure)
  },
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "itemOptions": [
    {
      object (ItemOption)
    }
  ],
  "productDetails": {
    object (ProductDetails)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
שדות
status

enum (PurchaseStatus)

חובה: סטטוס ברמת הפריט.
userVisibleStatusLabel

string

חובה: תווית/מחרוזת הגלויים למשתמש עבור הסטטוס. האורך המקסימלי המותר הוא 50 תווים.
type

enum (PurchaseType)

חובה: סוג הרכישה.
productId
(deprecated)

string

מזהה המוצר או המבצע שמשויך לפריט הזה.
quantity

integer

כמות היחידות של הפריט.
unitMeasure

object (MerchantUnitMeasure)

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

object (PurchaseReturnsInfo)

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

object (PurchaseFulfillmentInfo)

מידע על אספקה של הפריט הזה. אם המדיניות לא מוגדרת, הפריט הזה יורש את פרטי האספקה ברמת ההזמנה.
itemOptions[]

object (ItemOption)

תוספים או פריטי משנה נוספים.
productDetails

object (ProductDetails)

פרטים על המוצר.
extension
(deprecated)

object

כל שדה מיותר שהוחלף בין המוכר ל-Google. הערה: מומלץ מאוד לא להשתמש בתוסף הזה. בהתאם לתרחיש או הנסיבות, מומלץ לשקול אחת מהאפשרויות הבאות: 1. יש להגדיר שדות ב-PurchaseItemExtension אם הם יכולים לשמש לתרחישי שימוש אחרים (כלומר, יכולת/פונקציונליות כללית). 2. יש להשתמש ב-Vertical_extension אם הוא ספציפי לתרחיש או לתכונה מותאמים אישית ולא כלליים.

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

PurchaseStatus

סטטוס רכישה שמשויך להזמנת רכש או לפריט מסוים.

טיפוסים בני מנייה (enum)
PURCHASE_STATUS_UNSPECIFIED הסטטוס לא צוין.
READY_FOR_PICKUP מוכן לאיסוף.
SHIPPED המכשיר נשלח.
DELIVERED ההודעה נמסרה.
OUT_OF_STOCK חסר במלאי.
IN_PREPARATION 'IN_PREPARATION' יכולות להיות להם משמעויות שונות בהקשר שונה. אם מדובר בהזמנת מזון, יכול להיות שמדובר בהכנה של אוכל. בקמעונאות, יכול להיות שמדובר בפריט ארוז.
CREATED ההזמנה נוצרה.
CONFIRMED המוכר אישר את ההזמנה.
REJECTED המוכר דחה את ההזמנה או את הפריט.
RETURNED הפריט הוחזר על ידי המשתמש.
CANCELLED המשתמש ביטל את ההזמנה או הפריט.
CHANGE_REQUESTED המשתמש ביקש לשנות את ההזמנה, והמטמיע מעבד את השינוי הזה. אחרי הטיפול בבקשה, יש להעביר את ההזמנה למצב אחר.

PurchaseType

קטגוריית הרכישה.

טיפוסים בני מנייה (enum)
PURCHASE_TYPE_UNSPECIFIED ערך לא ידוע.
RETAIL הוא כולל רכישות כמו מוצרים פיזיים.
FOOD היא כוללת רכישה של הזמנת אוכל.
GROCERY רכישה של מוצרי מכולת.
MOBILE_RECHARGE רכישת טעינת כסף בנייד בתשלום מראש.

MerchantUnitMeasure

מידת תמחור יחידה של המוכר.

ייצוג JSON 
{
  "measure": number,
  "unit": enum (Unit)
}
שדות
measure

number

ערך: דוגמה 1.2.
unit

enum (Unit)

Unit: POUND, GRAM

Unit

טיפוסים בני מנייה (enum)
UNIT_UNSPECIFIED היחידה לא צוינה.
MILLIGRAM מיליגרם.
GRAM דקדוק.
KILOGRAM קילוגרם.
OUNCE הגייה.
POUND ליש"ט

PurchaseReturnsInfo

מחזירה מידע המשויך להזמנה או לפריט מסוים.

ייצוג JSON 
{
  "isReturnable": boolean,
  "daysToReturn": integer,
  "policyUrl": string
}
שדות
isReturnable

boolean

אם True, מותר להחזיר.
daysToReturn

integer

מותר להחזיר מוצרים בתוך מספר הימים הזה.
policyUrl

string

קישור למדיניות החזרת המוצרים.

PurchaseFulfillmentInfo

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

ייצוג JSON 
{
  "id": string,
  "fulfillmentType": enum (Type),
  "expectedFulfillmentTime": {
    object (Time)
  },
  "expectedPreparationTime": {
    object (Time)
  },
  "location": {
    object (Location)
  },
  "expireTime": string,
  "price": {
    object (PriceAttribute)
  },
  "fulfillmentContact": {
    object (UserInfo)
  },
  "shippingMethodName": string,
  "storeCode": string,
  "pickupInfo": {
    object (PickupInfo)
  }
}
שדות
id

string

מזהה ייחודי של אפשרות השירות הזו.
fulfillmentType

enum (Type)

חובה: סוג מילוי ההזמנה.
expectedFulfillmentTime

object (Time)

חלון אם צוין טווח זמן או זמן הגעה משוער אם צוין שעה אחת. זמן האספקה או האיסוף הצפוי.
expectedPreparationTime

object (Time)

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

object (Location)

מיקום האיסוף או המשלוח.
expireTime

string (Timestamp format)

השעה שבה יפוג התוקף של אפשרות מילוי ההזמנה הזו.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
price

object (PriceAttribute)

העלות של האפשרות הזו.
fulfillmentContact

object (UserInfo)

איש הקשר של המשתמש למילוי ההזמנות.
shippingMethodName

string

שם שיטת המשלוח שנבחרה על ידי המשתמש.
storeCode

string

קוד החנות של המיקום. דוגמה: Walmart הוא המוכר, ו-storeCode הוא החנות ב-Walmart שבה בוצע מילוי ההזמנה. https://support.google.com/business/answer/3370250?ref_topic=4596653.
pickupInfo

object (PickupInfo)

מידע נוסף על אופן הבחירה של ההזמנה. השדה הזה רלוונטי רק אם סוג מילוי ההזמנה הוא PICKUP.

סוג

סוג האספקה.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג לא צוין.
DELIVERY ההזמנה הזו תימסר.
PICKUP צריך לאסוף את ההזמנה הזו.

שעה

מבנה זמן שמייצג את הזמן של האירוע שבו צריך להשתמש בהצגת הזמנה למשתמש.

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

string

מייצג את המועד של אירוע ההזמנה, כמו זמן ההזמנה, זמן האספקה וכן הלאה. הערך יכול להיות משך זמן (שעת התחלה וסיום), תאריך, תאריך ושעה וכו'. מידע נוסף זמין בכתובת https://en.wikipedia.org/wiki/ISO_8601 כדי לראות את כל הפורמטים הנתמכים.

PickupInfo

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

ייצוג JSON 
{
  "pickupType": enum (PickupType),
  "curbsideInfo": {
    object (CurbsideInfo)
  },
  "checkInInfo": [
    {
      object (CheckInInfo)
    }
  ]
}
שדות
pickupType

enum (PickupType)

שיטת איסוף, כמו INSTORE, CURBSIDE וכו'.
curbsideInfo

object (CurbsideInfo)

פרטים ספציפיים למידע על מדלת העסק. אם הערך שלpickupType הוא לא CURBSIDE, המערכת תתעלם מהשדה הזה.
checkInInfo[]

object (CheckInInfo)

רשימת שיטות שונות שבהן השותף תומך בצ'ק-אין.

PickupType

רשימה של סוגי האיסוף הנתמכים.

טיפוסים בני מנייה (enum)
UNSPECIFIED לא צוין סוג האיסוף.
INSTORE יש לאסוף אוכל מתוך המסעדה.
CURBSIDE חנה את הרכב במקום ייעודי מחוץ למסעדה, ומישהו היה שולח שם אוכל.

CurbsideInfo

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

ייצוג JSON 
{
  "curbsideFulfillmentType": enum (CurbsideFulfillmentType),
  "userVehicle": {
    object (Vehicle)
  }
}
שדות
curbsideFulfillmentType

enum (CurbsideFulfillmentType)

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

object (Vehicle)

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

CurbsideFulfillmentType

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

טיפוסים בני מנייה (enum)
UNSPECIFIED לא צוין סוג מילוי הזמנה מדלת העסק.
VEHICLE_DETAIL פרטי הרכב נדרשים כדי לאפשר איסוף מדלת העסק.

כלי רכב

פרטים על כלי רכב

ייצוג JSON 
{
  "make": string,
  "model": string,
  "licensePlate": string,
  "colorName": string,
  "image": {
    object (Image)
  }
}
שדות
make

string

יצרן הרכב (למשל, הונדה). הערך הזה מוצג למשתמש וצריך להתאים אותו לשוק המקומי. חובה.
model

string

דגם הרכב (למשל, 'Grom'). הערך הזה מוצג למשתמש וצריך להתאים אותו לשוק המקומי. חובה.
licensePlate

string

מספר לוחית רישוי לרכב (למשל: 1ABC234). חובה.
colorName

string

שם הצבע של הרכב, למשל שחור אופציונלי.
image

object (Image)

כתובת URL של תמונה של הרכב. התמונה תוצג בגודל של כ-256x256 פיקסלים. הקובץ חייב להיות JPG או PNG. זה שינוי אופציונלי.

CheckInInfo

מטא-נתונים שנדרשים על ידי השותף כדי לתמוך בשיטת צ'ק-אין.

ייצוג JSON 
{
  "checkInType": enum (CheckInType)
}
שדות
checkInType

enum (CheckInType)

השיטה ששימשה לשליחת הוראות הצ'ק-אין.

CheckInType

שיטות שונות המשמשות לשליחת הוראות צ'ק-אין.

טיפוסים בני מנייה (enum)
CHECK_IN_TYPE_UNSPECIFIED ערך לא ידוע.
EMAIL פרטי הצ'ק-אין יישלחו באימייל.
SMS פרטי צ'ק-אין יישלחו ב-SMS.

ItemOption

מייצג תוספים או פריטי משנה.

ייצוג JSON 
{
  "id": string,
  "name": string,
  "prices": [
    {
      object (PriceAttribute)
    }
  ],
  "note": string,
  "quantity": integer,
  "productId": string,
  "subOptions": [
    {
      object (ItemOption)
    }
  ]
}
שדות
id

string

לאפשרויות שהן פריטים, צריך לציין מזהה פריט ייחודי.
name

string

שם האפשרות.
prices[]

object (PriceAttribute)

המחיר הכולל של האפשרות.
note

string

הערה שקשורה לאפשרות.
quantity

integer

לאפשרויות שהן פריטים, כמות.
productId

string

מזהה המוצר או המבצע שמשויך לאפשרות הזו.
subOptions[]

object (ItemOption)

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

ProductDetails

פרטים על המוצר.

ייצוג JSON 
{
  "productId": string,
  "gtin": string,
  "plu": string,
  "productType": string,
  "productAttributes": {
    string: string,
    ...
  }
}
שדות
productId

string

מזהה המוצר או המבצע שמשויך לפריט הזה.
gtin

string

מספר הפריט המסחרי הגלובלי של המוצר. שימושי אם מזהה המבצע לא קיים ב-Merchant Center. זה שינוי אופציונלי.
plu

string

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

string

קטגוריית המוצר שהוגדרה על ידי המוֹכר. לדוגמה "דף הבית > מכולת > מוצרי חלב ביצים > חלב > חלב מלא"
productAttributes

map (key: string, value: string)

פרטים שהמוכר סיפק לגבי המוצר, למשל: { &quot;allergen&quot;: &quot;peanut&quot; }. שימושי אם מזהה המבצע לא קיים ב-Merchant Center. זה שינוי אופציונלי.

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

ReservationItemExtension

תוכן הפריטים בהזמנות בהזמנה כמו מסעדה, תספורת וכו'

ייצוג JSON 
{
  "status": enum (ReservationStatus),
  "userVisibleStatusLabel": string,
  "type": enum (ReservationType),
  "reservationTime": {
    object (Time)
  },
  "userAcceptableTimeRange": {
    object (Time)
  },
  "confirmationCode": string,
  "partySize": integer,
  "staffFacilitators": [
    {
      object (StaffFacilitator)
    }
  ],
  "location": {
    object (Location)
  }
}
שדות
status

enum (ReservationStatus)

חובה: סטטוס הזמנה.
userVisibleStatusLabel

string

חובה: תווית/מחרוזת הגלויים למשתמש עבור הסטטוס. האורך המקסימלי המותר הוא 50 תווים.
type

enum (ReservationType)

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

object (Time)

השעה שבה השירות/האירוע מתוזמן להתרחש. אפשר להגדיר טווח זמן, תאריך או תאריך מדויק.
userAcceptableTimeRange

object (Time)

טווח הזמן המקובל על המשתמש.
confirmationCode

string

קוד האישור של ההזמנה הזו.
partySize

integer

מספר האנשים.
staffFacilitators[]

object (StaffFacilitator)

משתמשים עם הרשאות אדמין לצוות הניהול של ההזמנה. דוגמה: מעצב השיער.
location

object (Location)

מיקום השירות או האירוע.

ReservationStatus

סטטוס ההזמנה.

טיפוסים בני מנייה (enum)
RESERVATION_STATUS_UNSPECIFIED הסטטוס לא צוין.
PENDING ההזמנה בהמתנה.
CONFIRMED ההזמנה אושרה.
CANCELLED ההזמנה בוטלה על ידי המשתמש.
FULFILLED ההזמנה בוצעה.
CHANGE_REQUESTED נשלחה בקשה לשינוי ההזמנה
REJECTED פג התוקף של ההזמנה או שהיא נדחתה על ידי מבצע השילוב.

ReservationType

סוג ההזמנה.

טיפוסים בני מנייה (enum)
RESERVATION_TYPE_UNSPECIFIED הסוג לא צוין.
RESTAURANT הזמנה למסעדה.
HAIRDRESSER הזמנה למספרה.

StaffFacilitator

מידע על איש השירות.

ייצוג JSON 
{
  "name": string,
  "image": {
    object (Image)
  }
}
שדות
name

string

השם של מנחה הצוות. דוגמה: "ישראל ישראלי"
image

object (Image)

התמונות של האומן/ית.

PaymentData

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

ייצוג JSON 
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
שדות
paymentResult

object (PaymentResult)

תוצאת תשלום שמשמשת את מבצע השילוב להשלמת עסקה. השדה הזה יאוכלס ב-Actions on Google אם חוויית התשלום מנוהלת על ידי Actions-on-Google.
paymentInfo

object (PaymentInfo)

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

PaymentResult

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

ייצוג JSON 
{

  // Union field result can be only one of the following:
  "googlePaymentData": string,
  "merchantPaymentMethodId": string
  // End of list of possible types for union field result.
}
שדות
שדה איחוד result. קיבלנו את נתוני התשלום של Google או את אמצעי התשלום של המוכר. result יכול להיות רק אחת מהאפשרויות הבאות:
googlePaymentData

string

נתונים של אמצעי התשלום שסופקו על ידי Google. אם ספק שירותי התשלומים שלך רשום כאן בתור ספק שירותי תשלומים שנתמך על ידי Google: https://developers.google.com/pay/api/ כדי לקבל פרטים נוספים, אפשר לעבור אל ספק שירותי התשלומים דרך הקישור. אחרת, אפשר לעיין במסמכים הבאים לקבלת פרטים על המטען הייעודי (payload). https://developers.google.com/pay/api/payment-data-cryptography
merchantPaymentMethodId

string

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

PaymentInfo

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

ייצוג JSON 
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
שדות
paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

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

enum (PaymentMethodProvenance)

המקור של אמצעי התשלום ששימש לביצוע העסקה. יכול להיות שהמשתמש רשם את אותו אמצעי תשלום גם ב-Google וגם ב-Merchant.

PaymentMethodDisplayInfo

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

ייצוג JSON 
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string,
  "paymentMethodVoiceName": string
}
שדות
paymentType

enum (PaymentType)

סוג התשלום.
paymentMethodDisplayName

string

השם הגלוי למשתמש של אמצעי התשלום. לדוגמה, VISA **** 1234 בדיקה חשבון **** 5678
paymentMethodVoiceName

string

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

PaymentType

PaymentType מציין את אמצעי התשלום שמשמש את אמצעי התשלום שסופק על ידי המוכר. הפעולה צריכה לכלול גם את השם המוצג של אמצעי התשלום.

טיפוסים בני מנייה (enum)
PAYMENT_TYPE_UNSPECIFIED לא צוין סוג תשלום.
PAYMENT_CARD כרטיס אשראי, כרטיס חיוב מיידי או כרטיס תשלום מראש.
BANK אמצעי התשלום הוא חשבון בנק.
LOYALTY_PROGRAM אמצעי התשלום הוא מועדון לקוחות.
CASH אמצעי התשלום במזומן.
GIFT_CARD אמצעי התשלום הוא כרטיס מתנה.
WALLET ארנק של צד שלישי, כמו PayPal

PaymentMethodProvenance

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

טיפוסים בני מנייה (enum)
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED לא צוינה מקור.
PAYMENT_METHOD_PROVENANCE_GOOGLE המקור הוא Google.
PAYMENT_METHOD_PROVENANCE_MERCHANT המקור הוא Merchant.

קידום מכירות

מבצעים או מבצעים שנוספו לעגלת הקניות.

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

string

נדרש: קוד השובר שהוחל על המבצע הזה.

PurchaseOrderExtension

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

ייצוג JSON 
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ],
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
שדות
status

enum (PurchaseStatus)

חובה: הסטטוס הכולל של ההזמנה.
userVisibleStatusLabel

string

תווית/מחרוזת גלויים למשתמש עבור הסטטוס. האורך המקסימלי המותר הוא 50 תווים.
type

enum (PurchaseType)

חובה: סוג הרכישה.
returnsInfo

object (PurchaseReturnsInfo)

פרטי ההחזרה של ההזמנה.
fulfillmentInfo

object (PurchaseFulfillmentInfo)

מידע על אספקה של ההזמנה.
purchaseLocationType

enum (PurchaseLocationType)

מיקום הרכישה (בחנות או באינטרנט)
errors[]

object (PurchaseError)

אופציונלי: שגיאות שבגללן ההזמנה הזו נדחתה.
extension
(deprecated)

object

כל שדה מיותר שהוחלף בין המוכר ל-Google. הערה: מומלץ מאוד לא להשתמש בתוסף הזה. בהתאם לתרחיש או הנסיבות, מומלץ לשקול אחת מהאפשרויות הבאות: 1. יש להגדיר שדות ב-PurchaseOrderExtension אם אפשר להשתמש בהם לתרחישים אחרים לדוגמה (כלומר, יכולות/פונקציונליות כלליות). 2. יש להשתמש ב-Vertical_extension אם הוא ספציפי לתרחיש או לתכונה מותאמים אישית ולא כלליים.

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

PurchaseLocationType

סוג מיקום הרכישה.

טיפוסים בני מנייה (enum)
UNSPECIFIED_LOCATION ערך לא ידוע.
ONLINE_PURCHASE כל הרכישות נקנו באינטרנט.
INSTORE_PURCHASE כל הרכישות בחנות.

PurchaseError

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

ייצוג JSON 
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": integer
}
שדות
type

enum (ErrorType)

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

string

תיאור שגיאה נוסף.
entityId

string

מזהה הישות שתואם לשגיאה. דוגמה לכך יכולה להתאים ל-LineItemId / ItemOptionId.
updatedPrice

object (PriceAttribute)

רלוונטי במקרה של סוג השגיאה PRICE_CHANGED / INCORRECT_PRICE.
availableQuantity

integer

כמות זמינה עכשיו. רלוונטי במקרה של AVAILABILITY_CHANGED.

ErrorType

סוגי שגיאות אפשריים.

טיפוסים בני מנייה (enum)
ERROR_TYPE_UNSPECIFIED שגיאה לא ידועה
NOT_FOUND הישות לא נמצאה, יכול להיות: 'פריט', 'FulfillmentOption', 'קידום מכירות'. נדרש מזהה ישות.
INVALID נתוני הישות לא תקינים. הערך יכול להיות Item, FulfillmentOption, Promotion. נדרש מזהה ישות.
AVAILABILITY_CHANGED הפריט לא זמין או שאין מספיק פריטים למילוי הבקשה. נדרש מזהה ישות.
PRICE_CHANGED מחיר הפריט שונה מהמחיר בישות הפריט. חובה לציין מזהה ישות ומחיר מעודכן.
INCORRECT_PRICE שגיאות מחירים ב'עמלות', 'סה"כ'. חובה לציין מזהה ישות ומחיר מעודכן.
REQUIREMENTS_NOT_MET המגבלות על קבלת ההזמנה לא עומדות במגבלות – גודל סל הקניות המינימלי וכו'.
TOO_LATE פג התוקף של FulfillmentOption.
NO_CAPACITY אין קיבולת שירות זמינה. צריך להשתמש בקוד השגיאה הזה אם אף אחד מסוגי השגיאות המפורטים יותר לא רלוונטי.
NO_COURIER_AVAILABLE לא מצאנו שירות משלוחים. סוג שגיאה פרטני שניתן לסווג כ-NO_CAPALOCATION.
INELIGIBLE המשתמש לא כשיר לבצע את ההזמנה (רשימה שחורה).
OUT_OF_SERVICE_AREA לא ניתן לשלוח לכתובת המבוקשת בגלל כללי גבול וכו'.
CLOSED המסעדה סגורה בשעת ההזמנה.
PROMO_NOT_APPLICABLE קוד שגיאה גנרי שמתייחס לכל המקרים של כשל במימוש קוד ההטבה, אם אף אחד מהם לא מתאים. הוספת קוד ההטבה כמזהה ישות ב-SAML.
PROMO_NOT_RECOGNIZED קוד השובר לא זוהה על ידי השותף. הוספת קוד ההטבה כמזהה ישות ב-SAML.
PROMO_EXPIRED לא ניתן להחיל את המבצע כי פג התוקף שלו. הוספת קוד ההטבה כמזהה ישות ב-SAML.
PROMO_USER_INELIGIBLE המשתמש הנוכחי אינו זכאי לשובר הזה. הוספת קוד ההטבה כמזהה ישות ב-SAML.
PROMO_ORDER_INELIGIBLE ההזמנה הנוכחית לא עומדת בדרישות לקבלת השובר הזה. הוספת קוד ההטבה כמזהה ישות ב-SAML.
UNAVAILABLE_SLOT המשבצת להזמנה מראש לא זמינה.
FAILED_PRECONDITION המגבלות על קבלת ההזמנה לא עומדות במגבלות – גודל סל הקניות המינימלי וכו'
PAYMENT_DECLINED תשלום לא חוקי.
MERCHANT_UNREACHABLE אי אפשר להשיג את המוֹכר. האפשרות הזו עוזרת במקרים שבהם שותף הוא אתר אגרגטור, ואין לו אפשרות ליצור קשר עם המוכר.
ACCOUNT_LINKING_FAILED המוכר ניסה לקשר חשבון Google של משתמש לחשבון במערכת שלו, אבל הוא נתקל בשגיאה במהלך הפעולה.

TicketOrderExtension

תוכן של הזמנות כרטיסים, כמו סרטים, ספורט וכו'

ייצוג JSON 
{
  "ticketEvent": {
    object (TicketEvent)
  }
}
שדות
ticketEvent

object (TicketEvent)

האירוע הזה חל על כל הכרטיסים בפריטים.

TicketEvent

מייצג אירוע יחיד.

ייצוג JSON 
{
  "type": enum (Type),
  "name": string,
  "description": string,
  "url": string,
  "location": {
    object (Location)
  },
  "eventCharacters": [
    {
      object (EventCharacter)
    }
  ],
  "startDate": {
    object (Time)
  },
  "endDate": {
    object (Time)
  },
  "doorTime": {
    object (Time)
  }
}
שדות
type

enum (Type)

חובה: סוג אירוע הכרטיס. לדוגמה: סרט, קונצרט.
name

string

חובה: שם האירוע. לדוגמה, אם האירוע הוא סרט, הוא צריך להיות שם הסרט.
description

string

תיאור האירוע.
url

string

כתובת URL לפרטי האירוע.
location

object (Location)

המיקום שבו מתקיים האירוע או המיקום של הארגון.
eventCharacters[]

object (EventCharacter)

התווים שקשורים לאירוע הזה. לדוגמה, במאים או שחקנים באירוע קולנוע, אומני הופעות וכו'.
startDate

object (Time)

שעת התחלה.
endDate

object (Time)

שעת סיום.
doorTime

object (Time)

שעת הכניסה, שעשויה להיות שונה משעת ההתחלה של האירוע. לדוגמה האירוע מתחיל ב-9:00 אבל שעת הכניסה היא 8:30.

סוג

סוג האירוע.

טיפוסים בני מנייה (enum)
EVENT_TYPE_UNKNOWN סוג אירוע לא ידוע.
MOVIE סרט.
CONCERT קונצרט.
SPORTS ספורט.

EventCharacter

תו אירוע אחד, למשל מארגן, מבצע וכו'.

ייצוג JSON 
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
שדות
type

enum (Type)

סוג תו האירוע, למשל שחקן או במאי.
name

string

שם הדמות.
image

object (Image)

התמונות של הדמות.

סוג

סוג התו.

טיפוסים בני מנייה (enum)
TYPE_UNKNOWN סוג לא ידוע.
ACTOR המשתמש.
PERFORMER אמנים.
DIRECTOR במאי.
ORGANIZER מארגן.

UserNotification

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

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

string

הכותרת של ההודעה למשתמש. האורך המקסימלי המותר הוא 30 תווים.
text

string

תוכן ההתראה. האורך המקסימלי המותר הוא 100 תווים.

NextScene

מייצג את הסצנה שיש לבצע בשלב הבא.

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

string

שם הסצנה שרוצים לבצע בשלב הבא.

סשן

מכיל מידע על השיחה הנוכחית

ייצוג JSON 
{
  "id": string,
  "params": {
    string: value,
    ...
  },
  "typeOverrides": [
    {
      object (TypeOverride)
    }
  ],
  "languageCode": string
}
שדות
id

string

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

map (key: string, value: value (Value format))

חובה. רשימה של כל הפרמטרים שנאספו מטפסים ומ-Intent במהלך הסשן. המפתח הוא שם הפרמטר. פרמטרים שמוגדרים כאן ימוזגו עם פרמטרים שכבר הוגדרו בסשן. פרמטרים שהערך שלהם הוא null יוסרו מהסשן. לעיון בתיעוד לגבי אחסון הסשנים: https://developers.google.com/assistant/conversational/storage-session.

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

object (TypeOverride)

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

string

השפה של השיחה הנוכחית. תואם לקוד השפה IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt. זה יכול להיות שונה מהלוקאל של המשתמש אם הפעולה משתמשת בתכונות בכמה שפות. לדוגמה, כאשר מוגדר handler_response.expected.language_code הוא משנה את שפת השיחה בכל הפניות הבאות, והדבר ישתקף בשדה הזה.

TypeOverride

מייצג שינוי מברירת המחדל של סוג מסוים.

ייצוג JSON 
{
  "name": string,
  "mode": enum (TypeOverrideMode),
  "synonym": {
    object (SynonymType)
  }
}
שדות
name

string

חובה. שם של הסוג שרוצים להוסיף או לשנות.
mode

enum (TypeOverrideMode)

חובה. איך למזג את הסוג הזה עם ערכים של סוגים אחרים.
synonym

object (SynonymType)

TypeOverrideMode

סוגי השינויים בסוג ישות של סשן.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED לא צוין. אין להשתמש בערך הזה אף פעם.
TYPE_REPLACE הגדרות הסוגים בתשובה הזו יחליפו את הגדרות הסוגים שהוגדרו בעבר.
TYPE_MERGE הגדרות הסוגים בתשובה הזו ימוזגו עם הגדרות סוגים שהוגדרו בעבר. הגדרות סוגים חדשות יחליפו את הגדרות הסוגים הקיימות.

SynonymType

מייצג סוג באמצעות מילים נרדפות.

ייצוג JSON 
{
  "entries": [
    {
      object (Entry)
    }
  ]
}
שדות
entries[]

object (Entry)

חובה. רשימת הערכים של סוג המילה הנרדפת.

הערך

מייצג ערך של סוג מילה נרדפת.

ייצוג JSON 
{
  "name": string,
  "synonyms": [
    string
  ],
  "display": {
    object (EntryDisplay)
  }
}
שדות
name

string

חובה. שם הרשומה (למשל, 'אופניים'). הערך בשדה הזה חייב להיכלל בשדה מילים נרדפות חוזר כדי לזהות אותו כערך חוקי של סוג.
synonyms[]

string

חובה. רשימת מילים נרדפות של הרשומה (למשל, "אופניים", "מחזור").
display

object (EntryDisplay)

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

EntryDisplay

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

string

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

string

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

object (Image)

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

string

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

object (OpenUrl)

כתובת ה-URL של המסמך המשויך לפריט הקרוסלה בדפדפן. נדרש לדפדוף בקרוסלה.

משתמש

מייצג את המשתמש ששלח בקשה לפעולה.

ייצוג JSON 
{
  "locale": string,
  "params": {
    string: value,
    ...
  },
  "accountLinkingStatus": enum (AccountLinkingStatus),
  "verificationStatus": enum (UserVerificationStatus),
  "lastSeenTime": string,
  "engagement": {
    object (Engagement)
  },
  "packageEntitlements": [
    {
      object (PackageEntitlements)
    }
  ],
  "permissions": [
    enum (Permission)
  ]
}
שדות
locale

string

הגדרת הלוקאל הראשי של המשתמש ששלח את הבקשה. תואם לקוד השפה IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt. עם זאת, תג המשנה של הסקריפט לא נכלל.
params

map (key: string, value: value (Value format))

זה שינוי אופציונלי. רשימה של כל הפרמטרים שמשויכים למשתמש הנוכחי. למידע נוסף על נפח האחסון למשתמשים: https://developers.google.com/assistant/conversational/storage-user.

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

enum (AccountLinkingStatus)

האם חשבון המשתמש מקושר לאפליקציה.
verificationStatus

enum (UserVerificationStatus)

מציין את סטטוס האימות של המשתמש.
lastSeenTime

string (Timestamp format)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
engagement

object (Engagement)

המעורבות של המשתמש הנוכחי, כולל מינויים לכוונות רכישה.
packageEntitlements[]

object (PackageEntitlements)

הרשאות המשתמש שקשורות לחבילת Android שמשויכת לפעולה הנוכחית.
permissions[]

enum (Permission)

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

AccountLinkingStatus

מציינת אם משתמש הקצה קישר את החשבון שלו לאפליקציה הזו. לעיון בתיעוד לקישור חשבונות: https://developers.google.com/assistant/identity.

טיפוסים בני מנייה (enum)
ACCOUNT_LINKING_STATUS_UNSPECIFIED לא ידוע.
NOT_LINKED המשתמש לא קישר את החשבון שלו לאפליקציה הזו.
LINKED המשתמש קישר את החשבון שלו לאפליקציה הזו.

UserVerificationStatus

מציין אם Google אימתה את המשתמש. הסטטוס 'מאומת' מציין שניתן לשמור נתונים בשיחות שונות באמצעות שדה הפרמטרים או באמצעות קישור חשבונות.

טיפוסים בני מנייה (enum)
USER_VERIFICATION_STATUS_UNSPECIFIED לא ידוע.
GUEST משתמש אורח.
VERIFIED משתמש מאומת.

מעורבות

מספקת מידע נוסף לקריאה בלבד על מנגנוני המעורבות שהמשתמש הנוכחי נרשם אליהם. לדוגמה, כדאי לדעת לאילו כוונות המשתמש כבר נרשם, כדי לא לבקש ממנו להירשם שוב לאותה הכוונה. כלומר, אפשר להשתמש במידע הזה כדי לנתב באופן מותנה לסצנה לצורך הגדרת עדכונים יומיים או PushNotifications רק אם המשתמש עדיין לא נרשם. למידע נוסף על מעורבות המשתמשים: https://developers.google.com/assistant/engagement.

ייצוג JSON 
{
  "pushNotificationIntents": [
    {
      object (IntentSubscription)
    }
  ],
  "dailyUpdateIntents": [
    {
      object (IntentSubscription)
    }
  ]
}
שדות
pushNotificationIntents[]

object (IntentSubscription)

מכילה רשימה של כוונות שהמשתמש הפעיל עבורן התראות.
dailyUpdateIntents[]

object (IntentSubscription)

מכילה רשימת Intent שהמשתמש הפעיל עבורם עדכון יומי.

IntentSubscription

מתאר IntentSubscription קיים.

ייצוג JSON 
{
  "intent": string,
  "contentTitle": string
}
שדות
intent

string

השם של ה-Intent שנרשמת אליו.
contentTitle

string

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

PackageEntitlements

רשימה של הרשאות משתמש שקשורות לשם חבילה. אפשר לעיין במסמכים בנוגע לעסקאות דיגיטליות טובות: https://developers.google.com/assistant/transactions/digital/dev-guide-digital-non-consumables.

ייצוג JSON 
{
  "packageName": string,
  "entitlements": [
    {
      object (Entitlement)
    }
  ]
}
שדות
packageName

string

שם החבילה של Android שצוין בחבילת הפעולות.
entitlements[]

object (Entitlement)

הרשאות המשתמש עבור החבילה הנתונה.

זכאות

מגדירה את ההרשאה הדיגיטלית של המשתמש.

ייצוג JSON 
{
  "sku": string,
  "skuType": enum (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
שדות
sku

string

מק"ט של מוצר שם החבילה של האפליקציה בתשלום, סיומת של Finsky docid לרכישה מתוך האפליקציה ולמינוי מתוך האפליקציה. התאמת getSku() ב-Play InApp Billing API. מידע נוסף זמין במסמכי התיעוד בנושא חיוב על רכישות ב-Play: https://developer.android.com/google/play/billing.
skuType

enum (SkuType)

סוג המק"ט.
inAppDetails

object (SignedData)

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

SkuType

טיפוסים בני מנייה (enum)
SKU_TYPE_UNSPECIFIED
IN_APP רכישה מתוך האפליקציה
SUBSCRIPTION מינויים
APP אפליקציות בתשלום

SignedData

ייצוג JSON 
{
  "inAppPurchaseData": {
    object
  },
  "inAppDataSignature": string
}
שדות
inAppPurchaseData

object (Struct format)

מכיל את כל הנתונים של רכישות מתוך האפליקציה בפורמט JSON. ניתן לעיין בפרטים בטבלה 6 של https://developer.android.com/google/play/billing/billing_reference.html.
inAppDataSignature

string

תואם ל-IN_APP_DATA_SIGNATURE מהשיטה getPurchases() ב-Play InApp Billing API.

הרשאה

ערכים אפשריים להרשאה.

טיפוסים בני מנייה (enum)
PERMISSION_UNSPECIFIED הרשאה לא צוינה.
DEVICE_PRECISE_LOCATION לבקש את המיקום המדויק, קו הרוחב/אורך והכתובת המפורמט של המשתמש.
DEVICE_COARSE_LOCATION יש לבקש את המיקום המשוער, המיקוד, העיר וקוד המדינה של המשתמש.
UPDATE צריך לבקש הרשאות לשלוח עדכונים. מידע נוסף זמין בכתובת https://developers.google.com/assistant/engagement/daily.

דף הבית

מייצג את המבנה של Home Graph שאליו שייך מכשיר היעד של המשתמש.

ייצוג JSON 
{
  "params": {
    string: value,
    ...
  }
}
שדות
params

map (key: string, value: value (Value format))

זה שינוי אופציונלי. רשימת הפרמטרים שמשויכים למבנה Home Graph שאליו שייך מכשיר היעד. לעיון בתיעוד לגבי אחסון בבית: https://developers.google.com/assistant/conversational/storage-home.

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

מכשיר

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

ייצוג JSON 
{
  "capabilities": [
    enum (Capability)
  ],
  "currentLocation": {
    object (Location)
  },
  "timeZone": {
    object (TimeZone)
  }
}
שדות
capabilities[]

enum (Capability)

זהו שדה חובה. היכולות של המכשיר ששולח בקשה לפעולה.
currentLocation

object (Location)

זה שינוי אופציונלי. מיקום המכשיר של המשתמש. הערה: השדה הזה מאוכלס רק אחרי שמשתמש הקצה מעניק את הרשאות המיקום. בהודעת המיקום אפשר לקבל פרטים נוספים על השדות שמוגדרים בהתאם להרשאה בפירוט גס לעומת הרשאה מפורטת. למידע נוסף על הרשאות: https://developers.google.com/assistant/conversational/permissions.
timeZone

object (TimeZone)

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

פונקציה

יכולות שפלטפורמת המכשיר תומכת בהן בזמן הבקשה.

טיפוסים בני מנייה (enum)
UNSPECIFIED יכולת המכשיר לא צוינה.
SPEECH המכשיר יכול לדבר אל המשתמש באמצעות המרת טקסט לדיבור (TTS) או SSML.
RICH_RESPONSE המכשיר יכול להציג תגובות עשירות כמו כרטיסים, רשימות וטבלאות.
LONG_FORM_AUDIO המכשיר יכול להפעיל מדיה אודיו ארוכה, כמו מוזיקה ופודקאסטים.
INTERACTIVE_CANVAS המכשיר יכול להציג תגובה אינטראקטיבית מלוח הציור.
HOME_STORAGE המכשיר יכול לתמוך בשמירה ובאחזור של נפח האחסון בבית.

מיקום

מאגר שמייצג מיקום.

ייצוג JSON 
{
  "coordinates": {
    object (LatLng)
  },
  "postalAddress": {
    object (PostalAddress)
  }
}
שדות
coordinates

object (LatLng)

קואורדינטות גיאוגרפיות. נדרשת ההרשאה [DEVICE_PRECISE_LOCATION].
postalAddress

object (PostalAddress)

כתובת לדברי דואר. נדרשת ההרשאה [DEVICE_PRECISE_LOCATION] או [DEVICE_COARSE_LOCATION]. כשניתנת הרשאת מיקום משוער, רק ה-postalCode ו'אזור' אמורים להתאכלס. הרשאת המיקום המדויק תאכלס שדות נוספים כמו 'אזור מנהלי' ו-addressLines.

TimeZone

מייצג אזור זמן ממסד הנתונים של אזור זמן IANA.

ייצוג JSON 
{
  "id": string,
  "version": string
}
שדות
id

string

אזור הזמן ב-IANA Time Zone Database, למשל. 'America/New_York'.
version

string

זה שינוי אופציונלי. מספר הגרסה של מסד הנתונים של אזור הזמן IANA, למשל '2019a'.

הקשר

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

ייצוג JSON 
{
  "media": {
    object (MediaContext)
  },
  "canvas": {
    object (CanvasContext)
  }
}
שדות
media

object (MediaContext)

מכיל מידע על ההקשר של סשן המדיה הפעיל.
canvas

object (CanvasContext)

מכיל מידע על ההקשר של אזור העריכה הנוכחי.

MediaContext

מכיל מידע על ההקשר של סשן המדיה הפעיל.

ייצוג JSON 
{
  "progress": string,
  "index": integer
}
שדות
progress

string (Duration format)

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

משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s'. לדוגמה: "3.5s".
index

integer

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

CanvasContext

מכיל מידע על ההקשר של אזור העריכה הנוכחי.

ייצוג JSON 
{
  "state": value
}
שדות
state

value (Value format)

זה שינוי אופציונלי. המצב מוגדר על ידי אפליקציית 'לוח הציור האינטראקטיבי' של צד שלישי. הוא מוגדר רק לבקשה ולא לתגובה. לדוגמה, אם זוהי אפליקציית מתכונים, המצב יכול להיות הערך של המבנה : { "current_page" : 5, "last_page" : 3, } מגבלת הגודל היא 50KB.

צפוי

מתאר את הציפיות לפנייה הבאה בתיבת הדו-שיח.

ייצוג JSON 
{
  "speech": [
    string
  ]
}
שדות
speech[]

string

רשימת ביטויים שהפעולה מצפה להם מההגייה של המשתמש לצורך הטיית דיבור. מותר להשתמש ב-1,000 ביטויים לכל היותר. הערה: המשמעות של השדה הזה זהה לזו של ExpectedInput.speech_biasing_hints ב-API בגרסה 2.