REST Resource: inventory.partners.merchants.services.availability

{
  "startTime": string,
  "duration": string,
  "spotsTotal": string,
  "spotsOpen": string,
  "availabilityTag": string,
  "resources": {
    object (Resources)
  },
  "paymentOptionId": [
    string
  ],
  "recurrence": {
    object (Recurrence)
  },
  "scheduleException": [
    {
      object (ScheduleException)
    }
  ],
  "deposit": {
    object (Deposit)
  },
  "noShowFee": {
    object (NoShowFee)
  },
  "prepayment": {
    object (Prepayment)
  },
  "requireCreditCard": enum (RequireCreditCard),
  "ticketTypeId": [
    string
  ],
  "durationRequirement": enum (DurationRequirement),
  "schedulingRuleOverrides": {
    object (SchedulingRuleOverrides)
  },
  "confirmationMode": enum (ConfirmationMode),
  "linkoutRequiredReason": enum (LinkoutRequiredReason)
}

string (Timestamp format)

Início do horário disponível.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

string (Duration format)

Duração do horário disponível

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

string (int64 format)

Número total de vagas e vagas em aberto desse horário disponível. Exemplos:

• Aula de ioga com 10 vagas e 3 já reservadas: availability {spotsTotal: 10, spotsOpen: 7 ...}
• Sessão de massagem rápida que já está totalmente reservada: availability {spotsTotal: 1, spotsOpen: 0 ...}

Observação: se você enviar solicitações usando o formato de compactação de disponibilidade definido abaixo, esses dois campos serão inferidos.

• Uma recorrência envolve spotsTotal=1 e spotsOpen=1.
• Uma ScheduleException indica que spotsTotal=1 e spotsOpen=0.

string (int64 format)

Número de vagas abertas.

string

Uma string opaca opcional para identificar esse horário disponível. Se definida, ela será incluída nas solicitações que reservam/atualizam/cancelam compromissos.

object (Resources)

Recursos opcionais usados para diferenciar esse horário disponível de outros quando diferentes membros da equipe ou salas fazem parte do serviço.

Por exemplo, a mesma aula de ioga com dois professores:

availability { resources { staffId: "1" staffName: "Amy" }
               spotsTotal: 10 spotsOpen: 7 }
availability { resources { staffId: "2" staffName: "John" }
               spotsTotal: 5 spotsOpen: 2 }

string

Uma lista de códigos que fazem referência às opções de pagamento disponíveis para pagar pelo espaço. As opções de pagamento reais são definidas no nível do comerciante e também podem ser compartilhadas entre vários deles.

Esse campo modifica qualquer payment_option_ids especificado na mensagem de serviço. Da mesma forma, os payment_option_ids definidos aqui NÃO precisam estar presentes na mensagem de serviço, mas precisam ser adicionados no nível do comerciante.

object (Recurrence)

As informações de recorrência da disponibilidade, representando mais de um horário de início. Uma recorrência deve conter compromissos por um dia útil.

object (ScheduleException)

Os horários em que esse serviço não pode ser programado. Para limitar o número de mensagens scheduleException, considere unir as exceções adjacentes.

object (Deposit)

Um depósito opcional para a disponibilidade da vaga. Substitui o depósito de serviço, se ele tiver sido especificado.

object (NoShowFee)

Taxa opcional de não comparecimento para essa disponibilidade. Substitui a taxa de não comparecimento do serviço, se ela tiver sido especificada.

object (Prepayment)

Opcional. Informações opcionais de pré-pagamento para essa disponibilidade.

enum (RequireCreditCard)

Indica se o usuário precisa informar um cartão de crédito para reservar esse horário. Se o valor não for definido, ele será herdado do nível de serviço, se estiver indicado lá. (Opcional)

string

Indica uma lista de tipos de ingresso compatíveis com esse espaço disponível. Se esse campo não for definido, todos os tipos de ingresso no serviço pai estarão disponíveis para o espaço. Os valores desse campo precisam ser definidos no serviço pai. Exemplos:

• Serviço com quatro tipos de ingresso: TicketType {ticketTypeId: "adult_1" shortDescription: "Adult weekdays"} TicketType {ticketTypeId: "adult_2" shortDescription: "Adult weekends"} TicketType {ticketTypeId: "youth_1" shortDescription: "Youth weekdays"} TicketType {ticketTypeId: "youth_2" shortDescription: "Youth weekends"}

Para representar o inventário durante dias úteis: availability {ticketTypeId: "adult_1" ticketTypeId: "youth_1"...} Para representar o inventário durante feriados: availability {ticketTypeId: "adult_2" ticketTypeId: "youth_2"...}

• Serviço com três tipos de ingresso: TicketType {ticketTypeId: "adult" shortDescription: "Adult"} TicketType {ticketTypeId: "youth" shortDescription: "Youth"} TicketType {ticketTypeId: "senior" shortDescription: "Senior"}

Para indicar que todos os três tipos de ingresso estão disponíveis para esse espaço, use availability {ticketTypeId: "adult" ticketTypeId: "youth" ticketTypeId: "senior" ...} ou "availability {...}" (não defina ticketTypeId nele).

(opcional)

enum (DurationRequirement)

O requisito de mostrar a duração e/ou o horário de término dos slots. Este campo será ignorado se o slot não estiver disponível. Não é usado na vertical Coisas legais para fazer. (opcional)

object (SchedulingRuleOverrides)

Regras de programação de disponibilidade. Se os campos forem preenchidos, eles substituirão as regras de programação correspondentes nas SchedulingRules no nível de serviço.

enum (ConfirmationMode)

O modo de confirmação que será usado ao agendar essa disponibilidade. As tentativas de criar agendamentos para horários com o modo CONFIRMATION_MODE_SYNCHRONOUS precisam ser confirmadas ou negadas imediatamente. As tentativas de criar agendamentos para horários com o modo CONFIRMATION_MODE_ASYNCHRONOUS precisam ser confirmadas ou negadas imediatamente.

enum (LinkoutRequiredReason)

Opcional. O motivo pelo qual um link externo é obrigatório para esse slot. Se definido, o recurso do comerciante para esse slot precisa ter um LinkoutTemplate válido. (opcional)

{
  "staffId": string,
  "staffName": string,
  "roomId": string,
  "roomName": string,
  "partySize": integer,
  "roomDescription": {
    object (Text)
  }
}

string

Código opcional de um membro da equipe que presta o serviço. Esse campo identifica o membro da equipe em todos os comerciantes, serviços e registros de disponibilidade. Ele também precisa ser estável ao longo do tempo para permitir a correlação com agendamentos anteriores. Esse campo precisa estar presente se staffName também estiver.

string

Nome opcional de um membro da equipe que presta o serviço. Esse campo será exibido aos usuários que fizerem um agendamento e deve ser legível por humanos, em vez de um identificador opaco. Ele precisa estar presente se staffId também estiver.

string

Um código opcional para a sala onde o serviço está localizado. Esse campo identifica a sala em todos os comerciantes, serviços e registros de disponibilidade. Ele também precisa ser estável ao longo do tempo para permitir a correlação com agendamentos anteriores. O campo precisa estar presente se roomName também estiver.

string

Um nome opcional para a sala onde o serviço está localizado. Esse campo será exibido aos usuários que fizerem um agendamento e deve ser legível por humanos, em vez de um identificador opaco. (opcional, mas obrigatório se roomId estiver presente) Na seção "Alimentação", o nome de um ambiente só pode ser usado para áreas de estar, como o bar ou o pátio, e não para menus de preço fixo, atividades especiais ou qualquer outro valor que não seja referente ao ambiente (como reserva ou jantar). É altamente recomendável que a área de lugares padrão não tenha uma sala associada a ela.

integer

Aplicável somente para refeições: a quantidade de pessoas que podem ser acomodadas durante esse período. Um restaurante pode estar associado a vários espaços ao mesmo tempo, cada um especificando um partySize diferente, se, por exemplo, duas, três ou quatro pessoas puderem fazer uma reserva.

object (Text)

Opcional. Descrição da sala localizada. Se definido, um valor padrão precisa ser fornecido. É preferível também fornecer idiomas comuns para a localidade do comerciante. (opcional)

{
  "repeatUntil": string,
  "repeatEvery": string
}

string (Timestamp format)

O carimbo de data/hora inclusivo máximo (UTC) em que a disponibilidade se repete.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

string (Duration format)

Define o tempo entre os horários disponíveis consecutivos.

Exemplo: uma disponibilidade com duração de 20 min, repeatEvery igual a 30 min, startTime igual a 9h e repeatUntil igual a 11h resultará em um período com horários entre 9-9h20, 9h30-9h50, 10-10h20, 10h30-10h50, 11-11h20. (obrigatório)

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

{
  "timeRange": {
    object (TimeRange)
  }
}

object (TimeRange)

Período da exceção. Os espaços descritos pela recorrência que se sobrepõem a esse período fechado serão considerados indisponíveis.

Exemplo: se a recorrência especificar uma duração de 20 min com repeatEvery igual a 30 min, startTime igual a 9h e repeatUntil igual a 11h, uma ScheduleException com timeRange de 9h45-11h fará com os horários entre 9h30-9h50, 10-10h20 e 10h30-10h50 fiquem indisponíveis.

Como esse é o período em que a empresa está fechada, o espaço que começa às 11h não seria afetado.

{
  "priceInfo": {
    object (PriceInfo)
  }
}

object (PriceInfo)

Contêiner para detalhes de preços.

{
  "priceType": enum (PriceType),

  // Union field price_options can be only one of the following:
  "price": {
    object (Price)
  },
  "priceRange": {
    object (PriceRange)
  }
  // End of list of possible types for union field price_options.
}

enum (PriceType)

Define como o preço ou a faixa de preço é aplicada (por pessoa ou fixa)

object (Price)

O preço de um serviço ou uma taxa.

object (PriceRange)

O limite máximo e/ou mínimo de um serviço ou uma taxa.

{
  "minPrice": {
    object (Price)
  },
  "maxPrice": {
    object (Price)
  }
}

object (Price)

Valor mínimo.

object (Price)

Valor máximo. Deve ser sempre > minPrice.

{
  "lastBookableSec": string,
  "firstBookableSec": string,
  "lastOnlineCancellableSec": string
}

string (int64 format)

O último horário (em segundos) em que esse espaço pode ser reservado. Esse carimbo de data/hora precisa ser anterior ao startSec do horário em questão. Se você quiser oferecer a possibilidade de reservar após o horário de início, use o nível de serviço SchedulingRules.min_booking_before_end_time. Ao usá-lo, ele substituirá o que estiver especificado no min_booking_buffer do SchedulingRules correspondente do serviço.

string (int64 format)

O primeiro horário (em segundos) em que esse espaço pode ser reservado. Esse carimbo de data/hora precisa ser anterior ao startSec do horário ou o lastBookableSec, se especificado.

string (int64 format)

Se definido, o último horário (em segundos desde a época Unix) em que esse horário disponível específico pode ser cancelado pelo Reserve com o Google. Esse campo substitui qualquer regra de cancelamento no nível do serviço. (opcional)