- تمثيل JSON
- ConfigFiles
- ConfigFile
- البيان
- الإجراءات
- CustomAction
- التفاعل
- PushNotification
- DailyUpdate
- ActionLink
- AssistantLink
- الإعدادات
- Category (الفئة)
- SurfaceRequirements
- CapabilityRequirement
- SurfaceCapability
- LocalizedSettings
- ThemeCustomization
- ImageCornerStyle
- AccountLinking
- LinkingType
- AuthGrantType
- الردّ التلقائي على الويب
- المعالج
- HttpsEndpoint
- InlineCloudFunction
- النية
- IntentParameter
- ClassReference
- EntitySetReferences
- EntitySetReference
- النوع
- SynonymType
- MatchType
- الكيان
- EntityDisplay
- RegularExpressionType
- الكيان
- FreeTextType
- EntitySet
- الكيان
- GlobalIntentEvent
- EventHandler
- StaticPrompt
- StaticPromptCandidate
- أداة الاختيار
- SurfaceCapabilities
- الإمكانية
- StaticPromptResponse
- StaticSimplePrompt
- خيار المنتج
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- ImageFill
- StaticLinkPrompt
- OpenUrl
- UrlHint
- StaticTablePrompt
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- StaticMediaPrompt
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- RepeatMode
- StaticListPrompt
- ListItem
- StaticCollectionPrompt.
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- اقتراح
- StaticCanvasPrompt
- المشهد
- IntentEvent
- ConditionalEvent
- الفتحة
- PromptSettings
- CommitBehavior
- DefaultValue
- DataFiles
- DataFile
التفاف لقائمة من الملفات.
تمثيل JSON | |
---|---|
{ // Union field |
الحقول | ||
---|---|---|
حقل الاتحاد file_type يمكن إرسال نوع واحد فقط من الملفات إلى الخادم في كل مرة، سواء كانت ملفات تهيئة أو ملفات بيانات. يمكن أن تكون السمة "file_type " واحدة فقط مما يلي: |
||
configFiles |
قائمة بملفات الإعداد يشمل ذلك البيان والإعدادات وحِزم موارد نماذج التفاعل وغير ذلك. |
|
dataFiles |
قائمة بملفات البيانات ويشمل هذا الصورة والملف الصوتي ورمز مصدر دالة السحابة الإلكترونية. |
ConfigFiles
برنامج تغليف لملفات الإعداد المتكررة لا يمكن أن توجد الحقول المتكررة في أحد الحقول.
تمثيل JSON | |
---|---|
{
"configFiles": [
{
object ( |
الحقول | |
---|---|
configFiles[] |
ملفات تهيئة متعددة. |
ConfigFile
يمثل هذا النوع ملفًا واحدًا يحتوي على بيانات منظَّمة. يمكن للمطورين تحديد معظم مشاريعهم باستخدام التكوين المنظم بما في ذلك الإجراءات، والإعدادات، وإنجاز المهام.
تمثيل JSON | |
---|---|
{ "filePath": string, // Union field |
الحقول | ||
---|---|---|
filePath |
يشير ذلك المصطلح إلى المسار النسبي لملف الإعداد من جذر المشروع في بنية ملف حزمة تطوير البرامج (SDK). لكل نوع من أنواع الملفات أدناه مسار ملف مسموح به. على سبيل المثال: settings/settings.yaml |
|
حقل الاتحاد file يجب أن يكون لكل نوع من ملفات التهيئة حقل مقابل في أحدهما. يمكن أن تكون السمة "file " واحدة فقط مما يلي: |
||
manifest |
ملف بيان واحد مسار الملف المسموح به: |
|
actions |
ملف إجراءات واحد يحتوي على جميع الإجراءات المحددة. مسارات الملفات المسموح بها: |
|
settings |
تكوين إعدادات فردية تتضمن إعدادات وإعدادات غير قابلة للأقلمة للّغة الافتراضية للمشروع (إذا تم تحديدها). بالنسبة إلى ملف إلغاء اللغة، ستتم تعبئة الحقل localizedSettings فقط. مسارات الملفات المسموح بها: |
|
webhook |
تعريف واحد للردّ التلقائي على الويب مسار الملف المسموح به: |
|
intent |
تعريف الغرض الوحيد. مسارات الملفات المسموح بها: |
|
type |
تعريف من نوع واحد. مسارات الملفات المسموح بها: |
|
entitySet |
تعريف مجموعة كيانات واحدة. مسارات الملفات المسموح بها: |
|
globalIntentEvent |
تعريف واحد للحدث الشامل حسب النية بالشراء مسارات الملفات المسموح بها: |
|
scene |
تعريف مشهد واحد. مسارات الملفات المسموح بها: |
|
staticPrompt |
تعريف واحد ثابت للطلب مسارات الملفات المسموح بها: |
|
accountLinkingSecret |
البيانات الوصفية المقابلة لسر العميل المُستخدَم في ربط الحساب مسار الملف المسموح به: |
|
resourceBundle |
حزمة موارد واحدة، وهي عبارة عن خريطة من سلسلة إلى سلسلة أو قائمة من السلاسل. يمكن استخدام حِزم الموارد لترجمة السلاسل في الطلبات الثابتة. مسارات الملفات المسموح بها: |
البيان
تحتوي على معلومات "قابلة للنقل"، أي غير خاصة بأي مشروع معيّن ويمكن نقلها بين المشاريع.
تمثيل JSON | |
---|---|
{ "version": string } |
الحقول | |
---|---|
version |
تمثّل هذه السمة نسخة من تنسيق الملف. إصدار تنسيق الملف الحالي هو 1.0 مثال: "1.0" |
المهام
تمثل قائمة الإجراءات المحددة في المشروع.
تمثيل JSON | |
---|---|
{
"custom": {
string: {
object ( |
الحقول | |
---|---|
custom |
يمكنك الربط من الأغراض إلى الإجراءات المخصّصة لضبط الاستدعاء للمشروع. ويمكن أن تكون أغراض الاستدعاء إما نظام أو أغراض مخصّصة محدّدة في الحزمة "مخصّصة/حسب نية/". يجب أن يكون لجميع الأغراض المحدّدة هنا (أهداف النظام والأغراض المخصّصة) ملف أهداف مقابلة في الحزمة "مخصّص/عالمي/". عنصر يحتوي على قائمة من أزواج |
CustomAction
التفاصيل المتعلّقة بإجراء مخصّص.
تمثيل JSON | |
---|---|
{
"engagement": {
object ( |
الحقول | |
---|---|
engagement |
آليات تفاعل مرتبطة بهذا الإجراء لمساعدة المستخدمين النهائيين على الاشتراك في الإشعارات الفورية والتعديلات اليومية. يُرجى العلم أنّ اسم الغرض المحدّد في إعدادات خانتك الخاصة بالتحديثات اليومية/الإشعارات الفورية يجب أن يتطابق مع الغرض من هذا الإجراء في ما يخص اشتراك المستخدمين النهائيين في هذه التعديلات. |
تفاعل
تحدد آليات التفاعل المرتبطة بهذا الإجراء. يتيح ذلك للمستخدمين النهائيين الاشتراك في الإشعارات الفورية والتحديث اليومي.
تمثيل JSON | |
---|---|
{ "title": string, "pushNotification": { object ( |
الحقول | |
---|---|
title |
عنوان التفاعل الذي سيتم إرساله إلى المستخدمين النهائيين لطلب إذنهم لتلقي التحديثات. ستظهر رسالة المطالبة التي يتم إرسالها إلى المستخدمين النهائيين للحصول على التحديثات اليومية على النحو التالي: "في أي وقت تريد أن أرسِل إليك {title}" يوميًا، وستظهر الإشعارات الفورية على النحو التالي: "هل توافق على إرسال إشعارات فورية بشأن {title}"؟ هذا الحقل قابل للترجمة. |
pushNotification |
إعدادات الإشعارات الفورية التي تتيحها عملية التفاعل هذه |
actionLink |
إعداد الرابط لإجراء ما يحدد ما إذا كان سيتم تفعيل مشاركة الروابط لهذا الإجراء أم لا، وإذا كان الأمر كذلك، يحتوي على الاسم المعروض سهل الاستخدام للرابط. تم إيقاف ActionLink نهائيًا. يمكنك استخدام AssistantLink بدلاً من ذلك. |
assistantLink |
إعداد الرابط لإجراء ما يحدد ما إذا كان سيتم تفعيل مشاركة الروابط لهذا الإجراء أم لا، وإذا كان الأمر كذلك، يحتوي على الاسم المعروض سهل الاستخدام للرابط. |
dailyUpdate |
إعدادات التعديل اليومية التي يتيحها هذا التفاعل |
PushNotification
تُحدِّد إعدادات الإشعارات الفورية التي يتيحها هذا التفاعل.
DailyUpdate
تحدِّد إعدادات التحديث اليومية التي يتيحها هذا التفاعل.
ActionLink
تشير هذه العلامة إلى ما إذا كانت روابط المشاركة مفعّلة لهذا الإجراء والإعدادات المقابلة. يتم استخدام روابط الإجراءات لربط مستخدم بإجراء معيّن بصفحة معيّنة. تم إيقاف ActionLink نهائيًا. يمكنك استخدام AssistantLink بدلاً من ذلك.
تمثيل JSON | |
---|---|
{ "title": string } |
الحقول | |
---|---|
title |
عنوان معروض سهل الاستخدام للرابط. |
AssistantLink
تشير هذه العلامة إلى ما إذا كانت روابط المشاركة مفعّلة لهذا الإجراء والإعدادات المقابلة. يتم استخدام روابط "مساعد Google" لربط مستخدم بإجراء معيّن بصفحة معيّنة في التطبيق.
تمثيل JSON | |
---|---|
{ "title": string } |
الحقول | |
---|---|
title |
عنوان معروض سهل الاستخدام للرابط. |
الإعدادات
تمثل إعدادات مشروع "المهام" التي لا تكون خاصة بلغة معيّنة. العلامة التالية: 22
تمثيل JSON | |
---|---|
{ "projectId": string, "defaultLocale": string, "enabledRegions": [ string ], "disabledRegions": [ string ], "category": enum ( |
الحقول | |
---|---|
projectId |
رقم تعريف مشروع الإجراءات |
defaultLocale |
اللغة التلقائية للمشروع. بالنسبة إلى جميع الملفات باستثناء الملفات ضمن |
enabledRegions[] |
تُمثِّل المناطق التي يمكن للمستخدمين فيها استدعاء الإجراءات الخاصة بك، استنادًا إلى موقع تواجد المستخدم. لا يمكن ضبط السياسة في حال ضبط سياسة |
disabledRegions[] |
تمثل المناطق التي تم حظر الإجراءات فيها استنادًا إلى الموقع الجغرافي الذي تواجد فيه المستخدم. لا يمكن ضبط السياسة في حال ضبط سياسة |
category |
الفئة لمشروع الإجراءات هذا. |
usesTransactionsApi |
ما إذا كان بإمكان "المهام" استخدام المعاملات (مثل إجراء الحجوزات وتلقّي الطلبات وما إلى ذلك) وفي حال اختيار القيمة "خطأ"، ستفشل محاولات استخدام واجهات برمجة تطبيقات المعاملات. |
usesDigitalPurchaseApi |
ما إذا كان بإمكان "المهام" تنفيذ معاملات للسلع الرقمية. |
usesInteractiveCanvas |
يمكنك اختيار ما إذا كانت الإجراءات تستخدم "لوحة الرسم التفاعلية". |
usesHomeStorage |
ما إذا كانت "المهام" تستخدم ميزة "التخزين في المنزل" |
designedForFamily |
ما إذا كان محتوى المهام مخصّصًا للعائلات (DFF) |
containsAlcoholOrTobaccoContent |
ما إذا كانت "المهام" تتضمّن محتوى مرتبطًا بالكحول أو التبغ |
keepsMicOpen |
يمكنك اختيار ما إذا كانت الإجراءات يمكن أن تترك الميكروفون مفتوحًا بدون طلب صريح أثناء المحادثة. |
surfaceRequirements |
متطلبات السطح التي يجب أن تدعمها مساحة عرض العميل لاستدعاء الإجراءات في هذا المشروع. |
testingInstructions |
تعليمات الاختبار المرن لمراجع "المهام" (مثل تعليمات ربط الحساب) |
localizedSettings |
الإعدادات المترجَمة للّغة التلقائية للمشروع يجب أن يكون لكل لغة إضافية ملف إعدادات خاص بها في الدليل الخاص بها. |
accountLinking |
السماح للمستخدمين بإنشاء الحسابات أو ربطها من خلال تسجيل الدخول بحساب Google و/أو خدمة OAuth الخاصة |
selectedAndroidApps[] |
تطبيقات Android المحددة للوصول إلى عمليات الشراء على Google Play لإجراء المعاملات هذه مجموعة من تطبيقات Android المرتبطة بمشروع الإجراءات لإثبات ملكية العلامة التجارية وتفعيل ميزات إضافية. يُرجى الاطّلاع على https://developers.google.com/assistant/console/brand-verification للحصول على مزيد من المعلومات. |
الفئة
اختيارات الفئات لمشروع "المهام"
عمليات التعداد | |
---|---|
CATEGORY_UNSPECIFIED |
غير معروف / غير محدد |
BUSINESS_AND_FINANCE |
فئة النشاط التجاري والمالية. |
EDUCATION_AND_REFERENCE |
فئة التعليم والمراجع. |
FOOD_AND_DRINK |
فئة المأكولات والمشروبات. |
GAMES_AND_TRIVIA |
فئة الألعاب والمعلومات العامة. |
HEALTH_AND_FITNESS |
فئة الصحة واللياقة البدنية. |
KIDS_AND_FAMILY |
فئة الأطفال والعائلة. |
LIFESTYLE |
فئة أسلوب الحياة |
LOCAL |
فئة محلية. |
MOVIES_AND_TV |
فئة الأفلام والبرامج التلفزيونية |
MUSIC_AND_AUDIO |
فئة الموسيقى والصوت. |
NEWS |
فئة الأخبار |
NOVELTY_AND_HUMOR |
فئة "الابتكار والفكاهة". |
PRODUCTIVITY |
فئة الإنتاجية |
SHOPPING |
فئة التسوّق |
SOCIAL |
الفئة الاجتماعية: |
SPORTS |
فئة الرياضة |
TRAVEL_AND_TRANSPORTATION |
فئة السفر ووسائل النقل. |
UTILITIES |
فئة برامج الخدمات |
WEATHER |
فئة الطقس |
HOME_CONTROL |
فئة الإدارة الآلية للمنزل |
SurfaceRequirements
تحتوي على مجموعة من المتطلبات التي يجب أن يدعمها سطح العميل لتنفيذ الإجراءات في مشروعك.
تمثيل JSON | |
---|---|
{
"minimumRequirements": [
{
object ( |
الحقول | |
---|---|
minimumRequirements[] |
تمثّل هذه السمة الحد الأدنى لمجموعة الإمكانات اللازمة لاستدعاء الإجراءات في مشروعك. إذا كانت السطح لا تحتوي على أي من هذه العناصر، لن يتم تشغيل الإجراء. |
CapabilityRequirement
تمثّل هذه السمة شرطًا بشأن توفُّر إمكانية معيّنة.
تمثيل JSON | |
---|---|
{
"capability": enum ( |
الحقول | |
---|---|
capability |
تمثّل هذه السمة نوع الإمكانية. |
SurfaceCapability
مجموعة محتملة من إمكانات السطح.
عمليات التعداد | |
---|---|
SURFACE_CAPABILITY_UNSPECIFIED |
غير معروف / غير محدد |
AUDIO_OUTPUT |
يتوافق Surface مع ميزة إخراج الصوت. |
SCREEN_OUTPUT |
يتوافق Surface مع شاشة العرض/إخراج المحتوى المرئي. |
MEDIA_RESPONSE_AUDIO |
يتوافق تطبيق Surface مع صوت استجابة الوسائط. |
WEB_BROWSER |
يتوافق Surface مع متصفِّحات الويب. |
ACCOUNT_LINKING |
يتيح تطبيق Surface ربط الحسابات. |
INTERACTIVE_CANVAS |
يتوافق Surface مع "لوحة الرسم التفاعلية". |
HOME_STORAGE |
يتوافق Surface مع ميزة التخزين في المنزل. |
LocalizedSettings
تمثِّل إعدادات مشروع "المهام" الخاصة بلغة المستخدِم. في هذه الحالة، يعني المستخدم المستخدم النهائي الذي يستدعي الإجراءات. هذه الرسالة قابلة للترجمة.
تمثيل JSON | |
---|---|
{
"displayName": string,
"pronunciation": string,
"shortDescription": string,
"fullDescription": string,
"smallLogoImage": string,
"largeBannerImage": string,
"developerName": string,
"developerEmail": string,
"termsOfServiceUrl": string,
"voice": string,
"voiceLocale": string,
"privacyPolicyUrl": string,
"sampleInvocations": [
string
],
"themeCustomization": {
object ( |
الحقول | |
---|---|
displayName |
مطلوبة. الاسم المعروض التلقائي لمشروع الإجراءات هذا (في حال عدم توفّر ترجمة) |
pronunciation |
مطلوبة. طريقة لفظ الاسم المعروض لاستحضاره ضمن سياق صوتي (منطوق). |
shortDescription |
مطلوبة. هو الوصف الموجز التلقائي لمشروع الإجراءات (في حال عدم توفُّر ترجمة). عدد الأحرف المسموح به هو 80 حرفًا. |
fullDescription |
مطلوبة. الوصف الطويل التلقائي لمشروع الإجراءات (في حال عدم توفُّر ترجمة) عدد الأحرف المسموح به هو 4,000 حرف. |
smallLogoImage |
مطلوبة. صورة مربعة صغيرة، 192 × 192 بكسل يجب تحديد هذه السمة كمرجع للصورة المعنيّة في دليل |
largeBannerImage |
اختياريّ. صورة أفقية كبيرة، 1920 × 1080 بكسل يجب تحديد هذه السمة كمرجع للصورة المعنيّة في دليل |
developerName |
مطلوبة. اسم المطوّر الذي سيتم عرضه للمستخدمين |
developerEmail |
مطلوبة. عنوان البريد الإلكتروني لجهة اتصال مطوّر البرامج. |
termsOfServiceUrl |
اختياريّ. عنوان URL لبنود الخدمة. |
voice |
مطلوبة. نوع الصوت في "مساعد Google" الذي يسمعه المستخدمون عند تفاعلهم مع الإجراءات. القيم المسموح بها هي "male_1" و"male_2" و"female_1" و "female_2". |
voiceLocale |
اختياريّ. اللغة المستخدَمة للصوت المحدَّد. وفي حال عدم تحديد ذلك، يتم التحويل إلى لغة "مساعد Google" لدى المستخدم. في حال تحديد لغة الصوت، يجب أن تكون اللغة الجذر نفسها للّغة المحدّدة في LocalizedSettings. |
privacyPolicyUrl |
مطلوبة. عنوان URL لسياسة الخصوصية |
sampleInvocations[] |
اختياريّ. يتضمّن دليل "مساعد Google" نماذج لعبارات الاستدعاء معروضة كجزء من وصف مشروع الإجراءات الخاص بك. سيساعد هذا المستخدمين في تعلم كيفية استخدامه. |
themeCustomization |
اختياريّ. عمليات تخصيص المظاهر للمكوّنات المرئية للإجراءات |
ThemeCustomization
الأنماط المطبَّقة على البطاقات التي يتم عرضها للمستخدمين
تمثيل JSON | |
---|---|
{
"backgroundColor": string,
"primaryColor": string,
"fontFamily": string,
"imageCornerStyle": enum ( |
الحقول | |
---|---|
backgroundColor |
لون خلفية البطاقات يعمل كإجراء احتياطي إذا لم يقدِّم المطوِّرون |
primaryColor |
سيتم استخدام لون المظهر الأساسي للإجراء من أجل ضبط لون نص العنوان ولون خلفية عنصر العمل في بطاقات "المهام مع مساعد Google". مثال على الاستخدام: #FAFAFA |
fontFamily |
مجموعة الخطوط التي سيتم استخدامها لعنوان البطاقات. الخطوط المتوافقة: - Sans Serif - Sans Serif Medium - Sans Serif غامق - Sans Serif غامق - Sans Serif مكثف - Sans Serif مكثف - Serif Serif غامق - Monospace - تدوين - Sans Serif صغير |
imageCornerStyle |
نمط حدودي لصورة أمامية للبطاقات. على سبيل المثال، يمكن تطبيقها على الصورة الأمامية لبطاقة أساسية أو بطاقة لوحة عرض دوّارة. |
landscapeBackgroundImage |
الوضع الأفقي (1920×1200 بكسل كحد أدنى) يجب تحديد هذه السمة كمرجع للصورة المعنيّة في دليل |
portraitBackgroundImage |
وضع "بورتريه" (1200×1920 بكسل كحد أدنى) يجب تحديد هذه السمة كمرجع للصورة المعنيّة في دليل |
ImageCornerStyle
تصف كيفية عرض حدود الصور.
عمليات التعداد | |
---|---|
IMAGE_CORNER_STYLE_UNSPECIFIED |
غير محدّدة / غير محدّدة |
CURVED |
زاوية مستديرة للصورة |
ANGLED |
زاوية مستطيلة للصورة. |
AccountLinking
تتيح ميزة "ربط الحساب" لـ Google توجيه المستخدم لتسجيل الدخول إلى خدمات الويب في التطبيق.
بالنسبة إلى أنواع ربط "تسجيل الدخول بحساب Google" وبروتوكول OAuth + تسجيل الدخول بحساب Google، تُنشئ Google معرِّف عميل لتعريف Google بتطبيقك ("معرِّف العميل الذي تصدره Google من خلال الإجراءات الخاصة بك" على واجهة مستخدم وحدة التحكّم). هذا الحقل للقراءة فقط ويمكن التحقّق منه من خلال الانتقال إلى صفحة "ربط الحساب" في واجهة مستخدم وحدة التحكّم. يُرجى الاطّلاع على الرابط: https://developers.google.com/assistant/identity/google-sign-in
ملاحظة: بالنسبة إلى جميع أنواع إعدادات ربط الحسابات (باستثناء تسجيل الدخول بحساب Google)، عليك تقديم اسم مستخدم وكلمة مرور لحساب تجريبي في Settings.testing_instructions كي يتمكّن فريق المراجعة من مراجعة التطبيق (لن تكون مرئية للمستخدمين).
تمثيل JSON | |
---|---|
{ "enableAccountCreation": boolean, "linkingType": enum ( |
الحقول | |
---|---|
enableAccountCreation |
مطلوبة. إذا |
linkingType |
مطلوبة. نوع الربط المطلوب استخدامه. يُرجى الاطّلاع على https://developers.google.com/assistant/identity للحصول على مزيد من التفاصيل حول أنواع الربط. |
authGrantType |
اختياريّ. يشير إلى نوع المصادقة لـ OAUTH LinkingType. |
appClientId |
اختياريّ. معرّف العميل الذي أصدره تطبيقك إلى Google. هذا هو معرّف عميل OAuth2 الذي يحدِّد Google في خدمتك. لا يتم ضبطه إلا عند استخدام بروتوكول OAuth. |
authorizationUrl |
اختياريّ. نقطة نهاية لصفحة ويب تسجيل الدخول التي تتوافق مع رمز OAuth2 أو التدفقات الضمنية يجب أن يستخدم عنوان URL بروتوكول HTTPS. لا يتم ضبطه إلا عند استخدام بروتوكول OAuth. |
tokenUrl |
اختياريّ. نقطة نهاية OAuth2 لتبادل الرمز المميز. يجب أن يستخدم عنوان URL بروتوكول HTTPS. لا يتم ضبط هذا الإعداد عند استخدام بروتوكول OAuth مع منح IMPLICIT فقط كنوع الربط. لا يتم ضبطه إلا عند استخدام بروتوكول OAuth. |
scopes[] |
اختياريّ. قائمة بالأذونات التي يجب أن يوافق عليها المستخدم حتى يتسنى له استخدام خدمتك. لا يتم ضبطه إلا عند استخدام بروتوكول OAuth. تأكد من تقديم بنود الخدمة في معلومات الدليل في قسم LocalizedSettings.terms_of_service_url إذا كنت تحدد هذا الحقل. |
learnMoreUrl |
اختياريّ. إنّها صفحة ويب في خدمتك توضّح الأذونات التي يمنحها المستخدم إلى Google. لا يتم ضبطه إلا في حال استخدام OAuth وتسجيل الدخول بحساب Google. تأكد من تقديم بنود الخدمة في معلومات الدليل في قسم LocalizedSettings.terms_of_service_url إذا كنت تحدد هذا الحقل. |
useBasicAuthHeader |
اختياريّ. إذا كانت القيمة true، اسمح لـ Google بنقل معرِّف العميل والسر عبر عنوان مصادقة HTTP الأساسية. وبخلاف ذلك، تستخدم Google معرِّف العميل والمفتاح السرّي داخل نص المشاركة. لا يتم ضبطه إلا عند استخدام بروتوكول OAuth. تأكد من تقديم بنود الخدمة في معلومات الدليل في قسم LocalizedSettings.terms_of_service_url إذا كنت تحدد هذا الحقل. |
LinkingType
نوع ربط الحساب المطلوب تنفيذه.
عمليات التعداد | |
---|---|
LINKING_TYPE_UNSPECIFIED |
غير محدد |
GOOGLE_SIGN_IN |
نوع ربط "تسجيل الدخول بحساب Google" في حال استخدام نوع الربط هذا، لا حاجة إلى ضبط أي حقول مرتبطة ببروتوكول OAuth أدناه. |
OAUTH_AND_GOOGLE_SIGN_IN |
نوع الربط بين OAuth و"تسجيل الدخول بحساب Google". |
OAUTH |
نوع ربط OAuth. |
AuthGrantType
نوع منح الإذن باستخدام OAuth2 الذي تستخدمه Google لإرشاد المستخدم لتسجيل الدخول إلى خدمة الويب في تطبيقك.
عمليات التعداد | |
---|---|
AUTH_GRANT_TYPE_UNSPECIFIED |
غير محدد |
AUTH_CODE |
منح رمز التفويض. يتطلب منك تقديم كل من عنوان URL للمصادقة وعنوان URL لرمز الدخول. |
IMPLICIT |
منح رمز ضمني لا يتطلب منك ذلك سوى تقديم عنوان URL للمصادقة. |
الردّ التلقائي على الويب
البيانات الوصفية لأنواع مختلفة من الردود التلقائية على الويب. إذا كنت تستخدم inlineCloudFunction
، يجب أن يكون رمز المصدر في دليل بالاسم نفسه كقيمة المفتاح executeFunction
. على سبيل المثال، قيمة my_webhook
للمفتاح executeFunction
يجب أن تكون بنية الرمز على النحو التالي: - /webhooks/my_webhook.yaml
- /webhooks/my_webhook/index.js
- /webhooks/my_webhook/package.json
تمثيل JSON | |
---|---|
{ "handlers": [ { object ( |
الحقول | ||
---|---|---|
handlers[] |
قائمة معالِجات هذا الرد التلقائي على الويب. |
|
حقل الاتحاد webhook_type يتوفّر نوع واحد فقط للردّ التلقائي على الويب. يمكن أن تكون السمة "webhook_type " واحدة فقط مما يلي: |
||
httpsEndpoint |
نقطة نهاية HTTPS مخصّصة للردّ التلقائي على الويب. |
|
inlineCloudFunction |
البيانات الوصفية لدالة السحابة الإلكترونية التي تم نشرها من الرمز في مجلد الردود التلقائية على الويب |
المعالِج
يُعلن اسم معالج Webhoook. يمكن أن يحتوي الرد التلقائي على الويب على معالِجات متعدّدة مسجَّلة. يمكن استدعاء هذه المعالِجات من عدة أماكن في مشروع الإجراءات.
تمثيل JSON | |
---|---|
{ "name": string } |
الحقول | |
---|---|
name |
مطلوبة. اسم المعالج يجب أن يكون فريدًا عبر جميع المعالِجات في مشروع الإجراءات. يمكنك التحقق من اسم هذا المعالج لاستدعاء الدالة الصحيحة في رمز مصدر التنفيذ. |
HttpsEndpoint
نقطة نهاية REST للإشعار في حال عدم استخدام المحرر المضمَّن.
تمثيل JSON | |
---|---|
{ "baseUrl": string, "httpHeaders": { string: string, ... }, "endpointApiVersion": integer } |
الحقول | |
---|---|
baseUrl |
عنوان URL الأساسي الذي يستخدم بروتوكول HTTPS لنقطة نهاية التنفيذ (بروتوكول HTTP غير متوافق). يتم إلحاق أسماء المعالِج بمسار عنوان URL الأساسي بعد النقطتين (باتّباع دليل الأنماط الوارد في https://cloud.google.com/apis/design/custom_methods). على سبيل المثال، سيتلقّى عنوان URL الأساسي "https://gactions.service.com/api" طلبات بعنوان URL 'https://gactions.service.com/api:{method}'. |
httpHeaders |
خريطة معلمات HTTP التي سيتم تضمينها في طلب POST. عنصر يحتوي على قائمة من أزواج |
endpointApiVersion |
إصدار البروتوكول الذي تستخدمه نقطة النهاية. هذا هو البروتوكول الذي تشاركه جميع أنواع طرق التنفيذ وليس خاصًا بنوع طريقة التنفيذ التي تستخدمها Google. |
InlineCloudFunction
يحتفظ بالبيانات الوصفية لدالة Cloud مضمَّنة تم نشرها من مجلد الردود التلقائية على الويب.
تمثيل JSON | |
---|---|
{ "executeFunction": string } |
الحقول | |
---|---|
executeFunction |
اسم نقطة دخول دالة Cloud. يجب أن تتطابق قيمة هذا الحقل مع اسم الطريقة المُصدَّرة من رمز المصدر. |
النيّة بالشراء
تربط الأغراض مدخلات المستخدم المفتوحة بالكائنات المنظَّمة. تتم مطابقة العبارات المنطوقة مع الأغراض من خلال ميزة "فهم اللغة الطبيعية" من Google (NLU). يمكن أن تؤدي مطابقات الأهداف إلى بدء أحداث في تصميم محادثتك لإحراز تقدّم في محادثة المستخدم. يتم تحديد اسم الغرض في اسم الملف.
تمثيل JSON | |
---|---|
{
"parameters": [
{
object ( |
الحقول | |
---|---|
parameters[] |
تمثّل هذه السمة قائمة المَعلمات ضِمن عبارات التدريب. يجب تحديد كل المعلَمات هنا لكي يتم استخدامها في العبارة التدريبية. |
trainingPhrases[] |
تسمح عبارات التدريب لوحدة NLU في Google بمطابقة الأهداف تلقائيًا مع البيانات التي يدخلها المستخدمون. وكلما قدّمت المزيد من العبارات الفريدة، زادت فرصة مطابقة هذا الطلب. فيما يلي تنسيق جزء عبارة التدريب الذي تمت إضافة تعليقات توضيحية إليه. يُرجى العِلم أنّ الحقل |
IntentParameter
تعريف معلمة يمكن استخدامها داخل عبارات التدريب.
تمثيل JSON | |
---|---|
{ "name": string, // Union field |
الحقول | ||
---|---|---|
name |
مطلوبة. الاسم الفريد لمَعلمة intent. يمكن استخدامها في الشروط والاستجابات للإشارة إلى مَعلمات الأهداف المرجعية التي تم استخراجها من خلال NLU باستخدام $intent.params.[name].resolved |
|
حقل الاتحاد parameter_type نوع مَعلمة الغرض. يمكن أن تكون السمة "parameter_type " واحدة فقط مما يلي: |
||
type |
اختياريّ. لتحديد نوع بيانات هذه المَعلمة. ويجب عدم ضبط هذه الإعدادات للأغراض المضمّنة. |
|
entitySetReferences |
اختياريّ. يشير إلى مجموعات الكيانات المسموح بها لمَعلمة الغرض هذه. صالح فقط لمَعلمات الغرض المضمَّن. تشير هذه المراجع إلى مجموعات الكيانات في الدليل "custom/entitySets". |
ClassReference
يشير ذلك المصطلح إلى مرجع لفئة مستخدَمة لتعريف نوع الحقل أو القيمة المعروضة. تعد التعدادات أيضًا نوع من الفئات التي يمكن الإشارة إليها باستخدام ClassReference.
تمثيل JSON | |
---|---|
{ "name": string, "list": boolean } |
الحقول | |
---|---|
name |
مطلوبة. اسم النوع المضمَّن أو نوع مخصّص للمَعلمة أمثلة: |
list |
اختياريّ. يشير إلى ما إذا كان نوع البيانات يمثل قائمة من القيم. |
EntitySetReferences
مراجع مجموعة الكيانات لمعلَمة هدف.
تمثيل JSON | |
---|---|
{
"entitySetReferences": [
{
object ( |
الحقول | |
---|---|
entitySetReferences[] |
مطلوبة. مراجع مجموعة الكيانات لمعلَمة هدف. |
EntitySetReference
مرجع لمجموعة الكيانات المسموح بها لمَعلمة الغرض هذه.
تمثيل JSON | |
---|---|
{ "entitySet": string } |
الحقول | |
---|---|
entitySet |
مطلوبة. تحدِّد مجموعة الكيانات المحدّدة التي سيتم النظر فيها مع مَعلمة معيّنة. يجب أن يتوفّر تعريف مجموعة الكيانات المقابلة في الدليل المخصّص/entitySets/. |
Type
تعريف لنوع مخصص، في مقابل الأنواع المضمّنة. يمكن تعيين الأنواع إلى الخانات في مشهد أو معلَمات عبارات تدريب هدف. عمليًا، يمكن اعتبار الأنواع على أنها تعدادات. ملاحظة: يتم تحديد اسم النوع في اسم الملف.
تمثيل JSON | |
---|---|
{ "exclusions": [ string ], // Union field |
الحقول | ||
---|---|---|
exclusions[] |
مجموعة من الكلمات/العبارات الاستثنائية التي لا ينبغي مطابقتها حسب النوع. ملاحظة: إذا تمت مطابقة الكلمة أو العبارة حسب النوع ولكن تم إدراجها كاستبعاد، لن يتم عرضها في نتيجة استخراج المَعلمة. هذا الحقل قابل للترجمة. |
|
حقل الاتحاد sub_type اختيار النوع الفرعي حسب نوع المطابقة المطلوب إجراؤها يمكن أن تكون السمة "sub_type " واحدة فقط مما يلي: |
||
synonym |
نوع المرادفات، وهو في الأساس تعداد. |
|
regularExpression |
نوع التعبير العادي، يسمح بمطابقة التعبير العادي. |
|
freeText |
النوع FreeText. |
SynonymType
اكتب الذي يطابق النص حسب مجموعة من المرادفات.
تمثيل JSON | |
---|---|
{ "matchType": enum ( |
الحقول | |
---|---|
matchType |
اختياريّ. نوع المطابقة للمرادف. |
acceptUnknownValues |
اختياريّ. عند ضبط هذه السياسة على "صحيح"، ستتم مطابقة الكلمات أو العبارات غير المعروفة استنادًا إلى البيانات المحيطة بالإدخالات والتدريب على النية، مثل السلع التي يمكن إضافتها إلى قائمة التسوّق. |
entities |
مطلوبة. خريطة مُسمّاة للكيانات المرادفة عنصر يحتوي على قائمة من أزواج |
MatchType
نوع المطابقة الذي سيستخدمه هذا النوع من الإدخالات. سيضمن ذلك أن تستخدم جميع الأنواع طريقة المطابقة نفسها ويسمح بتنويع المطابقة لمطابقة المرادفات (أي المطابقة الغامضة مقابل المطابقة التامة). إذا كانت القيمة UNSPECIFIED
، سيتم ضبطها تلقائيًا على EXACT_MATCH
.
عمليات التعداد | |
---|---|
UNSPECIFIED |
يكون الإعداد التلقائي هو EXACT_MATCH . |
EXACT_MATCH |
تبحث عن مطابقة تامة للمرادف أو الاسم. |
FUZZY_MATCH |
أكثر من EXACT_MATCH . يبحث عن المطابقات المتشابهة فضلاً عن المطابقات التامة. |
الكيان
تمثل حقل كيان مرادفًا يحتوي على تفاصيل إدخال واحد داخل النوع.
تمثيل JSON | |
---|---|
{
"display": {
object ( |
الحقول | |
---|---|
display |
اختياريّ. تفاصيل عرض الكيان. |
synonyms[] |
اختياريّ. تمثّل هذه السمة قائمة مرادفات الكيان. هذا الحقل قابل للترجمة. |
EntityDisplay
العناصر التي سيتم عرضها على لوحة الرسم بعد استخراج كيان لنوع معيّن من طلب بحث تنطبق فقط على التطبيقات التي تتيح استخدام لوحات الرسم. هذه الرسالة قابلة للترجمة.
تمثيل JSON | |
---|---|
{ "iconTitle": string, "iconUrl": string } |
الحقول | |
---|---|
iconTitle |
اختياريّ. عنوان الرمز. |
iconUrl |
مطلوبة. تمثّل هذه السمة عنوان URL للرمز. |
RegularExpressionType
اكتب يطابق النص حسب التعبيرات العادية. هذه الرسالة قابلة للترجمة.
تمثيل JSON | |
---|---|
{
"entities": {
string: {
object ( |
الحقول | |
---|---|
entities |
مطلوبة. خريطة مُسمّاة للكيانات التي يحتوي كلّ منها على سلاسل تعبير عادي عنصر يحتوي على قائمة من أزواج |
الكيان
تمثل هذه السمة كائن كيان يحتوي على التعبير العادي الذي يُستخدم للمقارنة.
تمثيل JSON | |
---|---|
{
"display": {
object ( |
الحقول | |
---|---|
display |
اختياريّ. العناصر التي سيتم عرضها على لوحة الرسم بعد استخراج كيان من طلب بحث. تنطبق فقط على التطبيقات التي تتيح استخدام لوحات الرسم. |
regularExpressions[] |
مطلوبة. يستخدم بنية التعبير العادي RE2 (يمكنك الاطّلاع على https://github.com/google/re2/wiki/Syntax للحصول على مزيد من التفاصيل) |
FreeTextType
اكتب يتطابق مع أي نص إذا كان سياق الكلمات المحيطة قريبًا من أمثلة التدريب المقدَّمة.
تمثيل JSON | |
---|---|
{
"display": {
object ( |
الحقول | |
---|---|
display |
اختياريّ. العناصر التي سيتم عرضها على لوحة الرسم بعد استخراج كيان من طلب بحث. تنطبق فقط على التطبيقات التي تتيح استخدام لوحات الرسم. |
EntitySet
تصف مجموعات الكيانات مجموعة الكيانات المحدَّدة مسبقًا التي يمكن أن تأتي منها قيم مَعلمات الأغراض المضمَّنة. يمكن الإشارة إلى مجموعات الكيانات من entitySet في مَعلمات الغرض المدمجة.
تمثيل JSON | |
---|---|
{
"entities": [
{
object ( |
الحقول | |
---|---|
entities[] |
مطلوبة. قائمة الكيانات المتوافقة مع مجموعة الكيانات هذه. |
الكيان
يشير ذلك المصطلح إلى كيان يمكن أن تأتي منه قيمة مَعلمة الغرض المضمّنة.
تمثيل JSON | |
---|---|
{ "id": string } |
الحقول | |
---|---|
id |
مطلوبة. رقم تعريف الكيان. للاطّلاع على قائمة بالمَعلمات المضمَّنة والكيانات المتوافقة معها، يُرجى الانتقال إلى https://developers.google.com/assistant/conversational/build/built-in-intents |
GlobalIntentEvent
تُحدِّد أداة معالجة الأهداف العامة. يتم تحديد أحداث الأهداف العالمية في نطاق مشروع "المهام" بالكامل ويمكن أن يتم إلغاؤها من خلال معالِجات الأهداف في مشهد. يجب أن تكون أسماء الأغراض فريدة داخل مشروع Actions.
يمكن مطابقة الأهداف العالمية في أي وقت خلال الجلسة، ما يسمح للمستخدمين بالوصول إلى الإجراءات الشائعة مثل "الحصول على مساعدة" أو "الرجوع إلى الصفحة الرئيسية". ويمكن استخدامها أيضًا لربط المستخدمين بصفحات معيّنة في مسارات معيّنة عند استدعاء إجراء معيّن.
ملاحظة: يتم تحديد اسم الغرض في اسم الملف.
تمثيل JSON | |
---|---|
{
"transitionToScene": string,
"handler": {
object ( |
الحقول | |
---|---|
transitionToScene |
اختياريّ. مشهد الوجهة الذي يجب أن تنتقل إليه المحادثة. لقد تدمرت حالة المشهد الحالي أثناء الانتقال. |
handler |
اختياريّ. معالج الحدث الذي يتم تشغيله عند مطابقة الغرض. يجب التنفيذ قبل الانتقال إلى مشهد الوجهة. يفيد إنشاء الطلبات استجابةً للأحداث. |
EventHandler
تحدد معالجًا ليتم تنفيذه بعد الحدث. من أمثلة الأحداث الأحداث المستندة إلى النية والحالة في مشهد.
تمثيل JSON | |
---|---|
{ "webhookHandler": string, // Union field |
الحقول | ||
---|---|---|
webhookHandler |
اسم معالِج الردّ التلقائي على الويب المطلوب طلبه |
|
حقل الاتحاد prompt يمكن أن تكون الطلبات مضمّنة أو تتم الإشارة إليها حسب الاسم. يمكن أن تكون السمة "prompt " واحدة فقط مما يلي: |
||
staticPrompt |
موجّه ثابت مضمّن يمكن أن تحتوي على مراجع لموارد السلسلة في الحِزم. |
|
staticPromptName |
اسم الطلب الثابت المطلوب استدعاءه |
StaticPrompt
يمثّل هذا النوع قائمة من الطلبات المرشحة التي سيتم اختيار أحدها كطلب يظهر في الردّ على المستخدم. هذه الرسالة قابلة للترجمة.
تمثيل JSON | |
---|---|
{
"candidates": [
{
object ( |
الحقول | |
---|---|
candidates[] |
قائمة بالطلبات المرشحة التي سيتم إرسالها إلى العميل. يتضمّن كل طلب أداة اختيار لتحديد وقت استخدامها. سيتم إرسال أداة الاختيار الأولى التي تتطابق مع أحد الطلبات، وسيتم تجاهل بقية العناصر. |
StaticPromptCandidate
يمثِّل العنصر المحفّز لعرض طلب ثابت.
تمثيل JSON | |
---|---|
{ "selector": { object ( |
الحقول | |
---|---|
selector |
اختياريّ. تمثّل هذه السمة معايير ما إذا كان هذا الطلب يتطابق مع أحد الطلبات. إذا كانت أداة الاختيار فارغة، سيتمّ عرض هذا الطلب دائمًا. |
promptResponse |
الردّ المرتبط بأداة الاختيار |
أداة الاختيار
تحدِّد هذه السياسة معايير ما إذا كان الطلب يتطابق مع أحد الطلبات.
تمثيل JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
الحقول | |
---|---|
surfaceCapabilities |
مجموعة إمكانات السطح المطلوبة. |
SurfaceCapabilities
تمثل مساحة العرض التي يستخدمها المستخدم لتقديم طلب إلى الإجراء.
تمثيل JSON | |
---|---|
{
"capabilities": [
enum ( |
الحقول | |
---|---|
capabilities[] |
مطلوبة. تمثّل هذه السمة إمكانات السطح الذي يمكنه تقديم طلب إلى الإجراء. |
الإمكانية
الإمكانات التي يتيحها سطح الجهاز في وقت الطلب.
عمليات التعداد | |
---|---|
UNSPECIFIED |
إمكانية عرض غير محدَّد على السطح |
SPEECH |
يمكن للجهاز التحدث إلى المستخدم عن طريق تحويل النص إلى كلام أو SSML. |
RICH_RESPONSE |
يمكن للجهاز عرض ردود منسّقة، مثل البطاقات والقوائم والجداول. |
LONG_FORM_AUDIO |
يمكن للجهاز تشغيل الوسائط الصوتية الطويلة، مثل الموسيقى وملفات البودكاست. |
INTERACTIVE_CANVAS |
يمكن أن يعرض الجهاز استجابة تفاعلية من لوحة الرسم. |
WEB_LINK |
يمكن للجهاز استخدام روابط ويب في الردود المنسّقة لفتح متصفّح ويب. |
HOME_STORAGE |
يمكن للجهاز أن يتيح حفظ مساحة التخزين المنزلية وجلبها. |
StaticPromptResponse
تمثّل هذه السمة الردود المنظَّمة المطلوب إرسالها إلى المستخدم، مثل النص والكلام والبطاقات وبيانات لوحة الرسم وشرائح الاقتراحات وما إلى ذلك.
تمثيل JSON | |
---|---|
{ "firstSimple": { object ( |
الحقول | |
---|---|
firstSimple |
اختياريّ. الاستجابة الأولى بالصوت والنص فقط. |
content |
اختياريّ. محتوى مثل بطاقة أو قائمة أو وسائط يتم عرضها للمستخدم. |
lastSimple |
اختياريّ. الرد الأخير بالصوت والنص فقط. |
suggestions[] |
اختياريّ. الاقتراحات التي يتم عرضها للمستخدم والتي ستظهر دائمًا في نهاية الرد. إذا كان الحقل |
link |
اختياريّ. شريحة اقتراحات إضافية يمكنها توفير رابط إلى التطبيق أو الموقع الإلكتروني المرتبطَين سيتم عرض الشريحة بعنوان "فتح |
override |
اختياريّ. وضع لكيفية دمج هذه الرسائل مع الرسائل المحددة مسبقًا سيمحو " |
canvas |
ردّ يمكن استخدامه لتجربة لوحة تفاعلية. |
StaticSimplePrompt
يمثِّل طلبًا بسيطًا لإرساله إلى أحد المستخدمين.
تمثيل JSON | |
---|---|
{
"variants": [
{
object ( |
الحقول | |
---|---|
variants[] |
قائمة بالصيغ المحتملة |
الصيغة
تمثيل صيغة تشكل جزءًا من الطلب البسيط
تمثيل JSON | |
---|---|
{ "speech": string, "text": string } |
الحقول | |
---|---|
speech |
اختياريّ. تمثِّل الكلام الذي سيتم قوله إلى المستخدم. يمكن أن يكون تنسيق SSML أو نص إلى كلام. سيتم إلحاق الكلام تلقائيًا بالكلام الخاص بـ Simple Speak. إذا كان الحقل |
text |
اختياريّ. نص لعرضه في فقاعة المحادثة. في حال عدم توفيره، سيتم عرض حقل الكلام أعلاه. تقتصر على 640 حرفًا. سيتم إلحاق النص تلقائيًا بنص رسالة "الطلب البسيط" السابقة. إذا كان الحقل |
StaticContentPrompt
تمثّل هذه السمة عنصرًا نائبًا لجزء المحتوى من StaticPrompt.
تمثيل JSON | |
---|---|
{ // Union field |
الحقول | ||
---|---|---|
حقل الاتحاد content يمكن توفير نوع واحد فقط من المحتوى في الطلب. يمكن أن تكون السمة "content " واحدة فقط مما يلي: |
||
card |
بطاقة أساسية. |
|
image |
صورة. |
|
table |
بطاقة جدول. |
|
media |
استجابة تشير إلى مجموعة من الوسائط التي سيتم تشغيلها. |
|
list |
بطاقة لمشاركة عرض قائمة خيارات للاختيار من بينها. |
|
collection |
بطاقة تعرِض قائمة بالخيارات التي يمكنك الاختيار من بينها. |
|
collectionBrowse |
بطاقة تعرض مجموعة من صفحات الويب لتفتحها |
StaticCardPrompt
بطاقة أساسية لعرض بعض المعلومات، مثل صورة و/أو نص.
تمثيل JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
الحقول | |
---|---|
title |
اختياريّ. العنوان العام للبطاقة. |
subtitle |
اختياريّ. العنوان الفرعي للبطاقة. |
text |
مطلوبة. النص الأساسي للبطاقة، وهو مطلوب ما لم تكن الصورة متوفّرة. تدعم مجموعة محدودة من بنية markdown للتنسيق. |
image |
اختياريّ. صورة الجزء الرئيسي للبطاقة. ويتم تثبيت الارتفاع على 192 بكسل مستقل الكثافة. |
imageFill |
اختياريّ. كيفية ملء خلفية الصورة |
button |
اختياريّ. زر قابل للنقر يظهر في البطاقة. |
StaticImagePrompt
صورة معروضة في البطاقة.
تمثيل JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
الحقول | |
---|---|
url |
مطلوبة. عنوان URL المصدر للصورة ويمكن أن تكون الصور بتنسيق JPG وPNG وGIF (الرسوم المتحركة وغير المتحركة). مثلاً، |
alt |
مطلوبة. وصف نصي للصورة الذي سيتم استخدامه لتسهيل الاستخدام، مثل برامج قراءة الشاشة. |
height |
اختياريّ. ارتفاع الصورة بالبكسل. |
width |
اختياريّ. عرض الصورة بالبكسل. |
ImageFill
خيارات عرض الصورة الممكنة للتأثير في عرض الصورة. يجب استخدام هذا الخيار عندما لا تتطابق نسبة العرض إلى الارتفاع للصورة مع نسبة العرض إلى الارتفاع لحاوية الصورة.
عمليات التعداد | |
---|---|
UNSPECIFIED |
لم يتم تحديد ImageFill. |
GRAY |
املأ الفجوات بين الصورة وحاوية الصورة بأشرطة رمادية. |
WHITE |
املأ الفجوات بين الصورة وحاوية الصورة باستخدام أشرطة بيضاء. |
CROPPED |
يتم تغيير حجم الصورة بحيث يتطابق عرض الصورة وارتفاعها مع أبعاد الحاوية أو يتجاوزها. قد يؤدي ذلك إلى اقتصاص الجزء العلوي والسفلي من الصورة إذا كان ارتفاع الصورة التي تم تغيير حجمها أكبر من ارتفاع الحاوية، أو اقتصاص الجزء الأيسر والأيمن من الصورة إذا كان عرض الصورة التي تم تغيير حجمها أكبر من عرض الحاوية. يشبه هذا "وضع التكبير/التصغير" على تلفزيون بشاشة عريضة عند تشغيل فيديو بنسبة عرض إلى ارتفاع 4:3. |
StaticLinkPrompt
تُحدِّد رابطًا سيتم عرضه كشريحة اقتراح ويمكن للمستخدم فتحه.
تمثيل JSON | |
---|---|
{
"name": string,
"open": {
object ( |
الحقول | |
---|---|
name |
اسم الرابط |
open |
تُحدِّد السلوك عندما يفتح المستخدِم الرابط. |
OpenUrl
تُحدِّد السلوك عندما يفتح المستخدِم الرابط.
تمثيل JSON | |
---|---|
{
"url": string,
"hint": enum ( |
الحقول | |
---|---|
url |
حقل عنوان URL الذي يمكن أن يكون أيًا مما يلي: - عناوين URL التي تستخدم http/https لفتح تطبيق مرتبط بتطبيق أو صفحة ويب |
hint |
تشير هذه السمة إلى نوع عنوان URL. |
UrlHint
أنواع مختلفة من تلميحات عناوين URL.
عمليات التعداد | |
---|---|
HINT_UNSPECIFIED |
غير محدّدة |
AMP |
عنوان URL يشير مباشرةً إلى محتوى AMP أو إلى عنوان URL أساسي يشير إلى محتوى AMP عبر <link rel="amphtml"> . |
StaticTablePrompt
بطاقة جدول لعرض جدول نصوص.
تمثيل JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
الحقول | |
---|---|
title |
اختياريّ. العنوان العام للجدول. يجب ضبطها في حال ضبط العنوان الفرعي. |
subtitle |
اختياريّ. العنوان الفرعي للجدول. |
image |
اختياريّ. صورة مرتبطة بالجدول |
columns[] |
اختياريّ. العناوين ومحاذاة الأعمدة. |
rows[] |
اختياريّ. بيانات الصف في الجدول. نضمن ظهور أول 3 صفوف، ولكن قد يتم قص بعضها الآخر على مساحات عرض معيّنة. يُرجى الاختبار باستخدام المحاكي لمعرفة الصفوف التي سيتم عرضها لسطح معيّن. على مساحات العرض التي تتيح إمكانية استخدام |
button |
اختياريّ. زرّ |
TableColumn
لوصف عمود في الجدول.
تمثيل JSON | |
---|---|
{
"header": string,
"align": enum ( |
الحقول | |
---|---|
header |
نص العنوان للعمود. |
align |
محاذاة أفقية للمحتوى w.r.t العمود وإذا لم يتم تحديده، ستتم محاذاة المحتوى مع الحافة البادئة. |
HorizontalAlignment
محاذاة المحتوى داخل الخلية.
عمليات التعداد | |
---|---|
UNSPECIFIED |
المحاذاة الأفقية غير محددة. |
LEADING |
الحافة البادئة للخلية. وهذا هو الخيار التلقائي. |
CENTER |
تتم محاذاة المحتوى مع وسط العمود. |
TRAILING |
تتم محاذاة المحتوى مع حافة العمود. |
TableRow
تصف صفًا في الجدول.
تمثيل JSON | |
---|---|
{
"cells": [
{
object ( |
الحقول | |
---|---|
cells[] |
الخلايا في هذا الصف. نضمن ظهور أول 3 خلايا، ولكن قد يتم قص الخلايا الأخرى على أسطح معينة. يُرجى الاختبار باستخدام المحاكي لمعرفة الخلايا التي سيتم عرضها لسطح معين. |
divider |
يشير إلى ما إذا كان يجب وجود مُقسّم بعد كل صف. |
TableCell
لوصف خلية في صف واحد.
تمثيل JSON | |
---|---|
{ "text": string } |
الحقول | |
---|---|
text |
المحتوى النصي للخلية. |
StaticMediaPrompt
يحتوي على معلومات عن الوسائط، مثل الاسم والوصف وعنوان URL وما إلى ذلك. المعرّف التالي: 11
تمثيل JSON | |
---|---|
{ "mediaType": enum ( |
الحقول | |
---|---|
mediaType |
نوع الوسائط لهذا الرد |
startOffset |
بدء إزاحة كائن الوسائط الأول مدة بالثواني مؤلفة من تسعة أرقام كسور كحد أقصى، وتم إنهاؤها بـ " |
optionalMediaControls[] |
أنواع عناصر تحكّم اختيارية في الوسائط يمكن أن توفّرها جلسة الاستجابة للوسائط هذه. وفي حال ضبط هذه السياسة، سيتم إرسال الطلب إلى 3p عند وقوع حدث معيّن على الوسائط. إذا لم يتم ضبط السياسة، يجب أن تعالج جهة 3p نوعَي التحكّم التلقائيَّين، وهما "تم الانتهاء" و"تعذّر التحقق". |
mediaObjects[] |
قائمة بكائنات الوسائط |
repeatMode |
وضع التكرار لقائمة كائنات الوسائط. |
MediaType
نوع الوسائط لهذا الرد
عمليات التعداد | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
قيمة غير محدَّدة |
AUDIO |
ملف صوتي |
MEDIA_STATUS_ACK |
ردّ للإقرار بتقرير حالة الوسائط |
OptionalMediaControls
أنواع عناصر التحكّم في الوسائط التي يمكن إتاحة استجابة الوسائط بشكل اختياري
عمليات التعداد | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
قيمة غير محدّدة |
PAUSED |
حدث متوقف مؤقتًا. يتم تشغيله عندما يوقِف المستخدم الوسائط مؤقتًا. |
STOPPED |
تم إيقاف الحدث. يتم تشغيله عندما يخرج المستخدم من جلسة 3p أثناء تشغيل الوسائط. |
MediaObject
يمثل عنصر وسائط واحدًا.
تمثيل JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
الحقول | |
---|---|
name |
اسم عنصر الوسائط هذا |
description |
وصف عنصر الوسائط هذا. |
url |
تمثّل هذه السمة عنوان URL الذي يشير إلى محتوى الوسائط. |
image |
الصورة التي سيتم عرضها مع بطاقة الوسائط. |
MediaImage
الصورة التي سيتم عرضها داخل MediaPrompt
تمثيل JSON | |
---|---|
{ // Union field |
الحقول | ||
---|---|---|
حقل الاتحاد image يُسمح بنوع واحد فقط من MediaImage. يمكن أن تكون السمة "image " واحدة فقط مما يلي: |
||
large |
صورة كبيرة، مثل غلاف الألبوم وما إلى ذلك |
|
icon |
رمز صورة صغير معروض على يسار العنوان يتم تغيير حجمه إلى 36x36 بكسل مستقل الكثافة. |
RepeatMode
أنواع وضع التكرار لقائمة من عناصر الوسائط.
عمليات التعداد | |
---|---|
REPEAT_MODE_UNSPECIFIED |
يعادل إيقاف التشغيل. |
OFF |
إنهاء جلسة تشغيل الوسائط في نهاية عنصر الوسائط الأخير. |
ALL |
التكرار الحلقي إلى بداية كائن الوسائط الأول عند الوصول إلى نهاية آخر كائن وسائط. |
StaticListPrompt
بطاقة لمشاركة عرض قائمة خيارات للاختيار من بينها.
تمثيل JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
الحقول | |
---|---|
title |
اختياريّ. عنوان القائمة |
subtitle |
اختياريّ. العنوان الفرعي للقائمة. |
items[] |
مطلوبة. عناصر القائمة |
ListItem
عنصر في القائمة
تمثيل JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
الحقول | |
---|---|
key |
مطلوبة. مفتاح NLU الذي يتطابق مع اسم مفتاح الإدخال في النوع المرتبط به. عند النقر على العنصر، ستتم إعادة نشر هذا المفتاح كمَعلَمة خيار تحديد. |
title |
مطلوبة. عنوان السلعة. عند النقر على هذا النص، سيتم مشاركته مرة أخرى في المحادثة كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا بين مجموعة العناصر. |
description |
اختياريّ. النص الأساسي للعنصر. |
image |
اختياريّ. صورة العنصر |
StaticCollectionPrompt
بطاقة لمشاركة عرض مجموعة من الخيارات التي يمكنك الاختيار من بينها.
تمثيل JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
الحقول | |
---|---|
title |
اختياريّ. عنوان المجموعة |
subtitle |
اختياريّ. العنوان الفرعي للمجموعة. |
items[] |
مطلوبة. عناصر المجموعة |
imageFill |
اختياريّ. نوع خيار عرض الصورة |
CollectionItem
عنصر في المجموعة
تمثيل JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
الحقول | |
---|---|
key |
مطلوبة. مفتاح NLU الذي يطابق اسم مفتاح الإدخال في النوع المرتبط به. عند النقر على العنصر، ستتم إعادة نشر هذا المفتاح كمَعلَمة خيار تحديد. |
title |
مطلوبة. عنوان السلعة. عند النقر على هذا النص، سيتم مشاركته مرة أخرى في المحادثة كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا بين مجموعة العناصر. |
description |
اختياريّ. النص الأساسي للعنصر. |
image |
اختياريّ. صورة العنصر |
StaticCollectionBrowsePrompt
يقدم مجموعة من مستندات الويب كمجموعة من عناصر المربعات الكبيرة. يمكن اختيار عناصر لتشغيل مستند الويب المرتبط بها في عارض الويب.
تمثيل JSON | |
---|---|
{ "items": [ { object ( |
الحقول | |
---|---|
items[] |
العناصر في مجموعة التصفُّح يجب أن يتراوح حجم القائمة بين النطاق [2 و10]. |
imageFill |
خيار عرض الصور للصور في المجموعة. |
CollectionBrowseItem
العنصر في المجموعة
تمثيل JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
الحقول | |
---|---|
title |
مطلوبة. عنوان عنصر المجموعة. |
description |
وصف عنصر المجموعة. |
footer |
نص تذييل عنصر المجموعة، معروض أسفل الوصف. سطر واحد من النص، تم اقتطاعه بعلامة حذف. |
image |
صورة لعنصر المجموعة |
openUriAction |
مطلوبة. معرّف موارد منتظم (URI) لفتحه في حال اختيار العنصر. |
الاقتراح
تمثّل هذه السمة شريحة اقتراح، وهي عنصر في واجهة المستخدم يتم عرضه للمستخدم لتسهيل تجربته.
تمثيل JSON | |
---|---|
{ "title": string } |
الحقول | |
---|---|
title |
مطلوبة. النص المعروض في شريحة الاقتراح. عند النقر على هذا النص، سيتم مشاركته مرة أخرى في المحادثة كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا بين مجموعة شرائح الاقتراحات. 25 حرفًا بحد أقصى |
StaticCanvasPrompt
يُمثِّل استجابة "لوحة الرسم التفاعلية" التي سيتم إرسالها إلى المستخدم. يمكن استخدام هذا الإجراء إلى جانب الحقل firstSimple
في الطلب الذي يتضمّنه للتحدّث إلى المستخدم بالإضافة إلى عرض ردّ تفاعلي على لوحة الرسم.
تمثيل JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "sendStateDataToCanvasApp": boolean, "enableFullScreen": boolean } |
الحقول | |
---|---|
url |
مطلوبة. عنوان URL لعرض الويب المطلوب تحميله. |
data[] |
اختياريّ. بيانات JSON التي يتم تمريرها إلى صفحة الويب الخاصة بالتجربة الشاملة على أنّها فعالية إذا كان الحقل |
suppressMic |
اختياريّ. وتعني القيمة الحقيقية أنّه لن يتم فتح الميكروفون لالتقاط الإدخال بعد تقديم هذا الاستجابة الشاملة للمستخدم. |
sendStateDataToCanvasApp |
اختياريّ. إذا |
enableFullScreen |
اختياريّ. إذا كان |
أجواء الإضاءة
المشهد هو الوحدة الأساسية لتدفق التحكم عند تصميم محادثة. يمكن ربطها مع مشاهد أخرى، وإنشاء مطالبات للمستخدم النهائي، وتحديد الخانات. يتم تحديد اسم المشهد في اسم الملف.
تمثيل JSON | |
---|---|
{ "onEnter": { object ( |
الحقول | |
---|---|
onEnter |
المعالِج الذي يجب استدعاءه عند الانتقال إلى هذا المشهد. |
intentEvents[] |
قائمة الأحداث التي تبدأ استنادًا إلى الأغراض. ويمكن بدء هذه الأحداث في أي وقت بعد استدعاء معالج on_load. ملاحظة مهمّة: تحدّد هذه الأحداث مجموعة الأغراض التي تم تحديد نطاقها لهذا المشهد، وستحظى بالأولوية على أيّ أحداث محدّدة عالميًا تتضمّن الأغراض نفسها أو عباراتها التي تؤدّي إلى تشغيلها. يجب أن تكون أسماء الأغراض فريدة داخل المشهد. |
conditionalEvents[] |
قائمة الأحداث المطلوب بدؤها استنادًا إلى العبارات الشرطية. يتم تقييمها بعد ملء النموذج أو مباشرةً بعد on_load إذا لم يتوفّر نموذج لهذا المشهد (يتم إجراء التقييم مرة واحدة فقط). ولن يبدأ سوى أول حدث مطابق. |
slots[] |
قائمة مرتبة من الخانات. تحدِّد كل خانة نوع البيانات التي سيتم حلّها وإعدادها لتخصيص تجربة استخدام درجة الدقة هذه (مثل الطلبات). |
onSlotUpdated |
يتم استدعاء المعالج عند حدوث تغيير في حالة إحدى الخانات بسبب التحديثات داخل معالج آخر. يؤدي ذلك إلى إلغاء الخانات أو إلغاء صلاحية المشهد أو إجراء تغييرات أخرى على حالة المشهد. |
IntentEvent
يعمل على تسجيل الأحداث التي تبدأ كنتيجة لمطابقة النية.
تمثيل JSON | |
---|---|
{
"intent": string,
"transitionToScene": string,
"handler": {
object ( |
الحقول | |
---|---|
intent |
مطلوبة. الغرض من بدء الحدث |
transitionToScene |
اختياريّ. مشهد الوجهة الذي يجب أن تنتقل إليه المحادثة. لقد تدمرت حالة المشهد الحالي أثناء الانتقال. |
handler |
اختياريّ. معالج الحدث الذي يتم تشغيله عند مطابقة الغرض. يجب التنفيذ قبل الانتقال إلى مشهد الوجهة. من المفيد إنشاء مطالبات استجابةً للأحداث. |
ConditionalEvent
يسجِّل الأحداث التي يتم تشغيلها كنتيجة لشرط صحيح.
تمثيل JSON | |
---|---|
{
"condition": string,
"transitionToScene": string,
"handler": {
object ( |
الحقول | |
---|---|
condition |
مطلوبة. شرط الفلتر لبدء هذا الحدث إذا تم تقييم الشرط على "صحيح"، سيتم تشغيل |
transitionToScene |
اختياريّ. مشهد الوجهة الذي يجب أن تنتقل إليه المحادثة عندما يتم تقييم الشرط المرتبط على "صحيح". لقد تدمرت حالة المشهد الحالي أثناء الانتقال. |
handler |
اختياريّ. معالج الأحداث الذي يتم تشغيله عند تقييم الشرط المرتبط على |
الحيز
إعدادات لأحد الخانات. الشرائح عبارة عن وحدات فردية من البيانات يمكن ملؤها باللغة الطبيعية (أي معلّمات الأهداف) ومعلّمات الجلسات ومصادر أخرى.
تمثيل JSON | |
---|---|
{ "name": string, "type": { object ( |
الحقول | |
---|---|
name |
مطلوبة. اسم الخانة. |
type |
مطلوبة. لتحديد نوع بيانات هذه الخانة. |
required |
اختياريّ. تشير هذه السمة إلى ما إذا كان يجب ملء المساحة المتوفّرة قبل التقدّم. سيؤدي إدخال الخانات المطلوبة التي لم يتم ملؤها إلى إرسال إشعار قابل للتخصيص إلى المستخدم. |
promptSettings |
اختياريّ. لتسجيل المطالبات للمراحل المختلفة من ملء الخانات. |
commitBehavior |
اختياريّ. السلوك المرتبط بالخانة |
config |
اختياريّ. الإعدادات الإضافية المرتبطة بالخانة التي يتم استخدامها لملء الخانة. يكون تنسيق الإعداد خاصًا بنوع الخانة. يمكن إضافة مراجع الموارد إلى مَعلمة المستخدم أو الجلسة إلى هذه الإعدادات. هذه الإعدادات مطلوبة لملء الخانات ذات الصلة بالمعاملات وتفاعل المستخدمين. مثال: بالنسبة إلى خانة من النوع actions.type.CompletePurchaseValue، تقترح الإعدادات التالية طلب شراء سلعة رقمية مع إشارة إلى مَعلمة جلسة من تحديد العميل { "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" } } |
defaultValue |
اختياريّ. إعدادات لتعبئة قيمة تلقائية لهذه الخانة |
PromptSettings
مكان واحد يتم فيه تحديد طلبات الخانة
تمثيل JSON | |
---|---|
{ "initialPrompt": { object ( |
الحقول | |
---|---|
initialPrompt |
مطالبة بقيمة الخانة نفسها مثال: "ما المقاس الذي تريده؟" |
noMatchPrompt1 |
طلب للعرض عندما لا يتطابق إدخال المستخدم مع نوع القيمة المتوقّعة للخانة للمرة الأولى مثال: "عذرًا، لم أفهم ذلك". |
noMatchPrompt2 |
طلب للعرض عندما لا يتطابق إدخال المستخدم مع نوع القيمة المتوقّعة للخانة للمرة الثانية. مثال: "عذرًا، لم أفهم ذلك". |
noMatchFinalPrompt |
طلب للعرض عندما لا يتطابق إدخال المستخدم مع نوع القيمة المتوقّعة للخانة في المرة الأخيرة مثال: "عذرًا، لم أفهم ذلك". |
noInputPrompt1 |
مطالبة بإعطائه عندما لا يقدِّم المستخدم إدخالاً لأول مرة. مثال: "عذرًا، لم أفهم ذلك". |
noInputPrompt2 |
مطالبة بإعطائه عندما لا يقدِّم المستخدم إدخالاً للمرة الثانية. مثال: "عذرًا، لم أفهم ذلك". |
noInputFinalPrompt |
مطالبة بإعطائه عندما لا يقدِّم المستخدم إدخالاً لآخر مرة. مثال: "عذرًا، لم أفهم ذلك". |
CommitBehavior
رسالة تصف سلوك الإتمام المرتبط بالخانة بعد ملئها بنجاح.
تمثيل JSON | |
---|---|
{ "writeSessionParam": string } |
الحقول | |
---|---|
writeSessionParam |
معلمة الجلسة لكتابة قيمة الخانة بعد ملئها. يُرجى العلم أنّ المسارات المتداخلة غير متاحة حاليًا. يتم استخدام "$$" لكتابة قيمة الخانة إلى معلَمة جلسة لها اسم الخانة نفسه. على سبيل المثال: يتطابق writeSessionParam = "fruit" مع "$session.params.fruit". writeSessionParam = "ticket" يتجاوب مع "$session.params.ticket". |
DefaultValue
إعدادات لتعبئة قيمة تلقائية لهذه الخانة
تمثيل JSON | |
---|---|
{ "sessionParam": string, "constant": value } |
الحقول | |
---|---|
sessionParam |
اختياريّ. معلمة الجلسة المراد استخدامها لإعداد قيمة الخانة، إذا كانت تتضمن قيمة غير فارغة. يجب أن يتطابق نوع القيمة مع نوع الخانة. يُرجى العلم أنّ المسارات المتداخلة غير متاحة حاليًا. على سبيل المثال: يتجاوب |
constant |
اختياريّ. القيمة التلقائية الثابتة للخانة ولن يتم استخدام هذه السمة إلا إذا لم تتم تعبئة قيمة هذه الخانة من خلال |
DataFiles
برنامج التفاف لملف البيانات المتكرر. لا يمكن أن توجد الحقول المتكررة في أحد الحقول.
تمثيل JSON | |
---|---|
{
"dataFiles": [
{
object ( |
الحقول | |
---|---|
dataFiles[] |
ملفات بيانات متعددة. |
DataFile
يمثل هذا النوع ملفًا واحدًا يحتوي على بيانات غير مهيكلة. وتشمل الأمثلة ملفات الصور والملفات الصوتية ورمز مصدر دالة السحابة الإلكترونية.
تمثيل JSON | |
---|---|
{ "filePath": string, "contentType": string, "payload": string } |
الحقول | |
---|---|
filePath |
يشير ذلك المصطلح إلى المسار النسبي لملف البيانات من جذر المشروع في بنية ملف حزمة تطوير البرامج (SDK). مسارات الملفات المسموح بها: - الصور: |
contentType |
مطلوبة. نوع محتوى مادة العرض هذه مثال: |
payload |
محتوى ملف البيانات. ومن الأمثلة على ذلك وحدات البايت الأولية للصور أو الملفات الصوتية أو تنسيق ZIP لدالة السحابة الإلكترونية. هناك حد أقصى لحجم حمولة البيانات يبلغ 10 ميغابايت. سلسلة بترميز base64. |