طرح موجودی رابطه ای

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

الزامات کلی

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

{"@type": "Menu","name": "Coffee Shop A","@id": "1535"}

هر نهاد «رستوران» ممکن است دو نهاد خدماتی داشته باشد (هر کدام یکی برای انواع سرویس «تحویل» و «برداشت»). هر نهاد «سرویس» ممکن است فقط یک «منو» داشته باشد.

هر موجودیت فرعی را می توان در چندین رستوران مورد استفاده مجدد قرار داد.

دستورالعمل های ارزش JSON

نوع اجبار

یک نوع مقدار JSON می‌تواند با نوع تعریف‌شده در طرح متفاوت باشد تا زمانی که بتوان آن را به نوع مورد نیاز وادار کرد. به عنوان مثال، ویژگی های رشته می تواند هم مقادیر رشته و هم مقادیر صحیح را به عنوان ورودی بپذیرد. به طور مشابه، خصوصیات عدد صحیح می توانند مقدار رشته را بپذیرند تا زمانی که بتوان رشته را به عدد صحیح معتبر تجزیه کرد.

نوع اجبار همچنین برای خواص مکرر کار می کند. ویژگی های تکرار شده می توانند مقادیر را به عنوان ورودی بدون محصور شدن در براکت [] بپذیرند. برای مثال، ویژگی OperationHours.serviceId هر دو "service_id" و ["service_id"] را به عنوان ورودی معتبر می پذیرد.

ارزش تاریخ و زمان

DateTime بر اساس نوع schema.org است و، مگر اینکه خلاف آن ذکر شده باشد، باید از قالب ISO 8601 پیروی کند و تاریخ، زمان و منطقه زمانی را شامل شود. از دستور زیر برای DateTime استفاده کنید:

// DateTime format:
YYYY-MM-DDTHH:MM:SS[∓HH:MM|Z]

مثلا:

2017-05-01T06:30:00-07:00 // UTC minus 7 hours
2017-05-01T06:30:00Z  // UTC time zone. The optional "Z" suffix represents the UTC time zone.

Time ، زمان محلی منطقه زمانی یک رستوران یا مکان ارائه خدمات است، همچنین بر اساس نوع schema.org است، و همچنین باید از قالب ISO 8601 پیروی کند. Time از نحو زیر استفاده می کند:

// Time format:
THH:MM:SS

مثلا:

T08:08:00 // 8:08 AM

هر زمان که DateTime یا Time تعیین می کنید به موارد زیر توجه کنید:

  • پیشوند "T" قبل از زمان بخشی از قالب است و لازم است.
  • منطقه زمانی باید برای DATETIME مشخص شود. برای TIME لازم نیست.
  • زمان رستوران یا سرویس باید به وقت محلی مشخص شود.

داده های رستوران

رستوران (الزامی)

یک نهاد مورد نیاز برای پیاده سازی یک رستوران را توصیف می کند.

جدول زیر ویژگی های نوع Restaurant را فهرست می کند:

ویژگی تایپ کنید شرح
@type Const

ضروری.

ارزش: Restaurant

@id رشته

ضروری.

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

مثال: restaurant_1

name رشته

ضروری.

نام رستوران.

مثال: Foo

description رشته

توضیحاتی در مورد رستوران

مثال: Best seafood in town

url آدرس اینترنتی

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

مثال: http://www.provider.com/somerestaurant

sameAs آدرس اینترنتی

وب سایت رسمی رستوران.

مثال: http://www.provider2.com/somerestaurant

telephone رشته

شماره تلفن رستوران.

مثال: +12345665898

streetAddress رشته

ضروری.

آدرس خیابان رستوران.

مثال: 12345 Bar Avenu

addressLocality رشته

ضروری.

محل یا شهر.

مثال: San Francisco

addressRegion رشته

ضروری.

منطقه یا ایالت.

مثال: CA

postalCode رشته

ضروری.

کد پستی.

مثال: 94124

addressCountry رشته

ضروری.

کد کشور ISO 3166-1 آلفا-2 دو حرفی.

مثال: US

latitude عدد

عرض جغرافیایی بر حسب درجه مقادیر به محدوده [[-90, 90]] محدود می‌شوند. دقت باید حداقل 5 رقم اعشار باشد.

مثال: 35.7392607

longitude عدد

طول جغرافیایی بر حسب درجه مقادیر به محدوده [[-180، 180]] محدود می‌شوند. دقت باید حداقل 5 رقم اعشار باشد.

مثال: -120.3895522

dealId فهرست <رشته>

Deal قابل اجرا از رستوران.

imprint رشته

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

مثال: 

Three Brothers Tacos
123 FooSt
Mountain View
CA 94041, United States
email: contact@threebrotherstacos.com

Commercial Register: 123456789

economicOperator رشته

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

مثال: 

XYZ Corp
123 Main Street
555-555-5555

dateModified مهر زمانی ISO

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

مثال: 2017-01-02T00:00:00-07:00

مثال زیر یک عنصر Restaurant را نشان می دهد:

مثال

{
  "@type": "Restaurant",
  "@id": "10824",
  "name": "Pronto Wood Fired Pizzeria",
  "url": "https://www.provider.com/pronto-wood-fired-pizzeria",
  "telephone": "+16503659978",
  "streetAddress": "2560 El Camino Real",
  "addressLocality": "Palo Alto",
  "addressRegion": "CA",
  "postalCode": "94061",
  "addressCountry": "US",
  "latitude": 37.472842,
  "longitude": -122.217144
}

معامله

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

جدول زیر ویژگی های نوع Deal را فهرست می کند:

ویژگی تایپ کنید شرح
@type Const

ضروری.

ارزش: Deal

@id رشته

ضروری.

شناسه منحصر به فرد معامله.

مثال: FREEDELIVERY

dealCode رشته

ضروری.

شناسه معامله منحصر به فرد در هر معامله برای هر شریک. این شناسه باید به طور منحصر به فرد معامله را در سیستم تبلیغاتی شما مشخص کند. Google این شناسه را در قسمت promotions.coupon یک CheckoutRequest برای تأیید برای شما ارسال می کند.

مثال: ADETRE23

applicableServiceType لیست< ServiceType >

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

eligibleMaxOrders عدد صحیح

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

availabilityId فهرست <رشته>

مقادیر ID@ موجودیت‌های Availability که جزئیات مربوط به زمان در دسترس بودن بخش منو را ارائه می‌کند.

مثال: [ "availability_1" ]

isDisabled بولی

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

dealType DealType

ضروری.

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

priceCurrency رشته

هنگام discount is defined .

زمانی که eligibleTransactionVolumeMin is defined الزامی است.

ارز (در قالب 3 حرف ایزو 4217) تخفیف.

مثال: USD

eligibleTransactionVolumeMin عدد

حجم تراکنش، در واحد پولی که این تبلیغات برای آن معتبر است.

termsOfServiceUrl آدرس اینترنتی

ضروری.

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

dateModified مهر زمانی ISO

آخرین تاریخ و زمان تغییر یافته موجودیت Deal در قالب مهر زمانی ISO اما با نوع String.

مثال: 2017-01-02T00:00:00-07:00

دقیقاً یکی از گروه های زیر از خواص مورد نیاز است.
discount گروه 1 عدد

ارزش تخفیف به عنوان یک عدد

discountPercentage گروه 2 عدد

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

مثال زیر یک عنصر Deal را نشان می دهد:

مثال 1

{
  "@type": "Deal",
  "@id": "ONEDOLLARFEE",
  "dealCode": "THREEDOLLARFEE",
  "dealType": "CART_OFF",
  "availabilityId": [
    "availability_may2020"
  ],
  "termsOfServiceUrl": "http://www.provider.com/onedollardeal",
  "applicableServiceType": [
    "TAKEOUT"
  ],
  "discount": 3,
  "priceCurrency": "USD"
}

مثال 2

{
  "@type": "Deal",
  "@id": "10PERCOFF",
  "dealCode": "10PERCOFF",
  "dealType": "CART_OFF",
  "availabilityId": [
    "availability_weekdays_evening"
  ],
  "termsOfServiceUrl": "http://www.provider.com/deal",
  "discountPercentage": 10,
  "priceCurrency": "USD"
}

مثال 3

{
  "@type": "Deal",
  "@id": "FREEDELIVERY",
  "dealCode": "FREEDELIVERY",
  "dealType": "DELIVERY_OFF",
  "availabilityId": [
    "availability_may"
  ],
  "applicableServiceType": [
    "DELIVERY"
  ],
  "termsOfServiceUrl": "http://www.provider.com/free_delivery_deal",
  "discountPercentage": 100,
  "eligibleTransactionVolumeMin": 25,
  "priceCurrency": "USD"
}

داده های سرویس

خدمات (الزامی)

جزئیات خدمات سفارش غذا برای یک رستوران را شرح می دهد. Service یک نهاد ضروری برای پیاده سازی است.

جدول زیر ویژگی های نوع Service را فهرست می کند:

ویژگی تایپ کنید شرح
@type Const

ضروری.

ارزش: Service

@id رشته

ضروری.

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

مثال: service_1

serviceType ServiceType

ضروری.

نوع خدمات ارائه شده مقادیر ممکن "تحویل" یا "برداشت" است.

مثال: DELIVERY

restaurantId رشته

ضروری.

مقدار شناسه @ موجودیت رستوران با این نهاد سرویس مرتبط است.

مثال: restaurant_1

menuId رشته

ضروری.

مقدار ID@ موجودیت Menu مربوط به این نهاد سرویس است.

مثال: menu_1

dateModified مهر زمانی ISO

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

مثال: 2017-01-02T00:00:00-07:00

isDisabled بولی

نشان می دهد که آیا نهاد غیرفعال است. فقط زمانی از این نوع استفاده کنید که به دلیل یک رویداد غیرمنتظره باید نهاد را غیرفعال کنید و نمی دانید چه زمانی سرویس دوباره راه اندازی می شود (مثلاً برای تعطیلات استفاده نکنید).

مثال: true

servingConfig ServingConfig

پیکربندی سرویس برای سرویس مورد استفاده برای کنترل ویژگی‌های مختلف. به عنوان مثال غیرفعال کردن ویجت تبلیغاتی و غیره

actionLinkUrl رشته

حاوی یک نشانی وب برای سرویس تحویل/برداشت که هنگام انتقال از تجربه سفارش غذای انتها به انتها برای تغییر مسیر استفاده می‌شود.

مثال زیر یک عنصر Service را نشان می دهد:

مثال 1

{
  "@type": "Service",
  "@id": "10824/takeout",
  "serviceType": "TAKEOUT",
  "menuId": "10824",
  "restaurantId": "10824",
  "actionLinkUrl": "https://www.rwgpartnerwebsite.com/foodorderpickup/merchant_foepa_3"
}

مثال 2

{
  "@type": "Service",
  "@id": "10824/delivery",
  "serviceType": "DELIVERY",
  "menuId": "10824",
  "restaurantId": "10824",
  "actionLinkUrl": "https://www.rwgpartnerwebsite.com/foodorderdelivery/merchant_foepa_3"
}

محل خدمات

منطقه جغرافیایی را که می توان در آن غذا تحویل داد را توصیف می کند. اگر نهاد Service مرتبط دارای serviceType روی "DELIVERY" تنظیم شده باشد، این موجودیت باید اجرا شود.

جدول زیر ویژگی های نوع ServiceArea را فهرست می کند:

ویژگی تایپ کنید شرح
@type Const

ضروری.

مقدار: ServiceArea

@id رشته

ضروری.

شناسه منحصر به فرد منطقه خدمات.

مثال: service_area_1

serviceId فهرست <رشته>

ضروری.

مقدار ID@ موجودیت Service مرتبط با این موجودیت ServiceArea.

مثال: [ "service_1" ]

dateModified مهر زمانی ISO

آخرین تاریخ و زمان اصلاح شده فید نهاد ServiceArea در قالب مهر زمانی ISO اما با نوع String.

مثال: 2017-01-02T00:00:00-07:00

exclude بولی

این منطقه خدماتی را از کل منطقه تحویل مستثنی کنید. به عنوان مثال، یک کد پستی را می توان از یک منطقه چند ضلعی بزرگتر حذف کرد.

دقیقاً یکی از گروه های زیر از خواص مورد نیاز است.
polygon گروه 1 فهرست <رشته>

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

مثال: [ "37.806000 -122.425592 37.775849 -122.419043 37.795547 -122.394046 37.808747" ]

geoMidpointLatitude گروه 2 عدد

مختصات عرض جغرافیایی را در مرکز ناحیه CIRCLE نشان می دهد.

مثال: 37.806000

geoMidpointLongitude گروه 2 عدد

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

مثال: -122.425592

geoRadius گروه 2 عدد صحیح

شعاع تقریبی (بر حسب متر) ناحیه CIRCLE را نشان می دهد.

مثال: 10000

postalCode گروه 3 رشته

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

مثال: 91234

addressCountry گروه 3 رشته

کد کشور دو حرفی ISO 3166-1 آلفا-2 را نشان می دهد

مثال: US

مثال زیر یک عنصر ServiceArea را نشان می دهد:

مثال

{
  "@type": "ServiceArea",
  "@id": "28427",
  "serviceId": [
    "10824/delivery"
  ],
  "polygon": [
    "37.4818562 -122.25801303 37.48247836 -122.25801303 37.48434484 -122.25621319 37.48621133 -122.25424681 37.49181077 -122.24704744 37.49305509 -122.24541414 37.49429942 -122.2436143 37.49803238 -122.23821477 37.49803238 -122.21285044 37.49367726 -122.15885517 37.49056645 -122.15722187 37.48621133 -122.15542202 37.48558917 -122.15525548 37.4818562 -122.15525548 37.43191387 -122.17865343 37.43191387 -122.23444854"
  ]
}

ساعات کار (الزامی)

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

ویژگی های OperationHours opens and closes زمان باز و بسته شدن سیستم آنلاین را مشخص می کند که به کاربران اجازه می دهد سفارش دهند. در این ساعات سیستم آنلاین، از ServiceHours استفاده کنید تا ساعات باز و بسته شدن را برای زمان انجام سفارشات کاربران مشخص کنید.

زمان انجام سرویس باید در زمان محلی مشخص شود. منطقه زمانی را در مقدار opens لحاظ نکنید. اگر منطقه زمانی مشخص شده باشد، گوگل این اطلاعات را نادیده می گیرد. برای اطلاعات بیشتر، به قالب‌های DateTime و Time مراجعه کنید.

جدول زیر ویژگی های نوع OperationHours را فهرست می کند:

ویژگی تایپ کنید شرح
@type Const

ضروری.

ارزش: OperationHours

@id رشته

ضروری.

یک شناسه منحصر به فرد برای نهاد که پنجره سفارش را توصیف می کند که کاربران می توانند به جریان دسترسی داشته باشند و سفارشات ASAP/آینده را انجام دهند.

مثال: operation_hour_1

serviceId فهرست <رشته>

ضروری.

مقدار ID@ موجودیت Service مرتبط با این موجودیت OperationHours.

مثال: [ "service_1" ]

opens زمان ISO (محلی)

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

مثال: T00:00

closes زمان ISO (محلی)

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

مثال: T16:00

dayOfWeek فهرست< DayOfWeek >

فهرستی از روز(های) هفته که این ساعات کاری برای آنها معتبر است. مقادیر قابل قبول "دوشنبه"، "سه شنبه"، "چهارشنبه"، "پنجشنبه"، "جمعه"، "شنبه" و "یکشنبه" است.

مثال: [ "MONDAY", "TUESDAY" ]

validFrom مهر زمان ISO

زمانی که isSpecialHour = true لازم است.

یک مهر زمان ISO که زمان شروع پنجره سفارش را نشان می دهد که کاربران می توانند به جریان دسترسی داشته باشند و سفارشات ASAP/آینده را ثبت کنند.

مثال: 2017-01-01T00:00:00-07:00

validThrough مهر زمانی ISO

زمانی که isSpecialHour = true لازم است.

یک مهر زمانی ISO که زمان پایان پنجره سفارش را نشان می دهد که پس از آن کاربران نمی توانند به جریان دسترسی داشته باشند و سفارشات ASAP/آینده را انجام دهند.

مثال: 2017-01-02T00:00:00-07:00

isSpecialHour بولی

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

مثال: False

dateModified مهر زمانی ISO

آخرین تاریخ و زمان تغییر یافته موجودیت OperationHours در قالب مهر زمانی ISO اما با نوع String.

مثال: 2017-01-02T00:00:00-07:00

مثال زیر یک عنصر OperationHours را نشان می دهد:

مثال 1

{
  "@type": "OperationHours",
  "@id": "10824/deliveryOh",
  "serviceId": [
    "10824/delivery"
  ],
  "isSpecialHour": false
}

مثال 2

{
  "@type": "OperationHours",
  "@id": "10824/takeoutOh",
  "serviceId": [
    "10824/takeout"
  ],
  "isSpecialHour": false
}

ساعات خدمات (الزامی)

پنجره تکمیل را توصیف می کند که در آن کاربران می توانند اسلات تکمیل (ASAP یا جایگاه های آینده) را انتخاب کنند. اجرای ServiceHours مورد نیاز است.

ویژگی های OperationHours opens and closes زمان باز و بسته شدن سیستم آنلاین را مشخص می کند که به کاربران اجازه می دهد سفارش دهند. در این ساعات سیستم آنلاین، از ServiceHours استفاده کنید تا ساعات باز و بسته شدن را برای زمان انجام سفارشات کاربران مشخص کنید.

زمان انجام سرویس باید در زمان محلی مشخص شود. منطقه زمانی را در مقدار opens لحاظ نکنید. اگر منطقه زمانی مشخص شده باشد، گوگل این اطلاعات را نادیده می گیرد. برای اطلاعات بیشتر، به قالب‌های DateTime و Time مراجعه کنید.

جدول زیر ویژگی های نوع ServiceHours را فهرست می کند:

ویژگی تایپ کنید شرح
@type Const

ضروری.

ارزش: ServiceHours

@id رشته

ضروری.

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

مثال: service_hour_1

orderType OrderType

ضروری.

رشته‌ای که نشان می‌دهد ساعات خدمات برای سفارش‌های ASAP یا پیشرفته اعمال می‌شود یا خیر. مقادیر قابل قبول "ASAP" و "ADVANCE" هستند.

مثال: ASAP

serviceId فهرست <رشته>

ضروری.

مقدار ID@ موجودیت Service مرتبط با این موجودیت ServiceHours.

مثال: [ "service_1" ]

operationHoursId فهرست <رشته>

زمانی که isSpecialHour = false مورد نیاز است.

مقدار ID@ موجودیت OperationHours با این موجودیت ServiceHours مرتبط است.

مثال: [ "operation_hour_1" ]

opens زمان ISO (محلی)

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

مثال: T00:00

closes زمان ISO (محلی)

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

مثال: T16:00

dayOfWeek فهرست < DayOfWeek >

فهرستی از روز(های) هفته که این ساعات کاری برای آنها معتبر است.

مثال: [ "MONDAY", "TUESDAY" ]

validFrom مهر زمان ISO

زمانی که isSpecialHour = true لازم است.

یک مهر زمان ISO که زمان شروع پنجره سفارش را نشان می دهد که کاربران می توانند به جریان دسترسی داشته باشند و سفارشات ASAP/آینده را ثبت کنند.

مثال: 2017-01-01T00:00:00-07:00

validThrough مهر زمانی ISO

زمانی که isSpecialHour = true لازم است.

یک مهر زمانی ISO که زمان پایان پنجره سفارش را نشان می دهد که پس از آن کاربران نمی توانند به جریان دسترسی داشته باشند و سفارشات ASAP/آینده را انجام دهند.

مثال: 2017-01-02T00:00:00-07:00

isSpecialHour بولی

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

مثال: False

leadTimeMin عدد صحیح

حداقل زمان تخمینی تحویل / تحویل، در دقیقه، پس از ثبت سفارش ASAP. ما قویاً توصیه می کنیم که این ویژگی را تنظیم کنید.

مثال: 60

leadTimeMax عدد صحیح

حداکثر زمان تخمینی تحویل/ تحویل، در دقیقه، پس از ثبت سفارش ASAP. ما قویاً توصیه می کنیم که این ویژگی را تنظیم کنید.

مثال: 70

advanceBookingRequirementMin عدد صحیح

زمانی که orderType = "ADVANCE" مورد نیاز است.

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

مثال: 15

advanceBookingRequirementMax عدد صحیح

زمانی که orderType = "ADVANCE" مورد نیاز است.

حداکثر تعداد دقیقه از زمان سفارش که می توان پیش سفارش را انجام داد. به عنوان مثال، اگر یک سفارش پیش از انجام بیش از 2 روز بعد محدود شود، مقدار advanceBookingRequirementMax 2880 است.

مثال: 10080

advanceBookingSlotInterval رشته

زمانی که orderType = "ADVANCE" مورد نیاز است.

فاصله بین دو زمان متوالی اسلات رزرو از قبل. به عنوان مثال: اگر باز و بسته شدن ساعت 8 صبح و 8 بعد از ظهر باشد و advanceBookingSlotInterval 15 دقیقه باشد، کاربر می‌تواند زمان‌های تکمیل را تا ساعت 8 صبح، 8:15 صبح، 8:30 صبح، 8:45 صبح و غیره انتخاب کند. مدت زمان باید به عنوان مدت زمان ISO مشخص شود. به عنوان مثال: "PT15M" به معنای فواصل 15 دقیقه ای است.

مثال: PT15M

dateModified مهر زمانی ISO

آخرین تاریخ و زمان تغییر یافته موجودیت ServiceHours در قالب مهر زمانی ISO اما با نوع String.

مثال: 2017-01-02T00:00:00-07:00

مثال زیر یک عنصر ServiceHours را نشان می دهد:

مثال 1

{
  "@type": "ServiceHours",
  "@id": "613741/delivery",
  "orderType": "ASAP",
  "serviceId": [
    "10824/delivery"
  ],
  "opens": "T00:00",
  "closes": "T00:00",
  "isSpecialHour": true,
  "validFrom": "2017-12-25T00:00:00-07:00",
  "validThrough": "2017-12-25T23:59:00-07:00"
}

مثال 2

{
  "@type": "ServiceHours",
  "@id": "10824/takeoutSh_0",
  "orderType": "ASAP",
  "serviceId": [
    "10824/takeout"
  ],
  "operationHoursId": [
    "10824/takeoutOh"
  ],
  "opens": "11:00",
  "closes": "21:00",
  "dayOfWeek": [
    "MONDAY",
    "TUESDAY",
    "WEDNESDAY",
    "THURSDAY"
  ],
  "isSpecialHour": false
}

هزینه

هزینه ای را شرح می دهد. اگر نهاد Service مرتبط serviceType روی "DELIVERY" تنظیم کرده باشد، پس Fee ای با feeType روی "DELIVERY" لازم است.

جدول زیر ویژگی های نوع Fee را فهرست می کند:

ویژگی تایپ کنید شرح
@type Const

ضروری.

ارزش: Fee

@id رشته

ضروری.

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

مثال: service_fee_1

serviceId فهرست <رشته>

ضروری.

مقدار ID@ موجودیت Service مرتبط با این نهاد Fee.

مثال: [ "service_1" ]

feeType FeeType

ضروری.

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

مثال: DELIVERY

priceCurrency رشته

ضروری.

کد ارز 3 حرفی ISO 4217.

مثال: USD

basePrice عدد

قیمت پایه کارمزد، زمانی که percentageOfCart یا pricePerMeter استفاده می شود اعمال می شود.

مثال: 2.0

minPrice عدد

حداقل کارمزد، وقتی percentageOfCart یا pricePerMeter استفاده می شود، مقدار کارمزد را محدود می کند.

مثال: 2.0

maxPrice عدد

حداکثر کارمزد، وقتی percentageOfCart یا pricePerMeter استفاده می‌شود، مقدار کارمزد را محدود می‌کند.

مثال: 10.0

eligibleRegion فهرست <رشته>

شناسه @ ServiceArea برای منطقه(های) ژئوپلیتیکی که هزینه آن معتبر است. فقط در صورتی از این ملک استفاده کنید که هزینه های تحویل بسته به منطقه متفاوت باشد.

مثال: [ "service_area_1" ]

eligibleTransactionVolumeMin عدد

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

مثال: 50

eligibleTransactionVolumeMax عدد

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

مثال: 10

validFrom مهر زمانی ISO

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

مثال: 2017-01-01T00:00:00-07:00

validThrough مهر زمانی ISO

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

مثال: 2017-01-02T00:00:00-07:00

dateModified مهر زمانی ISO

آخرین تاریخ و زمان تغییر یافته موجودیت Fee در قالب مهر زمانی ISO اما با نوع String.

مثال: 2017-01-02T00:00:00-07:00

priority عدد

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

مثال: 3

دقیقاً یکی از گروه های زیر از خواص مورد نیاز است.
price گروه 1 عدد

قیمت کارمزد. اگر قیمت ثابت نیست، minPrice و maxPrice را می توان به جای قیمت ارائه کرد.

مثال: 1.5

percentageOfCart گروه 2 عدد

کارمزد به درصد از ارزش سبد خرید. مقادیر قابل قبول، مقادیر شناور بین 0 تا 100 هستند.

مثال: 9.00

pricePerMeter گروه 3 عدد

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

مثال: 0.001

مثال زیر یک عنصر Fee را نشان می دهد:

مثال 1

{
  "@type": "Fee",
  "@id": "28427",
  "serviceId": [
    "10824/delivery"
  ],
  "feeType": "DELIVERY",
  "priceCurrency": "USD",
  "eligibleRegion": [
    "28427"
  ],
  "eligibleTransactionVolumeMin": 20,
  "price": 5
}

مثال 2

{
  "@type": "Fee",
  "@id": "28427",
  "serviceId": [
    "10824/delivery"
  ],
  "feeType": "DELIVERY",
  "priceCurrency": "USD",
  "eligibleRegion": [
    "28427"
  ],
  "eligibleTransactionVolumeMin": 20,
  "pricePerMeter": 0.0005,
  "basePrice": 4
}

مثال 3

{
  "@type": "Fee",
  "@id": "28427",
  "serviceId": [
    "10824/delivery"
  ],
  "feeType": "DELIVERY",
  "priceCurrency": "USD",
  "eligibleRegion": [
    "28427"
  ],
  "eligibleTransactionVolumeMin": 20,
  "pricePerMeter": 0.0005,
  "basePrice": 4,
  "minPrice": 5,
  "maxPrice": 50
}

مثال 4

{
  "@type": "Fee",
  "@id": "28427",
  "serviceId": [
    "10824/delivery"
  ],
  "feeType": "DELIVERY",
  "priceCurrency": "USD",
  "eligibleRegion": [
    "28427"
  ],
  "eligibleTransactionVolumeMin": 20,
  "percentageOfCart": 5,
  "basePrice": 4
}

مثال 5

{
  "@type": "Fee",
  "@id": "28427",
  "serviceId": [
    "10824/delivery"
  ],
  "feeType": "DELIVERY",
  "priceCurrency": "USD",
  "eligibleRegion": [
    "28427"
  ],
  "eligibleTransactionVolumeMin": 20,
  "percentageOfCart": 5,
  "basePrice": 4,
  "minPrice": 5,
  "maxPrice": 50
}

یک نهاد مورد نیاز برای پیاده سازی منویی را توصیف می کند.

جدول زیر ویژگی های نوع Menu را فهرست می کند:

ویژگی تایپ کنید شرح
@type Const

ضروری.

مقدار: Menu

@id رشته

ضروری.

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

مثال: menu_1

name رشته

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

مثال: Foo

disclaimer رشته

سلب مسئولیت برای منو. به عنوان مثال، افشای اطلاعات تغذیه ای و افشای آلرژن ها.

مثال: Items may contain peanuts.

disclaimerUrl آدرس اینترنتی

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

dateModified مهر زمانی ISO

آخرین تاریخ و زمان تغییر یافته موجودیت منو در قالب مهر زمانی ISO اما با نوع String.

مثال: 2017-01-02T00:00:00-07:00

مثال زیر یک عنصر Menu را نشان می دهد: 

{
  "@type": "Menu",
  "@id": "10824"
}

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

جدول زیر ویژگی های نوع MenuSection را فهرست می کند:

ویژگی تایپ کنید شرح
@type Const

ضروری.

مقدار: MenuSection

@id رشته

ضروری.

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

مثال: menu_section_1

menuId فهرست< ReverseReference >

مقدار ID@ موجودیت Menu با این موجودیت MenuSection مرتبط است.

مثال: [ { "@id": "menu_id", "displayOrder": 4 } ]

menuSectionId فهرست <رشته>

فهرستی از مقادیر ID@ موجودیت های MenuSection فرزند که با این موجودیت MenuSection مطابقت دارد.

مهم: فقط باید از یکی از مراجع menuSectionId یا parentMenuSectionId(in child) استفاده کنید.

مثال: [ "child_menu_section_1", "child_menu_section_2" ]

parentMenuSectionId فهرست< ReverseReference >

مقدار ID@ موجودیت MenuSection والد با این موجودیت MenuSection مرتبط است.

مهم: شما باید فقط از یکی از مراجع parentMenuSectionId یا menuSectionId(in parent) استفاده کنید.

مثال: [ { "@id": "parent_menu_section_id", "displayOrder": 4 } ]

name رشته

ضروری.

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

مثال: Foo

description رشته

توضیحات بخش منو

مثال: Example menu section description that helps users.

image آدرس اینترنتی

آدرس یک تصویر از بخش منو.

مثال: https://provider.com/someimage

menuItemId فهرست <رشته>

فهرستی از مقادیر ID@ موجودیت های MenuItem که با این موجودیت MenuSection مطابقت دارند.

مهم: فقط باید از یکی از مراجع menuItemId یا MenuItem.parentMenuSectionId استفاده کنید.

مثال: [ "menu_item1", "menu_item2" ]

parentMenuItemId فهرست< ReverseReference >

فهرستی از مقادیر ID@ موجودیت های MenuItem والد که با این موجودیت MenuSection مطابقت دارند.

مهم: شما باید فقط از یکی از مراجع parentMenuItemId یا MenuItem.menuAddOnId استفاده کنید.

مثال: [ { "@id": "parent_menu_item_id", "displayOrder": 4 } ]

parentMenuItemOptionId فهرست< ReverseReference >

فهرستی از مقادیر ID@ موجودیت های MenuItemOption والد که با این موجودیت MenuSection مطابقت دارند.

مهم: شما باید فقط از یکی از مراجع parentMenuItemOptionId یا MenuItemOption.menuAddOnId استفاده کنید.

مثال: [ { "@id": "parent_menu_item_option_id", "displayOrder": 4 } ]

eligibleQuantityMax عدد صحیح

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

مثال: 5

eligibleQuantityMin عدد صحیح

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

مثال: 1

defaultItemId فهرست <رشته>

فهرستی از شناسه @ که به موجودیت‌های MenuItem ارجاع می‌دهد که به‌طور پیش‌فرض برای کاربران در MenuSection افزونه از پیش انتخاب می‌شوند. کاربران می توانند انتخاب های نهایی را تغییر دهند. اگر defaultItemId مشخص نشده باشد، هیچ MenuItem از پیش انتخاب نشده است.

مثال: [ "item1", "item2" ]

availabilityId فهرست <رشته>

مقادیر ID@ موجودیت‌های Availability که جزئیات مربوط به زمان در دسترس بودن بخش منو را ارائه می‌کند.

مثال: [ "menu_availability_1" ]

numberOfFreeAddOns عدد صحیح

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

مثال: 3

dateModified مهر زمان ISO

آخرین تاریخ و زمان تغییر یافته موجودیت MenuSection در قالب مهر زمانی ISO اما با نوع String.

مثال: 2017-01-02T00:00:00-07:00

applicableServiceType لیست< ServiceType >

سرویسی که این MenuSection برای آن قابل اجرا است. پیش فرض یک MenuSection را در نظر می گیرد که برای همه قابل اجرا است.

offeredById فهرست <رشته>

مقادیر ID@ موجودیت‌های Restaurant که این MenuSection در آنها موجود است. پیش‌فرض فرض می‌کند که یک MenuSection در همه مکان‌ها در دسترس است.

مثال: [ "restaurant_id_1", "restaurant_id_55" ]

مثال زیر یک عنصر MenuSection را نشان می دهد: 

{
  "@type": "MenuSection",
  "@id": "853705",
  "menuId": [
    {
      "@id": "10824",
      "displayOrder": 853705
    }
  ],
  "menuSectionId": [
    12345,
    43645
  ],
  "name": "Pasta",
  "applicableServiceType": [
    "TAKEOUT"
  ],
  "offeredById": [
    "italian_restaurant_location_1"
  ]
}
{
  "@type": "MenuSection",
  "@id": "427484",
  "menuId": [
    {
      "@id": "4287",
      "displayOrder": 964376
    }
  ],
  "menuItemId": [
    46784,
    42728
  ],
  "name": "Burger",
  "applicableServiceType": [
    "TAKEOUT",
    "DELIVERY"
  ]
}
{
  "@type": "MenuSection",
  "@id": "3138486",
  "name": "Choose a side:",
  "parentMenuItemId": [
    {
      "@id": "6680295",
      "displayOrder": 3138486
    }
  ],
  "eligibleQuantityMax": "5",
  "numberOfFreeAddOns": "2"
}
{
  "@type": "MenuSection",
  "@id": "3138482",
  "name": "Additional Pizza Toppings",
  "parentMenuItemId": [
    {
      "@id": "6680246",
      "displayOrder": 3138482
    }
  ],
  "eligibleQuantityMax": "3"
}

دسترسی

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

جدول زیر ویژگی های نوع Availability را فهرست می کند:

ویژگی تایپ کنید شرح
@type Const

ضروری.

ارزش: Availability

@id رشته

ضروری.

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

مثال: menu_section_avail_1

availabilityStarts زمان ISO (محلی)

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

مثال: T00:00

availabilityEnds زمان ISO (محلی)

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

مثال: T16:00

availableDay فهرست < DayOfWeek >

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

مثال: [ "MONDAY", "TUESDAY" ]

validFrom مهر زمانی ISO

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

مثال: 2017-01-01T00:00:00-07:00

validThrough مهر زمانی ISO

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

مثال: 2017-01-02T00:00:00-07:00

dateModified مهر زمانی ISO

آخرین تاریخ و زمان اصلاح شده فید موجودیت در دسترس بودن در قالب مهر زمانی ISO اما با نوع String.

مثال: 2017-01-02T00:00:00-07:00

مثال زیر یک عنصر Availability را نشان می دهد:

مثال

{
  "@type": "Availability",
  "@id": "85343705",
  "availabilityStarts": "06:00",
  "availabilityEnds": "22:30",
  "availableDay": [
    "SATURDAY",
    "SUNDAY"
  ]
}

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

جدول زیر ویژگی های نوع MenuItem را فهرست می کند:

ویژگی تایپ کنید شرح
@type Const

ضروری.

مقدار: MenuItem

@id رشته

ضروری.

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

مثال: menu_item_1

name رشته

ضروری.

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

مثال: Foo

description رشته

توضیحاتی در مورد آیتم منو

مثال: Foo

image آدرس اینترنتی

نشانی اینترنتی یک تصویر از آیتم منو.

مثال: http://someprovider.com/someimage

parentMenuSectionId فهرست< ReverseReference >

فهرستی از مقادیر ID@ موجودیت های MenuSection والد که با این موجودیت MenuItem مطابقت دارند.

مهم: شما باید فقط از یکی از مراجع parentMenuSectionId یا MenuSection.menuItemId استفاده کنید.

مثال: { "@id": "menu_section_parent_id", "displayOrder": 4 }

menuAddOnId فهرست <رشته>

فهرستی از مقادیر ID@ موجودیت های MenuSection که از بخش add on هستند که با این موجودیت MenuItem مطابقت دارند.

مهم: فقط باید از یکی از مراجع menuAddOnId یا MenuSection.parentMenuItemId استفاده کنید.

مثال: menu_addon_1

nutrition NutritionInformation

اطلاعات تغذیه برای ظرف، به ویژه کالری.

مثال: { "calories": "120-150 Cal" }

allergen لیست< Allergen >

آلرژن های این منو.

مثال: [ { "allergenType": "PEANUTS", "levelOfContainment": "MAY_CONTAIN" } ]

additive فهرست< Additive >

افزودنی های این منو آیتم.

مثال: [ { "additiveName": "Sodium nitrite", "levelOfContainment": "CONTAINS" } ]

suitableDiet فهرست < RestrictedDiet >

این ظرف با محدودیت غذایی شرح داده شده مطابقت دارد.

مثال: [ "DIABETIC", "GLUTEN_FREE" ]

depositInfo DepositInfo

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

مثال: { "depositCode": "RECYCLABLE", "depositValue": "0.05", "depositValueCurrency": "USD" }

numberOfServings عدد صحیح

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

مثال: 2

dateModified مهر زمان ISO

آخرین تاریخ و زمان تغییر یافته موجودیت MenuItem در قالب مهر زمانی ISO اما با نوع String.

مثال: 2017-01-02T00:00:00-07:00

مثال زیر یک عنصر MenuItem را نشان می دهد: 

{
  "@type": "MenuItem",
  "@id": "18931508",
  "name": "Sauteed Baby Spinach",
  "parentMenuSectionId": [
    {
      "@id": "3138479",
      "displayOrder": 18931508
    }
  ]
}
{
  "@type": "MenuItem",
  "@id": "18931508",
  "name": "Hamburger",
  "parentMenuSectionId": [
    {
      "@id": "4645747",
      "displayOrder": 12345
    }
  ],
  "nutrition": {
    "calories": "400 cal"
  },
  "allergen": [
    {
      "allergenType": "GLUTEN",
      "levelOfContainment": "CONTAINS"
    }
  ],
  "additive": [
    {
      "additiveName": "Sodium nitrite",
      "levelOfContainment": "CONTAINS"
    }
  ],
  "suitableDiet": [
    "DIABETIC",
    "LOW_FAT"
  ]
}

یک موجودیت اختیاری برای پیاده سازی. انتخاب هایی را توصیف می کند که کاربر باید هنگام انتخاب یک ظرف/ترکیب انجام دهد. کاربر باید یک گزینه را انتخاب کند، در غیر این صورت سفارش نامعتبر تلقی می شود (به عنوان مثال کاربر باید کوچک، متوسط ​​یا بزرگ را برای پیتزا انتخاب کند).

جدول زیر ویژگی های نوع MenuItemOption را فهرست می کند:

ویژگی تایپ کنید شرح
@type Const

مقدار: MenuItemOption

@id رشته

ضروری.

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

مثال: menu_item_1_option

menuItemId ReverseReference

ضروری.

مقدار ID@ موجودیت MenuItem با این موجودیت MenuItemOption مرتبط است.

مثال: { "@id": "menu_item_1", "displayOrder": 4 }

optionType OptionType

رشته ای که نشان می دهد گزینه آیتم منو از نظر اندازه، گزینه یا سمت پیتزا طبقه بندی شده است یا خیر. مقادیر قابل قبول «SIZE»، «OPTION» و «PIZZA_SIDE» هستند. "SIZE": اندازه گزینه MenuItemOption. مثلاً کوچک، متوسط ​​یا بزرگ. "OPTION": هر گونه تغییری غیر از اندازه (مثلاً غذایی که به عنوان سالاد یا ساندویچ می آید). اگر نمی توانید بین "SIZE" و "OPTION" تمایز قائل شوید، از "OPTION" استفاده کنید. "PIZZA_SIDE": مخصوص پیتزاها: به عنوان مثال این MenuItemOption فقط برای یک قسمت/کل پیتزا معتبر است (مثلاً رویه های قارچ در سمت چپ، سمت راست یا پیتزا کامل).

مثال: SIZE

value رشته یا PizzaSide

زمانی که optionType is defined مورد نیاز است.

یک مقدار رشته یا مقدار enum. مقادیر Enum مختص نوع گزینه PIZZA_SIDE هستند.

applicableParentOptionValue رشته

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

مثال: Small

menuAddOnId فهرست <رشته>

فهرستی از مقادیر ID@ موجودیت های MenuSection که از بخش add on هستند که با این موجودیت MenuItemOption مطابقت دارند.

مهم: فقط باید از یکی از مراجع menuAddOnId یا MenuSection.parentMenuItemId استفاده کنید.

مثال: menuAddOnId

nutrition NutritionInformation

اطلاعات تغذیه برای ظرف، به ویژه کالری.

مثال: { "calories": "120-150 Cal" }

allergen لیست< Allergen >

آلرژن های این منو.

مثال: { "allergenType": "PEANUTS", "levelOfContainment": "MAY_CONTAIN" }

additive فهرست< Additive >

افزودنی های این منو آیتم.

مثال: { "additiveName": "Sodium nitrite", "levelOfContainment": "CONTAINS" }

depositInfo DepositInfo

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

مثال: { "depositCode": "RECYCLABLE", "depositValue": "0.05", "depositValueCurrency": "USD" }

numberOfServings عدد صحیح

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

مثال: 2

dateModified مهر زمانی ISO

آخرین تاریخ و زمان تغییر یافته موجودیت MenuItemOption در قالب مهر زمان ISO اما با نوع String.

مثال: 2017-01-02T00:00:00-07:00

مثال زیر یک عنصر MenuItemOption را نشان می دهد: 

{
  "@type": "MenuItemOption",
  "@id": "56177944",
  "menuItemId": {
    "@id": "18930213",
    "displayOrder": 1234
  },
  "optionType": "PIZZA_SIDE",
  "value": "PIZZA_SIDE_LEFT"
}
{
  "@type": "MenuItemOption",
  "@id": "56177944",
  "menuItemId": {
    "@id": "18930213",
    "displayOrder": 1234
  },
  "applicableParentOptionValue": "Small Pizza"
}

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

جدول زیر ویژگی های نوع MenuItemOffer را فهرست می کند:

ویژگی تایپ کنید شرح
@type Const

ضروری.

مقدار: MenuItemOffer

@id رشته

ضروری.

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

مثال: menu_item_offer

sku رشته

ضروری.

شناسه پیشنهاد آیتم منو. مقادیر sku ممکن است در چندین مورد پیشنهادی منو متفاوت یا یکسان باشد. هنگامی که ما با شما تماس API برقرار می کنیم، مقدار sku به ترتیب تنظیم می شود.

مثال: Menu_item_offer_sku

price عدد

ضروری.

قیمت پیشنهاد آیتم منو

مثال: 2.5

priceCurrency رشته

ضروری.

کد ارز 3 حرفی ISO 4217.

مثال: USD

availabilityId فهرست <رشته>

مقادیر ID@ موجودیت‌های Availability که جزئیاتی را در مورد زمانی که پیشنهاد آیتم منو در دسترس است، ارائه می‌کند.

مثال: [ "menu_availability_1" ]

eligibleQuantityMin عدد

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

مثال: 1

eligibleQuantityMax عدد

حداکثر مقدار سفارشی که MenuItemOffer برای آن معتبر است.

مثال: 25

inventoryLevel عدد

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

مثال: 10

dateModified مهر زمانی ISO

آخرین تاریخ و زمان تغییر یافته موجودیت MenuItemOffer در قالب مهر زمانی ISO اما با نوع String.

مثال: 2017-01-02T00:00:00-07:00

applicableServiceType لیست< ServiceType >

سرویسی که این MenuItemOffer برای آن قابل اجرا است. پیش فرض یک MenuItemOffer را فرض می کند که برای همه قابل اجرا است.

offeredById فهرست <رشته>

مقادیر ID@ موجودیت‌های Restaurant که این MenuItemOffer در آنها موجود است. پیش‌فرض فرض می‌کند که MenuItemOffer در همه مکان‌ها در دسترس است.

مثال: [ "restaurant_id_5", "restaurant_id_26" ]

دقیقاً یکی از گروه های زیر از خواص مورد نیاز است.
menuItemId گروه 1 رشته

مقدار ID@ موجودیت MenuItem با این موجودیت MenuItemOffer مرتبط است.

مثال: menu_item_1

menuItemOptionId گروه 2 رشته

مقدار ID@ موجودیت MenuItemOption با این موجودیت MenuItemOffer مرتبط است.

مثال: menu_item_option_1

مثال زیر یک عنصر MenuItemOffer را نشان می دهد: 

{
  "@type": "MenuItemOffer",
  "@id": "6680262",
  "sku": "offer-mediterranean-bagel",
  "menuItemId": "896532",
  "price": 15.5,
  "priceCurrency": "USD",
  "applicableServiceType": [
    "DELIVERY"
  ],
  "offeredById": [
    "bagel_shop_location_5"
  ]
}

مشترک

مرجع معکوس

جدول زیر ویژگی های نوع ReverseReference را فهرست می کند:

ویژگی تایپ کنید شرح
@id رشته

ضروری.

شناسه @ موجودیت والد.

displayOrder عدد صحیح

ضروری.

نمایش ترتیب مورد در والد.

اطلاعات تغذیه

جدول زیر ویژگی های نوع NutritionInformation را فهرست می کند:

ویژگی تایپ کنید شرح
description رشته

اطلاعات تغذیه در متن آزاد. به عنوان مثال "حاوی مواد نگهدارنده".

calories رشته

تعداد کالری بر حسب کالری، کیلوکالری یا کیلوژول، با استفاده از فرمت زیر: مقدار کالری یا حداقل حداکثر کالری

مثال: 120.34 Cal

sodiumContent رشته

تعداد میلی گرم یا گرم سدیم، با استفاده از فرمت زیر: مقدار g یا min-max g

مثال: 1200 mg

مثال زیر یک عنصر NutritionInformation را نشان می دهد:

مثال

{
  "calories": "120-150 Cal",
  "sodiumContent": "100 mg"
}

آلرژن

جدول زیر ویژگی های نوع Allergen را فهرست می کند:

ویژگی تایپ کنید شرح
allergenType AllergenType

ضروری.

نوع آلرژن

levelOfContainment ContainmentLevel

سطح یک آلرژن معین در آیتم منو.

مثال زیر یک عنصر Allergen را نشان می دهد:

مثال

{
  "allergenType": "PEANUTS",
  "levelOfContainment": "MAY_CONTAIN"
}

افزودنی

جدول زیر ویژگی های نوع Additive را فهرست می کند:

ویژگی تایپ کنید شرح
additiveName رشته

ضروری.

نام ماده افزودنی

levelOfContainment ContainmentLevel

سطح یک افزودنی معین در آیتم منو.

مثال زیر یک عنصر Additive را نشان می دهد:

مثال

{
  "additiveName": "Sodium nitrite",
  "levelOfContainment": "CONTAINS"
}

DepositInfo

جدول زیر ویژگی های نوع DepositInfo را فهرست می کند:

ویژگی تایپ کنید شرح
depositCode DepositCode

کد سپرده.

depositValue عدد

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

depositValueCurrency رشته

ارز ارزش سپرده

مثال زیر یک عنصر DepositInfo را نشان می دهد:

مثال

{
  "depositCode": "RECYCLABLE",
  "depositValue": 0.05,
  "depositValueCurrency": "USD"
}

ServingConfig

پیکربندی سرویس برای سرویس مورد استفاده برای کنترل ویژگی‌های مختلف. به عنوان مثال غیرفعال کردن ویجت تبلیغاتی و غیره

جدول زیر ویژگی های نوع ServingConfig را فهرست می کند:

ویژگی تایپ کنید شرح
disableOrderInstructions بولی

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

disableMenuItemSpecialInstructions بولی

توانایی تعیین دستورالعمل‌های خاص روی یک آیتم منو را پنهان می‌کند.

disableTipWidget بولی

ویجت نوک را در صفحه «ثبت سفارش» جریان سفارش پنهان می‌کند.

disablePromoWidget بولی

ویجت تبلیغاتی را در صفحه «ثبت سفارش» جریان سفارش پنهان می‌کند.

menuItemSpecialInstructionsMaxLength عدد

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

orderInstructionsMaxLength عدد

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

مثال زیر یک عنصر ServingConfig را نشان می دهد:

مثال 1

{
  "disableMenuItemSpecialInstructions": true
}

مثال 2

{
  "disableTipWidget": true,
  "disablePromoWidget": true
}

مثال 3

{
  "menuItemSpecialInstructionsMaxLength": 250,
  "orderInstructionsMaxLength": 1000
}

Enums

روز هفته

نوع DayOfWeek دارای مقادیر ممکن زیر است:

  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
  • SUNDAY

نوع سرویس

نوع ServiceType دارای مقادیر ممکن زیر است:

  • DELIVERY
  • TAKEOUT

نوع سفارش

نوع OrderType مقادیر ممکن زیر را دارد:

  • ASAP
  • ADVANCE

نوع پاها

نوع FeeType مقادیر ممکن زیر را دارد:

  • DELIVERY
  • SERVICE

گزینه

Type OptionType دارای مقادیر ممکن زیر است:

  • SIZE
  • OPTION
  • PIZZA_SIDE

پیتزا

نوع PizzaSide مقادیر ممکن زیر را دارد:

  • PIZZA_SIDE_LEFT
  • PIZZA_SIDE_RIGHT
  • PIZZA_SIDE_WHOLE

نوع حساسیت

نوع آلرژن در هر GS1: AllergentyPecode .

نوع AllergenType مقادیر ممکن زیر را دارد:

  • ALMONDS
  • ALPHA_ISOMETHYL_IONONE
  • ALCOHOL
  • AMYL_CINNAMAL
  • ANISE_ALCOHOL
  • BARLEY
  • BENZYL_ALCOHOL
  • BENZYL_BENZOATE
  • BENZYL_CINNAMATE
  • BENZYL_SALICYLATE
  • BRAZIL_NUTS
  • BUTYLPHENYL_METHYLPROPIONATE
  • CARROTS
  • CASHEW_NUTS
  • CELERY
  • CEREALS_CONTAINING_GLUTEN
  • CINNAMAL
  • CINNAMYL_ALCOHOL
  • CITRAL
  • CITRONELLOL
  • COCOA
  • CORIANDER
  • CORN
  • COUMARIN
  • CRUSTACEANS
  • EGGS
  • EUGENOL
  • EVERNIA_FURFURACEA
  • EVERNIA_PRUNASTRI
  • FARNESOL
  • FISH
  • GERANIOL
  • GLUTEN
  • HAZELNUTS
  • HEXYL_CINNAMAL
  • HYDROXYCITRONELLAL
  • HYDROXYISOHEXYL_3_CYCLOHEXENE_CARBOXALDEHYDE_ISOEUGENOL_LIMONENE_LINAL
  • KAMUT
  • LACTOSE
  • LUPINE
  • MACADAMIA_NUTS
  • METHYL_2_OCTYNOATE
  • MILK
  • MOLLUSCS
  • MUSTARD
  • NO_DECLARED_ALLERGENS
  • OAT
  • PEANUTS
  • PEAS
  • PECAN_NUTS
  • PISTACHIOS
  • POD_FRUITS
  • QUEENSLAND_NUTS
  • RYE
  • SESAME_SEEDS
  • SOYBEANS
  • SPELT
  • SULPHUR_DIOXIDE
  • TREE_NUTS
  • TREE_NUT_TRACES
  • WALNUTS
  • WHEAT

سطح مهار

نوع ContainmentLevel مقادیر ممکن زیر را دارد:

  • CONTAINS
  • FREE_FROM
  • MAY_CONTAIN

کد سپرده

نوع DepositCode مقادیر ممکن زیر را دارد:

  • REUSABLE
  • RECYCLABLE

نوع معامله

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

نوع DealType مقادیر ممکن زیر را دارد:

  • CART_OFF
  • DELIVERY_OFF

محدود

نوع رژیمهای غذایی محدود در هر طرح .

نوع RestrictedDiet مقادیر ممکن زیر را دارد:

  • DIABETIC
  • GLUTEN_FREE
  • HALAL
  • HINDU
  • KOSHER
  • LOW_CALORIE
  • LOW_FAT
  • LOW_LACTOSE
  • LOW_SALT
  • VEGAN
  • VEGETARIAN