AppRequest

AppRequest היא בקשה שנשלחת על ידי Google Assistant למילוי הזמנה כדי ליצור אינטראקציה עם פעולה. גרסת ה-API מצוינת בכותרת ה-HTTP. בגרסה 1 של ה-API, הכותרת מכילה: Google-Assistant-API-Version: v1. בגרסה 2 של ה-API, הכותרת מכילה: Google-actions-API-Version: 2. בכתובת https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json מוסבר איך זה משמש לפעולות ב-Google .

ייצוג JSON 
{
  "user": {
    object (User)
  },
  "device": {
    object (Device)
  },
  "surface": {
    object (Surface)
  },
  "conversation": {
    object (Conversation)
  },
  "inputs": [
    {
      object (Input)
    }
  ],
  "isInSandbox": boolean,
  "availableSurfaces": [
    {
      object (Surface)
    }
  ]
}
שדות
user

object (User)

המשתמש שיזם את השיחה.
device

object (Device)

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

object (Surface)

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

object (Conversation)

מכיל נתוני סשן, כמו מזהה השיחה ואסימון השיחה.
inputs[]

object (Input)

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

boolean

השדה הזה מציין אם יש לטפל בבקשה במצב ארגז חול.
availableSurfaces[]

object (Surface)

משטחים זמינים למסירה במשטחים שונים.

משתמש

ייצוג JSON 
{
  "idToken": string,
  "profile": {
    object (UserProfile)
  },
  "accessToken": string,
  "permissions": [
    enum (Permission)
  ],
  "locale": string,
  "lastSeen": string,
  "userStorage": string,
  "packageEntitlements": [
    {
      object (PackageEntitlement)
    }
  ],
  "userVerificationStatus": enum (UserVerificationStatus)
}
שדות
idToken

string

אסימון שמייצג את זהות המשתמש. זהו אסימון אינטרנט של Json, כולל פרופיל מקודד. ההגדרה נמצאת בכתובת https://developers.google.com/identity/protocols/OpenIDConnect#obtainuserinfo.
profile

object (UserProfile)

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

string

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

enum (Permission)

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

string

הגדרת הלוקאל הראשית של המשתמש שהגיש את הבקשה. תואם לקוד השפה IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt עם זאת, תג המשנה של הסקריפט לא נכלל.
lastSeen

string (Timestamp format)

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

חותמת זמן בפורמט "זולו" RFC3339 UTC, מדויקת לננו-שניות. דוגמה: "2014-10-02T15:01:23.045123456Z"
userStorage

string

אסימון אטום שמסופק על ידי האפליקציה, והוא נשמר בשיחות של משתמש מסוים. הגודל המקסימלי של המחרוזת הוא 10,000 תווים.
packageEntitlements[]

object (PackageEntitlement)

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

enum (UserVerificationStatus)

מציין את סטטוס האימות של המשתמש.

UserProfile

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

ייצוג JSON 
{
  "displayName": string,
  "givenName": string,
  "familyName": string
}
שדות
displayName

string

השם המלא של המשתמש, כפי שמצוין בחשבון Google שלו. נדרשת ההרשאה NAME.
givenName

string

השם הפרטי של המשתמש, כפי שמצוין בחשבון Google שלו. נדרשת ההרשאה NAME.
familyName

string

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

PackageEntitlement

רשימת הרשאות שקשורות לשם חבילה

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

string

שם החבילה צריך להיות זהה לשם שמופיע בחבילת הפעולות
entitlements[]

object (Entitlement)

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

הרשאה

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

ייצוג JSON 
{
  "sku": string,
  "skuType": enum (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
שדות
sku

string

מק"ט המוצר שם החבילה של האפליקציה בתשלום והסיומת של Finsky docid לרכישות מתוך האפליקציה ולמינויים מתוך האפליקציה. להתאים את getSku() ב-Play InApp Billing API.
skuType

enum (SkuType)
inAppDetails

object (SignedData)

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

SignedData

ייצוג JSON 
{
  "inAppPurchaseData": {
    object
  },
  "inAppDataSignature": string
}
שדות
inAppPurchaseData

object (Struct format)

התאמה ל-INAPP_PURCHASE_DATA משיטת getPurchases() . כולל את כל הנתונים של רכישות מתוך האפליקציה בפורמט JSON. פרטים נוספים זמינים בטבלה 6 בכתובת https://developer.android.com/google/play/billing/billing_reference.html.
inAppDataSignature

string

תואם ל-IN_APP_DATA_SIGNATURE משיטת getPurchases() ב-Play InApp Billing API.

מכשיר

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

ייצוג JSON 
{
  "location": {
    object (Location)
  }
}
שדות
location

object (Location)

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

פלטפורמה

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

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

object (Capability)

רשימת יכולות שנתמכות על ידי הפלטפורמה בזמן הבקשה. למשל: actions.capability.AUDIO_OUTPUT

פונקציה

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

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

string

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

שיחה

ייצוג JSON 
{
  "conversationId": string,
  "type": enum (ConversationType),
  "conversationToken": string
}
שדות
conversationId

string

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

enum (ConversationType)

type מציין את המצב של השיחה במחזור החיים שלה.
conversationToken

string

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

קלט

ייצוג JSON 
{
  "rawInputs": [
    {
      object (RawInput)
    }
  ],
  "intent": string,
  "arguments": [
    {
      object (Argument)
    }
  ]
}
שדות
rawInputs[]

object (RawInput)

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

string

מציין את כוונת המשתמש. בפנייה הראשונה לשיחה, הכוונה תתייחס לכוונה להפעלה של הפעולה. בפניות הבאות, הכוונה תהיה פעולות נפוצות ב-Google Intent (שמתחילה ב-'actions'). לדוגמה, אם הקלט הצפוי הוא actions.intent.OPTION, הכוונה תהיה actions.intent.OPTION אם Google Assistant הצליח לעמוד בכוונה הזו, או actions.intent.TEXT אם המשתמש סיפק מידע נוסף. פרטים נוספים זמינים בכתובת https://developers.google.com/assistant/df-asdk/reference/intents.
arguments[]

object (Argument)

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

RawInput

ייצוג JSON 
{
  "inputType": enum (InputType),

  // Union field input can be only one of the following:
  "query": string,
  "url": string
  // End of list of possible types for union field input.
}
שדות
inputType

enum (InputType)

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

string

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

string

כתובת ה-URL הטריגר.