O cliente solicita a criação de um agendamento depois de verificar a disponibilidade do espaço solicitado e confirmar que está livre. O back-end do parceiro faz um agendamento no espaço solicitado e o retorna após a operação ser concluída ou se houver um erro de lógica de negócios (por exemplo, se o espaço ficar indisponível, se o pagamento for inválido etc.).
As informações sobre o usuário e o pagamento são indicadas nesta etapa.
Se a criação de um agendamento falhar devido a algum erro de lógica de negócios, o erro deverá ser preenchido na resposta. Consulte Falha no agendamento para ver mais informações.
Solicitação
CreateBookingRequest
Valor de retorno
CreateBookingResponse
Códigos de erro canônicos de gRPC
INVALID_ARGUMENTse o UserInformation disponibilizado for inválido (por exemplo, devido a campos ausentes)
// Request to create a [ext.maps.booking.partner.v2.Booking] for an inventory
// slot. Consumes the lease if provided.
message CreateBookingRequest {
// The inventory slot that is being requested to make this booking.
// If lease_ref is provided, slot must match the lease; slot is provided for
// the partner to verify the lease information.
// If lease_ref is absent, then create the booking for the slot. (required)
Slot slot = 1;
// The lease that is being confirmed to make this booking.
// If lease_ref is provided, then create the booking using the lease.
// (optional)
LeaseReference lease_ref = 2;
// Personal information of the user making the appointment (required)
UserInformation user_information = 3;
// Information about payments. When payment authorizations are handled by
// Google, if the booking request does not succeed, payment authorizations are
// automatically canceled. (optional)
PaymentInformation payment_information = 4;
// The parameters to be used if the payment is processed by the partner
// (i.e. payment_information.payment_processed_by is equal to
// PROCESSED_BY_PARTNER). (optional)
PaymentProcessingParameters payment_processing_parameters = 5;
// Idempotency token for [ext.maps.booking.partner.v2.CreateBooking] requests.
// (required)
string idempotency_token = 6;
// A string from the user which contains any special requests or additional
// information that they would like to notify the merchant about. (optional)
string additional_request = 7;
}
// Response with the created [ext.maps.booking.partner.v2.Booking] for an
// inventory slot
message CreateBookingResponse {
// The created booking (required)
Booking booking = 1;
// The updated user payment option used in this booking.
// If a new payment option was purchased to pay for the booking, this should
// be a newly created user payment option.
// If an already purchased user payment option was used for this booking,
// this should reflect an updated version of that user payment option.
// (optional)
UserPaymentOption user_payment_option = 2;
// If creating a booking fails, this field should reflect the business logic
// error (e.g., slot has become unavailable) and all other fields in the
// CreateBookingResponse message are expected to be unset. (required if
// failure occurs)
BookingFailure booking_failure = 3;
}