Package google.maps.booking.v1alpha

string

The entry point URL for this action link.

string

The BCP-47 language tag identifying the language in which the content from this URI is available.

string

ISO 3166-1 alpha-2 country code. Leave empty for unrestricted visibility.

ActionPlatform

The platform that this action should be performed on. If this field is unset, ACTION_PLATFORM_WEB_APPLICATION will be used as fallback.

ActionLinkType

Predetermined type of action.

OrderOnlineMetadata

Metadata for the order online link. Supports action with ActionLinkType of ACTION_LINK_TYPE_SHOP_ONLINE.

FoodOrderingMetadata

Metadata for Food Ordering links. Supports action type: * ACTION_LINK_TYPE_ORDER_FOOD_DELIVERY * ACTION_LINK_TYPE_ORDER_FOOD_TAKEOUT Does NOT support ACTION_LINK_TYPE_ORDER_FOOD.

EventMetadata

Additional information about action link which is unique to the events vertical.

Surface

Predetermined event surface associated with an action link. This is only used for Events vertical.

string

Identifier. Resource name of the AdsAccountLink. Format: partners/{partner}/adsAccountLinks/{ads_account_link}

string

Required. List of inventory item Ids to be linked with the Google Ads account.

State

Output only. State of the Ads account link.

Text

Custom message to be displayed to the user when booking through Reserve with Google.

Timestamp

Start time of the appointment slot.

Duration

Duration of the appointment slot

int64

Number of total spots and open spots of this availability. Examples:

• Yoga class of 10 spots with 3 booked: availability {spots_total: 10, spots_open: 7 ...}
• Chair massage session which is already fully booked: availability {spots_total: 1, spots_open: 0 ...}

Note: If sending requests using the availability compression format defined below, these two fields will be inferred.

• A Recurrence implies spots_total=1 and spots_open=1.
• A ScheduleException implies spots_total=1 and spots_open=0.

int64

Number of open spots.

string

An optional opaque string to identify this availability slot. If set, it will be included in the requests that book/update/cancel appointments.

Resources

Optional resources used to disambiguate this availability slot from others when different staff members, or rooms are part of the service.

E.g. the same Yoga class with two 2 instructors:

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 }

string

A list of ids referencing the payment options which can be used to pay for this slot. The actual payment options are defined at the Merchant level, and can also be shared among multiple Merchants.

This field overrides any payment_option_ids specified in the service message. Similarly payment_option_ids specified here do NOT have to be present in the service message, though must be defined at the Merchant level.

Recurrence

The recurrence information for the availability, representing more than one start time. A recurrence should contain appointments for one working day.

ScheduleException

Times when this service cannot be scheduled. To limit the number of schedule_exception messages, consider joining adjacent exceptions.

Deposit

Optional deposit for this availability. Overrides the service deposit if one was specified.

NoShowFee

Optional no show fee for this availability. Overrides the service no show fee if one was specified.

Prepayment

Optional. Optional prepayment information for this availability.

RequireCreditCard

Indicates whether the user must provide a credit card in order to book this availability slot. If the value is not set, it is inherited from the service level if it's set there. (optional)

string

Indicates a list of supported ticket types for this availability slot. If unset, all ticket types in the parent service are available for this slot. Note that the values of this field must be defined in the parent service. Examples:

• Service with four ticket types: 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"}

To represent the inventory during the weekdays: availability {ticket_type_id: "adult_1" ticket_type_id: "youth_1"...}. To represent the inventory during the holidays: availability {ticket_type_id: "adult_2" ticket_type_id: "youth_2"...}.

• Service with three ticket types: TicketType {ticket_type_id: "adult" short_description: "Adult"} TicketType {ticket_type_id: "youth" short_description: "Youth"} TicketType {ticket_type_id: "senior" short_description: "Senior"}

To indicate that all three ticket types are available for this time slot, use either availability {ticket_type_id: "adult" ticket_type_id: "youth" ticket_type_id: "senior" ...} or `availability {...}' (do not set ticket_type_id in this slot).

(optional)

DurationRequirement

The requirement to show the slots duration and/or endtime. This field will be ignored if the slot is unavailable. Not used in the Things-To-Do vertical. (optional)

SchedulingRuleOverrides

Availability scheduling rules. If fields are populated, they will override any corresponding scheduling rules on the service-level SchedulingRules.

ConfirmationMode

The confirmation mode that will be used when booking this availability. Attempts to create bookings for availabilities with a confirmation mode of CONFIRMATION_MODE_SYNCHRONOUS must be immediatlely confirmed or denied. Attempts to create bookings for availabilities with confirmation mode of CONFIRMATION_MODE_ASYNCHRONOUS must be either immediately denied or created with status PENDING.

LinkoutRequiredReason

Optional. The reason a linkout is required for this slot. If set, the Merchant resource for this slot must have a valid LinkoutTemplate. (optional)

Timestamp

The inclusive maximum UTC timestamp the availability repeats until.

Duration

Defines the time between successive availability slots.

Example: An availability with a duration of 20 min, a repeat_every of 30 min, a start_time of 9:00am, and a repeat_until of 11:00am will yield slots at 9-9:20am, 9:30-9:50am, 10-10:20am, 10:30-10:50am, 11-11:20am. (required)

TimeRange

The time range of the exception. Any slots described by the recurrence which overlap this closed-open time range will be considered unavailable.

Example: If the recurrence specifies a duration of 20 min, a repeat_every of 30 min, a start_time of 9:00am, and a repeat_until of 11:00am, then a ScheduleException with a time_range of 9:45am-11:00am would make unavailable the slots at 9:30-9:50am, 10-10:20am, and 10:30-10:50am.

Note that because the time range is closed-open, the slot beginning at 11am slot would not be impacted.

int64

The last time (in seconds) that this slot is able to be booked. This timestamp must be before the start_sec of the slot to be respected (if users should be able to book after the start time, use service level SchedulingRules.min_booking_before_end_time). If present, will override anything specified in the min_booking_buffer of the corresponding Service's SchedulingRules.

int64

The first time (in seconds) that this slot is able to be booked. This timestamp must be before the start_sec of the slot, or last_bookable_sec if specified.

int64

If set, the last time (in seconds since the Unix epoch) that this specific appointment slot can be cancelled through Reserve with Google. This field will override any service-level cancellation rules. (optional)

string

Resource name, which has the format of - partners/{partner_id}/feeds/{feed_name}.

GenericDeleteRecord

Records to be deleted. Maximum of 1000 records are allowed in one api call.

string

Resource name, which has the format of - partners/{partner_id}/feeds/{feed_name}.

GenericRecord

Records to be inserted and/or updated. Maximum of 1000 records are allowed in one api call.

string

Format of partners/{partner_id}.

ExtendedServiceAvailability

The extended service availability that is used to replace the existing availability slots.

ExtendedServiceAvailability

The successfully updated extended service availability messages that were used to replace the existing availability slots.

string

Resource name of the booking: partners/{partner ID}/bookings/{booking ID}

string

ID of the merchant for the slot

string

ID of the merchant service

Timestamp

Start time of the appointment slot

Duration

Duration of the appointment slot

ClientInformation

Personal information of the client making the appointment

BookingStatus

Status of the booking

PaymentInformation

Information about payment transactions that relate to the booking.

int64

Party size of the booking

Cause

The reason why the booking failed. (required)

CreditCardType

(required only if cause is PAYMENT_ERROR_CARD_TYPE_REJECTED)

string

This optional field is used for the partner to include additional information for debugging purpose only. (optional)

PaymentFailureInformation

Information about payment failures.

ThreeDS1Parameters

Parameters used by a RwG aggregator to initiate a 3DS1 authentication protocol with the user. Will be ignored unless BookingFailure.cause is set to PAYMENT_REQUIRES_3DS1.

string

The URL from which to load a form to present to the User for authentication.

string

A PaymentAuthentication Request. To be posted to the ACSUrl form if supplied.

string

An identifier used by the ACS provider. To be posted to the ACSUrl form if supplied.

string

Merchant data. To be posted to the ACSUrl form if supplied.

RefundCondition

Zero or more refund conditions applicable to the policy.

Duration

Duration before the start time, until when the customer can receive a refund for part of the service's cost specified in refund_percent. When set to 0 (default), the service can be cancelled at any time.

uint32

The percent that can be refunded, as long as the service booking is cancelled at least min_duration_before_start_time before the service start time, in the range of [0, 100]. When set to 0 (default), the service is not refundable. When set to 100 this service is fully refundable.

string

Given name of the client

string

Family name of the client

PostalAddress

Address of the client

string

Phone number of the client

string

Email address of the client

string

Required. The parent resource where this Ads account link will be created. This is same as the Partner Center account id. Format: partners/{partner}

string

Required. The ID to use for the Ads Account Link. This is same as Google Ads Customer Id. For details see https://support.google.com/google-ads/answer/1704344 Format : xxx-xxx-xxxx.

AdsAccountLink

Required. The AdsAccountLink to create.

string

The parent resource name for the partner who owns this merchant, in the format of partners/{partner_id}.

string

The merchant id to use for this merchant.

Merchant

The merchant to create.

string

The parent resource name for the merchant who owns this service, in the format of partners/{partner_id}/merchants/{merchant_id}.

string

The service id to use for this service.

Service

The service to create.

CreditCardType

A list of supported credit cards. No credit cards are supported if empty.

string

Required. The name of the AdsAccountLink to delete. Format: partners/{partner}/adsAccountLinks/{ads_account_link}

string

The resource name of the merchant to delete. In the format of partners/{partner_id}/merchants/{merchant_id}

string

The resource name of the service to delete. In the format of partners/{partner_id}/merchants/{merchant_id}/services/{service_id}

Price

Deposit amount.

int64

Minimum advance cancellation for the deposit.

PriceType

Defines how the deposit is determined from the availability.

Text

Users would be advised to pay only via the payment methods mentioned below.

Duration

Minimum duration.

Duration

Maximum duration.

Text

Required. Name, address, telephone number and email address of the economic operator, defined as the manufacturer, authorized representative, importer, distributor, fulfillment service provider or any other natural or legal person subject to obligations related to the manufacture of products, making them available, or putting them into service. Freeform string representation of the economic_operator. This information may be formatted using " " and "\n".

string

This is a mandatory field required to specify which merchant the availability messages below belong to.

string

This is a mandatory field required to specify which service the availability messages below belong to.

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.

Timestamp

Setting end_time_restrict while leaving start_time_restrict unset is interpreted to mean all time up to the end_time_restrict.

Duration

Setting duration further restricts the scope of the update to just the availability with matching duration.

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

The new list of availability.

int64

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

int64

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

int64

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

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

The processing state of this feed.

string

Human readable string providing more details if we failed to process this feed.

FeedStatistics

Statistics specific to this feed.

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.

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.

Duration

Fixed duration. For example: 30 mins.

DurationRange

A range of duration. Examples: * 30 mins to 45 mins * Greater than 30 mins * Less than 50 mins

bool

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

FeeType

Fee type. (required)

FeeAmount

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

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%

Money

Fixed amount. For example USD 3.5.

MoneyRange

Range of amount. Examples: * USD 3.5 to USD 5.5 * At least USD 3.5 * At most USD 5.5

bool

Unknown amount.

FulfillmentType

Required. The fulfillment type.

AvailableDay

Required. A list of days on which there is availability for this fulfillment method (preferably at least 2).

FeeDetails

Required. Fee details for the fulfillment method.

Price

Required. Minimum order for the fulfillment method associated with the action link.

Date

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

Timestamp

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.

NoFee

No fee for the fulfillment method.

MinimumFee

The base fee associated with the fulfillment method.

FixedFee

The fixed fee associated with the fulfillment method.

Price

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

Price

Required. The base fee amount for the fulfillment method.

Timestamp

Required. This timestamp is used to determine the order in which a delete will be applied to the inventory.

bytes

For non-proto based feeds.

Any

For proto-based feeds.

Timestamp

Required. This timestamp is used to to ensure correct ordering of inventory updates.

bytes

For non-proto based feeds.

Any

For proto-based feeds.

double

Latitude in degrees. (optional)

double

Longitude in degrees. (optional)

PostalAddress

Postal address of the location, preferred.

string

An unstructured address could also be provided as a fallback. E.g. "1600 amphitheatre parkway mountain view, ca 94043"

string

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

string

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

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}

string

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

string

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

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.

string

ID of the merchant Service.

int64

Start time of the appointment slot in seconds of UTC time since Unix epoch.

int64

Duration of the appointment slot in seconds.

OrderedTickets

Number of tickets ordered by Ticket Type.

Price

The total price (excluding taxes) of this Line Item.

BookingStatus

Status of the Line Item.

string

ID of a Ticket Type.

int32

Number of tickets ordered for this type.

string

Required. The parent, which owns this collection of merchant status. Format: partners/{partner_id}/merchants

int32

Required. The maximum number of items to return. Note that the server may reduce the page size.

string

Optional. The nextPageToken value returned from a previous ListMerchantStatusResponse, if any.

BookingInventoryStatus

Optional. Optional restriction to filter results by booking inventory status.

WaitlistInventoryStatus

Optional. Optional restriction to filter results by waitlist inventory status.

GeoMatchingStatus

Optional. Optional restriction to filter results by Geo matching status.

MerchantStatus

List of merchant statuses that satisfy the filter conditions.

string

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

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

int32

The maximum number of items to return.

string

The next_page_token value returned from a previous List request, if any.

State

Optional restrict to filter results by feed state.

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.

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.

string

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

string

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

string

Message in the locale above (UTF-8).

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.

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)

string

The public telephone number of the location including its country and area codes, e.g. +14567891234. (optional)

string

The url of the location's public website. (optional)

GeoCoordinates

The Geo info of the location, including latitude, longitude, and address. (optional)

LocationType

The type of the location, must be supplied if this location is provided for a Service.

string

Unique reference of the location within the service. This id can be used to refer to this location in other service fields. E.g. 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)

string

The merchant resource name, which has the format of partners/{partner_id}/merchants/{merchant_id}.

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.

string

The public telephone number of the merchant including its country and area codes, e.g. +14567891234.

string

The url of the merchant's public website.

GeoCoordinates

The Geo info of the merchant, including latitude, longitude, and address.

string

The category of the business in aggregator's platform.

int64

This field is 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.

TaxRate

The merchant's tax rate. If present this field overrides the deprecated tax_rate_basis_points field. An empty message (i.e. tax_rate { }) will reset the applied tax rate to zero.

PaymentRestrictions

Restrictions to the payment methods this merchant accepts. We assume no restrictions exist if this field is not set.

PaymentOption

Payment options available for this merchant. Services under this merchant will be able to individually limit the payment options they allow.

PaymentProcessorConfig

Configuration for a tokenized payment processor, if the merchant has support for it.

TokenizationConfig

Configuration for a tokenized payment processor, if the merchant has support for it.

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.

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.

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)

ServiceAttribute

Definitions for any service attributes used to describe the Services for this Merchant. (optional)

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,

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.

EconomicOperator

Optional. Economic Operator information associated to this specific merchant needed for regulatory compliance. (optional)

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.

string

The merchant status resource name, which has the format of partners/{partner_id}/merchants/{merchant_id}/status

string

Name of the merchant provided by partners.

GeoCoordinates

Partners provided Geo info of the merchant.

ProcessingStatus

Merchant processing status.

BookingStatus

Status related to end-to-end booking integration.

WaitlistStatus

Status related to waitlist integration.

PlaceInfo

Matched Geo place of this merchant. Empty if the merchant is not Geo matched.

LocalServicesMatchInfo

Local services match of this merchant. Empty if it is not a local service merchant or is not matched to any providers.

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.

bool

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

UrlType

Type of this URL.

string

URL that may surface this merchant.

MatchedProvider

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

int64

Google local services external customer ID.

string

Local service categories (verticals). E.g. "plumber" and "carpet_cleaning".

string

Name of the place.

string

Formatted address in local language.

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.

bool

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

Money

Minimum amount.

Money

Maximum amount.

Price

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

PriceType

Defines how the fee is determined from the availability.

string

Resource name of the order: partners/{partner ID}/orders/{order ID}

ClientInformation

Personal information of the client making the order.

PaymentInformation

Information about payment transactions that relate to the order.

string

ID of the merchant that all services in this order belong to.

LineItem

Line items in this order.

FulfillmentOption

Available fulfillment options for an order online action link.

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.

string

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

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.

string

The name of the payment option. This can be user visible.

string

A description of the payment option. This can be user visible.

Price

The price of the payment option.

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 (i.e. tax_rate { }) will reset the applied tax rate to zero.

PaymentOptionType

The type of this payment option. Single-use for drop-ins, multi-use for packs, and unlimited for memberships.

int64

How many sessions this payment option can be used for. Valid only for multi-session / packs, where the value should be > 1.

TimeRange

The payment option can be purchased within this interval.

TimeRange

The payment option can be used within this interval (e.g. special price for January 2017). If present, this overrides valid_duration and activation_type.

Duration

Duration of the payment option validity (e.g. 30 day membership).

ActivationType

Defines how the validity start date is determined for this payment option.

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.

Processor

Defines the payment processor partner this configuration applies to.

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

string

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

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.

Price

A fee that can vary by delivery method.

Price

A fee to process the user's payment method.

Price

An extra charge assessed for a service.

Price

A fee that goes to the venue/facility.

Price

Per ticket taxes.

string

The country, specified using its ISO 3166-1 alpha-2 country code, e.g. "US" (required)

string

The locality, e.g. "Mountain View". (required)

string

The region, e.g. "CA". This field is only required in countries where region is commonly a part of the address. (optional)

string

The postal code, e.g. "94043". (required)

string

The street address, e.g. "1600 Amphitheatre Pkwy". (required)

PriceInfo

Container for price details.

int64

The price in micro-units of the currency. Fractions of smallest currency unit will be rounded using nearest even rounding. (e.g. 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).

string

The currency of the price that is defined in ISO 4217.

string

An optional and opaque string that identifies the pricing option that is associated with the extended price.

PriceType

Defines how price or price range is applied (per person or fixed)

Price

The price of a service or a fee.

PriceRange

The upper and/or lower bound of a service or a fee.

Price

Minimum amount.

Price

Maximum amount. Should always be > min_price.

double

A singular value. For example: 5.6

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

double

Minimum value.

double

Maximum 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.

uint64

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

string

URL of this media source. Google will crawl the media hosted at this URL.

MediaType

Type of this media source.

Text

Caption of the media that supports i18n, only plain text is supported. Any HTML components will be stripped. (optional)

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)

string

Deprecated, prefer to use localized_caption.

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).

string

Deprecated, prefer to use localized_text.

ServiceAvailability

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

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.

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.

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.

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.

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.

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)

int64

The minimum advance notice in seconds required to cancel a booked appointment online. (optional)

Price

The fee for canceling within the minimum advance notice period.

Price

The fee for no-show without canceling.

AdmissionPolicy

The admission policy that applies to this service. If unset, defaults to TIME_STRICT. (optional)

CancellationPolicy

Scheduling rules cancellation policy. (required for Things-to-do)

int64

The duration (in seconds) from when the last booking can be made to when the availability slot starts.

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.

string

The service resource name, which has the format of partners/{partner_id}/merchants/{merchant_id}/services/{service_id}.

string

The name of the service, e.g. "Men's haircut". Deprecated, use localized_service_name instead.

Text

The name of the service, e.g. "Men's haircut". Possibly in several locales.

string

The user-visible description of the service. Deprecated, use localized_description instead.

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.
  

Important notes:

• 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

The price of the service.

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.

SchedulingRules

Rules to book/cancel an appointment.

PrepaymentType

Whether a prepayment is required, optional or not supported.

PrepaymentTerms

Terms around when the prepayment is completed.

ServiceIntakeForm

Deprecated. Please use intake_form and per_ticket_intake_form.

ServiceIntakeForm

A form requesting additional information from the user when they book this service. (optional)

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)

TaxRate

The service's tax rate. If present this field overrides any tax_rate set at the merchant level. An empty message (i.e. tax_rate { }) will reset the applied tax rate to zero.

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

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)

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)

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)

ActionLink

An action link related to this service. If action link exists, type (see below) must be set in the Service.

ServiceType

The predefined type of this service. (optional)

TicketType

Types of tickets that can be booked/purchased for this service, if tickets are supported. (optional)

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)

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)

WaitlistRules

Rules to joining the waitlist.

TicketingVerticalSpecificData

Additional information unique to the event ticketing vertical. (optional)

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.

PerOrderFee

Order level fees for purchasing this service. (optional)

ToursAndActivitiesContent

Content fields specific to Tours and Activities.

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

User rating for this service as an aggregate metric over all reviews.

HomeServiceData

Additional information unique to home service vertical. (optional)

VirtualSession

Optional. Information about virtual session. It is required for enabling virtual services.

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.

UriTemplate

Optional. An optional template specifying how Google should generate URLs to external site.

ChargeTiming

When the charge will occur relative to the purchase time.

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.

string

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

string

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

Value

All possible values for this service attribute.

string

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

string

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

string

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

string

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

string

The resource name of the service to apply this to. In the format of partners/{partner_id}/merchants/{merchant_id}/services/{service_id}

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.

Timestamp

Setting end_time_restrict while leaving start_time_restrict unset is interpreted to mean all time up to the end_time_restrict.

Duration

Setting duration further restricts the scope of the update to just the availability with matching duration.

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

The new list of availability.

ServiceIntakeFormField

Fields that will be displayed to the user.

bool

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

bool

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

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)

FieldType

The type of this field.

string

The text shown to the user for this field. Deprecated, please use localized_label instead.

Text

The text shown to the user for this field. The field can be supplied in multiple locales. (required)

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.

Text

Set if and only if the field type is MULTIPLE_CHOICE, CHECKBOXES, or DROPDOWN. Used to enumerate possible choices.

bool

Indicates whether an answer to this field is required by a user.

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)

Text

Additional options provided in addition to the provided values. Only applicable when the field type is LOCATION_SEARCH. E.g. in addition to the provided location list, another available option can be "I will contact supplier later". (optional)

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.

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)

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.

string

Optionally, the URL to the Terms and Conditions.

string

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

Text

The localized text to be displayed to the user.

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.

LocalizedString

Per-locale text values. Optional.

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.

string

A short description to this TicketType.

This can be user visible, e.g., “adult”, "child", “veteran”, “Row J”, etc. Required, each ticket type should have a description to be user visible. Deprecated, use localized_short_description instead.

Text

A short description to this TicketType with i18n support.

This can be user visible, e.g., “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

The price of a single ticket of this type, exclusive of any taxes. The tax rate of Service is applied to its tickets.

PerTicketFee

Additional fees for purchasing this ticket. (optional)

PriceDisplayType

Optional. Predetermined price display type of a single ticket of this type.

string

Description of any additional option which this ticket type represents, if any. Deprecated, use localized_option_description instead.

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). E.g. [{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."

InventoryType

Optional. Predetermined inventory type of a single ticket of this type.

EventCategory

The category of the event. Set only when event falls into one of the predefined categories. (optional)

string

The URL of the event on the partner's website. (optional)

Entity

A list of entities related to the event. (optional)

AttendanceMode

Required. The type of the event attendance.

string

Optional. URL where the event can be watched.

Text

Optional. Organizer who hosts the event.

string

Optional. URL of the organizer who hosts the event.

OrganizerType

Optional. The type of the organizer.

string

Required. URL of the pages where the event information or descriptions can be found.

EventState

Optional. State of the event.

Text

Optional. The localized brand name.

EventCreator

Optional. Information about the creator of the event.

string

Unique identifier of the entity in the partner's database. (optional)

string

Name of the entity. (required)

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)

EntityType

The type of the entity. (optional)

EntityRole

The role of the entity in the event. (optional)

PublicIdentificationData

Public references of the entity. (optional)

string

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

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, e.g. https://www.discogs.com/artist/1124645-Taylor-Swift, https://www.wikidata.org/wiki/Q19320959, https://twitter.com/acmilan. (optional)

string

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

Timestamp

The lower bound of the time range.

Timestamp

The upper bound of the time range.

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" }

BillingInformationFormat

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.