Especificação de locação

Uma locação detém temporariamente a propriedade de um espaço solicitado.

O back-end do parceiro verifica se o espaço solicitado é válido e ainda está disponível. O parceiro cria uma retenção temporária para o espaço em questão, que é configurado para expirar automaticamente no horário definido em lease_expiration_time. O back-end tem permissão para modificar o lease_expiration_time, por exemplo, se o tempo de locação especificado for muito longo. A locação criada é retornada ao cliente.

Nossa API Booking tem suporte opcional para locação. Com esse recurso, a criação de uma locação para o espaço solicitado é a primeira etapa ao fazer um agendamento.

// Temporary lease for an inventory slot
message Lease {
  // ID of the lease.
  // Not populated in CreateLeaseRequest. The value is chosen by the partner and
  // has to be returned in the response of CreateLease. (required)
  string lease_id = 1;

  // The appointment slot that the lease is created for. (required)
  Slot slot = 2;

  // Unique identifier for this lease, chosen by Reserve with Google. Serves as
  // an idempotency token for [ext.maps.booking.partner.v2.CreateLease]
  // requests. (required)
  string user_reference = 3;

  // Expiration time of the lease in UTC Timestamp (required)
  google.protobuf.Timestamp lease_expiration_time = 4;
}

// Reference to a [ext.maps.booking.partner.v2.Lease] that has been created via
// [ext.maps.booking.partner.v2.CreateLease]
message LeaseReference {
  // Lease ID (required)
  string lease_id = 1;
}

Mais informações sobre locações

O suporte para locação é opcional. Isso se aplica a parceiros que gostariam de implementar essa funcionalidade. Entre em contato com a Central de Ações para determinar a qualificação antes de começar.

Se você quiser permitir locações, implemente o conjunto recomendado da API v2, além de:

  • implementar o CreateLease;
  • implementar o CreateBooking e usar a referência de locação. O back-end do parceiro faz um agendamento com a referência informada.

Os requisitos da API v2 também se aplicam ao suporte para locação. Além disso, considere o seguinte:

  • Espera-se que o CreateBooking use a referência de locação. Ao fazer uma agendamento com a referência informada, o parceiro utiliza a locação e a torna inválida para outras reservas. Também é responsabilidade do parceiro verificar o agendamento criado usando o espaço na mensagem de solicitação.
  • NOT_FOUND será utilizado como um código adicional de erro gRPC se a referência de locação for informada e o parceiro não souber o código da locação.
Figura: criar um agendamento para uma locação