Package google.maps.booking.v1alpha

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

repeat_every

ExtendedServiceAvailability

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

مثال: یک در دسترس بودن با مدت زمان ۲۰ دقیقه، تکرار هر بار ۳۰ دقیقه، زمان شروع ۹:۰۰ صبح و تکرار تا ساعت ۱۱:۰۰ صبح، زمان‌های ۹-۹:۲۰ صبح، ۹:۳۰-۹:۵۰ صبح، ۱۰-۱۰:۲۰ صبح، ۱۰:۳۰-۱۰:۵۰ صبح، ۱۱-۱۱:۲۰ صبح را نشان می‌دهد. (الزامی)

استثنای زمانبندی

پیام‌های ScheduleException نشان‌دهنده محدوده‌های زمانی رزرو شده/غیرقابل دسترس در روز کاری هستند که استثناهایی برای تکرار شرح داده شده در بالا محسوب می‌شوند. با رزرو شدن بازه‌های زمانی، لیست استثناها باید به‌روزرسانی شود تا محدوده‌های زمانی جدید غیرقابل دسترس را منعکس کند. خود تکرار نباید تغییر کند.

فیلدها

فیلدها
`time_range`	`TimeRange` محدوده زمانی استثنا. هر بازه زمانی که توسط تکرار توصیف شده و با این محدوده زمانی بسته-باز همپوشانی داشته باشد، غیرقابل دسترس در نظر گرفته خواهد شد. مثال: اگر تابع تکرار مدت زمان ۲۰ دقیقه، repeat_every به مدت ۳۰ دقیقه، start_time به مدت ۹:۰۰ صبح و repeat_until به مدت ۱۱:۰۰ صبح را مشخص کند، آنگاه یک ScheduleException با محدوده زمانی ۹:۴۵ صبح تا ۱۱:۰۰ صبح، اسلات‌های ۹:۳۰ تا ۹:۵۰ صبح، ۱۰ تا ۱۰:۲۰ صبح و ۱۰:۳۰ تا ۱۰:۵۰ صبح را از دسترس خارج می‌کند. توجه داشته باشید که از آنجا که محدوده زمانی بسته-باز است، بازه زمانی شروع شده از ساعت ۱۱ صبح تحت تأثیر قرار نمی‌گیرد.

time_range

TimeRange

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

مثال: اگر تابع تکرار مدت زمان ۲۰ دقیقه، repeat_every به مدت ۳۰ دقیقه، start_time به مدت ۹:۰۰ صبح و repeat_until به مدت ۱۱:۰۰ صبح را مشخص کند، آنگاه یک ScheduleException با محدوده زمانی ۹:۴۵ صبح تا ۱۱:۰۰ صبح، اسلات‌های ۹:۳۰ تا ۹:۵۰ صبح، ۱۰ تا ۱۰:۲۰ صبح و ۱۰:۳۰ تا ۱۰:۵۰ صبح را از دسترس خارج می‌کند.

توجه داشته باشید که از آنجا که محدوده زمانی بسته-باز است، بازه زمانی شروع شده از ساعت ۱۱ صبح تحت تأثیر قرار نمی‌گیرد.

لغو قوانین زمانبندی

قوانین زمان‌بندی سطح دسترسی

فیلدها

فیلدها
`last_bookable_sec`	`int64` آخرین زمانی (به ثانیه) که این اسلات می‌تواند رزرو شود. این مهر زمانی باید قبل از شروع_ثانیه اسلات باشد تا رعایت شود (اگر کاربران باید بتوانند پس از زمان شروع رزرو کنند، از سطح سرویس SchedulingRules.min_booking_before_end_time استفاده کنید). در صورت وجود، هر چیزی که در min_booking_buffer از SchedulingRules سرویس مربوطه مشخص شده است را لغو می‌کند.
`first_bookable_sec`	`int64` اولین باری (به ثانیه) که این اسلات می‌تواند رزرو شود. این مهر زمانی باید قبل از start_sec اسلات یا در صورت مشخص شدن last_bookable_sec باشد.
`last_online_cancellable_sec`	`int64` در صورت تنظیم، آخرین باری (به ثانیه از زمان عصر یونیکس) که این بازه زمانی خاص از طریق رزرو با گوگل قابل لغو است. این فیلد هرگونه قانون لغو در سطح سرویس را لغو می‌کند. (اختیاری)

last_bookable_sec

int64

آخرین زمانی (به ثانیه) که این اسلات می‌تواند رزرو شود. این مهر زمانی باید قبل از شروع_ثانیه اسلات باشد تا رعایت شود (اگر کاربران باید بتوانند پس از زمان شروع رزرو کنند، از سطح سرویس SchedulingRules.min_booking_before_end_time استفاده کنید). در صورت وجود، هر چیزی که در min_booking_buffer از SchedulingRules سرویس مربوطه مشخص شده است را لغو می‌کند.

first_bookable_sec

int64

اولین باری (به ثانیه) که این اسلات می‌تواند رزرو شود. این مهر زمانی باید قبل از start_sec اسلات یا در صورت مشخص شدن last_bookable_sec باشد.

last_online_cancellable_sec

int64

در صورت تنظیم، آخرین باری (به ثانیه از زمان عصر یونیکس) که این بازه زمانی خاص از طریق رزرو با گوگل قابل لغو است. این فیلد هرگونه قانون لغو در سطح سرویس را لغو می‌کند. (اختیاری)

درخواست حذف دسته‌ای رکوردهای عمومی

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

فیلدها

فیلدها
`parent`	`string` نام منبع، که قالب آن به صورت - `partners/{partner_id}/feeds/{feed_name}` است.
`records[]`	`GenericDeleteRecord` رکوردهایی که باید حذف شوند. حداکثر ۱۰۰۰ رکورد در یک فراخوانی API مجاز است.

parent

string

نام منبع، که قالب آن به صورت - partners/{partner_id}/feeds/{feed_name} است.

records[]

GenericDeleteRecord

رکوردهایی که باید حذف شوند. حداکثر ۱۰۰۰ رکورد در یک فراخوانی API مجاز است.

درخواست رکورد عمومی BatchPush

درخواست دسته‌ای برای درج و/یا به‌روزرسانی رکوردهایی از نوع فید که در آدرس اینترنتی درخواست مشخص شده است.

فیلدها

فیلدها
`parent`	`string` نام منبع، که قالب آن به صورت - `partners/{partner_id}/feeds/{feed_name}` است.
`records[]`	`GenericRecord` رکوردهایی که باید درج و/یا به‌روزرسانی شوند. حداکثر ۱۰۰۰ رکورد در یک فراخوانی API مجاز است.

parent

string

نام منبع، که قالب آن به صورت - partners/{partner_id}/feeds/{feed_name} است.

records[]

GenericRecord

رکوردهایی که باید درج و/یا به‌روزرسانی شوند. حداکثر ۱۰۰۰ رکورد در یک فراخوانی API مجاز است.

درخواست دسترسی به سرویس جایگزینی دسته‌ای

درخواست دسته‌ای برای جایگزینی چندین بازه زمانی در دسترس بودن Service .

فیلدها

فیلدها
`parent`	`string` قالب `partners/{partner_id}` .
`extended_service_availability[]`	`ExtendedServiceAvailability` دسترسی‌پذیری سرویس توسعه‌یافته‌ای که برای جایگزینی اسلات‌های دسترسی‌پذیری موجود استفاده می‌شود.

parent

string

قالب partners/{partner_id} .

extended_service_availability[]

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

پاسخ در دسترس بودن سرویس و جایگزینی دسته‌ای

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

فیلدها

فیلدها
`extended_service_availability[]`	`ExtendedServiceAvailability` پیام‌های مربوط به به‌روزرسانی موفقیت‌آمیز دسترسی به خدمات گسترده که برای جایگزینی اسلات‌های دسترسی موجود استفاده شدند.

extended_service_availability[]

ExtendedServiceAvailability

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

رزرو

رزرو برای یک جایگاه موجودی

فیلدها
`name`	`string` نام منبع رزرو: `partners/{partner ID}/bookings/{booking ID}`
`merchant_id`	`string` شناسه فروشنده برای اسلات
`service_id`	`string` شناسه سرویس فروشنده
`start_time`	`Timestamp` زمان شروع قرار ملاقات
`duration`	`Duration` مدت زمان قرار ملاقات
`client_information`	`ClientInformation` اطلاعات شخصی مشتری که قرار ملاقات را تعیین می‌کند
`status`	`BookingStatus` وضعیت رزرو
`payment_information`	`PaymentInformation` اطلاعات مربوط به تراکنش‌های پرداخت مربوط به رزرو.
`party_size`	`int64` تعداد نفرات رزرو شده

رزرو ناموفق

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

فیلدها
`cause`	`Cause` دلیل عدم موفقیت رزرو (الزامی)
`rejected_card_type`	`CreditCardType` (فقط در صورتی که علت PAYMENT_ERROR_CARD_TYPE_REJECTED باشد، الزامی است)
`description`	`string` این فیلد اختیاری برای شریک استفاده می‌شود تا اطلاعات اضافی را فقط برای اهداف اشکال‌زدایی درج کند. (اختیاری)
`payment_failure`	`PaymentFailureInformation` اطلاعات مربوط به شکست پرداخت‌ها

علت

برشمردن علل شکست.

انوم‌ها
`CAUSE_UNSPECIFIED`	مقدار پیش‌فرض: استفاده نشود؛ به معنای «خطای ناشناخته» است
`SLOT_UNAVAILABLE`	جایگاه مورد نظر دیگر در دسترس نیست.
`SLOT_ALREADY_BOOKED_BY_USER`	کاربر قبلاً برای بازه زمانی مورد نظر وقت ملاقات رزرو کرده است.
`LEASE_EXPIRED`	اجاره نامه (در صورت وجود) منقضی شده است و دیگر نمی‌توان از آن برای تکمیل رزرو درخواستی استفاده کرد.
`OUTSIDE_CANCELLATION_WINDOW`	لغو درخواستی به دلیل محدودیت‌های زمانی در سیاست لغو سفارش فروشنده، در حال حاضر قابل انجام نیست.
`PAYMENT_ERROR_CARD_TYPE_REJECTED`	هنگام پردازش پرداخت خطایی رخ داد زیرا نوع کارت اعتباری ارائه شده توسط فروشنده پذیرفته نشد. نوع کارت اعتباری باید در قسمت reject_card_type وارد شود.
`PAYMENT_ERROR_CARD_DECLINED`	هنگام پردازش پرداخت خطایی رخ داد زیرا کارت اعتباری ارائه شده رد شد.
`PAYMENT_OPTION_NOT_VALID`	خطایی در بسته/عضویت مورد استفاده برای پرداخت هزینه رزرو رخ داده است. ممکن است هیچ استفاده معتبری باقی نمانده باشد، ممکن است منقضی شده باشد و غیره.
`PAYMENT_ERROR`	هنگام پردازش پرداخت این رزرو، خطایی رخ داد. از این مقدار برای نشان دادن یک خطای کلی مربوط به پرداخت استفاده کنید، تنها در صورتی که خطا با خطای پرداخت خاص فوق مطابقت نداشته باشد.
`USER_CANNOT_USE_PAYMENT_OPTION`	کاربر نمی‌تواند از گزینه پرداخت داده شده استفاده کند (مثلاً کاربری که سعی می‌کند از قیمت بار اول برای بار دوم استفاده کند).
`BOOKING_ALREADY_CANCELLED`	رزروی که کاربر سعی در لغو آن داشته، قبلاً لغو شده است.
`BOOKING_NOT_CANCELLABLE`	رزروی که کاربر سعی در لغو آن داشته است، قابل لغو نیست.
`OVERLAPPING_RESERVATION`	کاربر رزرو فعلی‌اش خیلی به این زمان نزدیک است.
`USER_OVER_BOOKING_LIMIT`	رزرو به دلیل تجاوز کاربر از محدودیت رزرو به ازای هر کاربر توسط تجمیع‌کننده، ناموفق بود.
`PAYMENT_REQUIRES_3DS1`	تنظیم کنید که چه زمانی پرداخت رد می‌شود زیرا شما درخواست می‌کنید که تراکنش دوباره امتحان شود، اما این بار پس از انجام چالش/پاسخ 3DS1. توجه داشته باشید که وضعیت شکست تراکنش فعلی همچنان ناموفق خواهد ماند. تلاش مجدد کاملاً جداگانه خواهد بود. وقتی این دلیل شکست باشد، payment_failure.3DS1_parameters باید تنظیم شود. اگر اینطور نباشد، با علت فعلی مانند PAYMENT_ERROR رفتار خواهد شد.

اطلاعات شکست پرداخت

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

فیلدها

فیلدها
`threeds1_parameters`	`ThreeDS1Parameters` پارامترهایی که توسط یک تجمیع‌کننده RwG برای شروع پروتکل احراز هویت 3DS1 با کاربر استفاده می‌شود. مگر اینکه BookingFailure.cause روی PAYMENT_REQUIRES_3DS1 تنظیم شده باشد، نادیده گرفته می‌شوند.

threeds1_parameters

ThreeDS1Parameters

پارامترهایی که توسط یک تجمیع‌کننده RwG برای شروع پروتکل احراز هویت 3DS1 با کاربر استفاده می‌شود. مگر اینکه BookingFailure.cause روی PAYMENT_REQUIRES_3DS1 تنظیم شده باشد، نادیده گرفته می‌شوند.

پارامترهای ThreeDS1

پارامترهایی که درخواست می‌کنند RwG یک چالش 3DS1 را انجام دهد.

پارامترها توسط توضیحات EMVCo از پروتکل 3DS1 تنظیم شده‌اند.

فیلدها
`acs_url`	`string` آدرس اینترنتی (URL) که از طریق آن فرمی برای ارائه به کاربر جهت احراز هویت بارگذاری می‌شود.
`pa_req`	`string` درخواست احراز هویت پرداخت. در صورت ارائه، باید به فرم ACSUrl ارسال شود.
`transaction_id`	`string` شناسه‌ای که توسط ارائه‌دهنده ACS استفاده می‌شود. در صورت ارائه، باید به فرم ACSUrl ارسال شود.
`md_merchant_data`	`string` اطلاعات فروشنده. در صورت ارائه، در فرم ACSUrl ارسال شود.

وضعیت رزرو

انوم‌ها
`BOOKING_STATUS_UNSPECIFIED`	مشخص نشده است.
`CONFIRMED`	رزرو قطعی شد
`PENDING_MERCHANT_CONFIRMATION`	رزرو قبل از اینکه به وضعیت تأیید شده (CONFIRMED) تغییر کند، منتظر تأیید فروشنده است (این وضعیت در حال حاضر پشتیبانی نمی‌شود)
`PENDING_CLIENT_CONFIRMATION`	رزرو قبل از اینکه به وضعیت تأیید شده (CONFIRMED) تغییر کند، منتظر تأیید مشتری است (این وضعیت در حال حاضر پشتیبانی نمی‌شود)
`CANCELED`	رزرو از طرف کاربر لغو شده است.
`NO_SHOW`	مشتری برای قرار ملاقات حاضر نشد
`NO_SHOW_PENALIZED`	مشتری برخلاف سیاست لغو وقت، در قرار ملاقات حاضر نشد.
`FAILED`	به دلیل اختلال در پردازش، رزرو انجام نشد.
`DECLINED_BY_MERCHANT`	رزرو به صورت ناهمزمان توسط فروشنده رد شد.

کال مرچنت

این نوع هیچ فیلدی ندارد.

پیام خالی برای استفاده در UnsupportedPartySizeOption، تنظیم این گزینه به کاربران امکان می‌دهد تا برای رزرو با کسب و کار تماس بگیرند.

سیاست لغو

سیاست لغو یک سرویس.

فیلدها

فیلدها
`refund_condition[]`	`RefundCondition` شرایط بازپرداخت صفر یا بیشتر که در این سیاست اعمال می‌شود.

refund_condition[]

RefundCondition

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

شرایط بازپرداخت

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

فیلدها

فیلدها
`min_duration_before_start_time`	`Duration` مدت زمان قبل از زمان شروع، تا زمانی که مشتری بتواند بخشی از هزینه خدمات مشخص شده در `refund_percent` را بازپرداخت دریافت کند. وقتی روی 0 (پیش‌فرض) تنظیم شود، سرویس می‌تواند در هر زمانی لغو شود.
`refund_percent`	`uint32` درصدی که می‌توان وجه آن را بازپرداخت کرد، به شرطی که رزرو سرویس حداقل `min_duration_before_start_time` قبل از زمان شروع سرویس لغو شود، در محدوده [0، 100]. وقتی روی 0 (پیش‌فرض) تنظیم شود، سرویس قابل استرداد نیست. وقتی روی 100 تنظیم شود، این سرویس به طور کامل قابل استرداد است.

min_duration_before_start_time

مدت زمان قبل از زمان شروع، تا زمانی که مشتری بتواند بخشی از هزینه خدمات مشخص شده در refund_percent را بازپرداخت دریافت کند. وقتی روی 0 (پیش‌فرض) تنظیم شود، سرویس می‌تواند در هر زمانی لغو شود.

refund_percent

uint32

درصدی که می‌توان وجه آن را بازپرداخت کرد، به شرطی که رزرو سرویس حداقل min_duration_before_start_time قبل از زمان شروع سرویس لغو شود، در محدوده [0، 100]. وقتی روی 0 (پیش‌فرض) تنظیم شود، سرویس قابل استرداد نیست. وقتی روی 100 تنظیم شود، این سرویس به طور کامل قابل استرداد است.

اطلاعات مشتری

اطلاعات شخصی در مورد شخصی که رزرو انجام می‌دهد

فیلدها
`given_name`	`string` نام داده شده مشتری
`family_name`	`string` نام خانوادگی موکل
`address`	`PostalAddress` آدرس مشتری
`telephone`	`string` شماره تلفن مشتری
`email`	`string` آدرس ایمیل مشتری

درخواست لینک حساب کاربری ایجاد تبلیغات

درخواست پیام برای AdsAccountLinkingService.CreateAdsAccountLink.

فیلدها

فیلدها
`parent`	`string` الزامی. منبع والد که لینک این حساب تبلیغات در آن ایجاد خواهد شد. این همان شناسه حساب مرکز شرکا است. فرمت: partners/{partner}
`ads_account_link_id`	`string` الزامی. شناسه‌ای که برای لینک حساب تبلیغات استفاده می‌شود. این همان شناسه مشتری تبلیغات گوگل است. برای جزئیات بیشتر به https://support.google.com/google-ads/answer/1704344 مراجعه کنید. فرمت: xxx-xxx-xxxx.
`ads_account_link`	`AdsAccountLink` الزامی. لینک حساب تبلیغات (AdsAccountLink) که باید ایجاد شود.

parent

string

الزامی. منبع والد که لینک این حساب تبلیغات در آن ایجاد خواهد شد. این همان شناسه حساب مرکز شرکا است. فرمت: partners/{partner}

ads_account_link_id

string

الزامی. شناسه‌ای که برای لینک حساب تبلیغات استفاده می‌شود. این همان شناسه مشتری تبلیغات گوگل است. برای جزئیات بیشتر به https://support.google.com/google-ads/answer/1704344 مراجعه کنید. فرمت: xxx-xxx-xxxx.

ads_account_link

AdsAccountLink

الزامی. لینک حساب تبلیغات (AdsAccountLink) که باید ایجاد شود.

درخواست ایجاد فروشنده

درخواست ایجاد یک Merchant .

فیلدها

parent

string

نام منبع والد برای شریکی که مالک این فروشگاه است، در قالب partners/{partner_id} .

merchant_id

string

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

merchant

Merchant

تاجر برای ایجاد.

درخواست ایجاد سرویس

درخواست ایجاد یک Service جدید.

فیلدها

parent

string

نام منبع والد برای فروشنده‌ای که مالک این سرویس است، در قالب partners/{partner_id}/merchants/{merchant_id} .

service_id

string

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

service

Service

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

محدودیت‌های کارت اعتباری

محدودیت‌های مربوط به انواع کارت‌های اعتباری که این فروشنده می‌پذیرد.

فیلدها

credit_card_type[]

CreditCardType

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

نوع کارت اعتباری

یک نوع کارت اعتباری.

انوم‌ها
`CREDIT_CARD_TYPE_UNSPECIFIED`	استفاده نشده.
`VISA`	یک کارت اعتباری ویزا.
`MASTERCARD`	یک کارت اعتباری مسترکارت.
`AMERICAN_EXPRESS`	یک کارت اعتباری امریکن اکسپرس.
`DISCOVER`	یک کارت اعتباری دیسکاور.
`JCB`	یک کارت اعتباری جی سی بی.

درخواست حذف تبلیغات حساب کاربری

درخواست پیام برای AdsAccountLinkingService.DeleteAdsAccountLink.

فیلدها

name

string

الزامی. نام لینک تبلیغات حساب کاربری که قرار است حذف شود. فرمت: partners/{partner}/adsAccountLinks/{ads_account_link}

درخواست حذف فروشنده

درخواست حذف یک Merchant .

فیلدها

name

string

نام منبع فروشنده‌ای که قرار است حذف شود. در قالب partners/{partner_id}/merchants/{merchant_id}

درخواست حذف سرویس

درخواست حذف یک Service .

فیلدها

name

string

نام منبع سرویسی که قرار است حذف شود. در قالب partners/{partner_id}/merchants/{merchant_id}/services/{service_id}

واریز

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

فیلدها

deposit

مبلغ سپرده.

min_advance_cancellation_sec

int64

حداقل مبلغ پیش پرداخت برای لغو رزرو

deposit_type

PriceType

نحوه تعیین سپرده از موجودی را تعریف می‌کند.

پرداخت مستقیم مرچنت

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

فیلدها

payment_methods[]

Text

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

محدوده مدت زمان

یک پوشش برای بازه زمانی که می‌تواند محدود یا نامحدود باشد. حداقل یکی از مدت زمان‌های min_duration و max_duration مورد نیاز است.

فیلدها

min_duration

حداقل مدت زمان.

max_duration

حداکثر مدت زمان.

اپراتور اقتصادی

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

فیلدها

text

Text

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

دسترسی‌پذیری گسترده به سرویس

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

فیلدها
`merchant_id`	`string` این یک فیلد اجباری است که برای مشخص کردن اینکه پیام‌های مربوط به موجودی کالا مربوط به کدام فروشگاه است، لازم است.
`service_id`	`string` این یک فیلد اجباری است که برای مشخص کردن سرویسی که پیام‌های مربوط به در دسترس بودن زیر به آن تعلق دارند، لازم است.
`start_time_restrict`	`Timestamp` در صورت ارائه، موجودیت‌های Availability ارائه شده را به عنوان یک snapshot کامل از [start_time_restrict, end_time_restrict] در نظر خواهیم گرفت. یعنی، اگر شرط زیر برقرار باشد، تمام Availability های موجود حذف خواهند شد: `start_time_restrict <= availability.start_sec && availability.start_sec < end_time_restrict` اگر یک پیام مدت زمان تنظیم شود، شرط بیشتر محدود می‌شود: `availability.duration == duration_restrict` اگر پیام resources_restrict تنظیم شود، شرط بیشتر محدود می‌شود: `availability.resources.staff_id == resources_restrict.staff_id && availability.resources.room_id == resources_restrict.room_id` این فیلدها معمولاً برای ارائه به‌روزرسانی کامل در دسترس بودن در یک محدوده زمانی مشخص استفاده می‌شوند. تنظیم start_time_restrict در حالی که end_time_restrict بدون تنظیم باقی می‌ماند، به این معنی است که تمام زمان‌ها از start_time_restrict شروع می‌شوند.
`end_time_restrict`	`Timestamp` تنظیم end_time_restrict هنگام تنظیم نکردن start_time_restrict، به معنای تمام زمان‌ها تا end_time_restrict تفسیر می‌شود.
`duration_restrict`	`Duration` تنظیم مدت زمان، دامنه به‌روزرسانی را فقط به در دسترس بودن با مدت زمان منطبق محدود می‌کند.
`resources_restrict`	`Resources` تنظیم resources_restrict دامنه به‌روزرسانی را فقط به این مجموعه از منابع محدود می‌کند. همه فیلدهای id منابع باید دقیقاً مطابقت داشته باشند.
`availability[]`	`Availability` لیست جدید موجودی.

آمار فید

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

فیلدها

new_items

int64

Newly added items by this feed. Items can be merchants, services or availability slots, depending on the type of the feed.

existing_items

int64

Existing items, updated as needed from newer information from the feed.

deleted_items

int64

Items no longer present in this feed, and that were removed as a result.

FeedStatus

Status of a feed uploaded by the aggregator's platform.

Fields
`name`	`string` The feed resource name, which has the format of `partners/{partner_id}/feeds/merchants/{file_name}` `partners/{partner_id}/feeds/services/{file_name}` `partners/{partner_id}/feeds/availability/{file_name}`
`state`	`State` The processing state of this feed.
`error_details`	`string` Human readable string providing more details if we failed to process this feed.
`statistics`	`FeedStatistics` Statistics specific to this feed.

ایالت

Enum to indicate the processing state of a feed.

انوم‌ها
`STATE_UNSPECIFIED`	Default value. Unused.
`IN_PROGRESS`	The feed is still being processed.
`SUCCESS`	The feed has been successfully processed.
`FAILURE`	We encountered an error while processing the feed.

FoodOrderingMetadata

Metadata for food ordering action links.

Fields
`fee_details[]`	`FeeDetails` Details of fees charged to the user on top of the item total. Repeated for different types of fees like service fee, delivery fee etc.
`advance_order_details`	`AdvanceOrderDetails` Details on advanced ordering support also known as order ahead where user can place an order for fulfillment at a later time than right now.
Union field `fulfillment_duration_options` . Order fulfillment time duration from order confirmation. For delivery orders, time duration until the food is delivered. For pickup orders, time duration until the food is ready for pickup. `fulfillment_duration_options` can be only one of the following:
`fulfillment_lead_time_duration`	`Duration` Fixed duration. For example: 30 mins.
`fulfillment_lead_time_duration_range`	`DurationRange` A range of duration. Examples: * 30 mins to 45 mins * Greater than 30 mins * Less than 50 mins

AdvanceOrderDetails

For order ahead support.

Fields

is_supported

bool

True if Advance Orders, also known as Order Ahead, is supported. (required)

FeeDetails

Fee details.

Fields

type

FeeType

Fee type. (required)

fee_amount

FeeAmount

Fee amount either in unit currency, a percentage of the cart value, or a combination of both. (required)

FeeAmount

FeeAmount examples: * Fixed fee: USD 0 (no fee), USD 1.5 * Range of fixed fee: USD 1.0 (minimum), USD 3.0 (maximum), USD 5.0-6.0 * Percentage of cart size: 15.5%, 10%-20%, 10% (minimum), 15% (maximum) * Compound of range and percentage: 25.5% & USD 2.5 (minimum), 25.5% & USD 4.5 (maximum), 10% & USD 1.5-2.5, 10.5%-20% & USD 2.5-3.5

Fields
`cart_percentage`	`QuantitativeValue` Fee in terms of a percentage of the cart value. Supports a range (bounded and unbounded) or a fixed percentage. Value should be between 0 and 100. Examples: * Fixed 5.5% * At least 5.5% * At most 5.5% * 4.5% to 5.5%
Union field `amount_options` . Options to specify monetary amount. `amount_options` can be only one of the following:
`amount`	`Money` Fixed amount. For example USD 3.5.
`amount_range`	`MoneyRange` Range of amount. Examples: * USD 3.5 to USD 5.5 * At least USD 3.5 * At most USD 5.5
`amount_unknown`	`bool` Unknown amount.

FeeType

Fee type.

انوم‌ها
`FEE_TYPE_UNSPECIFIED`	Fee type unspecified.
`DELIVERY`	For delivery fees.
`SERVICE`	For service fees.

FulfillmentOption

The fulfillment option for an order online action link.

Fields
`fulfillment_type`	`FulfillmentType` Required. The fulfillment type.
`available_day[]`	`AvailableDay` Required. A list of days on which there is availability for this fulfillment method (preferably at least 2).
`fee_details`	`FeeDetails` Required. Fee details for the fulfillment method.
`minimum_order`	`Price` Required. Minimum order for the fulfillment method associated with the action link.

AvailableDay

Day level availability.

Fields

fulfillment_date

Date

Required. An available date for a fulfillment method. Assumed to be in merchant's timezone.

last_ordering_time

Required. Unix timestamp. The last time a user could order, and receive items by fulfillment_date . In other words, after last_ordering_time, fulfillment_date will no longer be shown as available.

For example, if the fulfillment_date is 2020-08-10: - a last_ordering_time value of 2020-08-10 18:00 means that, in order to receive their order on 2020-08-10, a customer must make that order by 6pm that same day. - a last_ordering_time value of 2020-08-08 20:00 means that, in order to receive their order on 2020-08-10, a customer must make that order by 8pm two days prior.

FeeDetails

Fee details for the fulfillment method associated with the action link.

Fields
Union field `fee_details` . Fee model for the fulfillment method. `fee_details` can be only one of the following:
`no_fee`	`NoFee` No fee for the fulfillment method.
`base_fee`	`MinimumFee` The base fee associated with the fulfillment method.
`fixed_fee`	`FixedFee` The fixed fee associated with the fulfillment method.

FixedFee

The fixed fee required for the fulfillment method associated with the action link.

Fields

amount

Required. The amount of the fixed fee for the fulfillment method.

FulfillmentType

The fulfillment type associated with an action link.

انوم‌ها
`FULFILLMENT_TYPE_UNSPECIFIED`	The fulfillment type is unspecified.
`FULFILLMENT_TYPE_DELIVERY`	The fulfillment type is delivery.
`FULFILLMENT_TYPE_PICKUP`	The fulfillment type is pickup.

MinimumFee

The minimum fee required for the fulfillment method associated with the action link.

Fields

base_fee_amount

Required. The base fee amount for the fulfillment method.

NoFee

This type has no fields.

No fee required for the fulfillment method associated with the action link.

GenericDeleteRecord

Record to be deleted of the feed type mentioned in url request.

Fields
`delete_time`	`Timestamp` Required. This timestamp is used to determine the order in which a delete will be applied to the inventory.
Union field `record_type` . Encapsulate different types of feed (ndjson, proto-based, etc.) Partner can provide a full record similar to how a record is provided in a feed or BatchPush API. Partners also have the option to include only the essential fields of a record required to uniquely identify it. `record_type` can be only one of the following:
`data_record`	`bytes` For non-proto based feeds.
`proto_record`	`Any` For proto-based feeds.

GenericRecord

Record of the feed type mentioned in url request.

Fields
`generation_timestamp`	`Timestamp` Required. This timestamp is used to to ensure correct ordering of inventory updates.
Union field `record_type` . Encapsulate different types of feed (ndjson, proto-based, etc.) `record_type` can be only one of the following:
`data_record`	`bytes` For non-proto based feeds.
`proto_record`	`Any` For proto-based feeds.

GeoCoordinates

The Geo data of a location, including latitude, longitude, and address.

Fields
`latitude`	`double` Latitude in degrees. (optional)
`longitude`	`double` Longitude in degrees. (optional)
Union field `addresses` . Address for a location, could either be structured or unstructured. `addresses` can be only one of the following:
`address`	`PostalAddress` Postal address of the location, preferred.
`unstructured_address`	`string` An unstructured address could also be provided as a fallback. Eg "1600 amphitheatre parkway mountain view, ca 94043"

GetAdsAccountLinkRequest

Request message for AdsAccountLinkingService.GetAdsAccountLink.

Fields

name

string

Required. The name of the Ads account link to retrieve. Format: partners/{partner}/adsAccountLinks/{ads_account_link}

GetMerchantStatusRequest

The request to get a MerchantStatus

Fields

name

string

Required. Resource name, in the format of partners/{partner_id}/merchants/{merchant_id}/status.

GetStatusRequest

The request to retrieve the Status for a specific feed uploaded by the aggregator's platform.

Fields

name

string

The feed resource name, which has the format of

partners/{partner_id}/feeds/merchants/{file_name}
partners/{partner_id}/feeds/services/{file_name}
partners/{partner_id}/feeds/availability/{file_name}

HomeServiceData

Additional information required to be provided for home service vertical.

Fields

category_type

string

The high level category to which this home service belongs to. Eg plumber, electrician etc.

job_type

string

The job type under the category to which the given home service belongs to. Eg unclog_drain, install_faucet are the job types under plumber category.

IntegrationType

Depth of integration supported.

انوم‌ها
`INTEGRATION_TYPE_UNSPECIFIED`	Defaults to END_TO_END.
`INTEGRATION_TYPE_END_TO_END`	Complete integration that allows end to end booking through Google.
`INTEGRATION_TYPE_INVENTORY_ONLY`	Booking server doesn't need to support this service. Only merchants, services, and (optionally) availability data need to be sent.

InvalidateResourceRequest

Request to invalidate a resource.

Fields

resource_id

string

The name of the resource to be invalidated.

For example, for a Pickup resource, name should have the format of partners/{partner_id}/pickups/{pickup_id} . Implementations MUST remove cached versions of the identified resource.

LineItem

A single item in an order--the booking of a single service in a single time slot.

Fields
`service_id`	`string` ID of the merchant Service.
`start_sec`	`int64` Start time of the appointment slot in seconds of UTC time since Unix epoch.
`duration_sec`	`int64` Duration of the appointment slot in seconds.
`tickets[]`	`OrderedTickets` Number of tickets ordered by Ticket Type.
`price`	`Price` The total price (excluding taxes) of this Line Item.
`status`	`BookingStatus` Status of the Line Item.

OrderedTickets

Number of ordered tickets by Ticket Type.

Fields

ticket_id

string

ID of a Ticket Type.

count

int32

Number of tickets ordered for this type.

LinkoutTemplate

A template specifying how Google should generate URLs to a partner's site.

Fields

uri_template

string

The uri template must follow the RFC 6570, see https://datatracker.ietf.org/doc/html/rfc6570 . Supports Level 1 templates and all Level 4 composite templates. eg http://example.com/book/{foo}?b={bar } * foo = 2 * bar = abc https://example.com/book/2?b=abc

ListMerchantStatusesRequest

The request to get a list of MerchantStatus

Fields
`parent`	`string` Required. The parent, which owns this collection of merchant status. Format: `partners/{partner_id}/merchants`
`page_size`	`int32` Required. The maximum number of items to return. Note that the server may reduce the page size.
`page_token`	`string` Optional. The nextPageToken value returned from a previous ListMerchantStatusResponse, if any.
`booking_inventory_status_restrict`	`BookingInventoryStatus` Optional. Optional restriction to filter results by booking inventory status.
`waitlist_inventory_status_restrict`	`WaitlistInventoryStatus` Optional. Optional restriction to filter results by waitlist inventory status.
`geo_match_restrict`	`GeoMatchingStatus` Optional. Optional restriction to filter results by Geo matching status.

BookingInventoryStatus

End-to-end booking inventory status.

انوم‌ها
`BOOKING_INVENTORY_STATUS_UNSPECIFIED`	Not specified.
`NO_VALID_FUTURE_INVENTORY`	Merchant doesn't have booking inventory in the next 30 day.
`HAS_VALID_FUTURE_INVENTORY`	Merchant has booking inventory in the next 30 day.

GeoMatchingStatus

Merchant geo matching status.

انوم‌ها
`GEO_MATCHING_STATUS_UNSPECIFIED`	Not specified.
`GEO_UNMATCHED`	Merchant is not geo matched.
`GEO_MATCHED`	Merchant is geo matched.

WaitlistInventoryStatus

End-to-end waitlist inventory status.

انوم‌ها
`WAITLIST_INVENTORY_STATUS_UNSPECIFIED`	Not specified.
`NO_VALID_WAITLIST_SERVICE`	Merchant doesn't have service supporting waitlist.
`HAS_VALID_WAITLIST_SERVICE`	Merchant has service supporting waitlist.

ListMerchantStatusesResponse

The response to list MerchantStatus .

Fields

merchant_statuses[]

MerchantStatus

List of merchant statuses that satisfy the filter conditions.

next_page_token

string

Token to retrieve the next page of results. There are no more results in the list if empty.

ListStatusRequest

The request to retrieve the Status for multiple feeds uploaded by the aggregator's platform.

Fields
`name`	`string` The feed resource name, which has the format of `partners/{partner_id}/feeds/merchants` `partners/{partner_id}/feeds/services` `partners/{partner_id}/feeds/availability`
`page_size`	`int32` The maximum number of items to return.
`page_token`	`string` The next_page_token value returned from a previous List request, if any.
`state_restrict`	`State` Optional restrict to filter results by feed state.
`time_range_restrict`	`TimeRange` Optional restrict to filter results by upper and lower bound. If start_time is unset, it will default to beginning of unix time. If end_time is unset, it will default to now.

ListStatusResponse

The request to retrieve the Status for multiple feeds uploaded by the aggregator's platform.

Fields

status[]

FeedStatus

Reverse chronological list of statuses for uploaded feeds. The maximum number of items returned is based on the page_size field in the request.

next_page_token

string

Token to retrieve the next page of results. There are no more results in the list if empty.

LocalizedString

Instance of a string in one locale.

Fields

locale

string

IETF BCP 47 language code, such as "en", "mas", "zh-Hant", "de-CH-1901". See http://www.w3.org/International/articles/language-tags/ .

value

string

Message in the locale above (UTF-8).

مکان

Geographic information about a location.

Fields
`place_id`	`string` The Place ID for a place in the Google Places database and on Google Maps. See https://developers.google.com/places/web-service/place-id for more about Place IDs. If this is provided, Google will match the location to this place.
`name`	`string` The location's name, telephone, url and geo are used to support matching the location with places already present on Google Maps. This field is optional, but may be required in some contexts. For example, a Service.location without a name will not be matched to a business entity, even if they are located at the same address. (optional)
`telephone`	`string` The public telephone number of the location including its country and area codes, eg +14567891234. (optional)
`url`	`string` The url of the location's public website. (optional)
`geo`	`GeoCoordinates` The Geo info of the location, including latitude, longitude, and address. (optional)
`location_type`	`LocationType` The type of the location, must be supplied if this location is provided for a Service.
`location_id`	`string` Unique reference of the location within the service. This id can be used to refer to this location in other service fields. Eg in the custom intake form, a set of location ids can be used to specify pick up location options. If set, this id should be unique within the same service. (optional)

LocationType

The type of this location.

انوم‌ها
`LOCATION_TYPE_UNSPECIFIED`	Location type unspecified.
`VISITED_LOCATION`	The location where this service visits.
`START_LOCATION`	The location where this service starts, also serves as MEETING_LOCATION.
`END_LOCATION`	The location where this service ends.

Merchant

Info about a merchant that is on the aggregator's platform.

Fields
`name`	`string` The merchant resource name, which has the format of `partners/{partner_id}/merchants/{merchant_id}` .
`merchant_name`	`string` The merchant_name, telephone, url and geo are used to support matching partner inventory with merchants already present on Google Maps. This information will not be displayed. The name of the merchant.
`telephone`	`string` The public telephone number of the merchant including its country and area codes, eg +14567891234.
`url`	`string` The url of the merchant's public website.
`geo`	`GeoCoordinates` The Geo info of the merchant, including latitude, longitude, and address.
`category`	`string` The category of the business in aggregator's platform.
`num_bookings_30d (deprecated)`	`int64` این کالا منسوخ شده است! This field is deprecated.
`tax_rate_basis_points (deprecated)`	`uint32` این کالا منسوخ شده است! The merchant's tax rate in basis points (one hundredth of one percent). For example, if the tax rate is 7.5%, this field should be set to 750. If this field is left unset or set to 0, the total price charged to a user for any service provided by this merchant is the exact price specified by Service.price. The service price is assumed to be exempt from or already inclusive of applicable taxes. Taxes will not be shown to the user as a separate line item. If this field is set to any nonzero value, the total price charged to a user for any service provided by this merchant will include the service price plus the tax assessed using the tax rate provided here. Fractions of the smallest currency unit (for example, fractions of one cent) will be rounded using nearest even rounding. Taxes will be shown to the user as a separate line item. This field is deprecated, please use tax_rate instead.
`tax_rate (deprecated)`	`TaxRate` این کالا منسوخ شده است! The merchant's tax rate. If present this field overrides the deprecated tax_rate_basis_points field. An empty message (ie tax_rate { }) will reset the applied tax rate to zero. Deprecated since E2E payments is no longer supported.
`payment_restrictions (deprecated)`	`PaymentRestrictions` این کالا منسوخ شده است! Restrictions to the payment methods this merchant accepts. We assume no restrictions exist if this field is not set. Deprecated since E2E payments is no longer supported.
`payment_option[] (deprecated)`	`PaymentOption` این کالا منسوخ شده است! Payment options available for this merchant. Services under this merchant will be able to individually limit the payment options they allow. Deprecated since E2E payments is no longer supported.
`payment_processor_config (deprecated)`	`PaymentProcessorConfig` این کالا منسوخ شده است! Configuration for a tokenized payment processor, if the merchant has support for it.
`tokenization_config (deprecated)`	`TokenizationConfig` این کالا منسوخ شده است! Configuration for a tokenized payment processor, if the merchant has support for it. Deprecated since E2E payments is no longer supported.
`terms`	`Terms` The specific merchant's Terms and Conditions displayed to the user when a service is being booked through Reserve with Google. In addition to these the aggregator partner's Terms and Conditions are always displayed to the user and must not be provided here.
`brand_id`	`string` An opaque string that identifies the consumer-facing brand to use when displaying partner attribution. This field allows partners with multiple consumer-facing brands to provide merchants for all brands within the same feed. A brand consists of consumer-facing properties like the name, logo, Terms of Service, and Privacy Policy. If there is only one consumer-facing partner brand, this field does not need to be set and can be ignored. If the partner... Does not have multiple consumer-facing brands? --> Ignore this field Has Multiple Brands that are configured? `If this field is set --> Associated consumer-facing brand attribution is used If this field is unset or the empty string --> Default consumer-facing brand attribution is used` Careful Note: most partners do not need to set this field. If a partner wishes to use this field, they must contact us first to configure separate brands, including the default brand.
`matching_hints`	`MerchantMatchingHints` Hints to help Google match a merchant to a place on Google Maps. Note: most partners do not need to set this field, as Google will match merchants to places on Google Maps using the information provided above. (optional)
`service_attribute[]`	`ServiceAttribute` Definitions for any service attributes used to describe the Services for this Merchant. (optional)
`action_link[]`	`ActionLink` Optional. An action URL with associated language, list of countries restricted to, type, and optional platform that indicates which platform this action should be performed on,
`reservation_linkout_template[]`	`LinkoutTemplate` Optional. The linkout template that specifies how Google should generate the partner's URL to reserve a table on their platform. Note that currently only the first one will be used if multiple are provided. The URI template has support for fields which will be populated based on the user's reservation selections, all required fields are needed to build a reservation URL successfully: * (required) party_size, int: The size of the party for which the user is requesting a reservation. * (required) selected_date_time, ISO 8601 datetime ( https://en.wikipedia.org/wiki/ISO_8601) : The time the user is requesting a reservation for. * (optional) merchant_id, string: The ID of the Merchant the user is requesting a reservation with, not needed if template already includes a merchant identifier. * (optional) room_id, string: The id of the room the user is requesting a reservation for.
`waitlist_advisement`	`Advisement` Optional. General advisements from a specific merchant for a user joining a waitlist through Reserve with Google. Individual text fields in the advisement should be limited to 100 bytes in length.
`economic_operator`	`EconomicOperator` Optional. Economic Operator information associated to this specific merchant needed for regulatory compliance. (optional)

MerchantMatchingHints

Hints used to help Google match a merchant to a place on Google Maps.

Fields

place_id

string

The Place ID for a place in the Google Places database and on Google Maps. See https://developers.google.com/places/web-service/place-id for more about Place IDs.

MerchantStatus

Status of a merchant in the Reserve with Google platform.

Fields
`name`	`string` The merchant status resource name, which has the format of `partners/{partner_id}/merchants/{merchant_id}/status`
`merchant_name`	`string` Name of the merchant provided by partners.
`input_geo_info`	`GeoCoordinates` Partners provided Geo info of the merchant.
`processing_status`	`ProcessingStatus` Merchant processing status.
`booking_status`	`BookingStatus` Status related to end-to-end booking integration.
`waitlist_status`	`WaitlistStatus` Status related to waitlist integration.
`geo_match`	`PlaceInfo` Matched Geo place of this merchant. Empty if the merchant is not Geo matched.
`local_services_match`	`LocalServicesMatchInfo` Local services match of this merchant. Empty if it is not a local service merchant or is not matched to any providers.
`direct_urls[]`	`DirectUrl` A list of URLs to demonstrate the content of the current merchant inventory. Note that it doesn't mean the inventory is actually being served and the URL may be different from the public visible ones.

BookingStatus

Status related to end-to-end booking integration.

Fields

has_valid_future_inventory

bool

True if the merchant has inventory in the next 30 day. Doesn't guarantee the merchant is actually served.

DirectUrl

URL that surfaces the merchant.

Fields

type

UrlType

Type of this URL.

url

string

URL that may surface this merchant.

UrlType

Type of the surfacing URL.

انوم‌ها
`URL_TYPE_UNSPECIFIED`	Not specified.
`BOOKING`	End-to-end booking URL.
`WAITLIST`	End-to-end waitlist URL.
`LOCAL_SERVICES`	Google Local Services URL.

LocalServicesMatchInfo

Information of the Google local services match (only set for local services merchant).

Fields

matched_providers[]

MatchedProvider

Matched service providers. A merchant can be matched to multiple service providers.

MatchedProvider

Local services provider.

Fields

customer_id

int64

Google local services external customer ID.

categories[]

string

Local service categories (verticals). Eg "plumber" and "carpet_cleaning".

PlaceInfo

Information of a matched place.

Fields

name

string

Name of the place.

formatted_address

string

Formatted address in local language.

place_id

string

Google Place ID of this place. Can be used to construct Google Maps URL or fetch more details of the place. See https://developers.google.com/places/web-service/place-id for example usage.

ProcessingStatus

Merchant processing status.

انوم‌ها
`PROCESSING_STATUS_UNSPECIFIED`	Status unspecified.
`IN_PROGRESS`	The merchant has been received by Madden, but is still being processed. Merchants in this status will not have other status populated.
`COMPLETED`	Other statuses of the merchant have been computed.

WaitlistStatus

Status related to waitlist integration.

Fields

has_valid_waitlist_service

bool

True if the merchant has waitlist service. Doesn't guarantee the merchant is actually served.

MoneyRange

Wrapper for a range of monetary amount that could be bounded or unbounded. At least one of min_amount and max_amount is required.

Fields

min_amount

Money

Minimum amount.

max_amount

Money

Maximum amount.

NoShowFee

A fee that a user may be charged if they have made a booking but do not show up.

Fields

fee

The amount the user may be charged if they do not show up for their reservation.

fee_type

PriceType

Defines how the fee is determined from the availability.

سفارش دهید

An order for service appointments with a merchant.

Fields
`name`	`string` Resource name of the order: `partners/{partner ID}/orders/{order ID}`
`client_information`	`ClientInformation` Personal information of the client making the order.
`payment_information`	`PaymentInformation` Information about payment transactions that relate to the order.
`merchant_id`	`string` ID of the merchant that all services in this order belong to.
`item[]`	`LineItem` Line items in this order.

OrderOnlineMetadata

Metadata for an order online action link.

Fields

fulfillment_option[]

FulfillmentOption

Available fulfillment options for an order online action link.

PaymentInformation

Payment details that relate to a booking

Fields

prepayment_status

PrepaymentStatus

Prepayment status of the booking. If the prepayment_status is PREPAYMENT_PROVIDED or PREPAYMENT_REFUNDED, then payment_transaction_id contains the associated unique transaction id.

payment_transaction_id

string

Unique identifier for a payment transaction associated with the booking. Empty if not applicable.

PaymentOption

A payment option, which can be used to pay for services provided by a merchant. Payment options can be shared among multiple merchants (eg merchants belonging to the same chain).

Fields
`payment_option_id`	`string` This ID is used to identify this payment option. This ID is global to the whole aggregator, and re-using a value across multiple merchants will allow a user to pay with the corresponding payment option across those merchants. When re-using an ID accoss multiple merchants, updating any value for a payment option under one merchant will also update any other payment option with the same ID, under a different merchant. As such, it's a best practice to have all payment options sharing the same ID, always be updated to identical values, to avoid any possibility of underministic behavior.
`name`	`string` The name of the payment option. This can be user visible.
`description`	`string` A description of the payment option. This can be user visible.
`price`	`Price` The price of the payment option.
`tax_rate`	`TaxRate` The tax rate for this payment option. If present this field overrides the tax_rate field present in the Merchant or Service. An empty message (ie tax_rate { }) will reset the applied tax rate to zero.
`payment_option_type`	`PaymentOptionType` The type of this payment option. Single-use for drop-ins, multi-use for packs, and unlimited for memberships.
`session_count`	`int64` How many sessions this payment option can be used for. Valid only for multi-session / packs, where the value should be > 1.
`purchase_interval`	`TimeRange` The payment option can be purchased within this interval.
`valid_interval`	`TimeRange` The payment option can be used within this interval (eg special price for January 2017). If present, this overrides valid_duration and activation_type.
`valid_duration`	`Duration` Duration of the payment option validity (eg 30 day membership).
`activation_type`	`ActivationType` Defines how the validity start date is determined for this payment option.
`user_restriction`	`UserPurchaseRestriction` Restricts the users eligible to purchase this payment option. Can be used to restrict a promotional payment option to a subset of users. If not set, all users are eligible.

ActivationType

Defines how the validity start date is determined.

انوم‌ها
`ACTIVATION_TYPE_UNSPECIFIED`	Unused.
`ACTIVATION_ON_PURCHASE`	Validity starts at the time of purchase.
`ACTIVATION_ON_FIRST_USE`	Validity starts when the payment option is used for the first time.

PaymentOptionType

A payment option type.

انوم‌ها
`PAYMENT_OPTION_TYPE_UNSPECIFIED`	Unused.
`PAYMENT_OPTION_SINGLE_USE`	Payment option can only be used once.
`PAYMENT_OPTION_MULTI_USE`	Payment option can be used if its session count > 0.
`PAYMENT_OPTION_UNLIMITED`	Payment option can be used within its valid time range - session count is inapplicable.

PaymentProcessorConfig

A configuration for a payment processor, setup on a per Merchant basis.

Fields

processor

Processor

Defines the payment processor partner this configuration applies to.

public_key

string

The key used to identify this merchant with the payment processor.

For Stripe, refer to: https://stripe.com/docs/dashboard#api-keys For Braintree, refer to: https://articles.braintreepayments.com/control-panel/important-gateway-credentials

version

string

The API version number sent to the payment processor along with payment requests.

پردازنده

Defines a specific payment processor partner.

انوم‌ها
`PROCESSOR_UNSPECIFIED`	استفاده نشده
`PROCESSOR_STRIPE`	A configuration for payments with Stripe.
`PROCESSOR_BRAINTREE`	A configuration for payments with Braintree.

PaymentRestrictions

Restrictions to the payment methods this merchant accepts.

Fields

credit_card_restrictions

CreditCardRestrictions

Restrictions to the credit cards this merchant accepts. We assume all credit cards are accepted if this field is not set. Note that the list of cards supported by CreditCardType will grow over time, meaning that leaving this empty subjects a configuration to future changes.

PerOrderFee

Fees that must be paid once per order, regardless of number of tickets.

Fields

delivery_fee

A fee that can vary by delivery method.

processing_fee

A fee to process the user's payment method.

PerTicketFee

Fees that must be paid for each ticket the user purchases.

Fields

service_charge

An extra charge assessed for a service.

facility_fee

A fee that goes to the venue/facility.

taxes

Per ticket taxes.

PostalAddress

Address of a customer or a business.

Fields
`address_country`	`string` The country, specified using its ISO 3166-1 alpha-2 country code, eg "US" (required)
`address_locality`	`string` The locality, eg "Mountain View". (required)
`address_region`	`string` The region, eg "CA". This field is only required in countries where region is commonly a part of the address. (optional)
`postal_code`	`string` The postal code, eg "94043". (required)
`street_address`	`string` The street address, eg "1600 Amphitheatre Pkwy". (required)

پیش‌پرداخت

A payment the user may be charged as part of their reservation.

Fields

price_info

PriceInfo

Container for price details.

PrepaymentStatus

Prepayment status of a booking.

انوم‌ها
`PREPAYMENT_STATUS_UNSPECIFIED`	Not specified, defaults to PREPAYMENT_NOT_PROVIDED.
`PREPAYMENT_PROVIDED`	The fee for the booking has been paid in advance.
`PREPAYMENT_NOT_PROVIDED`	The fee for the booking has not been paid in advance.
`PREPAYMENT_REFUNDED`	The fee was previously PREPAYMENT_PROVIDED but has now been refunded.

قیمت

The price of a service or a fee.

Fields
`price_micros`	`int64` The price in micro-units of the currency. Fractions of smallest currency unit will be rounded using nearest even rounding. (eg For USD 2.5 cents rounded to 2 cents, 3.5 cents rounded to 4 cents, 0.5 cents rounded to 0 cents, 2.51 cents rounded to 3 cents).
`currency_code`	`string` The currency of the price that is defined in ISO 4217.
`pricing_option_tag`	`string` An optional and opaque string that identifies the pricing option that is associated with the extended price.

PriceInfo

Container for price details.

Fields
`price_type`	`PriceType` Defines how price or price range is applied (per person or fixed)
Union field `price_options` . Price options are to either specify an exact price or a range. `price_options` can be only one of the following:
`price`	`Price` The price of a service or a fee.
`price_range`	`PriceRange` The upper and/or lower bound of a service or a fee.

PriceInterpretation

Describes how a Price should be interpreted and displayed to the user.

انوم‌ها
`PRICE_INTERPRETATION_UNSPECIFIED`	Price interpretation unspecified, defaults to EXACT_AMOUNT.
`EXACT_AMOUNT`	When the price should be interpreted as a specific value. Examples: $20 for a yoga class; $15 for a child haircut
`STARTS_AT`	When the price of a service is variable but a minimum price is known and displayed to consumers. Consumers may make choices which increase the price. Note that any service that uses this PriceInterpretation must use PrepaymentType NOT_SUPPORTED. Examples: $30 for dog grooming, but additional consumer choices may increase the price
`NOT_DISPLAYED`	When the price of a service is variable and no price information is displayed to consumers ahead of time. Note that any service that uses this PriceInterpretation must use PrepaymentType NOT_SUPPORTED and Price must be empty. Examples: A consultation for a home service

PriceRange

Wrapper for a range of monetary amount treated as unbounded unless both values are set. At least one of min_amount and max_amount is required.

Fields

min_price

Minimum amount.

max_price

Maximum amount. Should always be > min_price.

PriceType

Defines how a total price is determined from an availability.

انوم‌ها

FIXED_RATE_DEFAULT

The price is for a fixed amount. This is the default value if the field is not set.

Examples: $50 deposit to reserve a table; $20 no show fee for a yoga class

PER_PERSON

The price specified is per person, and the total price is calculated according to the party size specified in Resources as price_micros * party_size. A PER_PERSON price must be accompanied by a party size in the availability resources. If it is not, a party size of one is used.

Examples: $10 each for tickets to a museum

QuantitativeValue

Wrapper for a numerical value that could be a range or a fixed value. QuantitativeValue examples: * Singular value: value: 10.5 * Bounded range: value_range {min_value: 5.5, max_value 10.5} * Lower bound: value_range {min_value: 5.5} * Upper bound: value_range {max_value: 10.5}

Fields

Union field value_options . (required) value_options can be only one of the following:

value

double

A singular value. For example: 5.6

value_range

RangeValue

A range of values that could also be open ended or bounded. Examples: * At least 5.5 * At most 5.5 * 5.5 to 6.5

RangeValue

Range of values such that min_value < max_value . Requires at least one of min_value and max_value .

Fields

min_value

double

Minimum value.

max_value

double

Maximum value.

رتبه‌بندی

Defines Rating for an entity.

Fields

value

double

Average rating value (required when number_of_ratings > 0). The value must be in the range of [1, 5] and can be omitted if and only if the number_of_ratings is zero.

number_of_ratings

uint64

Number of ratings used in calculating the value (required).

RelatedMedia

Photos related to this service. Google will crawl these media to ensure that they are displayed correctly to end-users. (optional)

Fields
`url`	`string` URL of this media source. Google will crawl the media hosted at this URL.
`type`	`MediaType` Type of this media source.
`localized_caption`	`Text` Caption of the media that supports i18n, only plain text is supported. Any HTML components will be stripped. (optional)
`attribution`	`Attribution` Attribution information about the source of the media. Note that if the attribution is required to display with the media to give credit to photographer or agency, this field must be set. (optional)
`caption (deprecated)`	`string` این کالا منسوخ شده است! Deprecated, prefer to use localized_caption.

انتساب

Attribution information for this media.

Fields

localized_text

Text

The text to give credit to the photographer or agency supporting i18n. This text will be displayed together with the source media. Note that only plain text is supported for this field, any HTML components will be stripped (hyperlink based attribution is not supported).

text
 (deprecated)

string

Deprecated, prefer to use localized_text.

MediaType

Enum to indicate the type of this media source. Only photos are supported. Please reach out to the Reserve with Google team if other media beyond photos need to be supported.

انوم‌ها
`TYPE_UNSPECIFIED`	Unused.
`PHOTO`	Indicates the media provided by the url is a photo.

ReplaceServiceAvailabilityRequest

The request to replace a Service 's availability.

Fields

service_availability

ServiceAvailability

The service availability that is used to replace the existing ones.

RequireCreditCard

Defines whether a credit card is required in order to book an appointment.

انوم‌ها
`REQUIRE_CREDIT_CARD_UNSPECIFIED`	The credit card requirement is not explicitly specified and the behaviour is identical to the one specified for CONDITIONAL.
`REQUIRE_CREDIT_CARD_CONDITIONAL`	Google will require a credit card for the booking if any of the following conditions are met: * the availability has a price and the prepayment_type is REQUIRED * the no_show_fee is set * the deposit field is set.
`REQUIRE_CREDIT_CARD_ALWAYS`	A credit card is always required in order to book this availability regardless of other field values.

منابع

A resource is used to disambiguate availability slots from one another when different staff members, or rooms are part of the service. Multiple slots for the same service and time interval can co-exist when they have different resources.

Fields
`staff_id`	`string` Optional ID for a staff member providing the service. This field identifies the staff member across all merchants, services, and availability records. It also needs to be stable over time to allow correlation with past bookings. This field must be present if staff_name is present.
`staff_name`	`string` Optional name of a staff member providing the service. This field will be displayed to users making a booking, and should be human readable, as opposed to an opaque identifier. This field must be present if staff_id is present.
`room_id`	`string` An optional ID for the room the service is located in. This field identifies the room across all merchants, services, and availability records. It also needs to be stable over time to allow correlation with past bookings. This field must be present if room_name is present.
`room_name`	`string` An optional name for the room the service is located in. This field will be displayed to users making a booking, and should be human readable, as opposed to an opaque identifier. (optional but required if room_id is present) In dining a room name should only be used for seating areas such as the bar or patio and should not be used for fixed price menus, special activities, or any other non-room value (such as reservation or dinner). It is strongly recommended that the default seating area not have a room associated with it.
`party_size`	`int32` Applicable only for Dining: The party size which can be accommodated during this time slot. A restaurant can be associated with multiple Slots for the same time, each specifying a different party_size, if for instance 2, 3, or 4 people can be seated with a reservation.
`room_description`	`Text` Optional. Localized room description. If set, a default value must be provided. It is preferred to also provide common languages for the merchant's locale. (optional)

SchedulingRules

The scheduling rules for a service.

Fields
`min_advance_online_canceling`	`int64` The minimum advance notice in seconds required to cancel a booked appointment online. (optional)
`late_cancellation_fee (deprecated)`	`Price` این کالا منسوخ شده است! The fee for canceling within the minimum advance notice period.
`noshow_fee (deprecated)`	`Price` این کالا منسوخ شده است! The fee for no-show without canceling.
`admission_policy`	`AdmissionPolicy` The admission policy that applies to this service. If unset, defaults to TIME_STRICT. (optional)
`cancellation_policy`	`CancellationPolicy` Scheduling rules cancellation policy. (required for Things-to-do)
Union field `min_booking_buffer` . The duration (in seconds) from when the last booking can be made to when the availability slot starts or ends. If "min_advance_booking" is set, the last bookable time is calculated as (<slot start time> - "min_advance_booking"). If "min_booking_buffer_before_end_time" is set, the last bookable time is calculated as (<slot end time> - "min_booking_buffer_before_end_time"). Note that the value of "min_booking_buffer_before_end_time" must be positive if set. If both are unset, the slot is bookable until the slot begin time. If both fields are set, only one value will be picked while the other value ignored--we cannot reliably predict which value is chosen. Examples: A haircut that needs to be booked at least 1 hour before the start time. 'scheduling_rules{ min_advance_booking: 3600 ...}` A museum where the last ticket can be purchased 30 mins before closing: 'scheduling_rules{ min_booking_buffer_before_end_time: 1800 ...}' A movie ticket that needs to be purchased before the start time. 'scheduling_rules{ ...}' (leave this field empty) (optional) `min_booking_buffer` can be only one of the following:
`min_advance_booking`	`int64` The duration (in seconds) from when the last booking can be made to when the availability slot starts.
`min_booking_buffer_before_end_time`	`int64` The duration (in seconds) from when the last booking can be made to when the availability slot ends. If this field is set, the "admission_policy" field must be set to TIME_FLEXIBLE to indicate that users can use the purchased tickets after slots start.

AdmissionPolicy

The admission policy of this service.

انوم‌ها
`ADMISSION_POLICY_UNSPECIFIED`	Unused.
`TIME_STRICT`	Customers are required to be present at the start time of the availability slot, and the service is expected to finish at the end time of the slot. Examples of TIME_STRICT use cases: * A tour that starts at 9am that requires all attendees to arrive at the start time, and returns at around 12pm. * A haircut reservation at 3pm on Saturday that will take approximately 30 minutes. * A fitness class from 6pm to 8pm.
`TIME_FLEXIBLE`	Customers can arrive at any time between the start and end time of the availability slot to use this booking. Examples of TIME_FLEXIBLE use cases: * A museum ticket that can be used during any time on the purchase date. * An afternoon admission to an amusement park that can be used from 12pm to 9pm.
`TIMED_ENTRY_WITH_FLEXIBLE_DURATION`	Customers need to arrive at the merchant at the start time of the availability slot but can leave any time they want. For example, in the museum admission scenario, a timed entry ticket for 10am requires the user to be at the museum at 10am. The start time of availability slots for this service represents the designated entry time. The end time, however, is used solely as a key to identify the availability slot for booking.

خدمات

Info about a service that is provided by the merchant, eg haircut.

Fields
`name`	`string` The service resource name, which has the format of `partners/{partner_id}/merchants/{merchant_id}/services/{service_id}` .
`service_name`	`string` The name of the service, eg "Men's haircut". Deprecated, use localized_service_name instead.
`localized_service_name`	`Text` The name of the service, eg "Men's haircut". Possibly in several locales.
`description`	`string` The user-visible description of the service. Deprecated, use localized_description instead.
`localized_description`	`Text` The user-visible description of the service. This field supports both plain-text and HTML-like formatting. Unlike plain text sections, customized layouts can be created here using headings, paragraphs, lists and some phrase tags. Please read the following instructions and notes carefully to ensure you create the best user-experience. Supported HTML-like formatting tags: Heading tags: <h1>, <h2>, <h3>, <h4>, <h5>, <h6> Heading tags can be used to display titles and sub-titles. For example, <h1>Itinerary</h1> will display the inline text as the most important heading of the section. Note that any inner HTML tags, styles or attributes will be ignored. For example, <h1 style=".."> will be treated the same as <h1>. Only pure text wil be preserved. Paragraph tag: <p> The paragraph tag can be used to highlight a detailed introduction or contents. Any inner tags, styles or attributes will be ignored, with a few exceptions: <br>, <strong> and <em>. Please see the phrase tag section below for more details. List tags: <ul>, <ol>, <li> The <ul> tag can be used with the <li> tag to display unordered lists, and the <ol> tag can be used with <li> to display ordered lists. This is a good way to display checklists, schedules, or any other lists that fit your use-cases. Example: To show a list of features of a cruise trip: <ol> <li>Wonderful ocean view and chances to play with wildlife.</li> <li>Carefully designed travel arrangements and services.</li> <li>Guaranteed lowest price.</li> </ol> Note that only <li> children under <ul> or <ol> tags will be converted. All other children will be dropped. Also, any inner tags, attributes and styles will be ignored; we only preserve pure text contents. Division tag: <div> All supported inner tags of the <div> tag will be parsed with the rules stated above, imply <div> tag itself does not mean any grouping or indenting here. Also, any inner attributes and styles will be ignored. Phrase tags: <br>, <strong>, <em>: Only the three tags mentioned above are supported. <br> can be used to break lines in paragraphs, and <strong>/<em> can be used to highlight important text. Any other phrase tags will be ignored. Unsupported tags: <html>, <header>, and <body> tags are not allowed. Any other tags not mentioned above are not supported (for example <table>, <td> ...). Any URLs, anchors, and links will be stripped, and will never be displayed to end-users. If you want to use photos to create a rich user experience, please use the "related_media" field below to send your photo URLs. نکات مهم: Try not to use other tags except for the supported ones mentioned above, because the contents within unsupported tags will be stripped, and may lead to an undesirable user experience. Try avoid deep nested structures like more than 3 different heading levels or nested lists. Keeping the structure flat, simple, and straightforward, helps to create a better user experience. If the currently supported layouts are not sufficient for your use cases, please reach out to the Reserve with Google team. The recommended maximum size is 32,000 characters.
`price`	`Price` The price of the service.
`price_interpretation`	`PriceInterpretation` Describes how the price is interpreted and displayed to the user. Can be used by any vertical except Dining and Things To Do to configure display of the service price.
`rules`	`SchedulingRules` Rules to book/cancel an appointment.
`prepayment_type`	`PrepaymentType` Whether a prepayment is required, optional or not supported.
`prepayment_terms`	`PrepaymentTerms` Terms around when the prepayment is completed.
`form[] (deprecated)`	`ServiceIntakeForm` این کالا منسوخ شده است! Deprecated. Please use intake_form and per_ticket_intake_form.
`intake_form`	`ServiceIntakeForm` A form requesting additional information from the user when they book this service. (optional)
`per_ticket_intake_form`	`ServiceIntakeForm` A form requesting additional information from the user when they book this service. This form must be filled out once for each ticket the user is booking. (optional)
`tax_rate`	`TaxRate` The service's tax rate. If present this field overrides any tax_rate set at the merchant level. An empty message (ie tax_rate { }) will reset the applied tax rate to zero.
`payment_option_id[]`	`string` A list of ids referencing the payment options which can be used to pay for this service. The actual payment options are defined at the Merchant level, and can also be shared among multiple Merchants.
`deposit`	`Deposit` Defines how a deposit may be charged to the user. Overrides the service deposit if one was specified. Setting this to an empty Deposit message removes any service-level deposit. (optional)
`no_show_fee`	`NoShowFee` Defines a no show fee that may be charged to the user. Overrides the service no show fee if one was specified. Setting this to an empty NoShowFee message removes any service-level no show fee. (optional)
`require_credit_card`	`RequireCreditCard` Indicates whether the user must provide a credit card in order to book this service. This field can be overridden at the availability level. (optional)
`action_link[]`	`ActionLink` An action link related to this service. If action link exists, type (see below) must be set in the Service.
`type`	`ServiceType` The predefined type of this service. (optional)
`ticket_type[]`	`TicketType` Types of tickets that can be booked/purchased for this service, if tickets are supported. (optional)
`related_media[]`	`RelatedMedia` Photos related to this service. Google will crawl and store the media to ensure that they are displayed to end-users in the most efficient way. (optional)
`service_attribute_value_id[]`	`ServiceAttributeValueId` Service attribute values that apply to this service (optional). Each Service may have zero or more values for each service attribute defined in the corresponding Merchant. (optional)
`waitlist_rules`	`WaitlistRules` Rules to joining the waitlist.
`ticketing_vertical_specific_data`	`TicketingVerticalSpecificData` Additional information unique to the event ticketing vertical. (optional)
`integration_type`	`IntegrationType` Depth of integration we support for this service. (optional) Irrelevant for partners with the starter integration. End to end will always be disabled for these partners.
`per_order_fee`	`PerOrderFee` Order level fees for purchasing this service. (optional)
`tours_and_activities_content`	`ToursAndActivitiesContent` Content fields specific to Tours and Activities.
`location[]`	`Location` Locations related to this service. IMPORTANT NOTES: If there are multiple visited locations related to this service, or the START_LOCATION is different from the VISITED_LOCATION, the START_LOCATION must be specified. Example: - A guided biking tour visiting three venues, the start venue needs to be specified. - A bus tour meeting at a hotel lobby and then head to the visited venue. The meeting location needs to be specified.
`rating`	`Rating` User rating for this service as an aggregate metric over all reviews.
`home_service_data`	`HomeServiceData` Additional information unique to home service vertical. (optional)
`virtual_session`	`VirtualSession` Optional. Information about virtual session. It is required for enabling virtual services.
`direct_merchant_payment`	`DirectMerchantPayment` Optional. Additional information which needs to be added if the service requires the user to pay directly to the merchant. IMPORTANT NOTE: RwG would not be involved in this transaction. It is required if virtual_session is defined and the service is not free or prepayment_type is NOT set to REQUIRED.
`uri_template`	`UriTemplate` Optional. An optional template specifying how Google should generate URLs to external site.

PrepaymentTerms

Specific information around when prepayment is completed.

Fields

charge_timing

ChargeTiming

When the charge will occur relative to the purchase time.

charge_time_before_start_time_sec

int64

Time in seconds before the service start time that the user is charged for payment. This field should only be set when ChargeTiming is CHARGE_LATER.

ChargeTiming

Enum to specify when the charge will occur relative to the purchase time.

انوم‌ها
`CHARGE_TIMING_UNSPECIFIED`	Unused.
`CHARGE_NOW`	Customer will be charged immediately.
`CHARGE_LATER`	Customer will be charged later.

PrepaymentType

Enum to indicate the prepayment type.

انوم‌ها
`PREPAYMENT_TYPE_UNSPECIFIED`	By default we will assume that the prepayment is NOT_SUPPORTED.
`REQUIRED`	The user has to pay this service at the booking time.
`OPTIONAL`	The user can choose to pre-pay this service at the booking time or later, but it is not required in order to book.
`NOT_SUPPORTED`	The prepayment is not supported for this service.

ServiceType

Predefined service types.

انوم‌ها
`SERVICE_TYPE_UNSPECIFIED`	Unused.
`SERVICE_TYPE_DINING_RESERVATION`	Dining reservation.
`SERVICE_TYPE_FOOD_ORDERING`	Food ordering, could be either food delivery or takeout or both.
`SERVICE_TYPE_FOOD_DELIVERY`	Food delivery.
`SERVICE_TYPE_FOOD_TAKEOUT`	Food takeout.
`SERVICE_TYPE_EVENT_TICKET`	Event ticket.
`SERVICE_TYPE_TRIP_TOUR`	Trip tour.
`SERVICE_TYPE_APPOINTMENT`	Service that provides appointments or classes. Recommended for (1) health and fitness, (2) spa and beauty, and (3) financial consults and evaluations services. Please see the supported service types: https://developers.google.com/maps-booking/guides/end-to-end-integration/overview
`SERVICE_TYPE_ONLINE_APPOINTMENT`	Service that provides online appointment for a class or session which will be fully virtual. Must be set if enabling virtual service bookings.
`SERVICE_TYPE_SHOPPING`	Service that allows users to shop from the given merchant. It could either be delivery or pickup.

ServiceAttribute

Service attributes are partner-defined categories that describe the Services for a Merchant. For example, a bank may define an "Account Type" service attribute with possible values of "Personal" and "Business", while a hair salon may define a "Service Type" service attribute with possible values of "Haircut", "Color", and "Style".

Fields

attribute_id

string

An identifier that uniquely identifies this service attribute among others for the same merchant, eg "account-type".

attribute_name

string

A user-visible name for this attribute, eg "Account Type".

value[]

Value

All possible values for this service attribute.

ارزش

Represents a possible value for a particular service attribute.

Fields

value_id

string

An identifier that uniquely identifies this value among others for this service attribute, eg "personal".

value_name

string

A user-visible name for the value, eg "Personal".

ServiceAttributeValueId

Identifies a particular value of a service attribute to be applied to a Service.

Fields

attribute_id

string

ID of an attribute as defined in Merchant.service_attribute, eg "service-type".

value_id

string

ID of the value for this attribute, eg "haircut". Must match a value_id in the service attribute definition.

ServiceAvailability

A list of availability and who/when they should be applied to.

Fields
`name`	`string` The resource name of the service to apply this to. In the format of `partners/{partner_id}/merchants/{merchant_id}/services/{service_id}`
`start_time_restrict`	`Timestamp` If provided, we will consider the Availability entities provided to be a complete snapshot from [start_time_restrict, end_time_restrict). That is, all existing availability will be deleted if the following condition holds true: `start_time_restrict <= availability.start_sec && availability.start_sec < end_time_restrict` If a duration message is set, the condition is further restricted: `availability.duration == duration_restrict` If a resources_restrict message is set, the condition is further restricted: `availability.resources.staff_id == resources_restrict.staff_id && availability.resources.room_id == resources_restrict.room_id` These fields are typically used to provide a complete update of availability in a given time range. Setting start_time_restrict while leaving end_time_restrict unset is interpreted to mean all time beginning at start_time_restrict.
`end_time_restrict`	`Timestamp` Setting end_time_restrict while leaving start_time_restrict unset is interpreted to mean all time up to the end_time_restrict.
`duration_restrict`	`Duration` Setting duration further restricts the scope of the update to just the availability with matching duration.
`resources_restrict`	`Resources` Setting resources_restrict further restricts the scope of the update to just this set of resources. All id fields of the resources must match exactly.
`availability[]`	`Availability` The new list of availability.

ServiceIntakeForm

Defines an intake form that customizes the service provided by a merchant.

Fields

field[]

ServiceIntakeFormField

Fields that will be displayed to the user.

first_time_customers
 (deprecated)

bool

If true, this form will be shown to first time customers. Deprecated. This functionality is not supported for intake forms.

returning_customers
 (deprecated)

bool

If true, this form will be shown to repeat customers. Deprecated. This functionality is not supported for intake forms.

ServiceIntakeFormField

Defines a field that is included in a ServiceIntakeForm.

Fields
`id`	`string` A string from an aggregator partner which uniquely identifies a form field. This id should be the same as the id in the corresponding form field answer and must be unique across both the service level and per ticket intake forms. (required)
`type`	`FieldType` The type of this field.
`label`	`string` The text shown to the user for this field. Deprecated, please use `localized_label` instead.
`localized_label`	`Text` The text shown to the user for this field. The field can be supplied in multiple locales. (required)
`value[]`	`string` Set if and only if the field type is LOCATION_SEARCH. Please use the "location_id" in the "location" field to specify the location value.
`choice_text[]`	`Text` Set if and only if the field type is MULTIPLE_CHOICE, CHECKBOXES, or DROPDOWN. Used to enumerate possible choices.
`is_required`	`bool` Indicates whether an answer to this field is required by a user.
`allow_custom_answer`	`bool` Indicates whether a custom value is allowed in additional to predefined answers. This is only applicable when the field type is LOCATION_SEARCH. (optional)
`additional_option[]`	`Text` Additional options provided in addition to the provided values. Only applicable when the field type is LOCATION_SEARCH. Eg in addition to the provided location list, another available option can be "I will contact supplier later". (optional)
`ticket_type_restrict[]`	`string` If this question should only be shown when the user books certain ticket types, this field should be set as the set of applicable ticket type ids. Leave the field empty if the question is always applicable.
`hint`	`Text` The hint text for input, which shows up as a text placeholder. This is only applicable when the field type is SHORT_ANSWER or PARAGRAPH. (optional)

FieldType

Enum to indicate the type of field.

انوم‌ها
`FIELD_TYPE_UNSPECIFIED`	Fields of unspecified or unknown type will be ignored.
`SHORT_ANSWER`	A one-line input field for text.
`PARAGRAPH`	A multi-line input field for text.
`MULTIPLE_CHOICE`	A set of radio buttons that requires one choice from many options.
`CHECKBOXES`	One or more enumerated items with checkboxes.
`DROPDOWN`	A selection from a dropdown.
`BOOLEAN`	A yes/no button.
`LOCATION_SEARCH`	A search box that supports finding matched location given user input from provided location list.

TaxRate

A tax rate applied when charging the user for a service, and which can be set on either a per merchant, or per service basis.

Fields

micro_percent

int32

A tax rate in millionths of one percent, effectively giving 6 decimals of precision. For example, if the tax rate is 7.253%, this field should be set to 7253000.

If this field is left unset or set to 0, the total price charged to a user for any service provided by this merchant is the exact price specified by Service.price. The service price is assumed to be exempt from or already inclusive of applicable taxes. Taxes will not be shown to the user as a separate line item.

If this field is set to any nonzero value, the total price charged to a user for any service provided by this merchant will include the service price plus the tax assessed using the tax rate provided here. Fractions of the smallest currency unit (for example, fractions of one cent) will be rounded using nearest even rounding. Taxes will be shown to the user as a separate line item.

شرایط

A set of rules and guidelines that are displayed to the user in order to make a booking through Reserve with Google.

Fields

url

string

Optionally, the URL to the Terms and Conditions.

text

string

The text to be displayed to the user. Use localized_text below for new integrations.

localized_text

Text

The localized text to be displayed to the user.

متن

A possibly-localized text payload. Some Text fields may contain marked-up content.

Fields

value

string

Text value in an unknown locale. Required if and only if localized_value is empty. The locale for this value may depend on the partner or service provider -- it should not be assumed to be any specific language.

localized_value[]

LocalizedString

Per-locale text values. Optional.

TicketType

TicketType is used to differentiate among tickets with different prices and/or availabilities due to different user types, different service attributes, or different options/add-ons.

A ticket is the minimal bookable unit to a service, eg a spot on a rafting trip, an admission to a museum, a full day double kayak rental.

Fields
`ticket_type_id`	`string` The ticket id is used to differentiate among different ticket types of the same service, and is only expected to be unique within a service.
`short_description`	`string` A short description to this TicketType. This can be user visible, eg, “adult”, "child", “veteran”, “Row J”, etc. Required, each ticket type should have a description to be user visible. Deprecated, use localized_short_description instead.
`localized_short_description`	`Text` A short description to this TicketType with i18n support. This can be user visible, eg, “adult”, "child", “veteran”, “Row J”, etc. Required, each ticket type should have a description to be user visible. Separate values could be supplied for each locale.
`price`	`Price` The price of a single ticket of this type, exclusive of any taxes. The tax rate of Service is applied to its tickets.
`per_ticket_fee`	`PerTicketFee` Additional fees for purchasing this ticket. (optional)
`price_display_type`	`PriceDisplayType` Optional. Predetermined price display type of a single ticket of this type.
`option_description`	`string` Description of any additional option which this ticket type represents, if any. Deprecated, use localized_option_description instead.
`localized_option_description`	`Text` Description of any additional option which this ticket type represents, if any. Separate values could be supplied for each locale. Additional options are useful when the ticket type represents multiple dimensions. Example 1: an admission ticket with different types 'adult', 'child' and language as an additional option, the expected TicketType list would be: - { ticket_type_id: "ticket_type_1" localized_short_description { value: "adult" } localized_option_description { value: "english" } } - { ticket_type_id: "ticket_type_2" localized_short_description { value: "adult" } localized_option_description { value: "spanish" } } - { ticket_type_id: "ticket_type_3" localized_short_description { value: "child" } localized_option_description { value: "english" } } - { ticket_type_id: "ticket_type_4" localized_short_description { value: "child" } localized_option_description { value: "spanish" } } Example 2: an multi-hour kayak rental with optional dry bag add-on, the short_description could be "3 hours" and the option_description could be either "with dry bag" or "without dry bag": - { ticket_type_id: "ticket_type_1" localized_short_description { value: "2 hours" } localized_option_description { value: "english" } } - { ticket_type_id: "ticket_type_2" localized_short_description { value: "2 hours" } localized_option_description { value: "spanish" } } - { ticket_type_id: "ticket_type_3" localized_short_description { value: "3 hours" } localized_option_description { value: "english" } } - { ticket_type_id: "ticket_type_4" localized_short_description { value: "3 hours" } localized_option_description { value: "spanish" } } Optional, but if any ticket type within the service has this field set, we expect all other ticket types to have this field set as well (a default option_description could be used). Eg [{ticket_type_1, adult, english}, {ticket_type_1, adult, ''}] is not a valid list. Only two HTML formatting tags are supported: and . They are intended to be used for specifying options with both a title and detailed description, for example: " Premium Seating This option offers seating at the private boxes including fully cushioned seats, private TVs, in-seat food and beverage service. These seats provide picturesque views of the field."
`inventory_type`	`InventoryType` Optional. Predetermined inventory type of a single ticket of this type.

InventoryType

Predetermined inventory type of a single ticket of this type.

انوم‌ها
`INVENTORY_TYPE_UNSPECIFIED`	The inventory type is unspecified.
`INVENTORY_TYPE_PRIMARY`	Primary inventory.
`INVENTORY_TYPE_VERIFIED_RESALE`	Verified resale inventory.
`INVENTORY_TYPE_RESALE`	Resale inventory.
`INVENTORY_TYPE_AGGREGATOR`	Aggregator inventory. Aggregator (eg www.bandsintown.com) means the partner provides events and tickets information. But the tickets are not sold by the partner directly. The actual tickets seller can be primary, verified resale or resale. Now we only differentiate top level partner inventory type and ignore the actual tickets seller inventory type within an aggregator.

PriceDisplayType

Indicates the price format displayed on the landing page.

This field is ignored for non-link-out inventory.

This field allows Google surfaces to show the same price format as used byService the landing page. Consistent price formats improve conversion rate and reduce confusion.

انوم‌ها
`PRICE_DISPLAY_TYPE_UNSPECIFIED`	The price display type is unspecified. Google will determine which format to show.
`PRICE_DISPLAY_TYPE_BASE`	The price shown on the landing page is the base price.
`PRICE_DISPLAY_TYPE_ALL_IN`	The price shown on the landing page includes all fees and taxes.

TicketingVerticalSpecificData

Additional information unique to the event ticketing vertical.

Fields
`event_category`	`EventCategory` The category of the event. Set only when event falls into one of the predefined categories. (optional)
`event_url`	`string` The URL of the event on the partner's website. (optional)
`entity[]`	`Entity` A list of entities related to the event. (optional)
`event_attendance_mode`	`AttendanceMode` Required. The type of the event attendance.
`event_virtual_location_url[]`	`string` Optional. URL where the event can be watched.
`event_organizer`	`Text` Optional. Organizer who hosts the event.
`event_organizer_url`	`string` Optional. URL of the organizer who hosts the event.
`event_organizer_type`	`OrganizerType` Optional. The type of the organizer.
`event_source_url[]`	`string` Required. URL of the pages where the event information or descriptions can be found.
`event_state`	`EventState` Optional. State of the event.
`brand_name`	`Text` Optional. The localized brand name.
`event_creator`	`EventCreator` Optional. Information about the creator of the event.

AttendanceMode

The type of the event attendance.

انوم‌ها
`ATTENDANCE_MODE_UNSPECIFIED`	Not specified.
`ONLINE`	For virtual events.
`PHYSICAL`	For physical events.
`PHYSICAL_ONLINE_MIXED`	For events that are both physical and virtual.

Entity

Represents an entity related to the event.

Fields
`id`	`string` Unique identifier of the entity in the partner's database. (optional)
`name`	`string` Name of the entity. (required)
`url`	`string` Url of the webpage that unambiguously describes the entity. This is the webpage on the partner's website for the entity if any; for other public URLs of the entity, use relevant_url in public_identification_data. (optional)
`entity_type`	`EntityType` The type of the entity. (optional)
`entity_role`	`EntityRole` The role of the entity in the event. (optional)
`public_identification_data`	`PublicIdentificationData` Public references of the entity. (optional)

EntityRole

The role of the entity in the event.

انوم‌ها
`ENTITY_ROLE_UNSPECIFIED`	Not specified.
`ENTITY_ROLE_HEADLINER`	The entity represents a headliner or leading performer at the event.
`ENTITY_ROLE_SUPPORTER`	The entity represents a supporting performer at the event.
`ENTITY_ROLE_HOME_TEAM`	The entity represents the home team at the (sports) event.
`ENTITY_ROLE_AWAY_TEAM`	The entity represents the away team at the (sports) event.

EntityType

The type of the entity. Note: not intended to be a universal ontology.

انوم‌ها
`ENTITY_TYPE_UNSPECIFIED`	Not specified. Do not use.
`ENTITY_TYPE_PERFORMER`	The entity represents the artist or group performing at a concert or a show. Only applicable when event category is CONCERT or THEATRE.
`ENTITY_TYPE_PLAYER`	The entity represents the sports team or player at the event. Only applicable when event category is SPORTS.
`ENTITY_TYPE_CONCERT_TOUR`	The entity represents the tour that this event belongs to. Only applicable when event category is CONCERT.
`ENTITY_TYPE_SPORTS_SERIES`	The entity represents a sports tournament that this event belongs to. Only applicable when event category is SPORTS.
`ENTITY_TYPE_PLAY`	The entity represents the type of play (eg, musical, comedy, ballet, etc.) performed at the event. Only applicable when event category is THEATRE.

EventCategory

A subset of event categories for which we customize the product experience. Note: not intended to be a universal ontology of events.

انوم‌ها
`EVENT_CATEGORY_UNSPECIFIED`	Not specified. Do not use.
`EVENT_CATEGORY_CONCERT`	Concerts.
`EVENT_CATEGORY_SPORTS`	Sports events.
`EVENT_CATEGORY_THEATRE`	Theatre events.
`EVENT_CATEGORY_EXHIBITS`	Exhibits.
`EVENT_CATEGORY_WORKSHOPS_AND_CLASSES`	Workshops and Classes.

EventCreator

Information about the creator of the event. Only relevant for platforms that include user-generated content events.

Fields

name

string

Optional. Name of the event creator. No character restriction.

EventState

State of the event.

انوم‌ها
`EVENT_STATE_UNSPECIFIED`	Not specified.
`SCHEDULED`	The event is scheduled.
`RESCHEDULED`	The event is rescheduled.
`CANCELLED`	The event is cancelled.
`POSTPONED`	The event is postponed.

OrganizerType

The type of the organizer.

انوم‌ها
`ORGANIZER_TYPE_UNSPECIFIED`	Not specified.
`PERSON`	For organizer who is a person.
`ORGANIZATION`	For organizer who is an organization.

PublicIdentificationData

Identifiers, webpages, or any other public sources that reference an entity.

Fields

relevant_url[]

string

Public URL of any webpage that is dedicated to only the topic. This could include official websites, discogs, social media platforms, wikipedia or imdb pages, eg https://www.discogs.com/artist/1124645-Taylor-Swift , https://www.wikidata.org/wiki/Q19320959 , https://twitter.com/acmilan . (optional)

musicbrainz_id

string

The 36-character musicbrainz identifier of the artist or other music entities, if applicable. See https://musicbrainz.org/doc/MusicBrainz_Identifier . (optional)

TimeRange

A closed-open time range, ie [start_time, end_time).

Fields

start_time

The lower bound of the time range.

end_time

BillingInformationFormat

The upper bound of the time range.

TokenizationConfig

A configuration for payment-processor tokenization, set up on a per-Merchant basis.

Fields

tokenization_parameter

map<string, string>

A tokenization configuration will typically have one tokenization_parameter whose key is "gateway" and whose value is the name of the processor.

The rest of the parameters are dependent on the processor. See Google Pay's documentation for further information.

Braintree example: tokenization_parameter { key: "gateway" value: "braintree" } tokenization_parameter { key: "braintree:apiVersion" value: "v1" } tokenization_parameter { key: "braintree:sdkVersion" value: "2.30.0" } tokenization_parameter { key: "braintree:merchantId" value: "abcdef" } tokenization_parameter { key: "braintree:clientKey" value: "production_xxx_yyy" }

Stripe example: tokenization_parameter { key: "gateway" value: "stripe" } tokenization_parameter { key: "stripe:version" value: "2018-02-28" } tokenization_parameter { key: "stripe:publishableKey" value: "pk_1234" }

Adyen example: tokenization_parameter { key: "gateway" value: "adyen" } tokenization_parameter { key: "gatewayMerchantId" value: "yourId" }

billing_information_format

Include in the payment token the user's billing information as entered into Google Pay with their FOP (see above). Leaving the field empty is equivalent to specifying MIN.

BillingInformationFormat

How much of the Billing Address to require of the user and include in the token. The enum values correspond to parameters in the Google Pay API (see https://developers.google.com/pay/api/web/reference/object#BillingAddressParameters) .

انوم‌ها
`BILLING_INFORMATION_FORMAT_UNSPECIFIED`	Not specified. Defaults to MIN.
`MIN`	name, country code, and postal code (Google Pay default setting).
`FULL`	name, street address, locality, region, country code, and postal code.

ToursAndActivitiesContent

Content fields specific to Tours and Activities. Each element in the repeated field should be independent to allow separate rendering (eg as a bullet point).

Populating ToursAndActivitiesContent is strongly recommended for tours and activities, but not strictly required. All fields support both plain-text and HTML-like text for basic formatting. Supported HTML-like formatting tags:

Phrase tags:
, , , : Only the three tags mentioned above are supported.
can be used to break lines in paragraphs, and / / can be used to highlight an important text. Any other phrase tags will be ignored.

All other tags and custom styles are not allowed and will be removed. Any URLs, anchors, and links will be stripped, and will never be displayed to end-users.

Important notes: * Don't duplicate data already supplied in highlights , exclusion and other, more specific, fields in the service description. * Avoid using other tags except for the supported ones mentioned above, because the contents within unsupported tags will be stripped, and may lead to an undesirable user experience.

Fields
`highlights[]`	`Text` The user-visible list of highlights.
`inclusions[]`	`Text` The user-visible list of inclusions.
`exclusions[]`	`Text` The user-visible list of exclusions.
`must_know[]`	`Text` The user-visible list of important notes, use for details such as age restrictions or other conditions that make this service unsuitable.

UnsupportedPartySizeOption

Options for parties that are out of range.

Fields

Union field kind . Available options for parties that are out of range. kind can be only one of the following:

call_merchant

CallMerchant

Party sizes that are out of range can call the business. A predefined message will be displayed to the user. Sample text to be displayed: "For parties larger than {waitlist_rules.max_party_size} please call the restaurant at {phone}." CallMerchant must be set, but will be empty.

UpdateAdsAccountLinkRequest

Request message for AdsAccountLinkingService.UpdateAdsAccountLink.

Fields

ads_account_link

AdsAccountLink

Required. The Ads account link to update.

The AdsAccountLink's name field is used to identify the AdsAccountLink to update. Format: partners/{partner}/adsAccountLinks/{ads_account_link}

update_mask

Optional. The list of fields to update.

UpdateBookingRequest

Request to update a google.maps.booking.v1alpha.Booking

Fields

update_mask

Field mask of all booking fields to be updated

booking

Booking

The booking to be updated

booking_failure

BookingFailure

If processing of an asynchronously confirmed booking request fails and the booking's status is being updated to FAILED, this field should reflect the business logic error (eg, user has an existing reservation too close to this time). This field should only be set when updating the booking status to FAILED and will be ignored otherwise.

UpdateMerchantRequest

The request to update a Merchant .

Fields

merchant

Merchant

The new merchant data.

update_mask

The specific fields to update for the merchant.

UpdateOrderRequest

Request to update a google.maps.booking.v1alpha.Order

Fields

update_mask

Field mask of all order fields to be updated

order

Order

The order to be updated

UpdateServiceRequest

The request to update a Service .

Fields

service

Service

The new service data.

update_mask