AppRequest

AppRequest هو طلب يرسله "مساعد Google" إلى مرة تنفيذ من أجل التفاعل مع إجراء. ويتم تحديد إصدار واجهة برمجة التطبيقات في عنوان HTTP. بالنسبة إلى الإصدار 1 من واجهة برمجة التطبيقات، يحتوي العنوان على: Google-Assistant-API-Version: v1. بالنسبة إلى الإصدار 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

إعداد اللغة الأساسية للمستخدم الذي قدّم الطلب. يتّبع رمز اللغة http://www.rfc-editor.org/rfc/bcp/bcp47.txt رمز اللغة IETF BCP-47، ومع ذلك، لم يتم تضمين العلامة الفرعية للنص البرمجي.
lastSeen

string (Timestamp format)

الطابع الزمني للتفاعل الأخير مع هذا المستخدم. سيتم حذف هذا الحقل إذا لم يسبق للمستخدم التفاعل مع الوكيل.

يجب أن يكون طابعًا زمنيًا بالتنسيق RFC3339 UTC "Zulu"‎ وبدقّة تصل إلى نانوثانية. مثال: "2014-10-02T15:01:23.045123456Z"
userStorage

string

يشير ذلك المصطلح إلى رمز مميّز مبهم يوفّره التطبيق ويستمر في جميع المحادثات لمستخدم معيّن. الحد الأقصى لحجم السلسلة هو 10 آلاف حرف.
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" يتفاعل معها المستخدم. أمّا Surface، فهي مختلفة عن الجهاز لأنّ مساحات عرض متعددة خاصة بخدمة "مساعد Google" قد تكون متوفّرة على الجهاز نفسه.

تمثيل 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)

النوع إلى حالة المحادثة في دورة حياتها.
conversationToken

string

رمز مميّز معتم يتم تحديده بواسطة الإجراء في آخر منعطف للمحادثة. ويمكن أن يستخدمه "الإجراء" لتتبُّع المحادثة أو تخزين البيانات ذات الصلة بالمحادثة.

الإدخال

تمثيل JSON 
{
  "rawInputs": [
    {
      object (RawInput)
    }
  ],
  "intent": string,
  "arguments": [
    {
      object (Argument)
    }
  ]
}
الحقول
rawInputs[]

object (RawInput)

تحويل الصوت إلى نص بشكل أولي من كل موضع في المحادثة قد تكون هناك حاجة إلى إجراء محادثات متعددة مع الإجراءات على Google لتوفير بعض أنواع الإدخالات في المهمة.
intent

string

ويشير إلى نية المستخدِم. بالنسبة للمنعطف الأول للمحادثة، سيشير الغرض إلى الغرض الذي حثّ على تنفيذ الإجراء. بالنسبة إلى الأدوار اللاحقة للمحادثات، سيكون الغرض هو الإجراءات الشائعة على نيّة Google (تبدأ بكلمة "الإجراءات"). على سبيل المثال، إذا كان الإدخال المتوقّع هو actions.intent.OPTION، سيكون الغرض المحدّد هنا إما actions.intent.OPTION إذا تمكّن "مساعد Google" من تحقيق ذلك، أو 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 الذي يؤدي إلى التشغيل.