Files

wrapper של רשימה של קבצים.

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

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

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

נתיב יחסי של קובץ התצורה מרמה הבסיסית (root) של הפרויקט במבנה קובץ ה-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 להפעלה יכולים להיות אובייקטים מסוג מערכת או אובייקטים בהתאמה אישית עם כוונת רכישה שמוגדרים בשדות 'custom/intents/ ' חבילה. לכל אובייקטי ה-Intent שמוגדרים כאן (כוונות מערכת וכוונות בהתאמה אישית) חייב להיות קובץ Intent תואם בשדה 'מותאם אישית/גלובלי/' חבילה.

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

CustomAction

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

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

object (Engagement)

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

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

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.

קטגוריה

בחירות הקטגוריות של פרויקט פעולות.

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

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

טיפוסים בני מנייה (enum)
SURFACE_CAPABILITY_UNSPECIFIED לא ידוע / לא צוין.
AUDIO_OUTPUT אפליקציית המסך תומכת בפלט אודיו.
SCREEN_OUTPUT סוג המסך תומך בפלט מסך או בפלט ויזואלי.
MEDIA_RESPONSE_AUDIO אפליקציית המסך תומכת באודיו של תגובת מדיה.
WEB_BROWSER פלטפורמת Surface תומכת בדפדפני אינטרנט.
ACCOUNT_LINKING פלטפורמת הפלטפורמה תומכת בקישור חשבונות.
INTERACTIVE_CANVAS אפליקציית Surface תומכת בלוח הציור האינטראקטיבי.
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

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

fullDescription

string

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

smallLogoImage

string

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

largeBannerImage

string

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

developerName

string

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

developerEmail

string

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

termsOfServiceUrl

string

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

voice

string

חובה. סוג הקול של Google Assistant שהמשתמשים שומעים כשהם מקיימים אינטראקציה עם הפעולות שלכם. הערכים הנתמכים הם 'male_1', 'male_2', 'female_1' ו-'female_2'.

voiceLocale

string

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

privacyPolicyUrl

string

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

sampleInvocations[]

string

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

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

fontFamily

string

משפחת הגופנים שתשמש לכותרות הכרטיסים. גופנים נתמכים: - Sans Serif - Sans Serif Medium - Sans Serif Bold - Sans Serif Black - Sans Serif Condensed - Sans Serif Condensed Medium - Serif - Serif Bold - Monospace - Cursive - Sans Serif Smallcaps

imageCornerStyle

enum (ImageCornerStyle)

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

landscapeBackgroundImage

string

פריסה לרוחב (מינימום 1,920x1,200 פיקסלים). צריך לציין את המזהה הזה כהפניה לתמונה המתאימה בספרייה 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

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

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

AccountLinking

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

לסוגי הקישור 'כניסה באמצעות חשבון Google' ו-OAuth + כניסה באמצעות חשבון Google, Google יוצרת מזהה לקוח שמזהה את האפליקציה שלכם עבור Google ('מספר לקוח ש-Google מנפיקה לפעולות שלכם' בממשק המשתמש של המסוף). השדה הזה הוא לקריאה בלבד ואפשר לבדוק אותו על ידי מעבר לדף 'קישור חשבונות' בממשק המשתמש של המסוף. למידע נוסף: 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, אפשר ליצור חשבון רק באתר. צריך לבחור באפשרות הזו אם רוצים להציג את התנאים וההגבלות או לקבל את הסכמת המשתמשים במהלך ההרשמה. linkType לא יכול להיות GOOGLE_SIGN_IN כשהערך הוא false. linkType לא יכול להיות OAUTH כאשר הערך הוא true.

linkingType

enum (LinkingType)

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

authGrantType

enum (AuthGrantType)

זה שינוי אופציונלי. מציין את סוג האימות ל-OAUTH linkType.

appClientId

string

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

authorizationUrl

string

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

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

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

AuthGrantType

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

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

רשימת גורמים מטפלים ב-webhook הזה.

שדה איחוד webhook_type. יש תמיכה רק בסוג webhook אחד. webhook_type יכול להיות רק אחת מהאפשרויות הבאות:
httpsEndpoint

object (HttpsEndpoint)

נקודת קצה (endpoint) מותאמת אישית של webhook.

inlineCloudFunction

object (InlineCloudFunction)

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

מטפל

הצהרת השם של ה-handler של webhoook. לתגובה לפעולה מאתר אחר (webhook) יכולים להיות רשומים כמה handlers. ניתן לקרוא ל-handlers האלה מכמה מקומות בפרויקט Actions.

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

string

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

HttpsEndpoint

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

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

string

כתובת ה-URL הבסיסית מסוג HTTPS של נקודת הקצה של מילוי ההזמנות (אין תמיכה ב-HTTP). שמות ה-handler מתווספים לנתיב כתובת ה-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 ממפים קלט פתוח של משתמשים לאובייקטים מובנים. המערכת מתאימה בין ביטויים מדוברים לכוונות באמצעות Natural Language Understanding של Google (NLU). התאמות 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

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

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

סוג ביטוי רגולרי, מאפשר התאמה לביטוי רגולרי.

freeText

object (FreeTextType)

סוג טקסט חופשי.

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 כברירת מחדל.

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

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

הערה, שם ה-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

השם של ה-webhook handler שיש להפעיל אליו.

שדה איחוד 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)

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

פונקציה

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

טיפוסים בני מנייה (enum)
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 או המרת טקסט לדיבור (TTS). כברירת מחדל, הדיבור יצורף לדיבור של ההנחיה הפשוטה הקודמת. אם השדה override בהנחיה שמכילה הוא true, הדיבור שמוגדר בשדה הזה יבטל את הדיבור של ההנחיה הקודמת הפשוטה.

text

string

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

StaticContentPrompt

placeholder של החלק 'תוכן' של הנחיה סטטית.

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

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

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

hint

enum (UrlHint)

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

UrlHint

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

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

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

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

TableRow

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

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

object (TableCell)

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

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)

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

mediaObjects[]

object (MediaObject)

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

repeatMode

enum (RepeatMode)

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

MediaType

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

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

OptionalMediaControls

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

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

MediaObject

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

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

string

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

description

string

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

url

string

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

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

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

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

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

sendStateDataToCanvasApp

boolean

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

enableFullScreen

boolean

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

סצינה

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

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

object (EventHandler)

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

intentEvents[]

object (IntentEvent)

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

conditionalEvents[]

object (ConditionalEvent)

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

slots[]

object (Slot)

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

onSlotUpdated

object (EventHandler)

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

IntentEvent

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

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

string

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

transitionToScene

string

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

handler

object (EventHandler)

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

ConditionalEvent

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

ייצוג 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(session.params.fruitList) > 2 substring - session.params.fullName.contains("John")

transitionToScene

string

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

handler

object (EventHandler)

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

משבצת

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

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

string

חובה. השם של המשבצת.

type

object (ClassReference)

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

required

boolean

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

promptSettings

object (PromptSettings)

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

commitBehavior

object (CommitBehavior)

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

config

value (Value format)

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

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

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

defaultValue

object (DefaultValue)

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

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)

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

noMatchPrompt1

object (EventHandler)

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

noMatchPrompt2

object (EventHandler)

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

noMatchFinalPrompt

object (EventHandler)

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

noInputPrompt1

object (EventHandler)

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

noInputPrompt2

object (EventHandler)

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

noInputFinalPrompt

object (EventHandler)

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

CommitBehavior

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

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

string

פרמטר הסשן שיכתוב את הערך של מיקום המודעה אחרי שהוא ממולא. שימו לב: בשלב זה אין תמיכה בנתיבים בתצוגת עץ. "$$" משמש לכתיבה של ערך המיקום לפרמטר של סשן שיש לו שם זהה לזה של מיקום המשבצת. לדוגמה: WriteSessionParam = "fruit" תואם ל- "$session.params.fruit". WritesessionParam = "ticket" תואם ל-"$session.params.ticket".

DefaultValue

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

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

string

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

constant

value (Value format)

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

DataFiles

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

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

object (DataFile)

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

DataFile

מייצג קובץ יחיד שמכיל נתונים לא מובנים. לדוגמה: קובצי תמונה, קובצי אודיו וקוד מקור של פונקציה ב-Cloud Functions.

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

string

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

contentType

string

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

payload

string (bytes format)

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

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