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

Wrapper برای فایل های پیکربندی مکرر. فیلدهای تکراری نمی توانند در یکی از آنها وجود داشته باشند.

نمایندگی JSON 
{
  "configFiles": [
    {
      object (ConfigFile)
    }
  ]
}
فیلدها
configFiles[]

object ( ConfigFile )

چندین فایل کانفیگ

ConfigFile

یک فایل واحد را نشان می دهد که حاوی داده های ساختاری است. توسعه دهندگان می توانند بیشتر پروژه خود را با استفاده از پیکربندی ساختاریافته از جمله Actions، Settings، Fulfillment تعریف کنند.

نمایندگی 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 )

پیکربندی تنظیمات منفرد که شامل تنظیمات غیر قابل محلی سازی و تنظیمات برای محلی پیش فرض پروژه (در صورت مشخص شدن) است. برای یک فایل لغو زبان، فقط فیلد تنظیمات محلی شده پر می شود. مسیرهای مجاز فایل: 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 ))

نقشه از intents تا اقدامات سفارشی برای پیکربندی فراخوان برای پروژه. مقاصد فراخوانی می‌توانند سیستم یا مقاصد سفارشی تعریف شده در بسته "custom/intents/" باشند. همه مقاصد تعریف شده در اینجا (مقصد سیستم و مقاصد سفارشی) باید یک فایل intent مربوطه در بسته "custom/global/" داشته باشند.

یک شی حاوی لیستی از "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

تنظیمات اعلان فشاری را که این تعامل پشتیبانی می‌کند، تعریف می‌کند.

به روز رسانی روزانه

تنظیمات به‌روزرسانی روزانه را که این تعامل از آن پشتیبانی می‌کند، تعریف می‌کند.

تنظیمات

تنظیماتی از یک پروژه Actions را نشان می دهد که مختص منطقه محلی نیست. برچسب بعدی: 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 مشخص نشده باشند، کاربران می توانند Actions شما را در همه مناطق فراخوانی کنند. هر منطقه با استفاده از نام متعارف اهداف جغرافیایی 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

آیا Actions می‌تواند از تراکنش‌ها استفاده کند (مثلاً رزرو، گرفتن سفارش و غیره). اگر نادرست باشد، تلاش برای استفاده از API های تراکنش ها شکست می خورد.

usesDigitalPurchaseApi

boolean

آیا Actions می‌تواند تراکنش‌هایی را برای کالاهای دیجیتال انجام دهد یا خیر.

usesInteractiveCanvas

boolean

آیا Actions از Canvas تعاملی استفاده می‌کند یا خیر.

usesHomeStorage

boolean

آیا Actions از ویژگی ذخیره‌سازی خانگی استفاده می‌کند یا خیر.

designedForFamily

boolean

اینکه آیا محتوای Actions برای خانواده طراحی شده است (DFF).

containsAlcoholOrTobaccoContent

boolean

آیا Actions حاوی محتوای مرتبط با الکل یا تنباکو است.

keepsMicOpen

boolean

اینکه آیا Actions ممکن است میکروفون را بدون درخواست صریح در طول مکالمه باز بگذارد یا خیر.

surfaceRequirements

object ( SurfaceRequirements )

الزامات سطحی که یک سطح مشتری باید برای فراخوانی Actions در این پروژه پشتیبانی کند.

testingInstructions

string

دستورالعمل‌های آزمایشی رایگان برای بازبین Actions (به عنوان مثال، دستورالعمل‌های پیوند حساب).

localizedSettings

object ( LocalizedSettings )

تنظیمات محلی برای محلی پیش فرض پروژه. هر محلی اضافی باید فایل تنظیمات خود را در دایرکتوری خود داشته باشد.

accountLinking

object ( AccountLinking )

به کاربران اجازه ایجاد یا پیوند حساب‌ها از طریق ورود به سیستم Google و/یا سرویس OAuth خود را بدهید.

selectedAndroidApps[]

string

برنامه‌های Android برای دسترسی به خریدهای Google Play برای تراکنش‌ها انتخاب شده‌اند. این مجموعه ای از برنامه های Android متصل به پروژه اقدامات است تا مالکیت برند را تأیید کند و ویژگی های اضافی را فعال کند. برای اطلاعات بیشتر به https://developers.google.com/assistant/console/brand-verification مراجعه کنید.

دسته بندی

انتخاب دسته برای یک پروژه اکشن.

Enums
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 دسته کنترل خانه.

سطح مورد نیاز

شامل مجموعه ای از الزامات است که سطح مشتری باید برای فراخوانی Actions در پروژه شما پشتیبانی کند.

نمایندگی JSON 
{
  "minimumRequirements": [
    {
      object (CapabilityRequirement)
    }
  ]
}
فیلدها
minimumRequirements[]

object ( CapabilityRequirement )

حداقل مجموعه ای از قابلیت های مورد نیاز برای فراخوانی Actions در پروژه شما. اگر سطح یکی از این موارد را نداشته باشد، Action فعال نخواهد شد.

نیاز به قابلیت

نشان دهنده یک نیاز در مورد در دسترس بودن یک قابلیت معین است.

نمایندگی JSON 
{
  "capability": enum (SurfaceCapability)
}
فیلدها
capability

enum ( SurfaceCapability )

نوع قابلیت.

SurfaceCapability

مجموعه ای از قابلیت های سطح ممکن است.

Enums
SURFACE_CAPABILITY_UNSPECIFIED ناشناخته / نامشخص
AUDIO_OUTPUT Surface از خروجی صدا پشتیبانی می کند.
SCREEN_OUTPUT Surface از صفحه نمایش/خروجی بصری پشتیبانی می کند.
MEDIA_RESPONSE_AUDIO Surface از صدای پاسخ رسانه ای پشتیبانی می کند.
WEB_BROWSER Surface از مرورگرهای وب پشتیبانی می کند.
ACCOUNT_LINKING Surface از پیوند حساب پشتیبانی می کند.
INTERACTIVE_CANVAS Surface از Canvas تعاملی پشتیبانی می کند.
HOME_STORAGE Surface از ذخیره سازی خانگی پشتیبانی می کند.

Localized Settings

تنظیمات یک پروژه Actions را نشان می دهد که مختص یک منطقه کاربر است. در این مثال کاربر به معنای کاربر نهایی است که Actions شما را فراخوانی می کند. این پیام قابل بومی سازی است.

نمایندگی 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

مورد نیاز. نام نمایشی پیش‌فرض برای این پروژه Actions (اگر ترجمه در دسترس نباشد)

pronunciation

string

مورد نیاز. تلفظ نام نمایشی برای فراخوانی آن در یک زمینه صوتی (گفتاری).

shortDescription

string

مورد نیاز. شرح کوتاه پیش‌فرض برای پروژه Actions (در صورت عدم وجود ترجمه). محدودیت 80 کاراکتر

fullDescription

string

مورد نیاز. شرح طولانی پیش‌فرض برای پروژه Actions (اگر ترجمه‌ای در دسترس نباشد). محدودیت 4000 کاراکتر

smallLogoImage

string

مورد نیاز. تصویر مربع کوچک، 192 x 192 پیکسل. این باید به عنوان یک مرجع به تصویر مربوطه در فهرست resources/images/ مشخص شود. به عنوان مثال، $resources.images.foo (بدون پسوند) برای تصویر در resources/images/foo.jpg هنگام کار بر روی پروژه ای که از کنسول کشیده شده است، می توان از URL مدیریت شده توسط Google استفاده کرد. آدرس‌های اینترنتی از منابع خارجی مجاز نیستند.

largeBannerImage

string

اختیاری. تصویر منظره بزرگ، 1920 x 1080 پیکسل. این باید به عنوان یک مرجع به تصویر مربوطه در فهرست resources/images/ مشخص شود. به عنوان مثال، $resources.images.foo (بدون پسوند) برای تصویر در resources/images/foo.jpg هنگام کار بر روی پروژه ای که از کنسول کشیده شده است، می توان از URL مدیریت شده توسط Google استفاده کرد. آدرس‌های اینترنتی از منابع خارجی مجاز نیستند.

developerName

string

مورد نیاز. نام توسعه دهنده که به کاربران نمایش داده می شود.

developerEmail

string

مورد نیاز. آدرس ایمیل تماس برای توسعه دهنده.

termsOfServiceUrl

string

اختیاری. URL شرایط خدمات.

voice

string

مورد نیاز. نوع صدای Google Assistant که کاربران هنگام تعامل با Actions شما می شنوند. مقادیر پشتیبانی شده عبارتند از: "male_1"، "male_2"، "female_1" و "female_2".

voiceLocale

string

اختیاری. محلی برای صدای مشخص شده. اگر مشخص نشده باشد، این مورد به منطقه دستیار کاربر حل می شود. اگر مشخص شده باشد، زبان محلی صدا باید همان زبان ریشه ای باشد که در LocalizedSettings مشخص شده است.

privacyPolicyUrl

string

مورد نیاز. URL خط مشی رازداری.

sampleInvocations[]

string

اختیاری. نمونه عبارات فراخوانی که به عنوان بخشی از توضیحات پروژه Actions شما در فهرست راهنمای Assistant نمایش داده می شود. این به کاربران کمک می کند تا نحوه استفاده از آن را بیاموزند.

themeCustomization

object ( ThemeCustomization )

اختیاری. سفارشی‌سازی تم برای اجزای بصری Actions شما.

سفارشی سازی تم

سبک های اعمال شده برای کارت هایی که به کاربران ارائه می شوند

نمایندگی JSON 
{
  "backgroundColor": string,
  "primaryColor": string,
  "fontFamily": string,
  "imageCornerStyle": enum (ImageCornerStyle),
  "landscapeBackgroundImage": string,
  "portraitBackgroundImage": string
}
فیلدها
backgroundColor

string

رنگ پس زمینه کارت ها اگر background_image توسط توسعه دهندگان ارائه نشده باشد یا background_image برای سطوح خاصی مناسب نباشد، به عنوان یک بک گراند عمل می کند. مثال استفاده: #فافافا

primaryColor

string

رنگ طرح زمینه اصلی Action برای تنظیم رنگ متن عنوان، رنگ پس‌زمینه مورد اقدام برای Actions در کارت‌های Google استفاده می‌شود. مثال استفاده: #فافافا

fontFamily

string

خانواده فونتی که برای عنوان کارت ها استفاده می شود. فونت های پشتیبانی شده: - Sans Serif - Sans Serif Medium - Sans Serif Bold - Sans Serif Black - Sans Serif Condensed - Sans Serif Condensed Medium - Serif - Serif Bold - Monospace - Cursive - Sans Serif Smallcaps

imageCornerStyle

enum ( ImageCornerStyle )

سبک حاشیه تصویر پیش زمینه کارت ها. به عنوان مثال، می تواند بر روی تصویر پیش زمینه یک کارت پایه یا کارت چرخ فلک اعمال شود.

landscapeBackgroundImage

string

حالت افقی (حداقل 1920x1200 پیکسل). این باید به عنوان یک مرجع به تصویر مربوطه در فهرست resources/images/ مشخص شود. به عنوان مثال: $resources.images.foo (بدون پسوند) برای تصویر در resources/images/foo.jpg هنگام کار بر روی پروژه ای که از کنسول کشیده شده است، می توان از URL مدیریت شده Google استفاده کرد.

portraitBackgroundImage

string

حالت پرتره (حداقل 1200x1920 پیکسل). این باید به عنوان یک مرجع به تصویر مربوطه در فهرست resources/images/ مشخص شود. به عنوان مثال: $resources.images.foo (بدون پسوند) برای تصویر در resources/images/foo.jpg هنگام کار بر روی پروژه ای که از کنسول کشیده شده است، می توان از URL مدیریت شده Google استفاده کرد.

ImageCornerStyle

شرح می دهد که چگونه مرزهای تصاویر باید ارائه شوند.

Enums
IMAGE_CORNER_STYLE_UNSPECIFIED تعریف نشده / نامشخص
CURVED گوشه گرد برای تصویر
ANGLED گوشه مستطیلی برای تصویر.

پیوند حساب

AccountLinking به Google اجازه می دهد تا کاربر را برای ورود به سرویس های وب برنامه راهنمایی کند.

برای انواع پیوند Google Sign In و OAuth + Google Sign In، Google یک شناسه سرویس گیرنده ایجاد می کند که برنامه شما را به Google شناسایی می کند («شناسه مشتری صادر شده توسط Google برای اقدامات شما» در رابط کاربری کنسول). این فیلد فقط خواندنی است و با رفتن به صفحه پیوند دادن حساب رابط کاربری Console قابل بررسی است. ببینید: 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 باشد، ایجاد حساب فقط در وب سایت شما مجاز است. اگر می خواهید شرایط خدمات خود را نمایش دهید یا رضایت کاربر را در حین ثبت نام دریافت کنید، این گزینه را انتخاب کنید. وقتی این false است، linkingType نمی‌تواند GOOGLE_SIGN_IN باشد. وقتی این true است linkingType نمی تواند OAUTH باشد.

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 Sign In تنظیم کنید. در صورت مشخص کردن این فیلد، مطمئن شوید که در اطلاعات دایرکتوری در بخش LocalizedSettings.terms_of_service_url، یک شرایط خدمات ارائه دهید.

useBasicAuthHeader

boolean

اختیاری. اگر درست است، به Google اجازه دهید شناسه مشتری و راز را از طریق سرصفحه احراز هویت اولیه HTTP ارسال کند. در غیر این صورت، گوگل از شناسه مشتری و راز داخل بدنه پست استفاده می کند. فقط هنگام استفاده از OAuth تنظیم شود. در صورت مشخص کردن این فیلد، مطمئن شوید که در اطلاعات دایرکتوری در بخش LocalizedSettings.terms_of_service_url، یک شرایط خدمات ارائه دهید.

LinkingType

نوع پیوند حساب برای انجام.

Enums
LINKING_TYPE_UNSPECIFIED نامشخص
GOOGLE_SIGN_IN نوع پیوند ورود به سیستم گوگل. در صورت استفاده از این نوع پیوند، نیازی به تنظیم فیلدهای مرتبط با OAuth در زیر نیست.
OAUTH_AND_GOOGLE_SIGN_IN نوع پیوند OAuth و Google Sign In.
OAUTH نوع پیوند OAuth.

AuthGrantType

نوع کمک مالی OAuth2 که Google برای راهنمایی کاربر برای ورود به سرویس وب برنامه شما استفاده می کند.

Enums
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 )

فراداده برای عملکرد ابری که از کد موجود در پوشه webhooks مستقر شده است.

هندلر

نام کنترل کننده webhoook را اعلام می کند. یک وب هوک می تواند چندین کنترل کننده ثبت شده داشته باشد. این کنترل کننده ها را می توان از چندین مکان در پروژه Actions شما فراخوانی کرد.

نمایندگی JSON 
{
  "name": string
}
فیلدها
name

string

مورد نیاز. نام کنترل کننده باید در بین همه کنترل‌کننده‌های پروژه Actions منحصربه‌فرد باشد. می توانید نام این کنترل کننده را بررسی کنید تا عملکرد صحیح را در کد منبع تکمیل خود فراخوانی کنید.

HttpsEndpoint

REST نقطه پایانی برای اطلاع در صورتی که از ویرایشگر درون خطی استفاده نمی کنید.

نمایندگی JSON 
{
  "baseUrl": string,
  "httpHeaders": {
    string: string,
    ...
  },
  "endpointApiVersion": integer
}
فیلدها
baseUrl

string

نشانی وب پایه HTTPS برای نقطه پایانی شما (HTTP پشتیبانی نمی‌شود). نام‌های Handler پس از دو نقطه به مسیر 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 درون خطی را که از پوشه webhooks مستقر شده نگه می دارد.

نمایندگی JSON 
{
  "executeFunction": string
}
فیلدها
executeFunction

string

نام نقطه ورودی Cloud Function. مقدار این فیلد باید با نام روش صادر شده از کد منبع مطابقت داشته باشد.

قصد

Intent ها ورودی کاربر با پایان باز را به اشیاء ساخت یافته ترسیم می کنند. عبارات گفتاری با اهداف با درک زبان طبیعی Google (NLU) مطابقت دارند. تطبیق‌های هدف می‌توانند رویدادهایی را در طراحی مکالمه شما برای پیشرفت مکالمه کاربر ایجاد کنند. نام intent در نام فایل مشخص شده است.

نمایندگی 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 'سان فرانسیسکو' 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 فیلد اتحادیه. نوع پارامتر intent. parameter_type تنها می تواند یکی از موارد زیر باشد:
type

object ( ClassReference )

اختیاری. نوع داده این پارامتر را اعلام می کند. این نباید برای مقاصد داخلی تنظیم شود.

entitySetReferences

object ( EntitySetReferences )

اختیاری. ارجاع به مجموعه‌های موجودیت‌های مجاز برای این پارامتر intent. فقط برای پارامترهای یک intent داخلی معتبر است. این ارجاعات به مجموعه‌های موجود در فهرست «custom/entitySets» اشاره می‌کنند.

مرجع کلاس

ارجاع به کلاسی که برای اعلام نوع فیلد یا مقدار بازگشتی استفاده می شود. Enum ها نیز نوعی کلاس هستند که می توان با استفاده از ClassReference به آنها ارجاع داد.

نمایندگی JSON 
{
  "name": string,
  "list": boolean
}
فیلدها
name

string

مورد نیاز. نام نوع داخلی یا نوع سفارشی پارامتر. مثال‌ها: PizzaToppings ، actions.type.Number

list

boolean

اختیاری. نشان می دهد که آیا نوع داده فهرستی از مقادیر را نشان می دهد یا خیر.

EntitySetReferences

ارجاعات مجموعه نهاد برای پارامتر intent.

نمایندگی JSON 
{
  "entitySetReferences": [
    {
      object (EntitySetReference)
    }
  ]
}
فیلدها
entitySetReferences[]

object ( EntitySetReference )

مورد نیاز. ارجاعات مجموعه نهاد برای پارامتر intent.

EntitySetReference

ارجاع به مجموعه موجودیت های مجاز برای این پارامتر intent.

نمایندگی JSON 
{
  "entitySet": string
}
فیلدها
entitySet

string

مورد نیاز. مجموعه خاصی از موجودیت ها را که باید برای یک پارامتر معین در نظر گرفته شوند، شناسایی می کند. تعریف مجموعه موجودیت مربوطه باید در پوشه custom/entitySets/ وجود داشته باشد.

تایپ کنید

اعلام نوع سفارشی، بر خلاف انواع داخلی. انواع را می توان به شکاف های یک صحنه یا پارامترهای عبارات آموزشی یک intent اختصاص داد. در عمل، Types را می توان به عنوان enum در نظر گرفت. توجه داشته باشید، نام نوع در نام فایل مشخص شده است.

نمایندگی 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 )

نوع مترادف، که در اصل یک enum است.

regularExpression

object ( RegularExpressionType )

نوع Regex، اجازه تطبیق عبارات منظم را می دهد.

freeText

object ( FreeTextType )

نوع متن آزاد

نوع مترادف

تایپی که متن را با مجموعه ای از مترادف ها مطابقت دارد.

نمایندگی 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 خواهد بود.

Enums
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

مورد نیاز. آدرس نماد.

RegularExpressionType

تایپ کنید که متن را با عبارات منظم مطابقت دهد. این پیام قابل بومی سازی است.

نمایندگی JSON 
{
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
فیلدها
entities

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

مورد نیاز. نقشه نام نهادهایی که هر کدام شامل رشته های Regex هستند.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

موجودیت

یک شیء موجود را نشان می دهد که حاوی عبارت منظم است که برای مقایسه استفاده می شود.

نمایندگی JSON 
{
  "display": {
    object (EntityDisplay)
  },
  "regularExpressions": [
    string
  ]
}
فیلدها
display

object ( EntityDisplay )

اختیاری. عناصری که پس از استخراج یک موجودیت از یک پرس و جو بر روی بوم نمایش داده می شوند. فقط مربوط به برنامه های بوم فعال است.

regularExpressions[]

string

مورد نیاز. از نحو regex RE2 استفاده می کند (برای جزئیات بیشتر به https://github.com/google/re2/wiki/Syntax مراجعه کنید)

FreeTextType

اگر بافت کلمات اطراف به نمونه های آموزشی ارائه شده نزدیک باشد، تایپ کنید که با هر متنی مطابقت داشته باشد.

نمایندگی JSON 
{
  "display": {
    object (EntityDisplay)
  }
}
فیلدها
display

object ( EntityDisplay )

اختیاری. عناصری که پس از استخراج یک موجودیت از یک پرس و جو بر روی بوم نمایش داده می شوند. فقط مربوط به برنامه های بوم فعال است.

EntitySet

مجموعه‌های موجودیت، مجموعه از پیش تعریف‌شده‌ای از موجودیت‌ها را توصیف می‌کنند که مقادیر پارامترهای intent داخلی می‌توانند از آن‌ها حاصل شوند. مجموعه های موجودیت را می توان از entitySet در پارامترهای intent داخلی ارجاع داد.

نمایندگی JSON 
{
  "entities": [
    {
      object (Entity)
    }
  ]
}
فیلدها
entities[]

object ( Entity )

مورد نیاز. لیست موجودیت هایی که مجموعه این نهاد پشتیبانی می کند.

موجودیت

موجودی که مقدار پارامتر intent داخلی می تواند از آن گرفته شود.

نمایندگی JSON 
{
  "id": string
}
فیلدها
id

string

مورد نیاز. شناسه نهاد. برای فهرستی از پارامترهای intent داخلی و موجودیت‌های پشتیبانی‌شده آنها، به https://developers.google.com/assistant/conversational/build/built-in-intents مراجعه کنید.

GlobalIntentEvent

یک کنترل کننده هدف جهانی را تعریف می کند. رویدادهای هدف جهانی در کل پروژه Action ها گنجانده شده است و ممکن است توسط کنترل کننده های هدف در یک صحنه لغو شوند. نام‌های هدف باید در یک پروژه Actions منحصربه‌فرد باشند.

اهداف کلی را می توان در هر زمان در طول یک جلسه مطابقت داد و به کاربران اجازه می دهد به جریان های رایج مانند "دریافت کمک" یا "بازگشت به خانه" دسترسی داشته باشند. آنها همچنین می توانند برای پیوند عمیق کاربران به جریان های خاص در هنگام فراخوانی یک Action استفاده شوند.

توجه داشته باشید که نام intent در نام فایل مشخص شده است.

نمایندگی JSON 
{
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
فیلدها
transitionToScene

string

اختیاری. صحنه مقصد که مکالمه باید به آن بپرد. وضعیت صحنه فعلی در مرحله گذار از بین می رود.

handler

object ( EventHandler )

اختیاری. کنترل کننده رویداد که هنگام مطابقت با هدف فعال می شود. باید قبل از انتقال به صحنه مقصد اجرا شود. برای تولید Prompt در پاسخ به رویدادها مفید است.

رویداد Handler

یک کنترل کننده را برای اجرا پس از یک رویداد تعریف می کند. نمونه‌هایی از رویدادها رویدادهای مبتنی بر قصد و شرط در یک صحنه هستند.

نمایندگی 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 )

مجموعه ای از قابلیت های سطح مورد نیاز.

قابلیت های سطحی

نمایانگر سطحی است که کاربر برای ارسال درخواست به Action از آن استفاده می کند.

نمایندگی JSON 
{
  "capabilities": [
    enum (Capability)
  ]
}
فیلدها
capabilities[]

enum ( Capability )

مورد نیاز. قابلیت های سطح درخواست به اکشن.

قابلیت

قابلیت هایی که سطح دستگاه در زمان درخواست پشتیبانی می کند.

Enums
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 ، الحاق به برخی از فیلدهای داخل فرمان های ساده، اعلان پیشنهادات و فرمان Canvas (بخشی از درخواست محتوا) را نیز فعال می کند. اگر در اعلان تعریف شده باشد، پیام‌های محتوا و پیوند همیشه بازنویسی می‌شوند. مقدار پیش فرض false است.

canvas

object ( StaticCanvasPrompt )

پاسخی که برای تجربه بوم تعاملی استفاده می شود.

StaticSimplePrompt

نشان دهنده یک اعلان ساده برای ارسال به کاربر است.

نمایندگی JSON 
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
فیلدها
variants[]

object ( Variant )

لیست انواع احتمالی

نوع

یک نوع را نشان می دهد که بخشی از دستور ساده است.

نمایندگی JSON 
{
  "speech": string,
  "text": string
}
فیلدها
speech

string

اختیاری. بیانگر گفتاری است که باید به کاربر گفته شود. می تواند SSML یا متن به گفتار باشد. به طور پیش‌فرض، گفتار به سخنرانی قبلی Simple Prompt اضافه می‌شود. اگر فیلد 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

مورد نیاز. متن اصلی کارت که مورد نیاز است مگر اینکه تصویر موجود باشد. از مجموعه محدودی از نحو نشانه گذاری برای قالب بندی پشتیبانی می کند.

image

object ( StaticImagePrompt )

اختیاری. تصویر قهرمان برای کارت. ارتفاع روی 192dp ثابت شده است.

imageFill

enum ( ImageFill )

اختیاری. پس زمینه تصویر چگونه پر می شود.

button

object ( StaticLinkPrompt )

اختیاری. یک دکمه قابل کلیک برای نمایش در کارت.

StaticImagePrompt

تصویری که در کارت نمایش داده می شود.

نمایندگی JSON 
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
فیلدها
url

string

مورد نیاز. آدرس منبع تصویر تصاویر می توانند JPG، PNG و GIF (متحرک و غیر متحرک) باشند. برای مثال، https://www.agentx.com/logo.png .

alt

string

مورد نیاز. شرح متنی از تصویر که برای دسترسی استفاده می شود، به عنوان مثال صفحه خوان.

height

integer

اختیاری. ارتفاع تصویر بر حسب پیکسل

width

integer

اختیاری. عرض تصویر بر حسب پیکسل

ImageFill

گزینه های نمایش تصویر ممکن برای تأثیرگذاری بر ارائه تصویر. این باید برای زمانی استفاده شود که نسبت تصویر با نسبت تصویر ظرف تصویر مطابقت نداشته باشد.

Enums
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 که می تواند یکی از این موارد باشد: - آدرس های http/https برای باز کردن یک برنامه مرتبط با برنامه یا یک صفحه وب

hint

enum ( UrlHint )

یک اشاره برای نوع URL را نشان می دهد.

UrlHint

انواع مختلف راهنمایی url.

Enums
HINT_UNSPECIFIED نامشخص
AMP نشانی اینترنتی که مستقیماً به محتوای AMP یا یک URL متعارف اشاره می کند که از طریق <link rel="amphtml"> به محتوای AMP اشاره می کند.

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 )

اختیاری. دکمه.

ستون جدول

ستونی را در جدول توصیف می کند.

نمایندگی JSON 
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
فیلدها
header

string

متن سرصفحه برای ستون.

align

enum ( HorizontalAlignment )

تراز افقی ستون wrt محتوا. اگر نامشخص باشد ، محتوا با لبه پیشرو تراز می شود.

افقی

تراز محتوای درون سلول.

Enums
UNSPECIFIED نامشخص افقی.
LEADING لبه پیشرو سلول. این پیش فرض است.
CENTER محتوا با مرکز ستون تراز می شود.
TRAILING محتوا با لبه دنباله ستون تراز شده است.

تابه

یک ردیف در جدول را توصیف می کند.

نمایندگی JSON 
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
فیلدها
cells[]

object ( TableCell )

سلولهای این ردیف. 3 سلول اول تضمین شده است که نشان داده می شوند اما برخی دیگر ممکن است بر روی سطوح خاص برش داده شوند. لطفاً با شبیه ساز تست کنید تا ببینید کدام سلول برای یک سطح معین نشان داده می شود.

divider

boolean

نشان می دهد که آیا بعد از هر ردیف باید یک تقسیم کننده وجود داشته باشد.

سفره سفالی

یک سلول را در یک ردیف توصیف می کند.

نمایندگی JSON 
{
  "text": string
}
فیلدها
text

string

محتوای متن سلول.

استاتیکدیمیاپرومپ

حاوی اطلاعاتی در مورد رسانه ها ، مانند نام ، توضیحات ، 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 )

حالت را برای لیست اشیاء رسانه ای تکرار کنید.

واسطه

نوع رسانه این پاسخ.

Enums
MEDIA_TYPE_UNSPECIFIED مقدار نامشخص
AUDIO پرونده صوتی
MEDIA_STATUS_ACK پاسخ به تأیید گزارش وضعیت رسانه ای.

OptionalMediAcontrols

انواع کنترل رسانه ها پاسخ رسانه می تواند به صورت اختیاری پشتیبانی کند

Enums
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED مقدار نامشخص
PAUSED رویداد مکث هنگامی که کاربر رسانه را مکث می کند ، شروع می شود.
STOPPED رویداد متوقف شد هنگامی که کاربر از جلسه 3p در طول بازی رسانه خارج می شود ، شروع می شود.

رسانه ها

یک شیء رسانه ای واحد را نشان می دهد.

نمایندگی JSON 
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
فیلدها
name

string

نام این شیء رسانه ای.

description

string

شرح این شیء رسانه ای.

url

string

URL که به محتوای رسانه اشاره می کند.

image

object ( 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 dp است.

تکرار

انواع حالت تکرار برای لیستی از اشیاء رسانه ای.

Enums
REPEAT_MODE_UNSPECIFIED معادل خاموش
OFF جلسه رسانه ای پایان در پایان آخرین شیء رسانه.
ALL هنگام رسیدن به پایان آخرین شیء رسانه ، به ابتدای اولین شیء رسانه ای حلقه بزنید.

staticlistprompt

کارت برای ارائه لیستی از گزینه ها برای انتخاب.

نمایندگی JSON 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
فیلدها
title

string

اختیاری. عنوان لیست.

subtitle

string

اختیاری. زیرنویس لیست.

items[]

object ( ListItem )

مورد نیاز. لیست موارد.

List Item

یک مورد در لیست.

نمایندگی 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 )

اختیاری. گزینه نمایش تصویر.

مجموعه

یک مورد در مجموعه.

نمایندگی 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 )

گزینه نمایش تصویر برای تصاویر در مجموعه.

مجموعه

مورد در مجموعه.

نمایندگی 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 برای باز کردن.

پیشنهاد

یک تراشه پیشنهادی را نشان می دهد ، یک عنصر UI برای راحتی به کاربر نشان داده شده است.

نمایندگی 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

اختیاری. یک مقدار واقعی بدان معنی است که پس از ارائه این پاسخ همهجانبه به کاربر ، MIC برای گرفتن ورودی باز نمی شود.

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 )

Handler برای استناد به هنگام انتقال به این صحنه.

intentEvents[]

object ( IntentEvent )

فهرست رویدادهایی که بر اساس مقاصد راه‌اندازی می‌شوند. این رویدادها می توانند در هر زمانی پس از فراخوانی On_load Handler فعال شوند. مهم - این وقایع مجموعه ای از اهداف را که در این صحنه قرار گرفته اند تعریف می کنند و بر هر رویدادی تعریف شده در سطح جهانی که دارای یک هدف یا عبارات تحریک کننده آنها هستند ، اولویت دارند. نام های قصد باید در یک صحنه بی نظیر باشند.

conditionalEvents[]

object ( ConditionalEvent )

فهرست رویدادهایی که باید بر اساس عبارات شرطی فعال شوند. اگر این صحنه فرم نداشته باشد ، اینها پس از پر شدن فرم یا بلافاصله پس از on_load ارزیابی می شوند (ارزیابی فقط یک بار انجام می شود). فقط اولین رویداد منطبق فعال خواهد شد.

slots[]

object ( Slot )

لیست سفارش داده شده اسلات. هر شکاف نوع داده ای را که حل می کند و پیکربندی می کند تا تجربه این وضوح را سفارشی کند (مثلاً درخواست ها) را مشخص می کند.

onSlotUpdated

object ( EventHandler )

هنگامی که تغییری در وضعیت یک اسلات ایجاد می شود که به دلیل به روز رسانی در Handler دیگر ایجاد نمی شود، Handler تماس می گیرد. این اجازه می دهد تا شکاف ها باطل شوند ، صحنه بی اعتبار یا تغییرات دیگری در حالت صحنه است.

در معرض دید

رویدادهایی را ثبت می کند که به عنوان نتیجه یک مسابقه هدف ایجاد می شود.

نمایندگی JSON 
{
  "intent": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
فیلدها
intent

string

مورد نیاز. قصد ایجاد این رویداد.

transitionToScene

string

اختیاری. صحنه مقصد که مکالمه باید به آن پرش کند. وضعیت صحنه فعلی در هنگام انتقال از بین می رود.

handler

object ( EventHandler )

اختیاری. کنترل کننده رویداد که هنگام همسان شدن هدف انجام می شود. باید قبل از انتقال به صحنه مقصد اجرا شود. مفید برای تولید درخواست در پاسخ به وقایع.

بدنام

رویدادهایی را که در نتیجه یک شرط واقعی ایجاد می کنند ، ثبت می کند.

نمایندگی JSON 
{
  "condition": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
فیلدها
condition

string

مورد نیاز. شرایط فیلتر برای این رویداد. اگر شرط به درست ارزیابی شود ، handler مرتبط با آن ایجاد می شود. منابع متغیر زیر پشتیبانی می شوند: $session - برای داده های مرجع در ذخیره جلسه. $user - به داده های مرجع در ذخیره کاربر. اپراتورهای Boolean زیر پشتیبانی می شوند (با مثال): && - session.params.counter > 0 && session.params.counter < 100 || - session.params.foo == "John" || session.params.counter == "Adam" ! - !(session.params.counter == 5) مقایسه های زیر پشتیبانی می شوند: == ، != ، < ، > ، <= ، >= لیست زیر و اپراتورهای رشته ای پشتیبانی می شوند (با مثال): in - "هندوانه" "در session.params.fruitList size - size(session.params.fruitList) > 2 substring - session.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 )

هنگامی که کاربر برای آخرین بار ورودی ارائه نمی کند، درخواست دهید. مثال: "ببخشید، متوجه نشدم."

رفتار متعهد

پیامی که رفتار commit مرتبط با اسلات را پس از پر شدن موفقیت آمیز توصیف می کند.

نمایندگی JSON 
{
  "writeSessionParam": string
}
فیلدها
writeSessionParam

string

پارامتر جلسه برای نوشتن مقدار اسلات پس از پر شدن. توجه داشته باشید که مسیرهای تودرتو در حال حاضر پشتیبانی نمی شوند. "$$" برای نوشتن مقدار اسلات در پارامتر جلسه با همان نام اسلات استفاده می شود. به عنوان مثال: writeSessionParam = "میوه" با "$session.params.fruit" مطابقت دارد. writeSessionParam = "بلیت" با "$session.params.ticket" مطابقت دارد.

مقدار پیش فرض

پیکربندی برای پر کردن یک مقدار پیش‌فرض برای این اسلات.

نمایندگی JSON 
{
  "sessionParam": string,
  "constant": value
}
فیلدها
sessionParam

string

اختیاری. پارامتر جلسه ای که برای مقداردهی اولیه اسلات استفاده می شود، اگر مقدار غیر خالی داشته باشد. نوع مقدار باید با نوع شکاف مطابقت داشته باشد. توجه داشته باشید که مسیرهای تودرتو در حال حاضر پشتیبانی نمی شوند. به عنوان مثال: sessionParam = "fruit" با $session.params.fruit مطابقت دارد. sessionParam = "ticket" با $session.params.ticket مطابقت دارد.

constant

value ( Value format)

اختیاری. مقدار پیش فرض ثابت برای شکاف. این فقط در صورتی استفاده خواهد شد که مقداری برای این اسلات از طریق sessionParam پر نشده باشد. نوع این مقدار باید با نوع شکاف مطابقت داشته باشد.

داده های

بسته بندی برای پرونده داده های مکرر. زمینه های مکرر نمی توانند در یک مورد وجود داشته باشند.

نمایندگی 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 - AUDIO: mp3 ، mpeg - توابع ابر Inline: 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.