REST Resource: inventory.partners.merchants.services

{
  "name": string,
  "serviceName": string,
  "localizedServiceName": {
    object (Text)
  },
  "description": string,
  "localizedDescription": {
    object (Text)
  },
  "price": {
    object (Price)
  },
  "priceInterpretation": enum (PriceInterpretation),
  "rules": {
    object (SchedulingRules)
  },
  "prepaymentType": enum (PrepaymentType),
  "prepaymentTerms": {
    object (PrepaymentTerms)
  },
  "form": [
    {
      object (ServiceIntakeForm)
    }
  ],
  "intakeForm": {
    object (ServiceIntakeForm)
  },
  "perTicketIntakeForm": {
    object (ServiceIntakeForm)
  },
  "taxRate": {
    object (TaxRate)
  },
  "paymentOptionId": [
    string
  ],
  "deposit": {
    object (Deposit)
  },
  "noShowFee": {
    object (NoShowFee)
  },
  "requireCreditCard": enum (RequireCreditCard),
  "actionLink": [
    {
      object (ActionLink)
    }
  ],
  "type": enum (ServiceType),
  "ticketType": [
    {
      object (TicketType)
    }
  ],
  "relatedMedia": [
    {
      object (RelatedMedia)
    }
  ],
  "serviceAttributeValueId": [
    {
      object (ServiceAttributeValueId)
    }
  ],
  "waitlistRules": {
    object (WaitlistRules)
  },
  "ticketingVerticalSpecificData": {
    object (TicketingVerticalSpecificData)
  },
  "integrationType": enum (IntegrationType),
  "perOrderFee": {
    object (PerOrderFee)
  },
  "toursAndActivitiesContent": {
    object (ToursAndActivitiesContent)
  },
  "location": [
    {
      object (Location)
    }
  ],
  "rating": {
    object (Rating)
  },
  "homeServiceData": {
    object (HomeServiceData)
  },
  "virtualSession": {
    object (VirtualSession)
  },
  "directMerchantPayment": {
    object (DirectMerchantPayment)
  }
}

string

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

string

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

object (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 localizedDescription instead.

object (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 "relatedMedia" 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.

object (Price)

The price of the service.

enum (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.

object (SchedulingRules)

Rules to book/cancel an appointment.

enum (PrepaymentType)

Whether a prepayment is required, optional or not supported.

object (PrepaymentTerms)

Terms around when the prepayment is completed.

object (ServiceIntakeForm)

Deprecated. Please use intakeForm and perTicketIntakeForm.

object (ServiceIntakeForm)

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

object (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)

object (TaxRate)

The service's tax rate. If present this field overrides any taxRate set at the merchant level. An empty message (i.e. taxRate { }) 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.

object (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)

object (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)

enum (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)

object (ActionLink)

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

enum (ServiceType)

The predefined type of this service. (optional)

object (TicketType)

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

object (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)

object (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)

object (WaitlistRules)

Rules to joining the waitlist.

object (TicketingVerticalSpecificData)

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

enum (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.

object (PerOrderFee)

Order level fees for purchasing this service. (optional)

object (ToursAndActivitiesContent)

Content fields specific to Tours and Activities.

object (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.

object (Rating)

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

object (HomeServiceData)

Additional information unique to home service vertical. (optional)

object (VirtualSession)

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

object (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 virtualSession is defined and the service is not free or prepaymentType is NOT set to REQUIRED.

{
  "minAdvanceOnlineCanceling": string,
  "lateCancellationFee": {
    object (Price)
  },
  "noshowFee": {
    object (Price)
  },
  "admissionPolicy": enum (AdmissionPolicy),
  "cancellationPolicy": {
    object (CancellationPolicy)
  },

  // Union field min_booking_buffer can be only one of the following:
  "minAdvanceBooking": string,
  "minBookingBufferBeforeEndTime": string
  // End of list of possible types for union field min_booking_buffer.
}

string (int64 format)

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

object (Price)

The fee for canceling within the minimum advance notice period.

object (Price)

The fee for no-show without canceling.

enum (AdmissionPolicy)

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

object (CancellationPolicy)

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

string (int64 format)

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

string (int64 format)

The duration (in seconds) from when the last booking can be made to when the availability slot ends. If this field is set, the "admissionPolicy" field must be set to TIME_FLEXIBLE to indicate that users can use the purchased tickets after slots start.

{
  "refundCondition": [
    {
      object (RefundCondition)
    }
  ]
}

object (RefundCondition)

Zero or more refund conditions applicable to the policy.

{
  "minDurationBeforeStartTime": string,
  "refundPercent": integer
}

string (Duration format)

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

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

integer (uint32 format)

The percent that can be refunded, as long as the service booking is cancelled at least minDurationBeforeStartTime 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.

{
  "chargeTiming": enum (ChargeTiming),
  "chargeTimeBeforeStartTimeSec": string
}

enum (ChargeTiming)

When the charge will occur relative to the purchase time.

string (int64 format)

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.

{
  "field": [
    {
      object (ServiceIntakeFormField)
    }
  ],
  "firstTimeCustomers": boolean,
  "returningCustomers": boolean
}

object (ServiceIntakeFormField)

Fields that will be displayed to the user.

boolean

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

boolean

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

{
  "id": string,
  "type": enum (FieldType),
  "label": string,
  "localizedLabel": {
    object (Text)
  },
  "value": [
    string
  ],
  "choiceText": [
    {
      object (Text)
    }
  ],
  "isRequired": boolean,
  "allowCustomAnswer": boolean,
  "additionalOption": [
    {
      object (Text)
    }
  ],
  "ticketTypeRestrict": [
    string
  ],
  "hint": {
    object (Text)
  }
}

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)

enum (FieldType)

The type of this field.

string

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

object (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 "locationId" in the "location" field to specify the location value.

object (Text)

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

boolean

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

boolean

Indicates whether a custom value is allowed in additional to predefined answers. This is only applicable when the field type is LOCATION_SEARCH. (optional)

object (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.

object (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)

{
  "ticketTypeId": string,
  "shortDescription": string,
  "localizedShortDescription": {
    object (Text)
  },
  "price": {
    object (Price)
  },
  "perTicketFee": {
    object (PerTicketFee)
  },
  "optionDescription": string,
  "localizedOptionDescription": {
    object (Text)
  }
}

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 localizedShortDescription instead.

object (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.

object (Price)

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

object (PerTicketFee)

Additional fees for purchasing this ticket. (optional)

string

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

object (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: - { ticketTypeId: "ticket_type_1" localizedShortDescription { value: "adult" } localizedOptionDescription { value: "english" } } - { ticketTypeId: "ticket_type_2" localizedShortDescription { value: "adult" } localizedOptionDescription { value: "spanish" } } - { ticketTypeId: "ticket_type_3" localizedShortDescription { value: "child" } localizedOptionDescription { value: "english" } } - { ticketTypeId: "ticket_type_4" localizedShortDescription { value: "child" } localizedOptionDescription { value: "spanish" } }

Example 2: an multi-hour kayak rental with optional dry bag add-on, the shortDescription could be "3 hours" and the optionDescription could be either "with dry bag" or "without dry bag": - { ticketTypeId: "ticket_type_1" localizedShortDescription { value: "2 hours" } localizedOptionDescription { value: "english" } } - { ticketTypeId: "ticket_type_2" localizedShortDescription { value: "2 hours" } localizedOptionDescription { value: "spanish" } } - { ticketTypeId: "ticket_type_3" localizedShortDescription { value: "3 hours" } localizedOptionDescription { value: "english" } } - { ticketTypeId: "ticket_type_4" localizedShortDescription { value: "3 hours" } localizedOptionDescription { 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 optionDescription 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."

{
  "serviceCharge": {
    object (Price)
  },
  "facilityFee": {
    object (Price)
  },
  "taxes": {
    object (Price)
  }
}

object (Price)

An extra charge assessed for a service.

object (Price)

A fee that goes to the venue/facility.

object (Price)

Per ticket taxes.

{
  "url": string,
  "type": enum (MediaType),
  "localizedCaption": {
    object (Text)
  },
  "attribution": {
    object (Attribution)
  },
  "caption": string
}

string

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

enum (MediaType)

Type of this media source.

object (Text)

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

object (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 localizedCaption.

{
  "localizedText": {
    object (Text)
  },
  "text": string
}

object (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 localizedText.

{
  "attributeId": string,
  "valueId": string
}

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 valueId in the service attribute definition.

{
  "minPartySize": integer,
  "maxPartySize": integer,
  "supportsAdditionalRequest": boolean,
  "aboveMaxPartySizeOptions": [
    {
      object (UnsupportedPartySizeOption)
    }
  ]
}

integer

Required. Must be a positive integer for services providing waitlist functionality. If the service or merchant does not provide waitlist functionality, this must not be populated.

integer

Required. Must be a positive integer for services providing waitlist functionality. If the service or merchant does not provide waitlist functionality, this must not be populated.

boolean

If true, the user will be able to send a free-form additional text request when joining the waitlist for this service.

object (UnsupportedPartySizeOption)

Set options for parties larger than the set maxPartySize. Leave empty if larger parties should not be given alternative options for joining a waitlist.

{
  "callMerchant": {
    object (CallMerchant)
  }
}

object (CallMerchant)

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

{
  "eventCategory": enum (EventCategory),
  "eventUrl": string,
  "entity": [
    {
      object (Entity)
    }
  ],
  "eventAttendanceMode": enum (AttendanceMode),
  "eventVirtualLocationUrl": [
    string
  ],
  "eventOrganizer": {
    object (Text)
  },
  "eventOrganizerUrl": string,
  "eventOrganizerType": enum (OrganizerType),
  "eventSourceUrl": [
    string
  ],
  "eventState": enum (EventState)
}

enum (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)

object (Entity)

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

enum (AttendanceMode)

Required. The type of the event attendance.

string

Optional. URL where the event can be watched.

object (Text)

Optional. Organizer who hosts the event.

string

Optional. URL of the organizer who hosts the event.

enum (OrganizerType)

Optional. The type of the organizer.

string

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

enum (EventState)

Optional. State of the event.

{
  "id": string,
  "name": string,
  "url": string,
  "entityType": enum (EntityType),
  "entityRole": enum (EntityRole),
  "publicIdentificationData": {
    object (PublicIdentificationData)
  }
}

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 relevantUrl in publicIdentificationData. (optional)

enum (EntityType)

The type of the entity. (optional)

enum (EntityRole)

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

object (PublicIdentificationData)

Public references of the entity. (optional)

{
  "relevantUrl": [
    string
  ],
  "musicbrainzId": string
}

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)

{
  "deliveryFee": {
    object (Price)
  },
  "processingFee": {
    object (Price)
  }
}

object (Price)

A fee that can vary by delivery method.

object (Price)

A fee to process the user's payment method.