AppRequest

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

ייצוג 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 'Zulu' , מדויק לננו-שניות. דוגמה: "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

מציין את כוונת המשתמש. בפנייה הראשונה בשיחה, הכוונה תתייחס לכוונת ההפעלה של הפעולה. בפניות נוספות של שיחות, המטרה תהיה פעולות נפוצות ב-Intent של Google (מתחיל ב-'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 שמפעילה את החיפוש.