- تمثيل JSON
- المستخدم
- UserUser (الملف الشخصي للمستخدم)
- الاستحقاق
- التخويل
- SignedData
- الجهاز
- السطح
- الإمكانية
- المحادثة
- الإدخال
- الإدخال الأولي
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-webblogspot-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 |
يشير إلى حالة إثبات هوية المستخدم. |
الملف الشخصي للمستخدم
تحتوي على المعلومات الشخصية للمستخدم. لا تتم تعبئة الحقول إلا إذا منح المستخدم الإذن بالإجراء في حقل معيّن.
تمثيل JSON | |
---|---|
{ "displayName": string, "givenName": string, "familyName": string } |
الحقول | |
---|---|
displayName |
الاسم الكامل للمستخدم كما هو محدّد في حسابه على Google يجب الحصول على إذن |
givenName |
الاسم الأول للمستخدم على النحو المحدّد في حسابه على Google. يجب الحصول على إذن |
familyName |
اسم العائلة للمستخدم على النحو المحدّد في حسابه على Google. أن يكون هذا الحقل فارغًا. يجب الحصول على إذن |
التخويل
قائمة الاستحقاقات ذات الصلة باسم الحزمة
تمثيل JSON | |
---|---|
{
"packageName": string,
"entitlements": [
{
object ( |
الحقول | |
---|---|
packageName |
يجب أن يتطابق اسم الحزمة في حزمة الإجراءات. |
entitlements[] |
قائمة الاستحقاقات الخاصة بتطبيق معيّن |
الاستحقاق
تحديد الاستحقاق الرقمي للمستخدم. أنواع التخويلات المحتملة: عمليات الشراء المدفوعة داخل التطبيقات وعمليات الشراء داخل التطبيقات والاشتراكات داخل التطبيق.
تمثيل JSON | |
---|---|
{ "sku": string, "skuType": enum ( |
الحقول | |
---|---|
sku |
رمز التخزين التعريفي للمنتج. اسم حزمة التطبيق المدفوع، ولاحقة Finsky docid للشراء داخل التطبيق والاشتراك داخل التطبيق. مطابقة getSku() في واجهة برمجة التطبيقات Play InApp Billing API |
skuType |
|
inAppDetails |
ولا يتوفّر هذا العرض إلا لعمليات الشراء داخل التطبيق والمشتركين داخل التطبيق. |
البيانات الموقَّعة
تمثيل 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" للمستخدم يتفاعل معها. يمكن تمييز هذا السطح عن الأجهزة لأنّ مساحات متعدّدة على "مساعد Google" يمكن أن تتوفّر على الجهاز نفسه.
تمثيل JSON | |
---|---|
{
"capabilities": [
{
object ( |
الحقول | |
---|---|
capabilities[] |
قائمة بالإمكانيات التي تتيحها الواجهة في وقت الطلب، على سبيل المثال |
الإمكانية
تمثل وحدة من الوظائف التي يمكن أن تدعمها المساحة.
تمثيل JSON | |
---|---|
{ "name": string } |
الحقول | |
---|---|
name |
اسم الإمكانية، مثل |
محادثة
تمثيل JSON | |
---|---|
{
"conversationId": string,
"type": enum ( |
الحقول | |
---|---|
conversationId |
معرِّف فريد للمحادثة المتعدّدة المراحل. ويتم إسناده للدور الأول. بعد ذلك، يظل كما هو عند تبادل المحادثة اللاحقة حتى يتم إنهاء المحادثة. |
type |
يشير النوع إلى حالة المحادثة في مراحلها. |
conversationToken |
رمز مميز مبهم يحدّده الإجراء في المنعطف الأخير على المحادثة يمكن استخدامه بواسطة إجراء لتتبّع المحادثة أو لتخزين البيانات المتعلقة بالمحادثة. |
إدخال
تمثيل JSON | |
---|---|
{ "rawInputs": [ { object ( |
الحقول | |
---|---|
rawInputs[] |
يتم تحويل الصوت إلى نص بشكل مبدئي من كل مرحلة من المحادثات. قد تكون الأدوار المتعددة في المحادثة مطلوبة لتنفيذ إجراءات على Google لتقديم بعض أنواع الإدخال إلى الإجراء. |
intent |
تشير إلى هدف المستخدم. بالنسبة إلى أول محادثة، ستتم الإشارة إلى الغرض من بدء الإجراء. بالنسبة إلى تبادلات المحادثات اللاحقة، سيكون intent هو إجراء شائع على نية Google (يبدأ بـ "الإجراءات"). على سبيل المثال، إذا كان الإدخال المتوقّع هو |
arguments[] |
قائمة بقيم الوسيطة المقدَّمة للإدخال المطلوب من خلال الإجراء. |
الإدخال الأوّلي
تمثيل JSON | |
---|---|
{ "inputType": enum ( |
الحقول | ||
---|---|---|
inputType |
يشير إلى كيفية تقديم المستخدم لهذا الإدخال: ردّ مكتوب أو ردّ صوتي غير محدّد، وغير ذلك. |
|
حقل الاتحاد input . يمكن أن تكون قيمة الإدخال الفعلية input واحدة فقط من القيم التالية: |
||
query |
الإدخال المكتوب أو المنطوق من المستخدم النهائي |
|
url |
عنوان URL المُشغِّل. |