Adicionar serviços on-line (descontinuado)

Observação:no momento, a Central de ações não oferece suporte a esse recurso para as novas funcionalidades do complemento.

Os serviços on-line são definidos como serviços realizados de maneira totalmente on-line, por meio de uma plataforma hospedada, e não exigem que o cliente assista ao serviço presencialmente. Alguns exemplos de serviços on-line podem incluir:

• Aula de ioga on-line pelo Zoom
• Aula de maquiagem on-line no Google Meet
• Estimativa por vídeo de encanamento on-line pelo Skype

Requisitos de qualificação para serviços on-line

Antes de iniciar a implementação, consulte as políticas e práticas recomendadas de serviços on-line.

Observação:no momento, não é possível especificar opções de pagamento (por exemplo, pacotes de classes) com serviços on-line. É recomendável implementar um único preço por classe.

Implementação de serviços on-line

Essa integração é um complemento da integração completa de horários e requer algumas mudanças em uma implementação. De modo geral, estas são as mudanças:

• Feeds: adicione type, VirtualSession, DirectMerchantPayment e CancellationPolicy aos feeds de serviços caso eles ainda não tenham sido adicionados.
• Servidor de agendamento: adicione VirtualSessionInfo ao método CreateBooking e envie e-mails com informações de configuração virtual ao usuário
• Atualizações em tempo real (comportamento atual): gerencie as mudanças no inventário virtual usando a RTU do InventoryUpdate, as modificações no agendamento pela RTU do BookingNotification e as mudanças no serviço com a RTU do serviço.

Feeds

Feed de serviços

Os campos a seguir são adicionados ao feed de serviços para oferecer suporte aos serviços on-line.

Especificações do feed de serviços

 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;
}

Exemplo de feed de serviços

{
  "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"
    }
  ]
}

• Descrição localizada: a descrição precisa explicar claramente sobre o que é o serviço. Consulte o guia de práticas recomendadas para saber como estruturar seu conteúdo de serviços.
• Instruções da sessão: as instruções da sessão precisam descrever toda a configuração necessária e atender às orientações detalhadas na política.
  • Se o URL do vídeo da plataforma e o ID da reunião não forem criados automaticamente como parte do CreateBooking (por exemplo, os detalhes não são enviados por CreateBookingResponse), você precisará informar claramente no session_instructions quando e de quem o usuário espera que os detalhes da plataforma sejam enviados a ele.
• Requisitos da sessão: os requisitos da sessão precisam descrever todos os equipamentos ou materiais necessários para o usuário participar da aula de forma eficaz. Você também pode incluir materiais opcionais de que o usuário talvez precise, mas marque-os como opcionais.
• Plataforma: a plataforma precisa indicar a plataforma que o usuário utilizará para acessar o serviço on-line.
  • Se a plataforma for determinada pelo comerciante posteriormente, defina platform como FLEXIBLE.
  • Se a plataforma que o comerciante está usando não estiver na lista, defina platform como OTHER e especifique other_platform_name.
• Política de cancelamento: é importante ter políticas de cancelamento precisas. Defina CancellationPolicy se reembolsos e cancelamentos forem permitidos. Se não for definido, a suposição padrão é que os reembolsos não são permitidos.

Feed de disponibilidade

• Total de horários: defina como a capacidade total de participantes permitidos para a plataforma (não esqueça de subtrair o pessoal).

Servidor de agendamento

Opcional: se o sistema criar um ID e um URL de reunião em nome do comerciante, inclua VirtualSessionInfo como parte de CreateBookingResponse.

Especificação do CreateBooking

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": "[e-mail]",
    "family_name": "John",
    "given_name": "Doe",
    "telephone": "[phone]",
    "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": "[phone]",
      "email": "[e-mail]"
    },
    "status": "CONFIRMED",
    "virtual_session_info": {
      "video_url": "meet.google.com/abcd-efg",
      "meeting_id": "abcd-efg",
      "password" : "somepassword"
    }
  }
}

Atualizações em tempo real

A lógica existente para atualizar o inventário ou as reservas precisa ser mantida para reservas virtuais.

• RTU InventoryUpdate: todas as atualizações de alterações de slot no seu sistema ou no sistema da Central de ações precisam disparar uma RTU InventoryUpdate para nos notificar sobre as mudanças nos slots.
• RTU BookingNotification: todas as atualizações de reservas (por exemplo, modificação de horário ou cancelamentos) no seu sistema ou na Central de ações precisam disparar uma RTU BookingNotification para nos informar sobre mudanças em uma reserva.
  • Se o usuário não fizer o pagamento para o comerciante/parceiro, envie uma RTU de cancelamento. Um e-mail de cancelamento será enviado pela Central de ações.
• RTU de serviço: se você atualizar os serviços usando uma RTU de serviço, inclua os campos de serviço on-line apropriados.

E-mails

Por padrão, a Central de ações envia e-mails padrão de confirmação de reserva, modificação e cancelamento quando um usuário faz uma transação na plataforma da Central de ações.

Os parceiros também precisam enviar detalhes da conferência, detalhes de pagamento e informações sobre a política de cancelamento em e-mails separados para o usuário. Você também pode enviar e-mails de lembrete antes do horário ou da turma. Consulte o documento de política para garantir que está em conformidade com as políticas de e-mail para classes virtuais.