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

إعداد اللغة الأساسية للمستخدم الذي يرسل الطلب. يتّبع رمز اللغة الذي يتبع رمز اللغة 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 آلاف حرف.

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 من طريقة 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" التي يتفاعل معها المستخدم. ويتميز الجهاز عن غيره من خلال حقيقة أنّ مساحات العرض المتعدّدة المتوفّرة في "مساعد 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 للتشغيل.