Files

التفاف لقائمة من الملفات.

تمثيل JSON
{

  // Union field file_type can be only one of the following:
  "configFiles": {
    object (ConfigFiles)
  },
  "dataFiles": {
    object (DataFiles)
  }
  // End of list of possible types for union field file_type.
}
الحقول
حقل الاتحاد file_type يمكن إرسال نوع واحد فقط من الملفات إلى الخادم في كل مرة، سواء كانت ملفات تهيئة أو ملفات بيانات. يمكن أن تكون السمة "file_type" واحدة فقط مما يلي:
configFiles

object (ConfigFiles)

قائمة بملفات الإعداد يشمل ذلك البيان والإعدادات وحِزم موارد نماذج التفاعل وغير ذلك.

dataFiles

object (DataFiles)

قائمة بملفات البيانات ويشمل هذا الصورة والملف الصوتي ورمز مصدر دالة السحابة الإلكترونية.

ConfigFiles

برنامج تغليف لملفات الإعداد المتكررة لا يمكن أن توجد الحقول المتكررة في أحد الحقول.

تمثيل JSON
{
  "configFiles": [
    {
      object (ConfigFile)
    }
  ]
}
الحقول
configFiles[]

object (ConfigFile)

ملفات تهيئة متعددة.

ConfigFile

يمثل هذا النوع ملفًا واحدًا يحتوي على بيانات منظَّمة. يمكن للمطورين تحديد معظم مشاريعهم باستخدام التكوين المنظم بما في ذلك الإجراءات، والإعدادات، وإنجاز المهام.

تمثيل JSON
{
  "filePath": string,

  // Union field file can be only one of the following:
  "manifest": {
    object (Manifest)
  },
  "actions": {
    object (Actions)
  },
  "settings": {
    object (Settings)
  },
  "webhook": {
    object (Webhook)
  },
  "intent": {
    object (Intent)
  },
  "type": {
    object (Type)
  },
  "entitySet": {
    object (EntitySet)
  },
  "globalIntentEvent": {
    object (GlobalIntentEvent)
  },
  "scene": {
    object (Scene)
  },
  "staticPrompt": {
    object (StaticPrompt)
  },
  "accountLinkingSecret": {
    object (AccountLinkingSecret)
  },
  "resourceBundle": {
    object
  }
  // End of list of possible types for union field file.
}
الحقول
filePath

string

يشير ذلك المصطلح إلى المسار النسبي لملف الإعداد من جذر المشروع في بنية ملف حزمة تطوير البرامج (SDK). لكل نوع من أنواع الملفات أدناه مسار ملف مسموح به. على سبيل المثال: settings/settings.yaml

حقل الاتحاد file يجب أن يكون لكل نوع من ملفات التهيئة حقل مقابل في أحدهما. يمكن أن تكون السمة "file" واحدة فقط مما يلي:
manifest

object (Manifest)

ملف بيان واحد مسار الملف المسموح به: manifest.yaml

actions

object (Actions)

ملف إجراءات واحد يحتوي على جميع الإجراءات المحددة. مسارات الملفات المسموح بها: actions/{language}?/actions.yaml

settings

object (Settings)

تكوين إعدادات فردية تتضمن إعدادات وإعدادات غير قابلة للأقلمة للّغة الافتراضية للمشروع (إذا تم تحديدها). بالنسبة إلى ملف إلغاء اللغة، ستتم تعبئة الحقل localizedSettings فقط. مسارات الملفات المسموح بها: settings/{language}?/settings.yaml يُرجى العلم بأنّ ملف الإعدادات غير المترجَمة settings/settings.yaml يجب أن يكون متوفّرًا في طلبات دفق الكتابة.

webhook

object (Webhook)

تعريف واحد للردّ التلقائي على الويب مسار الملف المسموح به: webhooks/{WebhookName}.yaml

intent

object (Intent)

تعريف الغرض الوحيد. مسارات الملفات المسموح بها: custom/intents/{language}?/{IntentName}.yaml

type

object (Type)

تعريف من نوع واحد. مسارات الملفات المسموح بها: custom/types/{language}?/{TypeName}.yaml

entitySet

object (EntitySet)

تعريف مجموعة كيانات واحدة. مسارات الملفات المسموح بها: custom/entitySets/{language}?/{EntitySetName}.yaml

globalIntentEvent

object (GlobalIntentEvent)

تعريف واحد للحدث الشامل حسب النية بالشراء مسارات الملفات المسموح بها: custom/global/{GlobalIntentEventName}.yaml يجب أن يكون اسم الملف (GlobalIntentEventName) هو اسم الغرض الذي يتوافق معه حدث الغرض العالمي هذا.

scene

object (Scene)

تعريف مشهد واحد. مسارات الملفات المسموح بها: custom/scenes/{SceneName}.yaml

staticPrompt

object (StaticPrompt)

تعريف واحد ثابت للطلب مسارات الملفات المسموح بها: custom/prompts/{language}?/{StaticPromptName}.yaml

accountLinkingSecret

object (AccountLinkingSecret)

البيانات الوصفية المقابلة لسر العميل المُستخدَم في ربط الحساب مسار الملف المسموح به: settings/accountLinkingSecret.yaml

resourceBundle

object (Struct format)

حزمة موارد واحدة، وهي عبارة عن خريطة من سلسلة إلى سلسلة أو قائمة من السلاسل. يمكن استخدام حِزم الموارد لترجمة السلاسل في الطلبات الثابتة. مسارات الملفات المسموح بها: resources/strings/{language}?/{multiple directories}?/{BundleName}.yaml

البيان

تحتوي على معلومات "قابلة للنقل"، أي غير خاصة بأي مشروع معيّن ويمكن نقلها بين المشاريع.

تمثيل JSON
{
  "version": string
}
الحقول
version

string

تمثّل هذه السمة نسخة من تنسيق الملف. إصدار تنسيق الملف الحالي هو 1.0 مثال: "1.0"

المهام

تمثل قائمة الإجراءات المحددة في المشروع.

تمثيل JSON
{
  "custom": {
    string: {
      object (CustomAction)
    },
    ...
  }
}
الحقول
custom

map (key: string, value: object (CustomAction))

يمكنك الربط من الأغراض إلى الإجراءات المخصّصة لضبط الاستدعاء للمشروع. ويمكن أن تكون أغراض الاستدعاء إما نظام أو أغراض مخصّصة محدّدة في الحزمة "مخصّصة/حسب نية/". يجب أن يكون لجميع الأغراض المحدّدة هنا (أهداف النظام والأغراض المخصّصة) ملف أهداف مقابلة في الحزمة "مخصّص/عالمي/".

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

CustomAction

التفاصيل المتعلّقة بإجراء مخصّص.

تمثيل JSON
{
  "engagement": {
    object (Engagement)
  }
}
الحقول
engagement

object (Engagement)

آليات تفاعل مرتبطة بهذا الإجراء لمساعدة المستخدمين النهائيين على الاشتراك في الإشعارات الفورية والتعديلات اليومية. يُرجى العلم أنّ اسم الغرض المحدّد في إعدادات خانتك الخاصة بالتحديثات اليومية/الإشعارات الفورية يجب أن يتطابق مع الغرض من هذا الإجراء في ما يخص اشتراك المستخدمين النهائيين في هذه التعديلات.

تفاعل

تحدد آليات التفاعل المرتبطة بهذا الإجراء. يتيح ذلك للمستخدمين النهائيين الاشتراك في الإشعارات الفورية والتحديث اليومي.

تمثيل JSON
{
  "title": string,
  "pushNotification": {
    object (PushNotification)
  },
  "actionLink": {
    object (ActionLink)
  },
  "assistantLink": {
    object (AssistantLink)
  },
  "dailyUpdate": {
    object (DailyUpdate)
  }
}
الحقول
title

string

عنوان التفاعل الذي سيتم إرساله إلى المستخدمين النهائيين لطلب إذنهم لتلقي التحديثات. ستظهر رسالة المطالبة التي يتم إرسالها إلى المستخدمين النهائيين للحصول على التحديثات اليومية على النحو التالي: "في أي وقت تريد أن أرسِل إليك {title}" يوميًا، وستظهر الإشعارات الفورية على النحو التالي: "هل توافق على إرسال إشعارات فورية بشأن {title}"؟ هذا الحقل قابل للترجمة.

pushNotification

object (PushNotification)

إعدادات الإشعارات الفورية التي تتيحها عملية التفاعل هذه

dailyUpdate

object (DailyUpdate)

إعدادات التعديل اليومية التي يتيحها هذا التفاعل

PushNotification

تُحدِّد إعدادات الإشعارات الفورية التي يتيحها هذا التفاعل.

DailyUpdate

تحدِّد إعدادات التحديث اليومية التي يتيحها هذا التفاعل.

الإعدادات

تمثل إعدادات مشروع "المهام" التي لا تكون خاصة بلغة معيّنة. العلامة التالية: 22

تمثيل JSON
{
  "projectId": string,
  "defaultLocale": string,
  "enabledRegions": [
    string
  ],
  "disabledRegions": [
    string
  ],
  "category": enum (Category),
  "usesTransactionsApi": boolean,
  "usesDigitalPurchaseApi": boolean,
  "usesInteractiveCanvas": boolean,
  "usesHomeStorage": boolean,
  "designedForFamily": boolean,
  "containsAlcoholOrTobaccoContent": boolean,
  "keepsMicOpen": boolean,
  "surfaceRequirements": {
    object (SurfaceRequirements)
  },
  "testingInstructions": string,
  "localizedSettings": {
    object (LocalizedSettings)
  },
  "accountLinking": {
    object (AccountLinking)
  },
  "selectedAndroidApps": [
    string
  ]
}
الحقول
projectId

string

رقم تعريف مشروع الإجراءات

defaultLocale

string

اللغة التلقائية للمشروع. بالنسبة إلى جميع الملفات باستثناء الملفات ضمن resources/ بدون لغة في المسار، تُنسَب البيانات المترجَمة إلى هذا defaultLocale. بالنسبة إلى الملفات الموجودة تحت resources/، لا توجد لغة تعني أن المورد قابل للتطبيق على جميع اللغات.

enabledRegions[]

string

تُمثِّل المناطق التي يمكن للمستخدمين فيها استدعاء الإجراءات الخاصة بك، استنادًا إلى موقع تواجد المستخدم. لا يمكن ضبط السياسة في حال ضبط سياسة disabledRegions. إذا لم يتم تحديد كل من enabledRegions وdisabledRegions، يمكن للمستخدمين استدعاء الإجراءات الخاصة بك في جميع المناطق. ويتم تمثيل كل منطقة باستخدام الاسم الأساسي للاستهدافات الجغرافية في AdWords. راجع https://developers.google.com/adwords/api/docs/appendix/geotargeting الأمثلة: - "ألمانيا" - "غانا" - "اليونان" - "غرينادا" - "المملكة المتحدة" - "الولايات المتحدة" - "جزر الولايات المتحدة الصغرى النائية" - "أوروغواي"

disabledRegions[]

string

تمثل المناطق التي تم حظر الإجراءات فيها استنادًا إلى الموقع الجغرافي الذي تواجد فيه المستخدم. لا يمكن ضبط السياسة في حال ضبط سياسة enabledRegions. ويتم تمثيل كل منطقة باستخدام الاسم الأساسي للاستهدافات الجغرافية في AdWords. راجع https://developers.google.com/adwords/api/docs/appendix/geotargeting الأمثلة: - "ألمانيا" - "غانا" - "اليونان" - "غرينادا" - "المملكة المتحدة" - "الولايات المتحدة" - "جزر الولايات المتحدة الصغرى النائية" - "أوروغواي"

category

enum (Category)

الفئة لمشروع الإجراءات هذا.

usesTransactionsApi

boolean

ما إذا كان بإمكان "المهام" استخدام المعاملات (مثل إجراء الحجوزات وتلقّي الطلبات وما إلى ذلك) وفي حال اختيار القيمة "خطأ"، ستفشل محاولات استخدام واجهات برمجة تطبيقات المعاملات.

usesDigitalPurchaseApi

boolean

ما إذا كان بإمكان "المهام" تنفيذ معاملات للسلع الرقمية.

usesInteractiveCanvas

boolean

يمكنك اختيار ما إذا كانت الإجراءات تستخدم "لوحة الرسم التفاعلية".

usesHomeStorage

boolean

ما إذا كانت "المهام" تستخدم ميزة "التخزين في المنزل"

designedForFamily

boolean

ما إذا كان محتوى المهام مخصّصًا للعائلات (DFF)

containsAlcoholOrTobaccoContent

boolean

ما إذا كانت "المهام" تتضمّن محتوى مرتبطًا بالكحول أو التبغ

keepsMicOpen

boolean

يمكنك اختيار ما إذا كانت الإجراءات يمكن أن تترك الميكروفون مفتوحًا بدون طلب صريح أثناء المحادثة.

surfaceRequirements

object (SurfaceRequirements)

متطلبات السطح التي يجب أن تدعمها مساحة عرض العميل لاستدعاء الإجراءات في هذا المشروع.

testingInstructions

string

تعليمات الاختبار المرن لمراجع "المهام" (مثل تعليمات ربط الحساب)

localizedSettings

object (LocalizedSettings)

الإعدادات المترجَمة للّغة التلقائية للمشروع يجب أن يكون لكل لغة إضافية ملف إعدادات خاص بها في الدليل الخاص بها.

accountLinking

object (AccountLinking)

السماح للمستخدمين بإنشاء الحسابات أو ربطها من خلال تسجيل الدخول بحساب Google و/أو خدمة OAuth الخاصة

selectedAndroidApps[]

string

تطبيقات 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 (CapabilityRequirement)
    }
  ]
}
الحقول
minimumRequirements[]

object (CapabilityRequirement)

تمثّل هذه السمة الحد الأدنى لمجموعة الإمكانات اللازمة لاستدعاء الإجراءات في مشروعك. إذا كانت السطح لا تحتوي على أي من هذه العناصر، لن يتم تشغيل الإجراء.

CapabilityRequirement

تمثّل هذه السمة شرطًا بشأن توفُّر إمكانية معيّنة.

تمثيل JSON
{
  "capability": enum (SurfaceCapability)
}
الحقول
capability

enum (SurfaceCapability)

تمثّل هذه السمة نوع الإمكانية.

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 (ThemeCustomization)
  }
}
الحقول
displayName

string

مطلوبة. الاسم المعروض التلقائي لمشروع الإجراءات هذا (في حال عدم توفّر ترجمة)

pronunciation

string

مطلوبة. طريقة لفظ الاسم المعروض لاستحضاره ضمن سياق صوتي (منطوق).

shortDescription

string

مطلوبة. هو الوصف الموجز التلقائي لمشروع الإجراءات (في حال عدم توفُّر ترجمة). عدد الأحرف المسموح به هو 80 حرفًا.

fullDescription

string

مطلوبة. الوصف الطويل التلقائي لمشروع الإجراءات (في حال عدم توفُّر ترجمة) عدد الأحرف المسموح به هو 4,000 حرف.

smallLogoImage

string

مطلوبة. صورة مربعة صغيرة، 192 × 192 بكسل يجب تحديد هذه السمة كمرجع للصورة المعنيّة في دليل resources/images/. على سبيل المثال، $resources.images.foo (بدون الإضافة) للصورة في resources/images/foo.jpg عند العمل على مشروع تم سحبه من Console، يمكن استخدام عنوان URL الذي تديره Google وتم سحبه. لا يُسمح بعناوين URL من مصادر خارجية.

largeBannerImage

string

اختياريّ. صورة أفقية كبيرة، 1920 × 1080 بكسل يجب تحديد هذه السمة كمرجع للصورة المعنيّة في دليل resources/images/. على سبيل المثال، $resources.images.foo (بدون الإضافة) للصورة في resources/images/foo.jpg عند العمل على مشروع تم سحبه من Console، يمكن استخدام عنوان URL الذي تديره Google وتم سحبه. لا يُسمح بعناوين URL من مصادر خارجية.

developerName

string

مطلوبة. اسم المطوّر الذي سيتم عرضه للمستخدمين

developerEmail

string

مطلوبة. عنوان البريد الإلكتروني لجهة اتصال مطوّر البرامج.

termsOfServiceUrl

string

اختياريّ. عنوان URL لبنود الخدمة.

voice

string

مطلوبة. نوع الصوت في "مساعد Google" الذي يسمعه المستخدمون عند تفاعلهم مع الإجراءات. القيم المسموح بها هي "male_1" و"male_2" و"female_1" و "female_2".

voiceLocale

string

اختياريّ. اللغة المستخدَمة للصوت المحدَّد. وفي حال عدم تحديد ذلك، يتم التحويل إلى لغة "مساعد Google" لدى المستخدم. في حال تحديد لغة الصوت، يجب أن تكون اللغة الجذر نفسها للّغة المحدّدة في LocalizedSettings.

privacyPolicyUrl

string

مطلوبة. عنوان URL لسياسة الخصوصية

sampleInvocations[]

string

اختياريّ. يتضمّن دليل "مساعد Google" نماذج لعبارات الاستدعاء معروضة كجزء من وصف مشروع الإجراءات الخاص بك. سيساعد هذا المستخدمين في تعلم كيفية استخدامه.

themeCustomization

object (ThemeCustomization)

اختياريّ. عمليات تخصيص المظاهر للمكوّنات المرئية للإجراءات

ThemeCustomization

الأنماط المطبَّقة على البطاقات التي يتم عرضها للمستخدمين

تمثيل JSON
{
  "backgroundColor": string,
  "primaryColor": string,
  "fontFamily": string,
  "imageCornerStyle": enum (ImageCornerStyle),
  "landscapeBackgroundImage": string,
  "portraitBackgroundImage": string
}
الحقول
backgroundColor

string

لون خلفية البطاقات يعمل كإجراء احتياطي إذا لم يقدِّم المطوِّرون background_image أو لم يلائم background_image مساحات عرض معيّنة. مثال على الاستخدام: #FAFAFA

primaryColor

string

سيتم استخدام لون المظهر الأساسي للإجراء من أجل ضبط لون نص العنوان ولون خلفية عنصر العمل في بطاقات "المهام مع مساعد Google". مثال على الاستخدام: #FAFAFA

fontFamily

string

مجموعة الخطوط التي سيتم استخدامها لعنوان البطاقات. الخطوط المتوافقة: - Sans Serif - Sans Serif Medium - Sans Serif غامق - Sans Serif غامق - Sans Serif مكثف - Sans Serif مكثف - Serif Serif غامق - Monospace - تدوين - Sans Serif صغير

imageCornerStyle

enum (ImageCornerStyle)

نمط حدودي لصورة أمامية للبطاقات. على سبيل المثال، يمكن تطبيقها على الصورة الأمامية لبطاقة أساسية أو بطاقة لوحة عرض دوّارة.

landscapeBackgroundImage

string

الوضع الأفقي (1920×1200 بكسل كحد أدنى) يجب تحديد هذه السمة كمرجع للصورة المعنيّة في دليل resources/images/. على سبيل المثال: $resources.images.foo (بدون الإضافة) للصورة في resources/images/foo.jpg عند العمل على مشروع تم سحبه من وحدة التحكّم، يمكن استخدام عنوان URL الذي تديره Google والذي تم سحبه.

portraitBackgroundImage

string

وضع "بورتريه" (1200×1920 بكسل كحد أدنى) يجب تحديد هذه السمة كمرجع للصورة المعنيّة في دليل resources/images/. على سبيل المثال: $resources.images.foo (بدون الإضافة) للصورة في resources/images/foo.jpg عند العمل على مشروع تم سحبه من وحدة التحكّم، يمكن استخدام عنوان URL الذي تديره Google والذي تم سحبه.

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 (LinkingType),
  "authGrantType": enum (AuthGrantType),
  "appClientId": string,
  "authorizationUrl": string,
  "tokenUrl": string,
  "scopes": [
    string
  ],
  "learnMoreUrl": string,
  "useBasicAuthHeader": boolean
}
الحقول
enableAccountCreation

boolean

مطلوبة. إذا true، سيتم السماح للمستخدمين بالاشتراك في حسابات جديدة عبر الصوت. إذا false، لن يُسمح بإنشاء الحساب إلا على موقعك الإلكتروني. حدد هذا الخيار إذا كنت تريد عرض بنود الخدمة أو الحصول على موافقات المستخدمين أثناء الاشتراك. لا يمكن أن يكون نوع الربط GOOGLE_SIGN_IN عندما تكون هذه القيمة false. لا يمكن أن يكون LinkingType OAUTH عندما يكون هذا الحقل "true".

linkingType

enum (LinkingType)

مطلوبة. نوع الربط المطلوب استخدامه. يُرجى الاطّلاع على https://developers.google.com/assistant/identity للحصول على مزيد من التفاصيل حول أنواع الربط.

authGrantType

enum (AuthGrantType)

اختياريّ. يشير إلى نوع المصادقة لـ OAUTH LinkingType.

appClientId

string

اختياريّ. معرّف العميل الذي أصدره تطبيقك إلى Google. هذا هو معرّف عميل OAuth2 الذي يحدِّد Google في خدمتك. لا يتم ضبطه إلا عند استخدام بروتوكول OAuth.

authorizationUrl

string

اختياريّ. نقطة نهاية لصفحة ويب تسجيل الدخول التي تتوافق مع رمز OAuth2 أو التدفقات الضمنية يجب أن يستخدم عنوان URL بروتوكول HTTPS. لا يتم ضبطه إلا عند استخدام بروتوكول OAuth.

tokenUrl

string

اختياريّ. نقطة نهاية OAuth2 لتبادل الرمز المميز. يجب أن يستخدم عنوان URL بروتوكول HTTPS. لا يتم ضبط هذا الإعداد عند استخدام بروتوكول OAuth مع منح IMPLICIT فقط كنوع الربط. لا يتم ضبطه إلا عند استخدام بروتوكول OAuth.

scopes[]

string

اختياريّ. قائمة بالأذونات التي يجب أن يوافق عليها المستخدم حتى يتسنى له استخدام خدمتك. لا يتم ضبطه إلا عند استخدام بروتوكول OAuth. تأكد من تقديم بنود الخدمة في معلومات الدليل في قسم LocalizedSettings.terms_of_service_url إذا كنت تحدد هذا الحقل.

learnMoreUrl

string

اختياريّ. إنّها صفحة ويب في خدمتك توضّح الأذونات التي يمنحها المستخدم إلى Google. لا يتم ضبطه إلا في حال استخدام OAuth وتسجيل الدخول بحساب Google. تأكد من تقديم بنود الخدمة في معلومات الدليل في قسم LocalizedSettings.terms_of_service_url إذا كنت تحدد هذا الحقل.

useBasicAuthHeader

boolean

اختياريّ. إذا كانت القيمة 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 (Handler)
    }
  ],

  // Union field webhook_type can be only one of the following:
  "httpsEndpoint": {
    object (HttpsEndpoint)
  },
  "inlineCloudFunction": {
    object (InlineCloudFunction)
  }
  // End of list of possible types for union field webhook_type.
}
الحقول
handlers[]

object (Handler)

قائمة معالِجات هذا الرد التلقائي على الويب.

حقل الاتحاد webhook_type يتوفّر نوع واحد فقط للردّ التلقائي على الويب. يمكن أن تكون السمة "webhook_type" واحدة فقط مما يلي:
httpsEndpoint

object (HttpsEndpoint)

نقطة نهاية HTTPS مخصّصة للردّ التلقائي على الويب.

inlineCloudFunction

object (InlineCloudFunction)

البيانات الوصفية لدالة السحابة الإلكترونية التي تم نشرها من الرمز في مجلد الردود التلقائية على الويب

المعالِج

يُعلن اسم معالج Webhoook. يمكن أن يحتوي الرد التلقائي على الويب على معالِجات متعدّدة مسجَّلة. يمكن استدعاء هذه المعالِجات من عدة أماكن في مشروع الإجراءات.

تمثيل JSON
{
  "name": string
}
الحقول
name

string

مطلوبة. اسم المعالج يجب أن يكون فريدًا عبر جميع المعالِجات في مشروع الإجراءات. يمكنك التحقق من اسم هذا المعالج لاستدعاء الدالة الصحيحة في رمز مصدر التنفيذ.

HttpsEndpoint

نقطة نهاية REST للإشعار في حال عدم استخدام المحرر المضمَّن.

تمثيل JSON
{
  "baseUrl": string,
  "httpHeaders": {
    string: string,
    ...
  },
  "endpointApiVersion": integer
}
الحقول
baseUrl

string

عنوان 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

map (key: string, value: string)

خريطة معلمات HTTP التي سيتم تضمينها في طلب POST.

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

endpointApiVersion

integer

إصدار البروتوكول الذي تستخدمه نقطة النهاية. هذا هو البروتوكول الذي تشاركه جميع أنواع طرق التنفيذ وليس خاصًا بنوع طريقة التنفيذ التي تستخدمها Google.

InlineCloudFunction

يحتفظ بالبيانات الوصفية لدالة Cloud مضمَّنة تم نشرها من مجلد الردود التلقائية على الويب.

تمثيل JSON
{
  "executeFunction": string
}
الحقول
executeFunction

string

اسم نقطة دخول دالة Cloud. يجب أن تتطابق قيمة هذا الحقل مع اسم الطريقة المُصدَّرة من رمز المصدر.

النيّة بالشراء

تربط الأغراض مدخلات المستخدم المفتوحة بالكائنات المنظَّمة. تتم مطابقة العبارات المنطوقة مع الأغراض من خلال ميزة "فهم اللغة الطبيعية" من Google (NLU). يمكن أن تؤدي مطابقات الأهداف إلى بدء أحداث في تصميم محادثتك لإحراز تقدّم في محادثة المستخدم. يتم تحديد اسم الغرض في اسم الملف.

تمثيل JSON
{
  "parameters": [
    {
      object (IntentParameter)
    }
  ],
  "trainingPhrases": [
    string
  ]
}
الحقول
parameters[]

object (IntentParameter)

تمثّل هذه السمة قائمة المَعلمات ضِمن عبارات التدريب. يجب تحديد كل المعلَمات هنا لكي يتم استخدامها في العبارة التدريبية.

trainingPhrases[]

string

تسمح عبارات التدريب لوحدة NLU في Google بمطابقة الأهداف تلقائيًا مع البيانات التي يدخلها المستخدمون. وكلما قدّمت المزيد من العبارات الفريدة، زادت فرصة مطابقة هذا الطلب. فيما يلي تنسيق جزء عبارة التدريب الذي تمت إضافة تعليقات توضيحية إليه. يُرجى العِلم أنّ الحقل auto اختياري، وأنّ السلوك التلقائي في حال عدم تحديد auto يكون معادلاً للحقل auto=false. تعني ($<paramName> '<sample text>' auto=<true or false>) auto = true أنّ NLU تمت إضافة تعليقات توضيحية إلى الجزء تلقائيًا. تعني auto = false أنّ المستخدم قد أضاف تعليقًا توضيحيًا إلى هذا الجزء. هذا هو الخيار التلقائي في حال عدم تحديد الخيار "تلقائي". مثال: "حجز رحلة جوية من ($source 'San Francisco' auto=false) إلى ($dest 'فانكوفر')"

IntentParameter

تعريف معلمة يمكن استخدامها داخل عبارات التدريب.

تمثيل JSON
{
  "name": string,

  // Union field parameter_type can be only one of the following:
  "type": {
    object (ClassReference)
  },
  "entitySetReferences": {
    object (EntitySetReferences)
  }
  // End of list of possible types for union field parameter_type.
}
الحقول
name

string

مطلوبة. الاسم الفريد لمَعلمة intent. يمكن استخدامها في الشروط والاستجابات للإشارة إلى مَعلمات الأهداف المرجعية التي تم استخراجها من خلال NLU باستخدام $intent.params.[name].resolved

حقل الاتحاد parameter_type نوع مَعلمة الغرض. يمكن أن تكون السمة "parameter_type" واحدة فقط مما يلي:
type

object (ClassReference)

اختياريّ. لتحديد نوع بيانات هذه المَعلمة. ويجب عدم ضبط هذه الإعدادات للأغراض المضمّنة.

entitySetReferences

object (EntitySetReferences)

اختياريّ. يشير إلى مجموعات الكيانات المسموح بها لمَعلمة الغرض هذه. صالح فقط لمَعلمات الغرض المضمَّن. تشير هذه المراجع إلى مجموعات الكيانات في الدليل "custom/entitySets".

ClassReference

يشير ذلك المصطلح إلى مرجع لفئة مستخدَمة لتعريف نوع الحقل أو القيمة المعروضة. تعد التعدادات أيضًا نوع من الفئات التي يمكن الإشارة إليها باستخدام ClassReference.

تمثيل JSON
{
  "name": string,
  "list": boolean
}
الحقول
name

string

مطلوبة. اسم النوع المضمَّن أو نوع مخصّص للمَعلمة أمثلة: PizzaToppings وactions.type.Number

list

boolean

اختياريّ. يشير إلى ما إذا كان نوع البيانات يمثل قائمة من القيم.

EntitySetReferences

مراجع مجموعة الكيانات لمعلَمة هدف.

تمثيل JSON
{
  "entitySetReferences": [
    {
      object (EntitySetReference)
    }
  ]
}
الحقول
entitySetReferences[]

object (EntitySetReference)

مطلوبة. مراجع مجموعة الكيانات لمعلَمة هدف.

EntitySetReference

مرجع لمجموعة الكيانات المسموح بها لمَعلمة الغرض هذه.

تمثيل JSON
{
  "entitySet": string
}
الحقول
entitySet

string

مطلوبة. تحدِّد مجموعة الكيانات المحدّدة التي سيتم النظر فيها مع مَعلمة معيّنة. يجب أن يتوفّر تعريف مجموعة الكيانات المقابلة في الدليل المخصّص/entitySets/.

Type

تعريف لنوع مخصص، في مقابل الأنواع المضمّنة. يمكن تعيين الأنواع إلى الخانات في مشهد أو معلَمات عبارات تدريب هدف. عمليًا، يمكن اعتبار الأنواع على أنها تعدادات. ملاحظة: يتم تحديد اسم النوع في اسم الملف.

تمثيل JSON
{
  "exclusions": [
    string
  ],

  // Union field sub_type can be only one of the following:
  "synonym": {
    object (SynonymType)
  },
  "regularExpression": {
    object (RegularExpressionType)
  },
  "freeText": {
    object (FreeTextType)
  }
  // End of list of possible types for union field sub_type.
}
الحقول
exclusions[]

string

مجموعة من الكلمات/العبارات الاستثنائية التي لا ينبغي مطابقتها حسب النوع. ملاحظة: إذا تمت مطابقة الكلمة أو العبارة حسب النوع ولكن تم إدراجها كاستبعاد، لن يتم عرضها في نتيجة استخراج المَعلمة. هذا الحقل قابل للترجمة.

حقل الاتحاد sub_type اختيار النوع الفرعي حسب نوع المطابقة المطلوب إجراؤها يمكن أن تكون السمة "sub_type" واحدة فقط مما يلي:
synonym

object (SynonymType)

نوع المرادفات، وهو في الأساس تعداد.

regularExpression

object (RegularExpressionType)

نوع التعبير العادي، يسمح بمطابقة التعبير العادي.

freeText

object (FreeTextType)

النوع FreeText.

SynonymType

اكتب الذي يطابق النص حسب مجموعة من المرادفات.

تمثيل JSON
{
  "matchType": enum (MatchType),
  "acceptUnknownValues": boolean,
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
الحقول
matchType

enum (MatchType)

اختياريّ. نوع المطابقة للمرادف.

acceptUnknownValues

boolean

اختياريّ. عند ضبط هذه السياسة على "صحيح"، ستتم مطابقة الكلمات أو العبارات غير المعروفة استنادًا إلى البيانات المحيطة بالإدخالات والتدريب على النية، مثل السلع التي يمكن إضافتها إلى قائمة التسوّق.

entities

map (key: string, value: object (Entity))

مطلوبة. خريطة مُسمّاة للكيانات المرادفة

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

MatchType

نوع المطابقة الذي سيستخدمه هذا النوع من الإدخالات. سيضمن ذلك أن تستخدم جميع الأنواع طريقة المطابقة نفسها ويسمح بتنويع المطابقة لمطابقة المرادفات (أي المطابقة الغامضة مقابل المطابقة التامة). إذا كانت القيمة UNSPECIFIED، سيتم ضبطها تلقائيًا على EXACT_MATCH.

عمليات التعداد
UNSPECIFIED يكون الإعداد التلقائي هو EXACT_MATCH.
EXACT_MATCH تبحث عن مطابقة تامة للمرادف أو الاسم.
FUZZY_MATCH أكثر من EXACT_MATCH. يبحث عن المطابقات المتشابهة فضلاً عن المطابقات التامة.

الكيان

تمثل حقل كيان مرادفًا يحتوي على تفاصيل إدخال واحد داخل النوع.

تمثيل JSON
{
  "display": {
    object (EntityDisplay)
  },
  "synonyms": [
    string
  ]
}
الحقول
display

object (EntityDisplay)

اختياريّ. تفاصيل عرض الكيان.

synonyms[]

string

اختياريّ. تمثّل هذه السمة قائمة مرادفات الكيان. هذا الحقل قابل للترجمة.

EntityDisplay

العناصر التي سيتم عرضها على لوحة الرسم بعد استخراج كيان لنوع معيّن من طلب بحث تنطبق فقط على التطبيقات التي تتيح استخدام لوحات الرسم. هذه الرسالة قابلة للترجمة.

تمثيل JSON
{
  "iconTitle": string,
  "iconUrl": string
}
الحقول
iconTitle

string

اختياريّ. عنوان الرمز.

iconUrl

string

مطلوبة. تمثّل هذه السمة عنوان URL للرمز.

RegularExpressionType

اكتب يطابق النص حسب التعبيرات العادية. هذه الرسالة قابلة للترجمة.

تمثيل JSON
{
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
الحقول
entities

map (key: string, value: object (Entity))

مطلوبة. خريطة مُسمّاة للكيانات التي يحتوي كلّ منها على سلاسل تعبير عادي

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

الكيان

تمثل هذه السمة كائن كيان يحتوي على التعبير العادي الذي يُستخدم للمقارنة.

تمثيل JSON
{
  "display": {
    object (EntityDisplay)
  },
  "regularExpressions": [
    string
  ]
}
الحقول
display

object (EntityDisplay)

اختياريّ. العناصر التي سيتم عرضها على لوحة الرسم بعد استخراج كيان من طلب بحث. تنطبق فقط على التطبيقات التي تتيح استخدام لوحات الرسم.

regularExpressions[]

string

مطلوبة. يستخدم بنية التعبير العادي RE2 (يمكنك الاطّلاع على https://github.com/google/re2/wiki/Syntax للحصول على مزيد من التفاصيل)

FreeTextType

اكتب يتطابق مع أي نص إذا كان سياق الكلمات المحيطة قريبًا من أمثلة التدريب المقدَّمة.

تمثيل JSON
{
  "display": {
    object (EntityDisplay)
  }
}
الحقول
display

object (EntityDisplay)

اختياريّ. العناصر التي سيتم عرضها على لوحة الرسم بعد استخراج كيان من طلب بحث. تنطبق فقط على التطبيقات التي تتيح استخدام لوحات الرسم.

EntitySet

تصف مجموعات الكيانات مجموعة الكيانات المحدَّدة مسبقًا التي يمكن أن تأتي منها قيم مَعلمات الأغراض المضمَّنة. يمكن الإشارة إلى مجموعات الكيانات من entitySet في مَعلمات الغرض المدمجة.

تمثيل JSON
{
  "entities": [
    {
      object (Entity)
    }
  ]
}
الحقول
entities[]

object (Entity)

مطلوبة. قائمة الكيانات المتوافقة مع مجموعة الكيانات هذه.

الكيان

يشير ذلك المصطلح إلى كيان يمكن أن تأتي منه قيمة مَعلمة الغرض المضمّنة.

تمثيل JSON
{
  "id": string
}
الحقول
id

string

مطلوبة. رقم تعريف الكيان. للاطّلاع على قائمة بالمَعلمات المضمَّنة والكيانات المتوافقة معها، يُرجى الانتقال إلى https://developers.google.com/assistant/conversational/build/built-in-intents

GlobalIntentEvent

تُحدِّد أداة معالجة الأهداف العامة. يتم تحديد أحداث الأهداف العالمية في نطاق مشروع "المهام" بالكامل ويمكن أن يتم إلغاؤها من خلال معالِجات الأهداف في مشهد. يجب أن تكون أسماء الأغراض فريدة داخل مشروع Actions.

يمكن مطابقة الأهداف العالمية في أي وقت خلال الجلسة، ما يسمح للمستخدمين بالوصول إلى الإجراءات الشائعة مثل "الحصول على مساعدة" أو "الرجوع إلى الصفحة الرئيسية". ويمكن استخدامها أيضًا لربط المستخدمين بصفحات معيّنة في مسارات معيّنة عند استدعاء إجراء معيّن.

ملاحظة: يتم تحديد اسم الغرض في اسم الملف.

تمثيل JSON
{
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
الحقول
transitionToScene

string

اختياريّ. مشهد الوجهة الذي يجب أن تنتقل إليه المحادثة. لقد تدمرت حالة المشهد الحالي أثناء الانتقال.

handler

object (EventHandler)

اختياريّ. معالج الحدث الذي يتم تشغيله عند مطابقة الغرض. يجب التنفيذ قبل الانتقال إلى مشهد الوجهة. يفيد إنشاء الطلبات استجابةً للأحداث.

EventHandler

تحدد معالجًا ليتم تنفيذه بعد الحدث. من أمثلة الأحداث الأحداث المستندة إلى النية والحالة في مشهد.

تمثيل JSON
{
  "webhookHandler": string,

  // Union field prompt can be only one of the following:
  "staticPrompt": {
    object (StaticPrompt)
  },
  "staticPromptName": string
  // End of list of possible types for union field prompt.
}
الحقول
webhookHandler

string

اسم معالِج الردّ التلقائي على الويب المطلوب طلبه

حقل الاتحاد prompt يمكن أن تكون الطلبات مضمّنة أو تتم الإشارة إليها حسب الاسم. يمكن أن تكون السمة "prompt" واحدة فقط مما يلي:
staticPrompt

object (StaticPrompt)

موجّه ثابت مضمّن يمكن أن تحتوي على مراجع لموارد السلسلة في الحِزم.

staticPromptName

string

اسم الطلب الثابت المطلوب استدعاءه

StaticPrompt

يمثّل هذا النوع قائمة من الطلبات المرشحة التي سيتم اختيار أحدها كطلب يظهر في الردّ على المستخدم. هذه الرسالة قابلة للترجمة.

تمثيل JSON
{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}
الحقول
candidates[]

object (StaticPromptCandidate)

قائمة بالطلبات المرشحة التي سيتم إرسالها إلى العميل. يتضمّن كل طلب أداة اختيار لتحديد وقت استخدامها. سيتم إرسال أداة الاختيار الأولى التي تتطابق مع أحد الطلبات، وسيتم تجاهل بقية العناصر.

StaticPromptCandidate

يمثِّل العنصر المحفّز لعرض طلب ثابت.

تمثيل JSON
{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
الحقول
selector

object (Selector)

اختياريّ. تمثّل هذه السمة معايير ما إذا كان هذا الطلب يتطابق مع أحد الطلبات. إذا كانت أداة الاختيار فارغة، سيتمّ عرض هذا الطلب دائمًا.

promptResponse

object (StaticPromptResponse)

الردّ المرتبط بأداة الاختيار

أداة الاختيار

تحدِّد هذه السياسة معايير ما إذا كان الطلب يتطابق مع أحد الطلبات.

تمثيل JSON
{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}
الحقول
surfaceCapabilities

object (SurfaceCapabilities)

مجموعة إمكانات السطح المطلوبة.

SurfaceCapabilities

تمثل مساحة العرض التي يستخدمها المستخدم لتقديم طلب إلى الإجراء.

تمثيل JSON
{
  "capabilities": [
    enum (Capability)
  ]
}
الحقول
capabilities[]

enum (Capability)

مطلوبة. تمثّل هذه السمة إمكانات السطح الذي يمكنه تقديم طلب إلى الإجراء.

الإمكانية

الإمكانات التي يتيحها سطح الجهاز في وقت الطلب.

عمليات التعداد
UNSPECIFIED إمكانية عرض غير محدَّد على السطح
SPEECH يمكن للجهاز التحدث إلى المستخدم عن طريق تحويل النص إلى كلام أو SSML.
RICH_RESPONSE يمكن للجهاز عرض ردود منسّقة، مثل البطاقات والقوائم والجداول.
LONG_FORM_AUDIO يمكن للجهاز تشغيل الوسائط الصوتية الطويلة، مثل الموسيقى وملفات البودكاست.
INTERACTIVE_CANVAS يمكن أن يعرض الجهاز استجابة تفاعلية من لوحة الرسم.
HOME_STORAGE يمكن للجهاز أن يتيح حفظ مساحة التخزين المنزلية وجلبها.

StaticPromptResponse

تمثّل هذه السمة الردود المنظَّمة المطلوب إرسالها إلى المستخدم، مثل النص والكلام والبطاقات وبيانات لوحة الرسم وشرائح الاقتراحات وما إلى ذلك.

تمثيل JSON
{
  "firstSimple": {
    object (StaticSimplePrompt)
  },
  "content": {
    object (StaticContentPrompt)
  },
  "lastSimple": {
    object (StaticSimplePrompt)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (StaticLinkPrompt)
  },
  "override": boolean,
  "canvas": {
    object (StaticCanvasPrompt)
  }
}
الحقول
firstSimple

object (StaticSimplePrompt)

اختياريّ. الاستجابة الأولى بالصوت والنص فقط.

content

object (StaticContentPrompt)

اختياريّ. محتوى مثل بطاقة أو قائمة أو وسائط يتم عرضها للمستخدم.

lastSimple

object (StaticSimplePrompt)

اختياريّ. الرد الأخير بالصوت والنص فقط.

suggestions[]

object (Suggestion)

اختياريّ. الاقتراحات التي يتم عرضها للمستخدم والتي ستظهر دائمًا في نهاية الرد. إذا كان الحقل append في الطلب الذي يتضمّن الطلب هو true، ستتم إضافة العناوين المحدَّدة في هذا الحقل إلى العناوين المحدَّدة في أي طلبات مقترَحة محدَّدة سابقًا، وستتم إزالة القيم المكرّرة.

override

boolean

اختياريّ. وضع لكيفية دمج هذه الرسائل مع الرسائل المحددة مسبقًا سيمحو "true" جميع الرسائل المحددة سابقًا (الأول والأخير ورابط المحتوى والاقتراحات ولوحة الرسم) وسيضيف الرسائل المحددة في هذا الطلب. سيضيف تطبيق "false" الرسائل المحدَّدة في هذا الطلب إلى الرسائل المحدَّدة في الردود السابقة. يؤدي ضبط هذا الحقل على false أيضًا إلى تفعيل إلحاق بعض الحقول به داخل "المطالبات البسيطة" ومطالبة "الاقتراحات" ومطالبة "لوحة الرسم" (جزء من مطالبة المحتوى). سيتم دائمًا استبدال رسائل المحتوى والرابط إذا تم تحديدها في الطلب. القيمة التلقائية هي false.

canvas

object (StaticCanvasPrompt)

ردّ يمكن استخدامه لتجربة لوحة تفاعلية.

StaticSimplePrompt

يمثِّل طلبًا بسيطًا لإرساله إلى أحد المستخدمين.

تمثيل JSON
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
الحقول
variants[]

object (Variant)

قائمة بالصيغ المحتملة

الصيغة

تمثيل صيغة تشكل جزءًا من الطلب البسيط

تمثيل JSON
{
  "speech": string,
  "text": string
}
الحقول
speech

string

اختياريّ. تمثِّل الكلام الذي سيتم قوله إلى المستخدم. يمكن أن يكون تنسيق SSML أو نص إلى كلام. سيتم إلحاق الكلام تلقائيًا بالكلام الخاص بـ Simple Speak. إذا كان الحقل override في الطلب الذي يتضمّن الطلب هو true، سيحلّ الكلام المحدّد في هذا الحقل محلّ الكلام السابق لـ "الطلب البسيط".

text

string

اختياريّ. نص لعرضه في فقاعة المحادثة. في حال عدم توفيره، سيتم عرض حقل الكلام أعلاه. تقتصر على 640 حرفًا. سيتم إلحاق النص تلقائيًا بنص رسالة "الطلب البسيط" السابقة. إذا كان الحقل override في الطلب الذي يتضمّن الطلب هو true، سيحلّ النص المحدّد في هذا الحقل محلّ نص الطلب البسيط السابق.

StaticContentPrompt

تمثّل هذه السمة عنصرًا نائبًا لجزء المحتوى من StaticPrompt.

تمثيل JSON
{

  // Union field content can be only one of the following:
  "card": {
    object (StaticCardPrompt)
  },
  "image": {
    object (StaticImagePrompt)
  },
  "table": {
    object (StaticTablePrompt)
  },
  "media": {
    object (StaticMediaPrompt)
  },
  "list": {
    object (StaticListPrompt)
  },
  "collection": {
    object (StaticCollectionPrompt)
  },
  "collectionBrowse": {
    object (StaticCollectionBrowsePrompt)
  }
  // End of list of possible types for union field content.
}
الحقول
حقل الاتحاد content يمكن توفير نوع واحد فقط من المحتوى في الطلب. يمكن أن تكون السمة "content" واحدة فقط مما يلي:
card

object (StaticCardPrompt)

بطاقة أساسية.

image

object (StaticImagePrompt)

صورة.

table

object (StaticTablePrompt)

بطاقة جدول.

media

object (StaticMediaPrompt)

استجابة تشير إلى مجموعة من الوسائط التي سيتم تشغيلها.

list

object (StaticListPrompt)

بطاقة لمشاركة عرض قائمة خيارات للاختيار من بينها.

collection

object (StaticCollectionPrompt)

بطاقة تعرِض قائمة بالخيارات التي يمكنك الاختيار من بينها.

collectionBrowse

object (StaticCollectionBrowsePrompt)

بطاقة تعرض مجموعة من صفحات الويب لتفتحها

StaticCardPrompt

بطاقة أساسية لعرض بعض المعلومات، مثل صورة و/أو نص.

تمثيل JSON
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (StaticImagePrompt)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (StaticLinkPrompt)
  }
}
الحقول
title

string

اختياريّ. العنوان العام للبطاقة.

subtitle

string

اختياريّ. العنوان الفرعي للبطاقة.

text

string

مطلوبة. النص الأساسي للبطاقة، وهو مطلوب ما لم تكن الصورة متوفّرة. تدعم مجموعة محدودة من بنية markdown للتنسيق.

image

object (StaticImagePrompt)

اختياريّ. صورة الجزء الرئيسي للبطاقة. ويتم تثبيت الارتفاع على 192 بكسل مستقل الكثافة.

imageFill

enum (ImageFill)

اختياريّ. كيفية ملء خلفية الصورة

button

object (StaticLinkPrompt)

اختياريّ. زر قابل للنقر يظهر في البطاقة.

StaticImagePrompt

صورة معروضة في البطاقة.

تمثيل JSON
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
الحقول
url

string

مطلوبة. عنوان URL المصدر للصورة ويمكن أن تكون الصور بتنسيق JPG وPNG وGIF (الرسوم المتحركة وغير المتحركة). مثلاً،https://www.agentx.com/logo.png.

alt

string

مطلوبة. وصف نصي للصورة الذي سيتم استخدامه لتسهيل الاستخدام، مثل برامج قراءة الشاشة.

height

integer

اختياريّ. ارتفاع الصورة بالبكسل.

width

integer

اختياريّ. عرض الصورة بالبكسل.

ImageFill

خيارات عرض الصورة الممكنة للتأثير في عرض الصورة. يجب استخدام هذا الخيار عندما لا تتطابق نسبة العرض إلى الارتفاع للصورة مع نسبة العرض إلى الارتفاع لحاوية الصورة.

عمليات التعداد
UNSPECIFIED لم يتم تحديد ImageFill.
GRAY املأ الفجوات بين الصورة وحاوية الصورة بأشرطة رمادية.
WHITE املأ الفجوات بين الصورة وحاوية الصورة باستخدام أشرطة بيضاء.
CROPPED يتم تغيير حجم الصورة بحيث يتطابق عرض الصورة وارتفاعها مع أبعاد الحاوية أو يتجاوزها. قد يؤدي ذلك إلى اقتصاص الجزء العلوي والسفلي من الصورة إذا كان ارتفاع الصورة التي تم تغيير حجمها أكبر من ارتفاع الحاوية، أو اقتصاص الجزء الأيسر والأيمن من الصورة إذا كان عرض الصورة التي تم تغيير حجمها أكبر من عرض الحاوية. يشبه هذا "وضع التكبير/التصغير" على تلفزيون بشاشة عريضة عند تشغيل فيديو بنسبة عرض إلى ارتفاع 4:3.

StaticLinkPrompt

تُحدِّد رابطًا سيتم عرضه كشريحة اقتراح ويمكن للمستخدم فتحه.

تمثيل JSON
{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}
الحقول
name

string

اسم الرابط

open

object (OpenUrl)

تُحدِّد السلوك عندما يفتح المستخدِم الرابط.

OpenUrl

تُحدِّد السلوك عندما يفتح المستخدِم الرابط.

تمثيل JSON
{
  "url": string,
  "hint": enum (UrlHint)
}
الحقول
url

string

حقل عنوان URL الذي يمكن أن يكون أيًا مما يلي: - عناوين URL التي تستخدم http/https لفتح تطبيق مرتبط بتطبيق أو صفحة ويب

hint

enum (UrlHint)

تشير هذه السمة إلى نوع عنوان URL.

UrlHint

أنواع مختلفة من تلميحات عناوين URL.

عمليات التعداد
HINT_UNSPECIFIED غير محدّدة
AMP عنوان URL يشير مباشرةً إلى محتوى AMP أو إلى عنوان URL أساسي يشير إلى محتوى AMP عبر <link rel="amphtml">.

StaticTablePrompt

بطاقة جدول لعرض جدول نصوص.

تمثيل JSON
{
  "title": string,
  "subtitle": string,
  "image": {
    object (StaticImagePrompt)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (StaticLinkPrompt)
  }
}
الحقول
title

string

اختياريّ. العنوان العام للجدول. يجب ضبطها في حال ضبط العنوان الفرعي.

subtitle

string

اختياريّ. العنوان الفرعي للجدول.

image

object (StaticImagePrompt)

اختياريّ. صورة مرتبطة بالجدول

columns[]

object (TableColumn)

اختياريّ. العناوين ومحاذاة الأعمدة.

rows[]

object (TableRow)

اختياريّ. بيانات الصف في الجدول. نضمن ظهور أول 3 صفوف، ولكن قد يتم قص بعضها الآخر على مساحات عرض معيّنة. يُرجى الاختبار باستخدام المحاكي لمعرفة الصفوف التي سيتم عرضها لسطح معيّن. على مساحات العرض التي تتيح إمكانية استخدام WEB_BROWSER، يمكنك توجيه المستخدم إلى صفحة ويب تحتوي على مزيد من البيانات.

button

object (StaticLinkPrompt)

اختياريّ. زرّ

TableColumn

لوصف عمود في الجدول.

تمثيل JSON
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
الحقول
header

string

نص العنوان للعمود.

align

enum (HorizontalAlignment)

محاذاة أفقية للمحتوى w.r.t العمود وإذا لم يتم تحديده، ستتم محاذاة المحتوى مع الحافة البادئة.

HorizontalAlignment

محاذاة المحتوى داخل الخلية.

عمليات التعداد
UNSPECIFIED المحاذاة الأفقية غير محددة.
LEADING الحافة البادئة للخلية. وهذا هو الخيار التلقائي.
CENTER تتم محاذاة المحتوى مع وسط العمود.
TRAILING تتم محاذاة المحتوى مع حافة العمود.

TableRow

تصف صفًا في الجدول.

تمثيل JSON
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
الحقول
cells[]

object (TableCell)

الخلايا في هذا الصف. نضمن ظهور أول 3 خلايا، ولكن قد يتم قص الخلايا الأخرى على أسطح معينة. يُرجى الاختبار باستخدام المحاكي لمعرفة الخلايا التي سيتم عرضها لسطح معين.

divider

boolean

يشير إلى ما إذا كان يجب وجود مُقسّم بعد كل صف.

TableCell

لوصف خلية في صف واحد.

تمثيل JSON
{
  "text": string
}
الحقول
text

string

المحتوى النصي للخلية.

StaticMediaPrompt

يحتوي على معلومات عن الوسائط، مثل الاسم والوصف وعنوان URL وما إلى ذلك. المعرّف التالي: 11

تمثيل JSON
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ],
  "repeatMode": enum (RepeatMode)
}
الحقول
mediaType

enum (MediaType)

نوع الوسائط لهذا الرد

startOffset

string (Duration format)

بدء إزاحة كائن الوسائط الأول

مدة بالثواني مؤلفة من تسعة أرقام كسور كحد أقصى، وتم إنهاؤها بـ "s". مثال: "3.5s".

optionalMediaControls[]

enum (OptionalMediaControls)

أنواع عناصر تحكّم اختيارية في الوسائط يمكن أن توفّرها جلسة الاستجابة للوسائط هذه. وفي حال ضبط هذه السياسة، سيتم إرسال الطلب إلى 3p عند وقوع حدث معيّن على الوسائط. إذا لم يتم ضبط السياسة، يجب أن تعالج جهة 3p نوعَي التحكّم التلقائيَّين، وهما "تم الانتهاء" و"تعذّر التحقق".

mediaObjects[]

object (MediaObject)

قائمة بكائنات الوسائط

repeatMode

enum (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 (MediaImage)
  }
}
الحقول
name

string

اسم عنصر الوسائط هذا

description

string

وصف عنصر الوسائط هذا.

url

string

تمثّل هذه السمة عنوان URL الذي يشير إلى محتوى الوسائط.

image

object (MediaImage)

الصورة التي سيتم عرضها مع بطاقة الوسائط.

MediaImage

الصورة التي سيتم عرضها داخل MediaPrompt

تمثيل JSON
{

  // Union field image can be only one of the following:
  "large": {
    object (StaticImagePrompt)
  },
  "icon": {
    object (StaticImagePrompt)
  }
  // End of list of possible types for union field image.
}
الحقول
حقل الاتحاد image يُسمح بنوع واحد فقط من MediaImage. يمكن أن تكون السمة "image" واحدة فقط مما يلي:
large

object (StaticImagePrompt)

صورة كبيرة، مثل غلاف الألبوم وما إلى ذلك

icon

object (StaticImagePrompt)

رمز صورة صغير معروض على يسار العنوان يتم تغيير حجمه إلى 36x36 بكسل مستقل الكثافة.

RepeatMode

أنواع وضع التكرار لقائمة من عناصر الوسائط.

عمليات التعداد
REPEAT_MODE_UNSPECIFIED يعادل إيقاف التشغيل.
OFF إنهاء جلسة تشغيل الوسائط في نهاية عنصر الوسائط الأخير.
ALL التكرار الحلقي إلى بداية كائن الوسائط الأول عند الوصول إلى نهاية آخر كائن وسائط.

StaticListPrompt

بطاقة لمشاركة عرض قائمة خيارات للاختيار من بينها.

تمثيل JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
الحقول
title

string

اختياريّ. عنوان القائمة

subtitle

string

اختياريّ. العنوان الفرعي للقائمة.

items[]

object (ListItem)

مطلوبة. عناصر القائمة

ListItem

عنصر في القائمة

تمثيل JSON
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
الحقول
key

string

مطلوبة. مفتاح NLU الذي يتطابق مع اسم مفتاح الإدخال في النوع المرتبط به. عند النقر على العنصر، ستتم إعادة نشر هذا المفتاح كمَعلَمة خيار تحديد.

title

string

مطلوبة. عنوان السلعة. عند النقر على هذا النص، سيتم مشاركته مرة أخرى في المحادثة كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا بين مجموعة العناصر.

description

string

اختياريّ. النص الأساسي للعنصر.

image

object (StaticImagePrompt)

اختياريّ. صورة العنصر

StaticCollectionPrompt

بطاقة لمشاركة عرض مجموعة من الخيارات التي يمكنك الاختيار من بينها.

تمثيل JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
الحقول
title

string

اختياريّ. عنوان المجموعة

subtitle

string

اختياريّ. العنوان الفرعي للمجموعة.

items[]

object (CollectionItem)

مطلوبة. عناصر المجموعة

imageFill

enum (ImageFill)

اختياريّ. نوع خيار عرض الصورة

CollectionItem

عنصر في المجموعة

تمثيل JSON
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
الحقول
key

string

مطلوبة. مفتاح NLU الذي يطابق اسم مفتاح الإدخال في النوع المرتبط به. عند النقر على العنصر، ستتم إعادة نشر هذا المفتاح كمَعلَمة خيار تحديد.

title

string

مطلوبة. عنوان السلعة. عند النقر على هذا النص، سيتم مشاركته مرة أخرى في المحادثة كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا بين مجموعة العناصر.

description

string

اختياريّ. النص الأساسي للعنصر.

image

object (StaticImagePrompt)

اختياريّ. صورة العنصر

StaticCollectionBrowsePrompt

يقدم مجموعة من مستندات الويب كمجموعة من عناصر المربعات الكبيرة. يمكن اختيار عناصر لتشغيل مستند الويب المرتبط بها في عارض الويب.

تمثيل JSON
{
  "items": [
    {
      object (CollectionBrowseItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
الحقول
items[]

object (CollectionBrowseItem)

العناصر في مجموعة التصفُّح يجب أن يتراوح حجم القائمة بين النطاق [2 و10].

imageFill

enum (ImageFill)

خيار عرض الصور للصور في المجموعة.

CollectionBrowseItem

العنصر في المجموعة

تمثيل JSON
{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (StaticImagePrompt)
  },
  "openUriAction": {
    object (OpenUrl)
  }
}
الحقول
title

string

مطلوبة. عنوان عنصر المجموعة.

description

string

وصف عنصر المجموعة.

footer

string

نص تذييل عنصر المجموعة، معروض أسفل الوصف. سطر واحد من النص، تم اقتطاعه بعلامة حذف.

image

object (StaticImagePrompt)

صورة لعنصر المجموعة

openUriAction

object (OpenUrl)

مطلوبة. معرّف موارد منتظم (URI) لفتحه في حال اختيار العنصر.

الاقتراح

تمثّل هذه السمة شريحة اقتراح، وهي عنصر في واجهة المستخدم يتم عرضه للمستخدم لتسهيل تجربته.

تمثيل JSON
{
  "title": string
}
الحقول
title

string

مطلوبة. النص المعروض في شريحة الاقتراح. عند النقر على هذا النص، سيتم مشاركته مرة أخرى في المحادثة كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا بين مجموعة شرائح الاقتراحات. 25 حرفًا بحد أقصى

StaticCanvasPrompt

يُمثِّل استجابة "لوحة الرسم التفاعلية" التي سيتم إرسالها إلى المستخدم. يمكن استخدام هذا الإجراء إلى جانب الحقل firstSimple في الطلب الذي يتضمّنه للتحدّث إلى المستخدم بالإضافة إلى عرض ردّ تفاعلي على لوحة الرسم.

تمثيل JSON
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "sendStateDataToCanvasApp": boolean,
  "enableFullScreen": boolean
}
الحقول
url

string

مطلوبة. عنوان URL لعرض الويب المطلوب تحميله.

data[]

value (Value format)

اختياريّ. بيانات JSON التي يتم تمريرها إلى صفحة الويب الخاصة بالتجربة الشاملة على أنّها فعالية إذا كان الحقل override في الطلب الذي يتضمّن الطلب هو false، ستتم إضافة قيم بيانات تم تحديدها في هذا الطلب إلى لوحة الرسم بعد قيم البيانات المحدّدة في طلبات لوحة الرسم السابقة.

suppressMic

boolean

اختياريّ. وتعني القيمة الحقيقية أنّه لن يتم فتح الميكروفون لالتقاط الإدخال بعد تقديم هذا الاستجابة الشاملة للمستخدم.

sendStateDataToCanvasApp

boolean

اختياريّ. إذا true، يتم تضمين البيانات الوصفية ذات الصلة بالمحادثة وإرسالها مرة أخرى إلى تطبيق لوحة الرسم.

enableFullScreen

boolean

اختياريّ. إذا كان true يشغل تطبيق لوحة الرسم ملء الشاشة ولا يحتوي على عنوان في الأعلى. ستظهر أيضًا رسالة نخب على شاشة التحميل تتضمّن الاسم المعروض للإجراء واسم مطوّر البرامج وتعليمات الخروج من الإجراء. القيمة التلقائية: false.

أجواء الإضاءة

المشهد هو الوحدة الأساسية لتدفق التحكم عند تصميم محادثة. يمكن ربطها مع مشاهد أخرى، وإنشاء مطالبات للمستخدم النهائي، وتحديد الخانات. يتم تحديد اسم المشهد في اسم الملف.

تمثيل JSON
{
  "onEnter": {
    object (EventHandler)
  },
  "intentEvents": [
    {
      object (IntentEvent)
    }
  ],
  "conditionalEvents": [
    {
      object (ConditionalEvent)
    }
  ],
  "slots": [
    {
      object (Slot)
    }
  ],
  "onSlotUpdated": {
    object (EventHandler)
  }
}
الحقول
onEnter

object (EventHandler)

المعالِج الذي يجب استدعاءه عند الانتقال إلى هذا المشهد.

intentEvents[]

object (IntentEvent)

قائمة الأحداث التي تبدأ استنادًا إلى الأغراض. ويمكن بدء هذه الأحداث في أي وقت بعد استدعاء معالج on_load. ملاحظة مهمّة: تحدّد هذه الأحداث مجموعة الأغراض التي تم تحديد نطاقها لهذا المشهد، وستحظى بالأولوية على أيّ أحداث محدّدة عالميًا تتضمّن الأغراض نفسها أو عباراتها التي تؤدّي إلى تشغيلها. يجب أن تكون أسماء الأغراض فريدة داخل المشهد.

conditionalEvents[]

object (ConditionalEvent)

قائمة الأحداث المطلوب بدؤها استنادًا إلى العبارات الشرطية. يتم تقييمها بعد ملء النموذج أو مباشرةً بعد on_load إذا لم يتوفّر نموذج لهذا المشهد (يتم إجراء التقييم مرة واحدة فقط). ولن يبدأ سوى أول حدث مطابق.

slots[]

object (Slot)

قائمة مرتبة من الخانات. تحدِّد كل خانة نوع البيانات التي سيتم حلّها وإعدادها لتخصيص تجربة استخدام درجة الدقة هذه (مثل الطلبات).

onSlotUpdated

object (EventHandler)

يتم استدعاء المعالج عند حدوث تغيير في حالة إحدى الخانات بسبب التحديثات داخل معالج آخر. يؤدي ذلك إلى إلغاء الخانات أو إلغاء صلاحية المشهد أو إجراء تغييرات أخرى على حالة المشهد.

IntentEvent

يعمل على تسجيل الأحداث التي تبدأ كنتيجة لمطابقة النية.

تمثيل JSON
{
  "intent": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
الحقول
intent

string

مطلوبة. الغرض من بدء الحدث

transitionToScene

string

اختياريّ. مشهد الوجهة الذي يجب أن تنتقل إليه المحادثة. لقد تدمرت حالة المشهد الحالي أثناء الانتقال.

handler

object (EventHandler)

اختياريّ. معالج الحدث الذي يتم تشغيله عند مطابقة الغرض. يجب التنفيذ قبل الانتقال إلى مشهد الوجهة. من المفيد إنشاء مطالبات استجابةً للأحداث.

ConditionalEvent

يسجِّل الأحداث التي يتم تشغيلها كنتيجة لشرط صحيح.

تمثيل JSON
{
  "condition": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
الحقول
condition

string

مطلوبة. شرط الفلتر لبدء هذا الحدث إذا تم تقييم الشرط على "صحيح"، سيتم تشغيل handler المرتبطة. المراجع المتغيّرة التالية متاحة: $session - للإشارة إلى البيانات في مساحة تخزين الجلسات. $user - للإشارة إلى البيانات في مساحة تخزين المستخدم تتوفر عوامل التشغيل المنطقية التالية (مع أمثلة): && - session.params.counter > 0 && session.params.counter < 100 || - session.params.foo == "John" || session.params.counter == "Adam" ! - !(session.params.counter == 5). المقارنات التالية متاحة: == و!= و< و> و<= و>= ويمكن استخدام عوامل تشغيل القائمة والسلسلة التالية (مع أمثلة): in - "Watermelon" في session.params.fruitList size - size(session.params.fruitList) > 2 substring {16session.params.fullName.contains("John")

transitionToScene

string

اختياريّ. مشهد الوجهة الذي يجب أن تنتقل إليه المحادثة عندما يتم تقييم الشرط المرتبط على "صحيح". لقد تدمرت حالة المشهد الحالي أثناء الانتقال.

handler

object (EventHandler)

اختياريّ. معالج الأحداث الذي يتم تشغيله عند تقييم الشرط المرتبط على true. يجب التنفيذ قبل الانتقال إلى مشهد الوجهة. يفيد إنشاء الطلبات استجابةً للأحداث.

الحيز

إعدادات لأحد الخانات. الشرائح عبارة عن وحدات فردية من البيانات يمكن ملؤها باللغة الطبيعية (أي معلّمات الأهداف) ومعلّمات الجلسات ومصادر أخرى.

تمثيل JSON
{
  "name": string,
  "type": {
    object (ClassReference)
  },
  "required": boolean,
  "promptSettings": {
    object (PromptSettings)
  },
  "commitBehavior": {
    object (CommitBehavior)
  },
  "config": value,
  "defaultValue": {
    object (DefaultValue)
  }
}
الحقول
name

string

مطلوبة. اسم الخانة.

type

object (ClassReference)

مطلوبة. لتحديد نوع بيانات هذه الخانة.

required

boolean

اختياريّ. تشير هذه السمة إلى ما إذا كان يجب ملء المساحة المتوفّرة قبل التقدّم. سيؤدي إدخال الخانات المطلوبة التي لم يتم ملؤها إلى إرسال إشعار قابل للتخصيص إلى المستخدم.

promptSettings

object (PromptSettings)

اختياريّ. لتسجيل المطالبات للمراحل المختلفة من ملء الخانات.

commitBehavior

object (CommitBehavior)

اختياريّ. السلوك المرتبط بالخانة

config

value (Value format)

اختياريّ. الإعدادات الإضافية المرتبطة بالخانة التي يتم استخدامها لملء الخانة. يكون تنسيق الإعداد خاصًا بنوع الخانة. يمكن إضافة مراجع الموارد إلى مَعلمة المستخدم أو الجلسة إلى هذه الإعدادات. هذه الإعدادات مطلوبة لملء الخانات ذات الصلة بالمعاملات وتفاعل المستخدمين.

مثال: بالنسبة إلى خانة من النوع actions.type.CompletePurchaseValue، تقترح الإعدادات التالية طلب شراء سلعة رقمية مع إشارة إلى مَعلمة جلسة من تحديد العميل userSelectedSkuId:

{ "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" } }

defaultValue

object (DefaultValue)

اختياريّ. إعدادات لتعبئة قيمة تلقائية لهذه الخانة

PromptSettings

مكان واحد يتم فيه تحديد طلبات الخانة

تمثيل JSON
{
  "initialPrompt": {
    object (EventHandler)
  },
  "noMatchPrompt1": {
    object (EventHandler)
  },
  "noMatchPrompt2": {
    object (EventHandler)
  },
  "noMatchFinalPrompt": {
    object (EventHandler)
  },
  "noInputPrompt1": {
    object (EventHandler)
  },
  "noInputPrompt2": {
    object (EventHandler)
  },
  "noInputFinalPrompt": {
    object (EventHandler)
  }
}
الحقول
initialPrompt

object (EventHandler)

مطالبة بقيمة الخانة نفسها مثال: "ما المقاس الذي تريده؟"

noMatchPrompt1

object (EventHandler)

طلب للعرض عندما لا يتطابق إدخال المستخدم مع نوع القيمة المتوقّعة للخانة للمرة الأولى مثال: "عذرًا، لم أفهم ذلك".

noMatchPrompt2

object (EventHandler)

طلب للعرض عندما لا يتطابق إدخال المستخدم مع نوع القيمة المتوقّعة للخانة للمرة الثانية. مثال: "عذرًا، لم أفهم ذلك".

noMatchFinalPrompt

object (EventHandler)

طلب للعرض عندما لا يتطابق إدخال المستخدم مع نوع القيمة المتوقّعة للخانة في المرة الأخيرة مثال: "عذرًا، لم أفهم ذلك".

noInputPrompt1

object (EventHandler)

مطالبة بإعطائه عندما لا يقدِّم المستخدم إدخالاً لأول مرة. مثال: "عذرًا، لم أفهم ذلك".

noInputPrompt2

object (EventHandler)

مطالبة بإعطائه عندما لا يقدِّم المستخدم إدخالاً للمرة الثانية. مثال: "عذرًا، لم أفهم ذلك".

noInputFinalPrompt

object (EventHandler)

مطالبة بإعطائه عندما لا يقدِّم المستخدم إدخالاً لآخر مرة. مثال: "عذرًا، لم أفهم ذلك".

CommitBehavior

رسالة تصف سلوك الإتمام المرتبط بالخانة بعد ملئها بنجاح.

تمثيل JSON
{
  "writeSessionParam": string
}
الحقول
writeSessionParam

string

معلمة الجلسة لكتابة قيمة الخانة بعد ملئها. يُرجى العلم أنّ المسارات المتداخلة غير متاحة حاليًا. يتم استخدام "$$" لكتابة قيمة الخانة إلى معلَمة جلسة لها اسم الخانة نفسه. على سبيل المثال: يتطابق writeSessionParam = "fruit" مع "$session.params.fruit". writeSessionParam = "ticket" يتجاوب مع "$session.params.ticket".

DefaultValue

إعدادات لتعبئة قيمة تلقائية لهذه الخانة

تمثيل JSON
{
  "sessionParam": string,
  "constant": value
}
الحقول
sessionParam

string

اختياريّ. معلمة الجلسة المراد استخدامها لإعداد قيمة الخانة، إذا كانت تتضمن قيمة غير فارغة. يجب أن يتطابق نوع القيمة مع نوع الخانة. يُرجى العلم أنّ المسارات المتداخلة غير متاحة حاليًا. على سبيل المثال: يتجاوب sessionParam = "fruit" مع $session.params.fruit. يتجاوب sessionParam = "ticket" مع $session.params.ticket.

constant

value (Value format)

اختياريّ. القيمة التلقائية الثابتة للخانة ولن يتم استخدام هذه السمة إلا إذا لم تتم تعبئة قيمة هذه الخانة من خلال sessionParam. يجب أن يتطابق نوع هذه القيمة مع نوع الخانة.

DataFiles

برنامج التفاف لملف البيانات المتكرر. لا يمكن أن توجد الحقول المتكررة في أحد الحقول.

تمثيل JSON
{
  "dataFiles": [
    {
      object (DataFile)
    }
  ]
}
الحقول
dataFiles[]

object (DataFile)

ملفات بيانات متعددة.

DataFile

يمثل هذا النوع ملفًا واحدًا يحتوي على بيانات غير مهيكلة. وتشمل الأمثلة ملفات الصور والملفات الصوتية ورمز مصدر دالة السحابة الإلكترونية.

تمثيل JSON
{
  "filePath": string,
  "contentType": string,
  "payload": string
}
الحقول
filePath

string

يشير ذلك المصطلح إلى المسار النسبي لملف البيانات من جذر المشروع في بنية ملف حزمة تطوير البرامج (SDK). مسارات الملفات المسموح بها: - الصور: resources/images/{multiple directories}?/{ImageName}.{extension} - الصوت: resources/audio/{multiple directories}?/{AudioFileName}.{extension} - رمز دالة السحابة الإلكترونية المضمّنة: webhooks/{WebhookName}.zip الإضافات المسموح بها: - الصور: png، jpg، jpeg - الصوت: mp3، mpeg - وظائف السحابة الإلكترونية المضمّنة: zip

contentType

string

مطلوبة. نوع محتوى مادة العرض هذه مثال: text/html يجب أن يتوافق نوع المحتوى مع المواصفات (http://www.w3.org/Protocols/rfc1341/4_Content-Type.html). يجب أن تكون وظائف السحابة الإلكترونية بتنسيق zip وأن يكون نوع المحتوى application/zip;zip_type=cloud_function. تشير المعلمة zip_type إلى أن الرمز البريدي مخصص لدالة سحابية.

payload

string (bytes format)

محتوى ملف البيانات. ومن الأمثلة على ذلك وحدات البايت الأولية للصور أو الملفات الصوتية أو تنسيق ZIP لدالة السحابة الإلكترونية. هناك حد أقصى لحجم حمولة البيانات يبلغ 10 ميغابايت.

سلسلة بترميز base64.