- ייצוג JSON
- משתמש
- UserProfile
- PackageEntitlement
- הרשאה
- SignedData
- מכשיר
- שטח
- יכולת
- שיחה
- מכשירים לקליטת נתונים
- RawInput
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 |
מידע על המכשיר שדרכו המשתמש מבצע אינטראקציה עם הפעולה. |
surface |
מידע על הפלטפורמה שאיתה המשתמש מקיים אינטראקציה, למשל אם היא יכולה להפיק אודיו או שיש בה מסך. |
conversation |
מכיל נתוני סשן, כמו מזהה השיחה ואסימון השיחה. |
inputs[] |
רשימת ערכי הקלט המתאימים לקלט הצפוי שצויינו על ידי הפעולה. בטריגר של השיחה הראשונית, הקלט מכיל מידע על האופן שבו המשתמש הפעיל את השיחה. |
isInSandbox |
השדה הזה מציין אם יש לטפל בבקשה במצב ארגז חול. |
availableSurfaces[] |
משטחים זמינים למסירה במשטחים שונים. |
משתמש
ייצוג JSON | |
---|---|
{ "idToken": string, "profile": { object ( |
שדות | |
---|---|
idToken |
אסימון שמייצג את זהות המשתמש. זהו אסימון אינטרנט של Json, כולל פרופיל מקודד. ההגדרה נמצאת בכתובת https://developers.google.com/identity/protocols/OpenIDConnect#obtainuserinfo. |
profile |
מידע על משתמש הקצה. חלק מהשדות זמינים רק אם המשתמש העניק הרשאה לספק את המידע הזה לפעולה. |
accessToken |
אסימון OAuth2 שמזהה את המשתמש במערכת. האפשרות הזו זמינה רק אם המשתמש מקשר את החשבון שלו. |
permissions[] |
מכיל הרשאות שהוענקו על ידי המשתמש לפעולה הזו. |
locale |
הגדרת הלוקאל הראשית של המשתמש שהגיש את הבקשה. תואם לקוד השפה IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt עם זאת, תג המשנה של הסקריפט לא נכלל. |
lastSeen |
חותמת הזמן של האינטראקציה האחרונה עם המשתמש הזה. השדה הזה יושמט אם למשתמש לא הייתה אינטראקציה עם הנציג לפני כן. חותמת זמן בפורמט "זולו" RFC3339 UTC, מדויקת לננו-שניות. דוגמה: |
userStorage |
אסימון אטום שמסופק על ידי האפליקציה, והוא נשמר בשיחות של משתמש מסוים. הגודל המקסימלי של המחרוזת הוא 10,000 תווים. |
packageEntitlements[] |
רשימת הרשאות של משתמשים לכל שם חבילה שרשום בחבילת הפעולות, אם יש. |
userVerificationStatus |
מציין את סטטוס האימות של המשתמש. |
UserProfile
מכיל את הפרטים האישיים של המשתמש. השדות מאוכלסים רק אם המשתמש מעניק את ההרשאה לפעולה בשדה מסוים.
ייצוג JSON | |
---|---|
{ "displayName": string, "givenName": string, "familyName": string } |
שדות | |
---|---|
displayName |
השם המלא של המשתמש, כפי שמצוין בחשבון Google שלו. נדרשת ההרשאה |
givenName |
השם הפרטי של המשתמש, כפי שמצוין בחשבון Google שלו. נדרשת ההרשאה |
familyName |
שם המשפחה של המשתמש כפי שמצוין בחשבון Google שלו. לתשומת ליבכם: השדה הזה יכול להיות ריק. נדרשת ההרשאה |
PackageEntitlement
רשימת הרשאות שקשורות לשם חבילה
ייצוג JSON | |
---|---|
{
"packageName": string,
"entitlements": [
{
object ( |
שדות | |
---|---|
packageName |
שם החבילה צריך להיות זהה לשם שמופיע בחבילת הפעולות |
entitlements[] |
רשימת ההרשאות לאפליקציה נתונה |
הרשאה
המדיניות הזו מגדירה את ההרשאה הדיגיטלית של המשתמש. סוגי ההרשאות האפשריות: רכישות מתוך האפליקציה בתשלום, רכישות מתוך האפליקציה ומינויים מתוך האפליקציה.
ייצוג JSON | |
---|---|
{ "sku": string, "skuType": enum ( |
שדות | |
---|---|
sku |
מק"ט המוצר שם החבילה של האפליקציה בתשלום והסיומת של Finsky docid לרכישות מתוך האפליקציה ולמינויים מתוך האפליקציה. להתאים את getSku() ב-Play InApp Billing API. |
skuType |
|
inAppDetails |
מוצג רק לרכישות מתוך האפליקציה ולמינויים מתוך האפליקציה. |
SignedData
ייצוג JSON | |
---|---|
{ "inAppPurchaseData": { object }, "inAppDataSignature": string } |
שדות | |
---|---|
inAppPurchaseData |
התאמה ל-INAPP_PURCHASE_DATA משיטת getPurchases() . כולל את כל הנתונים של רכישות מתוך האפליקציה בפורמט JSON. פרטים נוספים זמינים בטבלה 6 בכתובת https://developer.android.com/google/play/billing/billing_reference.html. |
inAppDataSignature |
תואם ל-IN_APP_DATA_SIGNATURE משיטת getPurchases() ב-Play InApp Billing API. |
מכשיר
מידע על המכשיר שדרכו המשתמש מבצע אינטראקציה עם הפעולה.
ייצוג JSON | |
---|---|
{
"location": {
object ( |
שדות | |
---|---|
location |
מייצג את מיקום המכשיר בפועל, כמו קו רוחב, קו אורך וכתובת בפורמט המתאים. נדרשת ההרשאה |
פלטפורמה
מידע ספציפי על פלטפורמת הלקוח של Google Assistant שאיתה המשתמש מקיים אינטראקציה. התכונה 'משטחים' נבדלת מהמכשיר בכך שכמה פלטפורמות של Assistant עשויות להימצא באותו מכשיר.
ייצוג JSON | |
---|---|
{
"capabilities": [
{
object ( |
שדות | |
---|---|
capabilities[] |
רשימת יכולות שנתמכות על ידי הפלטפורמה בזמן הבקשה. למשל: |
פונקציה
מייצג יחידה של פונקציונליות שהמשטח יכול לתמוך בה.
ייצוג JSON | |
---|---|
{ "name": string } |
שדות | |
---|---|
name |
שם היכולת, למשל |
שיחה
ייצוג JSON | |
---|---|
{
"conversationId": string,
"type": enum ( |
שדות | |
---|---|
conversationId |
מזהה ייחודי לשיחה רבת הפניות. היא מוקצית לפנייה הראשונה. לאחר מכן השיחה תישאר ללא שינוי בשיחות הבאות עד שהשיחה תסתיים. |
type |
type מציין את המצב של השיחה במחזור החיים שלה. |
conversationToken |
אסימון אטום שצוין על ידי הפעולה בתור השיחה האחרונה. הפעולה יכולה להשתמש בה כדי לעקוב אחרי השיחה או כדי לאחסן נתונים שקשורים לשיחה. |
קלט
ייצוג JSON | |
---|---|
{ "rawInputs": [ { object ( |
שדות | |
---|---|
rawInputs[] |
תמלול קלט גולמי מכל תור שיחה. יכול להיות שיידרשו מספר פניות בשיחות כדי לבצע פעולות ב-Google כדי לספק סוגים מסוימים של קלט לפעולה. |
intent |
מציין את כוונת המשתמש. בפנייה הראשונה לשיחה, הכוונה תתייחס לכוונה להפעלה של הפעולה. בפניות הבאות, הכוונה תהיה פעולות נפוצות ב-Google Intent (שמתחילה ב-'actions'). לדוגמה, אם הקלט הצפוי הוא |
arguments[] |
רשימה של ערכי ארגומנטים שסופקו עבור הקלט שהתבקש על ידי הפעולה. |
RawInput
ייצוג JSON | |
---|---|
{ "inputType": enum ( |
שדות | ||
---|---|---|
inputType |
מציין כיצד המשתמש סיפק קלט זה: תגובה שהוקלדה, תשובה קולית, לא צוין וכו'. |
|
שדה איחוד input . ערך הקלט בפועל input יכול להיות רק אחד מהערכים הבאים: |
||
query |
קלט מוקלד או דיבור ממשתמש הקצה. |
|
url |
כתובת ה-URL הטריגר. |