- تمثيل 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 |
يمكنك الربط من الأهداف إلى الإجراءات المخصّصة لضبط استدعاء المشروع. يمكن أن تكون أغراض الاستدعاء إما نظامًا أو أغراضًا مخصصة تم تحديدها في العمود "custom/intents/". طرد. يجب أن يكون لجميع الأهداف المحدّدة هنا (أهداف النظام والأهداف المخصّصة) ملف هدف مقابل في السمة "custom/global/ " طرد. عنصر يحتوي على قائمة بأزواج |
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 |
فئة 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 |
يتوافق سطح العرض مع محتوى الشاشة والإخراج المرئي. |
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 Black - Sans Serif مكثف - Sans Serif مكثف - Serif - Serif غامق - Monospace - Cursive - Sans Serif Smallcaps |
imageCornerStyle |
نمط حدود الصورة الأمامية للبطاقات على سبيل المثال، يمكن استخدامها على الصورة الأمامية لبطاقة أساسية أو بطاقة لوحة عرض دوّارة. |
landscapeBackgroundImage |
الوضع الأفقي (1920×1200 بكسل على الأقل) يجب تحديد ذلك كمرجع للصورة المقابلة في دليل |
portraitBackgroundImage |
وضع "بورتريه" (1200×1920 بكسل على الأقل) يجب تحديد ذلك كمرجع للصورة المقابلة في دليل |
ImageCornerStyle
يصف كيفية عرض حدود الصور.
عمليات التعداد | |
---|---|
IMAGE_CORNER_STYLE_UNSPECIFIED |
حالة غير محدَّدة / غير محدّدة |
CURVED |
زاوية دائرية للصورة. |
ANGLED |
زاوية مستطيلة للصورة. |
AccountLinking
يتيح ربط الحساب لـ Google توجيه المستخدم لتسجيل الدخول إلى خدمات التطبيق على الويب.
بالنسبة إلى نوعَي ربط "تسجيل الدخول بحساب Google" و"بروتوكول OAuth" و"تسجيل الدخول بحساب Google"، تُنشئ Google معرّف عميل يحدِّد تطبيقك لـ Google ("معرّف العميل الصادر عن Google إلى "الإجراءات" في واجهة مستخدم Console). هذا الحقل للقراءة فقط ويمكن التحقق منه من خلال الانتقال إلى صفحة "ربط الحساب" في واجهة مستخدم Console. يمكنك الانتقال إلى: 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
. على سبيل المثال، يجب أن تكون قيمة المفتاح executeFunction
باللغة my_webhook
على النحو التالي: - /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
يحتوي على البيانات الوصفية لدالة سحابية مضمّنة تم نشرها من مجلد الردود التلقائية على الويب.
تمثيل JSON | |
---|---|
{ "executeFunction": string } |
الحقول | |
---|---|
executeFunction |
اسم نقطة إدخال "دالة السحابة الإلكترونية". يجب أن تتطابق قيمة هذا الحقل مع اسم الطريقة التي تم تصديرها من رمز المصدر. |
النيّة بالشراء
تربط أهدافًا إدخال المستخدم المفتوح للكائنات المنظَّمة. تتم مطابقة العبارات الشفهية مع الأهداف من خلال ميزة "فهم اللغات الطبيعية" (NLU) من Google. يمكن أن تؤدي مطابقات الأهداف إلى تشغيل أحداث في تصميم محادثتك لإحراز تقدّم في محادثة المستخدم. ويتم تحديد اسم الغرض في اسم الملف.
تمثيل JSON | |
---|---|
{
"parameters": [
{
object ( |
الحقول | |
---|---|
parameters[] |
تمثّل هذه السمة قائمة بالمعلَمات ضمن عبارات التدريب. يجب تحديد جميع المَعلمات هنا لاستخدامها في عبارة التدريب. |
trainingPhrases[] |
تتيح العبارات التدريبية لـ NLU من Google مطابقة الأهداف تلقائيًا مع البيانات التي أدخلها المستخدم. وكلما زاد عدد العبارات الفريدة التي يتم تقديمها، زادت فرصة مطابقة هذا الهدف. في ما يلي تنسيق جزء العبارة التدريبية المُشار إليه في تعليقات توضيحية. تجدر الإشارة إلى أنّ الحقل |
IntentParameter
يشير ذلك المصطلح إلى تعريف معلَمة يمكن استخدامها داخل عبارات التدريب.
تمثيل JSON | |
---|---|
{ "name": string, // Union field |
الحقول | ||
---|---|---|
name |
مطلوب. اسم فريد لمعلَمة intent. يمكن استخدامها في الشروط والردود على مَعلمات الأهداف المرجعية المستخرجة من وحدة NLU باستخدام $intent.params.[name].resolved |
|
حقل الاتحاد parameter_type . نوع معلَمة intent. يمكن أن يكون parameter_type واحدًا فقط مما يلي: |
||
type |
اختياريّ. لتعريف نوع البيانات لهذه المَعلمة. لا يجب ضبط هذا الخيار على الأهداف المضمّنة. |
|
entitySetReferences |
اختياريّ. إحالات إلى مجموعات الكيانات المسموح بها لمعلَمة الغرض هذه صالحة فقط لمعلمات هدف مدمج. وتشير هذه المراجع إلى مجموعات الكيانات في الحقل "custom/entitySets" الدليل. |
ClassReference
يشير ذلك المصطلح إلى مرجع إلى فئة يُستخدَم للإشارة إلى نوع حقل أو قيمة معروضة. التعدادات هي أيضًا نوع من الفئات التي يمكن الرجوع إليها باستخدام ClassReference.
تمثيل JSON | |
---|---|
{ "name": string, "list": boolean } |
الحقول | |
---|---|
name |
مطلوب. اسم النوع المضمّن أو النوع المخصّص للمَعلمة أمثلة: |
list |
اختياريّ. يشير إلى ما إذا كان نوع البيانات يمثل قائمة من القيم. |
EntitySetReferences
مراجع مجموعة الكيانات لمعلَمة intent.
تمثيل JSON | |
---|---|
{
"entitySetReferences": [
{
object ( |
الحقول | |
---|---|
entitySetReferences[] |
مطلوب. مراجع مجموعة الكيانات لمعلَمة intent. |
EntitySetReference
مرجع إلى مجموعة الكيانات المسموح بها لمعلَمة الغرض هذه.
تمثيل JSON | |
---|---|
{ "entitySet": string } |
الحقول | |
---|---|
entitySet |
مطلوب. تحدّد المجموعة المحدّدة من الكيانات التي يجب أخذها في الاعتبار لمَعلمة معيّنة. يجب أن يتوفّر تعريف مجموعة الكيانات المقابل في الدليل custom/entitySets/. |
النوع
تعريف النوع المخصّص، وليس الأنواع المضمّنة. يمكن تعيين الأنواع لخانات في مشهد أو معلمات عبارات التدريب الخاصة بالهدف. من الناحية العملية، يمكن اعتبار الأنواع على أنها تعدادات. لاحظ أنه يتم تحديد اسم النوع في اسم الملف.
تمثيل 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
تصف مجموعات الكيانات مجموعة محدّدة مسبقًا من الكيانات التي يمكن أن تأتي منها قيم مَعلمات النية المضمّنة. يمكن الإشارة إلى مجموعات الكيانات من كيان لتتمكن من استخدام الكيان في مَعلمات intent المضمّنة.
تمثيل JSON | |
---|---|
{
"entities": [
{
object ( |
الحقول | |
---|---|
entities[] |
مطلوب. قائمة الكيانات التي تتوافق معها مجموعة الكيانات هذه. |
الكيان
تمثّل هذه السمة كيانًا يمكن أن تأتي منه قيمة معلَمة الغرض المضمّنة.
تمثيل JSON | |
---|---|
{ "id": string } |
الحقول | |
---|---|
id |
مطلوب. رقم تعريف الكيان. للحصول على قائمة بالمَعلمات المضمَّنة والكيانات المتوافقة معها، يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/build/built-in-intents. |
GlobalIntentEvent
إلى جانب معالج الأهداف العامة. يتم تحديد الأحداث العالمية حسب النية بالشراء على مشروع "المهام" بالكامل، وقد يتم تجاهلها من خلال معالِجات الأهداف في المشهد. يجب أن تكون أسماء الأهداف فريدة ضمن مشروع المهام.
يمكن مطابقة الأهداف العالمية في أي وقت خلال الجلسة، ما يسمح للمستخدمين بالوصول إلى المسارات الشائعة مثل "الحصول على المساعدة". أو "الرجوع إلى الصفحة الرئيسية". ويمكن استخدامها أيضًا لربط المستخدمين بصفحات معيّنة في تدفقات محدّدة عند استدعاء إجراء.
تجدر الإشارة إلى أنّه يتم تحديد اسم الغرض في اسم الملف.
تمثيل 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 أو تحويل النص إلى كلام. سيتم تلقائيًا إلحاق الكلام بالكلام في الطلب البسيط السابق. إذا كان الحقل |
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 وحدة بكسل مستقلة الكثافة (dp). |
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 الذي يمكن أن يكون أيًا مما يلي: - http/https عناوين URL لفتح تطبيق مرتبط بتطبيق أو صفحة ويب |
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[] |
أنواع عناصر التحكم الاختيارية في الوسائط التي يمكن أن تدعمها جلسة الاستجابة للوسائط هذه. في حال ضبطها، سيتم تقديم الطلب إلى جهة خارجية عند وقوع حدث معيّن للوسائط. في حال ترك هذه السياسة بدون ضبط، يجب أن يتعامل الطرف الثالث مع نوعَي التحكّم التلقائيَّين، "تم الانتهاء" و"تعذّر الإجراء". |
mediaObjects[] |
قائمة بكائنات الوسائط. |
repeatMode |
وضع التكرار لقائمة عناصر الوسائط. |
MediaType
نوع الوسائط لهذا الردّ.
عمليات التعداد | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
قيمة غير محدّدة |
AUDIO |
ملف صوتي |
MEDIA_STATUS_ACK |
الاستجابة للإقرار بتقرير حالة الوسائط. |
OptionalMediaControls
أنواع عناصر التحكم في الوسائط التي يمكن دعمها استجابة الوسائط بشكل اختياري
عمليات التعداد | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
قيمة غير محدّدة |
PAUSED |
تم إيقاف الحدث مؤقتًا. يتم تشغيله عندما يوقف المستخدم الوسائط مؤقتًا. |
STOPPED |
تم إيقاف الحدث. يتم تشغيله عندما يخرج المستخدم من جلسة تابعة لجهة خارجية أثناء تشغيل الوسائط. |
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 |
رمز صورة صغير يتم عرضه على يمين العنوان. ويتم تغيير حجمها إلى 36×36 بكسل مستقل الكثافة. |
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 = "تذكرة" مع "$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. |