AppRequest

AppRequest היא בקשה שנשלחה על ידי Google Assistant למילוי הזמנה, כדי לקיים אינטראקציה עם פעולה. גרסת ה-API מצוינת בכותרת ה-HTTP. לגרסה 1 של ה-API, הכותרת כוללת: Google-Assistant-API-Version: v1. לגרסה 2 של ה-API, הכותרת כוללת: 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)

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

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

string

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

object (PackageEntitlement)

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

enum (UserVerificationStatus)

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

פרופיל משתמש

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

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

string

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

string

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

string

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

הרשאת חבילה

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

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

string

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

object (Entitlement)

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

זכאות

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

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

string

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

enum (SkuType)
inAppDetails

object (SignedData)

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

נתונים חתומים

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

object (Struct format)

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

string

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

object (Argument)

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

קלט גולמי

ייצוג 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 שמפעילה את המודעות.