Method: fulfill

RPC که نشان دهنده API تحقق است

درخواست HTTP

POST https://webhook_handler_service.googleapis.com/fulfill

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "handler": {
    object (Handler)
  },
  "intent": {
    object (Intent)
  },
  "scene": {
    object (Scene)
  },
  "session": {
    object (Session)
  },
  "user": {
    object (User)
  },
  "home": {
    object (Home)
  },
  "device": {
    object (Device)
  },
  "context": {
    object (Context)
  }
}
زمینه های
handler

object ( Handler )

ضروری. اطلاعاتی در مورد نحوه رسیدگی به درخواست. به عنوان مثال درخواستی که قصد دریافت یک واقعیت را دارد ممکن است دارای یک کنترل کننده با نام "getFact" باشد.

intent

object ( Intent )

ضروری. نشان دهنده آخرین هدف منطبق است. به https://developers.google.com/assistant/conversational/intents مراجعه کنید.

scene

object ( Scene )

اختیاری. اطلاعات صحنه فعلی و بعدی هنگام فراخوانی تابع. زمانی که فراخوان تکمیل در محدوده یک صحنه انجام شود پر می شود. به https://developers.google.com/assistant/conversational/scenes مراجعه کنید.

session

object ( Session )

ضروری. داده های جلسه مانند شناسه جلسه و پارامترهای جلسه را نگه می دارد.

user

object ( User )

ضروری. کاربری که مکالمه را آغاز کرده است.

home

object ( Home )

اختیاری. اطلاعات مربوط به ساختار HomeGraph که دستگاه مورد نظر به آن تعلق دارد. به https://developers.google.com/actions/smarthome/concepts/homegraph مراجعه کنید.

device

object ( Device )

ضروری. اطلاعات دستگاهی که کاربر برای تعامل با Action استفاده می کند.

context

object ( Context )

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

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نشان دهنده پاسخی است که از اجرای برنامه‌نویس به Actions on Google ارسال شده است.

نمایندگی JSON
{
  "prompt": {
    object (Prompt)
  },
  "scene": {
    object (Scene)
  },
  "session": {
    object (Session)
  },
  "user": {
    object (User)
  },
  "home": {
    object (Home)
  },
  "device": {
    object (Device)
  },
  "expected": {
    object (Expected)
  }
}
زمینه های
prompt

object ( Prompt )

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

scene

object ( Scene )

اختیاری. نمایانگر صحنه فعلی و بعدی است. اگر Scene.next تنظیم شود، زمان اجرا بلافاصله به صحنه مشخص شده منتقل می شود.

session

object ( Session )

اختیاری. داده‌های جلسه جاری را توصیف می‌کند، پارامترهای جلسه را می‌توان ایجاد، به‌روزرسانی یا حذف کرد.

user

object ( User )

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

home

object ( Home )

اختیاری. برای تعیین پارامترهای مربوط به ساختار HomeGraph که دستگاه مورد نظر به آن تعلق دارد استفاده می شود. به https://developers.google.com/actions/smarthome/concepts/homegraph مراجعه کنید.

device

object ( Device )

اختیاری. برای جابه‌جایی بین دستگاه‌های «دستیار» که کاربر به آنها دسترسی دارد، استفاده کنید.

expected

object ( Expected )

اختیاری. انتظارات برای نوبت گفتگوی بعدی را شرح می دهد.

هندلر

نشان‌دهنده یک کنترل‌کننده انجام است که اطلاعات رویداد را از Actions on Google به انجام نگاشت می‌کند. از نام کنترل کننده برای تعیین کدی که باید اجرا کنید استفاده کنید. به عنوان مثال، یک کنترل کننده ممکن است برای دریافت اطلاعات در مورد اطلاعات سفارش کاربر با نام کنترل کننده مانند "OrderLookup" استفاده شود، در حالی که دیگری ممکن است اطلاعات محصول را از یک پایگاه داده، با نام کنترل کننده مانند "GetProductInfo" دریافت کند.

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

string

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

قصد

نشان دهنده یک قصد است. به https://developers.google.com/assistant/conversational/intents مراجعه کنید.

نمایندگی JSON
{
  "name": string,
  "params": {
    string: {
      object (IntentParameterValue)
    },
    ...
  },
  "query": string
}
زمینه های
name

string

ضروری. نام آخرین هدف مطابق.

params

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

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

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

query

string

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

IntentParameterValue

مقداری را برای پارامتر intent نشان می دهد. به https://developers.google.com/assistant/conversational/types مراجعه کنید.

نمایندگی JSON
{
  "original": string,
  "resolved": value
}
زمینه های
original

string

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

resolved

value ( Value format)

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

صحنه

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

نمایندگی JSON
{
  "name": string,
  "slotFillingStatus": enum (SlotFillingStatus),
  "slots": {
    string: {
      object (Slot)
    },
    ...
  },
  "next": {
    object (NextScene)
  }
}
زمینه های
name

string

ضروری. نام صحنه فعلی

slotFillingStatus

enum ( SlotFillingStatus )

ضروری. وضعیت فعلی پر شدن اسلات. این فیلد فقط خواندنی است.

slots

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

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

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

next

object ( NextScene )

اختیاری. اطلاعات مربوط به صحنه در مرحله بعدی اجرا می شود.

SlotFillingStatus

وضعیت فعلی پر شدن اسلات را نشان می دهد.

Enums
UNSPECIFIED مقدار بازگشتی زمانی که فیلد استفاده پر نشده باشد.
INITIALIZED شکاف ها مقداردهی اولیه شده اند اما پر کردن شکاف شروع نشده است.
COLLECTING مقادیر اسلات در حال جمع آوری هستند.
FINAL همه مقادیر اسلات نهایی هستند و قابل تغییر نیستند.

اسلات

نشان دهنده یک اسلات است.

نمایندگی JSON
{
  "mode": enum (SlotMode),
  "status": enum (SlotStatus),
  "value": value,
  "updated": boolean,
  "prompt": {
    object (Prompt)
  }
}
زمینه های
mode

enum ( SlotMode )

حالت اسلات (الزامی یا اختیاری). می تواند توسط توسعه دهنده تنظیم شود.

status

enum ( SlotStatus )

وضعیت اسلات.

value

value ( Value format)

ارزش شکاف. با تغییر این مقدار در پاسخ، مقدار در پر کردن شکاف تغییر خواهد کرد.

updated

boolean

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

prompt

object ( 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 (Simple)
  },
  "content": {
    object (Content)
  },
  "lastSimple": {
    object (Simple)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (Link)
  },
  "canvas": {
    object (Canvas)
  },
  "orderUpdate": {
    object (OrderUpdate)
  }
}
زمینه های
override

boolean

اختیاری. حالت نحوه ادغام این پیام‌ها با پیام‌های تعریف‌شده قبلی. "true" تمام پیام های تعریف شده قبلی (اولین و آخرین ساده، محتوا، پیوند پیشنهادات و بوم) را پاک می کند و پیام های تعریف شده در این اعلان را اضافه می کند. "false" پیام های تعریف شده در این اعلان را به پیام های تعریف شده در پاسخ های قبلی اضافه می کند. رها کردن این فیلد روی "نادرست" همچنین افزودن به برخی از فیلدهای داخل فرمان های ساده، اعلان پیشنهادات و اعلان Canvas (بخشی از اعلان محتوا) را امکان پذیر می کند. اگر در اعلان تعریف شده باشد، پیام‌های محتوا و پیوند همیشه بازنویسی می‌شوند. مقدار پیش فرض "نادرست" است.

firstSimple

object ( Simple )

اختیاری. اولین پاسخ صوتی و متنی.

content

object ( Content )

اختیاری. محتوایی مانند کارت، فهرست یا رسانه برای نمایش به کاربر.

lastSimple

object ( Simple )

اختیاری. آخرین پاسخ صوتی و متنی.

suggestions[]

object ( Suggestion )

اختیاری. پیشنهاداتی برای نمایش به کاربر که همیشه در انتهای پاسخ ظاهر می شوند. اگر فیلد «نسخ» در فرمان حاوی «نادرست» باشد، عناوین تعریف‌شده در این قسمت به عناوین تعریف‌شده در هر فرمان پیشنهادی تعریف‌شده قبلی اضافه می‌شوند و مقادیر تکراری حذف می‌شوند.

canvas

object ( Canvas )

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

orderUpdate

object ( OrderUpdate )

اقدام اختیاری پس از دریافت سفارش در جریان تراکنش، با OrderUpdate پاسخ می دهد. پس از دریافت این، Google این به‌روزرسانی را در سفارش ثبت می‌کند و در صورت موفقیت‌آمیز، یک کارت رسید را به همراه TTS ارسال شده روی دستگاه‌های نمایشگر نمایش می‌دهد.

ساده

نشان دهنده یک اعلان ساده برای ارسال به کاربر است. به https://developers.google.com/assistant/conversational/prompts-simple مراجعه کنید.

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

string

اختیاری. بیانگر گفتاری است که باید به کاربر گفته شود. می تواند SSML یا متن به گفتار باشد. اگر قسمت "override" در دستور حاوی "true" باشد، گفتار تعریف شده در این قسمت جایگزین گفتار Simple prompt قبلی می شود. به https://developers.google.com/assistant/conversational/ssml مراجعه کنید.

text

string

متن اختیاری برای نمایش در حباب چت. در صورت عدم ارائه، یک نمایش نمایشی از قسمت گفتار بالا استفاده خواهد شد. محدود به 640 کاراکتر. اگر فیلد «override» در اعلان حاوی «true» باشد، متن تعریف شده در این قسمت جایگزین متن دستور Simple قبلی می شود.

محتوا

شی کانتینر برای درخواست‌های غنی یا درخواست‌های انتخاب.

نمایندگی JSON
{

  // Union field content can be only one of the following:
  "card": {
    object (Card)
  },
  "image": {
    object (Image)
  },
  "table": {
    object (Table)
  },
  "media": {
    object (Media)
  },
  "collection": {
    object (Collection)
  },
  "list": {
    object (List)
  },
  "collectionBrowse": {
    object (CollectionBrowse)
  }
  // End of list of possible types for union field content.
}
زمینه های

content زمینه اتحادیه

content فقط می تواند یکی از موارد زیر باشد:

card

object ( Card )

یک کارت پایه

image

object ( Image )

یک تصویر.

table

object ( Table )

کارت جدول.

media

object ( Media )

پاسخ نشان‌دهنده مجموعه‌ای از رسانه‌ها برای پخش.

collection

object ( Collection )

کارتی که مجموعه ای از گزینه ها را برای انتخاب ارائه می دهد.

list

object ( List )

کارتی که فهرستی از گزینه ها را برای انتخاب ارائه می دهد.

collectionBrowse

object ( CollectionBrowse )

کارتی که مجموعه ای از صفحات وب را برای باز کردن ارائه می دهد.

کارت

یک کارت اصلی برای نمایش برخی از اطلاعات، به عنوان مثال یک تصویر و/یا متن. به https://developers.google.com/assistant/conversational/prompts-rich#basic_card مراجعه کنید.

نمایندگی JSON
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (Image)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (Link)
  }
}
زمینه های
title

string

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

subtitle

string

اختیاری.

text

string

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

image

object ( Image )

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

imageFill

enum ( ImageFill )

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

button

object ( Link )

دکمه با لینک خروجی. اختیاری.

تصویر

تصویری که در کارت نمایش داده می شود. به https://developers.google.com/assistant/conversational/prompts-rich#image-cards مراجعه کنید.

نمایندگی 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
GRAY شکاف بین تصویر و محفظه تصویر را با نوارهای خاکستری پر کنید.
WHITE شکاف بین تصویر و محفظه تصویر را با نوارهای سفید پر کنید.
CROPPED تصویر به گونه ای مقیاس بندی می شود که عرض و ارتفاع تصویر با ابعاد ظرف مطابقت داشته باشد یا بیشتر از آن باشد. اگر ارتفاع تصویر کوچک‌شده بیشتر از ارتفاع ظرف باشد، ممکن است بالا و پایین تصویر را برش دهد، یا اگر عرض تصویر مقیاس‌شده از عرض ظرف بیشتر باشد، سمت چپ و راست تصویر را برش دهد. این شبیه به "حالت زوم" در تلویزیون با صفحه عریض هنگام پخش یک ویدیوی 4:3 است.

OpenUrl

نمایندگی JSON
{
  "url": string,
  "hint": enum (UrlHint)
}
زمینه های
url

string

فیلد url که می تواند یکی از این موارد باشد: - آدرس های http/https برای باز کردن یک برنامه مرتبط با برنامه یا یک صفحه وب

hint

enum ( UrlHint )

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

UrlHint

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

Enums
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 (Image)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (Link)
  }
}
زمینه های
title

string

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

subtitle

string

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

image

object ( Image )

تصویر مرتبط با جدول اختیاری.

columns[]

object ( TableColumn )

سرصفحه ها و تراز ستون ها.

rows[]

object ( TableRow )

داده های ردیف جدول 3 ردیف اول تضمین شده است که نشان داده می شوند اما سایر ردیف ها ممکن است بر روی سطوح خاصی بریده شوند. لطفاً با شبیه ساز تست کنید تا ببینید کدام ردیف برای یک سطح مشخص نشان داده می شود. در سطوحی که از قابلیت WEB_BROWSER پشتیبانی می کنند، می توانید کاربر را به صفحه وب با داده های بیشتر هدایت کنید.

button

object ( Link )

دکمه.

ستون جدول

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

string

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

align

enum ( HorizontalAlignment )

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

تراز افقی

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

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

TableRow

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

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

object ( TableCell )

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

divider

boolean

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

TableCell

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

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

string

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

رسانه ها

یک شی رسانه ای را نشان می دهد. حاوی اطلاعاتی درباره رسانه، مانند نام، توضیحات، آدرس اینترنتی و غیره است. https://developers.google.com/assistant/conversational/prompts-media را ببینید.

نمایندگی JSON
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ],
  "repeatMode": enum (RepeatMode),
  "firstMediaObjectIndex": integer
}
زمینه های
mediaType

enum ( MediaType )

startOffset

string ( Duration format)

شروع افست اولین شی رسانه ای.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' خاتمه می یابد. مثال: "3.5s" .

optionalMediaControls[]

enum ( OptionalMediaControls )

انواع کنترل رسانه اختیاری که این جلسه پاسخ رسانه می تواند پشتیبانی کند. در صورت تنظیم، زمانی که یک رویداد رسانه ای خاص اتفاق می افتد، درخواست به 3p ارسال می شود. اگر تنظیم نشده باشد، 3p همچنان باید دو نوع کنترل پیش‌فرض، FINISHED و FAILED را کنترل کند.

mediaObjects[]

object ( MediaObject )

فهرست اشیاء رسانه ای

repeatMode

enum ( RepeatMode )

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

firstMediaObjectIndex

integer

شاخص مبتنی بر 0 اولین Media Object در mediaObjects برای پخش. اگر نامشخص، صفر یا خارج از محدوده باشد، پخش از اولین شی رسانه در mediaObjects شروع می شود.

نوع رسانه

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

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 (MediaImage)
  }
}
زمینه های
name

string

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

description

string

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

url

string

نشانی اینترنتی که به محتوای رسانه اشاره دارد. فایل‌های MP3 باید روی سرور وب میزبانی شوند و از طریق یک URL HTTPS در دسترس عموم قرار گیرند. پخش زنده فقط برای فرمت MP3 پشتیبانی می شود.

image

object ( MediaImage )

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

MediaImage

نمایندگی JSON
{

  // Union field image can be only one of the following:
  "large": {
    object (Image)
  },
  "icon": {
    object (Image)
  }
  // End of list of possible types for union field image.
}
زمینه های

image میدان اتحادیه

image می تواند تنها یکی از موارد زیر باشد:

large

object ( Image )

یک تصویر بزرگ، مانند جلد آلبوم و غیره.

icon

object ( Image )

یک نماد تصویر کوچک در سمت راست عنوان نمایش داده شده است. اندازه آن به 36x36 dp تغییر یافته است.

حالت تکرار

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

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

مجموعه

کارتی برای ارائه مجموعه ای از گزینه ها برای انتخاب. به https://developers.google.com/assistant/conversational/prompts-selection#collection مراجعه کنید

نمایندگی JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
زمینه های
title

string

عنوان مجموعه. اختیاری.

subtitle

string

زیرنویس مجموعه. اختیاری.

items[]

object ( CollectionItem )

لیستی از موارد می تواند دقیقه 2 و حداکثر 10 باشد.

imageFill

enum ( ImageFill )

نحوه پر شدن پس زمینه تصویر آیتم های مجموعه اختیاری.

مجموعه آیتم

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

نمایندگی JSON
{
  "key": string
}
زمینه های
key

string

ضروری. کلید NLU که با نام کلید ورودی در نوع مرتبط مطابقت دارد.

فهرست کنید

کارتی برای ارائه لیستی از گزینه ها برای انتخاب. به https://developers.google.com/assistant/conversational/prompts-selection#list مراجعه کنید

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

string

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

subtitle

string

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

items[]

object ( ListItem )

لیستی از موارد می تواند دقیقه 2 و حداکثر 30 باشد.

List Item

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

نمایندگی JSON
{
  "key": string
}
زمینه های
key

string

ضروری. کلید NLU که با نام کلید ورودی در نوع مرتبط مطابقت دارد.

مجموعه مرور

مجموعه ای از اسناد وب را به عنوان مجموعه ای از آیتم های کاشی بزرگ ارائه می دهد. موارد ممکن است برای راه اندازی سند وب مرتبط خود در یک نمایشگر وب انتخاب شوند. https://developers.google.com/assistant/conversational/prompts-selection#collectionBrowse را ببینید.

نمایندگی JSON
{
  "items": [
    {
      object (Item)
    }
  ],
  "imageFill": enum (ImageFill)
}
زمینه های
items[]

object ( Item )

لیستی از موارد می تواند دقیقه 2 و حداکثر 10 باشد.

imageFill

enum ( ImageFill )

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

مورد

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

نمایندگی JSON
{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (Image)
  },
  "openUriAction": {
    object (OpenUrl)
  }
}
زمینه های
title

string

ضروری. عنوان آیتم مجموعه.

description

string

شرح آیتم مجموعه

footer

string

متن پاورقی برای آیتم مجموعه، در زیر توضیحات نمایش داده شده است. تک خط متن، کوتاه شده با بیضی.

image

object ( Image )

تصویر برای آیتم مجموعه.

openUriAction

object ( OpenUrl )

ضروری. URI برای باز کردن در صورت انتخاب مورد.

پیشنهاد

وقتی «دستیار» درخواست را نمایش می‌دهد، پیشنهادها تراشه‌های پیشنهادی را در دستگاه‌های دارای نمایشگر به کاربران ارائه می‌دهند. از تراشه‌های پیشنهاد برای اشاره به پاسخ‌های کاربر برای ادامه یا تغییر مکالمه استفاده کنید. هنگامی که ضربه بزنید، یک تراشه پیشنهاد متن نمایش داده شده را کلمه به کلمه به مکالمه باز می گرداند، گویی که کاربر آن را تایپ کرده است. به https://developers.google.com/assistant/conversational/prompts#suggestions مراجعه کنید،

نمایندگی JSON
{
  "title": string
}
زمینه های
title

string

ضروری. متن نشان داده شده در تراشه پیشنهاد. وقتی روی آن ضربه بزنید، این متن به طور کلمه به مکالمه ارسال می شود، گویی که کاربر آن را تایپ کرده است. هر عنوان باید در میان مجموعه تراشه های پیشنهادی منحصر به فرد باشد. حداکثر 25 کاراکتر

بوم

نشان دهنده یک پاسخ بوم تعاملی برای ارسال به کاربر است. این می تواند همراه با فیلد "firstSimple" در اعلان حاوی برای صحبت با کاربر علاوه بر نمایش پاسخ بوم تعاملی استفاده شود. حداکثر اندازه پاسخ 50 هزار بایت است. به https://developers.google.com/assistant/interactivecanvas مراجعه کنید.

نمایندگی JSON
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "continuousMatchConfig": {
    object (ContinuousMatchConfig)
  }
}
زمینه های
url

string

URL برنامه وب بوم تعاملی برای بارگیری. اگر تنظیم نشود، آدرس اینترنتی بوم فعال فعلی مجدداً استفاده خواهد شد.

data[]

value ( Value format)

اختیاری. داده های JSON به عنوان یک رویداد به صفحه وب تجربه همهجانبه منتقل می شود. اگر فیلد «نسخ» در فرمان حاوی «نادرست» باشد، مقادیر داده‌های تعریف‌شده در این فرمان Canvas پس از مقادیر داده‌های تعریف‌شده در درخواست‌های قبلی Canvas اضافه می‌شوند.

suppressMic

boolean

اختیاری. مقدار پیش فرض: false.

continuousMatchConfig

object ( ContinuousMatchConfig )

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

ContinuousMatchConfig

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

نمایندگی JSON
{
  "expectedPhrases": [
    {
      object (ExpectedPhrase)
    }
  ],
  "durationSeconds": integer
}
زمینه های
expectedPhrases[]

object ( ExpectedPhrase )

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

durationSeconds

integer

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

عبارت مورد انتظار

نمایندگی JSON
{
  "phrase": string,
  "alternativePhrases": [
    string
  ]
}
زمینه های
phrase

string

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

alternativePhrases[]

string

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

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

به روز رسانی به یک سفارش.

نمایندگی JSON
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
زمینه های
type
(deprecated)

enum ( Type )

منسوخ شده: به جای آن از OrderUpdate.update_mask استفاده کنید. اگر نوع = SNAPSHOT، OrderUpdate.order باید کل سفارش باشد. اگر نوع = ORDER_STATUS، این تغییر وضعیت سطح سفارش است. فقط order.last_update_time و این وضعیت عمودی انتخاب می شوند. توجه: type.ORDER_STATUS فقط از به‌روزرسانی‌های وضعیت PurcahaseOrderExtension پشتیبانی می‌کند و برنامه‌ای برای گسترش این پشتیبانی وجود ندارد. در عوض، توصیه می‌کنیم از updateMask استفاده کنید، زیرا عمومی‌تر، قابل توسعه‌تر است و می‌تواند برای همه عمودی‌ها استفاده شود.

order

object ( Order )

updateMask

string ( FieldMask format)

توجه: توجه/توصیه های زیر برای فیلدهای ویژه زیر وجود دارد: 1. order.last_update_time همیشه به عنوان بخشی از درخواست به روز رسانی به روز می شود. 2. order.create_time، order.google_order_id و order.merchant_order_id در صورت ارائه به عنوان بخشی از updateMask نادیده گرفته خواهند شد.

این فهرستی از نام‌های فیلدهای کاملاً واجد شرایط با کاما است. مثال: "user.displayName,photo" .

userNotification

object ( UserNotification )

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

reason

string

دلیل تغییر/به روز رسانی

تایپ کنید

منسوخ شده: به جای آن از 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 (UserInfo)
  },
  "image": {
    object (Image)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "transactionMerchant": {
    object (Merchant)
  },
  "contents": {
    object (Contents)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "paymentData": {
    object (PaymentData)
  },
  "termsOfServiceUrl": string,
  "note": string,
  "promotions": [
    {
      object (Promotion)
    }
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseOrderExtension)
  },
  "ticket": {
    object (TicketOrderExtension)
  }
  // End of list of possible types for union field verticals.
}
زمینه های
googleOrderId

string

Google شناسه سفارش را اختصاص داد.

merchantOrderId

string

مورد نیاز: شناسه سفارش داخلی به تاجر اختصاص داده شده است. این شناسه باید منحصر به فرد باشد و برای عملیات به روز رسانی بعدی سفارش لازم است. این شناسه ممکن است روی googleOrderId ارائه شده یا هر مقدار منحصر به فرد دیگری تنظیم شود. توجه داشته باشید که شناسه ارائه شده به کاربران userVisibleOrderId است که ممکن است مقداری متفاوت و کاربرپسندتر باشد. حداکثر طول مجاز 128 کاراکتر است.

userVisibleOrderId

string

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

userVisibleStateLabel
(deprecated)

string

منسوخ شده: به جای آن از وضعیت OrderExtensions استفاده کنید. برچسب قابل مشاهده توسط کاربر برای وضعیت این سفارش.

buyerInfo

object ( UserInfo )

اطلاعات در مورد خریدار

image

object ( Image )

تصویر مرتبط با سفارش

createTime

string ( Timestamp format)

مورد نیاز: تاریخ و زمان ایجاد سفارش.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

lastUpdateTime

string ( Timestamp format)

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

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

transactionMerchant

object ( Merchant )

تاجری که تسویه حساب را تسهیل کرد. این می‌تواند با ارائه‌دهنده سطح مورد خطی متفاوت باشد. مثال: سفارش Expedia با مورد خط از ANA.

contents

object ( Contents )

مورد نیاز: محتویات را سفارش دهید که گروهی از موارد خطی است.

priceAttributes[]

object ( PriceAttribute )

قیمت، تخفیف، مالیات و غیره.

followUpActions[]

object ( Action )

پیگیری اقدامات در سطح سفارش

paymentData

object ( PaymentData )

داده های مربوط به پرداخت برای سفارش

termsOfServiceUrl

string

پیوندی به شرایط خدمات مربوط به سفارش/سفارش پیشنهادی.

note

string

یادداشت های پیوست شده به سفارش

promotions[]

object ( Promotion )

همه تبلیغاتی که با این سفارش مرتبط هستند.

disclosures[]

object ( Disclosure )

افشاهای مرتبط با این سفارش.

vertical
(deprecated)

object

منسوخ شده: به جای آن از عمودی استفاده کنید. این ویژگی ها برای همه موارد خط اعمال می شود، مگر اینکه در برخی از موارد خطی لغو شوند. این عمودی باید با نوع عمودی سطح مورد خط مطابقت داشته باشد. مقادیر ممکن: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

یک شی حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی "@type" حاوی یک URI است که نوع را مشخص می کند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" } .

verticals میدان اتحادیه این ویژگی ها برای همه موارد خط اعمال می شود، مگر اینکه در برخی از موارد خطی لغو شوند. این عمودی باید با نوع عمودی سطح مورد خط مطابقت داشته باشد. verticals فقط می توانند یکی از موارد زیر باشند:
purchase

object ( PurchaseOrderExtension )

سفارش خرید

ticket

object ( TicketOrderExtension )

سفارش بلیط

اطلاعات کاربر

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

نمایندگی JSON
{
  "email": string,
  "firstName": string,
  "lastName": string,
  "displayName": string,
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ]
}
زمینه های
email

string

ایمیل کاربر، به عنوان مثال: janedoe@gmail.com .

firstName

string

نام کاربر.

lastName

string

نام خانوادگی کاربر.

displayName

string

نام نمایشی کاربر، ممکن است با نام یا نام خانوادگی متفاوت باشد.

phoneNumbers[]

object ( PhoneNumber )

شماره تلفن های کاربر

شماره تلفن

نمایندگی شماره تلفن استاندارد

نمایندگی JSON
{
  "e164PhoneNumber": string,
  "extension": string,
  "preferredDomesticCarrierCode": string
}
زمینه های
e164PhoneNumber

string

شماره تلفن در قالب E.164، همانطور که در توصیه اتحادیه بین المللی مخابرات (ITU) E.164 تعریف شده است. پیوند ویکی: https://en.wikipedia.org/wiki/E.164

extension

string

برنامه افزودنی در توصیه های ITU استاندارد نشده است، به جز اینکه به عنوان مجموعه ای از اعداد با طول حداکثر 40 رقم تعریف شده است. در اینجا به‌عنوان رشته‌ای تعریف می‌شود که برای استفاده احتمالی از صفر اصلی در برنامه افزودنی استفاده می‌شود (سازمان‌ها آزادی کامل برای انجام این کار دارند، زیرا هیچ استانداردی تعریف نشده است). به غیر از ارقام، برخی از کاراکترهای شماره گیری دیگر مانند "," (که نشان دهنده انتظار است) ممکن است در اینجا ذخیره شوند. به عنوان مثال، در xxx-xxx-xxxx ext. 123، "123" پسوند است.

preferredDomesticCarrierCode

string

کد انتخاب شرکت مخابراتی که هنگام تماس با این شماره تلفن داخلی ترجیح داده می شود. این همچنین شامل کدهایی است که در برخی کشورها هنگام تماس از تلفن ثابت به تلفن همراه یا بالعکس باید شماره گیری شوند. به عنوان مثال، در کلمبیا، هنگام تماس از تلفن همراه به تلفن ثابت داخلی، یک "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

string

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

accessibilityText

string

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

height

integer

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

width

integer

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

بازرگان

تاجر برای سبد خرید/سفارش/خط مورد.

نمایندگی JSON
{
  "id": string,
  "name": string,
  "image": {
    object (Image)
  },
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "address": {
    object (Location)
  }
}
زمینه های
id

string

شناسه اختیاری به تاجر در صورت وجود اختصاص داده می‌شود.

name

string

نام تاجر مانند "نان پانرا".

image

object ( Image )

تصویر مرتبط با تاجر.

phoneNumbers[]

object ( PhoneNumber )

شماره تلفن های تاجر

address

object ( Location )

آدرس تاجر

محل

ظرفی که نشان دهنده یک مکان است.

نمایندگی JSON
{
  "coordinates": {
    object (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "name": string,
  "phoneNumber": string,
  "notes": string,
  "placeId": string
}
زمینه های
coordinates

object ( LatLng )

مختصات جغرافیایی به مجوز [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] نیاز دارد.

formattedAddress

string

نشانی نمایش، به عنوان مثال، "1600 Amphitheatre Pkwy, Mountain View, CA 94043". به مجوز [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] نیاز دارد.

zipCode

string

کد پستی. به مجوز [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] یا [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] نیاز دارد.

city

string

شهر. به مجوز [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] یا [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] نیاز دارد.

postalAddress

object ( PostalAddress )

آدرس پستی. به مجوز [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] یا [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] نیاز دارد.

name

string

نام مکان.

phoneNumber

string

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

notes

string

نکاتی در مورد مکان

placeId

string

placeId با Places API برای واکشی جزئیات یک مکان استفاده می شود. به https://developers.google.com/places/web-service/place-id مراجعه کنید

LatLng

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

نمایندگی JSON
{
  "latitude": number,
  "longitude": number
}
زمینه های
latitude

number

عرض جغرافیایی بر حسب درجه باید در محدوده [-90.0، +90.0] باشد.

longitude

number

طول جغرافیایی بر حسب درجه باید در محدوده [-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

integer

بازبینی طرحواره PostalAddress . این باید روی 0 تنظیم شود که آخرین ویرایش است.

همه ویرایش‌های جدید باید با نسخه‌های قبلی سازگار باشند.

regionCode

string

ضروری. کد منطقه CLDR کشور/منطقه آدرس. این هرگز استنباط نمی شود و اطمینان از صحیح بودن مقدار به عهده کاربر است. برای جزئیات بیشتر به http://cldr.unicode.org/ و http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html مراجعه کنید. مثال: "CH" برای سوئیس.

languageCode

string

اختیاری. کد زبان BCP-47 محتویات این آدرس (در صورت شناخته شدن). این اغلب زبان رابط کاربری فرم ورودی است یا انتظار می‌رود با یکی از زبان‌های مورد استفاده در کشور/منطقه آدرس یا معادل‌های نویسه‌گردانی شده آنها مطابقت داشته باشد. این می‌تواند بر قالب‌بندی در برخی کشورها تأثیر بگذارد، اما برای صحت داده‌ها حیاتی نیست و هرگز بر روی اعتبارسنجی یا سایر عملیات مرتبط با قالب‌بندی تأثیر نمی‌گذارد.

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

مثال: "zh-Hant"، "ja"، "ja-Latn"، "en".

postalCode

string

اختیاری. کد پستی آدرس همه کشورها از وجود کدهای پستی استفاده نمی‌کنند یا نیاز به وجود کد پستی ندارند، اما در جایی که از آنها استفاده می‌شود، ممکن است اعتبار سنجی اضافی را با سایر قسمت‌های آدرس (مثلاً اعتبارسنجی ایالت/زیپ در ایالات متحده آمریکا) ایجاد کنند.

sortingCode

string

اختیاری. کد مرتب‌سازی اضافی، خاص کشور. این در اکثر مناطق استفاده نمی شود. در جایی که از آن استفاده می‌شود، مقدار یا رشته‌ای مانند «CEDEX» است، که به صورت اختیاری با یک عدد دنبال می‌شود (مثلاً «CEDEX 7»)، یا فقط یک عدد به تنهایی، نشان‌دهنده «کد بخش» (جامائیکا)، «نشانگر ناحیه تحویل» است. (مالاوی) یا «نشانگر اداره پست» (مثلاً ساحل عاج).

administrativeArea

string

اختیاری. بالاترین بخش اداری که برای آدرس های پستی یک کشور یا منطقه استفاده می شود. به عنوان مثال، این می تواند یک ایالت، یک استان، یک استان یا یک استان باشد. به طور خاص، برای اسپانیا این استان است و نه جامعه خودمختار (مثلاً "بارسلونا" و نه "کاتالونیا"). بسیاری از کشورها از یک منطقه اداری در آدرس های پستی استفاده نمی کنند. به عنوان مثال در سوئیس این باید خالی از سکنه بماند.

locality

string

اختیاری. عموماً به بخش شهر/شهرک آدرس اشاره دارد. مثال: شهر ایالات متحده، کمون فناوری اطلاعات، شهر پست بریتانیا. در مناطقی از جهان که محلی ها به خوبی تعریف نشده اند یا به خوبی در این ساختار قرار نمی گیرند، محلی را خالی بگذارید و از خطوط آدرس استفاده کنید.

sublocality

string

اختیاری. موقعیت فرعی آدرس به عنوان مثال، این می تواند محله، محله، منطقه باشد.

addressLines[]

string

خطوط آدرس بدون ساختار که سطوح پایین یک آدرس را توصیف می کند.

از آنجایی که مقادیر در addressLines اطلاعات نوع ندارند و گاهی اوقات ممکن است حاوی چندین مقدار در یک فیلد واحد باشند (به عنوان مثال "Austin, TX")، واضح بودن ترتیب خطوط مهم است. ترتیب خطوط آدرس باید "سفارش پاکت" برای کشور/منطقه آدرس باشد. در جاهایی که ممکن است متفاوت باشد (مثلاً ژاپن)، address_language برای صریح‌تر کردن آن استفاده می‌شود (مثلاً "ja" برای سفارش بزرگ به کوچک و "ja-Latn" یا "en" برای کوچک به بزرگ). به این ترتیب، مشخص ترین خط یک آدرس را می توان بر اساس زبان انتخاب کرد.

حداقل نمایش ساختاری مجاز یک آدرس شامل یک RegionCode با تمام اطلاعات باقیمانده در خطوط آدرس است. قالب بندی چنین آدرسی تقریباً بدون کدگذاری جغرافیایی امکان پذیر است، اما هیچ استدلال معنایی در مورد هیچ یک از اجزای آدرس نمی توان تا حداقل تا حدی حل شود.

ایجاد آدرسی که فقط شامل یک regionCode و addressLines باشد و سپس geocoding روشی توصیه شده برای مدیریت آدرس‌های کاملاً بدون ساختار است (برخلاف حدس زدن اینکه کدام قسمت‌های آدرس باید محل‌ها یا مناطق اداری باشند).

recipients[]

string

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

organization

string

اختیاری. نام سازمان در آدرس.

فهرست

لفاف برای اقلام خط.

نمایندگی JSON
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
زمینه های
lineItems[]

object ( LineItem )

لیست اقلام خط سفارش حداقل 1 خط مورد نیاز است و حداکثر 50 مورد مجاز است. همه موارد خط باید به یک عمود تعلق داشته باشند.

آیتم خط

یک مورد خطی شامل یک مورد عمودی است. یک سفارش یا سبد خرید می‌تواند چندین مورد خط عمودی مشابه داشته باشد. آیتم های فرعی/افزونه ها و غیره باید بسته به موارد استفاده در پروتوهای عمودی تعریف شوند. توجه: 1. تمام رشته ها در تمام سطوح باید کمتر از 1000 کاراکتر باشند مگر اینکه طور دیگری مشخص شده باشد. 2. تعداد فیلدهای تکرار شده در تمام سطوح باید کمتر از 50 باشد، مگر اینکه طور دیگری مشخص شده باشد. 3. تمام مهرهای زمانی در همه سطوح، در صورت مشخص شدن، باید مهر زمانی معتبر باشند.

نمایندگی JSON
{
  "id": string,
  "name": string,
  "userVisibleStateLabel": string,
  "provider": {
    object (Merchant)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "recipients": [
    {
      object (UserInfo)
    }
  ],
  "image": {
    object (Image)
  },
  "description": string,
  "notes": [
    string
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseItemExtension)
  },
  "reservation": {
    object (ReservationItemExtension)
  }
  // End of list of possible types for union field verticals.
}
زمینه های
id

string

مورد نیاز: تاجر برای مورد خط شناسه اختصاص داده است. برای شناسایی مورد خط موجود در اعمال به‌روزرسانی‌های جزئی استفاده می‌شود. حداکثر طول مجاز 64 کاراکتر است.

name

string

نام کالای خط همانطور که در رسید نشان داده شده است. حداکثر طول مجاز 100 کاراکتر است.

userVisibleStateLabel
(deprecated)

string

منسوخ. به جای آن از وضعیت سطح عمودی استفاده کنید. به عنوان مثال، برای خرید، از PurchaseOrderExtension.status استفاده کنید. برچسب قابل مشاهده توسط کاربر برای وضعیت این مورد خط.

provider

object ( Merchant )

ارائه‌دهنده مورد خط خاص، اگر با سفارش کلی متفاوت باشد. مثال: Expedia Order با ارائه دهنده اقلام خطی ANA.

priceAttributes[]

object ( PriceAttribute )

قیمت و تنظیمات سطح مورد خطی.

followUpActions[]

object ( Action )

پیگیری اقدامات در مورد خط.

recipients[]

object ( UserInfo )

مشتریان سطح اقلام خطی، این ممکن است با خریدار سطح سفارش متفاوت باشد. مثال: کاربر X با نام کاربر Y رزرو رستوران انجام داده است.

image

object ( Image )

تصویر کوچک مرتبط با این مورد، در صورت وجود.

description

string

شرح مورد خط.

notes[]

string

یادداشت‌های اضافی قابل اعمال برای این مورد خاص، برای مثال خط‌مشی لغو.

disclosures[]

object ( Disclosure )

افشاهای مرتبط با این مورد.

vertical
(deprecated)

object

منسوخ شده: به جای آن از عمودی استفاده کنید. مورد نیاز: محتوای معنایی آیتم خط بر اساس نوع/عمودی آن. هر عمودی باید شامل جزئیات تحقق خودش باشد. باید یکی از مقادیر زیر باشد: google.actions.orders.v3.verticals.purchase.PurchaseItemExtension google.actions.orders.v3.verticals.reservation.ReservationItemExtension google.actions.orders.v3.verticals.ticket.TicketItemExtension

یک شی حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی "@type" حاوی یک URI است که نوع را مشخص می کند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" } .

verticals میدان اتحادیه مورد نیاز: محتوای معنایی آیتم خط بر اساس نوع/عمودی آن. هر عمودی باید شامل جزئیات تحقق خودش باشد. verticals فقط می توانند یکی از موارد زیر باشند:
purchase

object ( PurchaseItemExtension )

سفارشات خرید مانند کالا، غذا و غیره

reservation

object ( ReservationItemExtension )

سفارشات رزرو مانند رستوران، مدل مو و غیره

قیمت ویژگی

ویژگی قیمت یک سفارش یا یک قلم خط.

نمایندگی JSON
{
  "type": enum (Type),
  "name": string,
  "id": string,
  "state": enum (State),
  "taxIncluded": boolean,

  // Union field spec can be only one of the following:
  "amount": {
    object (Money)
  },
  "amountMillipercentage": integer
  // End of list of possible types for union field spec.
}
زمینه های
type

enum ( Type )

مورد نیاز: نوع ویژگی پول.

name

string

مورد نیاز: رشته ای از ویژگی قیمت را کاربر نمایش می دهد. این توسط تاجر ارسال و بومی سازی شده است.

id

string

اختیاری: شناسه قلم خطی که این قیمت با آن مطابقت دارد.

state

enum ( State )

مورد نیاز: وضعیت قیمت: برآورد در مقابل واقعی.

taxIncluded

boolean

این که آیا قیمت شامل مالیات می شود.

spec میدان اتحادیه نشان دهنده مقدار پولی یا درصد میلی است. spec می تواند تنها یکی از موارد زیر باشد:
amount

object ( Money )

مقدار پولی.

amountMillipercentage
(deprecated)

integer

مشخصات درصد، به 1/1000 درصد. به عنوان مثال: 8.750٪ به عنوان 8750 نشان داده می شود، درصدهای منفی نشان دهنده درصد تخفیف هستند. منسوخ شدن این رشته می‌توانید در صورت نیاز به یک مورد استفاده مجدد، دوباره اضافه کنید.

تایپ کنید

نشان دهنده نوع پول است.

Enums
TYPE_UNSPECIFIED نوع نامشخص است، کلاینت ها نباید این را به صراحت تنظیم کنند.
REGULAR قیمت نمایش منظم، قبل از اعمال هرگونه تخفیف و غیره.
DISCOUNT از جمع فرعی کسر شود.
TAX به جمع فرعی اضافه می شود.
DELIVERY به جمع فرعی اضافه می شود.
SUBTOTAL جمع فرعی قبل از اضافه شدن برخی هزینه ها.
FEE هر گونه هزینه اضافی
GRATUITY به جمع فرعی اضافه می شود.
TOTAL قیمت سفارش یا خط مورد نمایش داده می شود.

حالت

وضعیت قیمت را نشان می دهد.

Enums
STATE_UNSPECIFIED مشخص نشده است.
ESTIMATE قیمت فقط یک تخمین است اما مقدار نهایی نزدیک به این مقدار خواهد بود. مثال: در مواردی که مالیات در زمان معامله به طور دقیق مشخص نباشد، کل مبلغ تخمینی خواهد بود.
ACTUAL قیمت واقعی که از کاربر دریافت خواهد شد.

پول

مقداری پول را با نوع ارز آن نشان می دهد.

نمایندگی JSON
{
  "currencyCode": string,
  "amountInMicros": string
}
زمینه های
currencyCode

string

کد ارز 3 حرفی تعریف شده در ISO 4217.

amountInMicros

string ( int64 format)

مقدار بر حسب میکرو به عنوان مثال، این فیلد باید به صورت 1990000 برای 1.99 دلار تنظیم شود.

عمل

یک اقدام پیگیری مرتبط با سفارش یا مورد خط.

نمایندگی JSON
{
  "type": enum (Type),
  "title": string,
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "actionMetadata": {
    object (ActionMetadata)
  }
}
زمینه های
type

enum ( Type )

مورد نیاز: نوع عمل.

title

string

عنوان یا برچسب عمل، به کاربر نمایش داده می شود. حداکثر طول مجاز 100 کاراکتر است.

openUrlAction

object ( OpenUrlAction )

اقدام برای انجام.

actionMetadata

object ( ActionMetadata )

فراداده مرتبط با یک اقدام.

تایپ کنید

اقدامات بعدی احتمالی

Enums
TYPE_UNSPECIFIED اقدام نامشخص
VIEW_DETAILS عملکرد جزئیات سفارش را مشاهده کنید.
MODIFY عمل سفارش را اصلاح کنید.
CANCEL لغو اقدام سفارش
RETURN اقدام سفارش بازگشت
EXCHANGE اقدام سفارش مبادله.
EMAIL

اقدام ایمیل. انواع EMAIL و CALL منسوخ شده اند. openUrlAction.url می تواند به عنوان شماره تلفن یا ایمیل استفاده شود.

CALL

اقدام را فراخوانی کنید.

REORDER ترتیب مجدد اقدام.
REVIEW بررسی عملکرد سفارش
CUSTOMER_SERVICE با خدمات مشتریان تماس بگیرید.
FIX_ISSUE برای رفع مشکل به سایت یا برنامه تاجر مراجعه کنید.
DIRECTION لینک جهت.

OpenUrlAction

url داده شده را باز می کند.

نمایندگی JSON
{
  "url": string,
  "androidApp": {
    object (AndroidApp)
  },
  "urlTypeHint": enum (UrlTypeHint)
}
زمینه های
url

string

فیلد url که می تواند یکی از این موارد باشد: - آدرس های http/https برای باز کردن یک برنامه مرتبط با برنامه یا یک صفحه وب

androidApp

object ( AndroidApp )

اطلاعات مربوط به برنامه Android اگر انتظار می رود URL توسط یک برنامه Android تکمیل شود.

urlTypeHint

enum ( UrlTypeHint )

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

برنامه اندروید

مشخصات برنامه Android برای محدودیت های اجرا

نمایندگی JSON
{
  "packageName": string,
  "versions": [
    {
      object (VersionFilter)
    }
  ]
}
زمینه های
packageName

string

نام بسته هنگام تعیین Android Fulfillment نام بسته باید مشخص شود.

versions[]

object ( VersionFilter )

هنگامی که چندین فیلتر مشخص می شود، هر گونه تطبیق فیلتر برنامه را فعال می کند.

نسخه فیلتر

اگر نسخه/های خاصی از برنامه مورد نیاز است باید VersionFilter گنجانده شود.

نمایندگی JSON
{
  "minVersion": integer,
  "maxVersion": integer
}
زمینه های
minVersion

integer

حداقل کد نسخه یا 0، شامل.

maxVersion

integer

حداکثر کد نسخه، شامل. محدوده در نظر گرفته شده [minVersion:maxVersion] است. محدوده تهی دلالت بر هر نسخه ای دارد. مثال‌ها: برای تعیین یک نسخه از: [target_version:target_version] استفاده کنید. برای تعیین هر نسخه، minVersion و maxVersion را نامشخص بگذارید. برای تعیین تمام نسخه ها تا maxVersion، minVersion را نامشخص بگذارید. برای تعیین تمام نسخه‌ها از minVersion، maxVersion را نامشخص بگذارید.

UrlTypeHint

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

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

ActionMetadata

فراداده مرتبط در هر اقدام.

نمایندگی JSON
{
  "expireTime": string
}
زمینه های
expireTime

string ( Timestamp format)

زمانی که این اقدام منقضی می شود.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

افشای

افشای محصول، خدمات یا خط‌مشی که ممکن است به کاربر ارائه شود.

نمایندگی JSON
{
  "title": string,
  "disclosureText": {
    object (DisclosureText)
  },
  "presentationOptions": {
    object (DisclosurePresentationOptions)
  }
}
زمینه های
title

string

عنوان افشاگری مثال: "اطلاعات ایمنی".

disclosureText

object ( DisclosureText )

محتوای افشا. لینک های وب مجاز هستند.

presentationOptions

object ( DisclosurePresentationOptions )

گزینه های ارائه برای افشای.

DisclosureText

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

نمایندگی JSON
{
  "template": string,
  "textLinks": [
    {
      object (TextLink)
    }
  ]
}
زمینه های
template

string

متنی برای نمایش، حاوی متغیرهایی مانند "{0}" و "{1}" برای هر پیوند نوشتاری که باید درج شود. مثال: "هشدار: این محصول می تواند شما را در معرض مواد شیمیایی قرار دهد که در ایالت کالیفرنیا به عنوان عامل سرطان شناخته شده است. برای اطلاعات بیشتر به {0} مراجعه کنید." این متن افشا نباید حاوی محتوای تبلیغاتی یا تبلیغاتی باشد.

DisclosurePresentationOptions

گزینه هایی برای ارائه یک افشا.

نمایندگی JSON
{
  "presentationRequirement": enum (PresentationRequirement),
  "initiallyExpanded": boolean
}
زمینه های
presentationRequirement

enum ( PresentationRequirement )

الزامات ارائه افشا.

initiallyExpanded

boolean

اینکه آیا محتوای افشا باید در ابتدا گسترش یابد یا خیر. به طور پیش فرض، در ابتدا جمع شده است.

الزامات ارائه

الزام برای ارائه افشا.

Enums
REQUIREMENT_UNSPECIFIED نیاز نامشخص نباید این را به صراحت تنظیم کرد.
REQUIREMENT_OPTIONAL افشای اختیاری است. اگر دستگاه از نمایش افشاگری پشتیبانی نمی کند، می توان از آن صرفنظر کرد.
REQUIREMENT_REQUIRED افشاء الزامی است. در صورتی که دستگاه از نمایش افشاگری پشتیبانی نکند، مکالمه به تلفن تبدیل خواهد شد.

PurchaseItem Extension

محتویات مورد خط خرید عمودی.

نمایندگی JSON
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "productId": string,
  "quantity": integer,
  "unitMeasure": {
    object (MerchantUnitMeasure)
  },
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "itemOptions": [
    {
      object (ItemOption)
    }
  ],
  "productDetails": {
    object (ProductDetails)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
زمینه های
status

enum ( PurchaseStatus )

مورد نیاز: وضعیت سطح مورد خط.

userVisibleStatusLabel

string

مورد نیاز: برچسب/رشته قابل مشاهده توسط کاربر برای وضعیت. حداکثر طول مجاز 50 کاراکتر است.

type

enum ( PurchaseType )

مورد نیاز: نوع خرید

productId
(deprecated)

string

شناسه محصول یا پیشنهاد مرتبط با این مورد خط.

quantity

integer

مقدار مورد.

unitMeasure

object ( MerchantUnitMeasure )

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

returnsInfo

object ( PurchaseReturnsInfo )

اطلاعات این مورد خطی را برمی‌گرداند. اگر تنظیم نشود، این مورد خطی اطلاعات سطح سفارش را به ارث می برد.

fulfillmentInfo

object ( PurchaseFulfillmentInfo )

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

itemOptions[]

object ( ItemOption )

افزونه ها یا موارد فرعی اضافی.

productDetails

object ( ProductDetails )

جزئیات در مورد محصول.

extension
(deprecated)

object

هر فیلد اضافی رد و بدل شده بین تاجر و گوگل. توجه: استفاده از این افزونه به شدت ممنوع است. بر اساس استفاده/شرایط استفاده ، یکی از موارد زیر را در نظر بگیرید: 1- اگر می توان از آن برای سایر موارد استفاده استفاده کرد (به عنوان مثال توانایی/عملکرد عمومی) ، زمینه های موجود در BuyItemextension را تعریف کنید. 2. در صورت خاص بودن یک ویژگی/ویژگی استفاده غیر ژنتیکی ، از urdent_extension استفاده کنید.

یک شی حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی "@type" حاوی یک URI است که نوع را مشخص می کند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" } .

خرید

وضعیت خرید مرتبط با سفارش خرید یا یک مورد خط خاص.

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 (Unit)
}
زمینه های
measure

number

مقدار: مثال 1.2.

unit

enum ( Unit )

واحد: پوند مثال ، گرم.

واحد

Enums
UNIT_UNSPECIFIED واحد نامشخص.
MILLIGRAM میلی گرم
GRAM گرم
KILOGRAM کیلوگرم
OUNCE اونس.
POUND پوند

خرید و فروش

اطلاعات مرتبط با یک سفارش یا یک خط خاص را برمی‌گرداند.

نمایندگی JSON
{
  "isReturnable": boolean,
  "daysToReturn": integer,
  "policyUrl": string
}
زمینه های
isReturnable

boolean

اگر درست باشد، بازگشت مجاز است.

daysToReturn

integer

بازگشت در این چند روز مجاز است.

policyUrl

string

پیوند به سیاست بازگشت

خرید

اطلاعات تکمیلی مرتبط با یک سفارش خرید یا یک مورد خط خاص.

نمایندگی JSON
{
  "id": string,
  "fulfillmentType": enum (Type),
  "expectedFulfillmentTime": {
    object (Time)
  },
  "expectedPreparationTime": {
    object (Time)
  },
  "location": {
    object (Location)
  },
  "expireTime": string,
  "price": {
    object (PriceAttribute)
  },
  "fulfillmentContact": {
    object (UserInfo)
  },
  "shippingMethodName": string,
  "storeCode": string,
  "pickupInfo": {
    object (PickupInfo)
  }
}
زمینه های
id

string

شناسه منحصر به فرد برای این گزینه سرویس.

fulfillmentType

enum ( Type )

مورد نیاز: نوع انجام.

expectedFulfillmentTime

object ( Time )

یک پنجره اگر یک بازه زمانی مشخص شده باشد یا ETA اگر یک زمان مشخص شده باشد. زمان مورد انتظار تحویل یا تحویل

expectedPreparationTime

object ( Time )

یک پنجره اگر یک بازه زمانی مشخص شده باشد یا ETA اگر یک زمان مشخص شده باشد. زمان مورد انتظار برای تهیه غذا ترجیحا یکباره

location

object ( Location )

محل تحویل یا تحویل

expireTime

string ( Timestamp format)

زمانی که در آن این گزینه تکمیل منقضی می شود.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

price

object ( PriceAttribute )

هزینه این گزینه

fulfillmentContact

object ( UserInfo )

تماس کاربر برای این تحقق.

shippingMethodName

string

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

storeCode

string

کد فروشگاه محل. مثال: Walmart بازرگان است و StoreCode فروشگاه Walmart است که در آن انجام شده است. https://support.google.com/business/answer/3370250؟ref_topic=4596653 .

pickupInfo

object ( PickupInfo )

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

تایپ کنید

نوع تحقق

Enums
TYPE_UNSPECIFIED نوع نامشخص را تایپ کنید.
DELIVERY این سفارش تحویل داده می شود.
PICKUP این سفارش باید برداشت شود.

زمان

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

نمایندگی JSON
{
  "timeIso8601": string
}
زمینه های
timeIso8601

string

نمایانگر یک زمان سفارش سفارش مانند زمان رزرو ، زمان تحویل و غیره است. می تواند مدت زمان (زمان شروع و پایان) باشد ، فقط تاریخ ، زمان تاریخ و غیره. به https://en.wikipedia.org/wiki/iso_8601 برای همه قالب های پشتیبانی شده مراجعه کنید.

وانت

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

نمایندگی JSON
{
  "pickupType": enum (PickupType),
  "curbsideInfo": {
    object (CurbsideInfo)
  },
  "checkInInfo": [
    {
      object (CheckInInfo)
    }
  ]
}
زمینه های
pickupType

enum ( PickupType )

روش انتخاب ، مانند instore ، curbside و غیره

curbsideInfo

object ( CurbsideInfo )

جزئیات خاص برای اطلاعات حاشیه. اگر Pickuptype "حاشیه" نباشد ، این زمینه نادیده گرفته می شود.

checkInInfo[]

object ( CheckInInfo )

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

نوع تریک

لیست انواع وانت پشتیبانی شده.

Enums
UNSPECIFIED نوع نامشخص را انتخاب کنید.
INSTORE غذا را در داخل رستوران انتخاب کنید.
CURBSIDE وسیله نقلیه پارک در یک مکان مشخص در خارج از رستوران و شخصی در آنجا غذا را تحویل می دهد.

کنار کنار

جزئیات مربوط به نحوه تسهیل سفارش کنار.

نمایندگی JSON
{
  "curbsideFulfillmentType": enum (CurbsideFulfillmentType),
  "userVehicle": {
    object (Vehicle)
  }
}
زمینه های
curbsideFulfillmentType

enum ( CurbsideFulfillmentType )

شرکا برای تسهیل سفارشات وانت کنار نیاز به اطلاعات اضافی دارند. بسته به انتخاب نوع تحقق ، جزئیات مربوطه از کاربر جمع آوری می شود.

userVehicle

object ( Vehicle )

جزئیات وسیله نقلیه کاربر قرار دادن سفارش.

curbsidedfulfillmenttype

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

Enums
UNSPECIFIED نوع تحقق بخشیده به قسمت نامشخص.
VEHICLE_DETAIL جزئیات وسایل نقلیه مورد نیاز برای تسهیل وانت کنار.

وسیله نقلیه

جزئیات مربوط به یک وسیله نقلیه

نمایندگی JSON
{
  "make": string,
  "model": string,
  "licensePlate": string,
  "colorName": string,
  "image": {
    object (Image)
  }
}
زمینه های
make

string

وسیله نقلیه (به عنوان مثال "هوندا"). این به کاربر نمایش داده می شود و باید بومی سازی شود. ضروری.

model

string

مدل وسیله نقلیه (به عنوان مثال "GROM"). این به کاربر نمایش داده می شود و باید بومی سازی شود. ضروری.

licensePlate

string

شماره پلاک خودرو (به عنوان مثال "1ABC234"). ضروری.

colorName

string

نام رنگ وسیله نقلیه ، به عنوان مثال. سیاه اختیاری.

image

object ( Image )

URL به یک عکس از وسیله نقلیه. این عکس در حدود 256x256px نمایش داده می شود. باید JPG یا PNG باشد. اختیاری.

checkininfo

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

نمایندگی JSON
{
  "checkInType": enum (CheckInType)
}
زمینه های
checkInType

enum ( CheckInType )

روش مورد استفاده برای ارسال دستورالعمل های ورود.

چک

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

Enums
CHECK_IN_TYPE_UNSPECIFIED مقدار ناشناخته
EMAIL اطلاعات چک از طریق ایمیل ارسال می شود.
SMS اطلاعات چک توسط پیام کوتاه ارسال می شود.

مورد

افزودنی ها یا موارد زیر را نشان می دهد.

نمایندگی JSON
{
  "id": string,
  "name": string,
  "prices": [
    {
      object (PriceAttribute)
    }
  ],
  "note": string,
  "quantity": integer,
  "productId": string,
  "subOptions": [
    {
      object (ItemOption)
    }
  ]
}
زمینه های
id

string

برای گزینه هایی که مواردی هستند ، شناسه مورد منحصر به فرد.

name

string

نام گزینه

prices[]

object ( PriceAttribute )

قیمت کل قیمت.

note

string

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

quantity

integer

برای گزینه هایی که موارد ، کمیت هستند.

productId

string

محصول یا شناسه ارائه شده با این گزینه.

subOptions[]

object ( ItemOption )

برای تعریف سایر گزینه های فرعی تو در تو.

جزئیات محصول

جزئیات مربوط به محصول.

نمایندگی JSON
{
  "productId": string,
  "gtin": string,
  "plu": string,
  "productType": string,
  "productAttributes": {
    string: string,
    ...
  }
}
زمینه های
productId

string

محصول یا شناسه ارائه شده با این مورد خط.

gtin

string

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

plu

string

کدهای جستجوی قیمت ، که معمولاً کدهای PLU ، شماره PLU ، به علاوه ، تولید کدها یا برچسب های تولیدی نامیده می شوند ، سیستم اعدادی هستند که به طور منحصر به فرد محصولات فله ای را که در فروشگاه های مواد غذایی و سوپر مارکت ها فروخته می شوند ، شناسایی می کنند.

productType

string

دسته محصول تعریف شده توسط بازرگان. به عنوان مثال "خانه> مواد غذایی> لبنیات و تخم مرغ> شیر> شیر کامل"

productAttributes

map (key: string, value: string)

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

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

رزرواسیون

محتوای مورد خط برای سفارشات رزرو مانند رستوران ، مدل مو و غیره

نمایندگی JSON
{
  "status": enum (ReservationStatus),
  "userVisibleStatusLabel": string,
  "type": enum (ReservationType),
  "reservationTime": {
    object (Time)
  },
  "userAcceptableTimeRange": {
    object (Time)
  },
  "confirmationCode": string,
  "partySize": integer,
  "staffFacilitators": [
    {
      object (StaffFacilitator)
    }
  ],
  "location": {
    object (Location)
  }
}
زمینه های
status

enum ( ReservationStatus )

مورد نیاز: وضعیت رزرو.

userVisibleStatusLabel

string

مورد نیاز: برچسب/رشته قابل مشاهده کاربر برای وضعیت. حداکثر طول مجاز 50 بار است.

type

enum ( ReservationType )

نوع رزرو اگر هیچ یک از گزینه های نوع کاربردی نباشد ، ممکن است غیرقانونی باشد.

reservationTime

object ( Time )

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

userAcceptableTimeRange

object ( Time )

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

confirmationCode

string

کد تأیید برای این رزرو.

partySize

integer

تعداد مردم.

staffFacilitators[]

object ( StaffFacilitator )

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

location

object ( Location )

محل سرویس/رویداد.

محل رزرو

وضعیت رزرو.

Enums
RESERVATION_STATUS_UNSPECIFIED وضعیت نامشخص
PENDING رزرو در انتظار است.
CONFIRMED رزرو تأیید شده است.
CANCELLED رزرو توسط کاربر لغو می شود.
FULFILLED رزرو انجام شده است.
CHANGE_REQUESTED تغییر رزرو درخواست می شود
REJECTED رزرو یا منقضی شده یا توسط یکپارچه سازی رد شده است.

نوع رزرو

نوع رزرو

Enums
RESERVATION_TYPE_UNSPECIFIED نوع نامشخص
RESTAURANT رزرو برای رستوران.
HAIRDRESSER رزرو برای آرایشگاه.

کارکنان

اطلاعات مربوط به شخص خدمات.

نمایندگی JSON
{
  "name": string,
  "image": {
    object (Image)
  }
}
زمینه های
name

string

نام تسهیلگر کارکنان. سابق. "جان اسمیت"

image

object ( Image )

تصاویر مجری

پرداخت

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

نمایندگی JSON
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
زمینه های
paymentResult

object ( PaymentResult )

نتیجه پرداختی که توسط یکپارچه برای انجام معامله استفاده می شود. اگر تجربه پرداخت توسط Action-on-Google مدیریت شود ، این قسمت توسط اقدامات موجود در Google جمع می شود.

paymentInfo

object ( PaymentInfo )

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

مبلغ پرداخت

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

نمایندگی JSON
{

  // Union field result can be only one of the following:
  "googlePaymentData": string,
  "merchantPaymentMethodId": string
  // End of list of possible types for union field result.
}
زمینه های
result میدان اتحادیه یا داده پرداخت Google یا روش پرداخت بازرگان ارائه شده است. result می تواند تنها یکی از موارد زیر باشد:
googlePaymentData

string

Google داده های روش پرداخت را ارائه داد. اگر پردازنده پرداخت شما به عنوان پردازنده پرداخت پشتیبانی Google در اینجا ذکر شده است: https://developers.google.com/pay/api/ از طریق لینک به پردازنده پرداخت خود بروید تا جزئیات بیشتری را پیدا کنید. در غیر این صورت ، برای جزئیات بار به مستندات زیر مراجعه کنید. https://developers.google.com/pay/api/payment-data-cryptography

merchantPaymentMethodId

string

بازرگان/اقدام روش پرداخت انتخاب شده توسط کاربر را ارائه داد.

اطلاعات پرداخت

اطلاعات پرداخت در مورد سفارش انجام شده. این Proto اطلاعاتی را که برای تعامل کاربر در مواجهه مفید است ، ضبط می کند.

نمایندگی JSON
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
زمینه های
paymentMethodDisplayInfo

object ( PaymentMethodDisplayInfo )

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

paymentMethodProvenance

enum ( PaymentMethodProvenance )

اثبات روش پرداخت مورد استفاده برای معامله. کاربر ممکن است روش پرداخت یکسانی را هم در Google و هم برای بازرگان ثبت کرده باشد.

PaymentMethodDisplayInfo

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

نمایندگی JSON
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string,
  "paymentMethodVoiceName": string
}
زمینه های
paymentType

enum ( PaymentType )

نوع پرداخت.

paymentMethodDisplayName

string

نام قابل مشاهده توسط کاربر روش پرداخت. به عنوان مثال، VISA **** 1234 Checking acct **** 5678

paymentMethodVoiceName

string

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

string

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

frudorderextension

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

نمایندگی JSON
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ],
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
زمینه های
status

enum ( PurchaseStatus )

مورد نیاز: وضعیت کلی برای سفارش.

userVisibleStatusLabel

string

برچسب/رشته قابل مشاهده کاربر برای وضعیت. حداکثر طول مجاز 50 بار است.

type

enum ( PurchaseType )

مورد نیاز: نوع خرید.

returnsInfo

object ( PurchaseReturnsInfo )

اطلاعات مربوط به سفارش را برگردانید.

fulfillmentInfo

object ( PurchaseFulfillmentInfo )

اطلاعات تکمیلی برای سفارش

purchaseLocationType

enum ( PurchaseLocationType )

محل خرید (داخل فروشگاه / آنلاین)

errors[]

object ( PurchaseError )

اختیاری: خطاها به دلیل آن این ترتیب رد شد.

extension
(deprecated)

object

هر زمینه اضافی بین بازرگان و گوگل رد و بدل می شود. توجه: استفاده از این پسوند بسیار دلسرد است. بر اساس مورد/شرایط استفاده ، یکی از موارد زیر را در نظر بگیرید: 1- اگر می توان از آن برای سایر موارد استفاده استفاده کرد (به عنوان مثال توانایی/عملکرد عمومی) ، زمینه های موجود در خرید را تعریف کنید. 2. در صورت خاص بودن یک ویژگی/ویژگی استفاده غیر ژنتیکی ، از urdent_extension استفاده کنید.

یک شی حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی "@type" حاوی یک URI است که نوع را مشخص می کند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" } .

خرید و فروش

نوع موقعیت مکانی خرید.

Enums
UNSPECIFIED_LOCATION مقدار ناشناخته
ONLINE_PURCHASE تمام خریدهای خریداری شده بصورت آنلاین.
INSTORE_PURCHASE تمام خریدهای اینستور.

خریدار

خطاهایی که سفارش خرید را می توان برای آن رد کرد.

نمایندگی JSON
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": integer
}
زمینه های
type

enum ( ErrorType )

مورد نیاز: این نشان دهنده دلیل دانه ای است که یک سفارش توسط بازرگان رد می شود.

description

string

توضیحات خطای اضافی

entityId

string

شناسه موجودی که با خطا مطابقت دارد. مثال این می تواند با LineItemid / itemOptionID مطابقت داشته باشد.

updatedPrice

object ( PriceAttribute )

در مورد نوع خطای Price_Changed / Arrect_Price مرتبط است.

availableQuantity

integer

اکنون مقدار موجود است. در صورت وجود در دسترس بودن قابل استفاده است.

خط

انواع خطای احتمالی

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)
  }
}
زمینه های
ticketEvent

object ( TicketEvent )

این رویداد برای همه بلیت‌های مورد خط اعمال شد.

تیک تیک

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

نمایندگی JSON
{
  "type": enum (Type),
  "name": string,
  "description": string,
  "url": string,
  "location": {
    object (Location)
  },
  "eventCharacters": [
    {
      object (EventCharacter)
    }
  ],
  "startDate": {
    object (Time)
  },
  "endDate": {
    object (Time)
  },
  "doorTime": {
    object (Time)
  }
}
زمینه های
type

enum ( Type )

مورد نیاز: نوع رویداد بلیط ، به عنوان مثال فیلم ، کنسرت.

name

string

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

description

string

توضیحات این رویداد.

url

string

URL به اطلاعات رویداد.

location

object ( Location )

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

eventCharacters[]

object ( EventCharacter )

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

startDate

object ( Time )

زمان شروع.

endDate

object ( Time )

زمان پایان.

doorTime

object ( Time )

زمان ورود ، که ممکن است با زمان شروع رویداد متفاوت باشد. به عنوان مثال این رویداد از ساعت 9 صبح آغاز می شود ، اما زمان ورود 8:30 صبح است.

تایپ کنید

نوع رویداد

Enums
EVENT_TYPE_UNKNOWN نوع رویداد ناشناخته.
MOVIE فیلم سینما.
CONCERT کنسرت.
SPORTS ورزش ها.

شخصیت

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

نمایندگی JSON
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
زمینه های
type

enum ( Type )

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

name

string

نام شخصیت

image

object ( Image )

تصاویر شخصیت

تایپ کنید

نوع شخصیت.

Enums
TYPE_UNKNOWN نوع ناشناخته
ACTOR بازیگر.
PERFORMER بازیگر.
DIRECTOR کارگردان.
ORGANIZER تنظیم کننده.

استفاده از کاربری

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

نمایندگی JSON
{
  "title": string,
  "text": string
}
زمینه های
title

string

عنوان برای اعلان کاربر. حداکثر طول مجاز 30 بار است.

text

string

محتوای اعلان حداکثر طول مجاز 100 بار است.

صحنه بعدی

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

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

string

نام صحنه ای که در مرحله بعد اجرا می شود.

جلسه

حاوی اطلاعاتی در مورد جلسه مکالمه فعلی است

نمایندگی JSON
{
  "id": string,
  "params": {
    string: value,
    ...
  },
  "typeOverrides": [
    {
      object (TypeOverride)
    }
  ],
  "languageCode": string
}
زمینه های
id

string

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

params

map (key: string, value: value ( Value format))

ضروری. لیست کلیه پارامترهای جمع آوری شده از فرم ها و اهداف در طول جلسه. کلید نام پارامتر است. پارامترهای تعریف شده در اینجا با پارامترهایی که قبلاً در جلسه تعریف شده اند ادغام می شوند. پارامترهای با مقدار تهی از جلسه حذف می شوند. به مستندات ذخیره سازی جلسه مراجعه کنید: https://developers.google.com/assistant/conversational/storage-session .

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

typeOverrides[]

object ( TypeOverride )

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

languageCode

string

زبان جلسه مکالمه فعلی. دنبال IETF BCP-47 کد زبان http://www.rfc-editor.org/rfc/bcp/bcp47.txt . اگر این اکشن از ویژگی های چند زبانی استفاده کند ، می تواند متفاوت از محل کاربر باشد. به عنوان مثال ، هنگامی که handler_response.expected.language_code تنظیم شده است ، زبان مکالمه را برای همه چرخش های زیر تغییر می دهد ، که در این زمینه منعکس می شود.

TypeOverride

نمایانگر یک لغو برای یک نوع است.

نمایندگی JSON
{
  "name": string,
  "mode": enum (TypeOverrideMode),
  "synonym": {
    object (SynonymType)
  }
}
زمینه های
name

string

ضروری. نام نوع برای تکمیل یا لغو.

mode

enum ( TypeOverrideMode )

ضروری. نحوه ادغام این نوع با مقادیر دیگر.

synonym

object ( SynonymType )

نوع ترشی

انواع اصلاحات برای یک نوع موجودیت جلسه.

Enums
TYPE_UNSPECIFIED مشخص نشده است این مقدار هرگز نباید استفاده شود.
TYPE_REPLACE تعاریف نوع در این پاسخ جایگزین تعاریف نوع است که قبلاً تعریف شده است.
TYPE_MERGE تعاریف نوع در این پاسخ با تعاریف نوع که قبلاً تعریف شده است ادغام می شود. تعاریف نوع جدید تعاریف نوع موجود را رونویسی می کند.

نوع مترادف

نوعی با مترادف را نشان می دهد.

نمایندگی JSON
{
  "entries": [
    {
      object (Entry)
    }
  ]
}
زمینه های
entries[]

object ( Entry )

ضروری. لیست ورودی ها برای نوع مترادف.

ورود

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

نمایندگی JSON
{
  "name": string,
  "synonyms": [
    string
  ],
  "display": {
    object (EntryDisplay)
  }
}
زمینه های
name

string

ضروری. نام ورودی (به عنوان مثال "دوچرخه"). ورودی در این فیلد باید در فیلد مترادف های مکرر گنجانده شود تا به عنوان یک مقدار نوع معتبر شناسایی شود.

synonyms[]

string

ضروری. فهرست مترادف های ورودی (به عنوان مثال "دوچرخه"، "چرخه").

display

object ( EntryDisplay )

اختیاری. اطلاعات مورد نمایش داده می شود.

نمایشگاه

نمایندگی JSON
{
  "title": string,
  "description": string,
  "image": {
    object (Image)
  },
  "footer": string,
  "openUrl": {
    object (OpenUrl)
  }
}
زمینه های
title

string

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

description

string

اختیاری. متن بدن کارت.

image

object ( Image )

اختیاری. تصویر برای نمایش

footer

string

اختیاری. متن پاورقی برای مورد مجموعه مرور ، در زیر توضیحات نمایش داده شده است. یک خط متن ، کوتاه با بیضی.

openUrl

object ( OpenUrl )

URL سند مرتبط با مرور کالای چرخ فلک. برای مرور چرخ فلک مورد نیاز است.

کاربر

نمایانگر کاربر درخواستی برای Action است.

نمایندگی JSON
{
  "locale": string,
  "params": {
    string: value,
    ...
  },
  "accountLinkingStatus": enum (AccountLinkingStatus),
  "verificationStatus": enum (UserVerificationStatus),
  "lastSeenTime": string,
  "engagement": {
    object (Engagement)
  },
  "packageEntitlements": [
    {
      object (PackageEntitlements)
    }
  ],
  "permissions": [
    enum (Permission)
  ]
}
زمینه های
locale

string

تنظیمات محلی اولیه کاربر درخواست کننده. دنبال IETF BCP-47 کد زبان http://www.rfc-editor.org/rfc/bcp/bcp47.txt . با این حال ، subtag اسکریپت گنجانده نشده است.

params

map (key: string, value: value ( Value format))

اختیاری. لیست تمام پارامترهای مرتبط با کاربر فعلی. به اسناد ذخیره سازی کاربر مراجعه کنید: https://developers.google.com/assistant/conversational/storage-user .

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

accountLinkingStatus

enum ( AccountLinkingStatus )

این که آیا حساب کاربری به برنامه مرتبط است یا خیر.

verificationStatus

enum ( UserVerificationStatus )

وضعیت تأیید کاربر را نشان می دهد.

lastSeenTime

string ( Timestamp format)

جدول زمانی آخرین تعامل با این کاربر. اگر کاربر قبلاً با نماینده تعامل نداشته باشد ، این قسمت از بین می رود.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

engagement

object ( Engagement )

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

packageEntitlements[]

object ( PackageEntitlements )

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

permissions[]

enum ( Permission )

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

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 (IntentSubscription)
    }
  ],
  "dailyUpdateIntents": [
    {
      object (IntentSubscription)
    }
  ]
}
زمینه های
pushNotificationIntents[]

object ( IntentSubscription )

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

dailyUpdateIntents[]

object ( IntentSubscription )

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

فهرست بندی

توصیف یک متن موجود.

نمایندگی JSON
{
  "intent": string,
  "contentTitle": string
}
زمینه های
intent

string

نام نیتی که در آن مشترک است.

contentTitle

string

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

بسته بندی

لیستی از حق کاربر مربوط به نام بسته. به اسناد معامله خوب دیجیتال مراجعه کنید: https://developers.google.com/assistant/transactions/digital/dev-guide-digital-non-consumables .

نمایندگی JSON
{
  "packageName": string,
  "entitlements": [
    {
      object (Entitlement)
    }
  ]
}
زمینه های
packageName

string

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

entitlements[]

object ( Entitlement )

حق کاربر برای بسته داده شده.

استحقاق

حق دیجیتالی کاربر را تعریف می کند.

نمایندگی JSON
{
  "sku": string,
  "skuType": enum (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
زمینه های
sku

string

محصول SKU. نام بسته برای برنامه پرداخت شده ، پسوند Finsky Docid برای خرید درون برنامه و اشتراک درون برنامه. Match GetSku () در بازی API INAPP BILLING API. به اسناد صورتحساب Play INAPP مراجعه کنید: https://developer.android.com/google/play/billing .

skuType

enum ( SkuType )

نوع SKU.

inAppDetails

object ( SignedData )

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

زاویه

Enums
SKU_TYPE_UNSPECIFIED
IN_APP خرید درون برنامه ای
SUBSCRIPTION اشتراک ها
APP برنامه های پرداخت شده

امضا شده

نمایندگی JSON
{
  "inAppPurchaseData": {
    object
  },
  "inAppDataSignature": string
}
زمینه های
inAppPurchaseData

object ( Struct format)

شامل تمام داده های خرید InApp با فرمت JSON است. جزئیات را در جدول 6 https://developer.android.com/google/play/billing/billing_reference.html مشاهده کنید.

inAppDataSignature

string

مطابق با روش 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

map (key: string, value: value ( Value format))

اختیاری. لیست پارامترهای مرتبط با ساختار Homegraph که دستگاه هدف به آن تعلق دارد. به اسناد ذخیره سازی خانه مراجعه کنید: https://developers.google.com/assistant/conversational/storage-home .

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

دستگاه

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

نمایندگی JSON
{
  "capabilities": [
    enum (Capability)
  ],
  "currentLocation": {
    object (Location)
  },
  "timeZone": {
    object (TimeZone)
  }
}
زمینه های
capabilities[]

enum ( Capability )

ضروری. قابلیت های دستگاه در حال درخواست برای عمل است.

currentLocation

object ( Location )

اختیاری. محل دستگاه کاربر. توجه داشته باشید ، این تنها پس از اعطای مجوزهای مکان توسط کاربر نهایی جمع می شود. برای اطلاعات بیشتر به پیام موقعیت مکانی مراجعه کنید که در مورد آن بسته به مجوز در مقابل ریز و درشت ریز تنظیم شده است. به مستندات مجوزها مراجعه کنید: https://developers.google.com/assistant/conversational/permissions .

timeZone

object ( TimeZone )

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

قابلیت

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

Enums
UNSPECIFIED قابلیت دستگاه نامشخص.
SPEECH دستگاه می تواند از طریق متن به گفتار یا SSML با کاربر صحبت کند.
RICH_RESPONSE دستگاه می تواند پاسخ های غنی مانند کارت ، لیست و جداول را نشان دهد.
LONG_FORM_AUDIO دستگاه می تواند رسانه های صوتی فرم طولانی مانند موسیقی و پادکست ها را پخش کند.
INTERACTIVE_CANVAS دستگاه می تواند پاسخ بوم تعاملی را نشان دهد.
HOME_STORAGE دستگاه می تواند از صرفه جویی و واکشی ذخیره سازی خانه پشتیبانی کند.

محل

ظرفی که یک مکان را نشان می دهد.

نمایندگی JSON
{
  "coordinates": {
    object (LatLng)
  },
  "postalAddress": {
    object (PostalAddress)
  }
}
زمینه های
coordinates

object ( LatLng )

مختصات GEO. به مجوز [دستگاه_پریس_لاکت] نیاز دارد.

postalAddress

object ( PostalAddress )

آدرس پستی. به مجوز [دستگاه_پریس_لاکت] یا [device_coarse_location] نیاز دارد. هنگامی که مجوز موقعیت مکانی درشت اعطا می شود ، انتظار می رود که فقط زمینه های "postalcode" و "مکان" جمع شوند. مجوز موقعیت مکانی دقیق زمینه های اضافی مانند "Administrativeearea" و "خطوط آدرس" را جمع می کند.

منطقه زمانی

یک منطقه زمانی را از پایگاه داده منطقه زمانی IANA نشان می دهد.

نمایندگی JSON
{
  "id": string,
  "version": string
}
زمینه های
id

string

منطقه زمانی پایگاه داده منطقه زمانی IANA، به عنوان مثال "America/New_York".

version

string

اختیاری. شماره نسخه پایگاه داده منطقه زمانی IANA، به عنوان مثال "2019a".

متن نوشته

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

نمایندگی JSON
{
  "media": {
    object (MediaContext)
  },
  "canvas": {
    object (CanvasContext)
  }
}
زمینه های
media

object ( MediaContext )

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

canvas

object ( CanvasContext )

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

مدافع

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

نمایندگی JSON
{
  "progress": string,
  "index": integer
}
زمینه های
progress

string ( Duration format)

پیشرفت رسانه ای پرونده رسانه فعال فعلی.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' خاتمه می یابد. مثال: "3.5s" .

index

integer

0 فهرست مبتنی بر پرونده رسانه فعال فعلی در لیست پرونده های رسانه ای در پاسخ رسانه.

بیدوست متن

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

نمایندگی JSON
{
  "state": value
}
زمینه های
state

value ( Value format)

اختیاری. حالت تنظیم شده توسط برنامه بوم تعاملی 3p. این فقط برای درخواست تنظیم شده است ، نه برای پاسخ. به عنوان مثال ، اگر این یک برنامه دستور العمل باشد ، حالت می تواند یک مقدار ساختار باشد: {"current_page": 5 ، "last_page": 3 ،} اندازه اندازه 50kb است.

انتظار می رود

انتظارات برای نوبت گفتگوی بعدی را شرح می دهد.

نمایندگی JSON
{
  "speech": [
    string
  ]
}
زمینه های
speech[]

string

فهرست عباراتی که Action از بیان کاربر برای سوگیری گفتاری انتظار دارد. حداکثر 1000 عبارت مجاز است. توجه: این فیلد همان معنای ExpectedInput.speech_biasing_hints در API v2 را دارد.