Online services are defined as services that are held completely online via a hosted platform, and do not require a customer to attend the service in-person. Some examples of online services may include:
- Online yoga class via Zoom
- Online makeup masterclass via Google Meet
- Online plumbing video estimate via Skype
Online services eligibility requirements
Before starting the implementation, please review online services policies and best practices.
Online services implementation
A online services integration is an add-on to the existing Appointments End-to-End integration, and requires some changes to an existing implementation. At a high level, the following changes include:
- Feeds: add
type,VirtualSession,DirectMerchantPayment, andCancellationPolicy(if not added already) to the Services feeds - Booking server: add VirtualSessionInfo to the CreateBooking method, send emails with virtual set-up information to the user
- Real-time updates (existing behavior): handle changes to virtual inventory via the InventoryUpdate RTU, modifications to the booking via the BookingNotification RTU, and changes to the service via the Service RTU
Feeds
Services feed
The following fields are added to the Services feed to support online services.
Services feed specs
enum ServiceType {
SERVICE_TYPE_UNSPECIFIED = 0;
// Service that provides dining reservation.
SERVICE_TYPE_DINING_RESERVATION = 1;
// Service that provides food ordering in general, could be either takeout
// or delivery or both.
SERVICE_TYPE_FOOD_ORDERING = 2;
// Service that only provides food delivery.
SERVICE_TYPE_FOOD_DELIVERY = 6;
// Service that only provides food takeout.
SERVICE_TYPE_FOOD_TAKEOUT = 7;
// Service that provides appointments or classes. Recommended for (1) health
// and fitness, (2) spa and beauty, and (3) financial consults and
// evaluations services. Please see the supported service types:
// https://developers.google.com/actions-center/guides/end-to-end-integration/overview
SERVICE_TYPE_APPOINTMENT = 5;
// Service that provides appointment for an online class or session which
// will be fully virtual. Must be set if enabling virtual service bookings.
SERVICE_TYPE_ONLINE_APPOINTMENT = 8;
}
// Information about virtual/online session. E.g. Online yoga class, virtual
// cooking class etc.
message VirtualSession {
// Instructions on how this virtual class is set up. If the partner does not
// include the video URL with the booking, then this text must include when
// the video URL will be shared with the user. Eg. “Zoom url will be mailed
// 30 minutes prior to the class”. (Recommended)
// Only the folloiwng four tags are supported: <br>, <strong>, <em>, <i>.
Text session_instructions = 1;
// Requirements for the given virtual session. Eg. yoga mat,
// cooking utensils etc. (Recommended)
// Only the folloiwng four tags are supported: <br>, <strong>, <em>, <i>.
Text session_requirements = 2;
// Information about the virtual platform used in this session. (Required to
// enable virtual services)
message VirtualPlatformInfo {
// Enum to indicate which virtual platform would be used by the merchant.
enum Platform {
PLATFORM_UNSPECIFIED = 0;
// The merchant is flexible in which video platform they use.
FLEXIBLE = 1;
GOOGLE_HANGOUTS = 2;
GOOGLE_MEET = 3;
ZOOM = 4;
SKYPE = 5;
YOUTUBE = 6;
// Should be set if the video platform used is different from the ones
// mentioned here.
OTHER = 7;
}
Platform platform = 1;
// The name of the platform if the platform is set to OTHER. (Required if
// platform is set to OTHER)
Text other_platform_name = 2;
}
VirtualPlatformInfo virtual_platform_info = 3;
// Set this as true if the virtual session is not live and is pre-recorded.
// (Optional)
bool is_session_prerecorded = 4;
}
// Information about how the user can pay directly to the merchant instead of
// pre-paying for the service via RwG.
message DirectMerchantPayment {
// Users would be advised to pay only via the payment methods mentioned below.
repeated Text payment_methods = 1;
}
// Cancellation policy for a service.
message CancellationPolicy {
// Defines a single refund condition. Multiple refund conditions could be
// used together to describe "refund steps" as various durations before the
// service start time.
message RefundCondition {
// Duration in seconds 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.
int64 min_duration_before_start_time_sec = 1;
// 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.
uint32 refund_percent = 2;
}
// Zero or more refund conditions applicable to the policy.
repeated RefundCondition refund_condition = 1;
}
Services feed example
{
"service": [
{
"merchant_id": "100",
"service_id": "100-1",
"type" : "SERVICE_TYPE_ONLINE_APPOINTMENT",
"localized_service_name": {
"value": "Makeup masterclass",
"localized_value": [
{
"locale": "en",
"value": "Makeup masterclass"
}
]
},
"localized_description": {
"value": "Learn how to do runway makeup from an award winning makeup artist.",
"localized_value": [
{
"locale": "en",
"value": "Learn how to do runway makeup from an award winning makeup artist."
}
]
},
"virtual_session": {
"session_instructions": {
"value": "You must have access to a computer, and a solid internet connection. Class registration link will be sent to you 15 mins before the start of the class. The class link will be accessible 1 day after the class. ",
"localized_value": [
{
"locale": "en",
"value": "You must have access to a computer, and a solid internet connection. Class registration link will be sent to you 15 mins before the start of the class. The class link will be accessible 1 day after the class. "
}
]
},
"session_requirements": {
"value": "makeup brush, makeup palette, mirror",
"localized_value": [
{
"locale": "en",
"value": "makeup brush, makeup palette, mirror"
}
]
},
"virtual_platform_info": {
"platform": "OTHER",
"other_platform_name": "Susan's hosted platform"
}
},
"direct_merchant_payment": {
"payment_methods": [
{
"value": "Venmo",
"localized_value": [
{
"locale": "en",
"value": "Venmo"
}
]
}
]
},
"price": {
"price_micros": 75000000,
"currency_code": "USD"
},
"rules": {
"min_advance_booking": 0,
"min_advance_online_canceling": 86400,
"cancellation_policy": {
"refund_condition": [
{
"min_duration_before_start_time_sec": 3600,
"refund_percent": 100
}
]
}
},
"prepayment_type": "NOT_SUPPORTED",
"tax_rate": {
"micro_percent": 7750000
}
},
{
"merchant_id": "100",
"service_id": "100-2",
"type" : "SERVICE_TYPE_ONLINE_APPOINTMENT",
"localized_service_name": {
"value": "Advanced Vinyasa Yoga",
"localized_value": [
{
"locale": "en",
"value": "Advanced Vinyasa Yoga"
}
]
},
"localized_description": {
"value": "Learn the advanced techniques of vinyasa yoga taught by award winning yoga instructors.",
"localized_value": [
{
"locale": "en",
"value": "Learn the advanced techniques of vinyasa yoga taught by award winning yoga instructors."
}
]
},
"virtual_session": {
"session_instructions": {
"value": "You must have access to a computer, and a solid internet connection. Class registration link will be included in an email from the merchant.",
"localized_value": [
{
"locale": "en",
"value": "You must have access to a computer, and a solid internet connection. Class registration link will be included in an email from the merchant."
}
]
},
"session_requirements": {
"value": "yoga mat, dumbbells",
"localized_value": [
{
"locale": "en",
"value": "yoga mat, dumbbells"
}
]
},
"virtual_platform_info": {
"platform": "ZOOM"
}
},
"price": {
"price_micros": 40000000,
"currency_code": "USD"
},
"rules": {
"min_advance_booking": 0,
"min_advance_online_canceling": 86400,
"cancellation_policy": {
"refund_condition": [
{
"min_duration_before_start_time_sec": 86400,
"refund_percent": 100
},
{
"min_duration_before_start_time_sec": 3600,
"refund_percent": 50
}
]
}
},
"prepayment_type": "REQUIRED",
"tax_rate": {
"micro_percent": 7750000
},
"require_credit_card": "REQUIRE_CREDIT_CARD_ALWAYS"
}
]
}
- Localized description: The description should clearly articulate what the service is about. Please refer to the best practices guide on how best to structure your services content.
- Session instructions: The session instructions should describe all
the necessary set-up needed and meet the guidance spelled out in the
policy.
- If the platform video url and meeting id is not created automatically
as part of the CreateBooking (e.g. the details are not sent via
CreateBookingResponse), you should clearly call out in thesession_instructionswhen and from who the user should expect the platforms details to be sent to them.
- If the platform video url and meeting id is not created automatically
as part of the CreateBooking (e.g. the details are not sent via
- Session requirements: The session requirements should describe all the necessary equipment or materials a user needs to participate in the class effectively. You may also include optional materials the user may need, but please mark them as optional.
- Platform: The platform should indicate the platform the user will
be using to access the online service.
- If the platform will be determined by the merchant at a later time,
set the
platformtoFLEXIBLE. - If the platform the merchant is using is not in the list, set
platformtoOTHER, and specifyother_platform_name.
- If the platform will be determined by the merchant at a later time,
set the
- Cancellation policy: It is important to have accurate cancellation
policies. Set
CancellationPolicyif refunds and cancellations are allowed. The default assumption if not set, is that refunds are not allowed.
Availability feed
- Spots Total: Set this to the total capacity of participants allowed for the platform (ensure to subtract out the staff)
Booking Server
Optional: If your system creates a meeting id and url on behalf of your
merchant, please include VirtualSessionInfo as part of your
CreateBookingResponse.
CreateBooking spec
message Booking {
// Information related to the virtual session which was booked.
message VirtualSessionInfo {
// URL which was created for the virtual session. (optional)
string session_url = 1;
// The meeting id which was created for the virtual session. (optional)
string meeting_id = 2;
// Password required to access the session. (optional)
string password = 3;
}
VirtualSessionInfo virtual_session_info = X;
}
CreateBookingRequest
{
"idempotency_token": "10000000000",
"payment_information": {
"prepayment_status": "PREPAYMENT_NOT_PROVIDED"
},
"slot": {
"confirmation_mode": "CONFIRMATION_MODE_SYNCHRONOUS",
"duration_sec": "3600",
"merchant_id": "10001",
"service_id": "10001-1",
"start_sec": "1586829600"
},
"user_information": {
"email": "john.doe@gmail.com",
"family_name": "John",
"given_name": "Doe",
"telephone": "+123 456 7890",
"user_id": "110291237"
}
}
CreateBookingResponse
{
"booking": {
"bookingId": "abcdefg-12345",
"slot": {
"merchantId": "10001",
"serviceId": "10001-1",
"startSec": "1586804400",
"durationSec": "3600"
},
"userInformation": {
"userId": "110291237",
"givenName": "John",
"familyName": "Doe",
"telephone": "+123 456 7890",
"email": "john.doe@gmail.com"
},
"status": "CONFIRMED",
"virtual_session_info": {
"video_url": "meet.google.com/abcd-efg",
"meeting_id": "abcd-efg",
"password" : "somepassword"
}
}
}
Real-time Updates
The existing logic for updating inventory or bookings should be maintained for virtual bookings.
- InventoryUpdate RTU: Any updates to slot changes on your system or the Actions Center system, should fire an InventoryUpdate RTU to notify us on the changes in slots.
-
BookingNotification RTU: Any updates to bookings
(e.g. modification of time, or cancellations) on your system or the
Actions Center system, should fire a BookingNotification RTU to notify
us on the changes to a booking.
- If a user does not submit the payment to the merchant/partner, please send a cancellation RTU to us. A cancellation email will be sent by the Actions Center.
- Service RTU: If you currently update services via a Service RTU, make sure to include the appropriate online service fields if updating for a online service.
Emails
By default, the Actions Center will send the standard booking confirmation, modification, and cancellation emails when a user transacts on the Actions Center platform.
Partners should additionally send conference details, payment details, and cancellation policy information in separate emails to the user. Optionally, you may send reminder emails before the appointment or class. Please reference the policy document to ensure you are complying to the email policies for virtual classes.