Files

גלישת טקסט לרשימת קבצים.

ייצוג JSON 
{

  // Union field file_type can be only one of the following:
  "configFiles": {
    object (ConfigFiles)
  },
  "dataFiles": {
    object (DataFiles)
  }
  // End of list of possible types for union field file_type.
}
שדות
שדה איחוד file_type. ניתן לשלוח לשרת רק קבצים מסוג אחד בכל פעם, קובצי תצורה או קובצי נתונים. הערך של file_type יכול להיות רק אחת מהאפשרויות הבאות:
configFiles

object (ConfigFiles)

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

object (DataFiles)

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

ConfigFiles

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

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

object (ConfigFile)

קובצי תצורה מרובים.

ConfigFile

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

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

  // Union field file can be only one of the following:
  "manifest": {
    object (Manifest)
  },
  "actions": {
    object (Actions)
  },
  "settings": {
    object (Settings)
  },
  "webhook": {
    object (Webhook)
  },
  "intent": {
    object (Intent)
  },
  "type": {
    object (Type)
  },
  "entitySet": {
    object (EntitySet)
  },
  "globalIntentEvent": {
    object (GlobalIntentEvent)
  },
  "scene": {
    object (Scene)
  },
  "staticPrompt": {
    object (StaticPrompt)
  },
  "accountLinkingSecret": {
    object (AccountLinkingSecret)
  },
  "resourceBundle": {
    object
  }
  // End of list of possible types for union field file.
}
שדות
filePath

string

נתיב יחסי של קובץ התצורה מבסיס הפרויקט במבנה קובץ ה-SDK. לכל אחד מסוגי הקבצים הבאים יש נתיב קובץ מותר. לדוגמה: settings/settings.yaml
שדה איחוד file. לכל סוג של קובץ תצורה צריך להיות שדה תואם באחד. הערך של file יכול להיות רק אחת מהאפשרויות הבאות:
manifest

object (Manifest)

קובץ מניפסט יחיד. נתיב הקובץ המותר: manifest.yaml
actions

object (Actions)

קובץ פעולות יחיד עם כל הפעולות מוגדרות. נתיבי קבצים מותרים: actions/{language}?/actions.yaml
settings

object (Settings)

הגדרת תצורה של הגדרות בודדות, שכוללת הגדרות והגדרות שלא ניתנות להתאמה לשוק המקומי, ללוקאל שמוגדר כברירת מחדל בפרויקט (אם צוין). בקובץ לשינוי מיקום, רק השדה localizedSettings יאוכלס. נתיבי קובץ מותרים: settings/{language}?/settings.yaml שים לב שקובץ ההגדרות settings/settings.yaml שאינו מותאם לשוק המקומי חייב להיות כלול בבקשות תהליך הכתיבה.
webhook

object (Webhook)

הגדרת webhook אחד. נתיב הקובץ המותר: webhooks/{WebhookName}.yaml
intent

object (Intent)

הגדרת Intent יחידה. נתיבי קבצים מותרים: custom/intents/{language}?/{IntentName}.yaml
type

object (Type)

הגדרת סוג יחיד. נתיבי קבצים מותרים: custom/types/{language}?/{TypeName}.yaml
entitySet

object (EntitySet)

הגדרה של קבוצת ישויות בודדת. נתיבי קבצים מותרים: custom/entitySets/{language}?/{EntitySetName}.yaml
globalIntentEvent

object (GlobalIntentEvent)

הגדרה אחת של אירוע Intent גלובלי. נתיבי קבצים מותרים: custom/global/{GlobalIntentEventName}.yaml שם הקובץ (GlobalIntentEventName) צריך להיות שם ה-Intent שאליו תואם אירוע ה-Intent הגלובלי הזה.
scene

object (Scene)

הגדרת סצנה בודדת. נתיבי קבצים מותרים: custom/scenes/{SceneName}.yaml
staticPrompt

object (StaticPrompt)

הגדרה של הנחיה סטטית אחת. נתיבי קבצים מותרים: custom/prompts/{language}?/{StaticPromptName}.yaml
accountLinkingSecret

object (AccountLinkingSecret)

מטא-נתונים התואמים לסוד הלקוח ששימש לקישור החשבונות. נתיב הקובץ המותר: settings/accountLinkingSecret.yaml
resourceBundle

object (Struct format)

חבילת משאבים בודדת, שהיא מפה ממחרוזת למחרוזת או לרשימת מחרוזות. אפשר להשתמש בחבילות משאבים להתאמה לשוק המקומי של מחרוזות בהנחיות סטטיות. נתיבי קבצים מותרים: resources/strings/{language}?/{multiple directories}?/{BundleName}.yaml

מניפסט

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

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

string

הגרסה של פורמט הקובץ. הגרסה הנוכחית של פורמט הקובץ היא 1.0 דוגמה: "1.0"

פעולות

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

ייצוג JSON 
{
  "custom": {
    string: {
      object (CustomAction)
    },
    ...
  }
}
שדות
custom

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

מיפוי מאובייקטים מסוג Intent לפעולות מותאמות אישית כדי להגדיר את ההפעלה של הפרויקט. אובייקטים מסוג Intent להפעלה יכולים להיות אובייקטים של מערכת או אובייקטים בהתאמה אישית עם כוונת רכישה שמוגדרים בחבילה 'בהתאמה אישית/כוונות/'. לכל האובייקטים מסוג Intent שמוגדרים כאן (אובייקטים מסוג Intent של המערכת ואובייקטים בהתאמה אישית מסוג Intent) חייב להיות קובץ Intent תואם בחבילה 'בהתאמה אישית/גלובלית/'.

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

CustomAction

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

ייצוג JSON 
{
  "engagement": {
    object (Engagement)
  }
}
שדות
engagement

object (Engagement)

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

מעורבות

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

ייצוג JSON 
{
  "title": string,
  "pushNotification": {
    object (PushNotification)
  },
  "actionLink": {
    object (ActionLink)
  },
  "assistantLink": {
    object (AssistantLink)
  },
  "dailyUpdate": {
    object (DailyUpdate)
  }
}
שדות
title

string

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

object (PushNotification)

הגדרות של התראות שנתמכות במעורבות הזו.
dailyUpdate

object (DailyUpdate)

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

PushNotification

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

DailyUpdate

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

הגדרות

מייצגות הגדרות של פרויקט פעולות שאינן ספציפיות ללוקאל. התג הבא: 22

ייצוג JSON 
{
  "projectId": string,
  "defaultLocale": string,
  "enabledRegions": [
    string
  ],
  "disabledRegions": [
    string
  ],
  "category": enum (Category),
  "usesTransactionsApi": boolean,
  "usesDigitalPurchaseApi": boolean,
  "usesInteractiveCanvas": boolean,
  "usesHomeStorage": boolean,
  "designedForFamily": boolean,
  "containsAlcoholOrTobaccoContent": boolean,
  "keepsMicOpen": boolean,
  "surfaceRequirements": {
    object (SurfaceRequirements)
  },
  "testingInstructions": string,
  "localizedSettings": {
    object (LocalizedSettings)
  },
  "accountLinking": {
    object (AccountLinking)
  },
  "selectedAndroidApps": [
    string
  ]
}
שדות
projectId

string

מזהה הפרויקט של הפעולות.
defaultLocale

string

הלוקאל שמוגדר כברירת המחדל של הפרויקט. בכל הקבצים מלבד resources/ ללא לוקאל בנתיב, הנתונים שהותאמו לשוק המקומי משויכים לdefaultLocale. לקבצים מתחת ל-resources/, אין לוקאל, כלומר המשאב רלוונטי לכל הלוקאלים.
enabledRegions[]

string

התרשים מייצג את האזורים שבהם משתמשים יכולים להפעיל את הפעולות, על סמך מיקום הנוכחות של המשתמש. לא ניתן לקבוע אם המדיניות disabledRegions מוגדרת. אם לא מציינים את enabledRegions וגם את disabledRegions, המשתמשים יכולים להפעיל את הפעולות בכל האזורים. כל אזור מיוצג באמצעות השם הקנוני של המיקודים הגיאוגרפיים ב-AdWords. ראה https://developers.google.com/adwords/api/docs/appendix/geotargeting דוגמאות: - "גרמניה" - "גאנה" - "יוון" - "גרנאדה" - "בריטניה" - "ארצות הברית" - "האיים המרוחקים הקטנים של ארצות הברית" - "אורוגוואי"
disabledRegions[]

string

האזורים שבהם הפעולות נחסמו, על סמך מיקום המשתמש של המשתמש. לא ניתן לקבוע אם המדיניות enabledRegions מוגדרת. כל אזור מיוצג באמצעות השם הקנוני של המיקודים הגיאוגרפיים ב-AdWords. ראה https://developers.google.com/adwords/api/docs/appendix/geotargeting דוגמאות: - "גרמניה" - "גאנה" - "יוון" - "גרנאדה" - "בריטניה" - "ארצות הברית" - "האיים המרוחקים הקטנים של ארצות הברית" - "אורוגוואי"
category

enum (Category)

הקטגוריה של פרויקט הפעולות הזה.
usesTransactionsApi

boolean

האם הפעולות יכולות לכלול עסקאות (לדוגמה, ביצוע הזמנות, קבלת הזמנות וכו'). אם הערך הוא False, הניסיונות להשתמש בממשקי ה-API של טרנזקציות ייכשלו.
usesDigitalPurchaseApi

boolean

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

boolean

האם הפעולות כוללות לוח שיתופי אינטראקטיבי.
usesHomeStorage

boolean

אם בפעולות נעשה שימוש בתכונת האחסון של הבית.
designedForFamily

boolean

האם התוכן של 'פעולות' מתאים לכל המשפחה (DFF).
containsAlcoholOrTobaccoContent

boolean

אם הפעולות כוללות תוכן שקשור לאלכוהול או לטבק.
keepsMicOpen

boolean

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

object (SurfaceRequirements)

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

string

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

object (LocalizedSettings)

הגדרות מותאמות לשוק המקומי ללוקאל שמוגדר כברירת מחדל בפרויקט. לכל מיקום נוסף צריך להיות קובץ הגדרות משלו בספרייה משלו.
accountLinking

object (AccountLinking)

המשתמשים יכולים ליצור או לקשר חשבונות באמצעות כניסה באמצעות חשבון Google ו/או שירות OAuth משלך.
selectedAndroidApps[]

string

אפליקציות ל-Android שנבחרו כדי לגשת לרכישות ב-Google Play עבור עסקאות. זו בחירה מתוך האפליקציות ל-Android שמקושרות לפרויקט הפעולות, כדי לאמת את הבעלות על המותג ולהפעיל תכונות נוספות. מידע נוסף זמין בכתובת https://developers.google.com/assistant/console/brand-verification.

קטגוריה

קטגוריות אפשריות של פרויקטים בפרויקט פעולות.

טיפוסים בני מנייה (enums)
CATEGORY_UNSPECIFIED לא ידוע / לא צוין.
BUSINESS_AND_FINANCE הקטגוריה 'עסקים ופיננסים'.
EDUCATION_AND_REFERENCE הקטגוריה 'חינוך והפניה'.
FOOD_AND_DRINK קטגוריית האוכל והשתייה.
GAMES_AND_TRIVIA משחקים וטריוויה.
HEALTH_AND_FITNESS הקטגוריה 'בריאות וכושר'.
KIDS_AND_FAMILY ילדים ומשפחה.
LIFESTYLE קטגוריית סגנון חיים.
LOCAL קטגוריה מקומית.
MOVIES_AND_TV הקטגוריה 'סרטים ותוכניות טלוויזיה'.
MUSIC_AND_AUDIO קטגוריית מוזיקה ואודיו.
NEWS קטגוריית חדשות,
NOVELTY_AND_HUMOR נועז והומור.
PRODUCTIVITY קטגוריית פרודוקטיביות.
SHOPPING קטגוריית שופינג.
SOCIAL קטגוריה חברתית.
SPORTS קטגוריית ספורט.
TRAVEL_AND_TRANSPORTATION הקטגוריה 'נסיעות ותחבורה'.
UTILITIES קטגוריית כלי תחזוקה.
WEATHER קטגוריית מזג אוויר.
HOME_CONTROL קטגוריית הבית החכם.

SurfaceRequirements

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

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

object (CapabilityRequirement)

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

CapabilityRequirement

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

ייצוג JSON 
{
  "capability": enum (SurfaceCapability)
}
שדות
capability

enum (SurfaceCapability)

סוג היכולת.

SurfaceCapability

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

טיפוסים בני מנייה (enums)
SURFACE_CAPABILITY_UNSPECIFIED לא ידוע / לא צוין.
AUDIO_OUTPUT המשטחים תומכים בפלט אודיו.
SCREEN_OUTPUT המשטח תומך בפלט מסך/פלט חזותי.
MEDIA_RESPONSE_AUDIO 'פניה' תומך באודיו של תגובה למדיה.
WEB_BROWSER פלטפורמת Surface תומכת בדפדפני אינטרנט.
ACCOUNT_LINKING הפלטפורמה תומכת בקישור חשבונות.
INTERACTIVE_CANVAS המשטחים תומכים בלוח הציור האינטראקטיבי.
HOME_STORAGE הפלטפורמה תומכת באחסון בבית.

LocalizedSettings

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

ייצוג JSON 
{
  "displayName": string,
  "pronunciation": string,
  "shortDescription": string,
  "fullDescription": string,
  "smallLogoImage": string,
  "largeBannerImage": string,
  "developerName": string,
  "developerEmail": string,
  "termsOfServiceUrl": string,
  "voice": string,
  "voiceLocale": string,
  "privacyPolicyUrl": string,
  "sampleInvocations": [
    string
  ],
  "themeCustomization": {
    object (ThemeCustomization)
  }
}
שדות
displayName

string

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

string

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

string

חובה. התיאור הקצר שמוגדר כברירת מחדל לפרויקט הפעולות (אם אין תרגום זמין). עד 80 תווים.
fullDescription

string

חובה. התיאור הארוך שמוגדר כברירת מחדל לפרויקט הפעולות (אם אין תרגום זמין). עד 4,000 תווים.
smallLogoImage

string

חובה. תמונה מרובעת קטנה, 192 x 192 פיקסלים. צריך לציין את זה בתור הפניה לתמונה התואמת בספרייה resources/images/. לדוגמה, $resources.images.foo (ללא התוסף) לתמונה ב-resources/images/foo.jpg כשעובדים על פרויקט שנשלף מ-Play Console, ניתן להשתמש בכתובת ה-URL ש-Google מנהלת. כתובות אתרים ממקורות חיצוניים אינן מותרות.
largeBannerImage

string

אפשרות. תמונה גדולה לרוחב, 1920 x 1080 פיקסלים. צריך לציין את זה בתור הפניה לתמונה התואמת בספרייה resources/images/. לדוגמה, $resources.images.foo (ללא התוסף) לתמונה ב-resources/images/foo.jpg כשעובדים על פרויקט שנשלף מ-Play Console, ניתן להשתמש בכתובת ה-URL ש-Google מנהלת. כתובות אתרים ממקורות חיצוניים אינן מותרות.
developerName

string

חובה. שם המפתח שיוצג למשתמשים.
developerEmail

string

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

string

אפשרות. כתובת ה-URL של התנאים וההגבלות.
voice

string

חובה. הקול של Google Assistant שהמשתמשים שומעים כשהם מבצעים פעולות. הערכים הנתמכים הם "male_1", "male_2", "נקבה_1" ו-"נקבה_2".
voiceLocale

string

אפשרות. הלוקאל של הקול שצוין. אם לא מציינים שום אפשרות, היא מקבלת את הערך של לוקאל Assistant של המשתמש. אם צוין, ללוקאל של הקול חייבת להיות אותה שפת בסיס כמו של הלוקאל שצוין ב-LocalizedSettings.
privacyPolicyUrl

string

חובה. כתובת ה-URL של מדיניות הפרטיות.
sampleInvocations[]

string

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

object (ThemeCustomization)

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

ThemeCustomization

סגנונות שהוחלו על כרטיסים שמוצגים למשתמשים

ייצוג JSON 
{
  "backgroundColor": string,
  "primaryColor": string,
  "fontFamily": string,
  "imageCornerStyle": enum (ImageCornerStyle),
  "landscapeBackgroundImage": string,
  "portraitBackgroundImage": string
}
שדות
backgroundColor

string

צבע הרקע של הכרטיסים. משמשת כחלופה אם המפתחים background_image לא מספקים, או ש-background_image לא מתאים לפלטפורמות מסוימות. שימוש לדוגמה: #FAFAFA
primaryColor

string

צבע העיצוב הראשי של הפעולה ישמש להגדרת צבע הטקסט של הכותרת וצבע הרקע של פריט לביצוע בכרטיסים של Actions on Google. שימוש לדוגמה: #FAFAFA
fontFamily

string

משפחת הגופנים שתשמש לשמות של כרטיסים. גופנים נתמכים: - Sans Serif - Sans Serif Medium - Sans Serif Bold - Sans Serif Black - Sans Serif דחוס - Sans Serif דחוס בינוני - Serif - Serif Bold - Monospace - Cursive - אותיות קטנות של Sans Serif
imageCornerStyle

enum (ImageCornerStyle)

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

string

פריסה לרוחב (מינימום 1920x1200 פיקסלים). צריך לציין את זה בתור הפניה לתמונה התואמת בספרייה resources/images/. למשל: $resources.images.foo (ללא התוסף) לתמונה ב-resources/images/foo.jpg כשעובדים על פרויקט שנשלף ממסוף, ניתן להשתמש בכתובת ה-URL המנוהלת על ידי Google.
portraitBackgroundImage

string

פריסה לאורך (מינימום 1,200x1,920 פיקסלים). צריך לציין את זה בתור הפניה לתמונה התואמת בספרייה resources/images/. למשל: $resources.images.foo (ללא התוסף) לתמונה ב-resources/images/foo.jpg כשעובדים על פרויקט שנשלף ממסוף, ניתן להשתמש בכתובת ה-URL המנוהלת על ידי Google.

ImageCornerStyle

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

טיפוסים בני מנייה (enums)
IMAGE_CORNER_STYLE_UNSPECIFIED לא מוגדר / לא מוגדר.
CURVED עיגול פינה לתמונה.
ANGLED פינה מלבנית לתמונה.

AccountLinking

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

עבור סוגי הקישור 'כניסה באמצעות חשבון Google' ו'כניסה באמצעות חשבון Google' ו-'OAuth + Google', Google יוצרת מזהה לקוח שמזהה את האפליקציה שלכם בפני Google ('מזהה לקוח ש-Google מנפיקה ל-Actions' בממשק המשתמש של המסוף). השדה הזה הוא לקריאה בלבד וניתן לבדוק אותו על ידי ניווט לדף קישור החשבון בממשק המשתמש של המסוף. למידע נוסף: https://developers.google.com/assistant/identity/google-sign-in

הערה: בכל סוגי ההגדרות של קישור חשבונות (מלבד כניסה באמצעות חשבון Google), עליכם לציין שם משתמש וסיסמה לחשבון בדיקה ב-Settings.testing_instructions כדי שצוות הבדיקה יבדוק את האפליקציה (הם לא יהיו גלויים למשתמשים).

ייצוג JSON 
{
  "enableAccountCreation": boolean,
  "linkingType": enum (LinkingType),
  "authGrantType": enum (AuthGrantType),
  "appClientId": string,
  "authorizationUrl": string,
  "tokenUrl": string,
  "scopes": [
    string
  ],
  "learnMoreUrl": string,
  "useBasicAuthHeader": boolean
}
שדות
enableAccountCreation

boolean

חובה. אם true, המשתמשים יוכלו להירשם לחשבונות חדשים באמצעות הקול. אם false, ניתן ליצור חשבון רק באתר שלך. יש לבחור באפשרות הזו אם רוצים להציג את התנאים וההגבלות או לקבל את הסכמת המשתמשים במהלך ההרשמה. סוג הקישור לא יכול להיות GOOGLE_SIGN_IN כאשר הערך הוא false. לא ניתן להשתמש ב-OAUTH של סוג הקישור כשהערך הוא true.
linkingType

enum (LinkingType)

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

enum (AuthGrantType)

אפשרות. מציין את סוג האימות עבור OAUTH LinkingType.
appClientId

string

אפשרות. מזהה הלקוח שהונפק על ידי האפליקציה ל-Google. זהו מזהה הלקוח של OAuth2 שמזהה את Google לשירות שלכם. מוגדרת רק כשמשתמשים ב-OAuth.
authorizationUrl

string

אפשרות. נקודת קצה עבור דף האינטרנט המשמש לכניסה שתומך בקוד OAuth2 או בתהליכים משתמעים. כתובת ה-URL חייבת להשתמש ב-HTTPS. מוגדרת רק כשמשתמשים ב-OAuth.
tokenUrl

string

אפשרות. נקודת הקצה של OAuth2 להמרת אסימונים. כתובת ה-URL חייבת להשתמש ב-HTTPS. האפשרות הזו לא מוגדרת רק כשמשתמשים ב-OAuth עם הרשאת IMPLICIT כסוג הקישור. מוגדרת רק כשמשתמשים ב-OAuth.
scopes[]

string

אפשרות. רשימת הרשאות שהמשתמש צריך להסכים להן כדי להשתמש בשירות שלך. מוגדרת רק כשמשתמשים ב-OAuth. הקפד לספק תנאים והגבלות בפרטי הספרייה בקטע LocalizedSettings.terms_of_service_url אם אתה מציין שדה זה.
learnMoreUrl

string

אפשרות. זהו דף האינטרנט בשירות שלך שמתאר את ההרשאות שהמשתמש מעניק ל-Google. מוגדרת רק לשימוש ב-OAuth ובכניסה באמצעות חשבון Google. הקפד לספק תנאים והגבלות בפרטי הספרייה בקטע LocalizedSettings.terms_of_service_url אם אתה מציין שדה זה.
useBasicAuthHeader

boolean

אפשרות. אם המדיניות הזו מוגדרת כ-True, אפשר ל-Google לשדר מזהה לקוח וסוד דרך כותרת אימות בסיסית ב-HTTP. אחרת, Google משתמשת במזהה הלקוח ובסוד שבתוך גוף הפוסט. מוגדרת רק כשמשתמשים ב-OAuth. הקפד לספק תנאים והגבלות בפרטי הספרייה בקטע LocalizedSettings.terms_of_service_url אם אתה מציין שדה זה.

LinkingType

הסוג של קישור החשבונות שצריך לבצע.

טיפוסים בני מנייה (enums)
LINKING_TYPE_UNSPECIFIED לא צוינה.
GOOGLE_SIGN_IN סוג הקישור לכניסה באמצעות חשבון Google. אם משתמשים בסוג הקישור הזה, אין צורך להגדיר למטה שדות שקשורים ל-OAuth.
OAUTH_AND_GOOGLE_SIGN_IN סוג הקישור של OAuth וכניסה באמצעות חשבון Google.
OAUTH סוג קישור OAuth.

AuthGrantType

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

טיפוסים בני מנייה (enums)
AUTH_GRANT_TYPE_UNSPECIFIED לא צוינה.
AUTH_CODE הענקת קוד הרשאה. כדי לעשות את זה, צריך לספק גם כתובת URL לאימות וגם כתובת URL של אסימון גישה.
IMPLICIT הענקת קוד מרומז. חובה לספק רק כתובת URL לאימות.

Webhook

מטא-נתונים לסוגים שונים של webhooks. אם משתמשים ב-inlineCloudFunction, קוד המקור חייב להיות בספרייה עם שם שזהה לערך של המפתח executeFunction. לדוגמה, לערך של my_webhook עבור המפתח executeFunction יהיה מבנה קוד כמו: - /webhooks/my_webhook.yaml - /webhooks/my_webhook/index.js - /webhooks/my_webhook/package.json

ייצוג JSON 
{
  "handlers": [
    {
      object (Handler)
    }
  ],

  // Union field webhook_type can be only one of the following:
  "httpsEndpoint": {
    object (HttpsEndpoint)
  },
  "inlineCloudFunction": {
    object (InlineCloudFunction)
  }
  // End of list of possible types for union field webhook_type.
}
שדות
handlers[]

object (Handler)

רשימת גורמי handler ל-webhook הזה.
שדה איחוד webhook_type. יש תמיכה רק בסוג אחד של תגובה לפעולה מאתר אחר (webhook). הערך של webhook_type יכול להיות רק אחת מהאפשרויות הבאות:
httpsEndpoint

object (HttpsEndpoint)

נקודת קצה (endpoint) מסוג webhook HTTPS בהתאמה אישית.
inlineCloudFunction

object (InlineCloudFunction)

מטא-נתונים של הפונקציה ב-Cloud Functions שנפרסה מקוד בתיקיית ה-webhooks.

מטפל

הצהרה על השם של ה-handler של webhoook. ל-webhook יכולים להיות כמה גורמי handler רשומים. אפשר לקרוא לרכיבי ה-handler האלה מכמה מקומות בפרויקט הפעולות.

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

string

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

HttpsEndpoint

נקודת הקצה של REST לקבלת התראה אם אתם לא משתמשים בעורך המוטבע.

ייצוג JSON 
{
  "baseUrl": string,
  "httpHeaders": {
    string: string,
    ...
  },
  "endpointApiVersion": integer
}
שדות
baseUrl

string

כתובת ה-URL הבסיסית מסוג HTTPS של נקודת הקצה של מילוי הבקשה (אין תמיכה ב-HTTP). שמות של כינויים מצורפים לנתיב כתובת ה-URL הבסיסית אחרי נקודתיים (לפי מדריך הסגנון בכתובת https://cloud.google.com/apis/design/custom_methods). לדוגמה, כתובת ה-URL הבסיסית 'https://gactions.service.com/api' תקבל בקשות עם כתובת ה-URL 'https://gactions.service.com/api:{method}'.
httpHeaders

map (key: string, value: string)

מפה של הפרמטרים של HTTP שיש לכלול בבקשת ה-POST.

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

integer

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

InlineCloudFunction

מכילה את המטא-נתונים של פונקציה מוטבעת ב-Cloud Functions שנפרסה מתיקיית ה-webhooks.

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

string

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

כוונת רכישה

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

ייצוג JSON 
{
  "parameters": [
    {
      object (IntentParameter)
    }
  ],
  "trainingPhrases": [
    string
  ]
}
שדות
parameters[]

object (IntentParameter)

רשימת הפרמטרים בתוך ביטויי האימון. חייבים להגדיר כאן את כל הפרמטרים כדי להשתמש בהם בביטוי האימון.
trainingPhrases[]

string

ביטויי אימון מאפשרים ל-NLU של Google להתאים באופן אוטומטי בין כוונות לבין קלט של משתמשים. ככל שמספקים יותר ביטויים ייחודיים, כך גובר הסיכוי להתאמה של הכוונה הזו. זהו פורמט החלק של ביטוי האימון שמבואר. הערה: השדה auto הוא אופציונלי, והתנהגות ברירת המחדל כשלא מציינים את הערך auto זהה לזו של auto=false. המשמעות של ($<paramName> '<sample text>' auto=<true or false>) auto = true היא שלחלק נוספה הערות באופן אוטומטי על ידי NLU. auto = false פירושו שהמשתמש הוסיף הערה לחלק הזה. זו ברירת המחדל שבה לא צוין אוטומטי. דוגמה: "הזמנת טיסה מ-($source 'San Francisco' auto=false) אל ($dest 'Vancouver')"

IntentParameter

הגדרה של פרמטר שאפשר להשתמש בו בביטויים לאימון.

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

  // Union field parameter_type can be only one of the following:
  "type": {
    object (ClassReference)
  },
  "entitySetReferences": {
    object (EntitySetReferences)
  }
  // End of list of possible types for union field parameter_type.
}
שדות
name

string

חובה. השם הייחודי של הפרמטר Intent. אפשר להשתמש בתנאים ובתגובות כדי להפנות לפרמטרים של Intent שחולצו על ידי NLU עם $intent.params.[name].resolved
שדה איחוד parameter_type. הסוג של הפרמטר Intent. הערך של parameter_type יכול להיות רק אחת מהאפשרויות הבאות:
type

object (ClassReference)

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

object (EntitySetReferences)

אפשרות. הפניות לקבוצות של ישויות מותרות לפרמטר Intent הזה. תקף רק לפרמטרים של Intent מובנה. ההפניות האלה מפנות לקבוצות של ישויות בספרייה 'custom/entitySets'.

ClassReference

הפניה למחלקה שמשמשת להצהרה על סוג השדה או להחזרת ערך. טיפוסים בני מנייה (Enum) הם גם סוג של מחלקה שניתן להפנות אליה באמצעות ClassReference.

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

string

חובה. שם של סוג מובנה או סוג מותאם אישית של הפרמטר. דוגמאות: PizzaToppings, actions.type.Number
list

boolean

אפשרות. מציין אם סוג הנתונים מייצג רשימת ערכים.

EntitySetReferences

הפניות לקבוצות של ישויות לפרמטר Intent.

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

object (EntitySetReference)

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

EntitySetReference

הפניה לקבוצת הישויות המותרות עבור פרמטר ה-Intent הזה.

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

string

חובה. מציין את אוסף הישויות הספציפי שיש להביא בחשבון עבור פרמטר נתון. ההגדרה התואמת של קבוצת הישויות צריכה להיות בספרייה custom/entitySets/ .

תיאור

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

ייצוג JSON 
{
  "exclusions": [
    string
  ],

  // Union field sub_type can be only one of the following:
  "synonym": {
    object (SynonymType)
  },
  "regularExpression": {
    object (RegularExpressionType)
  },
  "freeText": {
    object (FreeTextType)
  }
  // End of list of possible types for union field sub_type.
}
שדות
exclusions[]

string

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

object (SynonymType)

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

object (RegularExpressionType)

סוג ביטוי רגולרי (regex), מאפשר התאמה של ביטויים רגולריים.
freeText

object (FreeTextType)

סוג FreeText.

SynonymType

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

ייצוג JSON 
{
  "matchType": enum (MatchType),
  "acceptUnknownValues": boolean,
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
שדות
matchType

enum (MatchType)

אפשרות. סוג ההתאמה למילה הנרדפת.
acceptUnknownValues

boolean

אפשרות. אם הערך מוגדר כ-True, המערכת תתאים בין מילים או ביטויים לא ידועים על סמך נתוני הקלט ואימוני הכוונות שלכם, כמו פריטים שעשויים להתווסף לרשימת קניות.
entities

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

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

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

MatchType

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

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

ישות

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

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

object (EntityDisplay)

אפשרות. פרטי הישות מוצגים.
synonyms[]

string

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

EntityDisplay

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

ייצוג JSON 
{
  "iconTitle": string,
  "iconUrl": string
}
שדות
iconTitle

string

אפשרות. שם הסמל.
iconUrl

string

חובה. כתובת ה-URL של הסמל.

RegularExpressionType

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

ייצוג JSON 
{
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
שדות
entities

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

חובה. מפה בעלת שם של ישויות שכל אחת מהן מכילה מחרוזות ביטוי רגולרי (regex).

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

ישות

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

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

object (EntityDisplay)

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

string

חובה. נעשה שימוש בתחביר של ביטוי רגולרי RE2 (פרטים נוספים זמינים בכתובת https://github.com/google/re2/wiki/Syntax)

FreeTextType

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

ייצוג JSON 
{
  "display": {
    object (EntityDisplay)
  }
}
שדות
display

object (EntityDisplay)

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

EntitySet

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

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

object (Entity)

חובה. רשימת הישויות שנתמכות בקבוצת הישויות הזו.

ישות

ישות יכולה להגיע מערך פרמטר Intent מובנה.

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

string

חובה. המזהה של הישות. בכתובת https://developers.google.com/assistant/conversational/build/built-in-intents תמצאו רשימה של פרמטרים מובנים בהתאמה אישית ושל הישויות הנתמכות בהם.

GlobalIntentEvent

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

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

הערה, שם ה-Intent מצוין בשם הקובץ.

ייצוג JSON 
{
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
שדות
transitionToScene

string

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

object (EventHandler)

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

EventHandler

מגדירה handler שצריך לבצע אחרי אירוע. דוגמאות לאירועים: אירועים שמבוססים על כוונת רכישה ותנאים בסצנה.

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

  // Union field prompt can be only one of the following:
  "staticPrompt": {
    object (StaticPrompt)
  },
  "staticPromptName": string
  // End of list of possible types for union field prompt.
}
שדות
webhookHandler

string

השם של ה-handler של תגובה לפעולה מאתר אחר (webhook) שאליו רוצים לקרוא.
שדה איחוד prompt. אפשר להוסיף הנחיות בתוך השורה או להפנות אליהן לפי השם. הערך של prompt יכול להיות רק אחת מהאפשרויות הבאות:
staticPrompt

object (StaticPrompt)

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

string

שם ההנחיה הסטטית להפעלה.

StaticPrompt

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

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

object (StaticPromptCandidate)

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

StaticPromptCandidate

מייצג מועמד להנחיה סטטית.

ייצוג JSON 
{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
שדות
selector

object (Selector)

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

object (StaticPromptResponse)

התגובה לפעולה שמשויכת לבורר.

בורר

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

ייצוג JSON 
{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}
שדות
surfaceCapabilities

object (SurfaceCapabilities)

קבוצת יכולות השטח הנדרשות.

SurfaceCapabilities

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

ייצוג JSON 
{
  "capabilities": [
    enum (Capability)
  ]
}
שדות
capabilities[]

enum (Capability)

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

פונקציה

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

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

StaticPromptResponse

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

ייצוג JSON 
{
  "firstSimple": {
    object (StaticSimplePrompt)
  },
  "content": {
    object (StaticContentPrompt)
  },
  "lastSimple": {
    object (StaticSimplePrompt)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (StaticLinkPrompt)
  },
  "override": boolean,
  "canvas": {
    object (StaticCanvasPrompt)
  }
}
שדות
firstSimple

object (StaticSimplePrompt)

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

object (StaticContentPrompt)

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

object (StaticSimplePrompt)

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

object (Suggestion)

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

boolean

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

object (StaticCanvasPrompt)

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

StaticSimplePrompt

מייצג הנחיה פשוטה לשליחה למשתמש.

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

object (Variant)

רשימת וריאציות אפשריות.

וריאנט

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

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

string

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

string

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

StaticContentPrompt

placeholder לחלק התוכן של StaticPrompt.

ייצוג JSON 
{

  // Union field content can be only one of the following:
  "card": {
    object (StaticCardPrompt)
  },
  "image": {
    object (StaticImagePrompt)
  },
  "table": {
    object (StaticTablePrompt)
  },
  "media": {
    object (StaticMediaPrompt)
  },
  "list": {
    object (StaticListPrompt)
  },
  "collection": {
    object (StaticCollectionPrompt)
  },
  "collectionBrowse": {
    object (StaticCollectionBrowsePrompt)
  }
  // End of list of possible types for union field content.
}
שדות
שדה איחוד content. בהנחיה אפשר לכלול רק סוג אחד של תוכן. הערך של content יכול להיות רק אחת מהאפשרויות הבאות:
card

object (StaticCardPrompt)

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

object (StaticImagePrompt)

תמונה.
table

object (StaticTablePrompt)

כרטיס טבלה.
media

object (StaticMediaPrompt)

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

object (StaticListPrompt)

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

object (StaticCollectionPrompt)

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

object (StaticCollectionBrowsePrompt)

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

StaticCardPrompt

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

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

string

אפשרות. השם הכולל של הכרטיס.
subtitle

string

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

string

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

object (StaticImagePrompt)

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

enum (ImageFill)

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

object (StaticLinkPrompt)

אפשרות. לחצן שניתן ללחוץ עליו שיוצג בכרטיס.

StaticImagePrompt

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

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

StaticLinkPrompt

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

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

string

שם הקישור
open

object (OpenUrl)

הגדרת ההתנהגות כשהמשתמש פותח את הקישור.

OpenUrl

הגדרת ההתנהגות כשהמשתמש פותח את הקישור.

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

string

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

enum (UrlHint)

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

UrlHint

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

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

StaticTablePrompt

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

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

string

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

string

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

object (StaticImagePrompt)

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

object (TableColumn)

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

object (TableRow)

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

object (StaticLinkPrompt)

אפשרות. לחצן.

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

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

StaticMediaPrompt

מכיל מידע על המדיה, כמו שם, תיאור, כתובת URL וכו'. המזהה הבא: 11

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

enum (MediaType)

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

string (Duration format)

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

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

enum (OptionalMediaControls)

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

object (MediaObject)

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

enum (RepeatMode)

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

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 שמפנה לתוכן המדיה.
image

object (MediaImage)

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

MediaImage

תמונה שתוצג בתוך MediaPrompt.

ייצוג JSON 
{

  // Union field image can be only one of the following:
  "large": {
    object (StaticImagePrompt)
  },
  "icon": {
    object (StaticImagePrompt)
  }
  // End of list of possible types for union field image.
}
שדות
שדה איחוד image. מותר להשתמש רק בסוג אחד של MediaImage. הערך של image יכול להיות רק אחת מהאפשרויות הבאות:
large

object (StaticImagePrompt)

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

object (StaticImagePrompt)

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

RepeatMode

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

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

StaticListPrompt

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

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

string

אפשרות. שם הרשימה.
subtitle

string

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

object (ListItem)

חובה. פריטים ברשימה.

ListItem

פריט ברשימה.

ייצוג JSON 
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
שדות
key

string

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

string

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

string

אפשרות. טקסט גוף הפריט.
image

object (StaticImagePrompt)

אפשרות. תמונת פריט.

StaticCollectionPrompt

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

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

string

אפשרות. שם האוסף.
subtitle

string

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

object (CollectionItem)

חובה. פריטים באוסף.
imageFill

enum (ImageFill)

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

CollectionItem

פריט באוסף.

ייצוג JSON 
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
שדות
key

string

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

string

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

string

אפשרות. טקסט גוף הפריט.
image

object (StaticImagePrompt)

אפשרות. תמונת פריט.

StaticCollectionBrowsePrompt

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

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

object (CollectionBrowseItem)

פריטים באוסף העיון. גודל הרשימה צריך להיות בטווח [2, 10].
imageFill

enum (ImageFill)

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

CollectionBrowseItem

פריט באוסף.

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

string

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

string

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

string

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

object (StaticImagePrompt)

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

object (OpenUrl)

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

הצעה

מייצג צ'יפ של הצעה, רכיב בממשק המשתמש שמוצג למשתמש לנוחותו.

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

string

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

StaticCanvasPrompt

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

ייצוג JSON 
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "sendStateDataToCanvasApp": boolean,
  "enableFullScreen": boolean
}
שדות
url

string

חובה. כתובת ה-URL של תצוגת האינטרנט לטעינה.
data[]

value (Value format)

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

boolean

אפשרות. ערך אמיתי פירושו שהמיקרופון לא ייפתח לצורך הקלטת קלט אחרי שהתגובה העשירה הזו תוצג למשתמש.
sendStateDataToCanvasApp

boolean

אפשרות. אם הטבלה true, נכללים מטא-נתונים שקשורים לשיחות ונשלחים בחזרה לאפליקציית לוח הציור.
enableFullScreen

boolean

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

סביבת תאורה

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

ייצוג JSON 
{
  "onEnter": {
    object (EventHandler)
  },
  "intentEvents": [
    {
      object (IntentEvent)
    }
  ],
  "conditionalEvents": [
    {
      object (ConditionalEvent)
    }
  ],
  "slots": [
    {
      object (Slot)
    }
  ],
  "onSlotUpdated": {
    object (EventHandler)
  }
}
שדות
onEnter

object (EventHandler)

handler שצריך להפעיל כשעוברים לסצנה הזו.
intentEvents[]

object (IntentEvent)

רשימת האירועים שמופעלים על סמך כוונות Intent. ניתן להפעיל את האירועים האלה בכל שלב לאחר קריאה ל-handler של on_load. חשוב – האירועים האלה מגדירים את קבוצת האובייקטים מסוג Intent שמתאימים לסצנה הזו, והם יקבלו עדיפות על פני כל אירוע שמוגדר באופן גלובלי עם אותן כוונות או ביטויי הפעלה. שמות של Intent חייבים להיות ייחודיים בתוך סצנה.
conditionalEvents[]

object (ConditionalEvent)

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

object (Slot)

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

object (EventHandler)

בוצעה קריאה ל-handler הנקרא כשיש שינוי במצב של יחידת קיבולת (Slot) שלא נגרם על ידי עדכונים אצל handler אחר. כך ניתן לבטל את התוקף של יחידות הקיבולת (Slot), לבטל את התוקף של הסצנה או לבצע שינויים אחרים במצב הסצנה.

IntentEvent

רושם אירועים שהופעלו כתוצאה מהתאמת Intent.

ייצוג JSON 
{
  "intent": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
שדות
intent

string

חובה. Intent שהפעיל את האירוע.
transitionToScene

string

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

object (EventHandler)

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

ConditionalEvent

רושם אירועים שהופעלו כתוצאה מתנאי True.

ייצוג JSON 
{
  "condition": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
שדות
condition

string

חובה. תנאי סינון שהאירוע הזה יופעל. אם התנאי מקבל ערך True, אז ה-handler המשויך יופעל. המערכת תומכת בהפניות למשתנים הבאים: $session – כדי להפנות לנתונים באחסון של הסשן. $user – כדי להפנות לנתונים באחסון של המשתמש. האופרטורים הבוליאניים הבאים נתמכים (עם דוגמאות): && - session.params.counter > 0 && session.params.counter < 100 || - session.params.foo == "John" || session.params.counter == "Adam" ! - !(session.params.counter == 5) ההשוואות הבאות נתמכות: ==, !=, <, >, <=, >= הרשימה הבאה ואופרטורים של מחרוזות נתמכים (עם דוגמאות): in - "Watermelon" ב-session.params.fruitList size - size - sizesize(session.params.fruitList) > 2substringsession.params.fullName.contains("John")
transitionToScene

string

אפשרות. סצנת היעד שאליה השיחה צריכה לעבור כשמתבצעת ההערכה של התנאי המשויך כ-True. המצב של הסצנה הנוכחית נהרס במהלך המעבר.
handler

object (EventHandler)

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

משבצת

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

ייצוג JSON 
{
  "name": string,
  "type": {
    object (ClassReference)
  },
  "required": boolean,
  "promptSettings": {
    object (PromptSettings)
  },
  "commitBehavior": {
    object (CommitBehavior)
  },
  "config": value,
  "defaultValue": {
    object (DefaultValue)
  }
}
שדות
name

string

חובה. השם של יחידת הקיבולת (Slot).
type

object (ClassReference)

חובה. סוג הנתונים של יחידת הקיבולת (Slot) הזו.
required

boolean

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

object (PromptSettings)

אפשרות. רושם הודעות לשלבים שונים של מילוי יחידות קיבולת (Slot).
commitBehavior

object (CommitBehavior)

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

value (Value format)

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

דוגמה: עבור יחידת קיבולת (Slot) מסוג actions.type.CompletePurchaseValue, ההגדרה הבאה מציעה הזמנת מוצר דיגיטלית עם הפניה לפרמטר סשן בהגדרת הלקוח userSelectedSkuId:

{ "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" } }
defaultValue

object (DefaultValue)

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

PromptSettings

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

ייצוג JSON 
{
  "initialPrompt": {
    object (EventHandler)
  },
  "noMatchPrompt1": {
    object (EventHandler)
  },
  "noMatchPrompt2": {
    object (EventHandler)
  },
  "noMatchFinalPrompt": {
    object (EventHandler)
  },
  "noInputPrompt1": {
    object (EventHandler)
  },
  "noInputPrompt2": {
    object (EventHandler)
  },
  "noInputFinalPrompt": {
    object (EventHandler)
  }
}
שדות
initialPrompt

object (EventHandler)

מבקשים מהערך של יחידת הקיבולת (Slot) עצמה. דוגמה: "באיזה גודל רצית?"
noMatchPrompt1

object (EventHandler)

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

object (EventHandler)

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

object (EventHandler)

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

object (EventHandler)

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

object (EventHandler)

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

object (EventHandler)

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

CommitBehavior

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

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

string

פרמטר הסשן שכותב את ערך המיקום אחרי שממלאים אותו. לתשומת ליבכם: בשלב הזה אין תמיכה בנתיבים מקוננים. '$$' משמש לכתיבת הערך של מיקום המשבצת לפרמטר של סשן עם שם שזהה לשם של מיקום המשבצת. למשל: WriteSessionParam = "fruit" matching to "$session.params.fruit". WriteSessionParam = "ticket" eligible to "$session.params.ticket".

DefaultValue

הגדרה לאכלוס ערך ברירת מחדל ביחידת הקיבולת (Slot) הזו.

ייצוג JSON 
{
  "sessionParam": string,
  "constant": value
}
שדות
sessionParam

string

אפשרות. פרמטר הסשן שישמש לאתחול הערך של יחידת הקיבולת (Slot), אם הוא לא ריק. סוג הערך צריך להתאים לסוג של יחידת הקיבולת (Slot). לתשומת ליבכם: בשלב הזה אין תמיכה בנתיבים מקוננים. למשל: sessionParam = "fruit" תואם את $session.params.fruit. sessionParam = "ticket" תואם ל-$session.params.ticket.
constant

value (Value format)

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

DataFiles

wrapper של קובץ נתונים חוזר. שדות חוזרים לא יכולים להתקיים באחד מהשדות.

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

object (DataFile)

קובצי נתונים מרובים.

DataFile

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

ייצוג JSON 
{
  "filePath": string,
  "contentType": string,
  "payload": string
}
שדות
filePath

string

נתיב יחסי של קובץ הנתונים מבסיס הפרויקט במבנה קובץ ה-SDK. נתיבי קבצים מותרים: - תמונות: resources/images/{multiple directories}?/{ImageName}.{extension} - אודיו: resources/audio/{multiple directories}?/{AudioFileName}.{extension} - קוד פונקציה מוטבעת ב-Cloud: webhooks/{WebhookName}.zip סיומות מותרות: - תמונות: png, jpg, jpeg - אודיו: mp3, mpeg - פונקציות ענן מוטבעות: zip
contentType

string

חובה. סוג התוכן של הנכס הזה. דוגמה: text/html סוג התוכן חייב להיות תואם למפרט (http://www.w3.org/Protocols/rfc1341/4_Content-Type.html). הפונקציות של Cloud חייבות להיות בפורמט zip וסוג התוכן צריך להיות application/zip;zip_type=cloud_function. הפרמטר zip_type מציין שה-zip נועד לפונקציה של Cloud Functions.
payload

string (bytes format)

התוכן של קובץ הנתונים. לדוגמה: בייטים גולמיים של תמונות, קובצי אודיו או פורמט ZIP של פונקציית Cloud. יש מגבלה מחמירה של 10MB על גודל המטען הייעודי (payload).

מחרוזת בקידוד base64.