- تمثيل JSON
- المستخدم
- UserProfile
- PackageEntitlement
- إذن الوصول إلى الموقع الإلكتروني
- SignedData
- الجهاز
- سطح المكتب
- الإمكانية
- المحادثة
- الإدخال
- RawInput
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 |
معلومات عن الجهاز الذي يستخدمه المستخدم للتفاعل مع الإجراء |
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 "Zulu" وبدقّة تصل إلى نانوثانية. مثال: |
userStorage |
رمز مميز مبهم يقدّمه التطبيق ويظهر على جميع المحادثات لمستخدم معيّن. الحد الأقصى لحجم السلسلة هو 10 آلاف حرف. |
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 من طريقة getPurchase() . يحتوي على جميع بيانات الشراء داخل التطبيق بتنسيق JSON. يمكنك الاطّلاع على التفاصيل في الجدول 6 من الرابط https://developer.android.com/google/play/billing/billing_reference.html. |
inAppDataSignature |
يطابق IN_APP_DATA_SIGNATURE من طريقة getPurchase() في واجهة برمجة تطبيقات فوترة Play InApp Billing API. |
الجهاز
معلومات عن الجهاز الذي يستخدمه المستخدم للتفاعل مع الإجراء
تمثيل JSON | |
---|---|
{
"location": {
object ( |
الحقول | |
---|---|
location |
تُمثِّل الموقع الجغرافي الفعلي للجهاز، مثل خط العرض والطول والعنوان بالتنسيق. يجب توفّر إذن |
مساحات العرض
معلومات خاصة بواجهة عميل "مساعد Google" التي يتفاعل معها المستخدم. ويتميز الجهاز عن غيره من خلال حقيقة أنّ مساحات العرض المتعدّدة المتوفّرة في "مساعد Google" قد تكون متوفّرة على الجهاز نفسه.
تمثيل JSON | |
---|---|
{
"capabilities": [
{
object ( |
الحقول | |
---|---|
capabilities[] |
قائمة بالإمكانيات التي يتيحها السطح في وقت تقديم الطلب، مثل |
الإمكانية
ويمثل وحدة وظيفية يستطيع السطح دعمها.
تمثيل JSON | |
---|---|
{ "name": string } |
الحقول | |
---|---|
name |
اسم الإمكانية، مثل |
المحادثة
تمثيل JSON | |
---|---|
{
"conversationId": string,
"type": enum ( |
الحقول | |
---|---|
conversationId |
معرّف فريد للمحادثة المتعددة المسارات. يتم تخصيصه للمنعطف الأول. وبعد ذلك يظل هذا الخيار كما هو في حالات التبديل في المحادثة اللاحقة إلى أن يتم إنهاء المحادثة. |
type |
نوع المحادثة إلى حالة المحادثة في مراحل نشاطها. |
conversationToken |
رمز مميّز مبهم تم تحديده من خلال الإجراء في آخر دور في المحادثة. ويمكن استخدامه من خلال أحد الإجراءات لتتبُّع المحادثة أو لتخزين البيانات ذات الصلة بالمحادثة. |
إدخال
تمثيل JSON | |
---|---|
{ "rawInputs": [ { object ( |
الحقول | |
---|---|
rawInputs[] |
تحويل الصوت إلى نص في كل مرحلة من المحادثة. وقد يُطلب منك تبديل عدة محادثات حتى تتمكّن الإجراءات على Google من توفير بعض أنواع الإدخالات في الإجراء. |
intent |
يشير إلى نية المستخدم. وبالنسبة إلى منعطف المحادثة الأول، سيشير الغرض إلى النية المحفّزة للإجراء. وبالنسبة إلى المراحل اللاحقة في المحادثة، سيكون الهدف من الإجراءات الشائعة على نية Google (يبدأ بـ "الإجراءات"). على سبيل المثال، إذا كان المدخل المتوقّع هو |
arguments[] |
قائمة بقيم الوسيطات المقدَّمة للإدخال الذي يطلبه الإجراء. |
RawInput
تمثيل JSON | |
---|---|
{ "inputType": enum ( |
الحقول | ||
---|---|---|
inputType |
تشير هذه القيمة إلى كيفية تقديم المستخدم لهذا الإدخال: استجابة مكتوبة، أو استجابة صوتية، أو غير محدّد، وغير ذلك. |
|
حقل الاتحاد input يمكن أن تكون قيمة الإدخال الفعلية input واحدة فقط مما يلي: |
||
query |
الإدخال المكتوب أو الشفهي من المستخدم النهائي |
|
url |
عنوان URL للتشغيل. |