- ייצוג JSON
- ConfigFiles
- ConfigFile
- מניפסט
- פעולות
- CustomAction
- מעורבות
- PushNotification
- DailyUpdate
- ActionLink
- AssistantLink
- הגדרות
- קטגוריה
- SurfaceRequirements
- CapabilityRequirement
- SurfaceCapability
- LocalizedSettings (הגדרות מקומיות)
- ThemeCustomization
- ImageCornerStyle
- AccountLinking
- LinkingType
- AuthGrantType
- תגובה לפעולה מאתר אחר (webhook)
- רכיבי Handler
- HttpsEndpoint
- InlineCloudFunction
- כוונת רכישה
- IntentParameter
- ClassReference
- EntitySetReferences
- EntitySetReference
- סוג
- SynonymType
- MatchType
- ישות
- EntityDisplay
- RegularExpressionType
- ישות
- FreeTextType
- EntitySet
- ישות
- GlobalIntentEvent
- EventHandler
- StaticPrompt
- StaticPromptCandidate
- סלקטור
- SurfaceCapabilities
- יכולת
- StaticPromptResponse
- StaticSimplePrompt
- וריאציה
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- ImageFill
- StaticLinkPrompt
- OpenUrl
- UrlHint
- StaticTablePrompt
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- StaticMediaPrompt
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- RepeatMode
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- הצעה
- StaticCanvasPrompt
- סצנה
- IntentEvent
- ConditionalEvent
- חריץ
- PromptSettings
- CommitBehavior
- DefaultValue
- DataFiles
- DataFile
גלישת טקסט לרשימת קבצים.
ייצוג JSON | |
---|---|
{ // Union field |
שדות | ||
---|---|---|
שדה איחוד file_type . ניתן לשלוח לשרת רק קבצים מסוג אחד בכל פעם, קובצי תצורה או קובצי נתונים. הערך של file_type יכול להיות רק אחת מהאפשרויות הבאות: |
||
configFiles |
רשימה של קובצי תצורה. כולל מניפסט, הגדרות, חבילות משאבים של מודל אינטראקציה ועוד. |
|
dataFiles |
רשימה של קובצי נתונים. זה כולל תמונה, קובץ אודיו וקוד מקור של פונקציה בענן. |
ConfigFiles
רכיב wrapper של קובצי תצורה חוזרים. שדות חוזרים לא יכולים להתקיים באחד מהשדות.
ייצוג JSON | |
---|---|
{
"configFiles": [
{
object ( |
שדות | |
---|---|
configFiles[] |
קובצי תצורה מרובים. |
ConfigFile
מייצג קובץ יחיד שמכיל נתונים מובְנים. המפתחים יכולים להגדיר את רוב הפרויקט שלהם באמצעות תצורה מובנית, כולל פעולות, הגדרות ומילוי הזמנות.
ייצוג JSON | |
---|---|
{ "filePath": string, // Union field |
שדות | ||
---|---|---|
filePath |
נתיב יחסי של קובץ התצורה מבסיס הפרויקט במבנה קובץ ה-SDK. לכל אחד מסוגי הקבצים הבאים יש נתיב קובץ מותר. לדוגמה: settings/settings.yaml |
|
שדה איחוד file . לכל סוג של קובץ תצורה צריך להיות שדה תואם באחד. הערך של file יכול להיות רק אחת מהאפשרויות הבאות: |
||
manifest |
קובץ מניפסט יחיד. נתיב הקובץ המותר: |
|
actions |
קובץ פעולות יחיד עם כל הפעולות מוגדרות. נתיבי קבצים מותרים: |
|
settings |
הגדרת תצורה של הגדרות בודדות, שכוללת הגדרות והגדרות שלא ניתנות להתאמה לשוק המקומי, ללוקאל שמוגדר כברירת מחדל בפרויקט (אם צוין). בקובץ לשינוי מיקום, רק השדה localizedSettings יאוכלס. נתיבי קובץ מותרים: |
|
webhook |
הגדרת webhook אחד. נתיב הקובץ המותר: |
|
intent |
הגדרת Intent יחידה. נתיבי קבצים מותרים: |
|
type |
הגדרת סוג יחיד. נתיבי קבצים מותרים: |
|
entitySet |
הגדרה של קבוצת ישויות בודדת. נתיבי קבצים מותרים: |
|
globalIntentEvent |
הגדרה אחת של אירוע Intent גלובלי. נתיבי קבצים מותרים: |
|
scene |
הגדרת סצנה בודדת. נתיבי קבצים מותרים: |
|
staticPrompt |
הגדרה של הנחיה סטטית אחת. נתיבי קבצים מותרים: |
|
accountLinkingSecret |
מטא-נתונים התואמים לסוד הלקוח ששימש לקישור החשבונות. נתיב הקובץ המותר: |
|
resourceBundle |
חבילת משאבים בודדת, שהיא מפה ממחרוזת למחרוזת או לרשימת מחרוזות. אפשר להשתמש בחבילות משאבים להתאמה לשוק המקומי של מחרוזות בהנחיות סטטיות. נתיבי קבצים מותרים: |
מניפסט
מכיל מידע "נייד", כלומר לא ספציפי לפרויקט מסוים ואפשר להעביר אותו בין פרויקטים.
ייצוג JSON | |
---|---|
{ "version": string } |
שדות | |
---|---|
version |
הגרסה של פורמט הקובץ. הגרסה הנוכחית של פורמט הקובץ היא 1.0 דוגמה: "1.0" |
פעולות
מייצג את רשימת הפעולות שמוגדרות בפרויקט.
ייצוג JSON | |
---|---|
{
"custom": {
string: {
object ( |
שדות | |
---|---|
custom |
מיפוי מאובייקטים מסוג Intent לפעולות מותאמות אישית כדי להגדיר את ההפעלה של הפרויקט. אובייקטים מסוג Intent להפעלה יכולים להיות אובייקטים של מערכת או אובייקטים בהתאמה אישית עם כוונת רכישה שמוגדרים בחבילה 'בהתאמה אישית/כוונות/'. לכל האובייקטים מסוג Intent שמוגדרים כאן (אובייקטים מסוג Intent של המערכת ואובייקטים בהתאמה אישית מסוג Intent) חייב להיות קובץ Intent תואם בחבילה 'בהתאמה אישית/גלובלית/'. אובייקט שמכיל רשימה של |
CustomAction
פרטים לגבי פעולה מותאמת אישית.
ייצוג JSON | |
---|---|
{
"engagement": {
object ( |
שדות | |
---|---|
engagement |
מנגנוני מעורבות שמשויכים לפעולה כדי לעזור למשתמשי הקצה להירשם לקבלת התראות ועדכונים יומיים. לתשומת ליבכם: שם ה-Intent שצוין בהגדרות המשבצת של העדכונים היומיים או ההתראות צריך להתאים ל-Intent המתאים לפעולה הזו, כדי שמשתמשי הקצה יוכלו להירשם לעדכונים האלה. |
מעורבות
מגדיר את מנגנוני המעורבות המשויכים לפעולה הזו. כך משתמשי הקצה יכולים להירשם לקבלת התראות ועדכונים יומיים.
ייצוג JSON | |
---|---|
{ "title": string, "pushNotification": { object ( |
שדות | |
---|---|
title |
הכותרת של האינטראקציה תישלח למשתמשי קצה ולבקש את רשותם לקבל עדכונים. ההודעה שתישלח למשתמשי הקצה עם עדכונים יומיים תיראה כך: "באיזו שעה ברצונך שאשלח את ה{title} היומי שלך". לגבי התראות, היא תיראה כך: "האם זה בסדר אם אשלח התראות על {title}". השדה הזה ניתן להתאמה לשוק המקומי. |
pushNotification |
הגדרות של התראות שנתמכות במעורבות הזו. |
actionLink |
ההגדרה של הקישור לפעולה שקובעת אם הפעולה תופעל שיתוף קישורים, ואם כן, היא מכילה את השם המוצג של הקישור הידידותי למשתמש. ה-ActionLink הוצא משימוש. במקום זאת, אפשר להשתמש ב-AssistantLink. |
assistantLink |
ההגדרה של הקישור לפעולה שקובעת אם הפעולה תופעל שיתוף קישורים, ואם כן, היא מכילה את השם המוצג של הקישור הידידותי למשתמש. |
dailyUpdate |
הגדרות העדכון היומי שנתמכות באינטראקציה הזו. |
PushNotification
המדיניות הזו קובעת הגדרות של התראות שנתמכות באינטראקציה הזו.
DailyUpdate
המדיניות הזו קובעת הגדרות של עדכונים יומיים שנתמכים באינטראקציה הזאת.
ActionLink
האפשרות מציינת אם שיתוף קישורים מופעל עבור הפעולה הזו ועבור ההגדרות התואמות. קישורים לפעולות משמשים ליצירת קישור עומק של משתמש לפעולה ספציפית. ה-ActionLink הוצא משימוש. במקום זאת, אפשר להשתמש ב-AssistantLink.
ייצוג JSON | |
---|---|
{ "title": string } |
שדות | |
---|---|
title |
כותרת לתצוגה ידידותית למשתמש של הקישור. |
AssistantLink
האפשרות מציינת אם שיתוף קישורים מופעל עבור הפעולה הזו ועבור ההגדרות התואמות. קישורים ל-Assistant משמשים ליצירת קישור עומק שיפנה את המשתמש לפעולה ספציפית.
ייצוג JSON | |
---|---|
{ "title": string } |
שדות | |
---|---|
title |
כותרת לתצוגה ידידותית למשתמש של הקישור. |
הגדרות
מייצגות הגדרות של פרויקט פעולות שאינן ספציפיות ללוקאל. התג הבא: 22
ייצוג JSON | |
---|---|
{ "projectId": string, "defaultLocale": string, "enabledRegions": [ string ], "disabledRegions": [ string ], "category": enum ( |
שדות | |
---|---|
projectId |
מזהה הפרויקט של הפעולות. |
defaultLocale |
הלוקאל שמוגדר כברירת המחדל של הפרויקט. בכל הקבצים מלבד |
enabledRegions[] |
התרשים מייצג את האזורים שבהם משתמשים יכולים להפעיל את הפעולות, על סמך מיקום הנוכחות של המשתמש. לא ניתן לקבוע אם המדיניות |
disabledRegions[] |
האזורים שבהם הפעולות נחסמו, על סמך מיקום המשתמש של המשתמש. לא ניתן לקבוע אם המדיניות |
category |
הקטגוריה של פרויקט הפעולות הזה. |
usesTransactionsApi |
האם הפעולות יכולות לכלול עסקאות (לדוגמה, ביצוע הזמנות, קבלת הזמנות וכו'). אם הערך הוא False, הניסיונות להשתמש בממשקי ה-API של טרנזקציות ייכשלו. |
usesDigitalPurchaseApi |
האם פעולות יכולות לבצע עסקאות במוצרים דיגיטליים. |
usesInteractiveCanvas |
האם הפעולות כוללות לוח שיתופי אינטראקטיבי. |
usesHomeStorage |
אם בפעולות נעשה שימוש בתכונת האחסון של הבית. |
designedForFamily |
האם התוכן של 'פעולות' מתאים לכל המשפחה (DFF). |
containsAlcoholOrTobaccoContent |
אם הפעולות כוללות תוכן שקשור לאלכוהול או לטבק. |
keepsMicOpen |
האם פעולות יכולות להשאיר את המיקרופון פתוח ללא בקשה מפורשת במהלך שיחה. |
surfaceRequirements |
דרישות השטח שפלטפורמת הלקוח צריכה לתמוך בהן כדי להפעיל פעולות בפרויקט הזה. |
testingInstructions |
הוראות לבודק פעולות מסוג פריסה גמישה (לדוגמה, הוראות לקישור חשבונות). |
localizedSettings |
הגדרות מותאמות לשוק המקומי ללוקאל שמוגדר כברירת מחדל בפרויקט. לכל מיקום נוסף צריך להיות קובץ הגדרות משלו בספרייה משלו. |
accountLinking |
המשתמשים יכולים ליצור או לקשר חשבונות באמצעות כניסה באמצעות חשבון Google ו/או שירות OAuth משלך. |
selectedAndroidApps[] |
אפליקציות ל-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 ( |
שדות | |
---|---|
minimumRequirements[] |
קבוצת היכולות המינימלית שנדרשת כדי להפעיל את הפעולות בפרויקט. אם במשטח חסר אחד או יותר מהמאפיינים האלה, הפעולה לא תופעל. |
CapabilityRequirement
מייצג את הדרישה לגבי הזמינות של יכולת נתונה.
ייצוג JSON | |
---|---|
{
"capability": enum ( |
שדות | |
---|---|
capability |
סוג היכולת. |
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 ( |
שדות | |
---|---|
displayName |
חובה. שם ברירת המחדל לתצוגה של פרויקט הפעולות הזה (אם אין תרגום זמין) |
pronunciation |
חובה. ההגייה של השם המוצג כדי להפעיל אותו בהקשר של קול (דיבור). |
shortDescription |
חובה. התיאור הקצר שמוגדר כברירת מחדל לפרויקט הפעולות (אם אין תרגום זמין). עד 80 תווים. |
fullDescription |
חובה. התיאור הארוך שמוגדר כברירת מחדל לפרויקט הפעולות (אם אין תרגום זמין). עד 4,000 תווים. |
smallLogoImage |
חובה. תמונה מרובעת קטנה, 192 x 192 פיקסלים. צריך לציין את זה בתור הפניה לתמונה התואמת בספרייה |
largeBannerImage |
אפשרות. תמונה גדולה לרוחב, 1920 x 1080 פיקסלים. צריך לציין את זה בתור הפניה לתמונה התואמת בספרייה |
developerName |
חובה. שם המפתח שיוצג למשתמשים. |
developerEmail |
חובה. כתובת האימייל ליצירת קשר עם המפתח. |
termsOfServiceUrl |
אפשרות. כתובת ה-URL של התנאים וההגבלות. |
voice |
חובה. הקול של Google Assistant שהמשתמשים שומעים כשהם מבצעים פעולות. הערכים הנתמכים הם "male_1", "male_2", "נקבה_1" ו-"נקבה_2". |
voiceLocale |
אפשרות. הלוקאל של הקול שצוין. אם לא מציינים שום אפשרות, היא מקבלת את הערך של לוקאל Assistant של המשתמש. אם צוין, ללוקאל של הקול חייבת להיות אותה שפת בסיס כמו של הלוקאל שצוין ב-LocalizedSettings. |
privacyPolicyUrl |
חובה. כתובת ה-URL של מדיניות הפרטיות. |
sampleInvocations[] |
אפשרות. ביטויי הפעלה לדוגמה שמוצגים כחלק מהתיאור של פרויקט הפעולות בספרייה של Assistant. כך המשתמשים ילמדו להשתמש בו. |
themeCustomization |
אפשרות. התאמות אישיות של עיצוב לרכיבים חזותיים של הפעולות. |
ThemeCustomization
סגנונות שהוחלו על כרטיסים שמוצגים למשתמשים
ייצוג JSON | |
---|---|
{
"backgroundColor": string,
"primaryColor": string,
"fontFamily": string,
"imageCornerStyle": enum ( |
שדות | |
---|---|
backgroundColor |
צבע הרקע של הכרטיסים. משמשת כחלופה אם המפתחים |
primaryColor |
צבע העיצוב הראשי של הפעולה ישמש להגדרת צבע הטקסט של הכותרת וצבע הרקע של פריט לביצוע בכרטיסים של Actions on Google. שימוש לדוגמה: #FAFAFA |
fontFamily |
משפחת הגופנים שתשמש לשמות של כרטיסים. גופנים נתמכים: - Sans Serif - Sans Serif Medium - Sans Serif Bold - Sans Serif Black - Sans Serif דחוס - Sans Serif דחוס בינוני - Serif - Serif Bold - Monospace - Cursive - אותיות קטנות של Sans Serif |
imageCornerStyle |
סגנון הגבול של תמונה בחזית של כרטיסים. לדוגמה, אפשר להחיל אותן על התמונה בחזית של כרטיס בסיסי או כרטיס קרוסלה. |
landscapeBackgroundImage |
פריסה לרוחב (מינימום 1920x1200 פיקסלים). צריך לציין את זה בתור הפניה לתמונה התואמת בספרייה |
portraitBackgroundImage |
פריסה לאורך (מינימום 1,200x1,920 פיקסלים). צריך לציין את זה בתור הפניה לתמונה התואמת בספרייה |
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 ( |
שדות | |
---|---|
enableAccountCreation |
חובה. אם |
linkingType |
חובה. סוג הקישור שבו כדאי להשתמש. פרטים נוספים על סוגי הקישורים זמינים בכתובת https://developers.google.com/assistant/identity. |
authGrantType |
אפשרות. מציין את סוג האימות עבור OAUTH LinkingType. |
appClientId |
אפשרות. מזהה הלקוח שהונפק על ידי האפליקציה ל-Google. זהו מזהה הלקוח של OAuth2 שמזהה את Google לשירות שלכם. מוגדרת רק כשמשתמשים ב-OAuth. |
authorizationUrl |
אפשרות. נקודת קצה עבור דף האינטרנט המשמש לכניסה שתומך בקוד OAuth2 או בתהליכים משתמעים. כתובת ה-URL חייבת להשתמש ב-HTTPS. מוגדרת רק כשמשתמשים ב-OAuth. |
tokenUrl |
אפשרות. נקודת הקצה של OAuth2 להמרת אסימונים. כתובת ה-URL חייבת להשתמש ב-HTTPS. האפשרות הזו לא מוגדרת רק כשמשתמשים ב-OAuth עם הרשאת IMPLICIT כסוג הקישור. מוגדרת רק כשמשתמשים ב-OAuth. |
scopes[] |
אפשרות. רשימת הרשאות שהמשתמש צריך להסכים להן כדי להשתמש בשירות שלך. מוגדרת רק כשמשתמשים ב-OAuth. הקפד לספק תנאים והגבלות בפרטי הספרייה בקטע LocalizedSettings.terms_of_service_url אם אתה מציין שדה זה. |
learnMoreUrl |
אפשרות. זהו דף האינטרנט בשירות שלך שמתאר את ההרשאות שהמשתמש מעניק ל-Google. מוגדרת רק לשימוש ב-OAuth ובכניסה באמצעות חשבון Google. הקפד לספק תנאים והגבלות בפרטי הספרייה בקטע LocalizedSettings.terms_of_service_url אם אתה מציין שדה זה. |
useBasicAuthHeader |
אפשרות. אם המדיניות הזו מוגדרת כ-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 ( |
שדות | ||
---|---|---|
handlers[] |
רשימת גורמי handler ל-webhook הזה. |
|
שדה איחוד webhook_type . יש תמיכה רק בסוג אחד של תגובה לפעולה מאתר אחר (webhook). הערך של webhook_type יכול להיות רק אחת מהאפשרויות הבאות: |
||
httpsEndpoint |
נקודת קצה (endpoint) מסוג webhook HTTPS בהתאמה אישית. |
|
inlineCloudFunction |
מטא-נתונים של הפונקציה ב-Cloud Functions שנפרסה מקוד בתיקיית ה-webhooks. |
מטפל
הצהרה על השם של ה-handler של webhoook. ל-webhook יכולים להיות כמה גורמי handler רשומים. אפשר לקרוא לרכיבי ה-handler האלה מכמה מקומות בפרויקט הפעולות.
ייצוג JSON | |
---|---|
{ "name": string } |
שדות | |
---|---|
name |
חובה. שם ה-handler. חייב להיות ייחודי בכל ה-handlers בפרויקט הפעולות. אפשר לבדוק את השם של ה-handler הזה כדי להפעיל את הפונקציה הנכונה בקוד המקור של מילוי הבקשה. |
HttpsEndpoint
נקודת הקצה של REST לקבלת התראה אם אתם לא משתמשים בעורך המוטבע.
ייצוג JSON | |
---|---|
{ "baseUrl": string, "httpHeaders": { string: string, ... }, "endpointApiVersion": integer } |
שדות | |
---|---|
baseUrl |
כתובת ה-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 |
מפה של הפרמטרים של HTTP שיש לכלול בבקשת ה-POST. אובייקט שמכיל רשימה של |
endpointApiVersion |
גרסת הפרוטוקול המשמשת את נקודת הקצה. זה הפרוטוקול שמשותף לכל סוגי מילוי ההזמנות, ולא ספציפי לסוג מילוי הבקשה ב-Google. |
InlineCloudFunction
מכילה את המטא-נתונים של פונקציה מוטבעת ב-Cloud Functions שנפרסה מתיקיית ה-webhooks.
ייצוג JSON | |
---|---|
{ "executeFunction": string } |
שדות | |
---|---|
executeFunction |
שם נקודת הכניסה של הפונקציה ב-Cloud Functions. הערך בשדה הזה צריך להתאים לשם השיטה שיוצאה מקוד המקור. |
כוונת רכישה
באובייקטים של Intent ניתן למפות קלט של משתמשים פתוחים לאובייקטים מובְנים. הביטויים המדוברים מותאמים לכוונות בעזרת הכלי 'הבנת שפה טבעית' (NLU) של Google. התאמות של Intent יכולות להפעיל אירועים בעיצוב של השיחה כדי לקדם את השיחה של המשתמש. שם ה-Intent מצוין בשם הקובץ.
ייצוג JSON | |
---|---|
{
"parameters": [
{
object ( |
שדות | |
---|---|
parameters[] |
רשימת הפרמטרים בתוך ביטויי האימון. חייבים להגדיר כאן את כל הפרמטרים כדי להשתמש בהם בביטוי האימון. |
trainingPhrases[] |
ביטויי אימון מאפשרים ל-NLU של Google להתאים באופן אוטומטי בין כוונות לבין קלט של משתמשים. ככל שמספקים יותר ביטויים ייחודיים, כך גובר הסיכוי להתאמה של הכוונה הזו. זהו פורמט החלק של ביטוי האימון שמבואר. הערה: השדה |
IntentParameter
הגדרה של פרמטר שאפשר להשתמש בו בביטויים לאימון.
ייצוג JSON | |
---|---|
{ "name": string, // Union field |
שדות | ||
---|---|---|
name |
חובה. השם הייחודי של הפרמטר Intent. אפשר להשתמש בתנאים ובתגובות כדי להפנות לפרמטרים של Intent שחולצו על ידי NLU עם $intent.params.[name].resolved |
|
שדה איחוד parameter_type . הסוג של הפרמטר Intent. הערך של parameter_type יכול להיות רק אחת מהאפשרויות הבאות: |
||
type |
אפשרות. מצהיר על סוג הנתונים של הפרמטר. אסור להגדיר את האפשרות הזאת לאובייקטים מובְנים מסוג Intent. |
|
entitySetReferences |
אפשרות. הפניות לקבוצות של ישויות מותרות לפרמטר Intent הזה. תקף רק לפרמטרים של Intent מובנה. ההפניות האלה מפנות לקבוצות של ישויות בספרייה 'custom/entitySets'. |
ClassReference
הפניה למחלקה שמשמשת להצהרה על סוג השדה או להחזרת ערך. טיפוסים בני מנייה (Enum) הם גם סוג של מחלקה שניתן להפנות אליה באמצעות ClassReference.
ייצוג JSON | |
---|---|
{ "name": string, "list": boolean } |
שדות | |
---|---|
name |
חובה. שם של סוג מובנה או סוג מותאם אישית של הפרמטר. דוגמאות: |
list |
אפשרות. מציין אם סוג הנתונים מייצג רשימת ערכים. |
EntitySetReferences
הפניות לקבוצות של ישויות לפרמטר Intent.
ייצוג JSON | |
---|---|
{
"entitySetReferences": [
{
object ( |
שדות | |
---|---|
entitySetReferences[] |
חובה. הפניות לקבוצות של ישויות לפרמטר Intent. |
EntitySetReference
הפניה לקבוצת הישויות המותרות עבור פרמטר ה-Intent הזה.
ייצוג JSON | |
---|---|
{ "entitySet": string } |
שדות | |
---|---|
entitySet |
חובה. מציין את אוסף הישויות הספציפי שיש להביא בחשבון עבור פרמטר נתון. ההגדרה התואמת של קבוצת הישויות צריכה להיות בספרייה custom/entitySets/ . |
תיאור
הצהרה מסוג מותאם אישית, בניגוד לסוגים מובנים. אפשר להקצות סוגים למשבצות בסצנה או לפרמטרים של ביטויי אימון של Intent. בפועל, אפשר לחשוב על טיפוסים כטיפוסים בני מנייה (enum). הערה, שם הסוג מצוין בשם הקובץ.
ייצוג JSON | |
---|---|
{ "exclusions": [ string ], // Union field |
שדות | ||
---|---|---|
exclusions[] |
קבוצת מילים/ביטויים יוצאי דופן שלא אמורים להתאים לפי הסוג שלהם. הערה: אם מילה/ביטוי תואמים לסוג אך רשומים כהחרגה, הם לא יוחזרו בתוצאת חילוץ הפרמטרים. השדה הזה ניתן להתאמה לשוק המקומי. |
|
שדה איחוד sub_type . בחירה של סוג משנה לפי סוג ההתאמה שיש לבצע. הערך של sub_type יכול להיות רק אחת מהאפשרויות הבאות: |
||
synonym |
סוג מילים נרדפות, שהוא בעצם טיפוסים בני מנייה (enum). |
|
regularExpression |
סוג ביטוי רגולרי (regex), מאפשר התאמה של ביטויים רגולריים. |
|
freeText |
סוג FreeText. |
SynonymType
סוג שתואם לטקסט לפי קבוצת מילים נרדפות.
ייצוג JSON | |
---|---|
{ "matchType": enum ( |
שדות | |
---|---|
matchType |
אפשרות. סוג ההתאמה למילה הנרדפת. |
acceptUnknownValues |
אפשרות. אם הערך מוגדר כ-True, המערכת תתאים בין מילים או ביטויים לא ידועים על סמך נתוני הקלט ואימוני הכוונות שלכם, כמו פריטים שעשויים להתווסף לרשימת קניות. |
entities |
חובה. מפה בעלת שם של ישויות מילים נרדפות. אובייקט שמכיל רשימה של |
MatchType
סוג ההתאמה שישמשו בערכים מהסוג הזה. כך תבטיחו שכל הסוגים ישתמשו באותה שיטת התאמה ותאפשרו גרסאות שונות של התאמה לצורך התאמה למילים נרדפות (כלומר, מעורפל לעומת מדויקת). אם הערך הוא UNSPECIFIED
, ברירת המחדל תהיה EXACT_MATCH
.
טיפוסים בני מנייה (enums) | |
---|---|
UNSPECIFIED |
ברירת המחדל היא EXACT_MATCH . |
EXACT_MATCH |
מחפש התאמה מדויקת למילה הנרדפת או לשם. |
FUZZY_MATCH |
קצר יותר מ-EXACT_MATCH . המערכת מחפשת התאמות דומות וגם התאמות מדויקות. |
ישות
מייצג שדה של ישות מילה נרדפת שמכיל את הפרטים של רשומה אחת בתוך הסוג.
ייצוג JSON | |
---|---|
{
"display": {
object ( |
שדות | |
---|---|
display |
אפשרות. פרטי הישות מוצגים. |
synonyms[] |
אפשרות. רשימת המילים הנרדפות של הישות. השדה הזה ניתן להתאמה לשוק המקומי. |
EntityDisplay
רכיבים שיוצגו באזור העריכה אחרי שיישות מסוג מסוים נשלפה משאילתה. רלוונטי רק לאפליקציות המותאמות להדפסות על קנבס. ניתן להתאים את ההודעה הזו לשוק המקומי.
ייצוג JSON | |
---|---|
{ "iconTitle": string, "iconUrl": string } |
שדות | |
---|---|
iconTitle |
אפשרות. שם הסמל. |
iconUrl |
חובה. כתובת ה-URL של הסמל. |
RegularExpressionType
סוג שתואם לטקסט לפי ביטויים רגולריים. ניתן להתאים את ההודעה הזו לשוק המקומי.
ייצוג JSON | |
---|---|
{
"entities": {
string: {
object ( |
שדות | |
---|---|
entities |
חובה. מפה בעלת שם של ישויות שכל אחת מהן מכילה מחרוזות ביטוי רגולרי (regex). אובייקט שמכיל רשימה של |
ישות
מייצג אובייקט ישות שמכיל את הביטוי הרגולרי המשמש להשוואה.
ייצוג JSON | |
---|---|
{
"display": {
object ( |
שדות | |
---|---|
display |
אפשרות. רכיבים שיוצגו באזור העריכה אחרי שישות נשלפה משאילתה. רלוונטי רק לאפליקציות המותאמות להדפסות על קנבס. |
regularExpressions[] |
חובה. נעשה שימוש בתחביר של ביטוי רגולרי RE2 (פרטים נוספים זמינים בכתובת https://github.com/google/re2/wiki/Syntax) |
FreeTextType
סוג הטקסט שתואם לכל טקסט אם ההקשר של המילים קרוב לדוגמאות האימון שסופקו.
ייצוג JSON | |
---|---|
{
"display": {
object ( |
שדות | |
---|---|
display |
אפשרות. רכיבים שיוצגו באזור העריכה אחרי שישות נשלפה משאילתה. רלוונטי רק לאפליקציות המותאמות להדפסות על קנבס. |
EntitySet
קבוצות ישויות מתארות את קבוצת הישויות המוגדרת מראש שמהן יכולים להגיע הערכים של הפרמטרים המובנים של ה-Intent. אפשר להפנות לקבוצות ישויות מ-entitySet בפרמטרים מובנים של Intent.
ייצוג JSON | |
---|---|
{
"entities": [
{
object ( |
שדות | |
---|---|
entities[] |
חובה. רשימת הישויות שנתמכות בקבוצת הישויות הזו. |
ישות
ישות יכולה להגיע מערך פרמטר Intent מובנה.
ייצוג JSON | |
---|---|
{ "id": string } |
שדות | |
---|---|
id |
חובה. המזהה של הישות. בכתובת https://developers.google.com/assistant/conversational/build/built-in-intents תמצאו רשימה של פרמטרים מובנים בהתאמה אישית ושל הישויות הנתמכות בהם. |
GlobalIntentEvent
מגדיר גורם handler גלובלי של Intent. אירועים גלובליים של Intent מוצגים ברמת הפרויקט כולו, ואפשר לבטל אותם על ידי רכיבי handler של Intent בסצנה. שמות של אובייקטים מסוג Intent חייבים להיות ייחודיים בפרויקט Actions.
אפשר להתאים כוונות גלובליות בכל שלב במהלך הסשן, וכך לאפשר למשתמשים לגשת לתהליך משותף כמו 'קבלת עזרה' או 'חזרה הביתה'. אפשר להשתמש בהם גם כדי לבצע קישור עומק של המשתמשים לתהליכי עבודה ספציפיים כשהם מפעילים פעולה.
הערה, שם ה-Intent מצוין בשם הקובץ.
ייצוג JSON | |
---|---|
{
"transitionToScene": string,
"handler": {
object ( |
שדות | |
---|---|
transitionToScene |
אפשרות. סצנת היעד שאליה השיחה צריכה לעבור. המצב של הסצנה הנוכחית נהרס במהלך המעבר. |
handler |
אפשרות. גורם מטפל באירועים שמופעל כאשר יש התאמה ל-Intent. צריכה להתבצע לפני המעבר לסצנת היעד. שימושי ליצירת הנחיות בתגובה לאירועים. |
EventHandler
מגדירה handler שצריך לבצע אחרי אירוע. דוגמאות לאירועים: אירועים שמבוססים על כוונת רכישה ותנאים בסצנה.
ייצוג JSON | |
---|---|
{ "webhookHandler": string, // Union field |
שדות | ||
---|---|---|
webhookHandler |
השם של ה-handler של תגובה לפעולה מאתר אחר (webhook) שאליו רוצים לקרוא. |
|
שדה איחוד prompt . אפשר להוסיף הנחיות בתוך השורה או להפנות אליהן לפי השם. הערך של prompt יכול להיות רק אחת מהאפשרויות הבאות: |
||
staticPrompt |
הנחיה סטטית בשורת הטקסט. יכול להכיל הפניות למשאבי מחרוזת בחבילות. |
|
staticPromptName |
שם ההנחיה הסטטית להפעלה. |
StaticPrompt
מייצג רשימה של הצעות להנחיה, שאחד מהן ייבחר כהצעה להופיע בתשובה למשתמש. ניתן להתאים את ההודעה הזו לשוק המקומי.
ייצוג JSON | |
---|---|
{
"candidates": [
{
object ( |
שדות | |
---|---|
candidates[] |
רשימת ההצעות שיש לשלוח ללקוח. בכל הצעה יש בורר שקובע מתי אפשר להשתמש בה. הבורר הראשון שתואם לבקשה יישלח, והמערכת תתעלם מהשאר. |
StaticPromptCandidate
מייצג מועמד להנחיה סטטית.
ייצוג JSON | |
---|---|
{ "selector": { object ( |
שדות | |
---|---|
selector |
אפשרות. הקריטריונים לקביעה אם ההנחיה הזו תואמת לבקשה. אם הבורר ריק, ההנחיה הזו תופעל תמיד. |
promptResponse |
התגובה לפעולה שמשויכת לבורר. |
בורר
מגדיר את הקריטריונים להתאמה של בקשה לבקשה.
ייצוג JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
שדות | |
---|---|
surfaceCapabilities |
קבוצת יכולות השטח הנדרשות. |
SurfaceCapabilities
מייצג את הפלטפורמה שבה המשתמש משתמש כדי לשלוח בקשה לפעולה.
ייצוג JSON | |
---|---|
{
"capabilities": [
enum ( |
שדות | |
---|---|
capabilities[] |
חובה. היכולות של הפלטפורמה ששולחים בקשה לפעולה. |
פונקציה
יכולות שנתמכות על פני השטח של המכשיר בזמן הבקשה.
טיפוסים בני מנייה (enums) | |
---|---|
UNSPECIFIED |
לא צוינה יכולת פלטפורמה. |
SPEECH |
המכשיר יכול לדבר אל המשתמש באמצעות המרת טקסט לדיבור (TTS) או SSML. |
RICH_RESPONSE |
המכשיר יכול להציג תשובות עשירות כמו כרטיסים, רשימות וטבלאות. |
LONG_FORM_AUDIO |
המכשיר יכול להפעיל מדיה של אודיו בפורמט ארוך, כמו מוזיקה ופודקאסטים. |
INTERACTIVE_CANVAS |
המכשיר יכול להציג תגובה אינטראקטיבית מלוח הציור. |
WEB_LINK |
המכשיר יכול להשתמש בקישורי אינטרנט בתגובות עשירות כדי לפתוח דפדפן אינטרנט. |
HOME_STORAGE |
המכשיר יכול לתמוך בשמירה ובאחזור של נפח אחסון בבית. |
StaticPromptResponse
מייצגות תשובות מובנות לשליחה למשתמש, כמו טקסט, דיבור, כרטיסים, נתוני קנבס, צ'יפים של הצעות וכו'.
ייצוג JSON | |
---|---|
{ "firstSimple": { object ( |
שדות | |
---|---|
firstSimple |
אפשרות. התגובה הראשונה בקול ובטקסט בלבד. |
content |
אפשרות. תוכן כמו כרטיס, רשימה או מדיה שאפשר להציג למשתמש. |
lastSimple |
אפשרות. התגובה האחרונה בהודעה קולית וטקסט בלבד. |
suggestions[] |
אפשרות. הצעות שיוצגו למשתמש שתמיד יופיעו בסוף התשובה. אם השדה |
link |
אפשרות. צ'יפ של הצעה נוסף, שיכול לקשר לאפליקציה או לאתר המשויכים. הצ'יפ יוצג עם הכותרת "פתיחה |
override |
אפשרות. מצב האופן שבו יש למזג את ההודעה הזו עם הודעות שהוגדרו קודם לכן. |
canvas |
תשובה שתשמש לחוויית שימוש אינטראקטיבית באזור העריכה. |
StaticSimplePrompt
מייצג הנחיה פשוטה לשליחה למשתמש.
ייצוג JSON | |
---|---|
{
"variants": [
{
object ( |
שדות | |
---|---|
variants[] |
רשימת וריאציות אפשריות. |
וריאנט
מייצג וריאנט שהוא חלק מההנחיה הפשוטה.
ייצוג JSON | |
---|---|
{ "speech": string, "text": string } |
שדות | |
---|---|
speech |
אפשרות. מייצג את הדיבור שיש לומר למשתמש. אפשר להשתמש בפורמט SSML או המרת טקסט לדיבור. כברירת מחדל, הדיבור יתווסף לדיבור של ההנחיה הפשוטה הקודמת. אם השדה |
text |
אפשרות. טקסט שיוצג בבועת הצ'אט. אם לא תספקו, ייעשה שימוש בתצוגה של שדה הדיבור שלמעלה. מוגבל ל-640 תווים. כברירת מחדל, הטקסט יצורף לטקסט של ההנחיה הפשוטה הקודמת. אם השדה |
StaticContentPrompt
placeholder לחלק התוכן של StaticPrompt.
ייצוג JSON | |
---|---|
{ // Union field |
שדות | ||
---|---|---|
שדה איחוד content . בהנחיה אפשר לכלול רק סוג אחד של תוכן. הערך של content יכול להיות רק אחת מהאפשרויות הבאות: |
||
card |
כרטיס בסיסי. |
|
image |
תמונה. |
|
table |
כרטיס טבלה. |
|
media |
תגובה שמציינת קבוצת מדיה להפעלה. |
|
list |
כרטיס להצגת רשימה של אפשרויות לבחירה. |
|
collection |
כרטיס שמציג רשימה של אפשרויות לבחירה. |
|
collectionBrowse |
כרטיס שמציג אוסף של דפי אינטרנט לפתיחה. |
StaticCardPrompt
כרטיס בסיסי להצגת מידע מסוים, כמו תמונה או טקסט.
ייצוג JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
שדות | |
---|---|
title |
אפשרות. השם הכולל של הכרטיס. |
subtitle |
אפשרות. כותרת המשנה של הכרטיס. |
text |
חובה. טקסט גוף הכרטיס, אם אין תמונה. יש תמיכה בקבוצה מוגבלת של תחביר Markdown לעיצוב. |
image |
אפשרות. תמונה ראשית (Hero) של הכרטיס. הגובה קבוע ל-192dp. |
imageFill |
אפשרות. איך ימולאו הרקע של התמונה. |
button |
אפשרות. לחצן שניתן ללחוץ עליו שיוצג בכרטיס. |
StaticImagePrompt
תמונה שמוצגת בכרטיס.
ייצוג JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
שדות | |
---|---|
url |
חובה. כתובת ה-URL המקורית של התמונה. התמונות יכולות להיות בפורמט JPG, PNG ו-GIF (מונפשים או ללא אנימציה). לדוגמה, |
alt |
חובה. תיאור טקסטואלי של התמונה שתשמש לצורך נגישות, למשל קוראי מסך. |
height |
אפשרות. גובה התמונה בפיקסלים. |
width |
אפשרות. רוחב התמונה בפיקסלים. |
ImageFill
אפשרויות אפשריות להצגת תמונות שמשפיעות על הצגת התמונה. מומלץ להשתמש באפשרות הזו כאשר יחס הגובה-רוחב של התמונה לא תואם ליחס הגובה-רוחב של מאגר התמונה.
טיפוסים בני מנייה (enums) | |
---|---|
UNSPECIFIED |
לא צוין ImageFill. |
GRAY |
ממלאים את הפערים בין התמונה למאגר התמונות באמצעות פסים אפורים. |
WHITE |
ממלאים את הפערים בין התמונה למאגר התמונות בפסים לבנים. |
CROPPED |
גודל התמונה משתנה כך שהרוחב והגובה של התמונה תואמים למידות המאגר או חורגים ממנו. פעולה זו עשויה לחתוך את החלק העליון והתחתון של התמונה אם גובה התמונה המותאם גדול יותר מגובה הקונטיינר. לחלופין, אם רוחב התמונה המותאם גדול מרוחב המאגר, ניתן לחתוך את השוליים השמאליים והימניים של התמונה. האפשרות הזו דומה ל'מצב זום' בטלוויזיה עם מסך רחב בזמן צפייה בסרטון ביחס 4:3. |
StaticLinkPrompt
הגדרת קישור שיוצג כצ'יפ של הצעה והמשתמש יוכל לפתוח אותו.
ייצוג JSON | |
---|---|
{
"name": string,
"open": {
object ( |
שדות | |
---|---|
name |
שם הקישור |
open |
הגדרת ההתנהגות כשהמשתמש פותח את הקישור. |
OpenUrl
הגדרת ההתנהגות כשהמשתמש פותח את הקישור.
ייצוג JSON | |
---|---|
{
"url": string,
"hint": enum ( |
שדות | |
---|---|
url |
שדה כתובת ה-URL שיכול להיות כל אחד מהפרטים הבאים: - כתובות URL מסוג http/https לפתיחת אפליקציה או דף אינטרנט שמקושרים לאפליקציה |
hint |
מציין רמז לסוג כתובת האתר. |
UrlHint
סוגים שונים של רמזים לכתובות URL.
טיפוסים בני מנייה (enums) | |
---|---|
HINT_UNSPECIFIED |
לא צוין |
AMP |
כתובת URL שמפנה ישירות לתוכן AMP או לכתובת URL קנונית שמפנה לתוכן AMP דרך <link rel="amphtml"> . |
StaticTablePrompt
כרטיס טבלה להצגת טבלה של טקסט.
ייצוג JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
שדות | |
---|---|
title |
אפשרות. הכותרת הכוללת של הטבלה. יש להגדיר אם מוגדרת כותרת משנה. |
subtitle |
אפשרות. כותרת משנה של הטבלה. |
image |
אפשרות. תמונה שמשויכת לטבלה. |
columns[] |
אפשרות. כותרות ויישור של עמודות. |
rows[] |
אפשרות. נתוני שורות בטבלה. 3 השורות הראשונות יוצגו בהכרח, אבל יכול להיות שאחרות ייחתכו בפלטפורמות מסוימות. אתם יכולים לבדוק באמצעות הסימולטור אילו שורות יוצגו עבור משטח נתון. בפלטפורמות שתומכות ביכולת |
button |
אפשרות. לחצן. |
TableColumn
מתאר עמודה בטבלה.
ייצוג JSON | |
---|---|
{
"header": string,
"align": enum ( |
שדות | |
---|---|
header |
טקסט הכותרת לעמודה. |
align |
יישור אופקי של עמודת w.r.t של התוכן. אם לא צוין אחרת, התוכן יושר לקצה העליון. |
HorizontalAlignment
יישור התוכן בתוך התא.
טיפוסים בני מנייה (enums) | |
---|---|
UNSPECIFIED |
לא צוין יישור אופקי. |
LEADING |
הקצה המוביל של התא. (זוהי ברירת המחדל) |
CENTER |
התוכן מיושר למרכז העמודה. |
TRAILING |
התוכן מיושר לקצה האחרון של העמודה. |
TableRow
מתאר שורה בטבלה.
ייצוג JSON | |
---|---|
{
"cells": [
{
object ( |
שדות | |
---|---|
cells[] |
תאים בשורה הזו. 3 התאים הראשונים יוצגו, אבל אחרים עשויים להיחתך בפלטפורמות מסוימות. השתמשו בסימולטור כדי לבדוק אילו תאים יוצגו עבור משטח נתון. |
divider |
מציינת אם צריך להיות קו מפריד אחרי כל שורה. |
TableCell
מתאר תא בשורה.
ייצוג JSON | |
---|---|
{ "text": string } |
שדות | |
---|---|
text |
תוכן הטקסט של התא. |
StaticMediaPrompt
מכיל מידע על המדיה, כמו שם, תיאור, כתובת URL וכו'. המזהה הבא: 11
ייצוג JSON | |
---|---|
{ "mediaType": enum ( |
שדות | |
---|---|
mediaType |
סוג המדיה של התשובה הזו. |
startOffset |
היסט ההתחלה של אובייקט המדיה הראשון. משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-' |
optionalMediaControls[] |
סוגים אופציונליים של פקדי מדיה שסשן התגובה הזה למדיה יכול לתמוך בהם. אם המדיניות מוגדרת, הבקשה תישלח על ידי צד שלישי כשמתרחש אירוע מדיה מסוים. אם היא לא מוגדרת, צד שלישי עדיין צריך לטפל בשני סוגי פקדים שמוגדרים כברירת מחדל, FINISHED ו-FAILED. |
mediaObjects[] |
רשימה של אובייקטי מדיה. |
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 ( |
שדות | |
---|---|
name |
השם של אובייקט המדיה הזה. |
description |
תיאור של אובייקט המדיה. |
url |
כתובת ה-URL שמפנה לתוכן המדיה. |
image |
תמונה שתוצג עם כרטיס המדיה. |
MediaImage
תמונה שתוצג בתוך MediaPrompt.
ייצוג JSON | |
---|---|
{ // Union field |
שדות | ||
---|---|---|
שדה איחוד image . מותר להשתמש רק בסוג אחד של MediaImage. הערך של image יכול להיות רק אחת מהאפשרויות הבאות: |
||
large |
תמונה גדולה, כמו עטיפת האלבום וכו' |
|
icon |
סמל תמונה קטן שמוצג משמאל לכותרת. הוא הוקטן ל-36x36dp. |
RepeatMode
סוגים של מצב חזרה על רשימה של אובייקטי מדיה.
טיפוסים בני מנייה (enums) | |
---|---|
REPEAT_MODE_UNSPECIFIED |
שוות ערך ל'כבוי'. |
OFF |
סיום הסשן של המדיה בסוף אובייקט המדיה האחרון. |
ALL |
לולאה לתחילת אובייקט המדיה הראשון כשמגיעים לסוף של אובייקט המדיה האחרון. |
StaticListPrompt
כרטיס להצגת רשימה של אפשרויות לבחירה.
ייצוג JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
שדות | |
---|---|
title |
אפשרות. שם הרשימה. |
subtitle |
אפשרות. כותרת המשנה של הרשימה. |
items[] |
חובה. פריטים ברשימה. |
ListItem
פריט ברשימה.
ייצוג JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
שדות | |
---|---|
key |
חובה. מפתח ה-NLU שתואם לשם מפתח הכניסה בסוג המשויך. כשמקישים על פריט, המפתח הזה יפורסם שוב כפרמטר לאפשרות בחירה. |
title |
חובה. שם הפריט. כשמקישים על קיצור הדרך, אפשר לחזור לשיחה מילה במילה, כאילו המשתמש הקליד אותו. כל שם פריט צריך להיות ייחודי בקבוצת הפריטים. |
description |
אפשרות. טקסט גוף הפריט. |
image |
אפשרות. תמונת פריט. |
StaticCollectionPrompt
כרטיס להצגת מגוון אפשרויות לבחירה.
ייצוג JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
שדות | |
---|---|
title |
אפשרות. שם האוסף. |
subtitle |
אפשרות. כותרת המשנה של האוסף. |
items[] |
חובה. פריטים באוסף. |
imageFill |
אפשרות. סוג אפשרות תצוגת התמונה. |
CollectionItem
פריט באוסף.
ייצוג JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
שדות | |
---|---|
key |
חובה. מפתח NLU שתואם לשם מפתח הכניסה בסוג המשויך. כשמקישים על פריט, המפתח הזה יפורסם שוב כפרמטר לאפשרות בחירה. |
title |
חובה. שם הפריט. כשמקישים על קיצור הדרך, אפשר לחזור לשיחה מילה במילה, כאילו המשתמש הקליד אותו. כל שם פריט צריך להיות ייחודי בקבוצת הפריטים. |
description |
אפשרות. טקסט גוף הפריט. |
image |
אפשרות. תמונת פריט. |
StaticCollectionBrowsePrompt
הצגת קבוצה של מסמכי אינטרנט כאוסף של פריטי אריח גדול. ניתן לבחור פריטים כדי להפעיל את מסמך האינטרנט המשויך אליהם במציג אינטרנט.
ייצוג JSON | |
---|---|
{ "items": [ { object ( |
שדות | |
---|---|
items[] |
פריטים באוסף העיון. גודל הרשימה צריך להיות בטווח [2, 10]. |
imageFill |
אפשרות להצגת תמונות בקולקציה. |
CollectionBrowseItem
פריט באוסף.
ייצוג JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
שדות | |
---|---|
title |
חובה. שם הפריט באוסף. |
description |
תיאור של פריט האוסף. |
footer |
טקסט הכותרת התחתונה של פריט האוסף, מוצג מתחת לתיאור. שורת טקסט אחת קטועה עם שלוש נקודות. |
image |
תמונה של הפריט באוסף. |
openUriAction |
חובה. URI לפתיחה אם הפריט נבחר. |
הצעה
מייצג צ'יפ של הצעה, רכיב בממשק המשתמש שמוצג למשתמש לנוחותו.
ייצוג JSON | |
---|---|
{ "title": string } |
שדות | |
---|---|
title |
חובה. הטקסט שמוצג בצ'יפ ההצעות. כשמקישים על קיצור הדרך, אפשר לחזור לשיחה מילה במילה, כאילו המשתמש הקליד אותו. כל שם צריך להיות ייחודי בקבוצת הצ'יפים של ההצעות. 25 תווים לכל היותר |
StaticCanvasPrompt
מייצג את התגובה האינטראקטיבית של לוח הציור שתישלח למשתמש. אפשר להשתמש בערך הזה בשילוב עם השדה firstSimple
בהנחיה שמכילה כדי לדבר עם המשתמש בנוסף להצגת תגובה אינטראקטיבית של לוח הציור.
ייצוג JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "sendStateDataToCanvasApp": boolean, "enableFullScreen": boolean } |
שדות | |
---|---|
url |
חובה. כתובת ה-URL של תצוגת האינטרנט לטעינה. |
data[] |
אפשרות. נתוני JSON שיועברו לדף האינטרנט של החוויה הסוחפת כאירוע. אם השדה |
suppressMic |
אפשרות. ערך אמיתי פירושו שהמיקרופון לא ייפתח לצורך הקלטת קלט אחרי שהתגובה העשירה הזו תוצג למשתמש. |
sendStateDataToCanvasApp |
אפשרות. אם הטבלה |
enableFullScreen |
אפשרות. אם |
סביבת תאורה
סצנה היא היחידה הבסיסית של זרימת השליטה בעיצוב שיחה. אפשר לשרשר אותם יחד עם סצנות אחרות, ליצור הנחיות למשתמש הקצה ולהגדיר יחידות קיבולת (Slot). שם הסצנה מצוין בשם הקובץ.
ייצוג JSON | |
---|---|
{ "onEnter": { object ( |
שדות | |
---|---|
onEnter |
handler שצריך להפעיל כשעוברים לסצנה הזו. |
intentEvents[] |
רשימת האירועים שמופעלים על סמך כוונות Intent. ניתן להפעיל את האירועים האלה בכל שלב לאחר קריאה ל-handler של on_load. חשוב – האירועים האלה מגדירים את קבוצת האובייקטים מסוג Intent שמתאימים לסצנה הזו, והם יקבלו עדיפות על פני כל אירוע שמוגדר באופן גלובלי עם אותן כוונות או ביטויי הפעלה. שמות של Intent חייבים להיות ייחודיים בתוך סצנה. |
conditionalEvents[] |
רשימת האירועים להפעלה על סמך הצהרות מותנות. אם אין טופס בסצנה הזו, מתבצעת הערכה שלהם אחרי מילוי הטופס, או מיד אחרי on_load. רק אירוע ההתאמה הראשון יופעל. |
slots[] |
רשימה ממוינת של יחידות קיבולת. כל יחידת קיבולת (Slot) מגדירה את סוג הנתונים שהיא תפתור ואת ההגדרה כדי להתאים אישית את חוויית הרזולוציה הזו (למשל, הנחיות). |
onSlotUpdated |
בוצעה קריאה ל-handler הנקרא כשיש שינוי במצב של יחידת קיבולת (Slot) שלא נגרם על ידי עדכונים אצל handler אחר. כך ניתן לבטל את התוקף של יחידות הקיבולת (Slot), לבטל את התוקף של הסצנה או לבצע שינויים אחרים במצב הסצנה. |
IntentEvent
רושם אירועים שהופעלו כתוצאה מהתאמת Intent.
ייצוג JSON | |
---|---|
{
"intent": string,
"transitionToScene": string,
"handler": {
object ( |
שדות | |
---|---|
intent |
חובה. Intent שהפעיל את האירוע. |
transitionToScene |
אפשרות. סצנת היעד שאליה השיחה צריכה לעבור. המצב של הסצנה הנוכחית נהרס במהלך המעבר. |
handler |
אפשרות. גורם מטפל באירועים שמופעל כאשר יש התאמה ל-Intent. צריכה להתבצע לפני המעבר לסצנת היעד. כדאי ליצור הנחיות בתגובה לאירועים. |
ConditionalEvent
רושם אירועים שהופעלו כתוצאה מתנאי True.
ייצוג JSON | |
---|---|
{
"condition": string,
"transitionToScene": string,
"handler": {
object ( |
שדות | |
---|---|
condition |
חובה. תנאי סינון שהאירוע הזה יופעל. אם התנאי מקבל ערך True, אז ה- |
transitionToScene |
אפשרות. סצנת היעד שאליה השיחה צריכה לעבור כשמתבצעת ההערכה של התנאי המשויך כ-True. המצב של הסצנה הנוכחית נהרס במהלך המעבר. |
handler |
אפשרות. הגורם המטפל באירועים שמופעל כשהתנאי המשויך מוערך כ- |
משבצת
הגדרה של יחידת קיבולת (Slot). יחידות קיבולת (Slots) הן יחידות נתונים בודדות שניתן למלא באמצעות שפה טבעית (כלומר, פרמטרים של Intent), פרמטרים של פעילות באתר ומקורות אחרים.
ייצוג JSON | |
---|---|
{ "name": string, "type": { object ( |
שדות | |
---|---|
name |
חובה. השם של יחידת הקיבולת (Slot). |
type |
חובה. סוג הנתונים של יחידת הקיבולת (Slot) הזו. |
required |
אפשרות. שדה זה מציין אם צריך למלא את יחידת הקיבולת (Slot) לפני ההתקדמות. אם השדה לא ימולא, תוצג למשתמש בקשה להתאמה אישית. |
promptSettings |
אפשרות. רושם הודעות לשלבים שונים של מילוי יחידות קיבולת (Slot). |
commitBehavior |
אפשרות. ביצוע ההתנהגות שמשויכת ביחידת הקיבולת (Slot). |
config |
אפשרות. הגדרות אישיות נוספות שקשורות ביחידת הקיבולת (Slot) ומשמשות למילוי יחידת הקיבולת (Slot). הפורמט של ההגדרות הוא ספציפי לסוג של יחידת הקיבולת (Slot). אפשר להוסיף להגדרה הזו הפניות למשאבים לפרמטר של משתמש או של סשן. ההגדרה הזו נדרשת למילוי יחידות קיבולת (Slot) שקשורות לעסקאות ולהתעניינות של משתמשים. דוגמה: עבור יחידת קיבולת (Slot) מסוג actions.type.CompletePurchaseValue, ההגדרה הבאה מציעה הזמנת מוצר דיגיטלית עם הפניה לפרמטר סשן בהגדרת הלקוח { "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" } } |
defaultValue |
אפשרות. הגדרה לאכלוס ערך ברירת מחדל ביחידת הקיבולת (Slot) הזו. |
PromptSettings
מקום אחד שבו מוגדרות הנחיות יחידות קיבולת.
ייצוג JSON | |
---|---|
{ "initialPrompt": { object ( |
שדות | |
---|---|
initialPrompt |
מבקשים מהערך של יחידת הקיבולת (Slot) עצמה. דוגמה: "באיזה גודל רצית?" |
noMatchPrompt1 |
הצגת בקשה כשהקלט של המשתמש לא תואם לסוג הערך הצפוי עבור יחידת הקיבולת בפעם הראשונה. לדוגמה: "סליחה, לא הבנתי". |
noMatchPrompt2 |
בקשה שתוצג כשהקלט של המשתמש לא תואם לסוג הערך הצפוי עבור יחידת הקיבולת (Slot) בפעם השנייה. לדוגמה: "סליחה, לא הבנתי". |
noMatchFinalPrompt |
הצגת בקשה כשהקלט של המשתמש לא תואם לסוג הערך הצפוי עבור יחידת הקיבולת (Slot) בפעם האחרונה. לדוגמה: "סליחה, לא הבנתי". |
noInputPrompt1 |
בקשה להזין כשהמשתמש לא מספק קלט בפעם הראשונה. לדוגמה: "סליחה, לא הבנתי". |
noInputPrompt2 |
בקשה להזין כשהמשתמש לא מספק קלט בפעם השנייה. לדוגמה: "סליחה, לא הבנתי". |
noInputFinalPrompt |
בקשה להזין כשהמשתמש לא מספק קלט בפעם האחרונה. לדוגמה: "סליחה, לא הבנתי". |
CommitBehavior
הודעה שמתארת את התנהגות ההתחייבות המשויכת ליחידת הקיבולת (Slot) אחרי שהמשימה מולאה.
ייצוג JSON | |
---|---|
{ "writeSessionParam": string } |
שדות | |
---|---|
writeSessionParam |
פרמטר הסשן שכותב את ערך המיקום אחרי שממלאים אותו. לתשומת ליבכם: בשלב הזה אין תמיכה בנתיבים מקוננים. '$$' משמש לכתיבת הערך של מיקום המשבצת לפרמטר של סשן עם שם שזהה לשם של מיקום המשבצת. למשל: WriteSessionParam = "fruit" matching to "$session.params.fruit". WriteSessionParam = "ticket" eligible to "$session.params.ticket". |
DefaultValue
הגדרה לאכלוס ערך ברירת מחדל ביחידת הקיבולת (Slot) הזו.
ייצוג JSON | |
---|---|
{ "sessionParam": string, "constant": value } |
שדות | |
---|---|
sessionParam |
אפשרות. פרמטר הסשן שישמש לאתחול הערך של יחידת הקיבולת (Slot), אם הוא לא ריק. סוג הערך צריך להתאים לסוג של יחידת הקיבולת (Slot). לתשומת ליבכם: בשלב הזה אין תמיכה בנתיבים מקוננים. למשל: |
constant |
אפשרות. ערך ברירת מחדל קבוע עבור יחידת הקיבולת. ייעשה שימוש באפשרות הזו רק אם ערך עבור יחידת הקיבולת (Slot) הזו לא הוזן באמצעות |
DataFiles
wrapper של קובץ נתונים חוזר. שדות חוזרים לא יכולים להתקיים באחד מהשדות.
ייצוג JSON | |
---|---|
{
"dataFiles": [
{
object ( |
שדות | |
---|---|
dataFiles[] |
קובצי נתונים מרובים. |
DataFile
מייצג קובץ יחיד שמכיל נתונים לא מובְנים. לדוגמה, קובצי תמונה, קובצי אודיו וקוד מקור של פונקציה בענן.
ייצוג JSON | |
---|---|
{ "filePath": string, "contentType": string, "payload": string } |
שדות | |
---|---|
filePath |
נתיב יחסי של קובץ הנתונים מבסיס הפרויקט במבנה קובץ ה-SDK. נתיבי קבצים מותרים: - תמונות: |
contentType |
חובה. סוג התוכן של הנכס הזה. דוגמה: |
payload |
התוכן של קובץ הנתונים. לדוגמה: בייטים גולמיים של תמונות, קובצי אודיו או פורמט ZIP של פונקציית Cloud. יש מגבלה מחמירה של 10MB על גודל המטען הייעודי (payload). מחרוזת בקידוד base64. |