- درخواست HTTP
- درخواست بدن
- بدن پاسخگو
- گرداننده
- قصد
- IntentParameterValue
- صحنه
- SlotFillingStatus
- اسلات
- حالت اسلات
- وضعیت اسلات
- اعلان
- ساده
- محتوا
- کارت
- تصویر
- ImageFill
- پیوند
- OpenUrl
- UrlHint
- جدول
- ستون جدول
- تراز افقی
- TableRow
- TableCell
- رسانه ها
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- RepeatMode
- مجموعه
- مجموعه آیتم
- فهرست کنید
- List Item
- مجموعه مرور
- مورد
- پیشنهاد
- بوم
- ContinuousMatchConfig
- عبارت مورد انتظار
- سفارش به روز رسانی
- تایپ کنید
- سفارش دهید
- UserInfo
- شماره تلفن
- تصویر
- بازرگان
- مکان
- LatLng
- آدرس پستی
- مطالب
- آیتم خط
- قیمت ویژگی
- تایپ کنید
- ایالت
- پول
- اقدام
- تایپ کنید
- OpenUrlAction
- برنامه اندروید
- نسخه فیلتر
- UrlTypeHint
- ActionMetadata
- افشای
- DisclosureText
- TextLink
- DisclosurePresentationOptions
- الزامات ارائه
- PurchaseItem Extension
- وضعیت خرید
- نوع خرید
- MerchantUnitMeasure
- واحد
- PurchaseReturnsInfo
- PurchaseFulfillmentInfo
- تایپ کنید
- زمان
- اطلاعات پیکاپ
- نوع پیکاپ
- CurbsideInfo
- CurbsideFulfillmentType
- وسیله نقلیه
- CheckInInfo
- CheckInType
- گزینه آیتم
- جزئیات محصول
- ReservationItem Extension
- وضعیت رزرو
- نوع رزرو
- کارمندان تسهیل کننده
- داده های پرداخت
- نتیجه پرداخت
- PaymentInfo
- PaymentMethodDisplayInfo
- نوع پرداخت
- روش پرداخت
- ارتقاء
- PurchaseOrder Extension
- PurchaseLocationType
- خطای خرید
- نوع خطا
- TicketOrder Extension
- TicketEvent
- تایپ کنید
- شخصیت رویداد
- تایپ کنید
- User Notification
- صحنه بعدی
- جلسه
- TypeOverride
- TypeOverrideMode
- نوع مترادف
- ورود
- EntryDisplay
- کاربر
- وضعیت پیوند حساب
- UserVerificationStatus
- نامزدی
- IntentSubscription
- حقوق بسته
- استحقاق
- SkuType
- SignedData
- اجازه
- صفحه اصلی
- دستگاه
- قابلیت
- مکان
- منطقه زمانی
- زمینه
- MediaContext
- CanvasContext
- مورد انتظار
RPC که نشان دهنده API تحقق است
درخواست HTTP
POST https://webhook_handler_service.googleapis.com/fulfill
URL از دستور GRPC Transcoding استفاده می کند.
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON | |
---|---|
{ "handler": { object ( |
فیلدها | |
---|---|
handler | مورد نیاز. اطلاعاتی در مورد نحوه رسیدگی به درخواست. به عنوان مثال درخواستی که قصد دریافت یک واقعیت را دارد ممکن است دارای یک کنترل کننده با نام "getFact" باشد. |
intent | مورد نیاز. نشان دهنده آخرین هدف منطبق است. به https://developers.google.com/assistant/conversational/intents مراجعه کنید. |
scene | اختیاری. اطلاعات صحنه فعلی و بعدی هنگام فراخوانی تابع. زمانی که فراخوان تکمیل در محدوده یک صحنه انجام شود پر می شود. به https://developers.google.com/assistant/conversational/scenes مراجعه کنید. |
session | مورد نیاز. داده های جلسه مانند شناسه جلسه و پارامترهای جلسه را نگه می دارد. |
user | مورد نیاز. کاربری که مکالمه را آغاز کرده است. |
home | اختیاری. اطلاعات مربوط به ساختار HomeGraph که دستگاه مورد نظر به آن تعلق دارد. به https://developers.google.com/actions/smarthome/concepts/homegraph مراجعه کنید. |
device | مورد نیاز. اطلاعات دستگاهی که کاربر برای تعامل با Action استفاده می کند. |
context | اختیاری. اطلاعات زمینه فعلی درخواست شامل، اما به اطلاعات جلسه رسانه فعال یا اطلاعات بوم محدود نمی شود. |
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نشان دهنده پاسخی است که از اجرای برنامهنویس به Actions on Google ارسال شده است.
نمایندگی JSON | |
---|---|
{ "prompt": { object ( |
فیلدها | |
---|---|
prompt | اختیاری. نشاندهنده درخواستهایی است که باید برای کاربر ارسال شود، این اعلانها به پیامهای اضافهشده قبلی اضافه میشوند، مگر اینکه به صراحت بازنویسی شوند. |
scene | اختیاری. نمایانگر صحنه فعلی و بعدی است. اگر |
session | اختیاری. دادههای جلسه جاری را توصیف میکند، پارامترهای جلسه را میتوان ایجاد، بهروزرسانی یا حذف کرد. |
user | اختیاری. برای تعیین پارامترهای کاربر برای ارسال مجدد استفاده کنید. |
home | اختیاری. برای تعیین پارامترهای مربوط به ساختار HomeGraph که دستگاه مورد نظر به آن تعلق دارد استفاده می شود. به https://developers.google.com/actions/smarthome/concepts/homegraph مراجعه کنید. |
device | اختیاری. برای جابهجایی بین دستگاههای «دستیار» که کاربر به آنها دسترسی دارد، استفاده کنید. |
expected | اختیاری. انتظارات برای نوبت گفتگوی بعدی را شرح می دهد. |
گرداننده
نشاندهنده یک کنترلکننده انجام است که اطلاعات رویداد را از Actions on Google به انجام نگاشت میکند. از نام کنترل کننده برای تعیین کدی که باید اجرا کنید استفاده کنید. به عنوان مثال، یک کنترل کننده ممکن است برای دریافت اطلاعات در مورد اطلاعات سفارش کاربر با نام کنترل کننده مانند "OrderLookup" استفاده شود، در حالی که دیگری ممکن است اطلاعات محصول را از یک پایگاه داده، با نام کنترل کننده مانند "GetProductInfo" دریافت کند.
نمایندگی JSON | |
---|---|
{ "name": string } |
فیلدها | |
---|---|
name | اختیاری. نام کنترل کننده. |
قصد
نشان دهنده یک قصد است. به https://developers.google.com/assistant/conversational/intents مراجعه کنید.
نمایندگی JSON | |
---|---|
{
"name": string,
"params": {
string: {
object ( |
فیلدها | |
---|---|
name | مورد نیاز. نام آخرین هدف منطبق. |
params | مورد نیاز. پارامترهای شناسایی شده به عنوان بخشی از تطبیق قصد را نشان می دهد. این نقشه ای از نام پارامتر شناسایی شده به مقدار پارامتر شناسایی شده از ورودی کاربر است. تمام پارامترهای تعریف شده در هدف منطبق که شناسایی شده اند در اینجا ظاهر می شوند. یک شی حاوی لیستی از |
query | اختیاری. ورودی تایپ شده یا گفتاری از کاربر نهایی که با این هدف مطابقت دارد. بر اساس ورودی کاربر، زمانی که یک intent مطابقت داده می شود، پر می شود. |
IntentParameterValue
مقداری را برای پارامتر intent نشان می دهد. به https://developers.google.com/assistant/conversational/types مراجعه کنید.
نمایندگی JSON | |
---|---|
{ "original": string, "resolved": value } |
فیلدها | |
---|---|
original | مورد نیاز. مقدار متن اصلی استخراج شده از گفته کاربر. |
resolved | مورد نیاز. مقدار ساختاریافته برای پارامتر استخراج شده از ورودی کاربر. این فقط در صورتی پر می شود که پارامتر در هدف منطبق تعریف شده باشد و مقدار پارامتر در طول تطبیق قصد شناسایی شود. |
صحنه
نمایش یک صحنه صحنه ها می توانند تکمیل را فراخوانی کنند، اعلان اضافه کنند، و مقادیر اسلات را از کاربر جمع آوری کنند. صحنه ها توسط رویدادها یا مقاصد تحریک می شوند و می توانند رویدادها را تحریک کنند و اهداف را با انتقال به صحنه های دیگر مطابقت دهند.
نمایندگی JSON | |
---|---|
{ "name": string, "slotFillingStatus": enum ( |
فیلدها | |
---|---|
name | مورد نیاز. نام صحنه فعلی |
slotFillingStatus | مورد نیاز. وضعیت فعلی پر کردن اسلات. این فیلد فقط خواندنی است. |
slots | شکاف های مرتبط با صحنه فعلی. پاسخ های کنترل کننده نمی توانند اسلات هایی را که در درخواست ارسال نشده اند برگردانند. یک شی حاوی لیستی از |
next | اختیاری. اطلاعات مربوط به صحنه در مرحله بعدی اجرا می شود. |
SlotFillingStatus
وضعیت فعلی پر شدن اسلات را نشان می دهد.
Enums | |
---|---|
UNSPECIFIED | مقدار بازگشتی زمانی که فیلد استفاده پر نشده باشد. |
INITIALIZED | شکاف ها مقداردهی اولیه شده اند اما پر کردن شکاف شروع نشده است. |
COLLECTING | مقادیر اسلات در حال جمع آوری هستند. |
FINAL | همه مقادیر اسلات نهایی هستند و قابل تغییر نیستند. |
اسلات
نشان دهنده یک اسلات است.
نمایندگی JSON | |
---|---|
{ "mode": enum ( |
فیلدها | |
---|---|
mode | حالت اسلات (الزامی یا اختیاری). می تواند توسط توسعه دهنده تنظیم شود. |
status | وضعیت اسلات. |
value | ارزش شکاف. با تغییر این مقدار در پاسخ، مقدار در پر کردن شکاف تغییر خواهد کرد. |
updated | نشان می دهد که آیا مقدار اسلات در آخرین پیچ جمع آوری شده است یا خیر. این فیلد فقط خواندنی است. |
prompt | اختیاری. این درخواست در صورت نیاز برای پر کردن یک اسلات مورد نیاز برای کاربر ارسال می شود. این اعلان اعلان موجود تعریف شده در کنسول را لغو می کند. این فیلد در درخواست webhook گنجانده نشده است. |
حالت اسلات
حالت یک اسلات را نشان می دهد، یعنی اینکه آیا لازم است یا نه.
Enums | |
---|---|
MODE_UNSPECIFIED | مقدار بازگشتی زمانی که فیلد استفاده پر نشده باشد. |
OPTIONAL | نشان می دهد که شکاف برای تکمیل پر کردن شکاف مورد نیاز نیست. |
REQUIRED | نشان می دهد که شکاف برای تکمیل پر کردن شکاف مورد نیاز است. |
وضعیت اسلات
وضعیت یک اسلات را نشان می دهد.
Enums | |
---|---|
SLOT_UNSPECIFIED | مقدار بازگشتی زمانی که فیلد استفاده پر نشده باشد. |
EMPTY | نشان می دهد که اسلات هیچ مقداری ندارد. این وضعیت را نمی توان از طریق پاسخ تغییر داد. |
INVALID | نشان می دهد که مقدار اسلات نامعتبر است. این وضعیت را می توان از طریق پاسخ تنظیم کرد. |
FILLED | نشان می دهد که شکاف دارای یک مقدار است. این وضعیت را نمی توان از طریق پاسخ تغییر داد. |
اعلان
نشان دادن پاسخ به یک کاربر به https://developers.google.com/assistant/conversational/prompts مراجعه کنید.
نمایندگی JSON | |
---|---|
{ "override": boolean, "firstSimple": { object ( |
فیلدها | |
---|---|
override | اختیاری. حالت نحوه ادغام این پیامها با پیامهای تعریفشده قبلی. "true" تمام پیام های تعریف شده قبلی (اولین و آخرین ساده، محتوا، پیوند پیشنهادات و بوم) را پاک می کند و پیام های تعریف شده در این اعلان را اضافه می کند. "false" پیام های تعریف شده در این اعلان را به پیام های تعریف شده در پاسخ های قبلی اضافه می کند. رها کردن این فیلد روی "نادرست" همچنین افزودن به برخی از فیلدهای داخل فرمان های ساده، اعلان پیشنهادات و اعلان Canvas (بخشی از اعلان محتوا) را امکان پذیر می کند. اگر در اعلان تعریف شده باشد، پیامهای محتوا و پیوند همیشه بازنویسی میشوند. مقدار پیش فرض "نادرست" است. |
firstSimple | اختیاری. اولین پاسخ صوتی و متنی. |
content | اختیاری. محتوایی مانند کارت، فهرست یا رسانه برای نمایش به کاربر. |
lastSimple | اختیاری. آخرین پاسخ صوتی و متنی. |
suggestions[] | اختیاری. پیشنهاداتی برای نمایش به کاربر که همیشه در انتهای پاسخ ظاهر می شوند. اگر فیلد «نسخ» در فرمان حاوی «نادرست» باشد، عناوین تعریفشده در این قسمت به عناوین تعریفشده در هر فرمان پیشنهادی تعریفشده قبلی اضافه میشوند و مقادیر تکراری حذف میشوند. |
link | اختیاری. یک تراشه پیشنهادی اضافی که میتواند به برنامه یا سایت مرتبط پیوند دهد. تراشه با عنوان "باز (نام)" ارائه می شود. حداکثر 20 کاراکتر |
canvas | اختیاری. نشان دهنده یک پاسخ بوم تعاملی برای ارسال به کاربر است. |
orderUpdate | اقدام اختیاری پس از دریافت سفارش در جریان تراکنش، با OrderUpdate پاسخ می دهد. پس از دریافت این، Google این بهروزرسانی را در سفارش ثبت میکند و در صورت موفقیتآمیز، یک کارت رسید را به همراه TTS ارسال شده روی دستگاههای نمایشگر نمایش میدهد. |
ساده
نشان دهنده یک اعلان ساده برای ارسال به کاربر است. به https://developers.google.com/assistant/conversational/prompts-simple مراجعه کنید.
نمایندگی JSON | |
---|---|
{ "speech": string, "text": string } |
فیلدها | |
---|---|
speech | اختیاری. بیانگر گفتاری است که باید به کاربر گفته شود. می تواند SSML یا متن به گفتار باشد. اگر قسمت "override" در دستور حاوی "true" باشد، گفتار تعریف شده در این قسمت جایگزین گفتار Simple prompt قبلی می شود. به https://developers.google.com/assistant/conversational/ssml مراجعه کنید. |
text | متن اختیاری برای نمایش در حباب چت. در صورت عدم ارائه، یک نمایش نمایشی از قسمت گفتار بالا استفاده خواهد شد. محدود به 640 کاراکتر. اگر فیلد «override» در اعلان حاوی «true» باشد، متن تعریف شده در این قسمت جایگزین متن دستور Simple قبلی می شود. |
محتوا
شی کانتینر برای درخواستهای غنی یا درخواستهای انتخاب.
نمایندگی JSON | |
---|---|
{ // Union field |
فیلدها | ||
---|---|---|
| ||
card | یک کارت پایه | |
image | یک تصویر | |
table | کارت جدول. | |
media | پاسخ نشاندهنده مجموعهای از رسانهها برای پخش. | |
collection | کارتی که مجموعه ای از گزینه ها را برای انتخاب ارائه می دهد. | |
list | کارتی که فهرستی از گزینه ها را برای انتخاب ارائه می دهد. | |
collectionBrowse | کارتی که مجموعه ای از صفحات وب را برای باز کردن ارائه می دهد. |
کارت
یک کارت اصلی برای نمایش برخی از اطلاعات، به عنوان مثال یک تصویر و/یا متن. به https://developers.google.com/assistant/conversational/prompts-rich#basic_card مراجعه کنید.
نمایندگی JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
فیلدها | |
---|---|
title | عنوان کلی کارت اختیاری. |
subtitle | اختیاری. |
text | متن متن کارت از مجموعه محدودی از نحو نشانه گذاری برای قالب بندی پشتیبانی می کند. الزامی است، مگر اینکه تصویر موجود باشد. |
image | تصویر قهرمان برای کارت. ارتفاع روی 192dp ثابت شده است. اختیاری. |
imageFill | پس زمینه تصویر چگونه پر می شود. اختیاری. |
button | دکمه با لینک خروجی. اختیاری. |
تصویر
تصویری که در کارت نمایش داده می شود. به https://developers.google.com/assistant/conversational/prompts-rich#image-cards مراجعه کنید.
نمایندگی JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
فیلدها | |
---|---|
url | آدرس منبع تصویر تصاویر می توانند JPG، PNG و GIF (متحرک و غیر متحرک) باشند. برای مثال، |
alt | شرح متنی از تصویر که برای دسترسی استفاده می شود، به عنوان مثال صفحه خوان. مورد نیاز. |
height | ارتفاع تصویر بر حسب پیکسل اختیاری. |
width | عرض تصویر بر حسب پیکسل اختیاری. |
ImageFill
گزینه های نمایش تصویر ممکن برای تأثیرگذاری بر ارائه تصویر. این باید برای زمانی استفاده شود که نسبت تصویر با نسبت تصویر ظرف تصویر مطابقت نداشته باشد.
Enums | |
---|---|
UNSPECIFIED | |
GRAY | شکاف بین تصویر و محفظه تصویر را با نوارهای خاکستری پر کنید. |
WHITE | شکاف بین تصویر و محفظه تصویر را با نوارهای سفید پر کنید. |
CROPPED | تصویر به گونه ای مقیاس بندی می شود که عرض و ارتفاع تصویر با ابعاد ظرف مطابقت داشته باشد یا بیشتر از آن باشد. اگر ارتفاع تصویر کوچکشده بیشتر از ارتفاع ظرف باشد، ممکن است بالا و پایین تصویر را برش دهد، یا اگر عرض تصویر مقیاسشده از عرض ظرف بیشتر باشد، سمت چپ و راست تصویر را برش دهد. این شبیه به "حالت زوم" در تلویزیون با صفحه عریض هنگام پخش یک ویدیوی 4:3 است. |
پیوند
یک تراشه پیشنهادی اضافی که میتواند به برنامه یا سایت مرتبط پیوند دهد. تراشه با عنوان "باز (نام)" ارائه می شود.
نمایندگی JSON | |
---|---|
{
"name": string,
"open": {
object ( |
فیلدها | |
---|---|
name | نام لینک. حداکثر 20 کاراکتر |
open | وقتی کاربر لینک را باز می کند چه اتفاقی می افتد |
OpenUrl
نمایندگی JSON | |
---|---|
{
"url": string,
"hint": enum ( |
فیلدها | |
---|---|
url | فیلد url که می تواند یکی از این موارد باشد: - آدرس های http/https برای باز کردن یک برنامه مرتبط با برنامه یا یک صفحه وب |
hint | یک اشاره برای نوع URL را نشان می دهد. |
UrlHint
انواع مختلف راهنمایی url.
Enums | |
---|---|
LINK_UNSPECIFIED | نامشخص |
AMP | URL که مستقیماً به محتوای AMP یا یک URL متعارف اشاره می کند که از طریق آن به محتوای AMP اشاره دارد . به https://amp.dev/ مراجعه کنید. |
جدول
کارت جدول برای نمایش جدول متن. به https://developers.google.com/assistant/conversational/prompts-rich#table_cards مراجعه کنید.
نمایندگی JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
فیلدها | |
---|---|
title | عنوان کلی جدول اختیاری است اما اگر زیرنویس تنظیم شده باشد باید تنظیم شود. |
subtitle | زیرنویس جدول اختیاری. |
image | تصویر مرتبط با جدول اختیاری. |
columns[] | سرصفحه ها و تراز ستون ها. |
rows[] | داده های ردیف جدول 3 ردیف اول تضمین شده است که نشان داده می شوند اما سایر ردیف ها ممکن است بر روی سطوح خاصی بریده شوند. لطفاً با شبیه ساز تست کنید تا ببینید کدام ردیف برای یک سطح مشخص نشان داده می شود. در سطوحی که از قابلیت WEB_BROWSER پشتیبانی می کنند، می توانید کاربر را به صفحه وب با داده های بیشتر هدایت کنید. |
button | دکمه. |
ستون جدول
نمایندگی JSON | |
---|---|
{
"header": string,
"align": enum ( |
فیلدها | |
---|---|
header | متن سرصفحه برای ستون. |
align | تراز افقی ستون wrt محتوا. اگر مشخص نباشد، محتوا با لبه اصلی تراز می شود. |
تراز افقی
هم ترازی محتوای داخل سلول.
Enums | |
---|---|
UNSPECIFIED | |
LEADING | لبه جلویی سلول. این پیش فرض است. |
CENTER | محتوا در مرکز ستون تراز شده است. |
TRAILING | محتوا با لبه انتهایی ستون تراز شده است. |
TableRow
یک ردیف را در جدول توصیف می کند.
نمایندگی JSON | |
---|---|
{
"cells": [
{
object ( |
فیلدها | |
---|---|
cells[] | سلول های این ردیف نمایش 3 سلول اول تضمین شده است، اما سایر سلول ها ممکن است بر روی سطوح خاصی بریده شوند. لطفاً با شبیه ساز تست کنید تا ببینید کدام سلول برای یک سطح مشخص نشان داده می شود. |
divider | نشان می دهد که آیا بعد از هر ردیف باید یک تقسیم کننده وجود داشته باشد. |
TableCell
یک سلول را در یک ردیف توصیف می کند.
نمایندگی JSON | |
---|---|
{ "text": string } |
فیلدها | |
---|---|
text | محتوای متن سلول |
رسانه ها
یک شی رسانه ای را نشان می دهد. حاوی اطلاعاتی درباره رسانه، مانند نام، توضیحات، آدرس اینترنتی و غیره است. https://developers.google.com/assistant/conversational/prompts-media را ببینید.
نمایندگی JSON | |
---|---|
{ "mediaType": enum ( |
فیلدها | |
---|---|
mediaType | |
startOffset | شروع افست اولین شی رسانه ای. مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' |
optionalMediaControls[] | انواع کنترل رسانه اختیاری که این جلسه پاسخ رسانه می تواند پشتیبانی کند. در صورت تنظیم، زمانی که یک رویداد رسانه ای خاص اتفاق می افتد، درخواست به 3p ارسال می شود. اگر تنظیم نشده باشد، 3p همچنان باید دو نوع کنترل پیشفرض، FINISHED و FAILED را کنترل کند. |
mediaObjects[] | فهرست اشیاء رسانه ای |
repeatMode | حالت تکرار برای لیست اشیاء رسانه. |
firstMediaObjectIndex | شاخص مبتنی بر 0 اولین Media Object در mediaObjects برای پخش. اگر نامشخص، صفر یا خارج از محدوده باشد، پخش از اولین شی رسانه در mediaObjects شروع می شود. |
MediaType
نوع رسانه ای این پاسخ.
Enums | |
---|---|
MEDIA_TYPE_UNSPECIFIED | |
AUDIO | فایل صوتی. |
MEDIA_STATUS_ACK | پاسخ به تأیید گزارش وضعیت رسانه. |
OptionalMediaControls
انواع کنترل رسانه اختیاری که پاسخ رسانه می تواند پشتیبانی کند
Enums | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED | مقدار نامشخص |
PAUSED | رویداد متوقف شد. هنگامی که کاربر رسانه را متوقف می کند فعال می شود. |
STOPPED | رویداد متوقف شد. هنگام خروج کاربر از جلسه 3p در حین پخش رسانه فعال می شود. |
MediaObject
یک شی رسانه واحد را نشان می دهد
نمایندگی JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
فیلدها | |
---|---|
name | نام این شی رسانه ای. |
description | شرح این شی رسانه ای. |
url | نشانی اینترنتی که به محتوای رسانه اشاره دارد. فایلهای MP3 باید روی سرور وب میزبانی شوند و از طریق یک URL HTTPS در دسترس عموم قرار گیرند. پخش زنده فقط برای فرمت MP3 پشتیبانی می شود. |
image | تصویر برای نمایش با کارت رسانه. |
MediaImage
نمایندگی JSON | |
---|---|
{ // Union field |
فیلدها | ||
---|---|---|
| ||
large | یک تصویر بزرگ، مانند جلد آلبوم و غیره. | |
icon | یک نماد تصویر کوچک در سمت راست عنوان نمایش داده شده است. اندازه آن به 36x36 dp تغییر یافته است. |
RepeatMode
انواع حالت تکرار برای لیستی از اشیاء رسانه.
Enums | |
---|---|
REPEAT_MODE_UNSPECIFIED | معادل OFF. |
OFF | پایان جلسه رسانه در پایان آخرین شی رسانه. |
ALL | هنگامی که به انتهای آخرین شی رسانه ای رسید، به ابتدای اولین شی رسانه حلقه بزنید. |
مجموعه
کارتی برای ارائه مجموعه ای از گزینه ها برای انتخاب. به https://developers.google.com/assistant/conversational/prompts-selection#collection مراجعه کنید
نمایندگی JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
فیلدها | |
---|---|
title | عنوان مجموعه. اختیاری. |
subtitle | زیرنویس مجموعه. اختیاری. |
items[] | لیستی از موارد می تواند دقیقه 2 و حداکثر 10 باشد. |
imageFill | نحوه پر شدن پس زمینه تصویر آیتم های مجموعه اختیاری. |
مجموعه آیتم
یک مورد در مجموعه
نمایندگی JSON | |
---|---|
{ "key": string } |
فیلدها | |
---|---|
key | مورد نیاز. کلید NLU که با نام کلید ورودی در نوع مرتبط مطابقت دارد. |
فهرست کنید
کارتی برای ارائه لیستی از گزینه ها برای انتخاب. به https://developers.google.com/assistant/conversational/prompts-selection#list مراجعه کنید
نمایندگی JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
فیلدها | |
---|---|
title | عنوان لیست اختیاری. |
subtitle | زیرنویس لیست اختیاری. |
items[] | لیستی از موارد می تواند دقیقه 2 و حداکثر 30 باشد. |
List Item
یک مورد در لیست
نمایندگی JSON | |
---|---|
{ "key": string } |
فیلدها | |
---|---|
key | مورد نیاز. کلید NLU که با نام کلید ورودی در نوع مرتبط مطابقت دارد. |
مجموعه مرور
مجموعه ای از اسناد وب را به عنوان مجموعه ای از آیتم های کاشی بزرگ ارائه می دهد. موارد ممکن است برای راه اندازی سند وب مرتبط خود در یک نمایشگر وب انتخاب شوند. https://developers.google.com/assistant/conversational/prompts-selection#collectionBrowse را ببینید.
نمایندگی JSON | |
---|---|
{ "items": [ { object ( |
فیلدها | |
---|---|
items[] | لیستی از موارد می تواند دقیقه 2 و حداکثر 10 باشد. |
imageFill | گزینه نوع نمایش تصویر |
مورد
مورد موجود در مجموعه
نمایندگی JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
فیلدها | |
---|---|
title | مورد نیاز. عنوان آیتم مجموعه. |
description | شرح آیتم مجموعه |
footer | متن پاورقی برای آیتم مجموعه، در زیر توضیحات نمایش داده شده است. تک خط متن، کوتاه شده با بیضی. |
image | تصویر برای آیتم مجموعه. |
openUriAction | مورد نیاز. URI برای باز کردن در صورت انتخاب مورد. |
پیشنهاد
وقتی «دستیار» درخواست را نمایش میدهد، پیشنهادها تراشههای پیشنهادی را در دستگاههای دارای نمایشگر به کاربران ارائه میدهند. از تراشههای پیشنهاد برای اشاره به پاسخهای کاربر برای ادامه یا تغییر مکالمه استفاده کنید. هنگامی که ضربه بزنید، یک تراشه پیشنهاد متن نمایش داده شده را کلمه به کلمه به مکالمه باز می گرداند، گویی که کاربر آن را تایپ کرده است. به https://developers.google.com/assistant/conversational/prompts#suggestions مراجعه کنید،
نمایندگی JSON | |
---|---|
{ "title": string } |
فیلدها | |
---|---|
title | مورد نیاز. متن نشان داده شده در تراشه پیشنهاد. وقتی روی آن ضربه بزنید، این متن به طور کلمه به مکالمه ارسال می شود، گویی که کاربر آن را تایپ کرده است. هر عنوان باید در میان مجموعه تراشه های پیشنهادی منحصر به فرد باشد. حداکثر 25 کاراکتر |
بوم
نشان دهنده یک پاسخ بوم تعاملی برای ارسال به کاربر است. این می تواند همراه با فیلد "firstSimple" در اعلان حاوی برای صحبت با کاربر علاوه بر نمایش پاسخ بوم تعاملی استفاده شود. حداکثر اندازه پاسخ 50 هزار بایت است. به https://developers.google.com/assistant/interactivecanvas مراجعه کنید.
نمایندگی JSON | |
---|---|
{
"url": string,
"data": [
value
],
"suppressMic": boolean,
"continuousMatchConfig": {
object ( |
فیلدها | |
---|---|
url | URL برنامه وب بوم تعاملی برای بارگیری. اگر تنظیم نشود، آدرس اینترنتی بوم فعال فعلی مجدداً استفاده خواهد شد. |
data[] | اختیاری. داده های JSON به عنوان یک رویداد به صفحه وب تجربه همهجانبه منتقل می شود. اگر فیلد «نسخ» در فرمان حاوی «نادرست» باشد، مقادیر دادههای تعریفشده در این فرمان Canvas پس از مقادیر دادههای تعریفشده در درخواستهای قبلی Canvas اضافه میشوند. |
suppressMic | اختیاری. مقدار پیش فرض: نادرست. |
continuousMatchConfig | پیکربندی مورد استفاده برای شروع حالت تطابق مداوم. |
ContinuousMatchConfig
پیکربندی مورد استفاده برای شروع حالت تطابق مداوم.
نمایندگی JSON | |
---|---|
{
"expectedPhrases": [
{
object ( |
فیلدها | |
---|---|
expectedPhrases[] | تمام عبارات مورد انتظار ممکن در این جلسه حالت تطابق مداوم. |
durationSeconds | مدت زمان برای روشن نگه داشتن حالت تطابق مداوم. اگر مشخص شود، پس از اتمام زمان، میکروفون بسته خواهد شد. حداکثر مقدار مجاز 180 است. |
عبارت مورد انتظار
نمایندگی JSON | |
---|---|
{ "phrase": string, "alternativePhrases": [ string ] } |
فیلدها | |
---|---|
phrase | عبارت مطابقت در جلسه حالت تطابق مداوم. |
alternativePhrases[] | برخی از عبارات ممکن است توسط مدل گفتار به اشتباه تشخیص داده شوند، حتی با سوگیری گفتاری. این به توسعه دهندگان اجازه می دهد تا محرک های جایگزین را برای همفون ها مشخص کنند. |
سفارش به روز رسانی
به روز رسانی به یک سفارش.
نمایندگی JSON | |
---|---|
{ "type": enum ( |
فیلدها | |
---|---|
type | منسوخ شده: به جای آن از OrderUpdate.update_mask استفاده کنید. اگر نوع = SNAPSHOT، OrderUpdate.order باید کل سفارش باشد. اگر نوع = ORDER_STATUS، این تغییر وضعیت سطح سفارش است. فقط order.last_update_time و این وضعیت عمودی انتخاب می شوند. توجه: type.ORDER_STATUS فقط از بهروزرسانیهای وضعیت PurcahaseOrderExtension پشتیبانی میکند و برنامهای برای گسترش این پشتیبانی وجود ندارد. در عوض، توصیه میکنیم از updateMask استفاده کنید، زیرا عمومیتر، قابل توسعهتر است و میتواند برای همه عمودیها استفاده شود. |
order | |
updateMask | توجه: توجه/توصیه های زیر برای فیلدهای ویژه زیر وجود دارد: 1. order.last_update_time همیشه به عنوان بخشی از درخواست به روز رسانی به روز می شود. 2. order.create_time، order.google_order_id و order.merchant_order_id در صورت ارائه به عنوان بخشی از updateMask نادیده گرفته خواهند شد. این فهرستی از نامهای فیلدهای کاملاً واجد شرایط با کاما است. مثال: |
userNotification | در صورت مشخص شدن، یک اعلان با عنوان و متن مشخص شده به کاربر نمایش می دهد. تعیین یک اعلان یک پیشنهاد برای اطلاع رسانی است و تضمین نمی شود که منجر به اعلان شود. |
reason | دلیل تغییر/به روز رسانی |
تایپ کنید
منسوخ شده: به جای آن از OrderUpdate.update_mask استفاده کنید. بهروزرسانیهای مجاز برای یک سفارش
Enums | |
---|---|
TYPE_UNSPECIFIED | نوع نامشخص، نباید این را به صراحت تنظیم کنید. |
ORDER_STATUS | فقط وضعیت سفارش را به روز کنید. |
SNAPSHOT | به روز رسانی عکس فوری سفارش |
سفارش دهید
موجودیت سفارش. توجه: 1. تمام رشته ها در تمام سطوح باید کمتر از 1000 کاراکتر باشند مگر اینکه طور دیگری مشخص شده باشد. 2. تعداد فیلدهای تکرار شده در تمام سطوح باید کمتر از 50 باشد، مگر اینکه طور دیگری مشخص شده باشد. 3. تمام مهرهای زمانی در همه سطوح، در صورت مشخص شدن، باید مهر زمانی معتبر باشند.
نمایندگی JSON | |
---|---|
{ "googleOrderId": string, "merchantOrderId": string, "userVisibleOrderId": string, "userVisibleStateLabel": string, "buyerInfo": { object ( |
فیلدها | ||
---|---|---|
googleOrderId | Google شناسه سفارش را اختصاص داد. | |
merchantOrderId | مورد نیاز: شناسه سفارش داخلی به تاجر اختصاص داده شده است. این شناسه باید منحصر به فرد باشد و برای عملیات به روز رسانی بعدی سفارش لازم است. این شناسه ممکن است روی googleOrderId ارائه شده یا هر مقدار منحصر به فرد دیگری تنظیم شود. توجه داشته باشید که شناسه ارائه شده به کاربران userVisibleOrderId است که ممکن است مقداری متفاوت و کاربرپسندتر باشد. حداکثر طول مجاز 128 کاراکتر است. | |
userVisibleOrderId | کاربر با ارجاع شناسه به سفارش فعلی روبروست. این شناسه باید با شناسه نمایش داده شده برای این سفارش در زمینههای دیگر، از جمله وبسایتها، برنامهها و ایمیل مطابقت داشته باشد. | |
userVisibleStateLabel | منسوخ شده: به جای آن از وضعیت OrderExtensions استفاده کنید. برچسب قابل مشاهده توسط کاربر برای وضعیت این سفارش. | |
buyerInfo | اطلاعات در مورد خریدار | |
image | تصویر مرتبط با سفارش | |
createTime | مورد نیاز: تاریخ و زمان ایجاد سفارش. یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: | |
lastUpdateTime | تاریخ و زمان آخرین به روز رسانی سفارش برای به روز رسانی سفارش مورد نیاز است. یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: | |
transactionMerchant | تاجری که تسویه حساب را تسهیل کرد. این میتواند با ارائهدهنده سطح مورد خطی متفاوت باشد. مثال: سفارش Expedia با مورد خط از ANA. | |
contents | مورد نیاز: محتویات را سفارش دهید که گروهی از موارد خطی است. | |
priceAttributes[] | قیمت، تخفیف، مالیات و غیره. | |
followUpActions[] | پیگیری اقدامات در سطح سفارش | |
paymentData | داده های مربوط به پرداخت برای سفارش | |
termsOfServiceUrl | پیوندی به شرایط خدمات مربوط به سفارش/سفارش پیشنهادی. | |
note | یادداشت های پیوست شده به سفارش | |
promotions[] | همه تبلیغاتی که با این سفارش مرتبط هستند. | |
disclosures[] | افشاهای مرتبط با این سفارش. | |
vertical | منسوخ شده: به جای آن از عمودی استفاده کنید. این ویژگی ها برای همه موارد خط اعمال می شود، مگر اینکه در برخی از موارد خطی لغو شوند. این عمودی باید با نوع عمودی سطح مورد خط مطابقت داشته باشد. مقادیر ممکن: یک شی حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی | |
verticals میدان اتحادیه این ویژگی ها برای همه موارد خط اعمال می شود، مگر اینکه در برخی از موارد خطی لغو شوند. این عمودی باید با نوع عمودی سطح مورد خط مطابقت داشته باشد. verticals فقط می توانند یکی از موارد زیر باشند: | ||
purchase | سفارش خرید | |
ticket | سفارش بلیط |
اطلاعات کاربر
اطلاعات در مورد کاربر این برای نشان دادن اطلاعات کاربر مرتبط با یک سفارش استفاده می شود.
نمایندگی JSON | |
---|---|
{
"email": string,
"firstName": string,
"lastName": string,
"displayName": string,
"phoneNumbers": [
{
object ( |
فیلدها | |
---|---|
email | ایمیل کاربر، به عنوان مثال: janedoe@gmail.com . |
firstName | نام کاربر. |
lastName | نام خانوادگی کاربر. |
displayName | نام نمایشی کاربر، ممکن است با نام یا نام خانوادگی متفاوت باشد. |
phoneNumbers[] | شماره تلفن های کاربر |
شماره تلفن
نمایندگی شماره تلفن استاندارد
نمایندگی JSON | |
---|---|
{ "e164PhoneNumber": string, "extension": string, "preferredDomesticCarrierCode": string } |
فیلدها | |
---|---|
e164PhoneNumber | شماره تلفن در قالب E.164، همانطور که در توصیه اتحادیه بین المللی مخابرات (ITU) E.164 تعریف شده است. پیوند ویکی: https://en.wikipedia.org/wiki/E.164 |
extension | برنامه افزودنی در توصیه های ITU استاندارد نشده است، به جز اینکه به عنوان مجموعه ای از اعداد با طول حداکثر 40 رقم تعریف شده است. در اینجا بهعنوان رشتهای تعریف میشود که برای استفاده احتمالی از صفر اصلی در برنامه افزودنی استفاده میشود (سازمانها آزادی کامل برای انجام این کار دارند، زیرا هیچ استانداردی تعریف نشده است). به غیر از ارقام، برخی از کاراکترهای شماره گیری دیگر مانند "," (که نشان دهنده انتظار است) ممکن است در اینجا ذخیره شوند. به عنوان مثال، در xxx-xxx-xxxx ext. 123، "123" پسوند است. |
preferredDomesticCarrierCode | کد انتخاب شرکت مخابراتی که هنگام تماس با این شماره تلفن داخلی ترجیح داده می شود. این همچنین شامل کدهایی است که در برخی کشورها هنگام تماس از تلفن ثابت به تلفن همراه یا بالعکس باید شماره گیری شوند. به عنوان مثال، در کلمبیا، هنگام تماس از تلفن همراه به تلفن ثابت داخلی، یک "3" باید قبل از خود شماره تلفن شماره گیری شود. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code توجه داشته باشید که این کد "ترجیح" است، به این معنی که کدهای دیگر نیز ممکن است کار کنند. |
تصویر
تصویری که در کارت نمایش داده می شود.
نمایندگی JSON | |
---|---|
{ "url": string, "accessibilityText": string, "height": integer, "width": integer } |
فیلدها | |
---|---|
url | آدرس منبع تصویر تصاویر می توانند JPG، PNG و GIF (متحرک و غیر متحرک) باشند. برای مثال، |
accessibilityText | شرح متنی از تصویر که برای دسترسی استفاده می شود، به عنوان مثال صفحه خوان. مورد نیاز. |
height | ارتفاع تصویر بر حسب پیکسل اختیاری. |
width | عرض تصویر بر حسب پیکسل اختیاری. |
بازرگان
تاجر برای سبد خرید/سفارش/خط مورد.
نمایندگی JSON | |
---|---|
{ "id": string, "name": string, "image": { object ( |
فیلدها | |
---|---|
id | شناسه اختیاری به تاجر در صورت وجود اختصاص داده میشود. |
name | نام تاجر مانند "نان پانرا". |
image | تصویر مرتبط با تاجر. |
phoneNumbers[] | شماره تلفن های تاجر |
address | آدرس تاجر. |
مکان
ظرفی که نشان دهنده یک مکان است.
نمایندگی JSON | |
---|---|
{ "coordinates": { object ( |
فیلدها | |
---|---|
coordinates | مختصات جغرافیایی به مجوز [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] نیاز دارد. |
formattedAddress | نشانی نمایش، به عنوان مثال، "1600 Amphitheatre Pkwy, Mountain View, CA 94043". به مجوز [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] نیاز دارد. |
zipCode | کد پستی به مجوز [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] یا [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] نیاز دارد. |
city | شهر. به مجوز [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] یا [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] نیاز دارد. |
postalAddress | آدرس پستی به مجوز [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] یا [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] نیاز دارد. |
name | نام مکان. |
phoneNumber | شماره تلفن محل، به عنوان مثال شماره تماس محل کسب و کار یا شماره تلفن محل تحویل. |
notes | نکاتی در مورد مکان |
placeId | placeId با Places API برای واکشی جزئیات یک مکان استفاده می شود. به https://developers.google.com/places/web-service/place-id مراجعه کنید |
LatLng
شیئی که نشان دهنده یک جفت طول و عرض جغرافیایی است. این به صورت یک جفت دوتایی برای نشان دادن درجه عرض جغرافیایی و درجه طول جغرافیایی بیان می شود. مگر اینکه طور دیگری مشخص شده باشد، این شی باید با استاندارد WGS84 مطابقت داشته باشد. مقادیر باید در محدوده نرمال شده باشند.
نمایندگی JSON | |
---|---|
{ "latitude": number, "longitude": number } |
فیلدها | |
---|---|
latitude | عرض جغرافیایی بر حسب درجه باید در محدوده [-90.0، +90.0] باشد. |
longitude | طول جغرافیایی بر حسب درجه باید در محدوده [-180.0، +180.0] باشد. |
آدرس پستی
نشان دهنده یک آدرس پستی است، به عنوان مثال برای آدرس های تحویل پستی یا پرداخت. با توجه به آدرس پستی، یک سرویس پستی می تواند اقلام را به محل، صندوق پستی یا موارد مشابه تحویل دهد. مدل سازی مکان های جغرافیایی (جاده ها، شهرها، کوه ها) در نظر گرفته نشده است.
در استفاده معمولی، بسته به نوع فرآیند، یک آدرس از طریق ورودی کاربر یا از وارد کردن دادههای موجود ایجاد میشود.
توصیههایی در مورد ورودی/ویرایش آدرس: - از ویجت آدرس آماده i18n مانند https://github.com/google/libaddressinput استفاده کنید - نباید عناصر رابط کاربری برای ورودی یا ویرایش فیلدها در خارج از کشورهایی که آن فیلد در آن وجود دارد، به کاربران ارائه شود. استفاده می شود.
برای راهنمایی بیشتر در مورد نحوه استفاده از این طرح، لطفاً به این آدرس مراجعه کنید: https://support.google.com/business/answer/6397478
نمایندگی JSON | |
---|---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
فیلدها | |
---|---|
revision | بازبینی طرحواره همه ویرایشهای جدید باید با نسخههای قبلی سازگار باشند. |
regionCode | مورد نیاز. کد منطقه CLDR کشور/منطقه آدرس. این هرگز استنباط نمی شود و اطمینان از صحیح بودن مقدار به عهده کاربر است. برای جزئیات بیشتر به http://cldr.unicode.org/ و http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html مراجعه کنید. مثال: "CH" برای سوئیس. |
languageCode | اختیاری. کد زبان BCP-47 محتویات این آدرس (در صورت شناخته شدن). این اغلب زبان رابط کاربری فرم ورودی است یا انتظار میرود با یکی از زبانهای مورد استفاده در کشور/منطقه آدرس یا معادلهای نویسهگردانی شده آنها مطابقت داشته باشد. این میتواند بر قالببندی در برخی کشورها تأثیر بگذارد، اما برای صحت دادهها حیاتی نیست و هرگز بر روی اعتبارسنجی یا سایر عملیات مرتبط با قالببندی تأثیر نمیگذارد. اگر این مقدار مشخص نیست، باید حذف شود (به جای تعیین یک پیش فرض احتمالاً نادرست). مثال: "zh-Hant"، "ja"، "ja-Latn"، "en". |
postalCode | اختیاری. کد پستی آدرس همه کشورها از وجود کدهای پستی استفاده نمیکنند یا نیاز به وجود کد پستی ندارند، اما در جایی که از آنها استفاده میشود، ممکن است اعتبار سنجی اضافی را با سایر قسمتهای آدرس (مثلاً اعتبارسنجی ایالت/زیپ در ایالات متحده آمریکا) ایجاد کنند. |
sortingCode | اختیاری. کد مرتبسازی اضافی، خاص کشور. این در اکثر مناطق استفاده نمی شود. در جایی که از آن استفاده میشود، مقدار یا رشتهای مانند «CEDEX» است، که به صورت اختیاری با یک عدد دنبال میشود (مثلاً «CEDEX 7»)، یا فقط یک عدد به تنهایی، نشاندهنده «کد بخش» (جامائیکا)، «نشانگر ناحیه تحویل» است. (مالاوی) یا «نشانگر اداره پست» (مثلاً ساحل عاج). |
administrativeArea | اختیاری. بالاترین بخش اداری که برای آدرس های پستی یک کشور یا منطقه استفاده می شود. به عنوان مثال، این می تواند یک ایالت، یک استان، یک استان یا یک استان باشد. به طور خاص، برای اسپانیا این استان است و نه جامعه خودمختار (مثلاً "بارسلونا" و نه "کاتالونیا"). بسیاری از کشورها از یک منطقه اداری در آدرس های پستی استفاده نمی کنند. به عنوان مثال در سوئیس این باید خالی از سکنه بماند. |
locality | اختیاری. عموماً به بخش شهر/شهرک آدرس اشاره دارد. مثال: شهر ایالات متحده، کمون فناوری اطلاعات، شهر پست بریتانیا. در مناطقی از جهان که محلی ها به خوبی تعریف نشده اند یا به خوبی در این ساختار قرار نمی گیرند، محلی را خالی بگذارید و از خطوط آدرس استفاده کنید. |
sublocality | اختیاری. موقعیت فرعی آدرس به عنوان مثال، این می تواند محله، محله، منطقه باشد. |
addressLines[] | خطوط آدرس بدون ساختار که سطوح پایین یک آدرس را توصیف می کند. از آنجایی که مقادیر در addressLines اطلاعات نوع ندارند و گاهی اوقات ممکن است حاوی چندین مقدار در یک فیلد واحد باشند (به عنوان مثال "Austin, TX")، واضح بودن ترتیب خطوط مهم است. ترتیب خطوط آدرس باید "سفارش پاکت" برای کشور/منطقه آدرس باشد. در جاهایی که ممکن است متفاوت باشد (مثلاً ژاپن)، address_language برای صریحتر کردن آن استفاده میشود (مثلاً "ja" برای سفارش بزرگ به کوچک و "ja-Latn" یا "en" برای کوچک به بزرگ). به این ترتیب، مشخص ترین خط یک آدرس را می توان بر اساس زبان انتخاب کرد. حداقل نمایش ساختاری مجاز یک آدرس شامل یک RegionCode با تمام اطلاعات باقیمانده در خطوط آدرس است. قالب بندی چنین آدرسی تقریباً بدون کدگذاری جغرافیایی امکان پذیر است، اما هیچ استدلال معنایی در مورد هیچ یک از اجزای آدرس نمی توان تا حداقل تا حدی حل شود. ایجاد آدرسی که فقط شامل یک regionCode و addressLines باشد و سپس geocoding روشی توصیه شده برای مدیریت آدرسهای کاملاً بدون ساختار است (برخلاف حدس زدن اینکه کدام قسمتهای آدرس باید محلها یا مناطق اداری باشند). |
recipients[] | اختیاری. گیرنده در آدرس این فیلد تحت شرایط خاصی ممکن است حاوی اطلاعات چند خطی باشد. به عنوان مثال، ممکن است حاوی اطلاعات "مراقبت از" باشد. |
organization | اختیاری. نام سازمان در آدرس. |
مطالب
لفاف برای اقلام خط.
نمایندگی JSON | |
---|---|
{
"lineItems": [
{
object ( |
فیلدها | |
---|---|
lineItems[] | لیست اقلام خط سفارش حداقل 1 خط مورد نیاز است و حداکثر 50 مورد مجاز است. همه موارد خط باید به یک عمود تعلق داشته باشند. |
آیتم خط
یک مورد خطی شامل یک مورد عمودی است. یک سفارش یا سبد خرید میتواند چندین مورد خط عمودی مشابه داشته باشد. آیتم های فرعی/افزونه ها و غیره باید بسته به موارد استفاده در پروتوهای عمودی تعریف شوند. توجه: 1. تمام رشته ها در تمام سطوح باید کمتر از 1000 کاراکتر باشند مگر اینکه طور دیگری مشخص شده باشد. 2. تعداد فیلدهای تکرار شده در تمام سطوح باید کمتر از 50 باشد، مگر اینکه طور دیگری مشخص شده باشد. 3. تمام مهرهای زمانی در همه سطوح، در صورت مشخص شدن، باید مهر زمانی معتبر باشند.
نمایندگی JSON | |
---|---|
{ "id": string, "name": string, "userVisibleStateLabel": string, "provider": { object ( |
فیلدها | ||
---|---|---|
id | مورد نیاز: تاجر برای مورد خط شناسه اختصاص داده است. برای شناسایی مورد خط موجود در اعمال بهروزرسانیهای جزئی استفاده میشود. حداکثر طول مجاز 64 کاراکتر است. | |
name | نام کالای خط همانطور که در رسید نشان داده شده است. حداکثر طول مجاز 100 کاراکتر است. | |
userVisibleStateLabel | منسوخ شده است. به جای آن از وضعیت سطح عمودی استفاده کنید. به عنوان مثال، برای خرید، از PurchaseOrderExtension.status استفاده کنید. برچسب قابل مشاهده توسط کاربر برای وضعیت این مورد خط. | |
provider | ارائهدهنده مورد خط خاص، اگر با سفارش کلی متفاوت باشد. مثال: Expedia Order با ارائه دهنده اقلام خطی ANA. | |
priceAttributes[] | قیمت و تنظیمات سطح مورد خطی. | |
followUpActions[] | پیگیری اقدامات در مورد خط. | |
recipients[] | مشتریان سطح اقلام خطی، این ممکن است با خریدار سطح سفارش متفاوت باشد. مثال: کاربر X با نام کاربر Y رزرو رستوران انجام داده است. | |
image | تصویر کوچک مرتبط با این مورد، در صورت وجود. | |
description | شرح مورد خط. | |
notes[] | یادداشتهای اضافی قابل اعمال برای این مورد خاص، برای مثال خطمشی لغو. | |
disclosures[] | افشاهای مرتبط با این مورد. | |
vertical | منسوخ شده: به جای آن از عمودی استفاده کنید. مورد نیاز: محتوای معنایی آیتم خط بر اساس نوع/عمودی آن. هر عمودی باید شامل جزئیات تحقق خودش باشد. باید یکی از مقادیر زیر باشد: یک شی حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی | |
verticals میدان اتحادیه مورد نیاز: محتوای معنایی آیتم خط بر اساس نوع/عمودی آن. هر عمودی باید شامل جزئیات تحقق خودش باشد. verticals فقط می توانند یکی از موارد زیر باشند: | ||
purchase | سفارشات خرید مانند کالا، غذا و غیره | |
reservation | سفارشات رزرو مانند رستوران، مدل مو و غیره |
قیمت ویژگی
ویژگی قیمت یک سفارش یا یک قلم خط.
نمایندگی JSON | |
---|---|
{ "type": enum ( |
فیلدها | ||
---|---|---|
type | مورد نیاز: نوع ویژگی پول. | |
name | مورد نیاز: رشته ای از ویژگی قیمت را کاربر نمایش می دهد. این توسط تاجر ارسال و بومی سازی شده است. | |
id | اختیاری: شناسه قلم خطی که این قیمت با آن مطابقت دارد. | |
state | مورد نیاز: وضعیت قیمت: برآورد در مقابل واقعی. | |
taxIncluded | این که آیا قیمت شامل مالیات می شود. | |
spec میدان اتحادیه نشان دهنده مقدار پولی یا درصد میلی است. spec فقط می تواند یکی از موارد زیر باشد: | ||
amount | مقدار پولی | |
amountMillipercentage | مشخصات درصد ، تا 1/1000 درصد درصد. به عنوان مثال: 8.750 ٪ به عنوان 8750 نشان داده شده است ، درصد منفی نشان دهنده تخفیف درصد است. کاهش این زمینه در صورت نیاز به usecase جامد ، می توانید اضافه کنید. |
تایپ کنید
نوع پول را نشان می دهد.
Enums | |
---|---|
TYPE_UNSPECIFIED | نوع نامشخص است ، مشتری ها نباید صریحاً این را تنظیم کنند. |
REGULAR | قیمت نمایش منظم ، قبل از اعمال هرگونه تخفیف و غیره. |
DISCOUNT | برای تفریق از زیرنویس. |
TAX | برای افزودن به زیرنویس. |
DELIVERY | برای افزودن به زیرنویس. |
SUBTOTAL | Subtotal قبل از اضافه شدن برخی از هزینه ها. |
FEE | هر هزینه اضافی |
GRATUITY | برای افزودن به زیرنویس. |
TOTAL | قیمت سفارش یا مورد خط نمایش داده شده است. |
ایالت
نمایانگر وضعیت قیمت است.
Enums | |
---|---|
STATE_UNSPECIFIED | مشخص نشده است |
ESTIMATE | قیمت فقط یک تخمین است اما مبلغ نهایی نزدیک به این مبلغ خواهد بود. مثال: در مواردی که مالیات در زمان معامله به طور دقیق مشخص نیست ، کل یک مقدار تخمین خواهد بود. |
ACTUAL | قیمت واقعی که برای کاربر شارژ می شود. |
پول
مقداری پول را با نوع ارز آن نشان می دهد.
نمایندگی JSON | |
---|---|
{ "currencyCode": string, "amountInMicros": string } |
فیلدها | |
---|---|
currencyCode | کد ارز 3 حرف تعریف شده در ISO 4217. |
amountInMicros | مقدار در میکرو. به عنوان مثال ، این قسمت باید به عنوان 1990000 با قیمت 1.99 دلار تنظیم شود. |
اقدام
یک عمل پیگیری مرتبط با سفارش یا خط خط.
نمایندگی JSON | |
---|---|
{ "type": enum ( |
فیلدها | |
---|---|
type | مورد نیاز: نوع عمل. |
title | عنوان یا برچسب عمل ، به کاربر نمایش داده می شود. حداکثر طول مجاز 100 بار است. |
openUrlAction | اقدام برای انجام |
actionMetadata | ابرداده مرتبط با یک عمل. |
تایپ کنید
اقدامات پیگیری احتمالی
Enums | |
---|---|
TYPE_UNSPECIFIED | اقدام نامشخص |
VIEW_DETAILS | مشاهده عملکرد جزئیات سفارش. |
MODIFY | اقدام سفارش را اصلاح کنید. |
CANCEL | اقدام سفارش را لغو کنید. |
RETURN | اقدام سفارش را برگردانید. |
EXCHANGE | اقدام سفارش مبادله. |
EMAIL | اقدام ایمیل. انواع ایمیل و تماس کاهش می یابد. OpenUrlaction.url می تواند به عنوان شماره تلفن یا ایمیل استفاده شود. |
CALL | اقدام با اقدام. |
REORDER | اقدام مجدد |
REVIEW | اقدام سفارش را بررسی کنید. |
CUSTOMER_SERVICE | با خدمات مشتری تماس بگیرید. |
FIX_ISSUE | مستقیم به سایت یا برنامه بازرگان برای رفع مشکل. |
DIRECTION | پیوند جهت |
OpenUrlAction
URL داده شده را باز می کند.
نمایندگی JSON | |
---|---|
{ "url": string, "androidApp": { object ( |
فیلدها | |
---|---|
url | قسمت URL که می تواند هر یک از: - URL های HTTP/HTTPS برای باز کردن یک برنامه مرتبط با برنامه یا یک صفحه وب |
androidApp | اگر انتظار می رود URL توسط یک برنامه Android انجام شود ، اطلاعات مربوط به برنامه Android را انجام دهید. |
urlTypeHint | اشاره ای به نوع URL نشان می دهد. |
اندرویدی
مشخصات برنامه Android برای محدودیت های تحقق
نمایندگی JSON | |
---|---|
{
"packageName": string,
"versions": [
{
object ( |
فیلدها | |
---|---|
packageName | نام بسته نام بسته باید هنگام مشخص کردن تحقق Android مشخص شود. |
versions[] | هنگامی که چندین فیلتر مشخص شد ، هر تطابق فیلتر باعث ایجاد برنامه می شود. |
نسخه
در صورت نیاز به نسخه/s خاص برنامه ، باید نسخه Filter گنجانده شود.
نمایندگی JSON | |
---|---|
{ "minVersion": integer, "maxVersion": integer } |
فیلدها | |
---|---|
minVersion | کد نسخه حداقل یا 0 ، فراگیر. |
maxVersion | کد نسخه حداکثر ، فراگیر. دامنه در نظر گرفته شده [minversion: maxversion] است. دامنه تهی حاکی از هر نسخه است. مثالها: برای مشخص کردن استفاده از نسخه واحد: [target_version: target_version]. برای مشخص کردن هر نسخه از Minversion و MaxVersion نامشخص است. برای مشخص کردن تمام نسخه ها تا حداکثر ، Minversion نامشخص را بگذارید. برای مشخص کردن تمام نسخه ها از Minversion ، MaxVersion نامشخص را بگذارید. |
urltypehint
انواع مختلف نکات URL.
Enums | |
---|---|
URL_TYPE_HINT_UNSPECIFIED | نامشخص |
AMP_CONTENT | URL که مستقیماً به محتوای AMP یا یک URL متعارف اشاره می کند که به محتوای AMP از طریق <link rel = "amphtml"> اشاره دارد. |
ActionMetadata
ابرداده مرتبط در هر عمل.
نمایندگی JSON | |
---|---|
{ "expireTime": string } |
فیلدها | |
---|---|
expireTime | زمانی که این عمل منقضی می شود. یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: |
افشای
یک محصول ، خدمات یا افشای خط مشی که ممکن است به کاربر ارائه شود.
نمایندگی JSON | |
---|---|
{ "title": string, "disclosureText": { object ( |
فیلدها | |
---|---|
title | عنوان افشای. مثال: "اطلاعات ایمنی". |
disclosureText | محتوای افشای اطلاعات. Weblinks مجاز است. |
presentationOptions | گزینه های ارائه برای افشای اطلاعات. |
فاش کردن
یک متن ساده با پیوندهای وب را نشان می دهد.
نمایندگی JSON | |
---|---|
{
"template": string,
"textLinks": [
{
object ( |
فیلدها | |
---|---|
template | متن برای نمایش ، حاوی صاحبخانه هایی مانند "{0}" و "{1}" برای هر لینک متن که باید درج شود. مثال: "هشدار: این محصول می تواند شما را در معرض مواد شیمیایی قرار دهد که برای ایجاد سرطان به ایالت کالیفرنیا شناخته شده اند. برای اطلاعات بیشتر به 0 {بروید." این متن افشای اطلاعات نباید حاوی هر محتوای تبلیغاتی یا تبلیغاتی باشد. |
textLinks[] | پیوندهای متنی که باید در الگوی جایگزین شوند. مورد اول برای "{0}" در رشته الگوی جایگزین می شود ، و مورد دوم برای "{1}" و غیره. |
لینک متن
پیوند متنی که باید در الگوی جایگزین شود.
نمایندگی JSON | |
---|---|
{ "displayText": string, "url": string } |
فیلدها | |
---|---|
displayText | متنی که باید برای کاربران نمایش داده شود. |
url | URL که کاربران باید هنگام فعال شدن پیوند به آن هدایت شوند. |
افشای برنامه ها
گزینه هایی برای ارائه افشای.
نمایندگی JSON | |
---|---|
{
"presentationRequirement": enum ( |
فیلدها | |
---|---|
presentationRequirement | الزام ارائه افشای. |
initiallyExpanded | آیا در ابتدا محتوای افشای اطلاعات باید گسترش یابد. به طور پیش فرض ، در ابتدا فرو ریخت. |
ارائه
الزام برای ارائه افشای.
Enums | |
---|---|
REQUIREMENT_UNSPECIFIED | نیاز نامشخص نباید این را صریح تنظیم کرد. |
REQUIREMENT_OPTIONAL | افشای اختیاری است. اگر دستگاه از افشای افشای پشتیبانی نکند ، می توان آن را رد کرد. |
REQUIREMENT_REQUIRED | افشای مورد نیاز است. اگر دستگاه از نمایش افشای اطلاعات پشتیبانی نمی کند ، مکالمه به تلفن خواهد بود. |
BuyItemextension
محتوای مورد خط خرید عمودی.
نمایندگی JSON | |
---|---|
{ "status": enum ( |
فیلدها | |
---|---|
status | مورد نیاز: وضعیت سطح مورد خط. |
userVisibleStatusLabel | مورد نیاز: برچسب/رشته قابل مشاهده کاربر برای وضعیت. حداکثر طول مجاز 50 بار است. |
type | مورد نیاز: نوع خرید. |
productId | محصول یا شناسه ارائه شده با این مورد خط. |
quantity | مقدار مورد |
unitMeasure | اندازه گیری واحد. اندازه مورد را در واحدهای انتخاب شده مشخص می کند. اندازه ، همراه با قیمت فعال برای تعیین قیمت واحد استفاده می شود. |
returnsInfo | اطلاعات را برای این مورد خط برمی گرداند. در صورت عدم استفاده ، این مورد خط به ارث می رسد سطح سفارش اطلاعات را برمی گرداند. |
fulfillmentInfo | اطلاعات تحقق برای این مورد خط. در صورت عدم استفاده ، این مورد خط اطلاعات تحقق سطح سفارش را به ارث می برد. |
itemOptions[] | افزودنی های اضافی یا زیر. |
productDetails | جزئیات مربوط به محصول. |
extension | هر زمینه اضافی بین بازرگان و گوگل رد و بدل می شود. توجه: استفاده از این پسوند بسیار دلسرد است. بر اساس مورد/شرایط استفاده ، یکی از موارد زیر را در نظر بگیرید: 1- اگر می توان از آن برای سایر موارد استفاده استفاده کرد (به عنوان مثال توانایی/عملکرد عمومی) ، زمینه های موجود در BuyItemextension را تعریف کنید. 2. در صورت خاص بودن یک ویژگی/ویژگی استفاده غیر ژنتیکی ، از urdent_extension استفاده کنید. یک شیء حاوی زمینه هایی از نوع دلخواه. یک قسمت اضافی |
خرید
وضعیت خرید مرتبط با سفارش خرید یا یک مورد خط خاص.
Enums | |
---|---|
PURCHASE_STATUS_UNSPECIFIED | وضعیت نامشخص |
READY_FOR_PICKUP | آماده برای برداشتن |
SHIPPED | حمل شده |
DELIVERED | تحویل داده شد. |
OUT_OF_STOCK | موجود نیست. |
IN_PREPARATION | "in_preparation" می تواند در زمینه های مختلف معنای متفاوتی داشته باشد. برای سفارش غذا می تواند غذا تهیه شود. برای خرده فروشی ، این می تواند یک مورد بسته بندی شود. |
CREATED | سفارش ایجاد شده است. |
CONFIRMED | بازرگان سفارش را تأیید کرد. |
REJECTED | بازرگان سفارش یا مورد خط را رد کرد. |
RETURNED | مورد توسط کاربر برگردانده شد. |
CANCELLED | سفارش یا مورد خط توسط کاربر لغو شد. |
CHANGE_REQUESTED | کاربر درخواست تغییر در سفارش کرده است و یکپارچه ساز این تغییر را پردازش می کند. پس از رسیدگی به درخواست ، دستور باید به حالت دیگری منتقل شود. |
نوع خرید
دسته خرید.
Enums | |
---|---|
PURCHASE_TYPE_UNSPECIFIED | مقدار ناشناخته |
RETAIL | این شامل خریدهایی مانند کالاهای فیزیکی است. |
FOOD | این شامل خرید سفارش غذا است. |
GROCERY | خرید مواد غذایی |
MOBILE_RECHARGE | خرید شارژ پیش پرداخت موبایل. |
اندازه بازرگان
اندازه گیری قیمت گذاری واحد بازرگان.
نمایندگی JSON | |
---|---|
{
"measure": number,
"unit": enum ( |
فیلدها | |
---|---|
measure | مقدار: مثال 1.2. |
unit | واحد: پوند مثال ، گرم. |
واحد
Enums | |
---|---|
UNIT_UNSPECIFIED | واحد نامشخص. |
MILLIGRAM | میلی گرم |
GRAM | گرم |
KILOGRAM | کیلو گرم |
OUNCE | اونس. |
POUND | پوند. |
خرید و فروش
اطلاعات مرتبط با یک سفارش یا یک مورد خط خاص را برمی گرداند.
نمایندگی JSON | |
---|---|
{ "isReturnable": boolean, "daysToReturn": integer, "policyUrl": string } |
فیلدها | |
---|---|
isReturnable | اگر درست باشد ، بازگشت مجاز است. |
daysToReturn | بازگشت در طی روزهای زیادی مجاز است. |
policyUrl | پیوند به خط مشی بازگشت. |
خرید
اطلاعات تحقق مرتبط با یک سفارش خرید یا یک مورد خط خاص.
نمایندگی JSON | |
---|---|
{ "id": string, "fulfillmentType": enum ( |
فیلدها | |
---|---|
id | شناسه منحصر به فرد برای این گزینه سرویس. |
fulfillmentType | مورد نیاز: نوع تحقق. |
expectedFulfillmentTime | یک پنجره اگر یک برد زمان مشخص شده یا ETA در صورت مشخص شدن زمان مشخص شده است. تحویل مورد انتظار یا زمان وانت. |
expectedPreparationTime | یک پنجره اگر یک برد زمان مشخص شده یا ETA در صورت مشخص شدن زمان مشخص شده است. زمان انتظار برای تهیه غذا. یک بار ترجیح داده می شود. |
location | وانت یا محل تحویل. |
expireTime | زمانی که در آن این گزینه تکمیل منقضی می شود. یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: |
price | هزینه این گزینه |
fulfillmentContact | تماس کاربر برای این تحقق. |
shippingMethodName | نام روش حمل و نقل انتخاب شده توسط کاربر. |
storeCode | ذخیره سازی محل. مثال: Walmart بازرگان است و StoreCode فروشگاه Walmart است که در آن انجام شده است. https://support.google.com/business/answer/3370250؟ref_topic=4596653 . |
pickupInfo | اطلاعات اضافی در مورد نحوه انتخاب سفارش. این قسمت فقط در صورت وانت انجام می شود. |
تایپ کنید
نوع تحقق
Enums | |
---|---|
TYPE_UNSPECIFIED | نوع نامشخص را تایپ کنید. |
DELIVERY | این سفارش تحویل داده می شود. |
PICKUP | این سفارش باید برداشت شود. |
زمان
سازه زمان برای نشان دادن زمان یک رویداد برای استفاده در هنگام نمایش سفارش به کاربر.
نمایندگی JSON | |
---|---|
{ "timeIso8601": string } |
فیلدها | |
---|---|
timeIso8601 | نمایانگر یک زمان سفارش سفارش مانند زمان رزرو ، زمان تحویل و غیره است. می تواند مدت زمان (زمان شروع و پایان) باشد ، فقط تاریخ ، زمان تاریخ و غیره. به https://en.wikipedia.org/wiki/iso_8601 برای همه قالب های پشتیبانی شده مراجعه کنید. |
اطلاعات پیکاپ
جزئیات مربوط به نحوه برداشت سفارش. این شامل جزئیاتی از قبیل نوع وانت و ابرداده های اضافی در صورت وجود است.
نمایندگی JSON | |
---|---|
{ "pickupType": enum ( |
فیلدها | |
---|---|
pickupType | روش انتخاب ، مانند instore ، curbside و غیره |
curbsideInfo | جزئیات خاص برای اطلاعات حاشیه. اگر Pickuptype "حاشیه" نباشد ، این زمینه نادیده گرفته می شود. |
checkInInfo[] | لیست روشهای مختلف پشتیبانی شده توسط شریک برای پشتیبانی از ورود به سیستم. |
نوع تریک
لیست انواع وانت پشتیبانی شده.
Enums | |
---|---|
UNSPECIFIED | نوع نامشخص را انتخاب کنید. |
INSTORE | غذا را در داخل رستوران انتخاب کنید. |
CURBSIDE | وسیله نقلیه پارک در یک مکان مشخص در خارج از رستوران و شخصی در آنجا غذا را تحویل می دهد. |
کنار کنار
جزئیات مربوط به نحوه تسهیل سفارش کنار.
نمایندگی JSON | |
---|---|
{ "curbsideFulfillmentType": enum ( |
فیلدها | |
---|---|
curbsideFulfillmentType | شرکا برای تسهیل سفارشات وانت کنار نیاز به اطلاعات اضافی دارند. بسته به انتخاب نوع تحقق ، جزئیات مربوطه از کاربر جمع آوری می شود. |
userVehicle | جزئیات وسیله نقلیه کاربر قرار دادن سفارش. |
curbsidedfulfillmenttype
مقادیر احتمالی انواع تحقق قسمت.
Enums | |
---|---|
UNSPECIFIED | نوع تحقق بخشیده به قسمت نامشخص. |
VEHICLE_DETAIL | جزئیات وسایل نقلیه مورد نیاز برای تسهیل وانت کنار. |
وسیله نقلیه
جزئیات مربوط به یک وسیله نقلیه
نمایندگی JSON | |
---|---|
{
"make": string,
"model": string,
"licensePlate": string,
"colorName": string,
"image": {
object ( |
فیلدها | |
---|---|
make | وسیله نقلیه (به عنوان مثال "هوندا"). این به کاربر نمایش داده می شود و باید بومی سازی شود. مورد نیاز. |
model | مدل وسیله نقلیه (به عنوان مثال "GROM"). این به کاربر نمایش داده می شود و باید بومی سازی شود. مورد نیاز. |
licensePlate | شماره پلاک خودرو (به عنوان مثال "1ABC234"). مورد نیاز. |
colorName | نام رنگ وسیله نقلیه ، به عنوان مثال. سیاه اختیاری. |
image | URL به یک عکس از وسیله نقلیه. این عکس در حدود 256x256px نمایش داده می شود. باید JPG یا PNG باشد. اختیاری. |
checkininfo
ابرداده مورد نیاز شریک برای پشتیبانی از یک روش checkin.
نمایندگی JSON | |
---|---|
{
"checkInType": enum ( |
فیلدها | |
---|---|
checkInType | روش استفاده شده برای ارسال دستورالعمل های checkin. |
چک
روشهای مختلفی که برای ارسال دستورالعمل های چک استفاده می شود.
Enums | |
---|---|
CHECK_IN_TYPE_UNSPECIFIED | مقدار ناشناخته |
EMAIL | اطلاعات چک از طریق ایمیل ارسال می شود. |
SMS | اطلاعات چک توسط پیام کوتاه ارسال می شود. |
مورد
افزودنی ها یا موارد زیر را نشان می دهد.
نمایندگی JSON | |
---|---|
{ "id": string, "name": string, "prices": [ { object ( |
فیلدها | |
---|---|
id | برای گزینه هایی که مواردی هستند ، شناسه مورد منحصر به فرد. |
name | نام گزینه |
prices[] | قیمت کل قیمت. |
note | یادداشت مربوط به گزینه |
quantity | برای گزینه هایی که موارد ، کمیت هستند. |
productId | محصول یا شناسه ارائه شده با این گزینه. |
subOptions[] | برای تعریف سایر گزینه های فرعی تو در تو. |
محصول
جزئیات مربوط به محصول.
نمایندگی JSON | |
---|---|
{ "productId": string, "gtin": string, "plu": string, "productType": string, "productAttributes": { string: string, ... } } |
فیلدها | |
---|---|
productId | محصول یا شناسه ارائه شده با این مورد خط. |
gtin | تعداد کالاهای تجاری جهانی محصول. مفید است اگر پیشنهاد در مرکز بازرگان وجود نداشته باشد. اختیاری. |
plu | کدهای جستجوی قیمت ، که معمولاً کدهای PLU ، شماره PLU ، به علاوه ، تولید کدها یا برچسب های تولیدی نامیده می شوند ، سیستم اعدادی هستند که به طور منحصر به فرد محصولات فله ای را که در فروشگاه های مواد غذایی و سوپر مارکت ها فروخته می شوند ، شناسایی می کنند. |
productType | دسته محصول تعریف شده توسط بازرگان. به عنوان مثال "خانه> مواد غذایی> لبنیات و تخم مرغ> شیر> شیر کامل" |
productAttributes | جزئیات مربوط به بازرگان در مورد محصول ، به عنوان مثال {"آلرژن": "بادام زمینی". مفید است اگر پیشنهاد در مرکز بازرگان وجود نداشته باشد. اختیاری. یک شیء حاوی لیستی از |
رزرواسیون
محتوای مورد خط برای سفارشات رزرو مانند رستوران ، مدل مو و غیره
نمایندگی JSON | |
---|---|
{ "status": enum ( |
فیلدها | |
---|---|
status | مورد نیاز: وضعیت رزرو. |
userVisibleStatusLabel | مورد نیاز: برچسب/رشته قابل مشاهده کاربر برای وضعیت. حداکثر طول مجاز 50 بار است. |
type | نوع رزرو اگر هیچ یک از گزینه های نوع کاربردی نباشد ، ممکن است غیرقانونی باشد. |
reservationTime | زمان برنامه ریزی سرویس/رویداد. می تواند یک محدوده زمانی ، تاریخ یا زمان دقیق تاریخ باشد. |
userAcceptableTimeRange | محدوده زمانی که برای کاربر قابل قبول است. |
confirmationCode | کد تأیید برای این رزرو. |
partySize | تعداد افراد |
staffFacilitators[] | کارکنان تسهیل کننده ای که در حال انجام رزرو هستند. مثال مدل مو. |
location | محل سرویس/رویداد. |
محل رزرو
وضعیت رزرو.
Enums | |
---|---|
RESERVATION_STATUS_UNSPECIFIED | وضعیت نامشخص |
PENDING | رزرو در انتظار است. |
CONFIRMED | رزرو تأیید شده است. |
CANCELLED | رزرو توسط کاربر لغو می شود. |
FULFILLED | رزرو انجام شده است. |
CHANGE_REQUESTED | تغییر رزرو درخواست می شود |
REJECTED | رزرو یا منقضی شده یا توسط یکپارچه سازی رد شده است. |
نوع رزرو
نوع رزرو
Enums | |
---|---|
RESERVATION_TYPE_UNSPECIFIED | نوع نامشخص |
RESTAURANT | رزرو برای رستوران. |
HAIRDRESSER | رزرو برای آرایشگاه. |
کارکنان
اطلاعات مربوط به شخص خدمات.
نمایندگی JSON | |
---|---|
{
"name": string,
"image": {
object ( |
فیلدها | |
---|---|
name | نام تسهیلگر کارکنان. مثال "جان اسمیت" |
image | تصاویر مجری |
پرداخت
داده های پرداخت مربوط به یک سفارش.
نمایندگی JSON | |
---|---|
{ "paymentResult": { object ( |
فیلدها | |
---|---|
paymentResult | نتیجه پرداختی که توسط یکپارچه برای انجام معامله استفاده می شود. اگر تجربه پرداخت توسط Action-on-Google مدیریت شود ، این قسمت توسط اقدامات موجود در Google جمع می شود. |
paymentInfo | اطلاعات پرداخت در مورد سفارش که برای تعامل کاربر با کاربر مفید است. |
مبلغ پرداخت
نتیجه پرداخت استفاده شده توسط یکپارچه برای انجام معامله.
نمایندگی JSON | |
---|---|
{ // Union field |
فیلدها | ||
---|---|---|
result میدان اتحادیه. یا داده پرداخت Google یا روش پرداخت بازرگان ارائه شده است. result فقط می تواند یکی از موارد زیر باشد: | ||
googlePaymentData | Google داده های روش پرداخت را ارائه داد. اگر پردازنده پرداخت شما به عنوان پردازنده پرداخت پشتیبانی Google در اینجا ذکر شده است: https://developers.google.com/pay/api/ از طریق لینک به پردازنده پرداخت خود بروید تا جزئیات بیشتری را پیدا کنید. در غیر این صورت ، برای جزئیات بار به مستندات زیر مراجعه کنید. https://developers.google.com/pay/api/payment-data-cryptography | |
merchantPaymentMethodId | بازرگان/اقدام روش پرداخت انتخاب شده توسط کاربر را ارائه داد. |
پرداخت
اطلاعات پرداخت در مورد سفارش انجام شده. این Proto اطلاعاتی را که برای تعامل کاربر در مواجهه مفید است ، ضبط می کند.
نمایندگی JSON | |
---|---|
{ "paymentMethodDisplayInfo": { object ( |
فیلدها | |
---|---|
paymentMethodDisplayInfo | اطلاعات نمایش روش پرداخت مورد استفاده برای معامله. |
paymentMethodProvenance | اثبات روش پرداخت مورد استفاده برای معامله. کاربر ممکن است روش پرداخت یکسانی را هم در Google و هم برای بازرگان ثبت کرده باشد. |
PaymentMethodDisplayInfo
نتیجه پرداخت استفاده شده توسط یکپارچه برای انجام معامله.
نمایندگی JSON | |
---|---|
{
"paymentType": enum ( |
فیلدها | |
---|---|
paymentType | نوع پرداخت |
paymentMethodDisplayName | نام قابل مشاهده کاربر روش پرداخت. به عنوان مثال ، ویزا **** 1234 بررسی acct **** 5678 |
paymentMethodVoiceName | نام روش پرداخت باید برای دستگاههای دستیار فقط صدا با کاربر صحبت شود. به عنوان مثال ، "ویزا پایان در یک دو سه چهار" یا "حساب چک که در پنج شش هفت هشت هشت" پایان یافته است. توجه: این رشته بهینه شده صوتی است که به جای پرداخت methoddisplayname برای دستگاه های دستیار فقط صدا استفاده می شود. اگر این رشته تنظیم نشده باشد ، در عوض PaymentMethodDisplayName نام برای کاربر صحبت می شود. |
نوع پرداخت
پرداخت نشان دهنده فرم پرداختی است که برای روش پرداخت ارائه شده توسط بازرگانان استفاده می شود. عمل همچنین باید یک نام نمایشگر برای روش پرداخت ارائه دهد.
Enums | |
---|---|
PAYMENT_TYPE_UNSPECIFIED | نوع پرداخت نامشخص. |
PAYMENT_CARD | کارت اعتباری/بدهی یا پیش پرداخت. |
BANK | روش پرداخت یک حساب بانکی است. |
LOYALTY_PROGRAM | روش پرداخت یک برنامه وفاداری است. |
CASH | روش پرداخت پول نقد است. |
GIFT_CARD | روش پرداخت کارت هدیه است. |
WALLET | کیف پول شخص ثالث ، یعنی پی پال |
پرداخت
نشان دهنده روش پرداخت استیضاح استفاده شده برای معامله است.
Enums | |
---|---|
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED | اثبات نامشخص است. |
PAYMENT_METHOD_PROVENANCE_GOOGLE | اثبات Google است. |
PAYMENT_METHOD_PROVENANCE_MERCHANT | اثبات بازرگان است. |
ارتقاء
تبلیغات/پیشنهادهایی که به سبد خرید اضافه شده است.
نمایندگی JSON | |
---|---|
{ "coupon": string } |
فیلدها | |
---|---|
coupon | مورد نیاز: کد کوپن برای این پیشنهاد اعمال می شود. |
frudorderextension
پسوند سفارش برای خرید عمودی. این خصوصیات برای کلیه موارد خط داخل به ترتیب کاربرد دارد ، مگر اینکه در یک مورد خط بیش از حد وجود داشته باشد.
نمایندگی JSON | |
---|---|
{ "status": enum ( |
فیلدها | |
---|---|
status | مورد نیاز: وضعیت کلی برای سفارش. |
userVisibleStatusLabel | برچسب/رشته قابل مشاهده کاربر برای وضعیت. حداکثر طول مجاز 50 بار است. |
type | مورد نیاز: نوع خرید. |
returnsInfo | اطلاعات را برای سفارش برگردانید. |
fulfillmentInfo | اطلاعات تحقق برای سفارش. |
purchaseLocationType | محل خرید (داخل فروشگاه / آنلاین) |
errors[] | اختیاری: خطاها به دلیل آن این ترتیب رد شد. |
extension | هر زمینه اضافی بین بازرگان و گوگل رد و بدل می شود. توجه: استفاده از این پسوند بسیار دلسرد است. بر اساس مورد/شرایط استفاده ، یکی از موارد زیر را در نظر بگیرید: 1- اگر می توان از آن برای سایر موارد استفاده استفاده کرد (به عنوان مثال توانایی/عملکرد عمومی) ، زمینه های موجود در خرید را تعریف کنید. 2. در صورت خاص بودن یک ویژگی/ویژگی استفاده غیر ژنتیکی ، از urdent_extension استفاده کنید. یک شیء حاوی زمینه هایی از نوع دلخواه. یک قسمت اضافی |
خرید و فروش
نوع موقعیت مکانی خرید.
Enums | |
---|---|
UNSPECIFIED_LOCATION | مقدار ناشناخته |
ONLINE_PURCHASE | تمام خریدهای خریداری شده بصورت آنلاین. |
INSTORE_PURCHASE | تمام خریدهای اینستور. |
خریدار
خطاهایی که سفارش خرید را می توان برای آن رد کرد.
نمایندگی JSON | |
---|---|
{ "type": enum ( |
فیلدها | |
---|---|
type | مورد نیاز: این نشان دهنده دلیل دانه ای است که یک سفارش توسط بازرگان رد می شود. |
description | توضیحات خطای اضافی |
entityId | شناسه موجودی که با خطا مطابقت دارد. مثال این می تواند با LineItemid / itemOptionID مطابقت داشته باشد. |
updatedPrice | در مورد نوع خطای Price_Changed / Arrect_Price مرتبط است. |
availableQuantity | اکنون مقدار موجود است. در صورت وجود در دسترس بودن قابل استفاده است. |
خط
انواع خطای احتمالی
Enums | |
---|---|
ERROR_TYPE_UNSPECIFIED | خطای ناشناخته |
NOT_FOUND | موجودیت یافت نشد ، می تواند مورد ، تحقق ، ارتقاء باشد. شناسه موجودیت لازم است. |
INVALID | داده های موجود معتبر نیستند. می تواند مورد ، تحقق ، ارتقاء باشد. شناسه موجودیت لازم است. |
AVAILABILITY_CHANGED | مورد در دسترس نیست یا موارد کافی برای انجام درخواست. شناسه موجودیت لازم است. |
PRICE_CHANGED | قیمت کالا متفاوت از قیمت موجود در موجودیت مورد. شناسه نهاد و قیمت به روز شده لازم است. |
INCORRECT_PRICE | خطاهای قیمت در هزینه ها ، در کل. شناسه نهاد و قیمت به روز شده لازم است. |
REQUIREMENTS_NOT_MET | محدودیت های پذیرش سفارش برآورده نشده است - حداقل اندازه سبد و غیره. ،. |
TOO_LATE | تحقق اتمام منقضی شد. |
NO_CAPACITY | بدون ظرفیت خدمات موجود. اگر هیچ یک از انواع خطای ریز ریزتر کاربرد ندارد ، از این کد خطا استفاده کنید. |
NO_COURIER_AVAILABLE | هیچ پیک تحویل یافت نمی شود. یک نوع خطای ریز دانه ای که ممکن است به عنوان NO_CAPACITY طبقه بندی شود. |
INELIGIBLE | کاربر واجد شرایط برای قرار دادن سفارش (لیست سیاه). |
OUT_OF_SERVICE_AREA | به دلیل قوانین مرزی و غیره قادر به ارائه آدرس درخواست شده نیست. |
CLOSED | رستوران در زمان سفارش برای تجارت بسته است. |
PROMO_NOT_APPLICABLE | کد خطای عمومی برای گرفتن کلیه موارد عدم استفاده از کد تبلیغی ، اگر هیچ یک از موارد زیر مناسب نیست. کد تبلیغاتی را به عنوان شناسه موجودیت اضافه کنید. |
PROMO_NOT_RECOGNIZED | کد کوپن توسط شریک شناخته نشده است. کد تبلیغاتی را به عنوان شناسه موجودیت اضافه کنید. |
PROMO_EXPIRED | با اتمام ارتقاء ، نمی تواند اعمال شود. کد تبلیغاتی را به عنوان شناسه موجودیت اضافه کنید. |
PROMO_USER_INELIGIBLE | کاربر فعلی واجد شرایط این کوپن نیست. کد تبلیغاتی را به عنوان شناسه موجودیت اضافه کنید. |
PROMO_ORDER_INELIGIBLE | سفارش فعلی واجد شرایط این کوپن نیست. کد تبلیغاتی را به عنوان شناسه موجودیت اضافه کنید. |
UNAVAILABLE_SLOT | شکاف پیش رو در دسترس نیست. |
FAILED_PRECONDITION | محدودیت برای پذیرش سفارش برآورده نشده است - حداقل اندازه سبد و غیره |
PAYMENT_DECLINED | پرداخت نامعتبر |
MERCHANT_UNREACHABLE | بازرگان قابل دسترسی نیست. این کمک می کند که شریک زندگی یک جمع باشد و نتواند به بازرگان برسد. |
ACCOUNT_LINKING_FAILED | بازرگان سعی کرد حساب Google کاربر را به یک حساب در سیستم خود پیوند دهد اما هنگام انجام این کار با خطایی روبرو شد. |
TicketOrderextension
سفارشات مربوط به سفارشات بلیط مانند فیلم ، ورزش و غیره را سفارش دهید
نمایندگی JSON | |
---|---|
{
"ticketEvent": {
object ( |
فیلدها | |
---|---|
ticketEvent | این رویداد برای کلیه بلیط های مورد خط اعمال می شود. |
تیک تیک
یک رویداد واحد را نشان می دهد.
نمایندگی JSON | |
---|---|
{ "type": enum ( |
فیلدها | |
---|---|
type | مورد نیاز: نوع رویداد بلیط ، به عنوان مثال فیلم ، کنسرت. |
name | مورد نیاز: نام این رویداد. به عنوان مثال ، اگر این رویداد یک فیلم است ، این باید نام فیلم باشد. |
description | توضیحات این رویداد. |
url | URL به اطلاعات رویداد. |
location | مکانی که در آن رویداد اتفاق می افتد ، یا یک سازمان در آن واقع شده است. |
eventCharacters[] | شخصیت های مربوط به این رویداد. این می تواند کارگردان یا بازیگران یک رویداد فیلم یا مجریان یک کنسرت و غیره باشد. |
startDate | زمان شروع |
endDate | زمان پایان |
doorTime | زمان ورود ، که ممکن است با زمان شروع رویداد متفاوت باشد. به عنوان مثال این رویداد از ساعت 9 صبح آغاز می شود ، اما زمان ورود 8:30 صبح است. |
تایپ کنید
نوع رویداد
Enums | |
---|---|
EVENT_TYPE_UNKNOWN | نوع رویداد ناشناخته. |
MOVIE | فیلم. |
CONCERT | کنسرت. |
SPORTS | ورزش. |
شخصیت
یک شخصیت یک رویداد ، به عنوان مثال سازمان دهنده ، مجری و غیره
نمایندگی JSON | |
---|---|
{ "type": enum ( |
فیلدها | |
---|---|
type | نوع شخصیت رویداد ، به عنوان مثال بازیگر یا کارگردان. |
name | نام شخصیت |
image | تصاویر شخصیت |
تایپ کنید
نوع شخصیت.
Enums | |
---|---|
TYPE_UNKNOWN | نوع ناشناخته |
ACTOR | بازیگر. |
PERFORMER | مجری. |
DIRECTOR | کارگردان. |
ORGANIZER | سازمان دهنده. |
استفاده از کاربری
اعلان کاربر اختیاری برای نمایش به عنوان بخشی از به روزرسانی سفارش.
نمایندگی JSON | |
---|---|
{ "title": string, "text": string } |
فیلدها | |
---|---|
title | عنوان برای اعلان کاربر. حداکثر طول مجاز 30 بار است. |
text | محتوای اعلان حداکثر طول مجاز 100 بار است. |
بعدی
نمایانگر صحنه ای است که باید اجرا شود.
نمایندگی JSON | |
---|---|
{ "name": string } |
فیلدها | |
---|---|
name | نام صحنه در مرحله بعدی اجرا می شود. |
جلسه
حاوی اطلاعاتی در مورد جلسه مکالمه فعلی است
نمایندگی JSON | |
---|---|
{
"id": string,
"params": {
string: value,
...
},
"typeOverrides": [
{
object ( |
فیلدها | |
---|---|
id | مورد نیاز. شناسه منحصر به فرد در مورد جلسه مکالمه فعلی. این فیلد فقط خواندنی است. |
params | مورد نیاز. لیست کلیه پارامترهای جمع آوری شده از فرم ها و اهداف در طول جلسه. کلید نام پارامتر است. پارامترهای تعریف شده در اینجا با پارامترهایی که قبلاً در جلسه تعریف شده اند ادغام می شوند. پارامترهای با مقدار تهی از جلسه حذف می شوند. به مستندات ذخیره سازی جلسه مراجعه کنید: https://developers.google.com/assistant/conversational/storage-session . یک شیء حاوی لیستی از |
typeOverrides[] | اختیاری. انواع مختلفی به جلسه. نوع جلسه تعریف می تواند انواع موجود را مکمل یا جایگزین کند. نام های نوع باید منحصر به فرد باشند. |
languageCode | زبان جلسه مکالمه فعلی. دنبال IETF BCP-47 کد زبان http://www.rfc-editor.org/rfc/bcp/bcp47.txt . اگر این اکشن از ویژگی های چند زبانی استفاده کند ، می تواند متفاوت از محل کاربر باشد. به عنوان مثال ، هنگامی که handler_response.expected.language_code تنظیم شده است ، زبان مکالمه را برای همه چرخش های زیر تغییر می دهد ، که در این زمینه منعکس می شود. |
نوع ترشی
نمایانگر یک نوع نادیده گرفتن برای یک نوع است.
نمایندگی JSON | |
---|---|
{ "name": string, "mode": enum ( |
فیلدها | |
---|---|
name | مورد نیاز. نام نوع برای تکمیل یا نادیده گرفتن. |
mode | مورد نیاز. نحوه ادغام این نوع با مقادیر دیگر. |
synonym | |
نوع ترشی
انواع اصلاحات برای یک نوع موجودیت جلسه.
Enums | |
---|---|
TYPE_UNSPECIFIED | مشخص نشده است این مقدار هرگز نباید استفاده شود. |
TYPE_REPLACE | تعاریف نوع در این پاسخ جایگزین تعاریف نوع است که قبلاً تعریف شده است. |
TYPE_MERGE | تعاریف نوع در این پاسخ با تعاریف نوع که قبلاً تعریف شده است ادغام می شود. تعاریف نوع جدید تعاریف نوع موجود را رونویسی می کند. |
نوع مترادف
نوعی با مترادف را نشان می دهد.
نمایندگی JSON | |
---|---|
{
"entries": [
{
object ( |
فیلدها | |
---|---|
entries[] | مورد نیاز. لیست ورودی ها برای نوع مترادف. |
ورود
یک ورودی برای یک نوع مترادف را نشان می دهد.
نمایندگی JSON | |
---|---|
{
"name": string,
"synonyms": [
string
],
"display": {
object ( |
فیلدها | |
---|---|
name | مورد نیاز. نام ورودی (به عنوان مثال "دوچرخه"). ورود در این زمینه باید در قسمت مترادف مکرر گنجانده شود تا به عنوان یک مقدار نوع معتبر مجدداً مورد استفاده قرار گیرد. |
synonyms[] | مورد نیاز. لیست مترادف برای ورود (به عنوان مثال "دوچرخه" ، "چرخه"). |
display | اختیاری. اطلاعات صفحه نمایش مورد |
نمایشگاه
نمایندگی JSON | |
---|---|
{ "title": string, "description": string, "image": { object ( |
فیلدها | |
---|---|
title | مورد نیاز. عنوان مورد هنگام ضربه زدن ، این متن به کلمه مکالمه ارسال می شود که گویی کاربر آن را تایپ کرده است. هر عنوان باید در بین مجموعه موارد مجموعه بی نظیر باشد. |
description | اختیاری. متن بدن کارت. |
image | اختیاری. تصویر برای نمایش. |
footer | اختیاری. متن پاورقی برای مورد مجموعه مرور ، در زیر توضیحات نمایش داده شده است. یک خط متن ، کوتاه با بیضی. |
openUrl | URL سند مرتبط با مرور کالای چرخ فلک. برای مرور چرخ فلک مورد نیاز است. |
کاربر
نمایانگر کاربر در حال درخواست برای عمل است.
نمایندگی JSON | |
---|---|
{ "locale": string, "params": { string: value, ... }, "accountLinkingStatus": enum ( |
فیلدها | |
---|---|
locale | تنظیم محلی محلی کاربر که درخواست را می کند. دنبال IETF BCP-47 کد زبان http://www.rfc-editor.org/rfc/bcp/bcp47.txt . با این حال ، subtag اسکریپت گنجانده نشده است. |
params | اختیاری. لیست کلیه پارامترهای مرتبط با کاربر فعلی. به اسناد ذخیره سازی کاربر مراجعه کنید: https://developers.google.com/assistant/conversational/storage-user . یک شیء حاوی لیستی از |
accountLinkingStatus | این که آیا حساب کاربری به برنامه مرتبط است یا خیر. |
verificationStatus | وضعیت تأیید کاربر را نشان می دهد. |
lastSeenTime | جدول زمانی آخرین تعامل با این کاربر. اگر کاربر قبلاً با نماینده تعامل نداشته باشد ، این قسمت از بین می رود. یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: |
engagement | تعامل کاربر فعلی شامل هرگونه اشتراک در اهداف. |
packageEntitlements[] | حق کاربر مربوط به بسته اندرویدی مرتبط با عمل فعلی. |
permissions[] | حاوی مجوزهای اعطا شده توسط کاربر به این اقدام است. |
ancountLinkingStatus
نشان می دهد که آیا کاربر نهایی حساب خود را به این برنامه پیوند داده است یا خیر. به اسناد پیوند به حساب مراجعه کنید: https://developers.google.com/assistant/entity .
Enums | |
---|---|
ACCOUNT_LINKING_STATUS_UNSPECIFIED | ناشناس. |
NOT_LINKED | کاربر حساب خود را به این برنامه پیوند نداده است. |
LINKED | کاربر حساب خود را به این برنامه پیوند داده است. |
UserVerificationStatus
نشان می دهد که آیا Google کاربر را تأیید کرده است یا خیر. یک وضعیت تأیید شده نشان می دهد که می توانید داده ها را در مکالمات با استفاده از قسمت Params یا با پیوند حساب ذخیره کنید.
Enums | |
---|---|
USER_VERIFICATION_STATUS_UNSPECIFIED | ناشناس. |
GUEST | کاربر مهمان. |
VERIFIED | کاربر تأیید شده |
نامزدی
اطلاعات فقط خواندنی را در مورد مکانیسم های تعامل که کاربر فعلی برای آن ثبت کرده است ارائه می دهد. به عنوان مثال ، می توان دانست که کاربر قبلاً مشترک است تا از آنها بخواهد که از آنها بخواهیم دوباره در همان هدف مشترک شوند ، مفید باشد. یعنی این اطلاعات را می توان به صورت مشروط به یک صحنه برای راه اندازی DailyUpdates یا PushNotifications فقط در صورتی که کاربر قبلاً مشترک نشده باشد ، استفاده کرد. به مستندات نامزدی کاربر مراجعه کنید: https://developers.google.com/assistant/engagement .
نمایندگی JSON | |
---|---|
{ "pushNotificationIntents": [ { object ( |
فیلدها | |
---|---|
pushNotificationIntents[] | شامل لیستی از اهداف است که کاربر برای اعلان فشار برای آن فعال کرده است. |
dailyUpdateIntents[] | شامل لیستی از اهداف است که کاربر به روزرسانی روزانه را برای آن فعال کرده است. |
فهرست بندی
توصیف یک متن موجود.
نمایندگی JSON | |
---|---|
{ "intent": string, "contentTitle": string } |
فیلدها | |
---|---|
intent | نام نیتی که در آن مشترک است. |
contentTitle | شرح کوتاهی از اشتراک. از آن به عنوان برچسب اعلان استفاده می شود و هنگامی که دستیار درخواست مجوز از کاربر را دارد. |
بسته بندی
لیستی از حق کاربر مربوط به نام بسته. به اسناد معامله خوب دیجیتال مراجعه کنید: https://developers.google.com/assistant/transactions/digital/dev-guide-digital-non-consumables .
نمایندگی JSON | |
---|---|
{
"packageName": string,
"entitlements": [
{
object ( |
فیلدها | |
---|---|
packageName | نام بسته اندرویدی که در بسته عمل مشخص شده است. |
entitlements[] | حق کاربر برای بسته داده شده. |
استحقاق
حق دیجیتالی کاربر را تعریف می کند.
نمایندگی JSON | |
---|---|
{ "sku": string, "skuType": enum ( |
فیلدها | |
---|---|
sku | محصول SKU. نام بسته برای برنامه پرداخت شده ، پسوند Finsky Docid برای خرید درون برنامه و اشتراک درون برنامه. Match GetSku () در بازی API INAPP BILLING API. به اسناد صورتحساب Play INAPP مراجعه کنید: https://developer.android.com/google/play/billing . |
skuType | نوع SKU. |
inAppDetails | فقط برای خرید درون برنامه و زیر مجموعه در برنامه موجود است. |
زاویه
Enums | |
---|---|
SKU_TYPE_UNSPECIFIED | |
IN_APP | خرید درون برنامه ای |
SUBSCRIPTION | اشتراک ها |
APP | برنامه های پولی |
امضا شده
نمایندگی JSON | |
---|---|
{ "inAppPurchaseData": { object }, "inAppDataSignature": string } |
فیلدها | |
---|---|
inAppPurchaseData | شامل تمام داده های خرید InApp با فرمت JSON است. جزئیات را در جدول 6 https://developer.android.com/google/play/billing/billing_reference.html مشاهده کنید. |
inAppDataSignature | مطابق با روش get -purchases () در بازی در API صورتحساب inapp. |
اجازه
مقادیر ممکن برای مجوز.
Enums | |
---|---|
PERMISSION_UNSPECIFIED | مجوز نامشخص |
DEVICE_PRECISE_LOCATION | از موقعیت مکانی دقیق کاربر ، عرض جغرافیایی/طول جغرافیایی و آدرس فرمت شده بخواهید. |
DEVICE_COARSE_LOCATION | از مکان درشت کاربر ، کد پستی ، شهر و کد کشور بخواهید. |
UPDATE | برای ارسال به روزرسانی مجوز بخواهید. به https://developers.google.com/assistant/engagement/daily مراجعه کنید. |
صفحه اصلی
ساختار Homegraph را نشان می دهد که دستگاه هدف کاربر به آن تعلق دارد.
نمایندگی JSON | |
---|---|
{ "params": { string: value, ... } } |
فیلدها | |
---|---|
params | اختیاری. لیست پارامترهای مرتبط با ساختار Homegraph که دستگاه هدف به آن تعلق دارد. به اسناد ذخیره سازی خانه مراجعه کنید: https://developers.google.com/assistant/conversational/storage-home . یک شیء حاوی لیستی از |
دستگاه
دستگاهی را که کاربر از آن استفاده می کند برای درخواست اقدامات نشان می دهد.
نمایندگی JSON | |
---|---|
{ "capabilities": [ enum ( |
فیلدها | |
---|---|
capabilities[] | مورد نیاز. قابلیت های دستگاه در حال درخواست برای عمل است. |
currentLocation | اختیاری. محل دستگاه کاربر. توجه داشته باشید ، این تنها پس از اعطای مجوزهای مکان توسط کاربر نهایی جمع می شود. برای اطلاعات بیشتر به پیام موقعیت مکانی مراجعه کنید که در مورد آن بسته به مجوز در مقابل ریز و درشت ریز تنظیم شده است. به مستندات مجوزها مراجعه کنید: https://developers.google.com/assistant/conversational/permissions . |
timeZone | اختیاری. منطقه زمانی مرتبط با دستگاه مشتری. می توان از آن برای حل مقادیر DateTime استفاده کرد. |
قابلیت
قابلیت هایی که سطح دستگاه در زمان درخواست پشتیبانی می کند.
Enums | |
---|---|
UNSPECIFIED | قابلیت دستگاه نامشخص. |
SPEECH | دستگاه می تواند از طریق متن به گفتار یا SSML با کاربر صحبت کند. |
RICH_RESPONSE | دستگاه می تواند پاسخ های غنی مانند کارت ، لیست و جداول را نشان دهد. |
LONG_FORM_AUDIO | دستگاه می تواند رسانه های صوتی فرم طولانی مانند موسیقی و پادکست ها را پخش کند. |
INTERACTIVE_CANVAS | دستگاه می تواند پاسخ بوم تعاملی را نشان دهد. |
WEB_LINK | دستگاه می تواند از پیوندهای وب در پاسخ های غنی برای باز کردن یک مرورگر وب استفاده کند. |
HOME_STORAGE | دستگاه می تواند از صرفه جویی و واکشی ذخیره سازی خانه پشتیبانی کند. |
مکان
ظرفی که یک مکان را نشان می دهد.
نمایندگی JSON | |
---|---|
{ "coordinates": { object ( |
فیلدها | |
---|---|
coordinates | مختصات GEO. به مجوز [دستگاه_پریس_لاکت] نیاز دارد. |
postalAddress | آدرس پستی به مجوز [دستگاه_پریس_لاکت] یا [device_coarse_location] نیاز دارد. هنگامی که مجوز موقعیت مکانی درشت اعطا می شود ، انتظار می رود که فقط زمینه های "postalcode" و "مکان" جمع شوند. مجوز موقعیت مکانی دقیق زمینه های اضافی مانند "Administrativeearea" و "خطوط آدرس" را جمع می کند. |
منطقه زمانی
یک منطقه زمانی را از پایگاه داده منطقه زمانی IANA نشان می دهد.
نمایندگی JSON | |
---|---|
{ "id": string, "version": string } |
فیلدها | |
---|---|
id | منطقه زمانی پایگاه داده منطقه زمانی IANA ، به عنوان مثال "America/New_york". |
version | اختیاری. شماره نسخه پایگاه داده منطقه زمانی IANA ، به عنوان مثال "2019a". |
زمینه
حاوی اطلاعات زمینه در هنگام پرس و جو است. چنین زمینه ای شامل اطلاعات مربوط به جلسه رسانه فعال ، وضعیت برنامه وب بوم و غیره نیست.
نمایندگی JSON | |
---|---|
{ "media": { object ( |
فیلدها | |
---|---|
media | حاوی اطلاعات زمینه در مورد جلسه رسانه فعال فعلی است. |
canvas | حاوی اطلاعات زمینه در مورد بوم فعلی است. |
مدافع
حاوی اطلاعات زمینه در مورد جلسه رسانه فعال فعلی است.
نمایندگی JSON | |
---|---|
{ "progress": string, "index": integer } |
فیلدها | |
---|---|
progress | پیشرفت رسانه ای پرونده رسانه فعال فعلی. مدت زمان در ثانیه با حداکثر نه رقم کسری ، توسط " |
index | 0 فهرست مبتنی بر پرونده رسانه فعال فعلی در لیست پرونده های رسانه ای در پاسخ رسانه. |
بیدوست متن
حاوی اطلاعات زمینه در مورد بوم فعلی است.
نمایندگی JSON | |
---|---|
{ "state": value } |
فیلدها | |
---|---|
state | اختیاری. حالت تنظیم شده توسط برنامه بوم تعاملی 3p. این فقط برای درخواست تنظیم شده است ، نه برای پاسخ. به عنوان مثال ، اگر این یک برنامه دستور العمل باشد ، حالت می تواند یک مقدار ساختار باشد: {"current_page": 5 ، "last_page": 3 ،} اندازه اندازه 50kb است. |
مورد انتظار
انتظارات برای چرخش گفتگوی بعدی را توصیف می کند.
نمایندگی JSON | |
---|---|
{ "speech": [ string ] } |
فیلدها | |
---|---|
speech[] | لیست عبارات این عمل از گفته کاربر برای تعصب گفتار انتظار دارد. حداکثر 1000 عبارت مجاز است. توجه: این قسمت همان معنای مورد انتظار را دارد. speech_biasing_hints در API V2. |