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 בשם "getDatat".
intent

object (Intent)

חובה. מייצג את ה-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)

אפשרות. מידע הקשור למבנה של HomeGraph שאליו שייך מכשיר היעד. פרטים נוספים זמינים בכתובת 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)

אפשרות. משמש לציון פרמטרים הקשורים למבנה HomeGraph שאליו שייך מכשיר היעד. פרטים נוספים זמינים בכתובת 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

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

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))

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

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

object (NextScene)

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

SlotFillingStatus

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

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

משבצת

מייצג יחידת קיבולת (Slot).

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

enum (SlotMode)

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

enum (SlotStatus)

הסטטוס של יחידת הקיבולת (Slot).
value

value (Value format)

הערך של יחידת הקיבולת (Slot). שינוי הערך הזה בתשובה יגרום לשינוי הערך במילוי המשבצת.
updated

boolean

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

object (Prompt)

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

SlotMode

מייצג את המצב של יחידת קיבולת (Slot), כלומר, אם נדרש או לא.

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

SlotStatus

מייצג את הסטטוס של יחידת קיבולת (Slot).

טיפוסים בני מנייה (enums)
SLOT_UNSPECIFIED ערך חלופי כששדה השימוש לא מאוכלס.
EMPTY מציין שלמשבצת אין ערכים. לא ניתן לשנות את הסטטוס הזה באמצעות התגובה.
INVALID שדה זה מציין שערך יחידת הקיבולת (Slot) לא חוקי. ניתן להגדיר את הסטטוס הזה דרך התגובה.
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" תאפשר גם הוספה של שדות מסוימים בהנחיות פשוטות, בהנחיה 'הצעות' ובהנחיה 'בד ציור' (חלק מההנחיה 'תוכן'). הודעות התוכן והקישור תמיד מוחלפות אם הן מוגדרות בהודעה. ערך ברירת המחדל הוא 'false'.
firstSimple

object (Simple)

אפשרות. התגובה הראשונה בקול ובטקסט בלבד.
content

object (Content)

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

object (Simple)

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

object (Suggestion)

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

object (Canvas)

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

object (OrderUpdate)

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

פשוט

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

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

string

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

string

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

Content

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

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

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

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

OpenUrl

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

string

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

enum (UrlHint)

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

UrlHint

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

טיפוסים בני מנייה (enums)
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

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

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

TableRow

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

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

object (TableCell)

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

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

object (MediaObject)

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

enum (RepeatMode)

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

integer

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

MediaType

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

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

OptionalMediaControls

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

טיפוסים בני מנייה (enums)
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

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

טיפוסים בני מנייה (enums)
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 תווים לכל היותר

אזור עריכה

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

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

string

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

value (Value format)

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

boolean

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

object (ContinuousMatchConfig)

הגדרה המשמשת להפעלת מצב התאמה רציפה.

ContinuousMatchConfig

הגדרה המשמשת להפעלת מצב התאמה רציפה.

ייצוג 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 במקום זאת. אם הסוג = SNAPSHOT, יש לציין את OrderUpdate.order בכל ההזמנה. אם הסוג = ORDER_STATUS, זהו השינוי בסטטוס של רמת ההזמנה. אנחנו אוספים רק את הפרמטר order.last_update_time והסטטוס האנכי הזה. הערה: type.ORDER_STATUS תומך רק בעדכוני סטטוס של ForcahaseOrderExtension ואנחנו לא מתכננים להרחיב את התמיכה הזו. במקום זאת, מומלץ להשתמש ב-updateMask כי הוא כללי יותר, ניתן להרחבה וניתן להשתמש בו לכל הענפים.
order

object (Order)
updateMask

string (FieldMask format)

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

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

object (UserNotification)

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

string

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

תיאור

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

טיפוסים בני מנייה (enums)
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

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

object (UserInfo)

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

object (Image)

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

string (Timestamp format)

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

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

string (Timestamp format)

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

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

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

PhoneNumber

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

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

string

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

string

תוסף אינו סטנדרטי בהמלצות של ITU, אלא אם הוא מוגדר כסדרת מספרים באורך מקסימלי של 40 ספרות. הוא מוגדר כאן כמחרוזת כדי להתאים לשימוש אפשרי באפס מוביל בתוסף (לארגונים יש חופש מלא לעשות זאת, מכיוון שלא הוגדר תקן). מלבד ספרות, אפשר לשמור כאן תווי חיוג אחרים כמו ',' (המצביעים על המתנה). לדוגמה, בדוגמה xxx-xxx-xxxx ext. 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

שם המוכר, כמו "לחם פנרה".
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

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

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

עצות לגבי קלט / עריכה של כתובת: - יש להשתמש בווידג'ט כתובת המוכן ל-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, עיר דואר בבריטניה. באזורים בעולם שבהם הרשויות המוניציפאליות אינן מוגדרות היטב או שאינן מתאימות למבנה זה, השאירו את הרשות המוניציפאלית ריקה והשתמשו ב-addressLines.
sublocality

string

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

string

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

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

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

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

string

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

string

אפשרות. שם הארגון בכתובת.

תוכן עניינים

ראפ לפריטים.

ייצוג 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% מיוצגים כ-8,750, אחוזים שליליים מייצגים הנחות באחוזים. המערכת מוציאה את השדה הזה משימוש. אם צריך תרחיש לדוגמה ברור, אפשר להוסיף אותם בחזרה.

תיאור

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

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

ארץ

מצב המחיר.

טיפוסים בני מנייה (enums)
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)

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

תיאור

פעולות מעקב אפשריות.

טיפוסים בני מנייה (enums)
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 שיכול להיות כל אחד מהפרטים הבאים: - כתובות URL מסוג http/https לפתיחת אפליקציה או דף אינטרנט שמקושרים לאפליקציה
androidApp

object (AndroidApp)

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

enum (UrlTypeHint)

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

AndroidApp

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

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

string

כשמציינים את שם החבילה, יש לציין את שם החבילה.
versions[]

object (VersionFilter)

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

VersionFilter

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

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

integer

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

integer

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

UrlTypeHint

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

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

ActionMetadata

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

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

string (Timestamp format)

השעה שבה הפעולה הזו תפוג.

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

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

DisclosurePresentationOptions

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

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

enum (PresentationRequirement)

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

boolean

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

PresentationRequirement

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

טיפוסים בני מנייה (enums)
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

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

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

PurchaseType

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

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

MerchantUnitMeasure

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

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

number

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

enum (Unit)

יחידה: דוגמה ל-POUND, GRAM.

יחידה

טיפוסים בני מנייה (enums)
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, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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.

תיאור

סוג האספקה.

טיפוסים בני מנייה (enums)
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)

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

object (CheckInInfo)

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

PickupType

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

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

CurbsideInfo

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

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

enum (CurbsideFulfillmentType)

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

object (Vehicle)

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

CurbsideFulfillmentType

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

טיפוסים בני מנייה (enums)
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

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

טיפוסים בני מנייה (enums)
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

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

string

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

object (ItemOption)

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

ProductDetails

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

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

string

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

string

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

string

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

string

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

map (key: string, value: string)

פרטים שהמוכר סיפק לגבי המוצר, למשל { "allergen": "peanut" }. שימושי אם OfferId לא נמצא ב-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

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

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

ReservationType

סוג ההזמנה.

טיפוסים בני מנייה (enums)
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 וגם במוכר.

PaymentMethodDisplayInfo

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

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

enum (PaymentType)

סוג התשלום.
paymentMethodDisplayName

string

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

string

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

PaymentType

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

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

PaymentMethodProvenance

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

טיפוסים בני מנייה (enums)
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED לא צוין המקור.
PAYMENT_METHOD_PROVENANCE_GOOGLE מוצא הוא Google.
PAYMENT_METHOD_PROVENANCE_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

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

טיפוסים בני מנייה (enums)
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_Change / INCORRECT_PRICE.
availableQuantity

integer

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

ErrorType

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

טיפוסים בני מנייה (enums)
ERROR_TYPE_UNSPECIFIED שגיאה לא ידועה
NOT_FOUND הישות לא נמצאה, יכול להיות פריט, FulfillmentOption, קידום. נדרש מזהה ישות.
INVALID נתוני הישות לא תקינים. יכול להיות 'פריט', 'FulfillmentOption', 'קידום מכירות'. נדרש מזהה ישות.
AVAILABILITY_CHANGED הפריט אינו זמין, או שאין מספיק פריטים למילוי הבקשה. נדרש מזהה ישות.
PRICE_CHANGED מחיר הפריט שונה מהמחיר בישות 'פריט'. חובה לציין מזהה ישות ומחיר מעודכן.
INCORRECT_PRICE שגיאות במחיר ב'עמלות', 'סה"כ'. חובה לציין מזהה ישות ומחיר מעודכן.
REQUIREMENTS_NOT_MET אין עמידה במגבלות על קבלת הזמנה – גודל סל מינימלי וכו'.
TOO_LATE פג התוקף של FulfillmentOption.
NO_CAPACITY אין קיבולת שירות זמינה. משתמשים בקוד השגיאה הזה אם אף אחד מסוגי השגיאות ברמת פירוט גבוהה יותר לא רלוונטי.
NO_COURIER_AVAILABLE לא מצאנו חברת משלוחים. סוג שגיאה מפורט שעשוי להיות מסווג כ-NO_CAPACITY.
INELIGIBLE המשתמש לא כשיר לביצוע ההזמנה (ברשימה שחורה).
OUT_OF_SERVICE_AREA לא ניתן לשלוח את ההזמנה לכתובת המבוקשת בגלל כללי גבול וכו'.
CLOSED המסעדה סגורה לעסקים בזמן ההזמנה.
PROMO_NOT_APPLICABLE קוד שגיאה כללי לזיהוי כל המקרים של כשל בהחלת קוד ההטבה, אם אף אחד מהקודמים לא מתאים. הוספת קוד הטבה כמזהה ישות.
PROMO_NOT_RECOGNIZED השותף לא זיהה את קוד השובר. הוספת קוד הטבה כמזהה ישות.
PROMO_EXPIRED לא ניתן להחיל כי פג התוקף של המבצע. הוספת קוד הטבה כמזהה ישות.
PROMO_USER_INELIGIBLE המשתמש הנוכחי אינו זכאי לשובר זה. הוספת קוד הטבה כמזהה ישות.
PROMO_ORDER_INELIGIBLE ההזמנה הנוכחית אינה כשירה לשובר זה. הוספת קוד הטבה כמזהה ישות.
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.

תיאור

סוג האירוע.

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

EventCharacter

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

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

enum (Type)

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

string

שם הדמות.
image

object (Image)

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

תיאור

סוג התו.

טיפוסים בני מנייה (enums)
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

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

טיפוסים בני מנייה (enums)
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, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
engagement

object (Engagement)

האינטראקציה של המשתמש הנוכחי, כולל כל המינויים ל-Intents.
packageEntitlements[]

object (PackageEntitlements)

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

enum (Permission)

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

AccountLinkingStatus

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

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

UserVerificationStatus

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

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

מעורבות

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

טיפוסים בני מנייה (enums)
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.

הרשאה

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

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

דף הבית

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

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

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

אפשרות. רשימת הפרמטרים המשויכים למבנה HomeGraph שאליו שייך מכשיר היעד. אפשר לעיין במסמכי התיעוד בנושא אחסון בבית: 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)

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

פונקציה

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

טיפוסים בני מנייה (enums)
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' ו-'locality' בלבד. ההרשאה 'מיקום מדויק' תאכלס שדות נוספים כמו 'administrativeArea' ו-'addressLines'.

TimeZone

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

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

string

אזור הזמן של מסד הנתונים IANA Time Zone Database, למשל "America/New_York".
version

string

אפשרות. מספר הגרסה של מסד הנתונים IANA Time Zone Database, למשל "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)

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

צפוי

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

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

string

רשימת ביטויים שהפעולה מצפה להם מהביטויים של המשתמש לצורך הטיית דיבור. אפשר להזין עד 1,000 ביטויים. הערה: לשדה הזה יש משמעות זהה לזו של השפה ה- הזדהות ב-API v2.