ActionPackage

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

ייצוג JSON
{
  "manifest": {
    object (Manifest)
  },
  "accountLinking": {
    object (AccountLinking)
  },
  "actions": [
    {
      object (Action)
    }
  ],
  "types": [
    {
      object (Type)
    }
  ],
  "conversations": {
    string: {
      object(ConversationFulfillment)
    },
    ...
  },
  "locale": string
}
שדות
manifest

object (Manifest)

פרטי האפליקציה כאן נשמר הרישום של הספרייה, וכן פרטים מזהים אחרים של אפליקציות כמו displayName.

accountLinking

object (AccountLinking)

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

actions[]

object (Action)

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

types[]

object (Type)

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

conversations

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

שיחות במפה שאפשר לשתף בין actions. לדוגמה, אפשר לראות את conversationName בFulfillment.

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

locale

string

הלוקאל של חבילת הפעולות הזו. הוא מיוצג על ידי מחרוזות שפה מסוג BCP-47, כמו 'en', 'en-US', 'fr', 'fr-CA', 'sr-Latn', 'zh-Hans', 'zh-Hans-CN', 'zh-Hant', 'zh-Hant-HK' וכו'. צריך להשתמש באפליקציות האלה כשהאפליקציה תומכת ביותר משפה אחת. לכל לוקאל נתמך יש ActionPackage משלו. אם לא תספקו ערך, יש לציין את לוקאל ברירת המחדל של הסוכן.

מניפסט

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

  1. פעולות בדף הרישום בספריית Google.
  2. זיהוי ייחודי של אפליקציה להפעלה מפורשת (displayName).
  3. תוכן בשביל חלקים אחרים של ActionPackage (shortDescription משמש להצגה ב-AccountLinking, displayName משמש ב-actions כדי להציג את שם האפליקציה למשתמשים).

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

ייצוג JSON
{
  "displayName": string,
  "invocationName": string,
  "enabledRegions": [
    string
  ],
  "disabledRegions": [
    string
  ],
  "shortDescription": string,
  "longDescription": string,
  "category": string,
  "smallSquareLogoUrl": string,
  "largeLandscapeLogoUrl": string,
  "companyName": string,
  "contactEmail": string,
  "termsOfServiceUrl": string,
  "privacyUrl": string,
  "sampleInvocation": [
    string
  ],
  "introduction": string,
  "testingInstructions": string,
  "voiceName": string,
  "externalVoiceName": string,
  "voiceLocale": string,
  "surfaceRequirements": {
    object (SurfaceRequirements)
  }
}
שדות
displayName

string

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

invocationName

string

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

enabledRegions[]

string (int64 format)

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

disabledRegions[]

string (int64 format)

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

shortDescription

string

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

longDescription

string

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

category

string

הקטגוריה של האפליקציה. הערך חייב להיות אחת מהקטגוריות המותרות של אפליקציות. רשימת הפעולות המותרות מופיעה במסוף Google.

smallSquareLogoUrl

string

תמונה קטנה מרובעת. המידות חייבות להיות 192 על 192 פיקסלים.

largeLandscapeLogoUrl

string

תמונה גדולה לרוחב. המידות הן 2208 על 1242 פיקסלים.

companyName

string

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

contactEmail

string

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

termsOfServiceUrl

string

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

privacyUrl

string

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

sampleInvocation[]

string

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

introduction

string

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

testingInstructions

string

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

voiceName

string

שם הקול שבו יש להשתמש. ערכים לדוגמה נתמכים: male_1, male_2, female_1, female_2.

externalVoiceName

string

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

voiceLocale

string

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

surfaceRequirements

object (SurfaceRequirements)

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

SurfaceRequirements

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

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

object (Capability)

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

פונקציה

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

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

string

שם היכולת, למשל actions.capability.AUDIO_OUTPUT

סוג

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

ייצוג JSON
{
  "name": string,
  "entities": [
    {
      object (Entity)
    }
  ],
  "isUserDefined": boolean
}
שדות
name

string

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

entities[]
(deprecated)

object (Entity)

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

isUserDefined

boolean

האם הישויות מוגדרות על ידי המשתמש (שונות לכל משתמש).

ישות

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

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

string

מפתח ייחודי לפריט הזה.

synonyms[]

string

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