Package google.maps.booking.v1alpha

索引

BookingNotification

接收有关来自外部时间安排合作伙伴的预约通知。合作伙伴应根据合作伙伴是实现基于预订的 RPC(例如 CreateBooking 和 CheckAvailability)还是基于订单的 RPC(例如 CreateOrder 和 CheckOrderFulfillability)来调用 UpdateBooking 或 UpdateOrder。

UpdateBooking

rpc UpdateBooking(UpdateBookingRequest) returns (Booking)

更新现有 Booking

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking
UpdateOrder

rpc UpdateOrder(UpdateOrderRequest) returns (Order)

更新现有 Order

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking

Feed

获取由外部集合商家合作伙伴上传的 Feed 的处理状态。

GetStatus

rpc GetStatus(GetStatusRequest) returns (FeedStatus)

检索指定的集合商家之前所上传 Feed 的 Status,并将其返回。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking
ListStatus

rpc ListStatus(ListStatusRequest) returns (ListStatusResponse)

检索指定的集合商家之前上传的多个商家 Feed、服务 Feed 或可用性 Feed 的 Status,并将其返回。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking

InvalidationService

接收来自外部合作伙伴的资源失效请求。

InvalidateResource

rpc InvalidateResource(InvalidateResourceRequest) returns (Empty)

使现有资源失效。

如果请求的资源未订阅 Google 服务,则请求会被忽略。

支持的资源类型:- 自提

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking

InventoryStatus

检索已上传商家的商品目录和匹配状态。

GetMerchantStatus

rpc GetMerchantStatus(GetMerchantStatusRequest) returns (MerchantStatus)

获取 MerchantMerchantStatus

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking
ListMerchantStatuses

rpc ListMerchantStatuses(ListMerchantStatusesRequest) returns (ListMerchantStatusesResponse)

列出符合过滤条件的合作伙伴的所有 MerchantStatus

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking

InventoryUpdate

接收来自外部集合商家的商品目录更新。

BatchDeleteGenericRecords

rpc BatchDeleteGenericRecords(BatchDeleteGenericRecordsRequest) returns (Empty)

删除指定 Feed 类型的记录。仅执行基本验证(例如请求格式不正确),之后会立即将适当的响应返回给合作伙伴。Google 对请求执行业务逻辑验证。此批量调用不保证原子性。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking
BatchPushGenericRecord

rpc BatchPushGenericRecord(BatchPushGenericRecordRequest) returns (Empty)

插入和/或更新指定 Feed 类型的记录。仅执行基本验证(例如请求格式不正确),之后会立即将适当的响应返回给合作伙伴。Google 对请求执行业务逻辑验证。此批量调用不保证原子性。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking
BatchReplaceServiceAvailability

rpc BatchReplaceServiceAvailability(BatchReplaceServiceAvailabilityRequest) returns (BatchReplaceServiceAvailabilityResponse)

替换现有 ServicesAvailability。此批量调用不保证原子性,仅返回成功更新的可用性空档。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking
CreateMerchant

rpc CreateMerchant(CreateMerchantRequest) returns (Merchant)

创建由指定的集合商家管理的新 Merchant,并将其返回。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking
CreateService

rpc CreateService(CreateServiceRequest) returns (Service)

创建由指定的集合商家管理的商家的新 Service,并将其返回。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking
DeleteMerchant

rpc DeleteMerchant(DeleteMerchantRequest) returns (Empty)

删除由指定的集合商家管理的现有 Merchant。系统也将停用商家的所有服务及可用性。如果您稍后重新添加相应商家,系统会显示同一组服务和可用性空档。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking
DeleteService

rpc DeleteService(DeleteServiceRequest) returns (Empty)

删除由指定的集合商家管理的商家的现有 Service。系统也将删除所有服务的可用性。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking
ReplaceServiceAvailability

rpc ReplaceServiceAvailability(ReplaceServiceAvailabilityRequest) returns (ServiceAvailability)

替换由指定的集合商家管理的商家现有 ServiceAvailability,并将其返回。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking
UpdateMerchant

rpc UpdateMerchant(UpdateMerchantRequest) returns (Merchant)

更新由指定的集合商家管理的现有 Merchant,并将其返回。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking
UpdateService

rpc UpdateService(UpdateServiceRequest) returns (Service)

更新由指定的集合商家管理的商家的现有 Service,并将其返回。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking

ActionLinkType

与操作链接相关的预定操作类型。

枚举

ActionPlatform

用于指明在哪个平台上执行此操作。Web 应用是通用的后备平台。建议您至少拥有一个包含 ACTION_PLATFORM_WEB_APPLICATION 的 ActionLink。如果链接将 Android 和 iOS 作为平台,该链接仅适用于对应的系统。

枚举
ACTION_PLATFORM_UNSPECIFIED 平台未指定。
ACTION_PLATFORM_WEB_APPLICATION 通用操作平台为 Web 应用。
ACTION_PLATFORM_MOBILE_WEB 操作平台为移动设备上的 Web 应用。
ACTION_PLATFORM_ANDROID 操作平台为 Android 操作系统。
ACTION_PLATFORM_IOS 操作平台为 iOS 操作系统。

建议

通过“通过 Google 预订”功能预订时向用户显示的建议。

字段
text

Text

通过“通过 Google 预订”功能预订时向用户显示的自定义消息。

可用性

商家服务的可用性空档,用于表示时间和空档数。

字段
start_time

Timestamp

预约空档的开始时间。

duration

Duration

预约空档的持续时间

spots_total

int64

此可用性的总空档数和可用空档数。示例:

  • 瑜伽课有 10 个空档,其中 3 个已预订:availability {spots_total: 10, spots_open: 7 ...}
  • 按摩椅服务空档已订满:availability {spots_total: 1, spots_open: 0 ...}

注意:如果使用下面指定的可用性压缩格式发送请求,将推断出以下两个字段。

  • Recurrence 表示 spots_total=1spots_open=1
  • ScheduleException 表示 spots_total=1spots_open=0
spots_open

int64

空缺数量。

availability_tag

string

用于标识可用性空档的可选不透明字符串。如果设置,它将包含在预订/更新/取消预约的请求中。

resources

Resources

当服务中包含不同的工作人员或房间时,用于消除此可用性空档与其他空档之间的歧义的可选资源。

例如,同一瑜伽课程有 2 位老师:

availability { resources { staff_id: "1" staff_name: "Amy" }
               spots_total: 10 spots_open: 7 }
availability { resources { staff_id: "2" staff_name: "John" }
               spots_total: 5 spots_open: 2 }
payment_option_id[]

string

ID 列表,其中列出了可用于支付此空档费用的付款方式。实际的付款方式需在商家级别定义,且多个商家可共享付款方式。

该字段将替换服务消息中指定的任何 payment_option_ids。同样,此处指定的 payment_option_ids 无需在服务消息中显示,但必须在商家级别定义。

recurrence

Recurrence

可用性的重复周期信息,表示多个开始时间。重复周期应包含一个工作日的预约。

schedule_exception[]

ScheduleException

无法安排此服务的时间。如需限制 schedule_exception 消息的数量,请考虑合并相邻的例外情况。

deposit

Deposit

适用于此可用性的可选押金。如果指定了押金,则会替换在服务级别定义的押金。

no_show_fee

NoShowFee

适用于此可用性的可选违约金。如果指定了违约金,则会替换在服务级别定义的违约金。

require_credit_card

RequireCreditCard

表明用户是否必须提供信用卡信息才能预订此可用性空档。如果未设置该值,将从服务级别(如果已在该级别设置)继承。(可选)

ticket_type_id[]

string

表示此可用性空档支持的票券类型列表。如果未设置该值,则父级服务中的所有票券类型均适用于此空档。请注意,必须在父级服务中定义此字段的值。示例:

  • 具有四种票券类型的服务:TicketType {ticket_type_id: "adult_1" short_description: "Adult weekdays"} TicketType {ticket_type_id: "adult_2" short_description: "Adult weekends"} TicketType {ticket_type_id: "youth_1" short_description: "Youth weekdays"} TicketType {ticket_type_id: "youth_2" short_description: "Youth weekends"}

如需表示工作日期间的商品目录,请使用:availability {ticket_type_id: "adult_1" ticket_type_id: "youth_1"...}。如需表示节假日期间的商品目录,请使用:availability {ticket_type_id: "adult_2" ticket_type_id: "youth_2"...}

  • 具有三种票券类型的服务:TicketType {ticket_type_id: "adult" short_description: "Adult"} TicketType {ticket_type_id: "youth" short_description: "Youth"} TicketType {ticket_type_id: "senior" short_description: "Senior"}

如需表示这三种票券类型均适用于此时间空档,请使用 availability {ticket_type_id: "adult" ticket_type_id: "youth" ticket_type_id: "senior" ...} 或 `availability {...}'(请勿在此空档内设置 ticket_type_id)。

(可选)

duration_requirement

DurationRequirement

显示空档时长和/或结束时间的要求。如果空档不可用,系统将忽略此字段。不用于推荐活动类别。(可选)

scheduling_rule_overrides

SchedulingRuleOverrides

可用性时间安排规则。如果填充了字段,则这些字段将覆盖服务级 SchedulingRules 上任何相应的时间安排规则。

confirmation_mode

ConfirmationMode

表示预订此可用性时使用哪种确认模式。使用 CONFIRMATION_MODE_SYNCHRONOUS 的确认模式创建可用性的预订时,必须立即确认或拒绝。如果尝试使用 CONFIRMATION_MODE_ASYNCHRONOUS 的确认模式创建可用性的预订,则必须立即拒绝或创建状态为 PENDING 的预订。

ConfirmationMode

预订可用性时使用的确认模式。

枚举
CONFIRMATION_MODE_UNSPECIFIED 未指定确认模式。系统将进行同步确认。
CONFIRMATION_MODE_SYNCHRONOUS 系统将同步确认对此可用性的预订。
CONFIRMATION_MODE_ASYNCHRONOUS 系统将异步确认对此可用性的预订。

DurationRequirement

此枚举指明用户需满足哪些要求才能确认或查看所请求的空档时长/结束时间。

枚举
DURATION_REQUIREMENT_UNSPECIFIED 未指定结束时间的处理方法。这是默认值。
DO_NOT_SHOW_DURATION 系统不会向用户显示结束时间。
MUST_SHOW_DURATION 必须先向用户显示结束时间,然后才能进行预约。

周期性

重复周期消息是可选的,但允许以更紧凑的方式表示持续重复的可用性空档。它们通常表示一天的工作安排。其中,可使用 ScheduleException 消息来表示工作日内已预订/不可用的时间范围。

要求:

  1. 可用性空档或重复周期的扩展不得创建相同的空档。如果 ID、start_time、duration 和 resource 相匹配,则将相应空档视为相同的空档。
  2. 请勿在单个服务的空档内将标准的可用性格式与重复周期混合使用。重复周期更适合提供预约的商家/服务。标准格式适用于定期安排课程的商家/服务。
  3. 重复周期不得超过 24 小时。
字段
repeat_until

Timestamp

可用性重复截止时间的时间戳,需包含最大时间单位的世界协调时间 (UTC)。

repeat_every

Duration

定义连续可用性空档之间的时间。

示例:一个可用性的 duration 为 20 分钟、repeat_every 为 30 分钟、start_time 为上午 9:00、repeat_until 为上午 11:00,该可用性将在上午 9:00-9:20、上午 9:30-9:50、上午 10:00-10:20、上午 10:30-10:50 和上午 11:00-11:20 生成空档。(必填)

ScheduleException

ScheduleException 消息表示工作日内已预订/不可用的时间范围,它是上述重复周期的例外情况。时间空档被预订后,应更新例外情况列表,以反映新的不可用的时间范围。不应修改重复周期本身。

字段
time_range

TimeRange

例外情况的时间范围。由重复周期描述且与此已打烊-营业中时间范围重叠的任何空档都将被视为不可用。

示例:如果重复周期指定时长为 20 分钟、repeat_every 为 30 分钟、start_time 为上午 9:00 且 repeat_until 为上午 11:00,则 time_range 为上午 9:45-11:00 的 ScheduleException 会使上午 9:30-9:50、上午 10-10:20 和上午 10:30-10:50 的空档不可用。

请注意,由于时间范围为已打烊-营业中,因此,从上午 11 点开始的空档不会受到影响。

SchedulingRuleOverrides

可用性级别时间安排规则。

字段
last_bookable_sec

int64

可预订此空档的最后时间(以秒为单位)。此时间戳必须在空档的 start_sec 之前(如需支持用户在开始时间后进行预订,请使用服务级 SchedulingRules.min_booking_before_end_time)。如果存在,则将覆盖相应服务的 SchedulingRules 的 min_booking_buffer 中任何指定的内容。

first_bookable_sec

int64

能够预订此空档的最早时间(以秒为单位)。此时间戳必须在空档的 start_sec 或 last_bookable_sec(如果指定)之前。

last_online_cancellable_sec

int64

如果设置,则可通过“通过 Google 预订”取消此特定预约空档的最后时间(以自 Unix 纪元以来的秒数表示)。此字段将覆盖任何服务级别的取消规则。(可选)

BatchDeleteGenericRecordsRequest

用于删除指定 Feed 类型的记录的批量请求。

字段
parent

string

资源名称,格式为 partners/{partner_id}/feeds/{feed_name}

records[]

GenericDeleteRecord

要删除的记录。一个 API 调用中最多允许 1000 条记录。

BatchPushGenericRecordRequest

用于插入和/或更新请求网址中指定的 Feed 类型的记录的批量请求。

字段
parent

string

资源名称,格式为 partners/{partner_id}/feeds/{feed_name}

records[]

GenericRecord

要插入和/或更新的记录。一个 API 调用中最多允许 1000 条记录。

BatchReplaceServiceAvailabilityRequest

用于替换多个 Service 的可用性空档的批量请求。

字段
parent

string

格式为 partners/{partner_id}

extended_service_availability[]

ExtendedServiceAvailability

扩展的服务可用性,用于替换现有可用性空档。

BatchReplaceServiceAvailabilityResponse

用于替换多个 Service 的可用性空档的批量响应。此消息仅包含成功更新的空档

字段
extended_service_availability[]

ExtendedServiceAvailability

成功更新的已扩展服务可用性消息,用于替换现有可用性空档。

预订

对商品目录空档的预订

字段
name

string

预订的资源名称:partners/{partner ID}/bookings/{booking ID}

merchant_id

string

空档的商家 ID

service_id

string

商家服务的 ID

start_time

Timestamp

预约空档的开始时间

duration

Duration

预约空档的持续时间

client_information

ClientInformation

进行预约的客户的个人信息

status

BookingStatus

预订状态

payment_information

PaymentInformation

与预订相关的付款交易信息。

party_size

int64

预订的就餐人数

BookingFailure

用于说明异步预订处理失败的原因的状态数据。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 处理付款时出现错误,因为商家不接受所提供的信用卡类型。信用卡类型必须在 rejected_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 视为当前的失败原因。

PaymentFailureInformation

与付款失败相关的信息。

字段
threeds1_parameters

ThreeDS1Parameters

供 RwG 集合商家用以启动 3DS1 用户身份验证协议的参数。除非 BookingFailure.cause 设置为 PAYMENT_REQUIRES_3DS1,否则系统会忽略此参数。

ThreeDS1Parameters

请求 RwG 执行 3DS1 挑战的参数。

这些参数由 EMVCo 对 3DS1 协议的说明设置。

字段
acs_url

string

可加载供用户进行身份验证的表单的网址。

pa_req

string

PaymentAuthentication 请求。将发布到 ACSUrl 表单(如果提供)。

transaction_id

string

ACS 提供商所用的标识符。将发布到 ACSUrl 表单(如果提供)。

md_merchant_data

string

商家数据。将发布到 ACSUrl 表单(如果提供)。

BookingStatus

预订状态

枚举
BOOKING_STATUS_UNSPECIFIED 未指定。
CONFIRMED 预订已确认
PENDING_MERCHANT_CONFIRMATION 预订正在等待商家确认,经商家确认后才能转为“已确认”状态(目前尚不支持)
PENDING_CLIENT_CONFIRMATION 预订正在等待客户确认,经客户确认后才能转为“已确认”状态(目前尚不支持)
CANCELED 已代表用户取消预订。
NO_SHOW 客户未按时赴约
NO_SHOW_PENALIZED 客户未按时赴约,违反了取消政策。
FAILED 预订操作处理失败,无法完成预订。
DECLINED_BY_MERCHANT 预订被商家异步拒绝。

CallMerchant

要在 UnsupportedPartySizeOption 中使用的空白消息,设置此选项后,系统会向用户显示致电商家进行预订的选项。

CancellationPolicy

服务的取消政策。

字段
refund_condition[]

RefundCondition

适用于政策的零或多个退款条件。

RefundCondition

指定单个退款条件。您可使用多个退款条件来描述服务开始时间前各个时段的“退款步骤”。

字段
min_duration_before_start_time

Duration

服务开始前的时段,在该时间范围内取消预订的客户可以收到有关 refund_percent 中指定的部分服务费用的退款。如果将该字段设置为 0(默认值),用户将可随时取消相应服务。

refund_percent

uint32

只要在服务开始时间前至少 min_duration_before_start_time 取消预订,将退还的服务费用百分比,值的范围为 [0, 100]。将该字段设置为 0(默认值)表示相应服务不支持退款。如果设置为 100,则该服务可全额退款。

ClientInformation

预订者的个人信息

字段
given_name

string

客户的名字

family_name

string

客户的姓氏

address

PostalAddress

客户的地址

telephone

string

客户的电话号码

email

string

客户的电子邮件地址

CreateMerchantRequest

创建 Merchant 的请求。

字段
parent

string

拥有此商家的合作伙伴的父级资源名称,格式为 partners/{partner_id}

merchant_id

string

要用于此商家的商家 ID。

merchant

Merchant

要创建的商家。

CreateServiceRequest

创建新 Service 的请求。

字段
parent

string

拥有此服务的商家的父级资源名称,格式为 partners/{partner_id}/merchants/{merchant_id}

service_id

string

要用于此服务的服务 ID。

service

Service

要创建的服务。

CreditCardRestrictions

对此商家所接受的信用卡类型的限制。

字段
credit_card_type[]

CreditCardType

受支持的信用卡列表。留空表示不支持任何信用卡。

CreditCardType

信用卡类型。

枚举
CREDIT_CARD_TYPE_UNSPECIFIED 未使用。
VISA Visa 信用卡。
MASTERCARD Mastercard 信用卡。
AMERICAN_EXPRESS 美国运通信用卡。
DISCOVER Discover 信用卡。
JCB JCB 信用卡。

DeleteMerchantRequest

用于删除 Merchant 的请求。

字段
name

string

要删除的商家的资源名称。格式为:partners/{partner_id}/merchants/{merchant_id}

DeleteServiceRequest

用于删除 Service 的请求。

字段
name

string

要删除的服务的资源名称。格式为 partners/{partner_id}/merchants/{merchant_id}/services/{service_id}

押金

一种保证金,可直接向用户收取,也可冻结用户信用卡中的部分额度。

字段
deposit

Price

存款金额。

min_advance_cancellation_sec

int64

至少需要提前多久取消预订才会退回押金。

deposit_type

PriceType

定义如何根据可用性确定押金。

DirectMerchantPayment

有关用户如何直接向商家付款而不是通过 RwG 预付款的信息。

字段
payment_methods[]

Text

我们会建议用户仅通过下列付款方式付款。

DurationRange

时长范围的封装容器,可以是有界限的,也可以是无界限的。至少需要 min_duration 和 max_duration 时长之一。

字段
min_duration

Duration

时长下限。

max_duration

Duration

时长上限。

ExtendedServiceAvailability

可用性列表及其所适用的人员或时间。

字段
merchant_id

string

这是必填字段,用于指定以下可用性消息所属的商家。

service_id

string

这是必填字段,用于指定以下可用性消息所属的服务。

start_time_restrict

Timestamp

如果提供,我们会将提供的可用性实体视为 [start_time_restrict, end_time_restrict] 的完整概况。也就是说,如果符合以下条件,系统将会删除所有现有的可用性:

   start_time_restrict <= availability.start_sec &&
   availability.start_sec < end_time_restrict

如果设置了 duration 消息,系统会进一步对条件进行限制:

  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

新的可用性列表。

FeedStatistics

处理已上传的 Feed 时获取的统计信息。

字段
new_items

int64

此 Feed 新添加的项。内容可以是商家、服务或可用性空档,具体取决于 Feed 的类型。

existing_items

int64

现有项,根据需要根据 Feed 中的较新信息进行更新。

deleted_items

int64

此 Feed 中已不存在的商品,并因此而被移除。

FeedStatus

集合商家的平台所上传 Feed 的状态。

字段
name

string

Feed 资源的名称,格式为

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

State

此 Feed 的处理状态。

error_details

string

如果我们无法处理此 Feed,人类可读的字符串用于提供更多详细信息。

statistics

FeedStatistics

特定于此 Feed 的统计信息。

用于表示 Feed 处理状态的枚举。

枚举
STATE_UNSPECIFIED 默认值。未使用。
IN_PROGRESS Feed 仍在处理中。
SUCCESS Feed 已成功处理。
FAILURE 处理 Feed 时遇到错误。

FoodOrderingMetadata

订餐操作链接的元数据。

字段
fee_details[]

FeeDetails

在商品总金额的基础上向用户收取的费用的详细信息。针对不同类型的费用(例如服务费、配送费等)重复。

advance_order_details

AdvanceOrderDetails

有关高级订购支持(也称为提前下单)的详细信息,该功能允许用户在晚于当前时间下单履单。

联合字段 fulfillment_duration_options。订单确认后的履单时长。对于送餐订单,此属性是指距离送餐完毕的时长。对于自提订单,指的是可供自提的食品等待时间。fulfillment_duration_options 只能是下列其中一项:
fulfillment_lead_time_duration

Duration

固定时长。例如:30 分钟。

fulfillment_lead_time_duration_range

DurationRange

时长范围。示例:* 30 分钟至 45 分钟 * 超过 30 分钟 * 少于 50 分钟

AdvanceOrderDetails

用于提前下单支持。

字段
is_supported

bool

如果支持提前订单(也称为提前下单),则为 True。(必填)

FeeDetails

费用详情。

字段
type

FeeType

费用类型。(必填)

fee_amount

FeeAmount

以单位货币和/或购物车价值百分比表示的费用金额。(必填)

FeeAmount

FeeAmount 示例:* 固定费用:0 美元(免费)、1.5 美元 * 固定费用的范围:1.0 美元(最低)、3.0 美元(最高)、5.0-6.0 美元 * 购物车内商品数量的比例:15.5%、10%-20%、10%(最高)、15%(最高)* 25% 的比例和百分比组合2.5 美元(最低),25.5% 和4.5 美元(最高),10% 和1.5-2.5 美元、10.5%-20% 和2.5-3.5 美元

字段
cart_percentage

QuantitativeValue

以购物车价值百分比表示的费用。支持范围(有界限和无界限)或固定百分比。值应介于 0 到 100 之间。例如:* 固定 5.5% * 至少为 5.5% * 最大为 5.5% * 4.5% 至 5.5%

联合字段 amount_options。用于指定货币金额的选项。amount_options 只能是下列其中一项:
amount

Money

固定金额。例如 USD 3.5。

amount_range

MoneyRange

金额范围。示例:* 3.5 美元 - 5.5 美元 * 最低 3.5 美元 * 最高 5.5 美元

amount_unknown

bool

未知金额。

FeeType

费用类型。

枚举
FEE_TYPE_UNSPECIFIED 未指定费用类型。
DELIVERY 运费。
SERVICE 服务费。

FulfillmentOption

在线订单操作的履单选项。

字段
fulfillment_type

FulfillmentType

必需。履单类型。

available_day[]

AvailableDay

必需。此履单方法有货的日期列表(最好提供至少 2 天)。

fee_details

FeeDetails

必需。履单方法的费用详情。

minimum_order

Price

必需。与操作链接关联的 fulfillment 方法的最低顺序。

AvailableDay

天级可用性。

字段
fulfillment_date

Date

必需。履单方法的可用日期。假定采用商家所在的时区。

last_ordering_time

Timestamp

必需。Unix 时间戳。用户上次可在 fulfillment_date之前订购和接收商品的时间。换句话说,在 last_ordering_time 之后,fulfillment_date 将不再显示为可用。

例如,如果 fulfillment_date 为 2020-08-10: - last_ordering_time 值为 2020-08-10 18:00,则表示客户必须在当天下午 6 点之前下单,才能在 2020 年 8 月 10 日收到订单。如果 last_ordering_time 值为 2020-08-08 20:00,则表示客户必须在两天前 8 点之前下单,才能在 2020 年 8 月 10 日收到订单。

FeeDetails

与操作链接关联的履单方法的费用详情。

字段
联合字段 fee_details。履单方法的费用模式。fee_details 只能是下列其中一项:
no_fee

NoFee

履单方法免费。

base_fee

MinimumFee

与履单方法相关的基本费用。

fixed_fee

FixedFee

与履单方法相关的固定费用。

FixedFee

与操作链接关联的履单方法所需的固定费用。

字段
amount

Price

必需。履单方法的固定费用金额。

FulfillmentType

与操作链接关联的执行方式类型。

枚举
FULFILLMENT_TYPE_UNSPECIFIED 未指定履单类型。
FULFILLMENT_TYPE_DELIVERY 履单类型为配送。
FULFILLMENT_TYPE_PICKUP 履单类型为“提货”。

MinimumFee

与操作链接关联的履单方法所需的最低费用。

字段
base_fee_amount

Price

必需。履单方法的基本费用金额。

NoFee

与操作链接关联的履单方法无需付费。

GenericDeleteRecord

将要删除的记录(网址请求中提到的 Feed 类型)。

字段
delete_time

Timestamp

必需。此时间戳用于确定对广告资源应用删除操作的顺序。

联合字段 record_type。封装不同类型的 Feed(ndjson、基于 proto 等)合作伙伴可以提供完整记录,类似于在 Feed 或 BatchPush API 中提供记录的方式。合作伙伴也可以选择只包括对记录进行唯一标识所需的必要字段。record_type 只能是下列其中一项:
data_record

bytes

适用于并非基于 proto 的 Feed。

proto_record

Any

适用于基于 proto 的 Feed。

GenericRecord

网址请求中提及的 Feed 类型的记录。

字段
generation_timestamp

Timestamp

必需。此时间戳用于确保商品目录更新按正确的顺序排列。

联合字段 record_type。封装不同类型的 Feed(ndjson、基于 proto 等)record_type 只能是下列其中一项:
data_record

bytes

适用于并非基于 proto 的 Feed。

proto_record

Any

适用于基于 proto 的 Feed。

GeoCoordinates

某一地点的地理位置数据,包括纬度、经度和地址。

字段
latitude

double

纬度(以度为单位)。(可选)

longitude

double

经度(以度为单位)。(可选)

联合字段 addresses。某一地点的地址,可以是结构化或非结构化地址。addresses 只能是下列其中一项:
address

PostalAddress

营业地点的邮政地址(首选)。

unstructured_address

string

非结构化地址也可用作备用地址。例如:“北京市海淀区中关村东路 1 号院”

GetMerchantStatusRequest

获取 MerchantStatus 的请求

字段
name

string

必需。资源名称,格式为:partners/{partner_id}/merchants/{merchant_id}/status。

GetStatusRequest

用于检索集合商家平台所上传特定 Feed 的 Status 的请求。

字段
name

string

Feed 资源的名称,格式为

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

HomeServiceData

需要提供针对家政服务行业的其他信息。

字段
category_type

string

此家政服务所属的高级类别。例如:管道工、电工等

job_type

string

给定家政服务所属类别下的职位类型。例如:unclog_drain 和 install_faucet 是“管道工”类别下的作业类型。

IntegrationType

支持的集成深度。

枚举
INTEGRATION_TYPE_UNSPECIFIED 默认为 END_TO_END。
INTEGRATION_TYPE_END_TO_END 允许通过 Google 进行端到端预订的完整集成。
INTEGRATION_TYPE_INVENTORY_ONLY 预订服务器无需支持此服务。只需发送商家、服务和(可选)可用性数据。

InvalidateResourceRequest

请求使资源失效。

字段
resource_id

string

要使资源失效的资源的名称。

例如,对于自提资源,名称应采用 partners/{partner_id}/pickups/{pickup_id} 格式。实现必须移除已识别资源的缓存版本。

LineItem

订单中的单个项 - 在单个时间空档内预订的单项服务。

字段
service_id

string

商家服务的 ID。

start_sec

int64

预约空档的开始时间,以自 Unix 纪元以来的世界协调时间(以秒为单位)表示。

duration_sec

int64

预约空档的时长(以秒为单位)。

tickets[]

OrderedTickets

按票券类型订购的票券数量。

price

Price

此订单项的总价格(不含税)。

status

BookingStatus

订单项的状态。

OrderedTickets

按票券类型订购的票券数量。

字段
ticket_id

string

票券类型的 ID。

count

int32

订购的此类门票的数量。

ListMerchantStatusesRequest

获取 MerchantStatus 列表的请求

字段
parent

string

必需。拥有此商家状态集合的父级。格式:partners/{partner_id}/merchants

page_size

int32

必需。需要返回的最大项数。 请注意,服务器可能会缩减页面大小。

page_token

string

可选。从上一个 ListMerchantStatusResponse 返回的 nextPageToken 值(如果有)。

booking_inventory_status_restrict

BookingInventoryStatus

可选。按预订商品目录状态过滤结果的可选限制。

waitlist_inventory_status_restrict

WaitlistInventoryStatus

可选。用于按候位名单商品目录状态过滤结果的可选限制。

geo_match_restrict

GeoMatchingStatus

可选。按地理位置匹配状态过滤结果的可选限制。

BookingInventoryStatus

端到端预订商品目录状态。

枚举
BOOKING_INVENTORY_STATUS_UNSPECIFIED 未指定。
NO_VALID_FUTURE_INVENTORY 商家在接下来的 30 天内没有预订商品目录。
HAS_VALID_FUTURE_INVENTORY 商家可在接下来的 30 天内预订商品目录。

GeoMatchingStatus

商家地理位置匹配状态。

枚举
GEO_MATCHING_STATUS_UNSPECIFIED 未指定。
GEO_UNMATCHED 商家的地理位置不匹配。
GEO_MATCHED 商家地理位置匹配。

WaitlistInventoryStatus

端到端等候名单商品目录状态。

枚举
WAITLIST_INVENTORY_STATUS_UNSPECIFIED 未指定。
NO_VALID_WAITLIST_SERVICE 商家没有支持加入等候名单的服务。
HAS_VALID_WAITLIST_SERVICE 商家提供支持等候名单的服务。

ListMerchantStatusesResponse

对列表 MerchantStatus 的响应。

字段
merchant_statuses[]

MerchantStatus

满足过滤条件的商家状态的列表。

next_page_token

string

用于检索下一页结果的令牌。如果为空,则列表中无其他结果。

ListStatusRequest

用于检索集合商家平台上传的多个 Feed 的 Status 的请求。

字段
name

string

Feed 资源的名称,格式为

  • partners/{partner_id}/feeds/merchants
  • partners/{partner_id}/feeds/services
  • partners/{partner_id}/feeds/availability
page_size

int32

需要返回的最大项数。

page_token

string

从上一个 List 请求返回的 next_page_token 值(如果有)。

state_restrict

State

用于按 Feed 状态过滤结果的可选限制。

time_range_restrict

TimeRange

用于按上限和下限过滤结果的可选限制。如果未设置 start_time,则默认以 UNIX 时间为开始时间。如果未设置 end_time,则默认为现在。

ListStatusResponse

用于检索集合商家平台上传的多个 Feed 的 Status 的请求。

字段
status[]

FeedStatus

按时间倒序排列的已上传 Feed 的状态列表。返回的最大项数取决于请求中的 page_size 字段。

next_page_token

string

用于检索下一页结果的令牌。如果为空,则列表中无其他结果。

LocalizedString

某一语言区域的字符串示例。

字段
locale

string

IETF BCP 47 语言代码,例如 en、mas、zh-Hant、de-CH-1901。请参阅 http://www.w3.org/International/articles/language-tags/

value

string

采用上述语言区域的消息 (UTF-8)。

位置

某个地点的地理位置信息。

字段
place_id

string

Google Places 数据库中和 Google 地图上某个地点的地点 ID。如需详细了解地点 ID,请参阅 https://developers.google.com/places/web-service/place-id。如果提供,Google 会将营业地点与此地点进行匹配。

name

string

营业地点的名称、电话、网址和地理位置用于将营业地点与 Google 地图上已有的地点进行匹配。

此字段是可选的,但在某些情况下可能是必需的。例如,没有名称的 Service.location 不会与商家实体匹配,即使这两个实体位于同一地址也是如此。(可选)

telephone

string

包含国家/地区代码的营业地点公开电话号码,例如 +14567891234。 (可选)

url

string

营业地点公共网站的网址。(可选)

geo

GeoCoordinates

营业地点的地理位置信息,包括纬度、经度和地址。(可选)

location_type

LocationType

如果为服务提供了此营业地点,则必须提供该营业地点的类型。

location_id

string

服务中对营业地点的唯一引用。此 ID 可用于在其他服务字段中引用此营业地点。例如:在自定义信息录入表单中,可以使用一组营业地点 ID 来指定自提地点选项。如果已设置,此 ID 在同一服务中应具有唯一性。(可选)

LocationType

营业地点的类型。

枚举
LOCATION_TYPE_UNSPECIFIED 未指定营业地点的类型。
VISITED_LOCATION 提供服务的地点。
START_LOCATION 服务开始时的地点,也作为 MEETING_LOCATION。
END_LOCATION 服务结束时的地点。

商家

集合商家平台上的某个商家的相关信息。

字段
name

string

商家资源名称,格式为 partners/{partner_id}/merchants/{merchant_id}

merchant_name

string

merchant_name、telephone、url 和 geo 用于将合作伙伴商品目录与 Google 地图上已有的商家进行匹配。此信息不会显示。

商家的名称。

telephone

string

商家的公开电话号码(包括国家/地区代码和区号),例如+14567891234。

url

string

商家公开网站的网址。

geo

GeoCoordinates

商家的地理位置信息,包括纬度、经度和地址。

category

string

集合商家平台中商家的类别。

num_bookings_30d
(deprecated)

int64

该字段已弃用。

tax_rate_basis_points
(deprecated)

uint32

商家的税率(以 0.01% 为基准点)。例如,如果税率为 7.5%,应将该字段设置为 750。

如果未设置或将该字段设置为 0,对于由此商家提供的任何服务,向用户收取的总费用为 Service.price 所指定的确切价格。该服务价格被视为无需缴纳税费或已包含适用税费。系统不会将税费作为单独的订单项向用户显示。

如果将该字段设置为任何非零值,对于由此商家提供的任何服务,向用户收取的总费用将包含服务价格以及使用此处提供的税率计算得出的税费。最小货币单位的小数部分(例如,1 美分的小数部分)将四舍五入为最接近的偶数。系统会将税费作为单独的订单项向用户显示。

此字段已弃用,请改用 tax_rate。

tax_rate

TaxRate

商家的税率。如果存在该字段,该字段将替换已弃用的 tax_rate_basis_points 字段。空白消息(即 tax_rate { })会将适用税率重置为零。

payment_restrictions

PaymentRestrictions

对此商家所接受付款方式的限制。如果未设置此字段,则假定不存在任何限制。

payment_option[]

PaymentOption

此商家所支持的付款方式。此商家的服务将能够单独限制其允许的付款方式。

payment_processor_config
(deprecated)

PaymentProcessorConfig

适用于令牌化付款处理方的配置(如果商家支持)。

tokenization_config

TokenizationConfig

适用于令牌化付款处理方的配置(如果商家支持)。

terms

Terms

特定商家的条款及条件,在用户使用“通过 Google 预订”功能预订服务时显示。此外,这些集合商家合作伙伴的条款及条件会始终向用户显示,且不得在此处提供。

brand_id

string

不透明的字符串,用于在显示合作伙伴属性时标识面向消费者的品牌。此字段允许拥有多个面向消费者的品牌的合作伙伴在同一 Feed 中提供所有品牌的商家。

品牌由面向消费者的属性(例如名称、徽标、服务条款及隐私权政策)组成。

如果只有一个面向消费者的合作伙伴品牌,则无需设置该字段,且可将其忽略。

如果合作伙伴…

没有多个面向消费者的品牌?--> 请忽略此字段

配置了多个品牌?

  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

请注意,大多数合作伙伴都不需要设置该字段。如果合作伙伴要使用该字段,必须先与我们联系以配置单独的品牌(包括默认品牌)。

matching_hints

MerchantMatchingHints

可帮助 Google 将商家与 Google 地图上的地点进行匹配的提示。请注意:大多数合作伙伴都不需要设置该字段,因为 Google 会使用上述信息将商家与 Google 地图上的地点进行匹配。(可选)

service_attribute[]

ServiceAttribute

用于描述此商家的服务的任何服务属性的定义。(可选)

waitlist_advisement

Advisement

可选。特定商家针对通过“通过 Google 预订”加入等候名单的用户提供的一般建议。建议中各个文本字段的长度应限制为 100 个字节。

MerchantMatchingHints

可帮助 Google 将商家与 Google 地图上的地点进行匹配的技巧。

字段
place_id

string

Google Places 数据库中和 Google 地图上某个地点的地点 ID。如需详细了解地点 ID,请参阅 https://developers.google.com/places/web-service/place-id

MerchantStatus

商家在“通过 Google 预订”平台中的状态。

字段
name

string

商家状态资源名称,格式为 partners/{partner_id}/merchants/{merchant_id}/status

merchant_name

string

合作伙伴提供的商家名称。

input_geo_info

GeoCoordinates

合作伙伴提供了商家的地理位置信息。

processing_status

ProcessingStatus

商家处理状态。

booking_status

BookingStatus

与端到端预订集成相关的状态。

waitlist_status

WaitlistStatus

与候位名单集成相关的状态。

geo_match

PlaceInfo

此商家的匹配地理位置信息。如果商家与地理位置不匹配,则为空。

local_services_match

LocalServicesMatchInfo

此商家的本地生活服务广告匹配项。如果不是本地服务商家或与任何提供商都不匹配,则为空。

direct_urls[]

DirectUrl

一个网址列表,演示当前商家商品目录的内容。请注意,这并不意味着广告资源实际上处于投放状态,网址可能与公开显示的网址不同。

BookingStatus

与端到端预订集成相关的状态。

字段
has_valid_future_inventory

bool

如果商家在接下来的 30 天内有商品目录,则为“true”。并不保证商家实际会得到投放。

DirectUrl

显示商家的网址。

字段
type

UrlType

此网址的类型。

url

string

可能会显示此商家的网址。

UrlType

显示的网址的类型。

枚举
URL_TYPE_UNSPECIFIED 未指定。
BOOKING 端到端预订网址。
WAITLIST 端到端候位名单网址。
LOCAL_SERVICES Google 本地生活服务网址。

LocalServicesMatchInfo

Google 本地生活服务信息匹配(仅适用于本地生活服务商家)。

字段
matched_providers[]

MatchedProvider

匹配的服务提供商。一个商家可以与多个服务提供商相匹配。

MatchedProvider

本地服务提供商。

字段
customer_id

int64

Google 本地生活服务外部客户 ID。

categories[]

string

本地生活服务类别(行业)。例如:“管道工”和“carpet_cleaning”

PlaceInfo

匹配地点的信息。

字段
name

string

地点的名称。

formatted_address

string

以当地语言显示的格式化地址。

place_id

string

此地点的 Google 地点 ID。可用于构建 Google 地图网址或提取地点的更多详细信息。如需查看用法示例,请参阅 https://developers.google.com/places/web-service/place-id

ProcessingStatus

商家处理状态。

枚举
PROCESSING_STATUS_UNSPECIFIED 状态不明。
IN_PROGRESS Madden 已收到商家,但仍在处理中。处于此状态的商家不会填充其他状态。
COMPLETED 已计算商家的其他状态。

WaitlistStatus

与候位名单集成相关的状态。

字段
has_valid_waitlist_service

bool

如果商家提供候位名单服务,则为 true。并不保证商家实际会得到投放。

MoneyRange

金额范围的封装容器,可以是有界限或无界限的。至少需要指定 min_amount 和 max_amount 中的一个。

字段
min_amount

Money

最低金额。

max_amount

Money

最高金额。

NoShowFee

已预订的用户未按时赴约时向其收取的费用。

字段
fee

Price

用户未按时赴约时向其收取的费用金额。

fee_type

PriceType

定义如何根据可用性确定费用。

订单

向商家提交的服务预约订单。

字段
name

string

订单的资源名称:partners/{partner ID}/orders/{order ID}

client_information

ClientInformation

下单客户的个人信息。

payment_information

PaymentInformation

与订单相关的付款交易信息。

merchant_id

string

此订单中所有服务所属的商家的 ID。

item[]

LineItem

此订单中的订单项。

OrderOnlineMetadata

在线订单操作链接的元数据。

字段
fulfillment_option[]

FulfillmentOption

在线订单操作链接的可用履单选项。

PaymentInformation

与预订相关的付款明细

字段
prepayment_status

PrepaymentStatus

预订的预付款状态。如果 prepayment_status 为 PREPAYMENT_PROVIDED 或 PREPAYMENT_REFUNDED,则 payment_transaction_id 包含相关联的唯一交易 ID。

payment_transaction_id

string

与预订关联的付款交易的唯一标识符。如果不适用,则为空。

PaymentOption

付款方式,可用于支付商家所提供服务的费用。多个商家(例如同一连锁品牌的商家)可共用同一付款方式。

字段
payment_option_id

string

此 ID 用于标识此付款方式。

此 ID 适用于所有集合商家,而且如果多个商家重复使用同一个值,则可允许用户在向这些商家付款时都可以使用相应的付款方式。

当多个商家重复使用某个 ID 时,更新某个商家所接受付款方式的任何值后,其他商家使用相同 ID 所标识的付款方式也会一并更新。因此,最好为所有付款方式使用同一 ID,并始终将其更新为相同的值,避免出现非确定性行为。

name

string

付款方式的名称。此信息可向用户显示。

description

string

付款方式的说明。此信息可向用户显示。

price

Price

付款方式的价格。

tax_rate

TaxRate

此付款方式的税率。如果存在该字段,该字段将替换商家或服务中显示的 tax_rate 字段。空白消息(即 tax_rate { })会将适用税率重置为零。

payment_option_type

PaymentOptionType

此付款方式的类型。针对临时用户可一次性使用,对套餐可多次使用,对会员而言则无限制。

session_count

int64

此付款方式可用于多少次会话。仅适用于多会话 / 套餐,其值应为 >1.

purchase_interval

TimeRange

可在此时间范围内购买付款方式。

valid_interval

TimeRange

可在此时间范围内使用付款方式(例如,2017 年 1 月特惠价格)。如果存在,此字段将替换 valid_duration 和 activate_type。

valid_duration

Duration

付款方式的有效期限(例如 30 天的会员资格有效期)。

activation_type

ActivationType

定义如何确定此付款方式的有效开始日期。

user_restriction

UserPurchaseRestriction

有资格购买此付款方式的用户需满足的限制条件。可用于将促销付款方式的限制为部分用户。如果未设置,则所有用户均符合条件。

ActivationType

定义如何确定有效期的开始日期。

枚举
ACTIVATION_TYPE_UNSPECIFIED 未使用。
ACTIVATION_ON_PURCHASE 自购买时开始生效。
ACTIVATION_ON_FIRST_USE 自首次使用付款方式时开始生效。

PaymentOptionType

付款方式的类型。

枚举
PAYMENT_OPTION_TYPE_UNSPECIFIED 未使用。
PAYMENT_OPTION_SINGLE_USE 付款方式只能使用一次。
PAYMENT_OPTION_MULTI_USE 当付款方式的会话数大于 0 时,便可以使用相应付款方式。
PAYMENT_OPTION_UNLIMITED 付款方式可在其有效的时间范围内使用(会话数不适用)。

PaymentProcessorConfig

按商家设置的付款处理方配置。

字段
processor

Processor

指定此配置所适用的付款处理方合作伙伴。

public_key

string

用于通过付款处理方识别此商家的密钥。

如需了解 Stripe,请访问 https://stripe.com/docs/dashboard#api-keys。如需了解 Braintree,请访问 https://articles.braintreepayments.com/control-panel/important-gateway-credentials

version

string

随付款请求一起发送给付款处理方的 API 版本号。

处理器

定义特定的付款处理方合作伙伴。

枚举
PROCESSOR_UNSPECIFIED 未使用
PROCESSOR_STRIPE 适用于 Stripe 付款方式的配置。
PROCESSOR_BRAINTREE 适用于 Braintree 付款方式的配置。

PaymentRestrictions

对此商家所接受付款方式的限制。

字段
credit_card_restrictions

CreditCardRestrictions

对此商家所接受的信用卡的限制。如果未设置该字段,我们会默认接受所有信用卡。请注意,CreditCardType 支持的卡的列表会不断增加,这意味着如果留空,则相应配置需要适应将来的更改。

PerOrderFee

须为每笔订单支付的费用(无论票券的数量是多少)。

字段
delivery_fee

Price

可能因配送方式而异的费用。

processing_fee

Price

处理用户付款方式的费用。

PerTicketFee

用户购买每张票券时必须支付的费用。

字段
service_charge

Price

针对服务评估的额外费用。

facility_fee

Price

进入场馆/设施的费用。

taxes

Price

每张门票的税费。

PostalAddress

客户或商家的地址。

字段
address_country

string

国家/地区,使用其 ISO 3166-1 alpha-2 国家/地区代码指定,例如“US”(必填)

address_locality

string

市行政区(例如“秦淮区”)。(必填)

address_region

string

地区(例如“南京市”)。只有在地区通常是地址的一部分的国家/地区才需要填写此字段。(可选)

postal_code

string

邮政编码,例如“210006”。(必填)

street_address

string

街道地址(例如“中山南路 1 号”)。(必填)

PrepaymentStatus

预订的预付款状态。

枚举
PREPAYMENT_STATUS_UNSPECIFIED 未指定,默认为 PREPAYMENT_NOT_PROVIDED。
PREPAYMENT_PROVIDED 预订费用已提前支付。
PREPAYMENT_NOT_PROVIDED 预订费用未提前支付。
PREPAYMENT_REFUNDED 费用原为 PREPAYMENT_PROVIDED,但已退款。

价格

服务的价格或所需费用。

字段
price_micros

int64

以微观的货币单位表示的价格。最小货币单位的小数部分将四舍五入为最接近的偶数。(例如,2.5 美分四舍五入为 2 美分,3.5 美分四舍五入为 4 美分,0.5 美分四舍五入为 0 美分,2.51 美分四舍五入为 3 美分)。

currency_code

string

ISO 4217 中定义的货币价格。

pricing_option_tag

string

可选且不透明的字符串,用于标识与扩展价格关联的定价选项。

PriceInterpretation

说明价格的解析方式和面向用户显示的方式。

枚举
PRICE_INTERPRETATION_UNSPECIFIED 未指定价格解析方式,默认为 EXACT_AMOUNT。
EXACT_AMOUNT

应将价格解析为特定值时。

例如:瑜伽课一节 20 元;儿童理发一次 15 元

STARTS_AT

服务的价格不固定,但最低价格已知且向消费者显示价格时。价格可能会因消费者的选择而变高。

请注意,使用 PriceInterpretation 的任何服务都必须使用 PrepaymentType NOT_SUPPORTED。

示例:狗狗美容 30 美元,但消费者的其他选择可能会使价格变高

NOT_DISPLAYED

服务的价格不固定且不提前向消费者显示价格信息时。

请注意,使用 PriceInterpretation 的任何服务都必须使用 PrepaymentType NOT_SUPPORTED,且价格必须为空。

示例:家政服务的相关咨询

PriceType

定义如何根据可用性确定总价。

枚举
FIXED_RATE_DEFAULT

价格为固定金额。如果未设置该字段,将使用默认值。

示例:预订餐位的押金为 50 元;瑜伽课的违约金为 20 元

PER_PERSON

指定的价格为每人的费用,总费用则是根据“资源”中指定的人数进行计算的,计算方法为 price_micros 乘以 party_size。PER_PERSON 价格必须与可用资源中的人数一同显示。如果未显示,则假设人数为 1。

示例:博物馆门票每张 10 元

QuantitativeValue

数值的封装容器,此值可以是范围或固定值。QuantitativeValue 示例:* 奇异值:value: 10.5 * 有边界范围:value_range {min_value: 5.5, max_value 10.5} * 下限:value_range {min_value: 5.5} * 上限:value_range {max_value: 10.5}

字段
联合字段 value_options。(必需)value_options 只能是下列其中一项:
value

double

奇异值。例如:5.6

value_range

RangeValue

也可以是开放式或有界限值的范围。例如:* 至少为 5.5 * 最多为 5.5 * 5.5 至 6.5

RangeValue

取值范围,使 min_value <max_value。至少需要 min_valuemax_value 中的一个。

字段
min_value

double

最小值。

max_value

double

最大值。

Rating

定义实体的评分。

字段
value

double

平均评分值(number_of_ratings > 0 时为必填项)。该值必须在 [1, 5] 的范围内,并且当且仅当 number_of_ratings 为零时才能省略。

number_of_ratings

uint64

计算此值时所用的评分数量(必填)。

RelatedMedia

与服务相关的图片。Google 会抓取这些媒体,用于确保面向最终用户正确显示。(可选)

字段
url

string

媒体来源的网址。Google 会抓取托管在此网址上的媒体。

type

MediaType

此媒体来源的类型。

localized_caption

Text

对支持国际化的媒体的说明,仅支持纯文本格式。所有 HTML 组件均会被删除。(可选)

attribution

Attribution

有关媒体来源的提供方信息。请注意,如果提供方信息需要与媒体一同显示,以便注明摄影师或代理机构,则必须设置该字段。(可选)

caption
(deprecated)

string

已弃用,建议使用 localized_caption。

提供方

媒体提供方的相关信息。

字段
localized_text

Text

用于注明支持国际化的摄影师或代理机构的文本。此文本将与源媒体一同显示。请注意,此字段仅支持纯文本,所有 HTML 组件都将被删除(基于超链接的提供方说明不受支持)。

text
(deprecated)

string

已弃用,建议使用 localized_text。

MediaType

用于指明媒体来源类型的枚举。仅支持图片格式。如需使用图片以外的其他媒体,请与“通过 Google 预订”团队联系。

枚举
TYPE_UNSPECIFIED 未使用。
PHOTO 表示网址所提供的媒体是图片。

ReplaceServiceAvailabilityRequest

用于替换 Service 的可用性的请求。

字段
service_availability

ServiceAvailability

用于替换现有服务的服务可用性。

RequireCreditCard

指定是否需要在预约时提供信用卡信息。

枚举
REQUIRE_CREDIT_CARD_UNSPECIFIED 未明确指定是否需要提供信用卡信息,且行为与为条件字段指定的行为相同。
REQUIRE_CREDIT_CARD_CONDITIONAL 如果满足以下任一条件,Google 将要求在预订时提供信用卡信息:* 库存具有价格,且 prepayment_type 为“必填”* 已设置 no_show_fee * 已设置“押金”字段。
REQUIRE_CREDIT_CARD_ALWAYS 无论其他字段的值为何,预订此库存时均须提供信用卡信息。

资源

当服务中包含不同的工作人员或房间时,此资源可用于消除这些可用性空档之间的歧义。如果同一服务和时间间隔的多个空档的资源不同,这些空档可共存。

字段
staff_id

string

提供服务的工作人员的可选 ID。此字段用于标识所有商家、服务和可用性记录中的工作人员。此外,考虑到需与之前的预订相关联,此字段需要随着时间的推移保持一致。如果存在 people_name,则必须提供此字段。

staff_name

string

提供服务的工作人员的可选姓名。办理预订的用户将看到此字段,该字段应该是用户可理解的内容,而非不透明的标识符。如果存在 people_id,则必须提供此字段。

room_id

string

服务所在房间的可选 ID。此字段用于标识所有商家、服务和可用性记录中的房间。此外,考虑到需与之前的预订相关联,此字段需要随着时间的推移保持一致。如果存在 room_name,则必须显示此字段。

room_name

string

服务所在房间的可选名称。办理预订的用户将看到此字段,该字段应该是用户可理解的内容,而非不透明的标识符。(可选,但如果存在 Room_id,则为必需属性)在用餐中,房间名称应仅用于休息区(例如酒吧或露台),而不应用于固定价格的菜单、特殊活动或任何其他非客房值(例如预订或晚餐)。强烈建议不要在默认休息区没有关联的会议室。

party_size

int32

仅适用于餐饮服务:此时间空档内可容纳的就餐人数。一家餐馆可以同时与多个空档相关联,每个空档可指定不同的 party_size,例如可预订 2 人、3 人或 4 人座位。

SchedulingRules

服务的时间表规则。

字段
min_advance_online_canceling

int64

网上取消预订应至少提前通知的时间(以秒为单位)。(可选)

late_cancellation_fee
(deprecated)

Price

在至少应提前通知的期限内取消时应支付的费用。

noshow_fee
(deprecated)

Price

未取消预订时应付的违约金。

admission_policy

AdmissionPolicy

适用于此服务的准入政策。如果未设置,默认为 TIME_STRICT。(可选)

cancellation_policy

CancellationPolicy

时间表规则取消政策。(对于推荐活动而言是必需的)

联合字段 min_booking_buffer。从上次预订时间到可用性空档开始或结束时间的时长(以秒为单位)。

如果已设置“min_advance_booking”,则最后可预订时间的计算方式为:(<空档开始时间> - "min_advance_booking")。如果已设置“min_booking_buffer_before_end_time”,则最后可预订时间的计算方式为:(<空档结束时间> - "min_booking_buffer_before_end_time")。请注意,如需设置“min_booking_buffer_before_end_time”时,必须将其设置为正值。如果两者均未设置,则在空档开始时间之前,相应空档可预订。如果同时设置了这两个字段,那么系统只会选择其中一个值,而忽略另一个值,也就是说,我们无法可靠地预测会选择哪个值。

示例:

  • 需要至少提前 1 个小时预约理发服务。“scheduling_rules{ min_advance_booking: 3600 ...}”

  • 最晚可在闭馆前 30 分钟购买博物馆门票:“scheduling_rules{ min_booking_buffer_before_end_time: 1800 ...}”

  • 需要在电影开始时间之前购买电影票。“scheduling_rules{ ...}”(请将此字段留空)(可选)min_booking_buffer 只能是以下其中一项:

min_advance_booking

int64

从上次预订时间到可用性空档开始时间的时长(以秒为单位)。

min_booking_buffer_before_end_time

int64

从上次预订时间到可用性空档结束时间的时长(以秒为单位)。如果设置了此字段,则“admission_policy”字段必须设置为 TIME_FLEXIBLE,以指明用户可以在空档开始后使用所购票券。

AdmissionPolicy

此服务的准入政策。

枚举
ADMISSION_POLICY_UNSPECIFIED 未使用。
TIME_STRICT 客户需要在可用性空档开始时到场,且服务会在此空档结束时结束。TIME_STRICT 使用情形示例:* 某游览项目上午 9:00 开始,所有参加者都需要在开始时间到达,中午 12:00 左右返回。* 预约时间为星期六下午 3:00 的某理发服务大约需要 30 分钟的时间。* 某健身课程的上课时间为晚上 6:00 到晚上 8:00。
TIME_FLEXIBLE

客户可以在可用性空档的开始和结束时间之间的任何时间享受已预约的服务。

TIME_FLEXIBLE 使用情形示例:* 可在购票当天的任何时间使用博物馆门票。* 可在中午 12:00 至晚上 9:00 使用下午时段的游乐园入场券。

TIMED_ENTRY_WITH_FLEXIBLE_DURATION

客户需要在可用性空档的开始时间到达商家地点,但可以随时离开。

例如,上午 10:00 的限时门票要求参观者在上午 10:00 点到达博物馆。此服务的可用性空档的开始时间即指定的到场时间。结束时间仅用作确定可用性空档的键。

服务

商家所提供服务的相关信息,例如理发。

字段
name

string

服务资源名称,格式为 partners/{partner_id}/merchants/{merchant_id}/services/{service_id}

service_name

string

服务的名称,例如“男士理发”。已弃用,请改用 localized_service_name。

localized_service_name

Text

服务的名称,例如“男士理发”。可能在多个语言区域。

description

string

可供用户查看的服务简介。已弃用,请改用 localized_description。

localized_description

Text

可供用户查看的服务简介。

此字段同时支持纯文本格式及类似于 HTML 的格式。与纯文本部分不同,自定义布局的创建可使用标题、段落、列表和一些词组标记。请仔细阅读以下说明和注意事项,确保提供最佳的用户体验。

支持的类似于 HTML 的格式标记:

标题标记:<h1>、<h2>、<h3>、<h4>、<h5>、<h6>
标题标记可用于显示标题和副标题。例如,<h1>行程</h1>会将内嵌文本显示为该部分最重要的标题。请注意,所有内部 HTML 标记、样式或属性都将被忽略。例如,<h1 style=".."> 与 <h1> 的处理方式相同。仅保留纯文本。

段落标记:<p>
段落标记可用于突出显示详细信息或内容。任何内部标记、样式或属性都将被忽略,但存在以下几种例外情况:<br>、<strong> 和 <em>。如需了解详情,请参阅下面的词组标记部分。

列表标记:<ul>、<ol>、<li>
<ul> 标记可与 <li> 标记用于显示无序列表,<ol> 标记可与 <li> 标记用于显示有序列表。这是显示核对清单、时间表或任何其他适合您的用例的列表的好方法。
示例:如需显示游轮旅行的一系列特色,请执行以下操作:
<ol>
<li>绝美海景,有机会与野生动物一起玩耍。</li>
<li>精心设计旅行安排和服务。</li>
<li>保证最低价。</li>
</ol>
请注意,只有<li><ul> 岁以下的儿童或 <ol>代码将被转换。所有其他子级内容都会被舍弃。此外,所有内部标记、属性和样式都会被忽略,只保留纯文本内容。

分区标记:<div>
系统会根据上述规则对 <div> 标记受支持的所有内部标记进行解析,<div> 标记本身并不意味着在此进行任何分组或缩进。此外,所有内部属性和样式都会被忽略。

词组标记:<br>、<strong>、<em>
仅支持以上 3 种标记。<br> 用于对段落中的内容进行分行,<strong>/<em> 用于突出显示重要文本。所有其他词组标记都会被忽略。

不受支持的标记:

  • 不允许使用 <html>、<header> 和 <body> 标记。
  • 上面未提及的所有其他标记均不受支持(例如 <table>、<td> 等标记)。
    任何网址、锚标记和链接都会被删除,且任何时候都不会向最终用户显示。如果您想通过图片来打造丰富的用户体验,请通过下面的“related_media”字段发送图片的网址。

重要注意事项:

  • 请勿使用上述受支持的标记以外的其他标记,因为不受支持的标记中的内容会被删除,用户体验也可能会受到影响。
  • 尽量避免使用深层嵌套结构,例如 3 个以上的不同标题级别或嵌套列表。确保结构简单明了,从而打造更优质的用户体验。
  • 如果目前支持的布局无法满足您的使用情形,请与“通过 Google 预订”团队联系。
  • 建议的大小上限为 32000 个字符。
price

Price

服务的价格。

price_interpretation

PriceInterpretation

说明价格的解析方式和面向用户显示的方式。可用于除餐饮和推荐活动之外的任何行业来配置服务价格的显示方式。

rules

SchedulingRules

预约/取消预约的规则。

prepayment_type

PrepaymentType

预付款是必需项、可选项还是不支持预付款。

prepayment_terms

PrepaymentTerms

与预付款完成相关的条款。

form[]
(deprecated)

ServiceIntakeForm

已弃用。请使用 intake_form 和 per_ticket_intake_form。

intake_form

ServiceIntakeForm

在用户预订此服务时,用于请求用户提供更多信息的表单。(可选)

per_ticket_intake_form

ServiceIntakeForm

在用户预订此服务时,用于请求用户提供更多信息的表单。用户预订每张票券时均需填写一次该表单。(可选)

tax_rate

TaxRate

服务的税率。如果存在,则该字段将替换在商家级别设置的任何 tax_rate。空白消息(即 tax_rate { })会将适用税率重置为零。

payment_option_id[]

string

ID 列表,其中列出了可用于支付此服务费用的付款方式。实际的付款方式需在商家级别定义,且多个商家可共享付款方式。

deposit

Deposit

指定向用户收取押金的方式。如果指定了押金,则会替换在服务级别定义的押金。如果将该字段留空,系统会移除服务级别的所有押金。(可选)

no_show_fee

NoShowFee

指定可能需要向用户收取的违约金。如果指定了违约金,则会替换在服务级别定义的违约金。如果将该字段留空,系统会移除服务级别的所有违约金。(可选)

require_credit_card

RequireCreditCard

指明用户是否必须提供信用卡信息才能预订相应服务。可在可用性级别替换该字段。(可选)

type

ServiceType

服务的预定义类型。(可选)

ticket_type[]

TicketType

可预订/购买的服务票券类型(如果支持票券)。(可选)

related_media[]

RelatedMedia

与服务相关的图片。Google 会抓取并存储媒体,用于确保以最有效的方式向最终用户展示。(可选)

service_attribute_value_id[]

ServiceAttributeValueId

适用于相应服务的服务属性值(可选)。对于在相应商家中定义的每个服务属性,每项服务都可能具有零个或多个值。(可选)

waitlist_rules

WaitlistRules

加入等候名单需遵循的规则。

ticketing_vertical_specific_data

TicketingVerticalSpecificData

特定于活动门票行业的其他信息。(可选)

integration_type

IntegrationType

我们所支持的集成深度。(可选)不适用于采用初级集成的合作伙伴。对于此类合作伙伴,“端到端”将始终处于停用状态。

per_order_fee

PerOrderFee

用于购买相应服务的订单级费用。(可选)

tours_and_activities_content

ToursAndActivitiesContent

特定于“游览”和“活动”的内容字段。

location[]

Location

与服务相关的地点。重要注意事项:如果有多个与服务相关的已访问地点,或者 START_LOCATION 与 VISITED_LOCATION 不同,则必须指定 START_LOCATION。示例:- 对于途径 3 个地点的有向导的骑行之旅,需指定第一个地点。- 对于要在酒店大厅集合,然后前往参观地点的观光巴士之旅,需要指定会议地点。

rating

Rating

此服务的用户评分,是针对所有评价的汇总指标。

home_service_data

HomeServiceData

家政服务行业特有的额外信息。(可选)

virtual_session

VirtualSession

可选。有关虚拟会话的信息。必须具有此权限才能启用虚拟服务。

direct_merchant_payment

DirectMerchantPayment

可选。当服务要求用户直接向商家付款时需要添加的其他信息。重要提示:RwG 不会参与此交易。如果定义了 virtual_session 但服务不是免费服务,或者 prepayment_type 未设置为 REQUIRED,则必须提供此值。

PrepaymentTerms

有关何时完成预付款的具体信息。

字段
charge_timing

ChargeTiming

相对于购买时间的扣款时间。

charge_time_before_start_time_sec

int64

服务开始时间前,系统向用户收取费用的时间(以秒为单位)。只有在 ChargeTiming 为 CHARGE_LATER 时才应设置此字段。

ChargeTiming

用于指定相对于购买时间的扣款时间的枚举。

枚举
CHARGE_TIMING_UNSPECIFIED 未使用。
CHARGE_NOW 系统会立即向客户收取费用。
CHARGE_LATER 客户稍后将被扣款。

PrepaymentType

用于表示预付款类型的枚举。

枚举
PREPAYMENT_TYPE_UNSPECIFIED 系统默认预付款为 NOT_SUPPORTED。
REQUIRED 用户必须在预订时支付服务费用。
OPTIONAL 用户可以选择在预订时或预订后预付服务的费用,但这并不是进行预订的必要条件。
NOT_SUPPORTED 相应服务不支持预付费。

ServiceType

预定义的服务类型。

枚举
SERVICE_TYPE_UNSPECIFIED 未使用。
SERVICE_TYPE_DINING_RESERVATION 用餐预订。
SERVICE_TYPE_FOOD_ORDERING 订餐方式可以是送餐和/或外卖。
SERVICE_TYPE_FOOD_DELIVERY 外卖。
SERVICE_TYPE_FOOD_TAKEOUT 外带。
SERVICE_TYPE_EVENT_TICKET 活动门票。
SERVICE_TYPE_TRIP_TOUR 旅游。
SERVICE_TYPE_APPOINTMENT 提供预约或课程的服务。建议用于:(1) 保健和健身行业;(2) 水疗和美容行业;以及 (3) 金融咨询和评估服务。如需查看支持的服务类型,请访问:https://developers.google.com/maps-booking/guides/end-to-end-integration/overview
SERVICE_TYPE_ONLINE_APPOINTMENT 针对完全虚拟的课程或会话提供在线预约的服务。如果启用虚拟服务预订,则必须设置此字段。
SERVICE_TYPE_SHOPPING 允许用户从指定商家购物的服务。可以是“送餐”或“自取”。

ServiceAttribute

服务属性是由合作伙伴定义的类别,用于介绍商家所提供的服务。例如,银行可能会为“账号类型”服务属性定义“个人”和“企业”,而美发店可能会将“服务类型”服务属性的值定义为“理发”、“染色”和“造型”。

字段
attribute_id

string

用于唯一标识同一商家的此服务属性与其他服务属性的标识符,例如“account-type”。

attribute_name

string

此属性的用户可见名称,例如“账号类型”。

value[]

Value

此服务属性的所有可能值。

表示特定服务属性的可能值。

字段
value_id

string

用于在此服务属性中唯一标识该值的标识符,例如“personal”。

value_name

string

值的用户可见名称,例如“个人”。

ServiceAttributeValueId

标识要应用于服务的服务属性的特定值。

字段
attribute_id

string

Merchant.service_attribute 中定义的属性的 ID,例如“service-type”

value_id

string

此属性值的 ID,例如“理发”。必须与服务属性定义中的 value_id 相匹配。

ServiceAvailability

可用性列表及其所适用的人员或时间。

字段
name

string

要将此参数应用到的服务资源的名称。格式为 partners/{partner_id}/merchants/{merchant_id}/services/{service_id}

start_time_restrict

Timestamp

如果提供,我们会将提供的可用性实体视为 [start_time_restrict, end_time_restrict] 的完整概况。也就是说,如果符合以下条件,系统将会删除所有现有的可用性:

   start_time_restrict <= availability.start_sec &&
   availability.start_sec < end_time_restrict

如果设置了 duration 消息,系统会进一步对条件进行限制:

  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

新的可用性列表。

ServiceIntakeForm

指定可对商家所提供服务进行自定义的信息录入表单。

字段
field[]

ServiceIntakeFormField

将向用户显示的字段。

first_time_customers
(deprecated)

bool

如果值为 true,系统将向新客户显示此表单。已弃用。信息录入表单不支持此功能。

returning_customers
(deprecated)

bool

如果值为 true,系统将向回头客显示此表单。已弃用。信息录入表单不支持此功能。

ServiceIntakeFormField

指定 ServiceIntakeForm 中包含的字段。

字段
id

string

集合商家合作伙伴提供的字符串,用于唯一标识表单字段。此 ID 应与相应表单字段回答中的 ID 相同,且必须在服务级别和单张票券信息录入表单中具有唯一性。(必填)

type

FieldType

此字段的类型。

label

string

该字段中向用户显示的文本。已弃用,请改用 localized_label

localized_label

Text

该字段中向用户显示的文本。可面向多个语言区域提供。(必填)

value[]

string

当且仅当字段类型为 LOCATION_SEARCH 时设置。请使用“location_id”在“位置”字段以指定地理位置值。

choice_text[]

Text

当且仅当字段类型是 MULTIPLE_CHOICE、CHECKBOXES 或 DROPDOWN 时设置。用于枚举可能的选项。

is_required

bool

指明用户是否必须回答此字段。

allow_custom_answer

bool

指明是否允许在预定义的答案之外使用自定义值。仅当字段类型为 LOCATION_SEARCH 时,此字段才适用。(可选)

additional_option[]

Text

除所提供的值外,提供的其他选项。仅在字段类型为 LOCATION_SEARCH 时适用。例如:除了提供的地点列表外,您还可以使用“稍后与供应商联系”选项。(可选)

ticket_type_restrict[]

string

如果仅应在用户预订某些类型的票券时显示此问题,则应将此字段设置为一组适用的票券类型 ID。如果问题始终适用,请将此字段留空。

hint

Text

输入的提示文本,以文本占位符的形式显示。这仅在字段类型为 SHORT_ANSWER 或 PARAGRAPH 时适用。(可选)

FieldType

用于表明字段类型的枚举。

枚举
FIELD_TYPE_UNSPECIFIED 未指定或类型未知的字段将被忽略。
SHORT_ANSWER 用于输入文本的单行输入字段。
PARAGRAPH 用于输入文本的多行输入字段。
MULTIPLE_CHOICE 供用户从多个选项中选择一项的一组单选按钮。
CHECKBOXES 一个或多个带有复选框的枚举项。
DROPDOWN 下拉菜单中的一个选项。
BOOLEAN “是/否”按钮。

TaxRate

在向用户收取服务费用时适用的税率,可以按商家或服务设置。

字段
micro_percent

int32

一种税率,以百万分之一计,精确到小数点后 6 位。例如,如果税率为 7.253%,则应将该字段应设置为 7253000。

如果未设置或将该字段设置为 0,对于由此商家提供的任何服务,向用户收取的总费用为 Service.price 所指定的确切价格。该服务价格被视为无需缴纳税费或已包含适用税费。系统不会将税费作为单独的订单项向用户显示。

如果将该字段设置为任何非零值,对于由此商家提供的任何服务,向用户收取的总费用将包含服务价格以及使用此处提供的税率计算得出的税费。最小货币单位的小数部分(例如,1 美分的小数部分)将四舍五入为最接近的偶数。系统会将税费作为单独的订单项向用户显示。

条款

用户在使用“通过 Google 预订”进行预订时需遵守的一组规则和准则。

字段
url

string

(可选)指向条款及条件的网址。

text

string

将向用户显示的文字。请使用下面的 localized_text 进行新的集成。

localized_text

Text

要向用户显示的本地化文本。

文本

可能已本地化的文本有效负载。某些文本字段可能包含标记的内容。

字段
value

string

语言区域未知的文本值。当且仅当 localized_value 为空时为必填项。此值的语言区域可能取决于合作伙伴或服务提供商,不应将其假定为任何特定语言。

localized_value[]

LocalizedString

每个语言的文本值。可选。

TicketType

TicketType 用于区分因用户类型、服务属性或选项/附加服务不同而具有不同价格和/或可用性的票券。

票券是服务最小的可预订单元(例如,漂流之旅中的某个地点、博物馆门票、双人皮划艇全天租借服务)。

字段
ticket_type_id

string

票券 ID 用于区分同一服务的不同票券类型,且仅在服务内是唯一的。

short_description

string

对 TicketType 的简要说明。

此内容可面向用户显示,例如“成人”、“儿童”、“退伍军人”和“Row J”等。该字段是必填字段,每种票券类型都应附有面向用户的说明。已弃用,请改用 localized_short_description。

localized_short_description

Text

对支持国际化的 TicketType 的简要说明。

此内容可面向用户显示,例如“成人”、“儿童”、“退伍军人”和“Row J”等。该字段是必填字段,每种票券类型都应附有面向用户的说明。可分别针对不同语言区域提供不同的值。

price

Price

单张此类票券的价格,不含任何税费。服务税率适用于门票的税率。

per_ticket_fee

PerTicketFee

购买此票券需支付的额外费用。(可选)

option_description

string

对此票券类型所代表的任何其他选项的说明(如有)。已弃用,请改用 localized_option_description。

localized_option_description

Text

对此票券类型所代表的任何其他选项的说明(如有)。可分别针对不同语言区域提供不同的值。

当票券类型表示多个维度时,其他选项非常有用。

示例 1:将不同类型(例如“成人”、“儿童”)和语言作为附加选项的票券,TicketType 列表可如下所示:- { ticket_type_id: "ticket_type_1" localized_short_description { value: "成人" } localized_option_description { value: "英语" } } - { ticket_type_id: "ticket_type_2" localized_short_description { value: "成人" } localized_option_description { value: "西班牙语" } } - { ticket_type_id: "ticket_type_3" localized_short_description { value: "儿童" } localized_option_description { value: "英语" } } - { ticket_type_id: "ticket_type_4" localized_short_description { value: "儿童" } localized_option_description { value: "西班牙语" } }

示例 2:具有防水袋附加选项且租借时长可长达数小时的皮划艇租借服务,其中 short_description 可以为“3 个小时”,而 option_description 可以为“包含防水袋”或“不含防水袋”:- { ticket_type_id: "ticket_type_1" localized_short_description { value: "2 个小时" } localized_option_description { value: "英语" } } - { ticket_type_id: "ticket_type_2" localized_short_description { value: "2 个小时" } localized_option_description { value: "西班牙语" } } - { ticket_type_id: "ticket_type_3" localized_short_description { value: "3 个小时" } localized_option_description { value: "英语" } } - { ticket_type_id: "ticket_type_4" localized_short_description { value: "3 个小时" } localized_option_description { value: "西班牙语" } }

可选,但如果服务的所有票券类型均已设置该字段,则应为其他所有票券类型设置该字段(可以使用默认的 option_description)。例如 [{ticket_type_1, 成人, 英语}, {ticket_type_1, 成人, ''}] 并非有效列表。

仅支持两种 HTML 格式标记:
。这两种标记用于指定同时包含标题和详细说明的选项,例如“高级座位
享受私人包厢,提供全包式座椅、专享电视和送餐到座服务。可在此欣赏如画般的田野风景。”

TicketingVerticalSpecificData

特定于活动门票行业的其他信息。

字段
event_category

EventCategory

活动所属的类别。仅在活动属于某个预定义的类别时设置该字段。(可选)

event_url

string

合作伙伴网站上的活动网址。(可选)

entity[]

Entity

与活动相关的实体列表。(可选)

event_attendance_mode

AttendanceMode

必需。活动参加类型。

event_virtual_location_url[]

string

可选。可观看活动的网址。

event_organizer

Text

可选。活动的组织者。

event_organizer_url

string

可选。举办活动的组织者的网址。

event_organizer_type

OrganizerType

可选。组织者的类型。

event_source_url[]

string

必需。活动信息或说明所在网页的网址。

event_state

EventState

可选。事件的状态。

AttendanceMode

活动参加类型。

枚举
ATTENDANCE_MODE_UNSPECIFIED 未指定。
ONLINE 用于线上活动。
PHYSICAL 适用于线下活动。
PHYSICAL_ONLINE_MIXED 适用于线上和线下活动。

实体

表示与活动相关的实体。

字段
id

string

合作伙伴数据库中实体的唯一标识符。(可选)

name

string

实体的名称。(必填)

url

string

对实体进行明确描述的网页的网址。这是相应实体在合作伙伴网站上的网页(如有);对于实体的其他公共网址,请使用 public_identification_data 中的 relevant_url。(可选)

entity_type

EntityType

实体的类型。(可选)

entity_role

EntityRole

实体在活动中的角色。(可选)

public_identification_data

PublicIdentificationData

实体的公共引用。(可选)

EntityRole

实体在活动中的角色。

枚举
ENTITY_ROLE_UNSPECIFIED 未指定。
ENTITY_ROLE_HEADLINER 该实体表示参加活动的主角或主要表演者。
ENTITY_ROLE_SUPPORTER 该实体表示参加活动的配角。
ENTITY_ROLE_HOME_TEAM 该实体表示参加(体育)活动的主场队。
ENTITY_ROLE_AWAY_TEAM 该实体表示参加(体育)活动的客场队。

EntityType

实体的类型。注意:不会作为通用本体。

枚举
ENTITY_TYPE_UNSPECIFIED 未指定。请勿使用。
ENTITY_TYPE_PERFORMER 该实体表示在演唱会或演出中进行表演的艺术家或团体。仅在活动类别为“演唱会”或“戏剧”时适用。
ENTITY_TYPE_PLAYER 该实体表示参加比赛的团队或运动员。仅在活动类别为“体育赛事”时适用。
ENTITY_TYPE_CONCERT_TOUR 该实体表示活动所属的游览项目。仅在活动类别为“演唱会”时适用。
ENTITY_TYPE_SPORTS_SERIES 该实体表示活动所属的体育赛事。仅在活动类别为“体育赛事”时适用。
ENTITY_TYPE_PLAY 该实体表示在活动的表演类型(例如音乐剧、喜剧、芭蕾舞等)。仅在活动类别为“戏剧”时适用。

EventCategory

为其自定义产品体验的活动类别的子集。注意:不会作为活动的通用本体。

枚举
EVENT_CATEGORY_UNSPECIFIED 未指定。请勿使用。
EVENT_CATEGORY_CONCERT 演唱会。
EVENT_CATEGORY_SPORTS 体育赛事。
EVENT_CATEGORY_THEATRE 戏剧表演。
EVENT_CATEGORY_EXHIBITS 展览。
EVENT_CATEGORY_WORKSHOPS_AND_CLASSES 讲习班和课程。

EventState

事件的状态。

枚举
EVENT_STATE_UNSPECIFIED 未指定。
SCHEDULED 活动已排定时间。
RESCHEDULED 活动已重新安排。
CANCELLED 该活动已取消。
POSTPONED 活动已延期。

OrganizerType

组织者的类型。

枚举
ORGANIZER_TYPE_UNSPECIFIED 未指定。
PERSON 适用于只有个人组织者。
ORGANIZATION 适用于是组织的组织者。

PublicIdentificationData

引用实体的标识符、网页或任何其他公共来源。

字段
relevant_url[]

string

内容主要涉及相应主题的任何网页的公共网址。包括官方网站、Discogs、社交媒体平台、维基百科或 IMDb 页面,例如 https://www.discogs.com/artist/1124645-Taylor-Swifthttps://www.wikidata.org/wiki/Q19320959https://twitter.com/acmilan。(可选)

musicbrainz_id

string

艺术家或其他音乐实体的 36 个字符的 MusicBrainz 标识符(如适用)。如需了解详情,请访问 https://musicbrainz.org/doc/MusicBrainz_Identifier。(可选)

TimeRange

开始营业到结束营业的时间范围,即 [start_time, end_time]。

字段
start_time

Timestamp

时间范围的下限。

end_time

Timestamp

时间范围的上限。

TokenizationConfig

按商家设置的适用于付款处理方令牌化的配置。

字段
tokenization_parameter

map<string, string>

令牌化配置通常会有一个 tokenization_parameter,其键为“gateway”,其值为处理方的名称。

其余参数取决于处理方。如需了解详情,请参阅 Google Pay 的文档。

Braintree 示例: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 示例:tokenization_parameter { key: "gateway" value: "stripe" } tokenization_parameter { key: "stripe:version" value: "2018-02-28" } tokenization_parameter { key: "stripe:publishableKey" value: "pk_1234" }

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

billing_information_format

BillingInformationFormat

在付款令牌中添加用户在 Google Pay 中输入的结算信息(请参阅上文)。将此字段留空等同于指定 MIN。

BillingInformationFormat

在账单邮寄地址信息中要求用户支付的金额,将其包含在令牌中。枚举值应对应于 Google Pay API 中的参数(请参阅 https://developers.google.com/pay/api/web/reference/object#BillingAddressParameters)

枚举
BILLING_INFORMATION_FORMAT_UNSPECIFIED 未指定。默认值为 MIN。
MIN 姓名、国家/地区代码以及邮政编码(Google Pay 的默认设置)。
FULL 姓名、街道地址、市行政区、区域、国家/地区代码和邮政编码。

ToursAndActivitiesContent

特定于游览项目和活动的“内容”字段。重复字段中的各个元素应相互独立,以便单独呈现(例如以要点的形式显示)。

强烈建议为游览项目和活动填充 ToursAndActivitiesContent,但并非硬性要求。所有字段均支持将纯文本和类似于 HTML 的文本作为基本格式。支持的类似于 HTML 的格式标记:

词组标记:
, , , :仅支持上述三种标记。
用于对段落中的内容进行分行,// 则用于突出显示重要文本。所有其他词组标记都会被忽略。

不允许使用任何其他标记和自定义样式,且相应标记和样式会被移除。任何网址、锚标记和链接都会被删除,且任何时候都不会向最终用户显示。

重要注意事项:* 请勿重复提供服务说明中 highlightsexclusion 及其他更具体的字段中已提供的数据。* 请勿使用上述受支持的标记以外的其他标记,因为不受支持的标记中的内容会被删除,用户体验也可能会受到影响。

字段
highlights[]

Text

用户可见的突出显示内容列表。

inclusions[]

Text

向用户显示的包含项列表。

exclusions[]

Text

向用户显示的排除项列表。

must_know[]

Text

向用户显示的重要备注列表,用于详细说明年龄限制或不适合使用此服务的其他情况。

UnsupportedPartySizeOption

适用于超出范围的选项。

字段
call_merchant

CallMerchant

如果人数超出范围,您可以致电联系商家。系统将向用户显示一条预定义消息。要显示的示例文本:“对于人数超过 {waitlist_rules.max_party_size} 的聚会,请致电 {phone} 与餐厅联系。”必须设置 CallMerchant,但它将为空。

UpdateBookingRequest

请求更新 google.maps.booking.v1alpha.Booking

字段
update_mask

FieldMask

要更新的所有预订字段的字段掩码

booking

Booking

要更新的预订

booking_failure

BookingFailure

如果异步确认的预订请求处理失败,且预订的状态被更新为“FAILED”,则该字段应反映业务逻辑错误(例如,用户的现有预订与此次预订的时间太过接近)。只有在将预订状态更新为“FAILED”时才应设置此字段,否则系统会忽略此字段。

UpdateMerchantRequest

用于更新 Merchant 的请求。

字段
merchant

Merchant

新的商家数据。

update_mask

FieldMask

要为商家更新的特定字段。

UpdateOrderRequest

请求更新 google.maps.booking.v1alpha.Order

字段
update_mask

FieldMask

要更新的所有订单字段的字段掩码

order

Order

要更新的订单

UpdateServiceRequest

用于更新 Service 的请求。

字段
service

Service

新服务数据。

update_mask

FieldMask

要为服务更新的特定字段。

UserPurchaseRestriction

限制有资格使用付款方式的用户。

字段
new_to_merchant

bool

只有以前从未从同一商家购买过商品的用户才可以购买的付款方式。

new_to_payment_option

bool

只有以前从未购买过相同付款方式的用户才可以购买的付款方式。

VirtualSession

有关线上/在线会话的信息。例如:线上瑜伽课程、线上烹饪课等

字段
session_instructions

Text

有关如何设置此虚拟类的说明。如果合作伙伴未在预订中添加视频网址,则此文本必须包含视频网址与用户分享的时间。例如 “Zoom url 将在课程开始前 30 分钟通过邮件寄送”。(推荐)

session_requirements

Text

指定虚拟会话的要求。例如瑜伽垫、烹饪用具等(推荐)

virtual_platform_info

VirtualPlatformInfo

此会话中所用虚拟平台的相关信息。(启用虚拟服务是必需的)

is_session_prerecorded

bool

必需。如果虚拟会议未进行直播,并且是预先录制的,请将此项设为 true。

VirtualPlatformInfo

将用于此虚拟会话的平台的相关信息。

字段
platform

Platform

用于虚拟会话的平台。

other_platform_name

Text

如果平台设为“其他”,平台的名称。(如果平台设置为“其他”,则必须提供此值)

平台

用于指明商家将使用哪个虚拟平台的枚举。

枚举
PLATFORM_UNSPECIFIED 未使用。
FLEXIBLE 商家可以灵活地选择使用的视频平台。
GOOGLE_HANGOUTS Google 环聊产品。
GOOGLE_MEET Google Meet 产品。
ZOOM Zoom Video Communications。
SKYPE Skype。
YOUTUBE 在 YouTube 中直播。
OTHER 如果使用的视频平台与此处提到的视频平台不同,则应设置此字段。

WaitlistRules

加入候位名单需遵守的规则。

字段
min_party_size

int32

必填。对于提供候位名单功能的服务,必须提供正整数。如果服务或商家不提供候位名单功能,则不得填充此字段。

max_party_size

int32

必需。对于提供候位名单功能的服务,必须提供正整数。如果服务或商家不提供候位名单功能,则不得填充此字段。

supports_additional_request

bool

如果为 true,用户将能够在加入此服务的等候名单时发送任意格式的附加文本请求。

above_max_party_size_options[]

UnsupportedPartySizeOption

为大于所设 max_party_size 的各方设置选项。如果不应为大型派对提供加入等候名单的其他选项,请将其留空。